rails_admin 2.0.2 → 3.1.2

data/lib/rails_admin/config/fields/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
 require 'rails_admin/config/hideable'
@@ -14,13 +16,12 @@ module RailsAdmin
         include RailsAdmin::Config::Groupable
         include RailsAdmin::Config::Inspectable
 
-        attr_reader :name, :properties, :abstract_model
+        attr_reader :name, :properties, :abstract_model, :parent, :root
         attr_accessor :defined, :order, :section
-        attr_reader :parent, :root
 
-        NAMED_INSTANCE_VARIABLES = [
-          :@parent, :@root, :@section, :@children_fields_registered,
-          :@associated_model_config, :@group
+        NAMED_INSTANCE_VARIABLES = %i[
+          @parent @root @section @children_fields_registered
+          @associated_model_config @group
         ].freeze
 
         def initialize(parent, name, properties)
@@ -36,7 +37,7 @@ module RailsAdmin
         end
 
         register_instance_option :css_class do
-          "#{self.name}_field"
+          "#{name}_field"
         end
 
         def type_css_class
@@ -51,14 +52,36 @@ module RailsAdmin
           nil
         end
 
+        register_instance_option :sticky? do
+          false
+        end
+
         register_instance_option :sortable do
           !virtual? || children_fields.first || false
         end
 
+        def sort_column
+          if sortable == true
+            "#{abstract_model.table_name}.#{name}"
+          elsif (sortable.is_a?(String) || sortable.is_a?(Symbol)) && sortable.to_s.include?('.') # just provide sortable, don't do anything smart
+            sortable
+          elsif sortable.is_a?(Hash) # just join sortable hash, don't do anything smart
+            "#{sortable.keys.first}.#{sortable.values.first}"
+          elsif association # use column on target table
+            "#{associated_model_config.abstract_model.table_name}.#{sortable}"
+          else # use described column in the field conf.
+            "#{abstract_model.table_name}.#{sortable}"
+          end
+        end
+
         register_instance_option :searchable do
           !virtual? || children_fields.first || false
         end
 
+        register_instance_option :search_operator do
+          RailsAdmin::Config.default_search_operator
+        end
+
         register_instance_option :queryable? do
           !virtual?
         end
@@ -67,8 +90,22 @@ module RailsAdmin
           !!searchable
         end
 
-        register_instance_option :search_operator do
-          @search_operator ||= RailsAdmin::Config.default_search_operator
+        register_instance_option :filter_operators do
+          []
+        end
+
+        register_instance_option :default_filter_operator do
+          nil
+        end
+
+        def filter_options
+          {
+            label: label,
+            name: name,
+            operator: default_filter_operator,
+            operators: filter_operators,
+            type: type,
+          }
         end
 
         # serials and dates are reversed in list, which is more natural (last modified items first).
@@ -78,7 +115,7 @@ module RailsAdmin
 
         # list of columns I should search for that field [{ column: 'table_name.column', type: field.type }, {..}]
         register_instance_option :searchable_columns do
-          @searchable_columns ||= begin
+          @searchable_columns ||=
             case searchable
             when true
               [{column: "#{abstract_model.table_name}.#{name}", type: type}]
@@ -93,22 +130,21 @@ module RailsAdmin
                   table_name, column = f.split '.'
                   type = nil
                 elsif f.is_a?(Hash)                                              #  <Model|table_name> => <attribute|column>
-                  am = f.keys.first.is_a?(Class) && AbstractModel.new(f.keys.first)
-                  table_name = am && am.table_name || f.keys.first
+                  am = AbstractModel.new(f.keys.first) if f.keys.first.is_a?(Class)
+                  table_name = am&.table_name || f.keys.first
                   column = f.values.first
-                  property = am && am.properties.detect { |p| p.name == f.values.first.to_sym }
-                  type = property && property.type
+                  property = am&.properties&.detect { |p| p.name == f.values.first.to_sym }
+                  type = property&.type
                 else                                                             #  <attribute|column>
                   am = (association? ? associated_model_config.abstract_model : abstract_model)
                   table_name = am.table_name
                   column = f
                   property = am.properties.detect { |p| p.name == f.to_sym }
-                  type = property && property.type
+                  type = property&.type
                 end
                 {column: "#{table_name}.#{column}", type: (type || :string)}
               end
             end
-          end
         end
 
         register_instance_option :formatted_value do
@@ -155,7 +191,7 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :length do
-          @length ||= properties && properties.length
+          @length ||= properties&.length
         end
 
         # Accessor for field's length restrictions per validations
@@ -172,17 +208,17 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :required? do
-          context = begin
+          context =
             if bindings && bindings[:object]
               bindings[:object].persisted? ? :update : :create
             else
               :nil
             end
-          end
+
           (@required ||= {})[context] ||= !!([name] + children_fields).uniq.detect do |column_name|
             abstract_model.model.validators_on(column_name).detect do |v|
               !(v.options[:allow_nil] || v.options[:allow_blank]) &&
-                [:presence, :numericality, :attachment_presence].include?(v.kind) &&
+                %i[presence numericality attachment_presence].include?(v.kind) &&
                 (v.options[:on] == context || v.options[:on].blank?) &&
                 (v.options[:if].blank? && v.options[:unless].blank?)
             end
@@ -193,7 +229,7 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :serial? do
-          properties && properties.serial?
+          properties&.serial?
         end
 
         register_instance_option :view_helper do
@@ -213,6 +249,7 @@ module RailsAdmin
           returned = true
           (RailsAdmin.config.default_hidden_fields || {}).each do |section, fields|
             next unless self.section.is_a?("RailsAdmin::Config::Sections::#{section.to_s.camelize}".constantize)
+
             returned = false if fields.include?(name)
           end
           returned
@@ -223,12 +260,29 @@ module RailsAdmin
           []
         end
 
+        register_instance_option :eager_load do
+          false
+        end
+
+        register_deprecated_instance_option :eager_load?, :eager_load
+
+        def eager_load_values
+          case eager_load
+          when true
+            [name]
+          when false, nil
+            []
+          else
+            Array.wrap(eager_load)
+          end
+        end
+
         register_instance_option :render do
           bindings[:view].render partial: "rails_admin/main/#{partial}", locals: {field: self, form: bindings[:form]}
         end
 
         def editable?
-          !(@properties && @properties.read_only?)
+          !((@properties && @properties.read_only?) || (bindings[:object] && bindings[:object].readonly?))
         end
 
         # Is this an association
@@ -255,7 +309,7 @@ module RailsAdmin
         # @see RailsAdmin::Config::Fields::Base.register_instance_option :required?
         def optional(state = nil, &block)
           if !state.nil? || block
-            required state.nil? ? proc { false == instance_eval(&block) } : false == state
+            required state.nil? ? proc { instance_eval(&block) == false } : state == false
           else
             optional?
           end
@@ -277,14 +331,14 @@ module RailsAdmin
         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
+          raise e.exception <<~ERROR
+            #{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
+          ERROR
         end
 
         # Reader for nested attributes
@@ -298,7 +352,7 @@ module RailsAdmin
         end
 
         def generic_help
-          (required? ? I18n.translate('admin.form.required') : I18n.translate('admin.form.optional')) + '. '
+          "#{required? ? I18n.translate('admin.form.required') : I18n.translate('admin.form.optional')}. "
         end
 
         def generic_field_help
@@ -313,7 +367,7 @@ module RailsAdmin
         end
 
         def parse_input(_params)
-          # overriden
+          # overridden
         end
 
         def inverse_of

data/lib/rails_admin/config/fields/factories/action_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 

data/lib/rails_admin/config/fields/factories/active_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'
@@ -16,7 +18,9 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
         ["#{name}_attachment".to_sym, "#{name}_blob".to_sym]
       end
     children_fields = associations.map do |child_name|
-      next unless child_association = parent.abstract_model.associations.detect { |p| p.name.to_sym == child_name }
+      child_association = parent.abstract_model.associations.detect { |p| p.name.to_sym == child_name }
+      next unless child_association
+
       child_field = fields.detect { |f| f.name == child_name } || RailsAdmin::Config::Fields.default_factory.call(parent, child_association, fields)
       child_field.hide unless field == child_field
       child_field.filterable(false) unless field == child_field

data/lib/rails_admin/config/fields/factories/association.rb

@@ -1,25 +1,24 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/belongs_to_association'
 
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
-  if association = parent.abstract_model.associations.detect { |a| a.foreign_key == properties.name && [:belongs_to, :has_and_belongs_to_many].include?(a.type) }
-    field = RailsAdmin::Config::Fields::Types.load("#{association.polymorphic? ? :polymorphic : association.type}_association").new(parent, association.name, association)
+  parent.abstract_model.associations.filter { |a| Array(a.foreign_key).include?(properties.name) && %i[belongs_to has_and_belongs_to_many].include?(a.type) }.each do |association|
+    field = RailsAdmin::Config::Fields::Types.load(association.field_type).new(parent, association.name, association)
     fields << field
 
     child_columns = []
-    possible_field_names = begin
-      if association.polymorphic?
-        [:foreign_key, :foreign_type, :foreign_inverse_of]
-      else
-        [:foreign_key]
-      end.collect { |k| association.send(k) }.compact
-    end
+    possible_field_names = if association.polymorphic?
+                             %i[foreign_key foreign_type foreign_inverse_of]
+                           else
+                             [:foreign_key]
+                           end.flat_map { |k| Array(association.send(k)) }.compact
 
     parent.abstract_model.properties.select { |p| possible_field_names.include? p.name }.each do |column|
-      unless child_field = fields.detect { |f| f.name.to_s == column.name.to_s }
-        child_field = RailsAdmin::Config::Fields.default_factory.call(parent, column, fields)
-      end
+      child_field = fields.detect { |f| f.name.to_s == column.name.to_s }
+      child_field ||= RailsAdmin::Config::Fields.default_factory.call(parent, column, fields)
       child_columns << child_field
     end
 
@@ -29,5 +28,5 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
     end
 
     field.children_fields child_columns.collect(&:name)
-  end
+  end.any?
 end

data/lib/rails_admin/config/fields/factories/carrierwave.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'
@@ -7,12 +9,14 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
   if defined?(::CarrierWave) && model.is_a?(CarrierWave::Mount) && model.uploaders.include?(attachment_name = properties.name.to_s.chomp('_file_name').to_sym)
     columns = [model.uploader_options[attachment_name][:mount_on] || attachment_name, "#{attachment_name}_content_type".to_sym, "#{attachment_name}_file_size".to_sym]
     field = RailsAdmin::Config::Fields::Types.load(
-      [:serialized, :json].include?(properties.type) ? :multiple_carrierwave : :carrierwave,
+      %i[serialized json].include?(properties.type) ? :multiple_carrierwave : :carrierwave,
     ).new(parent, attachment_name, properties)
     fields << field
     children_fields = []
     columns.each do |children_column_name|
-      next unless child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      next unless child_properties
+
       children_field = fields.detect { |f| f.name == children_column_name } || RailsAdmin::Config::Fields.default_factory.call(parent, child_properties, fields)
       children_field.hide unless field == children_field
       children_field.filterable(false) unless field == children_field

data/lib/rails_admin/config/fields/factories/devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/password'
@@ -5,13 +7,15 @@ require 'rails_admin/config/fields/types/password'
 # Register a custom field factory for devise model
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
   if properties.name == :encrypted_password
-    extensions = [:password_salt, :reset_password_token, :remember_token]
+    extensions = %i[password_salt reset_password_token remember_token]
     fields << RailsAdmin::Config::Fields::Types.load(:password).new(parent, :password, properties)
     fields << RailsAdmin::Config::Fields::Types.load(:password).new(parent, :password_confirmation, properties)
     extensions.each do |ext|
       properties = parent.abstract_model.properties.detect { |p| ext == p.name }
       next unless properties
-      unless field = fields.detect { |f| f.name == ext }
+
+      field = fields.detect { |f| f.name == ext }
+      unless field
         RailsAdmin::Config::Fields.default_factory.call(parent, properties, fields)
         field = fields.last
       end

data/lib/rails_admin/config/fields/factories/dragonfly.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'
 
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
-  extensions = [:name, :uid]
+  extensions = %i[name uid]
   if (properties.name.to_s =~ /^(.+)_uid$/) && defined?(::Dragonfly) && parent.abstract_model.model.respond_to?(:dragonfly_attachment_classes) && parent.abstract_model.model.dragonfly_attachment_classes.collect(&:attribute).include?(attachment_name = Regexp.last_match[1].to_sym)
     field = RailsAdmin::Config::Fields::Types.load(:dragonfly).new(parent, attachment_name, properties)
     children_fields = []
     extensions.each do |ext|
       children_column_name = "#{attachment_name}_#{ext}".to_sym
-      next unless child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      next unless child_properties
+
       children_field = fields.detect { |f| f.name == children_column_name } || RailsAdmin::Config::Fields.default_factory.call(parent, child_properties, fields)
       children_field.hide
       children_field.filterable(false)

data/lib/rails_admin/config/fields/factories/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types/enum'
 require 'rails_admin/config/fields/types/active_record_enum'

data/lib/rails_admin/config/fields/factories/paperclip.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'
 
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
-  extensions = [:file_name, :content_type, :file_size, :updated_at, :fingerprint]
+  extensions = %i[file_name content_type file_size updated_at fingerprint]
   model = parent.abstract_model.model
   if (properties.name.to_s =~ /^(.+)_file_name$/) && defined?(::Paperclip) && model.try(:attachment_definitions) && model.attachment_definitions.key?(attachment_name = Regexp.last_match[1].to_sym)
     field = RailsAdmin::Config::Fields::Types.load(:paperclip).new(parent, attachment_name, properties)
     children_fields = []
     extensions.each do |ext|
       children_column_name = "#{attachment_name}_#{ext}".to_sym
-      next unless child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
+      next unless child_properties
+
       children_field = fields.detect { |f| f.name == children_column_name } || RailsAdmin::Config::Fields.default_factory.call(parent, child_properties, fields)
       children_field.hide
       children_field.filterable(false)

data/lib/rails_admin/config/fields/factories/password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types/password'
 

data/lib/rails_admin/config/fields/factories/shrine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'
 require 'rails_admin/config/fields/types/file_upload'
@@ -5,7 +7,7 @@ require 'rails_admin/config/fields/types/file_upload'
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
   next false unless defined?(::Shrine)
 
-  attachment_names = parent.abstract_model.model.ancestors.select { |m| m.is_a?(Shrine::Attachment) }.map { |a| a.instance_variable_get("@name") }
+  attachment_names = parent.abstract_model.model.ancestors.select { |m| m.is_a?(Shrine::Attachment) }.map { |a| a.instance_variable_get('@name') }
   next false if attachment_names.blank?
 
   attachment_name = attachment_names.detect { |a| a == properties.name.to_s.chomp('_data').to_sym }

data/lib/rails_admin/config/fields/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
@@ -12,9 +14,8 @@ module RailsAdmin
         include RailsAdmin::Config::Configurable
         include RailsAdmin::Config::Hideable
 
-        attr_reader :name, :abstract_model
+        attr_reader :name, :abstract_model, :parent, :root
         attr_accessor :section
-        attr_reader :parent, :root
 
         def initialize(parent, name)
           @parent = parent

data/lib/rails_admin/config/fields/types/action_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin
@@ -9,7 +11,7 @@ module RailsAdmin
           RailsAdmin::Config::Fields::Types.register(self)
 
           register_instance_option :version do
-            '1.1.1'
+            '1.3.1'
           end
 
           register_instance_option :css_location do
@@ -20,6 +22,10 @@ module RailsAdmin
             "https://cdnjs.cloudflare.com/ajax/libs/trix/#{version}/trix.js"
           end
 
+          register_instance_option :warn_dynamic_load do
+            true
+          end
+
           register_instance_option :partial do
             :form_action_text
           end

data/lib/rails_admin/config/fields/types/active_record_enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/enum'
 
 module RailsAdmin
@@ -29,12 +31,14 @@ module RailsAdmin
 
           def parse_value(value)
             return unless value.present?
+
             abstract_model.model.attribute_types[name.to_s].serialize(value)
           end
 
           def parse_input(params)
             value = params[name]
             return unless value
+
             params[name] = parse_input_value(value)
           end
 

data/lib/rails_admin/config/fields/types/active_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/file_upload'
 
 module RailsAdmin
@@ -8,7 +10,7 @@ module RailsAdmin
           RailsAdmin::Config::Fields::Types.register(self)
 
           register_instance_option :thumb_method do
-            {resize: '100x100>'}
+            {resize_to_limit: [100, 100]}
           end
 
           register_instance_option :delete_method do
@@ -17,12 +19,30 @@ module RailsAdmin
 
           register_instance_option :image? do
             if value
-              value.filename.to_s.split('.').last =~ /jpg|jpeg|png|gif|svg/i
+              mime_type = Mime::Type.lookup_by_extension(value.filename.extension_without_delimiter)
+              mime_type.to_s.match?(/^image/)
             end
           end
 
+          register_instance_option :eager_load do
+            {"#{name}_attachment": :blob}
+          end
+
+          register_instance_option :direct? do
+            false
+          end
+
+          register_instance_option :html_attributes do
+            {
+              required: required? && !value.present?,
+            }.merge(
+              direct? && {data: {direct_upload_url: bindings[:view].main_app.rails_direct_uploads_url}} || {},
+            )
+          end
+
           def resource_url(thumb = false)
             return nil unless value
+
             if thumb && value.variable?
               thumb = thumb_method if thumb == true
               variant = value.variant(thumb)
@@ -36,7 +56,7 @@ module RailsAdmin
 
           def value
             attachment = super
-            attachment if attachment && attachment.attached?
+            attachment if attachment&.attached?
           end
         end
       end

data/lib/rails_admin/config/fields/types/all.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/action_text'
 require 'rails_admin/config/fields/types/active_record_enum'
 require 'rails_admin/config/fields/types/active_storage'
 require 'rails_admin/config/fields/types/belongs_to_association'
 require 'rails_admin/config/fields/types/boolean'
 require 'rails_admin/config/fields/types/bson_object_id'
+require 'rails_admin/config/fields/types/composite_keys_belongs_to_association'
 require 'rails_admin/config/fields/types/date'
 require 'rails_admin/config/fields/types/datetime'
 require 'rails_admin/config/fields/types/decimal'
@@ -38,3 +41,4 @@ require 'rails_admin/config/fields/types/froala'
 require 'rails_admin/config/fields/types/json'
 require 'rails_admin/config/fields/types/inet'
 require 'rails_admin/config/fields/types/uuid'
+require 'rails_admin/config/fields/types/citext'

data/lib/rails_admin/config/fields/types/belongs_to_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/association'
 
 module RailsAdmin
@@ -7,6 +9,10 @@ module RailsAdmin
         class BelongsToAssociation < RailsAdmin::Config::Fields::Association
           RailsAdmin::Config::Fields::Types.register(self)
 
+          register_instance_option :filter_operators do
+            %w[_discard like not_like is starts_with ends_with] + (required? ? [] : %w[_separator _present _blank])
+          end
+
           register_instance_option :formatted_value do
             (o = value) && o.send(associated_model_config.object_label_method)
           end
@@ -23,28 +29,16 @@ module RailsAdmin
             nested_form ? :form_nested_one : :form_filtering_select
           end
 
-          register_instance_option :inline_add do
-            true
-          end
-
-          register_instance_option :inline_edit do
+          register_instance_option :eager_load do
             true
           end
 
-          register_instance_option :eager_load? do
-            true
-          end
-
-          def associated_primary_key
-            @associated_primary_key ||= association.primary_key
-          end
-
           def selected_id
-            bindings[:object].send(foreign_key)
+            bindings[:object].safe_send(association.key_accessor)
           end
 
           def method_name
-            nested_form ? "#{name}_attributes".to_sym : association.foreign_key
+            nested_form ? "#{name}_attributes".to_sym : super
           end
 
           def multiple?