Ruby on Rails: Where to define global constants?

by

If your model is really “responsible” for the constants you should stick them there. You can create class methods to access them without creating a new object instance:

class Card < ActiveRecord::Base
  def self.colours
    ['white', 'blue']
  end
end

# accessible like this
Card.colours

Alternatively, you can create class variables and an accessor. This is however discouraged as class variables might act kind of surprising with inheritance and in multi-thread environments.

class Card < ActiveRecord::Base
  @@colours = ['white', 'blue'].freeze
  cattr_reader :colours
end

# accessible the same as above
Card.colours

The two options above allow you to change the returned array on each invocation of the accessor method if required. If you have true a truly unchangeable constant, you can also define it on the model class:

class Card < ActiveRecord::Base
  COLOURS = ['white', 'blue'].freeze
end

# accessible as
Card::COLOURS

You could also create global constants which are accessible from everywhere in an initializer like in the following example. This is probably the best place, if your colours are really global and used in more than one model context.

# put this into config/initializers/my_constants.rb
COLOURS = ['white', 'blue'].freeze

# accessible as a top-level constant this time
COLOURS

Note: when we define constants above, often we want to freeze the array. That prevents other code from later (inadvertently) modifying the array by e.g. adding a new element. Once an object is frozen, it can’t be changed anymore.

More Related Contents:

  1. ‘sudo gem install’ or ‘gem install’ and gem locations
  2. Multiple objects in a Rails form
  3. ActiveRecord Query Union
  4. Validate presence of one field or another (XOR)
  5. Altering the primary key in Rails to be a string
  6. Deprecated warning for Rails 4 has_many with order
  7. Float vs Decimal in ActiveRecord
  8. Heroku deployment failed because of sqlite3 gem error
  9. twitter bootstrap drop down suddenly not working
  10. Error installing Nokogiri 1.5.0 with rails 3.1.0 and ubuntu
  11. How do I “activate” a different version of a particular gem?
  12. A migration to add unique constraint to a combination of columns
  13. POST JSON to API using Rails and HTTParty
  14. Devise update user without password
  15. Rails 3 equivalent for periodically_call_remote
  16. libffi.so.6: cannot open shared object file in rails
  17. Convert HTML to word file ?
  18. 400 Bad Request – request header or cookie too large
  19. Ruby on Rails 3 – Reload lib directory for each request
  20. How to use long id in Rails applications?
  21. Rails: “Next post” and “Previous post” links in my show view, how to?
  22. How to configure Log4r with Rails 3.0.x?
  23. How do I ignore the authenticity token for specific actions in Rails?
  24. How to get started on TDD with Ruby on Rails? [closed]
  25. What is the difference between pluck and collect in Rails?
  26. How can I disable logging in Ruby on Rails on a per-action basis?
  27. Template is missing
  28. How to integrate a Wrap Bootstrap theme into an Rails application?
  29. Is the server running on host “localhost” (::1) and accepting TCP/IP connections on port 5432?
  30. How to programmatically list all controllers in Rails

Leave a Comment