Agile Web Development

A glorified before_filter that loads an instance of an ActiveRecord object as the result of searching for said object against a model defined by a given model name. The value of the HTTP request parameter :id will be used as the default lookup value. LoadModel will require that the value of the id be an integer as well as give you the ability to require an instance be found and/or override several other default behaviors.

Example

  class SillyFellowController < Application
    load_model :silly_fellow
    def action
      @silly_fellow.do_something
    end
  ens

You can require that a model instance be found for all actions or given actions. Default behavior is to not require that a model instance be found. When require is on and a record is not found, a Glomp::RequiredRecordNotFound Exception is thrown.

To turn require on for all actions, simply pass true to a provided :require attribute, like so:

Example

  load_model :silly_fellow, :require => true

To turn require on for specific actions, pass an array of action names to :require. The model will be loaded for all actions, regardless of whether or not required is provided, but the exception will only be raised when an record is not found for the provided actions.

Example

  load_model :silly_fellow, :require => [:show, :update]

To use a different parameter key and model than the default, you can provide the values in the :paramater_key and :class options (though not necessary to provide them together), like the following:

Example

  load_model :foo, :class => :user, :parameter_key => :bar_id

In the above example, load_model will assume the parameter_key and the model’s primary/foreign key are both the same. For instance, the above example would result in a call like the following:

 @foo = User.find_by_bar_id(params[:bar_id])

If you want to use a different lookup/foreign key than the default, you can also provide that key name using the :foreign_key parameter; like so:

Example

 load_model :foo, :class => :user, :parameter_key => :bar_id,
   :foreign_key => :baz_id

Which would result in a call similar to the following:

 @foo = User.find_by_baz_id(params[:bar_id])

If you want to only use load_model for some actions, you can still name them as you would with a before_filter using :only or :except. If you provide an :only and an :except value. :only will always win out over :except when there are collisions (i.e. you provide both in the same call)

Example

 load_model :foo, :only => [:show]
 load_model :bar, :except => [:create]

Contact

Justin Knowlden <justin@goglomp.net>

License

See MIT-LICENSE

Owner: Justin Knowlden

Home: http://glomp.rubyforge.org/load_model/

Repository: http://glomp.rubyforge.org/svn/plugins/load_model

License: Rails' (MIT)

Category: Controllers