loading...
Cover image for Rails: Radio Buttons In Nested Forms

Rails: Radio Buttons In Nested Forms

yechielk profile image Yechiel Kalmenson Updated on ・7 min read

The story behind my first Stack Overflow answer.

I was recently asked to add a feature to a Rails app. The app is a Contact Management System (CMS). Each contact has a name, an email address, and a phone number. I was asked to add the ability for multiple phone numbers to be added to each contact; each phone number should be able to be either a home number, work number, or cell-phone number. Also, one of the numbers should be designated the default number.

The way I approached it was by moving the phone numbers into a separate PhoneNumber class, with a many-to-one relationship to the Contact class, so now every contact could have many phone numbers, and every phone number belongs to a contact.

Additionally, I now had to update the 'New Contact' form to accept the nested attributes for the PhoneNumber class, as well as add a radio button so users can select which number would be the default, and this is where I ran into a problem.

No soap, radio!

First a brief explanation of how radio buttons work:

If you look at the HTML for a form with radio buttons, you will see that each button is it's own input element, what links them together is that they all share the same name attribute. This is what it looks like:

<form>
  <input type="radio" name="picker" value="chose_me" checked> Chose Me!<br>
  <input type="radio" name="picker" value="no_me"> No Me!<br>
  <input type="radio" name="picker" value="whatever_who_cares"> Whatever, who cares?  
</form> 

Codepen Sample

Notice how each input has the same name (picker), that's what lets the browser know that they are all linked and that it should only allow one of the buttons to be picked at a time.

Rails Helpers

Rails has a built in helper method that generates radio buttons for forms; the radio_button method. When that method is called on a form element Rails will automatically generate the proper HTML element with the correct attributes so that when the form gets submitted your server will know how to construct a new object (or update an existing one) from the data.

My problem was that I wasn't making a regular form, I was making a nested form, a form within a form. I had my Contact form, and within the Contact form, I was collecting attributes for my PhoneNumber class.

Rails generally handles that kind of stuff pretty well. What it does is, it adds fields to your form, and each field gets a name attribute that follows the format of parent_class[nested_classes_attributes][:index][attribute]. So in my case, where I had PhoneNumbers nested in the Contacts parent class, the Number field in the first phone number form had a name attribute of contact[phone_numbers_attributes][0][number]; the number field in the second phone number form had a name attribute of contact[phone_numbers_attributes][1][number], and so on. Each form incrementing the index by one, so that the server would know we are dealing with different PhoneNumber objects.

The problem was that I needed a radio button on each phone number form so that users could choose which phone number was the default, but I needed all of the radio buttons to have the same name. The Rails form helper method, as mentioned, was treating each phone number as a separate form, and giving each button a different name attribute.

As usual, I turned to Google and was pretty excited to see that one of the first results linked to a question on Stack Overflow that sounded just like the problem I was having. The problem was that when I clicked on it, I saw that even though the question was first asked in 2011, it only had three answers, and none of them solved my problem.

XKCD Wisdom Of The Ancients

Great Help!

An incomplete solution provided by one of the answers was that, instead of attaching the radio button to the existing form, to have it as an independent radio_button_tag and to manually supply the name as well as any other attributes needed. That would result in a form that looked like this:

<%= form_for @contact do |f| %>
    <%= f.text_field :name %>
    <%= f.email_field :email %>
    <%= f.fields_for :phoneNumbers do |phone_form| %>
        <%= phone_form.text_field :number %>
        <%= phone_form.select :location, ["Home", "Work", "Mobile", "Fax"] %>
        <%= radio_button_tag "contact[default_telephone]" %>
   <% end %>
<% end %>

You will notice that the number and location fields are attached to a phone_form object which gives them their name attribute, but the radio button tag isn't attached to anything, instead the name (contact[default_telephone])is supplied as an argument.

The problem is that the radio buttons need two more pieces of information to work properly. The first piece of information was the value that would be submitted if the button was checked off, which would ideally be the index of the current phone number the form was rendering. The second piece of information was which phone number was the current default number so that the correct button would be selected by default if the form was an Edit Contact form. And those two pieces of information were missing from the Stack Overflow answer; I was on my own.

A Solution To Every Problem

I spent some time thinking about the problem and realized something. The other fields, the ones that were attached to phone_form were probably getting their information from the phone_form object. If my radio_button_tag was still within the phone_form scope (which it was, as long as I put it before the first <% end %> tag) it should have access to the phone_form object and any methods available to it.

I would have to find a way to inspect the phone_form object and see what was available through it.

One of my favorite debugging methods in rails is to put a raise <object>.inspect at a spot in my code, then when my app would reach that breakpoint it would display the object on the screen as an error, along with a console that would have access to any variables available at the breakpoint.

The problem was, I have only used that method in my controllers, I never used it in a view yet, and while I had a hunch it would work, I wanted to make sure. So to start with I put the following in the middle of my view: <% raise "Hello World".inspect %> and navigated to that page. Sure enough, I got the following screen:

"Hello world" error screen

Perfect, now let's inspect the actual object. I put the following into my form, right before the radio button tag:
<% raise phone_form.inspect %>:

FormBuilder error screen

Yeah, quite an eyeful. That's what a Ruby Object looks like, and this object was apparently a FormBuilder object. All the information I needed was somewhere in the huge wall of text; the problem was how to find it.

I headed to the console at the bottom to see what I could find. Running phone_form just gave me the same wall of text obviously, so I decided to run phone_form.methods to see what methods were available to the phone_form object.

I actually ran phone_form.methods - Object.methods to remove any methods that were generic to all Ruby objects and got:

>>  phone_form.methods - Object.methods
=> [:select, :index, :options, :label, :options=, :object, :multipart?, :submit, 
:object=, :fields, :to_partial_path, :to_model, :multipart, :date_select, 
:object_name, :time_select, :datetime_select, :fields_for, :text_field, 
:password_field, :hidden_field, :file_field, :text_area, :check_box, 
:radio_button, :color_field, :search_field, :telephone_field, :phone_field, 
:date_field, :time_field, :datetime_field, :datetime_local_field, :month_field, 
:week_field, :url_field, :email_field, :number_field, :range_field, 
:field_helpers, :field_helpers=, :multipart=, :button, :emitted_hidden_id?, 
:field_helpers?, :object_name=, :collection_select, :grouped_collection_select,
:time_zone_select, :collection_radio_buttons, :collection_check_boxes, 
:model_name_from_record_or_class, :convert_to_model]

Playing around with some of the more promising sounding method names, I found the the :index method did indeed give me the index of the current form, and :object gave me the object that was tied to the form, so my final radio tag ended up looking like this:
<%= radio_button_tag "contact[default_telephone]", phone_form.index, phone_form.object.default %>

The first argument ("contact[default_telephone]") is the name attribute, which is the same for all phone number forms and ensures my radio buttons would act like radio buttons.

The second argument (phone_form.index) is the value passed in by the radio button, and is equal to the index of the form currently being worked on, and will be used by the controller to identify which phone number is the default one (as I will show soon).

The third argument (phone_form.object.default) determines whether the radio button should be selected by default. phone_form.object is the current PhoneNumber object the form is rendering, and the .default is the current value of whether this instance of PhoneNumber is default or not.

Now I just had to update my controller to let it use the information passed in by my form. I added the following two lines of code to the beginning of my create and update controllers:

  def create
    # Determine the index of the phone number that should be the default 
    default_index = params[:contact][:default_telephone]
    # Set the phone number at that index as default
    params[:contact][:telephones_attributes][default_index][:default] = true
    # Create the new object....
  end

Share The Love!

There was just one thing left to do. I remembered what it was like to find that Stack Overflow question without a proper answer, I realized I would probably not be the last person to ask that question, so I headed back the question and added my very first Stack Overflow answer!

You can use radio_button_tag and pass it your own name attribute.

Being that you are still in the choice_fields scope, you have access to a few methods that can expose the object you are working on, which will help you name your radio_button_tag properly.

The following code will give your…

As a code newbie, I have spent countless hours reading questions and answers on Stack Overflow. Stack Overflow has been my buddy, mentor, and big brother. Being able to give back and contribute was a huge milestone. Hopefully, that answer will be the first of many.


This article has been cross-posted from my blog Coding Hassid
You can read more about my coding journey there, or by following me on Twitter @yechielk

Posted on by:

yechielk profile

Yechiel Kalmenson

@yechielk

He/Him/His I'm a Software Engineer and a teacher. There's no feeling quite like the one you get when you watch someone's eyes light up learning something they didn't know.

Discussion

markdown guide
 

Ah! I've been dealing with radio buttons lately. This is really interesting, thanks for sharing in such detail.

 
 

FYI: you can write <%= radio_button_tag "contact[default_telephone]" %> as <%= radio_button_tag :contact, index: :default_telephone %>, which leads to same name, but it feels a bit more 'railsy'.

 

I'm not seeing that.

According to the documentation the second argument passed to radio_button_tag is the value of the input. Writing the tag the way you did gives me a radio button that looks like this:

<input type="radio" name="contact" id="contact__:index__:default_telephone_" value="{:index=>:default_telephone}">

I tried a few other variations and none gave e a properly formatted radio button.

 

Sorry, I was a bit quick to reply:

<%= f.radio_button :default_telephone_index, phone_form.index %>

should give you what you want, considering you have to have accessors for default_telephone_index on you model/form_object. (Which would be a good approach anyway, since you want as little code as possible in your view.) Also note that the radio_button is on the overall form, not the phoneNumber formbuilder.

Also, the original intent of my comment was to point you to the use of the :index option not to have to compose names yourself, but it only works on methods like radio_button on the formbuilder, not on _tag methods.