13 Jun 2017
Let’s table set — what is a nested resource?
I’m referring to a type of routing mechanism available to use in Ruby on Rails. The ‘resources’ syntax is a useful way to have Rails generate each of the CRUD routes for you. Take a look below.
config/routes.rb in my rails application
Here, in my config/routes.rb file, I am using the ‘resources’ keyword to draw routes for my ‘Artist’ model. Now, when I run ‘rake routes,’ I can see that the following routes have been generated for me.
‘rake routes’ returns the full list of rails routes to your terminal — ‘rake’ is a ruby gem that is required for this call
If i want to expand my model to include songs, I have some choices to make. I could have Rails generate a suite of routes beginning with ‘/songs’ for me, just as I have done with artists OR I could choose to nest these routes underneath those that I have already drawn for artists. The latter would look like this.
Here, I am passing my songs resources in as a block underneath ‘artists’
The nested approach provides me with the following list of routes.
And here lies the first thing that I learned about nested routes.
My ‘/artists/:id’ convention becomes ‘/artists/:artist_id/songs/:id’ once I navigate into my song routes. Why is this syntax change important? Now when my application receives a request to any of the actions defined in my SongsController, an artist ID is passed to me in the format of ‘params[:artist_id].’
If I want my songs#index action to display a collection of songs that belong to the artist that I am navigating under, I will need to pass ‘params[:artist_id]’ in as an argument to stipulate that I only want songs from the artist who’s ID matches (see below).
Rails comes pre-loaded with a bunch of different useful helper methods, one of which is ‘form_for,’ which assists with the routing for model-based form input.
Typically, I would use an instance of a model as the sole argument in a form. When we create a new song, with the models outlined earlier, what we are really doing is creating a new song object that belongs to an artist object. Therefore, without letting our ‘form_for’ element which artist we want to relate the form input to as well as which song, our ‘form_for’ model will not work. An example of my form for creating a new song is below.
Simple demonstration: I’m going to add resources for ‘lyrics’ underneath my nested ‘songs’ resources.
yeah, there’s gotta be a better way
From Jamis Buck’s blog post (also referenced in the Rails guide):
Resources should never be nested more than 1 level deep.
Buck’s blog post suggests an advanced method for keeping your routes and URLs from getting out of control but I wanted to highlight two quick ways that you can refactor your code.
Adding the ‘shallow: true’ parameter to your nested resource will define routes at the base level, ‘/songs/’, for four of our RESTful routes — show, edit, update and destroy, while leaving the remaining routes — index, new, create— at the nested level. So how is this useful to us?
In my model, with artists and songs, we are now able to use the routes starting with ‘/songs/:id’ to view or modify existing songs on an individual basis. Recall that songs belong to artists, so upon creation, we still need to initialize a song with an artist relationship. However, once a song is created, it doesn’t matter to artist relationship if we would like to edit or delete it. And so, we don’t need to follow a lengthy route, such as ‘/artists/:artist_id/songs/:id/edit’ to make our changes.
While it would not help to simplify my model, collection and member blocks can be used to create routes with specific dependencies.
Thank you for reading and be sure to check out the additional resources linked below.