Class: RailsAdmin::Config::Fields::Base

Inherits:
Object
  • Object
show all
Includes:
Configurable, Groupable, Hideable, Proxyable
Defined in:
lib/rails_admin/config/fields/base.rb

Overview

rubocop:disable ClassLength

Instance Attribute Summary collapse

Attributes included from Proxyable

#bindings

Instance Method Summary collapse

Methods included from Groupable

#group

Methods included from Hideable

#hidden?, #hide, included, #show

Methods included from Configurable

#has_option?, #register_deprecated_instance_option, #register_instance_option

Methods included from Proxyable

#with

Constructor Details

#initialize(parent, name, properties) ⇒ Base

Returns a new instance of Base



19
20
21
22
23
24
25
26
27
28
29
# File 'lib/rails_admin/config/fields/base.rb', line 19

def initialize(parent, name, properties)
  @parent = parent
  @root = parent.root

  @abstract_model = parent.abstract_model
  @defined = false
  @name = name.to_sym
  @order = 0
  @properties = properties
  @section = parent
end

Instance Attribute Details

#abstract_modelObject (readonly)

Returns the value of attribute abstract_model



15
16
17
# File 'lib/rails_admin/config/fields/base.rb', line 15

def abstract_model
  @abstract_model
end

#definedObject

Returns the value of attribute defined



16
17
18
# File 'lib/rails_admin/config/fields/base.rb', line 16

def defined
  @defined
end

#nameObject (readonly)

Returns the value of attribute name



15
16
17
# File 'lib/rails_admin/config/fields/base.rb', line 15

def name
  @name
end

#orderObject

Returns the value of attribute order



16
17
18
# File 'lib/rails_admin/config/fields/base.rb', line 16

def order
  @order
end

#parentObject (readonly)

Returns the value of attribute parent



17
18
19
# File 'lib/rails_admin/config/fields/base.rb', line 17

def parent
  @parent
end

#propertiesObject (readonly)

Returns the value of attribute properties



15
16
17
# File 'lib/rails_admin/config/fields/base.rb', line 15

def properties
  @properties
end

#rootObject (readonly)

Returns the value of attribute root



17
18
19
# File 'lib/rails_admin/config/fields/base.rb', line 17

def root
  @root
end

#sectionObject

Returns the value of attribute section



16
17
18
# File 'lib/rails_admin/config/fields/base.rb', line 16

def section
  @section
end

Instance Method Details

#association?Boolean

Is this an association

Returns:

  • (Boolean)


225
226
227
# File 'lib/rails_admin/config/fields/base.rb', line 225

def association?
  is_a?(RailsAdmin::Config::Fields::Association)
end

#editable?Boolean

Returns:

  • (Boolean)


220
221
222
# File 'lib/rails_admin/config/fields/base.rb', line 220

def editable?
  !(@properties && @properties.read_only?)
end

#errorsObject

Reader for validation errors of the bound object



230
231
232
233
234
# File 'lib/rails_admin/config/fields/base.rb', line 230

def errors
  ([name] + children_fields).uniq.collect do |column_name|
    bindings[:object].errors[column_name]
  end.uniq.flatten
end

#form_default_valueObject



313
314
315
# File 'lib/rails_admin/config/fields/base.rb', line 313

def form_default_value
  (default_value if bindings[:object].new_record? && value.nil?)
end

#form_valueObject



317
318
319
# File 'lib/rails_admin/config/fields/base.rb', line 317

def form_value
  form_default_value.nil? ? formatted_value : form_default_value
end

#generic_field_helpObject



294
295
296
297
298
299
# File 'lib/rails_admin/config/fields/base.rb', line 294

def generic_field_help
  model = abstract_model.model_name.underscore
  model_lookup = "admin.help.#{model}.#{name}".to_sym
  translated = I18n.translate(model_lookup, help: generic_help, default: [generic_help])
  (translated.is_a?(Hash) ? translated.to_a.first[1] : translated).html_safe
end

#generic_helpObject



290
291
292
# File 'lib/rails_admin/config/fields/base.rb', line 290

def generic_help
  (required? ? I18n.translate('admin.form.required') : I18n.translate('admin.form.optional')) + '. '
end

#inspectObject



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/rails_admin/config/fields/base.rb', line 321

def inspect
  "#<#{self.class.name}[#{name}] #{
    instance_variables.collect do |v|
      value = instance_variable_get(v)
      if [:@parent, :@root, :@section, :@children_fields_registered,
          :@associated_model_config, :@group, :@bindings].include? v
        if value.respond_to? :name
          "#{v}=#{value.name.inspect}"
        else
          "#{v}=#{value.class.name}"
        end
      else
        "#{v}=#{value.inspect}"
      end
    end.join(', ')
  }>"
end

#inverse_ofObject



305
306
307
# File 'lib/rails_admin/config/fields/base.rb', line 305

def inverse_of
  nil
end

#method_nameObject



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

def method_name
  name
end

#optional(state = nil, &block) ⇒ Object

Inverse accessor whether this field is required.

See Also:

  • :required?


246
247
248
249
250
251
252
# File 'lib/rails_admin/config/fields/base.rb', line 246

def optional(state = nil, &block)
  if !state.nil? || block # rubocop:disable NonNilCheck
    required state.nil? ? proc { false == (instance_eval(&block)) } : false == state
  else
    optional?
  end
end

#optional=(state) ⇒ Object

Writer to make field optional.

See Also:

  • optional


257
258
259
# File 'lib/rails_admin/config/fields/base.rb', line 257

def optional=(state)
  optional(state)
end

#optional?Boolean

Reader whether field is optional.

Returns:

  • (Boolean)

See Also:

  • :required?


239
240
241
# File 'lib/rails_admin/config/fields/base.rb', line 239

def optional?
  !required?
end

#parse_input(_params) ⇒ Object



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

def parse_input(_params)
  # overriden
end

#typeObject

Reader for field's type



262
263
264
# File 'lib/rails_admin/config/fields/base.rb', line 262

def type
  @type ||= self.class.name.to_s.demodulize.underscore.to_sym
end

#type_css_classObject



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

def type_css_class
  "#{type}_type"
end

#valueObject

Reader for field's value



267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/rails_admin/config/fields/base.rb', line 267

def value
  bindings[:object].safe_send(name)
rescue NoMethodError => e
  raise e.exception <<-EOM.gsub(/^\s{10}/, '')
  #{e.message}
  If you want to use a RailsAdmin virtual field(= a field without corresponding instance method),
  you should declare 'formatted_value' in the field definition.
    field :#{name} do
      formatted_value{ bindings[:object].call_some_method }
    end
  EOM
end

#virtual?Boolean

Returns:

  • (Boolean)


39
40
41
# File 'lib/rails_admin/config/fields/base.rb', line 39

def virtual?
  properties.blank?
end