rails_admin 3.1.4 → 3.3.0

data/lib/rails_admin/adapters/active_record.rb

@@ -15,7 +15,7 @@ module RailsAdmin
       end
 
       def get(id, scope = scoped)
-        object = scope.where(primary_key => id).first
+        object = primary_key_scope(scope, id).first
         return unless object
 
         object.extend(ObjectExtension)
@@ -72,6 +72,14 @@ module RailsAdmin
 
       delegate :primary_key, :table_name, to: :model, prefix: false
 
+      def quoted_table_name
+        model.quoted_table_name
+      end
+
+      def quote_column_name(name)
+        model.connection.quote_column_name(name)
+      end
+
       def encoding
         adapter =
           if ::ActiveRecord::Base.respond_to?(:connection_db_config)
@@ -107,10 +115,42 @@ module RailsAdmin
         true
       end
 
+      def format_id(id)
+        if primary_key.is_a? Array
+          RailsAdmin.config.composite_keys_serializer.serialize(id)
+        else
+          id
+        end
+      end
+
+      def parse_id(id)
+        if primary_key.is_a?(Array)
+          ids = RailsAdmin.config.composite_keys_serializer.deserialize(id)
+          primary_key.each_with_index do |key, i|
+            ids[i] = model.type_for_attribute(key).cast(ids[i])
+          end
+          ids
+        else
+          id
+        end
+      end
+
     private
 
+      def primary_key_scope(scope, id)
+        if primary_key.is_a? Array
+          scope.where(primary_key.zip(parse_id(id)).to_h)
+        else
+          scope.where(primary_key => id)
+        end
+      end
+
       def bulk_scope(scope, options)
-        scope.where(primary_key => options[:bulk_ids])
+        if primary_key.is_a? Array
+          options[:bulk_ids].map { |id| primary_key_scope(scope, id) }.reduce(&:or)
+        else
+          scope.where(primary_key => options[:bulk_ids])
+        end
       end
 
       def sort_scope(scope, options)
@@ -201,6 +241,8 @@ module RailsAdmin
           case @type
           when :boolean
             boolean_unary_operators
+          when :uuid
+            uuid_unary_operators
           when :integer, :decimal, :float
             numeric_unary_operators
           else
@@ -230,6 +272,7 @@ module RailsAdmin
           )
         end
         alias_method :numeric_unary_operators, :boolean_unary_operators
+        alias_method :uuid_unary_operators, :boolean_unary_operators
 
         def range_filter(min, max)
           if min && max && min == max
@@ -255,9 +298,12 @@ module RailsAdmin
         end
 
         def build_statement_for_boolean
-          return ["(#{@column} IS NULL OR #{@column} = ?)", false] if %w[false f 0].include?(@value)
-
-          ["(#{@column} = ?)", true] if %w[true t 1].include?(@value)
+          case @value
+          when 'false', 'f', '0'
+            ["(#{@column} IS NULL OR #{@column} = ?)", false]
+          when 'true', 't', '1'
+            ["(#{@column} = ?)", true]
+          end
         end
 
         def column_for_value(value)

data/lib/rails_admin/adapters/mongoid/association.rb

@@ -46,7 +46,7 @@ module RailsAdmin
 
         def klass
           if polymorphic? && %i[referenced_in belongs_to].include?(macro)
-            polymorphic_parents(:mongoid, model.name, name) || []
+            polymorphic_parents(:mongoid, association.inverse_class_name, name) || []
           else
             association.klass
           end

data/lib/rails_admin/adapters/mongoid/object_extension.rb

@@ -20,11 +20,6 @@ module RailsAdmin
                   send(name)&.save
                 end
               end
-              object.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
-                def #{name}_id=(item_id)
-                  self.#{name} = (#{association.klass}.find(item_id) rescue nil)
-                end
-              RUBY
             end
           end
         end

data/lib/rails_admin/adapters/mongoid.rb

@@ -251,9 +251,12 @@ module RailsAdmin
         end
 
         def build_statement_for_boolean
-          return {@column => false} if %w[false f 0].include?(@value)
-
-          {@column => true} if %w[true t 1].include?(@value)
+          case @value
+          when 'false', 'f', '0'
+            {@column => false}
+          when 'true', 't', '1'
+            {@column => true}
+          end
         end
 
         def column_for_value(value)

data/lib/rails_admin/config/actions/index.rb

@@ -50,9 +50,11 @@ module RailsAdmin
               format.json do
                 output =
                   if params[:compact]
-                    primary_key_method = @association ? @association.associated_primary_key : @model_config.abstract_model.primary_key
-                    label_method = @model_config.object_label_method
-                    @objects.collect { |o| {id: o.send(primary_key_method).to_s, label: o.send(label_method).to_s} }
+                    if @association
+                      @association.collection(@objects).collect { |(label, id)| {id: id, label: label} }
+                    else
+                      @objects.collect { |object| {id: object.id.to_s, label: object.send(@model_config.object_label_method).to_s} }
+                    end
                   else
                     @objects.to_json(@schema)
                   end

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

@@ -13,7 +13,7 @@ module RailsAdmin
         end
 
         def method_name
-          association.key_accessor
+          nested_form ? :"#{name}_attributes" : association.key_accessor
         end
 
         register_instance_option :pretty_value do
@@ -56,7 +56,30 @@ module RailsAdmin
         # preload entire associated collection (per associated_collection_scope) on load
         # Be sure to set limit in associated_collection_scope if set is large
         register_instance_option :associated_collection_cache_all do
-          @associated_collection_cache_all ||= (associated_model_config.abstract_model.count < associated_model_limit)
+          @associated_collection_cache_all ||= dynamically_scope_by.blank? && (associated_model_config.abstract_model.count < associated_model_limit)
+        end
+
+        # client-side dynamic scoping
+        register_instance_option :dynamically_scope_by do
+          nil
+        end
+
+        # parses #dynamically_scope_by and returns a Hash in the form of
+        # {[form field name in this model]: [field name in the associated model]}
+        def dynamic_scope_relationships
+          @dynamic_scope_relationships ||=
+            Array.wrap(dynamically_scope_by).flat_map do |field|
+              field.is_a?(Hash) ? field.to_a : [[field, field]]
+            end.map do |field_name, target_name| # rubocop:disable Style/MultilineBlockChain
+              field = section.fields.detect { |f| f.name == field_name }
+              raise "Field '#{field_name}' was given for #dynamically_scope_by but not found in '#{abstract_model.model_name}'" unless field
+
+              target_field = associated_model_config.list.fields.detect { |f| f.name == target_name }
+              raise "Field '#{field_name}' was given for #dynamically_scope_by but not found in '#{associated_model_config.abstract_model.model_name}'" unless target_field
+              raise "Field '#{field_name}' in '#{associated_model_config.abstract_model.model_name}' can't be used for dynamic scoping because it's not filterable" unless target_field.filterable
+
+              [field.method_name, target_name]
+            end.to_h
         end
 
         # determines whether association's elements can be removed
@@ -111,6 +134,12 @@ module RailsAdmin
           bindings[:object].send(association.name)
         end
 
+        # Returns collection of all selectable records
+        def collection(scope = nil)
+          (scope || bindings[:controller].list_entries(associated_model_config, :index, associated_collection_scope, false)).
+            map { |o| [o.send(associated_object_label_method), format_key(o.send(associated_primary_key)).to_s] }
+        end
+
         # has many?
         def multiple?
           true
@@ -123,6 +152,16 @@ module RailsAdmin
         def associated_model_limit
           RailsAdmin.config.default_associated_collection_limit
         end
+
+      private
+
+        def format_key(key)
+          if key.is_a?(Array)
+            RailsAdmin.config.composite_keys_serializer.serialize(key)
+          else
+            key
+          end
+        end
       end
     end
   end

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

@@ -62,15 +62,15 @@ module RailsAdmin
 
         def sort_column
           if sortable == true
-            "#{abstract_model.table_name}.#{name}"
+            "#{abstract_model.quoted_table_name}.#{abstract_model.quote_column_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}"
+          elsif association? # use column on target table
+            "#{associated_model_config.abstract_model.quoted_table_name}.#{abstract_model.quote_column_name(sortable)}"
           else # use described column in the field conf.
-            "#{abstract_model.table_name}.#{sortable}"
+            "#{abstract_model.quoted_table_name}.#{abstract_model.quote_column_name(sortable)}"
           end
         end
 

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'rails_admin/config/fields/association'
+
+module RailsAdmin
+  module Config
+    module Fields
+      class CollectionAssociation < Association
+        # orderable associated objects
+        register_instance_option :orderable do
+          false
+        end
+
+        register_instance_option :partial do
+          nested_form ? :form_nested_many : :form_filtering_multiselect
+        end
+
+        def collection(scope = nil)
+          if scope
+            super
+          elsif associated_collection_cache_all
+            selected = selected_ids
+            i = 0
+            super.sort_by { |a| [selected.index(a[1]) || selected.size, i += 1] }
+          else
+            value.map { |o| [o.send(associated_object_label_method), format_key(o.send(associated_primary_key))] }
+          end
+        end
+
+        def associated_prepopulate_params
+          {associated_model_config.abstract_model.param_key => {association.foreign_key => bindings[:object].try(:id)}}
+        end
+
+        def multiple?
+          true
+        end
+
+        def selected_ids
+          value.map { |s| format_key(s.send(associated_primary_key)).to_s }
+        end
+
+        def parse_input(params)
+          return unless associated_model_config.abstract_model.primary_key.is_a?(Array)
+
+          if nested_form
+            params[method_name].each_value do |value|
+              value[:id] = associated_model_config.abstract_model.parse_id(value[:id])
+            end
+          elsif params[method_name].is_a?(Array)
+            params[method_name] = params[method_name].map { |key| associated_model_config.abstract_model.parse_id(key) if key.present? }.compact
+            if params[method_name].empty?
+              # Workaround for Arel::Visitors::UnsupportedVisitError in #ids_writer, until https://github.com/rails/rails/pull/51116 is in place
+              params.delete(method_name)
+              params[name] = []
+            end
+          end
+        end
+
+        def form_default_value
+          (default_value if bindings[:object].new_record? && value.empty?)
+        end
+
+        def form_value
+          form_default_value.nil? ? selected_ids : form_default_value
+        end
+
+        def widget_options
+          {
+            xhr: !associated_collection_cache_all,
+            'edit-url': (inline_edit && bindings[:view].authorized?(:edit, associated_model_config.abstract_model) ? bindings[:view].edit_path(model_name: associated_model_config.abstract_model.to_param, id: '__ID__') : ''),
+            remote_source: bindings[:view].index_path(associated_model_config.abstract_model, source_object_id: abstract_model.format_id(bindings[:object].id), source_abstract_model: abstract_model.to_param, associated_collection: name, current_action: bindings[:view].current_action, compact: true),
+            scopeBy: dynamic_scope_relationships,
+            sortable: !!orderable,
+            removable: !!removable,
+            cacheAll: !!associated_collection_cache_all,
+            regional: {
+              add: ::I18n.t('admin.misc.add_new'),
+              chooseAll: ::I18n.t('admin.misc.chose_all'),
+              clearAll: ::I18n.t('admin.misc.clear_all'),
+              down: ::I18n.t('admin.misc.down'),
+              remove: ::I18n.t('admin.misc.remove'),
+              search: ::I18n.t('admin.misc.search'),
+              up: ::I18n.t('admin.misc.up'),
+            },
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rails_admin/config/fields/association'
+
+module RailsAdmin
+  module Config
+    module Fields
+      class SingularAssociation < Association
+        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
+
+        register_instance_option :partial do
+          nested_form ? :form_nested_one : :form_filtering_select
+        end
+
+        def collection(scope = nil)
+          if associated_collection_cache_all || scope
+            super
+          else
+            [[formatted_value, selected_id]]
+          end
+        end
+
+        def multiple?
+          false
+        end
+
+        def selected_id
+          raise NoMethodError # abstract
+        end
+
+        def parse_input(params)
+          return unless nested_form && params[method_name].try(:[], :id).present?
+
+          ids = associated_model_config.abstract_model.parse_id(params[method_name][:id])
+          ids = ids.to_composite_keys.to_s if ids.respond_to?(:to_composite_keys)
+          params[method_name][:id] = ids
+        end
+
+        def form_value
+          form_default_value.nil? ? selected_id : form_default_value
+        end
+
+        def widget_options
+          {
+            xhr: !associated_collection_cache_all,
+            remote_source: bindings[:view].index_path(associated_model_config.abstract_model, source_object_id: abstract_model.format_id(bindings[:object].id), source_abstract_model: abstract_model.to_param, associated_collection: name, current_action: bindings[:view].current_action, compact: true),
+            scopeBy: dynamic_scope_relationships,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -18,10 +18,7 @@ module RailsAdmin
           end
 
           register_instance_option :image? do
-            if value
-              mime_type = Mime::Type.lookup_by_extension(value.filename.extension_without_delimiter)
-              mime_type.to_s.match?(/^image/)
-            end
+            value && (value.representable? || value.content_type.match?(/^image/))
           end
 
           register_instance_option :eager_load do
@@ -40,14 +37,22 @@ module RailsAdmin
             )
           end
 
+          register_instance_option :searchable do
+            false
+          end
+
+          register_instance_option :sortable do
+            false
+          end
+
           def resource_url(thumb = false)
             return nil unless value
 
-            if thumb && value.variable?
+            if thumb && value.representable?
               thumb = thumb_method if thumb == true
-              variant = value.variant(thumb)
+              representation = value.representation(thumb)
               Rails.application.routes.url_helpers.rails_blob_representation_path(
-                variant.blob.signed_id, variant.variation.key, variant.blob.filename, only_path: true
+                representation.blob.signed_id, representation.variation.key, representation.blob.filename, only_path: true
               )
             else
               Rails.application.routes.url_helpers.rails_blob_path(value, only_path: true)

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

@@ -6,7 +6,6 @@ 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'

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

@@ -1,22 +1,14 @@
 # frozen_string_literal: true
 
-require 'rails_admin/config/fields/association'
+require 'rails_admin/config/fields/singular_association'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class BelongsToAssociation < RailsAdmin::Config::Fields::Association
+        class BelongsToAssociation < RailsAdmin::Config::Fields::SingularAssociation
           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
-
           register_instance_option :sortable do
             @sortable ||= abstract_model.adapter_supports_joins? && associated_model_config.abstract_model.properties.collect(&:name).include?(associated_model_config.object_label_method) ? associated_model_config.object_label_method : {abstract_model.table_name => method_name}
           end
@@ -25,24 +17,29 @@ module RailsAdmin
             @searchable ||= associated_model_config.abstract_model.properties.collect(&:name).include?(associated_model_config.object_label_method) ? [associated_model_config.object_label_method, {abstract_model.model => method_name}] : {abstract_model.model => method_name}
           end
 
-          register_instance_option :partial do
-            nested_form ? :form_nested_one : :form_filtering_select
-          end
-
           register_instance_option :eager_load do
             true
           end
 
-          def selected_id
-            bindings[:object].safe_send(association.key_accessor)
+          register_instance_option :allowed_methods do
+            nested_form ? [method_name] : Array(association.foreign_key)
           end
 
-          def method_name
-            nested_form ? :"#{name}_attributes" : super
+          def selected_id
+            if association.foreign_key.is_a?(Array)
+              format_key(association.foreign_key.map { |attribute| bindings[:object].safe_send(attribute) })
+            else
+              bindings[:object].safe_send(association.key_accessor)
+            end
           end
 
-          def multiple?
-            false
+          def parse_input(params)
+            return super if nested_form
+            return unless params[method_name].present? && association.foreign_key.is_a?(Array)
+
+            association.foreign_key.zip(RailsAdmin.config.composite_keys_serializer.deserialize(params.delete(method_name))).each do |key, value|
+              params[key] = value
+            end
           end
         end
       end

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

@@ -12,7 +12,6 @@ module RailsAdmin
           RailsAdmin::Config::Fields::Types.register(self)
 
           register_instance_option :image? do
-            false unless value
             if abstract_model.model.new.respond_to?("#{name}_name")
               mime_type = Mime::Type.lookup_by_extension(bindings[:object].send("#{name}_name").to_s.split('.').last)
               mime_type.to_s.match?(/^image/)

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

@@ -52,7 +52,7 @@ module RailsAdmin
           end
 
           register_instance_option :image? do
-            mime_type = Mime::Type.lookup_by_extension(resource_url.to_s.split('.').last)
+            mime_type = Mime::Type.lookup_by_extension(extension)
             mime_type.to_s.match?(/^image/)
           end
 
@@ -66,6 +66,12 @@ module RailsAdmin
             }
           end
 
+          def extension
+            URI.parse(resource_url).path.split('.').last
+          rescue URI::InvalidURIError
+            nil
+          end
+
           # virtual class
           def resource_url
             raise 'not implemented'

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'rails_admin/config/fields/types/has_many_association'
+require 'rails_admin/config/fields/collection_association'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class HasAndBelongsToManyAssociation < RailsAdmin::Config::Fields::Types::HasManyAssociation
+        class HasAndBelongsToManyAssociation < RailsAdmin::Config::Fields::CollectionAssociation
           # Register field type for the type loader
           RailsAdmin::Config::Fields::Types.register(self)
         end

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

@@ -1,36 +1,14 @@
 # frozen_string_literal: true
 
-require 'rails_admin/config/fields/association'
+require 'rails_admin/config/fields/collection_association'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class HasManyAssociation < RailsAdmin::Config::Fields::Association
+        class HasManyAssociation < RailsAdmin::Config::Fields::CollectionAssociation
           # Register field type for the type loader
           RailsAdmin::Config::Fields::Types.register(self)
-
-          register_instance_option :partial do
-            nested_form ? :form_nested_many : :form_filtering_multiselect
-          end
-
-          # orderable associated objects
-          register_instance_option :orderable do
-            false
-          end
-
-          def method_name
-            nested_form ? :"#{name}_attributes" : super
-          end
-
-          # Reader for validation errors of the bound object
-          def errors
-            bindings[:object].errors[name]
-          end
-
-          def associated_prepopulate_params
-            {associated_model_config.abstract_model.param_key => {association.foreign_key => bindings[:object].try(:id)}}
-          end
         end
       end
     end

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

@@ -1,42 +1,32 @@
 # frozen_string_literal: true
 
-require 'rails_admin/config/fields/association'
+require 'rails_admin/config/fields/singular_association'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class HasOneAssociation < RailsAdmin::Config::Fields::Association
+        class HasOneAssociation < RailsAdmin::Config::Fields::SingularAssociation
           # Register field type for the type loader
           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])
+          register_instance_option :allowed_methods do
+            nested_form ? [method_name] : [name]
           end
 
-          register_instance_option :partial do
-            nested_form ? :form_nested_one : :form_filtering_select
-          end
-
-          # Accessor for field's formatted value
-          register_instance_option :formatted_value do
-            (o = value) && o.send(associated_model_config.object_label_method)
-          end
-
-          def selected_id
-            value.try(:id).try(:to_s)
+          def associated_prepopulate_params
+            {associated_model_config.abstract_model.param_key => {association.foreign_key => bindings[:object].try(:id)}}
           end
 
-          def method_name
-            nested_form ? :"#{name}_attributes" : super
-          end
+          def parse_input(params)
+            return super if nested_form
 
-          def multiple?
-            false
+            id = params.delete(method_name)
+            params[name] = associated_model_config.abstract_model.get(id) if id
           end
 
-          def associated_prepopulate_params
-            {associated_model_config.abstract_model.param_key => {association.foreign_key => bindings[:object].try(:id)}}
+          def selected_id
+            format_key(value.try(:id)).try(:to_s)
           end
         end
       end