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/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/actions/history_index.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

Defined Under Namespace

Modules: Actions, Configurable, 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

See Also:

proc {}
DEFAULT_AUTHORIZE = 
proc {}
DEFAULT_AUDIT = 
proc {}
DEFAULT_CURRENT_USER = 
proc {}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.browser_validations ⇒ Object

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



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

def browser_validations
  @browser_validations
end

.compact_show_view ⇒ Object

hide blank fields in show view if true



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

def compact_show_view
  @compact_show_view
end

.default_associated_collection_limit ⇒ Object

Default association limit



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

def default_associated_collection_limit
  @default_associated_collection_limit
end

.default_hidden_fields ⇒ Object

Fields to be hidden in show, create and update views



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

def default_hidden_fields
  @default_hidden_fields
end

.default_items_per_page ⇒ Object

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



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

def default_items_per_page
  @default_items_per_page
end

.default_search_operator ⇒ Object

Returns the value of attribute default_search_operator.



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

def default_search_operator
  @default_search_operator
end

.excluded_models ⇒ Object

Configuration option to specify which models you want to exclude.



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

def excluded_models
  @excluded_models
end

.forgery_protection_settings ⇒ Object

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



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

def forgery_protection_settings
  @forgery_protection_settings
end

.included_models ⇒ Object

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).



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

def included_models
  @included_models
end

.label_methods ⇒ Object

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]



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

def label_methods
  @label_methods
end

.main_app_name ⇒ Object

Application title, can be an array of two elements



25
26
27
 
# File 'lib/rails_admin/config.rb', line 25

def main_app_name
  @main_app_name
end

.navigation_static_label ⇒ Object

Returns the value of attribute navigation_static_label.



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

def navigation_static_label
  @navigation_static_label
end

.navigation_static_links ⇒ Object

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



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

def navigation_static_links
  @navigation_static_links
end

.parent_controller ⇒ Object

set parent controller



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

def parent_controller
  @parent_controller
end

.registry ⇒ Object (readonly)

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

See Also:



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

def registry
  @registry
end

.show_gravatar ⇒ Object

show Gravatar in Navigation bar



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

def show_gravatar
  @show_gravatar
end

.sidescroll ⇒ Object

Enable horizontal-scrolling table in list view, ignore total_columns_width



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

def sidescroll
  @sidescroll
end

.total_columns_width ⇒ Object

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



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

def total_columns_width
  @total_columns_width
end

Class Method Details

.actions(&block) ⇒ Object

Returns action configuration object



254
255
256
 
# File 'lib/rails_admin/config.rb', line 254

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

.audit_with(*args, &block) ⇒ Object

Setup auditing/history/versioning provider that observe objects lifecycle



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

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)
    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:



108
109
110
111
 
# File 'lib/rails_admin/config.rb', line 108

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, pass it like this.

See the 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:



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

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)
    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) 


177
178
179
180
 
# File 'lib/rails_admin/config.rb', line 177

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.user_ or current_user will be used.

Examples:

Custom

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

See Also:



195
196
197
198
 
# File 'lib/rails_admin/config.rb', line 195

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:



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

def model(entity, &block)
  key = begin
    if entity.is_a?(RailsAdmin::AbstractModel)
      entity.model.try(:name).try :to_sym
    elsif entity.is_a?(Class)
      entity.name.to_sym
    elsif entity.is_a?(String) || entity.is_a?(Symbol)
      entity.to_sym
    else
      entity.class.name.to_sym
    end
  end

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

.models ⇒ Object

Returns all model configurations

See Also:



261
262
263
 
# File 'lib/rails_admin/config.rb', line 261

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

.models_pool ⇒ Object

pool of all found model names from the whole application



209
210
211
 
# File 'lib/rails_admin/config.rb', line 209

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

.reset ⇒ Object

Reset all configurations to defaults.

See Also:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/rails_admin/config.rb', line 268

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] = [: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_associated_collection_limit = 100
  @default_search_operator = 'default'
  @excluded_models = []
  @included_models = []
  @total_columns_width = 697
  @sidescroll = nil
  @label_methods = [:name, :title]
  @main_app_name = proc { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
  @registry = {}
  @show_gravatar = true
  @navigation_static_links = {}
  @navigation_static_label = nil
  @parent_controller = '::ActionController::Base'
  @forgery_protection_settings = {with: :exception}
  RailsAdmin::Config::Actions.reset
end

.reset_all_models ⇒ Object

Reset all models configuration Used to clear all configurations when reloading code in development.

See Also:



309
310
311
 
# File 'lib/rails_admin/config.rb', line 309

def reset_all_models
  @registry = {}
end

.reset_model(model) ⇒ Object

Reset a provided model’s configuration.

See Also:



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

def reset_model(model)
  key = model.is_a?(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:



317
318
319
320
321
322
323
324
325
 
# File 'lib/rails_admin/config.rb', line 317

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