rails_admin 3.1.1 → 3.3.1

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

@@ -33,7 +33,7 @@ module RailsAdmin
 
         def klass
           if options[:polymorphic]
-            polymorphic_parents(:active_record, model.name.to_s, name) || []
+            polymorphic_parents(:active_record, association.active_record.name.to_s, name) || []
           else
             association.klass
           end
@@ -42,16 +42,29 @@ module RailsAdmin
         def primary_key
           return nil if polymorphic?
 
-          case type
-          when :has_one
-            association.klass.primary_key
+          value =
+            case type
+            when :has_one
+              association.klass.primary_key
+            else
+              association.association_primary_key
+            end
+
+          if value.is_a? Array
+            :id
           else
-            association.association_primary_key
-          end.try(:to_sym)
+            value.to_sym
+          end
         end
 
         def foreign_key
-          association.foreign_key.to_sym
+          if association.options[:query_constraints].present?
+            association.options[:query_constraints].map(&:to_sym)
+          elsif association.foreign_key.is_a?(Array)
+            association.foreign_key.map(&:to_sym)
+          else
+            association.foreign_key.to_sym
+          end
         end
 
         def foreign_key_nullable?
@@ -71,11 +84,15 @@ module RailsAdmin
         def key_accessor
           case type
           when :has_many, :has_and_belongs_to_many
-            "#{name.to_s.singularize}_ids".to_sym
+            :"#{name.to_s.singularize}_ids"
           when :has_one
-            "#{name}_id".to_sym
+            :"#{name}_id"
           else
-            foreign_key
+            if foreign_key.is_a?(Array)
+              :"#{name}_id"
+            else
+              foreign_key
+            end
           end
         end
 
@@ -88,7 +105,7 @@ module RailsAdmin
         end
 
         def inverse_of
-          options[:inverse_of].try :to_sym
+          options[:inverse_of].try(:to_sym) || as
         end
 
         def read_only?

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

@@ -4,24 +4,6 @@ module RailsAdmin
   module Adapters
     module ActiveRecord
       module ObjectExtension
-        def self.extended(object)
-          object.class.reflect_on_all_associations.each do |association|
-            association = Association.new(association, object.class)
-            case association.type
-            when :has_one
-              object.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
-                def #{association.name}_id
-                  self.#{association.name}&.id
-                end
-
-                def #{association.name}_id=(item_id)
-                  self.#{association.name} = (#{association.klass}.find(item_id) rescue nil)
-                end
-              RUBY
-            end
-          end
-        end
-
         def assign_attributes(attributes)
           super if attributes
         end

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)
@@ -25,6 +25,10 @@ module RailsAdmin
         model.all
       end
 
+      def none
+        model.none
+      end
+
       def first(options = {}, scope = nil)
         all(options, scope).first
       end
@@ -72,6 +76,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 +119,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)
@@ -172,7 +216,7 @@ module RailsAdmin
       # "0055" is the filter index, no use here. o is the operator, v the value
       def filter_scope(scope, filters, fields = config.list.fields.select(&:filterable?))
         filters.each_pair do |field_name, filters_dump|
-          filters_dump.each do |_, filter_dump|
+          filters_dump.each_value do |filter_dump|
             wb = WhereBuilder.new(scope)
             field = fields.detect { |f| f.name.to_s == field_name }
             value = parse_field_value(field, filter_dump[:v])
@@ -201,6 +245,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 +276,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,8 +302,12 @@ module RailsAdmin
         end
 
         def build_statement_for_boolean
-          return ["(#{@column} IS NULL OR #{@column} = ?)", false] if %w[false f 0].include?(@value)
-          return ["(#{@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
@@ -92,9 +92,9 @@ module RailsAdmin
         def key_accessor
           case macro.to_sym
           when :has_many
-            "#{name.to_s.singularize}_ids".to_sym
+            :"#{name.to_s.singularize}_ids"
           when :has_one
-            "#{name}_id".to_sym
+            :"#{name}_id"
           when :embedded_in, :embeds_one, :embeds_many
             nil
           else
@@ -111,7 +111,7 @@ module RailsAdmin
         end
 
         def inverse_of
-          association.inverse_of.try :to_sym
+          association.inverse_of.try(:to_sym) || as
         end
 
         def read_only?

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

@@ -21,6 +21,7 @@ module RailsAdmin
               Moped::Errors::InvalidObjectId
               BSON::ObjectId::Invalid
               BSON::InvalidObjectId
+              BSON::Error::InvalidObjectId
             ].exclude?(e.class.to_s)
           end
         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

@@ -31,6 +31,7 @@ module RailsAdmin
           Mongoid::Errors::InvalidFind
           Moped::Errors::InvalidObjectId
           BSON::InvalidObjectId
+          BSON::Error::InvalidObjectId
         ].exclude?(e.class.to_s)
       end
 
@@ -38,6 +39,11 @@ module RailsAdmin
         model.scoped
       end
 
+      # Criteria#none is lost when merged into another criteria
+      def none
+        scoped.in(_id: [])
+      end
+
       def first(options = {}, scope = nil)
         all(options, scope).first
       end
@@ -152,7 +158,7 @@ module RailsAdmin
         statements = []
 
         filters.each_pair do |field_name, filters_dump|
-          filters_dump.each do |_, filter_dump|
+          filters_dump.each_value do |filter_dump|
             field = fields.detect { |f| f.name.to_s == field_name }
             next unless field
 
@@ -250,8 +256,12 @@ module RailsAdmin
         end
 
         def build_statement_for_boolean
-          return {@column => false} if %w[false f 0].include?(@value)
-          return {@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/export.rb

@@ -19,7 +19,8 @@ module RailsAdmin
             format = params[:json] && :json || params[:csv] && :csv || params[:xml] && :xml
             if format
               request.format = format
-              @schema = HashHelper.symbolize(params[:schema].slice(:except, :include, :methods, :only).permit!.to_h) if params[:schema] # to_json and to_xml expect symbols for keys AND values.
+              serialization_schema # built while @action is still export
+              @schema = serialization_schema.sanitize(params[:schema].slice(:include, :methods, :only).permit!.to_h) if params[:schema]
               @objects = list_entries(@model_config, :export)
               index
             else

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

@@ -50,11 +50,13 @@ 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)
+                    @objects.to_json(@schema || serialization_schema.default)
                   end
 
                 if params[:send_data]
@@ -65,7 +67,7 @@ module RailsAdmin
               end
 
               format.xml do
-                output = @objects.to_xml(@schema)
+                output = @objects.to_xml(@schema || serialization_schema.default)
                 if params[:send_data]
                   send_data output, filename: "#{params[:model_name]}_#{DateTime.now.strftime('%Y-%m-%d_%Hh%Mm%S')}.xml"
                 else

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

@@ -21,7 +21,7 @@ module RailsAdmin
         register_instance_option :controller do
           proc do
             respond_to do |format|
-              format.json { render json: @object }
+              format.json { render json: @object.to_json(serialization_schema.default) }
               format.html { render @action.template_name }
             end
           end

data/lib/rails_admin/config/configurable.rb

@@ -9,7 +9,7 @@ module RailsAdmin
         base.send :extend, ClassMethods
       end
 
-      def has_option?(name) # rubocop:disable Naming/PredicateName
+      def has_option?(name) # rubocop:disable Naming/PredicatePrefix
         options = self.class.instance_variable_get('@config_options')
         options&.key?(name)
       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
 
@@ -357,7 +357,7 @@ module RailsAdmin
 
         def generic_field_help
           model = abstract_model.model_name.underscore
-          model_lookup = "admin.help.#{model}.#{name}".to_sym
+          model_lookup = :"admin.help.#{model}.#{name}"
           translated = I18n.translate(model_lookup, help: generic_help, default: [generic_help])
           (translated.is_a?(Hash) ? translated.to_a.first[1] : translated).html_safe
         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/factories/active_storage.rb

@@ -13,9 +13,9 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
     fields << field
     associations =
       if properties.type == :has_many
-        ["#{name}_attachments".to_sym, "#{name}_blobs".to_sym]
+        [:"#{name}_attachments", :"#{name}_blobs"]
       else
-        ["#{name}_attachment".to_sym, "#{name}_blob".to_sym]
+        [:"#{name}_attachment", :"#{name}_blob"]
       end
     children_fields = associations.map do |child_name|
       child_association = parent.abstract_model.associations.detect { |p| p.name.to_sym == child_name }

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

@@ -7,7 +7,7 @@ require 'rails_admin/config/fields/types/file_upload'
 RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
   model = parent.abstract_model.model
   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]
+    columns = [model.uploader_options[attachment_name][:mount_on] || attachment_name, :"#{attachment_name}_content_type", :"#{attachment_name}_file_size"]
     field = RailsAdmin::Config::Fields::Types.load(
       %i[serialized json].include?(properties.type) ? :multiple_carrierwave : :carrierwave,
     ).new(parent, attachment_name, properties)

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

@@ -10,7 +10,7 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
     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
+      children_column_name = :"#{attachment_name}_#{ext}"
       child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
       next unless child_properties
 

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

@@ -11,7 +11,7 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
     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
+      children_column_name = :"#{attachment_name}_#{ext}"
       child_properties = parent.abstract_model.properties.detect { |p| p.name.to_s == children_column_name.to_s }
       next unless child_properties
 

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

@@ -16,7 +16,7 @@ RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
   field = RailsAdmin::Config::Fields::Types.load(:shrine).new(parent, attachment_name, properties)
   fields << field
 
-  data_field_name = "#{attachment_name}_data".to_sym
+  data_field_name = :"#{attachment_name}_data"
   child_properties = parent.abstract_model.properties.detect { |p| p.name == data_field_name }
   next true unless child_properties