Module: RailsAdmin::Config

Defined in:
lib/rails_admin/config.rb,
lib/rails_admin/config/model.rb,
lib/rails_admin/config/fields.rb,
lib/rails_admin/config/actions.rb,
lib/rails_admin/config/sections.rb,
lib/rails_admin/config/hideable.rb,
lib/rails_admin/config/groupable.rb,
lib/rails_admin/config/proxyable.rb,
lib/rails_admin/config/has_fields.rb,
lib/rails_admin/config/has_groups.rb,
lib/rails_admin/config/actions/new.rb,
lib/rails_admin/config/fields/base.rb,
lib/rails_admin/config/actions/base.rb,
lib/rails_admin/config/fields/group.rb,
lib/rails_admin/config/actions/edit.rb,
lib/rails_admin/config/fields/types.rb,
lib/rails_admin/config/actions/show.rb,
lib/rails_admin/config/configurable.rb,
lib/rails_admin/config/actions/index.rb,
lib/rails_admin/config/sections/list.rb,
lib/rails_admin/config/sections/base.rb,
lib/rails_admin/config/sections/edit.rb,
lib/rails_admin/config/sections/show.rb,
lib/rails_admin/config/actions/delete.rb,
lib/rails_admin/config/sections/modal.rb,
lib/rails_admin/config/actions/export.rb,
lib/rails_admin/config/proxyable/proxy.rb,
lib/rails_admin/config/sections/export.rb,
lib/rails_admin/config/sections/create.rb,
lib/rails_admin/config/sections/nested.rb,
lib/rails_admin/config/sections/update.rb,
lib/rails_admin/config/fields/types/enum.rb,
lib/rails_admin/config/fields/types/text.rb,
lib/rails_admin/config/fields/types/time.rb,
lib/rails_admin/config/fields/types/date.rb,
lib/rails_admin/config/actions/dashboard.rb,
lib/rails_admin/config/fields/association.rb,
lib/rails_admin/config/fields/types/float.rb,
lib/rails_admin/config/fields/types/color.rb,
lib/rails_admin/config/actions/show_in_app.rb,
lib/rails_admin/config/actions/bulk_delete.rb,
lib/rails_admin/config/fields/types/hidden.rb,
lib/rails_admin/config/fields/types/string.rb,
lib/rails_admin/config/fields/types/integer.rb,
lib/rails_admin/config/fields/types/boolean.rb,
lib/rails_admin/config/fields/types/decimal.rb,
lib/rails_admin/config/actions/history_show.rb,
lib/rails_admin/config/actions/history_index.rb,
lib/rails_admin/config/fields/types/password.rb,
lib/rails_admin/config/fields/types/datetime.rb,
lib/rails_admin/config/fields/types/paperclip.rb,
lib/rails_admin/config/fields/types/timestamp.rb,
lib/rails_admin/config/fields/types/dragonfly.rb,
lib/rails_admin/config/fields/types/serialized.rb,
lib/rails_admin/config/fields/types/carrierwave.rb,
lib/rails_admin/config/fields/types/file_upload.rb,
lib/rails_admin/config/fields/types/bson_object_id.rb,
lib/rails_admin/config/fields/types/has_one_association.rb,
lib/rails_admin/config/fields/types/has_many_association.rb,
lib/rails_admin/config/fields/types/belongs_to_association.rb,
lib/rails_admin/config/fields/types/polymorphic_association.rb,
lib/rails_admin/config/fields/types/has_and_belongs_to_many_association.rb

Defined Under Namespace

Modules: Actions, Configurable, Fields, Groupable, HasFields, HasGroups, Hideable, Proxyable, Sections Classes: Model

Constant Summary

DEFAULT_AUTHENTICATION =

RailsAdmin is setup to try and authenticate with warden If warden is found, then it will try to authenticate

This is valid for custom warden setups, and also devise If you're using the admin setup for devise, you should set RailsAdmin to use the admin

Proc.new do
  request.env['warden'].try(:authenticate!)
end
DEFAULT_ATTR_ACCESSIBLE_ROLE =
Proc.new { :default }
DEFAULT_AUTHORIZE =
Proc.new {}
DEFAULT_AUDIT =
Proc.new {}
DEFAULT_CURRENT_USER =
Proc.new do
  request.env["warden"].try(:user) || respond_to?(:current_user) && current_user
end

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.compact_show_viewObject

hide blank fields in show view if true



58
59
60
# File 'lib/rails_admin/config.rb', line 58

def compact_show_view
  @compact_show_view
end

.default_hidden_fieldsObject

Fields to be hidden in show, create and update views



45
46
47
# File 'lib/rails_admin/config.rb', line 45

def default_hidden_fields
  @default_hidden_fields
end

.default_items_per_pageObject

Default items per page value used if a model level option has not been configured



49
50
51
# File 'lib/rails_admin/config.rb', line 49

def default_items_per_page
  @default_items_per_page
end

.default_search_operatorObject

Returns the value of attribute default_search_operator



51
52
53
# File 'lib/rails_admin/config.rb', line 51

def default_search_operator
  @default_search_operator
end

.excluded_modelsObject

Configuration option to specify which models you want to exclude.



35
36
37
# File 'lib/rails_admin/config.rb', line 35

def excluded_models
  @excluded_models
end

.included_modelsObject

Configuration option to specify a whitelist of models you want to RailsAdmin to work with. The excluded_models list applies against the whitelist as well and further reduces the models RailsAdmin will use. If included_models is left empty ([]), then RailsAdmin will automatically use all the models in your application (less any excluded_models you may have specified).



42
43
44
# File 'lib/rails_admin/config.rb', line 42

def included_models
  @included_models
end

.label_methodsObject

Configuration option to specify which method names will be searched for to be used as a label for object records. This defaults to [:name, :title]



55
56
57
# File 'lib/rails_admin/config.rb', line 55

def label_methods
  @label_methods
end

.main_app_nameObject

Application title, can be an array of two elements



32
33
34
# File 'lib/rails_admin/config.rb', line 32

def main_app_name
  @main_app_name
end

.registryObject (readonly)

Stores model configuration objects in a hash identified by model's class name.

See Also:



67
68
69
# File 'lib/rails_admin/config.rb', line 67

def registry
  @registry
end

.statisticsObject

hides dashboard record count bars when set to false



70
71
72
# File 'lib/rails_admin/config.rb', line 70

def statistics
  @statistics
end

.total_columns_widthObject

Set the max width of columns in list view before a new set is created



61
62
63
# File 'lib/rails_admin/config.rb', line 61

def total_columns_width
  @total_columns_width
end

Class Method Details

.actions(&block) ⇒ Object

Returns action configuration object



259
260
261
# File 'lib/rails_admin/config.rb', line 259

def actions(&block)
  RailsAdmin::Config::Actions.instance_eval(&block) if block
end

.attr_accessible_role(&blk) ⇒ Object



101
102
103
104
# File 'lib/rails_admin/config.rb', line 101

def attr_accessible_role(&blk)
  @attr_accessible_role = blk if blk
  @attr_accessible_role || DEFAULT_ATTR_ACCESSIBLE_ROLE
end

.audit_with(*args, &block) ⇒ Object

Setup auditing/history/versioning provider that observe objects lifecycle



107
108
109
110
111
112
113
114
115
116
117
# File 'lib/rails_admin/config.rb', line 107

def audit_with(*args, &block)
  extension = args.shift
  if(extension)
    @audit = Proc.new {
      @auditing_adapter = RailsAdmin::AUDITING_ADAPTERS[extension].new(*([self] + args).compact)
    }
  else
    @audit = block if block
  end
  @audit || DEFAULT_AUDIT
end

.authenticate_with(&blk) ⇒ Object

Setup authentication to be run as a before filter This is run inside the controller instance so you can setup any authentication you need to

By default, the authentication will run via warden if available and will run the default.

If you use devise, this will authenticate the same as authenticate_user!

Examples:

Devise admin

RailsAdmin.config do |config|
  config.authenticate_with do
    authenticate_admin!
  end
end

Custom Warden

RailsAdmin.config do |config|
  config.authenticate_with do
    warden.authenticate! :scope => :paranoid
  end
end

See Also:



95
96
97
98
# File 'lib/rails_admin/config.rb', line 95

def authenticate_with(&blk)
  @authenticate = blk if blk
  @authenticate || DEFAULT_AUTHENTICATION
end

.authorize_with(*args, &block) ⇒ Object

Setup authorization to be run as a before filter This is run inside the controller instance so you can setup any authorization you need to.

By default, there is no authorization.

To use an authorization adapter, pass the name of the adapter. For example, to use with CanCan[https://github.com/ryanb/cancan], pass it like this.

See the wiki[https://github.com/sferik/rails_admin/wiki] for more on authorization.

Examples:

Custom

RailsAdmin.config do |config|
  config.authorize_with do
    redirect_to root_path unless warden.user.is_admin?
  end
end

CanCan

RailsAdmin.config do |config|
  config.authorize_with :cancan
end

See Also:



142
143
144
145
146
147
148
149
150
151
152
# File 'lib/rails_admin/config.rb', line 142

def authorize_with(*args, &block)
  extension = args.shift
  if(extension)
    @authorize = Proc.new {
      @authorization_adapter = RailsAdmin::AUTHORIZATION_ADAPTERS[extension].new(*([self] + args).compact)
    }
  else
    @authorize = block if block
  end
  @authorize || DEFAULT_AUTHORIZE
end

.configure_with(extension) {|configuration| ... } ⇒ Object

Setup configuration using an extension-provided ConfigurationAdapter

Examples:

Custom configuration for role-based setup.

RailsAdmin.config do |config|
  config.configure_with(:custom) do |config|
    config.models = ['User', 'Comment']
    config.roles  = {
      'Admin' => :all,
      'User'  => ['User']
    }
  end
end

Yields:

  • (configuration)


166
167
168
169
# File 'lib/rails_admin/config.rb', line 166

def configure_with(extension)
  configuration = RailsAdmin::CONFIGURATION_ADAPTERS[extension].new
  yield(configuration) if block_given?
end

.current_user_method(&block) ⇒ Object

Setup a different method to determine the current user or admin logged in. This is run inside the controller instance and made available as a helper.

By default, request.env["warden"].user or current_user will be used.

Examples:

Custom

RailsAdmin.config do |config|
  config.current_user_method do
    current_admin
  end
end

See Also:



184
185
186
187
# File 'lib/rails_admin/config.rb', line 184

def current_user_method(&block)
  @current_user = block if block
  @current_user || DEFAULT_CURRENT_USER
end

.model(entity, &block) ⇒ Object

Loads a model configuration instance from the registry or registers a new one if one is yet to be added.

First argument can be an instance of requested model, its class object, its class name as a string or symbol or a RailsAdmin::AbstractModel instance.

If a block is given it is evaluated in the context of configuration instance.

Returns given model's configuration

See Also:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/rails_admin/config.rb', line 231

def model(entity, &block)
  key = begin
    if entity.kind_of?(RailsAdmin::AbstractModel)
      entity.model.try(:name).try :to_sym
    elsif entity.kind_of?(Class)
      entity.name.to_sym
    elsif entity.kind_of?(String) || entity.kind_of?(Symbol)
      entity.to_sym
    else
      entity.class.name.to_sym
    end
  end
  config = @registry[key] ||= RailsAdmin::Config::Model.new(entity)
  config.instance_eval(&block) if block
  config
end

.models(&block) ⇒ Object

Returns all model configurations

If a block is given it is evaluated in the context of configuration instances.

See Also:



269
270
271
# File 'lib/rails_admin/config.rb', line 269

def models(&block)
  RailsAdmin::AbstractModel.all.map{|m| model(m, &block)}
end

.models_poolObject

pool of all found model names from the whole application



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/rails_admin/config.rb', line 198

def models_pool
  possible =
    included_models.map(&:to_s).presence || (
    @@system_models ||= # memoization for tests
      ([Rails.application] + Rails::Application::Railties.engines).map do |app|
        (app.paths['app/models'] + app.config.autoload_paths).map do |load_path|
          Dir.glob(app.root.join(load_path)).map do |load_dir|
            Dir.glob(load_dir + "/**/*.rb").map do |filename|
              # app/models/module/class.rb => module/class.rb => module/class => Module::Class
              lchomp(filename, "#{app.root.join(load_dir)}/").chomp('.rb').camelize
            end
          end
        end
      end.flatten
    )

  excluded = (excluded_models.map(&:to_s) + ['RailsAdmin::History'])

  (possible - excluded).uniq.sort
end

.resetObject

Reset all configurations to defaults.

See Also:



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/rails_admin/config.rb', line 276

def reset
  @compact_show_view = true
  @authenticate = nil
  @authorize = nil
  @audit = nil
  @current_user = nil
  @default_hidden_fields = {}
  @default_hidden_fields[:base] = [:_type]
  @default_hidden_fields[:edit] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
  @default_hidden_fields[:show] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
  @default_items_per_page = 20
  @default_search_operator = 'default'
  @attr_accessible_role = nil
  @excluded_models = []
  @included_models = []
  @total_columns_width = 697
  @label_methods = [:name, :title]
  @main_app_name = Proc.new { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
  @registry = {}
  @statistics = true
  RailsAdmin::Config::Actions.reset
end

.reset_model(model) ⇒ Object

Reset a provided model's configuration.

See Also:



302
303
304
305
# File 'lib/rails_admin/config.rb', line 302

def reset_model(model)
  key = model.kind_of?(Class) ? model.name.to_sym : model.to_sym
  @registry.delete(key)
end

.visible_models(bindings) ⇒ Object

Get all models that are configured as visible sorted by their weight and label.

See Also:



311
312
313
314
315
# File 'lib/rails_admin/config.rb', line 311

def visible_models(bindings)
  models.map{|m| m.with(bindings) }.select{|m| m.visible? && bindings[:controller].authorized?(:index, m.abstract_model) && !m.abstract_model.embedded?}.sort do |a, b|
    (weight_order = a.weight <=> b.weight) == 0 ? a.label.downcase <=> b.label.downcase : weight_order
  end
end