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/hideable.rb,
lib/rails_admin/config/sections.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/lazy_model.rb,
lib/rails_admin/config/actions/new.rb,
lib/rails_admin/config/fields/base.rb,
lib/rails_admin/config/inspectable.rb,
lib/rails_admin/config/actions/base.rb,
lib/rails_admin/config/actions/edit.rb,
lib/rails_admin/config/actions/show.rb,
lib/rails_admin/config/configurable.rb,
lib/rails_admin/config/fields/group.rb,
lib/rails_admin/config/fields/types.rb,
lib/rails_admin/config/actions/index.rb,
lib/rails_admin/config/sections/base.rb,
lib/rails_admin/config/sections/edit.rb,
lib/rails_admin/config/sections/list.rb,
lib/rails_admin/config/sections/show.rb,
lib/rails_admin/config/actions/delete.rb,
lib/rails_admin/config/actions/export.rb,
lib/rails_admin/config/sections/modal.rb,
lib/rails_admin/config/has_description.rb,
lib/rails_admin/config/proxyable/proxy.rb,
lib/rails_admin/config/sections/create.rb,
lib/rails_admin/config/sections/export.rb,
lib/rails_admin/config/sections/nested.rb,
lib/rails_admin/config/sections/update.rb,
lib/rails_admin/config/actions/dashboard.rb,
lib/rails_admin/config/fields/types/date.rb,
lib/rails_admin/config/fields/types/enum.rb,
lib/rails_admin/config/fields/types/inet.rb,
lib/rails_admin/config/fields/types/json.rb,
lib/rails_admin/config/fields/types/text.rb,
lib/rails_admin/config/fields/types/time.rb,
lib/rails_admin/config/fields/types/uuid.rb,
lib/rails_admin/config/fields/association.rb,
lib/rails_admin/config/fields/types/color.rb,
lib/rails_admin/config/fields/types/float.rb,
lib/rails_admin/config/actions/bulk_delete.rb,
lib/rails_admin/config/actions/show_in_app.rb,
lib/rails_admin/config/fields/types/citext.rb,
lib/rails_admin/config/fields/types/froala.rb,
lib/rails_admin/config/fields/types/hidden.rb,
lib/rails_admin/config/fields/types/shrine.rb,
lib/rails_admin/config/fields/types/string.rb,
lib/rails_admin/config/actions/history_show.rb,
lib/rails_admin/config/fields/types/boolean.rb,
lib/rails_admin/config/fields/types/decimal.rb,
lib/rails_admin/config/fields/types/integer.rb,
lib/rails_admin/config/fields/types/numeric.rb,
lib/rails_admin/config/actions/history_index.rb,
lib/rails_admin/config/const_load_suppressor.rb,
lib/rails_admin/config/fields/types/datetime.rb,
lib/rails_admin/config/fields/types/password.rb,
lib/rails_admin/config/fields/types/ck_editor.rb,
lib/rails_admin/config/fields/types/dragonfly.rb,
lib/rails_admin/config/fields/types/paperclip.rb,
lib/rails_admin/config/fields/types/timestamp.rb,
lib/rails_admin/config/fields/types/wysihtml5.rb,
lib/rails_admin/config/fields/types/serialized.rb,
lib/rails_admin/config/fields/types/simple_mde.rb,
lib/rails_admin/config/fields/types/action_text.rb,
lib/rails_admin/config/fields/types/carrierwave.rb,
lib/rails_admin/config/fields/types/code_mirror.rb,
lib/rails_admin/config/fields/types/file_upload.rb,
lib/rails_admin/config/fields/types/string_like.rb,
lib/rails_admin/config/fields/types/active_storage.rb,
lib/rails_admin/config/fields/types/bson_object_id.rb,
lib/rails_admin/config/fields/types/active_record_enum.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/multiple_carrierwave.rb,
lib/rails_admin/config/fields/types/multiple_file_upload.rb,
lib/rails_admin/config/fields/types/belongs_to_association.rb,
lib/rails_admin/config/fields/types/multiple_active_storage.rb,
lib/rails_admin/config/fields/types/polymorphic_association.rb,
lib/rails_admin/config/fields/types/has_and_belongs_to_many_association.rb,
lib/rails_admin/config/fields/types/composite_keys_belongs_to_association.rb

Defined Under Namespace

Modules: Actions, Configurable, ConstLoadSuppressor, Fields, Groupable, HasDescription, HasFields, HasGroups, Hideable, Inspectable, Proxyable, Sections Classes: LazyModel, Model

Constant Summary collapse

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 {}
DEFAULT_AUTHORIZE =
proc {}
DEFAULT_AUDIT =
proc {}
DEFAULT_CURRENT_USER =
proc {}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.asset_sourceObject



245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/rails_admin/config.rb', line 245

def asset_source
  @asset_source ||=
    begin
      detected = defined?(Sprockets) ? :sprockets : :invalid
      unless ARGV.join(' ').include? 'rails_admin:install'
        warn <<~MSG
          [Warning] After upgrading RailsAdmin to 3.x you haven't set asset_source yet, using :#{detected} as the default.
          To suppress this message, run 'rails rails_admin:install' to setup the asset delivery method suitable to you.
        MSG
      end
      detected
    end
end

.browser_validationsObject

Tell browsers whether to use the native HTML5 validations (novalidate form option).



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

def browser_validations
  @browser_validations
end

.compact_show_viewObject

hide blank fields in show view if true



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

def compact_show_view
  @compact_show_view
end

.default_associated_collection_limitObject

Default association limit



47
48
49
# File 'lib/rails_admin/config.rb', line 47

def default_associated_collection_limit
  @default_associated_collection_limit
end

.default_hidden_fieldsObject

Fields to be hidden in show, create and update views



40
41
42
# File 'lib/rails_admin/config.rb', line 40

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



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

def default_items_per_page
  @default_items_per_page
end

.default_search_operatorObject

Returns the value of attribute default_search_operator.



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

def default_search_operator
  @default_search_operator
end

.excluded_modelsObject

Configuration option to specify which models you want to exclude.



30
31
32
# File 'lib/rails_admin/config.rb', line 30

def excluded_models
  @excluded_models
end

.forgery_protection_settingsObject

set settings for protect_from_forgery method By default, it raises exception upon invalid CSRF tokens



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

def forgery_protection_settings
  @forgery_protection_settings
end

.included_modelsObject

Configuration option to specify a allowlist of models you want to RailsAdmin to work with. The excluded_models list applies against the allowlist 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).



37
38
39
# File 'lib/rails_admin/config.rb', line 37

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]



53
54
55
# File 'lib/rails_admin/config.rb', line 53

def label_methods
  @label_methods
end

.main_app_nameObject

Application title, can be an array of two elements



27
28
29
# File 'lib/rails_admin/config.rb', line 27

def main_app_name
  @main_app_name
end

Bootstrap CSS classes used for Navigation bar



75
76
77
# File 'lib/rails_admin/config.rb', line 75

def navbar_css_classes
  @navbar_css_classes
end

Returns the value of attribute navigation_static_label.



82
83
84
# File 'lib/rails_admin/config.rb', line 82

def navigation_static_label
  @navigation_static_label
end

accepts a hash of static links to be shown below the main navigation



81
82
83
# File 'lib/rails_admin/config.rb', line 81

def navigation_static_links
  @navigation_static_links
end

.parent_controllerObject

set parent controller



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

def parent_controller
  @parent_controller
end

.registryObject (readonly)

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

See Also:



72
73
74
# File 'lib/rails_admin/config.rb', line 72

def registry
  @registry
end

.show_gravatarObject

show Gravatar in Navigation bar



78
79
80
# File 'lib/rails_admin/config.rb', line 78

def show_gravatar
  @show_gravatar
end

Class Method Details

.actions(&block) ⇒ Object

Setup actions to be used.



291
292
293
294
295
296
# File 'lib/rails_admin/config.rb', line 291

def actions(&block)
  return unless block

  RailsAdmin::Config::Actions.reset
  RailsAdmin::Config::Actions.instance_eval(&block)
end

.audit_with(*args, &block) ⇒ Object

Setup auditing/versioning provider that observe objects lifecycle



116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/rails_admin/config.rb', line 116

def audit_with(*args, &block)
  extension = args.shift
  if extension
    klass = RailsAdmin::AUDITING_ADAPTERS[extension]
    klass.setup if klass.respond_to? :setup
    @audit = proc do
      @auditing_adapter = klass.new(*([self] + args).compact, &block)
    end
  elsif block
    @audit = 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:



110
111
112
113
# File 'lib/rails_admin/config.rb', line 110

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 CanCanCan[https://github.com/CanCanCommunity/cancancan/], pass it like this.

See the wiki[https://github.com/railsadminteam/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

CanCanCan

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

See Also:



153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/rails_admin/config.rb', line 153

def authorize_with(*args, &block)
  extension = args.shift
  if extension
    klass = RailsAdmin::AUTHORIZATION_ADAPTERS[extension]
    klass.setup if klass.respond_to? :setup
    @authorize = proc do
      @authorization_adapter = klass.new(*([self] + args).compact, &block)
    end
  elsif block
    @authorize = 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)


179
180
181
182
# File 'lib/rails_admin/config.rb', line 179

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:



197
198
199
200
# File 'lib/rails_admin/config.rb', line 197

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:



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/rails_admin/config.rb', line 227

def model(entity, &block)
  key =
    case entity
    when RailsAdmin::AbstractModel
      entity.model.try(:name).try :to_sym
    when Class, ConstLoadSuppressor::ConstProxy
      entity.name.to_sym
    when String, Symbol
      entity.to_sym
    else
      entity.class.name.to_sym
    end

  @registry[key] ||= RailsAdmin::Config::LazyModel.new(key.to_s)
  @registry[key].add_deferred_block(&block) if block
  @registry[key]
end

.modelsObject

Returns all model configurations

See Also:



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

def models
  RailsAdmin::AbstractModel.all.collect { |m| model(m) }
end

.models_poolObject

pool of all found model names from the whole application



211
212
213
# File 'lib/rails_admin/config.rb', line 211

def models_pool
  (viable_models - excluded_models.collect(&:to_s)).uniq.sort
end

.reload!Object

Perform reset, then load RailsAdmin initializer again



347
348
349
350
# File 'lib/rails_admin/config.rb', line 347

def reload!
  reset
  load RailsAdmin::Engine.config.initializer_path
end

.resetObject

Reset all configurations to defaults.

See Also:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/rails_admin/config.rb', line 308

def reset
  @compact_show_view = true
  @browser_validations = true
  @authenticate = nil
  @authorize = nil
  @audit = nil
  @current_user = nil
  @default_hidden_fields = {}
  @default_hidden_fields[:base] = [:_type]
  @default_hidden_fields[:edit] = %i[id _id created_at created_on deleted_at updated_at updated_on deleted_on]
  @default_hidden_fields[:show] = %i[id _id created_at created_on deleted_at updated_at updated_on deleted_on]
  @default_items_per_page = 20
  @default_associated_collection_limit = 100
  @default_search_operator = 'default'
  @excluded_models = []
  @included_models = []
  @label_methods = %i[name title]
  @main_app_name = proc { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
  @registry = {}
  @navbar_css_classes = %w[navbar-dark bg-primary border-bottom]
  @show_gravatar = true
  @navigation_static_links = {}
  @navigation_static_label = nil
  @asset_source = nil
  @parent_controller = '::ActionController::Base'
  @forgery_protection_settings = {with: :exception}
  RailsAdmin::Config::Actions.reset
  RailsAdmin::AbstractModel.reset
end

.reset_model(model) ⇒ Object

Reset a provided model's configuration.

See Also:



341
342
343
344
# File 'lib/rails_admin/config.rb', line 341

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

.sidescroll=(_) ⇒ Object



286
287
288
# File 'lib/rails_admin/config.rb', line 286

def sidescroll=(_)
  ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
end

.total_columns_width=(_) ⇒ Object



282
283
284
# File 'lib/rails_admin/config.rb', line 282

def total_columns_width=(_)
  ActiveSupport::Deprecation.warn('The total_columns_width configuration option is deprecated and has no effect.')
end

.visible_models(bindings) ⇒ Object

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

See Also:



355
356
357
358
359
360
361
362
363
# File 'lib/rails_admin/config.rb', line 355

def visible_models(bindings)
  visible_models_with_bindings(bindings).sort do |a, b|
    if (weight_order = a.weight <=> b.weight) == 0
      a.label.casecmp(b.label)
    else
      weight_order
    end
  end
end