Best Practices for reusing code between controllers in Ruby on Rails

by

In my opinion, normal OO design principles apply:

  • If the code is really a set of utilities that doesn’t need access to object state, I would consider putting it in a module to be called separately. For instance, if the code is all mapping utilities, create a module Maps, and access the methods like: Maps::driving_directions.
  • If the code needs state and is used or could be used in every controller, put the code in ApplicationController.
  • If the code needs state and is used in a subset of all controllers that are closely and logically related (i.e. all about maps) then create a base class (class MapController < ApplicationController) and put the shared code there.
  • If the code needs state and is used in a subset of all controllers that are not very closely related, put it in a module and include it in necessary controllers.

In your case, the methods need state (params), so the choice depends on the logical relationship between the controllers that need it.
In addition:

Also:

  • Use partials when possible for repeated code and either place in a common ‘partials’ directory or include via a specific path.
  • Stick to a RESTful approach when possible (for methods) and if you find yourself creating a lot of non-RESTful methods consider extracting them to their own controller.

More Related Contents:

  1. Format a string containing Phone numbers
  2. SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
  3. How to understand nil vs. empty vs. blank in Ruby
  4. How do I get the current absolute URL in Ruby on Rails?
  5. SSL Error When installing rubygems, Unable to pull data from ‘https://rubygems.org/
  6. redirect_to using POST in rails
  7. Rails 4: List of available datatypes
  8. ActiveRecord.find(array_of_ids), preserving order
  9. In Ruby on Rails, how do I format a date with the “th” suffix, as in, “Sun Oct 5th”?
  10. What’s the best way to use SOAP with Ruby?
  11. Rails: ActiveRecord query based on association value
  12. Rails update_attributes without save?
  13. how to solve “ruby installation is missing psych” error?
  14. Detect MIME type of uploaded file in Ruby
  15. How can I find out the current route in Rails?
  16. Using send_file to download a file from Amazon S3?
  17. How to use ActiveRecord in a ruby script outside Rails?
  18. How to change the default path of view files in a Rails 3 controller?
  19. How do I set up the database.yml file in Rails?
  20. Rails I18n validation deprecation warning
  21. Rails each loop insert tag every 6 items?
  22. Validation failed: Upload file has an extension that does not match its contents
  23. Error message: Make sure that `gem install pg -v ‘0.18.1’` succeeds before bundling
  24. Ruby on Rails 3 howto make ‘OR’ condition
  25. Rails 4.0 expire_fragment/cache expiration not working
  26. Rails catch-all/globbing routes
  27. Always getting 401 Unauthorized with new install of Rails + Devise
  28. using has_many :through and build
  29. Why won’t Heroku accept my Gemfile.lock in Windows?
  30. Rails engines extending functionality

Leave a Comment