Models

Configuration location

A model configuration can be done in any of the places below:

• inside the RailsAdmin initializer:

  # config/initializers/rails_admin.rb
  
  RailsAdmin.config do |config|
    config.model 'ModelName' do 
      # ...
    end
  end

• in the model definition file:

  # app/models/model_name.rb
  
  class ModelName < ActiveRecord::Base
    rails_admin do 
      # ...
    end
  end

• in a separate concern file:

  module ModelNameAdmin
    extend ActiveSupport::Concern
  
    included do
      rails_admin do
        # ...
      end
    end
  end

  Don't forget to include the concern module in the model file itself by doing:

  include ModelNameAdmin

This is your choice to make:

• The initializer is loaded once at startup (modifications will show up when restarting the application) and may slow down your application startup, but all RailsAdmin configuration will stay in one place.
• Models are reloaded at each request in development mode (when modified), which may smooth your RailsAdmin development workflow.

The object_label_method method

The model configuration option object_label_method configures the title display of a single database record, i.e. an instance of a model.

By default it tries to call "name" or "title" methods on the record in question. If the object responds to neither, then the label will be constructed from the model's classname appended with its database identifier. You can add label methods (or replace the default [:name, :title]) with:

RailsAdmin.config {|c| c.label_methods << :description}

This object_label_method value is used in a number of places in RailsAdmin--for instance for the output of belongs to associations in the listing views of related models, for the option labels of the relational fields' input widgets in the edit views of related models and for part of the audit information stored in the history records--so keep in mind that this configuration option has widespread effects.

# config/initializers/rails_admin.rb
RailsAdmin.config do |config|
  config.model 'Team' do
    object_label_method do
      :custom_label_method
    end
  end
end

# app/models/team.rb
class Team < ActiveRecord::Base
  ...

  def custom_label_method
    "Team #{self.name}"
  end
end

Difference between label and object_label

label and object_label are both model configuration options. label is used whenever Rails Admin refers to a model class, while object_label is used whenever Rails Admin refers to an instance of a model class (representing a single database record).

Configuring models all at once

If you want to use config.model for all models, you may find it in ActiveRecord::Base.descendants

If cache_classes is off (by default it's off in development, but on in production): Call Rails.application.eager_load! before the following:

RailsAdmin.config do |config|
  ActiveRecord::Base.descendants.each do |imodel|
    config.model "#{imodel.name}" do
      list do
        exclude_fields :created_at, :updated_at
      end
    end
  end
end

Note: In versions prior to v1.0.0.rc, successive invocations of config.model to the same model would replace the configuration block rather than adding to it--meaning that the above block gets ignored for any model that also has a config block in the model class. (This was fixed by #2670.)

Changing the model scope

From the version 3.0.0, you can customize the model's scope to be used by RailsAdmin by setting the scope configuration option.

RailsAdmin.config do |config|
  config.model Team do
    scope { Team.any_in(color: %w[red blue]) }
  end
end

This can also be useful for canceling the effect of default_scope which is enforced in a model.

class Team < ActiveRecord::Base
  ...
  default_scope { where(deleted_at: nil) }
end

RailsAdmin.config do |config|
  config.model Team do
    scope { Team.unscoped }
  end
end