Cyber Monday Sale 40% off unlimited courses & creative assets! 40% off unlimited assets! Save Now

# AntiPatterns Basics: Rails Controllers

If you have lived on the “fat models, skinny controllers” diet, you have definitely been going in the right direction. Keeping controllers skinny, though, is not as easy as it sounds. In this article you’ll learn a couple of beginner-friendly approaches for losing some controller fat.

## Topics

• Fat Controllers
• Non-RESTful Controllers
• Rat’s Nest Resources

## FAT Controllers

Well, “fat models, skinny controllers”, right? In case you haven’t read the previous AntiPattern articles, I should mention that aiming for models and controllers that stay skinny is a better guideline—no matter what. All that excess fat is not good for your projects—“skinny everything” makes much more sense. (Maybe I should make it clear that I’m not associated with the fashion industry in any way and don’t want to repeat the impression that you can’t be considered beautiful without fitting a certain type of imaginary body.)

As with models, you want controllers that have single responsibilities. Controllers should be dumb really, managing traffic and not much else. Also, if possible, we want to make our templates as dumb as possible—presenters can be handy in that regard.

It is further important that you do not stray much from RESTful controller actions. Sure, every once in a while it can make sense to have additional methods in there, but most of the time, you should feel a little uneasy having them around. Controllers tend to get fat when they amass business logic that actually belongs in models or when inexperienced developers don’t make use of Rails conventions.

You won’t be the first trying to reinvent the wheel, and you certainly won’t be the last. Don’t feel bad about it, because probably most of us have been there, but as a craftsman, you really should invest time and effort to know the conventions, benefits and limitations of the frameworks you work with—at least for commercial purposes where somebody pays for your expertise. Experiments are always fine, of course.

Since controllers are in charge of the flow of your application as well as gathering the information that your views need, they already have a pretty important responsibility. They really do not need added complexity from the realm of your models. Controllers are closely working with your views to display the data provided by the model layer. Their relationship is tighter than with models. The model layer can potentially be developed much more independently from the others. The good thing about that is that a clean controller layer often has a positive effect on how tidy your views can be.

What I want to get across is that fat controllers are super common in Rails land—especially among beginners and inexperienced developers—and with a little bit of love and care, this can be optimized easily.

The first step is straightforward. Ask yourself when a controller grows in size if the complexity comes from added business logic. If so, find a way to move it to the model layer where you have the added benefit of having a better home for testing complex code.

### Presenters

To follow the above recommendation of moving acquired controller logic to models, presenters can be a handy technique. They can simulate a model while combining a couple of loosely related attributes together, which can be useful for keeping controllers slim and sexy. On top of that, they are also good at keeping logic nastiness out of your views. Pretty good deal for crafting an extra object!

Presenters can “imitate” a model which represents the state that your view needs and combines the attributes that need to move through the controller. They can be more complex, but then I feel they are drifting into “Decorator” territory.

Sometimes a controller is in charge of creating multiple models simultaneously and we want to avoid it handling multiple instance variables in there. Why is this important? Because it helps us to keep the maintainability of our apps in check. The presenter aggregates behaviour and attributes, which makes it easy for our controllers to focus on small, dead-simple jobs—with a single object. Also, formatting data in your view or other similar small functions are frequent jobs that often occur. Having this contained in a presenter is not only great for clean views but also for having a dedicated place that makes testing this  behaviour straightforward—the model layer is easier to test. More “bang for the buck” and all that jazz.

If you stumble upon the Presenter Pattern and find multiple approaches or different ways to describe it, you are not going crazy. There seems to be little clear-cut agreement on what a presenter is. What is common knowledge, though, is that it sits between the MVC layers. We can use it to manage multiple model objects that need to be created at the same time. While combining these objects, it imitates an ActiveRecord model.

A commonly cited scenario is some sort of form that inputs information for various different models, like a new user account that also has input fields for credit cards and addresses or something. Going full wizard by stepping through a couple of forms in sequence is not that different. Since these parts of your application tend to be very important ones, it is definitely a good idea to keep things tidy while having the best possible option available for testing at the same time.

The user experience on this one is key too. In the example below, we want to create a simple mission that has_one agent and one quartermaster. No rocket science, but it’s a good example to see how quickly things can get out of hand. The controller needs to juggle multiple objects that the view needs in a nested form to tie things together. You will soon see that all of this can be cured with a nice “Form Object” which presents the objects needed and weaves things together in one central class.

app/models/mission.rb

I’m mentioning the models here just for the sake of completeness in case you've never used fields_for before—a bit simplified but working. Below is the heart of the matter.

#### Too Many Instance Variables

app/controllers/missions_controller.rb

Overall, it’s easy to see that this is heading in the wrong direction. It's already attracted quite a bit of mass and it only consists of new and create methods. Not good! The private methods are already piling up way too fast as well. Having agent_params and quartermaster_params in a MissionsController does not sound too slick to you, I hope. A rare sight, you think? I’m afraid not. “Single Responsibilities” in controllers truly are a golden guideline. You’ll see why in just a minute.

Even if you squint your eyes, this looks super nasty. And during saving in the create action, with validations in place, if we can’t save every object due to some mistake or something, we’ll end up with orphaned objects that nobody wants to deal with. Yikes!

Sure, we could put this into a transaction block, which successfully completes saving only if all objects are in order, but this is a bit like surfing against the current—also, why do model-level stuff like this in the controller, really? There are more elegant ways to catch a wave.

Following this path, the view would have an accompanying form_for for @mission and the additional fields_for for @agent and @quartermaster of course.

#### Messy Form With Multiple Objects

app/views/missions/new.html.erb

Sure, this works, but I wouldn’t be too excited to stumble upon this. fields_for sure is handy and all, but handling this with OOP is a lot more dope. For such a case, a presenter will also aid us in having a simpler view because the form will deal with just a single object. Nesting the form becomes unnecessary that way. By the way, I left out any wrappers for styling the form to make it easier to digest visually.

### Form Object Presenter

app/views/missions/new.html.erb

As you can easily see, our view has become much simpler—no nestings, and it’s a lot more straightforward this flat. The part you need to be a bit careful about is this:

You need to provide form_for with a path via url so that it can “post” the params from this form to its proper controller—here MissionsController. Without that additional argument, Rails would try to find the controller for our presenter object @mission_presenter through conventions—in this case MissionFormPresentersController—and blow up without one.

In general, we should try our best to keep controller actions mostly as simple as dealing with the CRUD manipulation of resources—that’s what a controller does for a living and is best equipped to do without muddying the MVC distinctions. As a nice side effect, the level of complexity in your controllers will go way down as well.

app/controllers/missions_controller.rb

The controller is also a lot easier on the eyes, isn’t it? Much cleaner and pretty much standard controller actions. We are dealing with a single object that has one job. We instantiate a single object, the presenter, and feed it the params as usual.

The only thing that bugged me was sending this long list of whitelisted strong parameters. I extracted them into a method called whitelisted, which just returns an array with the complete list of parameters. Otherwise, mission_params would have looked like the following—which felt too nasty:

Oh, a word about the :mission_form_presenter argument for params.require. Although we named our instance variable for the presenter @mission_presenter, when we use it with form_for, Rails expects the key of the params hash for the form to be named after the object instantiated—not after the name given in a controller. I have seen newbies trip over this several times. That Rails is providing you with cryptic errors in such a case isn’t helping either. If you need a little refresher on params, this is a good place to dig in:

In our Mission model, we now have no need for accepts_nested_attributes anymore and can get rid of that harmless-looking, dreaded thing. The validates method is also irrelevant here because we add this responsibility to our form object. The same goes for our validations on Agent and Quartermaster, of course.

app/models/mission.rb

Encapsulating this validation logic directly on our new object helps us keep things clean and organized. In cases where you could also create these objects independently from each other, validations should stay where they currently are, of course. This kind of duplication can also be dealt with, for example by using validates_with with a separate class for validation that inherits from ActiveModel::Validator.

Now we have a skinny controller with a single responsibility and a flat form for creating multiple objects in parallel. Awesome! How did we achieve all this?  Below is the presenter that does all the work—not implying this class does a lot of work, though. We want to have some sort of intermediary model without a database that juggles multiple objects. Take a look at this plain old ruby object (PORO).

app/presenters/mission_form_presenter.rb

I think it’s fair to say that it’s not very complicated. MissionFormPresenter is a form object that now encapsulates what made our controller unnecessarily fat. As a bonus, our view became flat and simple. What happens here is that we can aggregate all the info from our form and then we create all the objects we need sequentially.

The most important piece happens in our new save method. First we create the new Mission object. After that, we can create the two objects associated with it: Agent and Quartermaster. Through our has_one and belongs_to associations, we can make use of a create_x method that adapts to the name of the associated object.

For example, if we use has_one :agent, we get a create_agent method. Easy, right? (Actually we also get a build_agent method.) I decided to use the version with a bang(!) because it raises an ActiveRecord::RecordInvalid error if the record is invalid while attempting to save. Wrapped inside a transaction block, these bang methods take care that no orphaned object gets saved if some validation kicks in. The transaction block will roll back if something goes wrong during save.

How does this work with the attributes, you might ask? We ask Rails for a little bit of love via include ActiveModel::Model (API). This allows us to initialize objects with a hash of attributes—which is exactly what we do in the controller. After that, we can use our attr_accessor methods to extract our attributes to instantiate the objects we really need.

ActiveModel::Model further enables us to interact with views and controllers. Among other goodies, you can also use this for validations in such classes. Putting these validations into such dedicated form objects is a good idea for organization, and it also keeps your models a bit tidier.

I decided to extract the long list of parameters into private methods which feed the objects that get created in save. In such a presenter object, I have little concern about having a couple more private methods lying around. Why not? Feels cleaner!

Testing these kinds of scenarios where multiple models come together should be treated with utmost care—the simpler the objects in question, the better the testing experience. No rocket science, really. Presenters operate in your favor on this one. Having these tests potentially tied to the controller is not the best way to approach this. Remember, unit tests are fast and cheap.

A word of caution. Do not overuse presenters—they should not be your first choice. Usually, the need for a presenter grows over time. For me personally, they are best used when you have data represented by multiple models that need to come together in a single view.

Without a presenter, you might more often than not prepare multiple instance variables in your controller for a single view. That alone can make them real fat, real quick. A thing that you should consider and weigh is that while presenters add objects to your codebase, they can also reduce the number of objects a controller needs to deal with—less complexity and single responsibilities. It is probably a fairly advanced technique to lose some fat, but when you want to slim down, you need to put in the work.

## Non-RESTful Controllers

Not trying to adhere to the standard controller actions is most likely a bad idea. Having tons of custom controller methods is an AntiPattern you can avoid pretty easily. Methods like login_user, activate_admin, show_books, and other funny business that stands in for new, create, show and so forth, should give you a reason to pause and to doubt your approach. Not following a RESTful approach can easily lead to massive controllers, mostly likely because you’ll need to fight the framework or reinvent the wheel every once in a while.

In short, not a good idea. Also, more often than not, it’s a symptom of inexperience or carelessness. Following the “Single Responsibility Principle” seems to be very hard under these circumstances as well—just an educated guess, though.

Approaching resources in your controller in a RESTful manner makes your life a lot less complicated and your apps easier to maintain as well—which adds to the overall stability of your app. Think about handling resources RESTfully from the perspective of an object’s lifecycle. You create, update, show (single or collections), update and destroy them.

For most cases, this will do the job. FYI, new and edit actions aren’t really part of REST—they are more like different versions of the show action, helping you present different stages in the resource’s lifecycle. Put together, most of the time, these seven standard controller actions give you all you need to manage your resources in your controllers. Another big advantage is that other Rails developers working with your code will be able to navigate your controllers much faster.

Following that line of RESTful cool aid, this also includes the way you name your controllers. The name of the resource you work on should be mirrored in the controller object.

For example, having a MissionsController that handles other resources than @mission objects is a smell that something is off. The sheer size of a controller often is also a dead giveaway that REST was ignored. Should you encounter large controllers that implement tons of customized methods that break with conventions, it can be a very effective strategy to split them into multiple distinctive controllers that have focused responsibilities—and basically manage only a single resource while adhering to a RESTful style. Break them apart aggressively and you will have an easier time composing their methods the Rails way.

## Rat’s Nest Resources

Look at the following example and ask yourself what’s wrong with this:

#### Nested AgentsController

app/controllers/agents_controller.rb

Here we check if we have a nested route that provides us with the id for a possible @mission object. If so, we want to use the associated object to get the agents from it. Otherwise, we’ll fetch a list of all agents for the view. Looks harmless, especially because it’s still concise, but it’s the start of a potentially much larger rat’s nest.

#### Nested Routes

Nothing obtuse about the nested routes here. In general, there is nothing wrong about this approach. The thing we should be careful about is how the controller handles this business—and as a consequence, how the view needs to adapt to it. Not exactly squeaky clean, as you can see below.

#### View With Unnecessary Conditional

app/views/agents/index.html.erb

Might also not look like a big deal, I get it. The level of complexity is not exactly real world though. Aside from that, the argument is more about dealing with resources in an object-oriented way and about using Rails to your fullest advantage.

I guess this is a little bit of an edge case regarding single responsibilities. It’s not exactly violating this idea too badly, even though we have a second object—@mission—for the association lingering around. But since we are using it for getting access to a specific set of agents, this is totally alright.

The branching is the part that is inelegant and will most likely lead to poor design decisions—both in views and controllers. Creating two versions of @agents in the same method is the perpetrator here. I’ll make it short, this can get out of hand really quickly. Once you start nesting resources like this, chances are good that new rats are hanging around soon.

And the view above also needs a conditional that adapts to the situation for when you have @agents associated with a @mission. As you can easily see, a little bit of sloppiness in your controller can lead to bloated views that have more code than needed. Let’s try another approach. Exterminator time!

#### Separate Controllers

Instead of nesting these resources, we should be giving each version of this resource its own distinctive, focused controller—one controller for “simple”, unnested agents and one for agents that are associated with a mission. We can achieve this via namespacing one of them under a /missions folder.

app/controllers/missions/agents_controller.rb

By wrapping this controller inside a module, we can avoid having AgentsController inherit twice from ApplicationController. Without it, we would run into an error like this: Unable to autoload constant Missions::AgentsController. I think a module is a small price to pay for making Rails autoloading happy. The second AgentsController can stay in the same file as before. It now only deals with one possible resource in index—prepping all agents without missions that are around.

app/controllers/agents_controller.rb

Of course, we also need to instruct our routes to look for this new namespaced controller if agents are associated with a mission.

After we've specified that our nested resource has a namespaced controller, we’re all set. When we do a rake routes check in the terminal, we’ll see that our new controller is namespaced and that we are good to go.

#### New Routes

Our nested resource for agents is now properly redirected to controllers/missions/agents_controller.rb and each action can take care of agents that are part of a mission. For the sake of completeness, let’s have a look at our final views as well:

#### Agents With Mission

app/views/missions/agents/index.html.erb

#### Agents Without Mission

app/views/agents/index.html

Well, let’s get rid of that little bit of duplication where we iterate over @agents also. I created a partial for rendering a list of agents and put it into a new shared directory under views

app/views/shared/_agents.html.erb

Nothing new or surprising here, but our views are now more DRY.

#### Agents With Mission

app/views/missions/agents/index.html.erb

#### Agents Without Mission

app/views/agents/index.html

Dope!

## Final Thoughts

I think if you as a beginner can avoid these AntiPatterns in your controllers, you are off to a very good start. There is still much left to learn for you in this regard, but give it time, it’s nothing that comes too easy or overnight. On the other hand, if you are hungry for more and like to explore more advanced techniques, I’m all for it of course. Don’t let yourself be discouraged by the “advanced” name tag.

Take your time, have fun, and don’t get frustrated if you need to revisit the topic again because you don’t yet have all pieces of the puzzle in place yet. If you are early in the development game and have started to play with design patterns, I believe you are way ahead of the game and have made the right decision.

Don’t wait, and get out of your comfort zone to stretch your gray matter a bit.