{"id":751,"date":"2011-06-26T15:32:00","date_gmt":"2011-06-26T15:32:00","guid":{"rendered":"https:\/\/www.keenertech.com\/?p=751"},"modified":"2011-06-26T15:32:00","modified_gmt":"2011-06-26T15:32:00","slug":"recipe-detecting-required-fields-in-rails","status":"publish","type":"post","link":"https:\/\/staging.keenertech.com\/?p=751","title":{"rendered":"Recipe: Detecting Required Fields in Rails"},"content":{"rendered":"\n

It’s a familiar problem. You’re creating a form and you want to mark certain fields as required. You’d rather not hard-code which fields are required, because this might change over time. Plus, you’ve already got validations in your model that check for the presence of required fields, and you’d really rather not duplicate any of that logic. So, how can you tell whether a field associated with an ActiveRecord model is required?<\/p>\n\n\n\n

The Problem<\/h3>\n\n\n\n

Let’s assume that we have a model called Author, with required fields of first_name and last_name. The model looks like this:<\/p>\n\n\n\n

   class Author < ActiveRecord::Base\n\n      validates_presence_of :first_name\n      validates_presence_of :last_name\n\n   end<\/pre>\n\n\n\n
The validations ensure that the first_name and last_name attributes of the model will have values. The bottom line is that the model has information about which fields are required. We need to be able to interrogate the model to determine if a field is required.<\/p>\n\n\n\n
The Solution<\/h3>\n\n\n\n
After a little bit of research, it turns out that ActiveRecord has a validators_on method. Let’s fire up the Rails console and see how it works:<\/p>\n\n\n\n
      console><\/strong>  Author.validators_on(:first_name)\n      => [#<ActiveModel::Validations::PresenceValidator:0x45c4770 \n      @attributes=[:first_name, :last_name], @options={}>]<\/pre>\n\n\n\n
OK, that gives us an array of validations for the specified field, where each validation is an instance of some type of validation class. That’s somewhat useful, but we can do better.<\/p>\n\n\n\n
      console><\/strong> Author.validators_on(:first_name).map(&:class)\n      => [ActiveModel::Validations::PresenceValidator]<\/pre>\n\n\n\n
That’s even better. Now we have an array of classes, where each element is the class of a validator that has been placed on the specified attribute. The “&:class” argument to the map method causes the class method to be executed for each element in the array.<\/p>\n\n\n\n
Now that we know how to get a list of the validations that are on a particular field, we can write a method that will return TRUE or FALSE based on whether a field is required. I’m going to throw in one wrinkle, though. I’d like to be able to call the method using either a class or an instance of a class.<\/p>\n\n\n\n
   def required?(obj, attr)\n      target = (obj.class == Class) ? obj : obj.class\n      target.validators_on(attr).map(&:class).include?(\n         ActiveModel::Validations::PresenceValidator)\n   end\n<\/pre>\n\n\n\n
I can put this method in my application_helper.rb file for my Rails application. Then I can call it from a view in two ways:<\/p>\n\n\n\n
      required?(Author, :first_name)<\/p>\n\n\n\n
Or, assuming that the controller has passed an instance of the Author model to the view as @author:<\/p>\n\n\n\n
      required?(@author, :first_name)<\/p>\n\n\n\n
By the way, this call works just fine, as well:<\/p>\n\n\n\n
      required?(@author, “first_name”)<\/p>\n\n\n\n
Now my view logic can easily check whether a field is required.<\/p>\n\n\n\n
   <%= form_for(@author) do |f| %>
      <p><%= f.text_field :first_name %>
      <% if required?(@author, :first_name) %>*<% end %><\/p><\/p>\n\n\n\n
Reception<\/h3>\n\n\n\n
[May 5, 2026] This article was quite well received back in the day. Since I can’t easily port the comments from the old version of the KeenerTech.com website, I pulled some screenshots instead:<\/p>\n\n\n\n
\"First<\/figure>\n\n\n\n
\"Second<\/figure>\n\n\n\n
\"Third<\/figure>\n","protected":false},"excerpt":{"rendered":"
It’s a familiar problem. You’re creating a form and you want to mark certain fields as required. You’d<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[160,172],"class_list":["post-751","post","type-post","status-publish","format-standard","hentry","category-technology","tag-rails","tag-ruby"],"_links":{"self":[{"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=\/wp\/v2\/posts\/751","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=751"}],"version-history":[{"count":0,"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=\/wp\/v2\/posts\/751\/revisions"}],"wp:attachment":[{"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=751"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=751"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/staging.keenertech.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=751"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}