module RailsAdmin::Config::HasFields
Provides accessors and autoregistering of model’s fields.
Public Instance Methods
Accessor for all fields
# File lib/rails_admin/config/has_fields.rb, line 107 def all_fields ((ro_fields = _fields(true)).select(&:defined).presence || ro_fields).map{|f| f.section = self; f } end
configure a field without adding it.
# File lib/rails_admin/config/has_fields.rb, line 41 def configure(name, type = nil, &block) field(name, type, false, &block) end
exclude fields by name or by condition (block)
# File lib/rails_admin/config/has_fields.rb, line 61 def exclude_fields(*field_names, &block) block ||= lambda { |f| field_names.include?(f.name) } _fields.each {|f| f.defined = true } if _fields.select(&:defined).empty? _fields.select {|f| f.instance_eval &block }.each {|f| f.defined = false } end
Defines a configuration for a field.
# File lib/rails_admin/config/has_fields.rb, line 6 def field(name, type = nil, add_to_section = true, &block) field = _fields.find {|f| name == f.name } # some fields are hidden by default (belongs_to keys, has_many associations in list views.) # unhide them if config specifically defines them if field field.show unless field.instance_variable_get("@#{field.name}_registered").is_a?(Proc) end # Specify field as virtual if type is not specifically set and field was not # found in default stack if field.nil? && type.nil? field = (_fields << RailsAdmin::Config::Fields::Types.load(:string).new(self, name, {})).last # Register a custom field type if one is provided and it is different from # one found in default stack elsif !type.nil? && type != (field.nil? ? nil : field.type) _fields.delete(field) unless field.nil? properties = abstract_model.properties.find {|p| name == p[:name] } field = (_fields << RailsAdmin::Config::Fields::Types.load(type).new(self, name, properties)).last end # If field has not been yet defined add some default properties if add_to_section && !field.defined field.defined = true field.order = _fields.select(&:defined).length end # If a block has been given evaluate it and sort fields after that if block field.instance_eval &block end field end
Returns all field configurations for the model configuration instance. If no fields have been defined returns all fields. Defined fields are sorted to match their order property. If order was not specified it will match the order in which fields were defined.
If a block is passed it will be evaluated in the context of each field
# File lib/rails_admin/config/has_fields.rb, line 82 def fields(*field_names,&block) return all_fields if field_names.empty? && !block if field_names.empty? defined = _fields.select {|f| f.defined } defined = _fields if defined.empty? else defined = field_names.map{|field_name| _fields.find {|f| f.name == field_name } } end defined.map do |f| unless f.defined f.defined = true f.order = _fields.select(&:defined).length end f.instance_eval(&block) if block f end end
Defines configuration for fields by their type.
# File lib/rails_admin/config/has_fields.rb, line 102 def fields_of_type(type, &block) _fields.select {|f| type == f.type }.map! {|f| f.instance_eval &block } if block end
# File lib/rails_admin/config/has_fields.rb, line 71 def include_all_fields include_fields_if() { true } end
include fields by name and apply an optionnal block to each (through a call to fields), or include fields by conditions if no field names
# File lib/rails_admin/config/has_fields.rb, line 47 def include_fields(*field_names, &block) if field_names.empty? _fields.select {|f| f.instance_eval &block }.each do |f| unless f.defined f.defined = true f.order = _fields.select(&:defined).length end end else fields(*field_names, &block) end end
Get all fields defined as visible, in the correct order.
# File lib/rails_admin/config/has_fields.rb, line 112 def visible_fields i = 0 all_fields.map {|f| f.with(bindings) }.select(&:visible?).sort_by{|f| [f.order, i += 1] } # stable sort, damn end
Protected Instance Methods
Raw fields. Recursively returns parent section’s raw fields Duping it if accessed for modification.
# File lib/rails_admin/config/has_fields.rb, line 122 def _fields(readonly = false) return @_fields if @_fields return @_ro_fields if readonly && @_ro_fields unless self.class == RailsAdmin::Config::Sections::Base # parent is RailsAdmin::Config::Model, recursion is on Section's classes @_ro_fields ||= parent.send(self.class.superclass.to_s.underscore.split('/').last)._fields(true).freeze else # recursion tail @_ro_fields = @_fields = RailsAdmin::Config::Fields.factory(self) end readonly ? @_ro_fields : (@_fields ||= @_ro_fields.map(&:clone)) end