Полностью настраиваемое сообщение об ошибке валидации с Rails

213

Использование Rails Я пытаюсь получить сообщение об ошибке, например "Поле песни не может быть пустым" при сохранении. Выполнение следующих действий:

validates_presence_of :song_rep_xyz, :message => "can't be empty"

... отображает только "Song Rep XYW не может быть пустым", что не очень хорошо, потому что заголовок поля не является удобным для пользователя. Как я могу изменить название самого поля? Я могу изменить фактическое имя поля в базе данных, но у меня есть несколько полей "песни", и мне нужно иметь конкретные имена полей.

Я не хочу взломать процесс проверки рельсов, и я чувствую, что должен быть способ исправить это.

Теги:

15 ответов

385
Лучший ответ

Теперь принятый способ установить гуманизированные имена и настраиваемые сообщения об ошибках - использовать локали.

# config/locales/en.yml
en:
  activerecord:
    attributes:
      user:
        email: "E-mail address"
    errors:
      models:
        user:
          attributes:
            email:
              blank: "is required"

Теперь очеловеченное имя и сообщение о подтверждении присутствия для атрибута "email" были изменены.

Сообщения проверки могут быть установлены для конкретной модели + атрибута, модели, атрибута или глобально.

  • 2
    Установка имен полей по языку - это замечательно, но как настроить пользовательские сообщения об ошибках по языку?
  • 18
    Если вы используете mongoid, замените activerecord: mongoid:
Показать ещё 12 комментариев
56

В вашей модели:

validates_presence_of :address1, :message => "Put some address please" 

На ваш взгляд

<% m.errors.each do |attr,msg|  %>
 <%=msg%>
<% end %>

Если вы сделаете вместо этого

<%=attr %> <%=msg %>

вы получите это сообщение об ошибке с именем атрибута

address1 Put some address please

если вы хотите получить сообщение об ошибке для одного единственного атрибута

<%= @model.errors[:address1] %>
  • 0
    Это не приемлемое решение. Что если я хочу поведение по умолчанию для всех других атрибутов (attr + msg)?
  • 0
    Там вы идете .. вы можете играть с этими двумя вещами и заставить его работать
Показать ещё 3 комментария
56

Попробуйте это.

class User < ActiveRecord::Base
  validate do |user|
    user.errors.add_to_base("Country can't be blank") if user.country_iso.blank?
  end
end

Я нашел здесь здесь.

Вот еще один способ сделать это. Что вы делаете, так это определение метода human_attribute_name в классе модели. Метод передается имя столбца в виде строки и возвращает строку для использования в сообщениях проверки.

class User < ActiveRecord::Base

  HUMANIZED_ATTRIBUTES = {
    :email => "E-mail address"
  }

  def self.human_attribute_name(attr)
    HUMANIZED_ATTRIBUTES[attr.to_sym] || super
  end

end

Вышеприведенный код из здесь

  • 0
    Проблема в том, что мое поле называется: song_rep_xyz (ну, что-то сложное), что не удобно для пользователя
  • 15
    для Rails 3 "def self.human_attribute_name (attr)" необходимо изменить на "def self.human_attribute_name (attr, options = {})", в противном случае возвращается ошибка
Показать ещё 1 комментарий
15

Да, есть способ сделать это без плагина! Но я не такой чистый и элегантный, как использование упомянутого плагина. Вот оно.

Предполагая, что это Rails 3 (я не знаю, отличается ли это в предыдущих версиях),

сохраните это в своей модели:

validates_presence_of :song_rep_xyz, :message => "can't be empty"

и в представлении вместо того, чтобы оставить

@instance.errors.full_messages

как это было бы при использовании генератора эшафотов, поставьте:

@instance.errors.first[1]

И вы получите только сообщение, которое вы указали в модели, без имени атрибута.

Пояснение:

#returns an hash of messages, one element foreach field error, in this particular case would be just one element in the hash:
@instance.errors  # => {:song_rep_xyz=>"can't be empty"}

#this returns the first element of the hash as an array like [:key,"value"]
@instance.errors.first # => [:song_rep_xyz, "can't be empty"]

#by doing the following, you are telleing ruby to take just the second element of that array, wich is the message.
@instance.errors.first[1]

Пока мы показываем только одно сообщение, всегда для первой ошибки. Если вы хотите отобразить все erros, вы можете зациклиться на хеше и показать значения.

Надеюсь, что это помогло.

13

Код Rails3 с полностью локализованными сообщениями:

В модели user.rb определите валидацию

validates :email, :presence => true

В config/locales/en.yml

en:  
  activerecord:
    models: 
      user: "Customer"
    attributes:
      user:
        email: "Email address"
    errors:
      models:
        user:
          attributes:
            email:
              blank: "cannot be empty"
12

Я рекомендую установить custom_error_message gem (или как плагин), первоначально написанный Дэвидом Излием

Это позволяет вам делать такие вещи, как:

validates_presence_of :non_friendly_field_name, :message => "^Friendly field name is blank"
  • 2
    Спасибо! нет ли способа сделать это без плагина?
  • 0
    Я использовал этот плагин в прошлом с большим успехом, хотя, похоже, он больше не поддерживается регулярно.
Показать ещё 6 комментариев
11

В пользовательском методе проверки используйте:

errors.add(:base, "Custom error message")

поскольку add_to_base устарела.

errors.add_to_base("Custom error message")

10

В связи с принятым ответом и еще один ответ в списке:

Я подтверждаю, что nanamkim fork custom-err-msg работает с Rails 5 и с настройкой локали.

Вам просто нужно запустить локальное сообщение с помощью каретки, и оно не должно отображать имя атрибута в сообщении.

Модель, определенная как:

class Item < ApplicationRecord
  validates :name, presence: true
end

со следующим en.yml:

en:
  activerecord:
    errors:
      models:
        item:
          attributes:
            name:
              blank: "^You can't create an item without a name."

item.errors.full_messages отобразит:

You can't create an item without a name

вместо обычного Name You can't create an item without a name

  • 0
    спас жизнь сегодня. Спасибо
6

Вот еще один способ:

Если вы используете этот шаблон:

<% if @thing.errors.any? %>
  <ul>
    <% @thing.errors.full_messages.each do |message| %>
      <li><%= message %></li>
    <% end %>
  </ul>
<% end %>

Вы можете написать свое собственное сообщение следующим образом:

class Thing < ActiveRecord::Base

  validate :custom_validation_method_with_message

  def custom_validation_method_with_message
    if some_model_attribute.blank?
      errors.add(:_, "My custom message")
    end
  end

Таким образом, из-за подчеркивания, полное сообщение становится "Мое пользовательское сообщение", но дополнительное пространство в начале незаметно. Если вы действительно не хотите, чтобы дополнительное пространство в начале просто добавляло метод .lstrip.

<% if @thing.errors.any? %>
  <ul>
    <% @thing.errors.full_messages.each do |message| %>
      <li><%= message.lstrip %></li>
    <% end %>
  </ul>
<% end %>

Метод String.lstrip избавится от лишнего пространства, созданного ': _', и оставит любые другие сообщения об ошибках без изменений.

Или даже лучше, используйте первое слово своего пользовательского сообщения в качестве ключа:

  def custom_validation_method_with_message
    if some_model_attribute.blank?
      errors.add(:my, "custom message")
    end
  end

Теперь полное сообщение будет "Мое пользовательское сообщение" без дополнительного места.

Если вы хотите, чтобы полное сообщение начиналось с слова, заглавного как "URL-адрес не может быть пустым", это невозможно. Вместо этого попробуйте добавить другое слово в качестве ключа:

  def custom_validation_method_with_message
    if some_model_attribute.blank?
      errors.add(:the, "URL can't be blank")
    end
  end

Теперь полное сообщение будет "URL не может быть пустым"

  • 0
    ооо, вы даже можете сделать errors.add(:_, 'foobar') и получить 'foobar' в качестве сообщения
6

Просто делайте это обычным способом:

validates_presence_of :email, :message => "Email is required."

Но покажите его так:

<% if @user.errors.any? %>
  <% @user.errors.messages.each do |message| %>
    <div class="message"><%= message.last.last.html_safe %></div>
  <% end %>
<% end %>

Возвращает

"Email is required."

Метод локализации, безусловно, является "правильным" способом сделать это, но если вы делаете небольшой, неглобальный проект и хотите просто быстро развиваться - это определенно проще, чем перескакивание файлов.

Мне нравится это для возможности помещать имя поля где-то, кроме начала строки:

validates_uniqueness_of :email, :message => "There is already an account with that email."
3

Одним из решений может быть изменение формата ошибки по умолчанию i18n:

en:
  errors:
    format: "%{message}"

Значение по умолчанию format: %{attribute} %{message}

2

Если вы хотите перечислить их все в хорошем списке, но без использования грубого дружественного имени, вы можете сделать это...

object.errors.each do |attr,message|
  puts "<li>"+message+"</li>"
end
1

На ваш взгляд

object.errors.each do |attr,msg|
  if msg.is_a? String
    if attr == :base
      content_tag :li, msg
    elsif msg[0] == "^"
      content_tag :li, msg[1..-1]
    else
      content_tag :li, "#{object.class.human_attribute_name(attr)} #{msg}"
    end
  end
end

Если вы хотите переопределить сообщение об ошибке без имени атрибута, просто добавьте сообщение с помощью ^ так:

validates :last_name,
  uniqueness: {
    scope: [:first_name, :course_id, :user_id],
    case_sensitive: false,
    message: "^This student has already been registered."
  }
  • 0
    не работает с рельсами 5.1 / ruby 2.4? получить название модели в этой области
  • 0
    @Ben работает для меня на Rails 5.1.2, Ruby 2.4.1p111. Можете ли вы поделиться своим кодом?
Показать ещё 1 комментарий
0

Вот мой код, который может быть вам полезен, если он вам еще нужен: Моя модель:

validates :director, acceptance: {message: "^Please confirm that you are a director of the company."}, on: :create, if: :is_director?

Затем я создал помощник для отображения сообщений:

module ErrorHelper
  def error_messages!
    return "" unless error_messages?
    messages = resource.errors.full_messages.map { |msg|
       if msg.present? && !msg.index("^").nil?
         content_tag(:p, msg.slice((msg.index("^")+1)..-1))
       else
         content_tag(:p, msg)
       end
    }.join

    html = <<-HTML
      <div class="general-error alert show">
        #{messages}
      </div>
    HTML

    html.html_safe
  end

  def error_messages?
    !resource.errors.empty?
  end
end
0

Я пробовал следовать, работал у меня:)

1 job.rb

class Job < ApplicationRecord
    validates :description, presence: true
    validates :title, 
              :presence => true, 
              :length => { :minimum => 5, :message => "Must be at least 5 characters"}
end

2 jobs_controller.rb

def create
      @job = Job.create(job_params)
      if @job.valid?
        redirect_to jobs_path
      else
        render new_job_path
      end     
    end

3 _form.html.erb

<%= form_for @job do |f| %>
  <% if @job.errors.any? %>
    <h2>Errors</h2>
    <ul>
      <% @job.errors.full_messages.each do |message|%>
        <li><%= message %></li>
      <% end %>  
    </ul>
  <% end %>
  <div>
    <%= f.label :title %>
    <%= f.text_field :title %>
  </div>
  <div>
    <%= f.label :description %>
    <%= f.text_area :description, size: '60x6' %>

  </div>
  <div>
    <%= f.submit %>
  </div>
<% end %> 

Ещё вопросы

Сообщество Overcoder
Наверх
Меню