rails_admin 3.1.2 → 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)
@@ -172,7 +212,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 +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,8 +298,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/active_record.rb.bak

@@ -0,0 +1,348 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'rails_admin/adapters/active_record/association'
+require 'rails_admin/adapters/active_record/model_extension'
+require 'rails_admin/adapters/active_record/property'
+
+module RailsAdmin
+  module Adapters
+    module ActiveRecord
+      DISABLED_COLUMN_TYPES = %i[tsvector blob binary spatial hstore geometry].freeze
+
+      def model_with_extension
+        @model_with_extension ||=
+          begin
+            klass = Class.new(model) do
+              include ModelExtension
+            end
+            klass.instance_eval <<-RUBY, __FILE__, __LINE__+1
+              def name
+                "#{@model_name.to_s}"
+              end
+            RUBY
+            klass
+          end
+      end
+
+      def new(params = {})
+        model_with_extension.new(params)
+      end
+
+      def get(id, scope = nil)
+        scope = model_with_extension.merge(scope || scoped)
+        scope.where(primary_key => id).first
+      end
+
+      def scoped
+        model_with_extension.all
+      end
+
+      def first(options = {}, scope = nil)
+        all(options, scope).first
+      end
+
+      def all(options = {}, scope = nil)
+        scope = model_with_extension.merge(scope || scoped)
+        scope = scope.includes(options[:include]) if options[:include]
+        scope = scope.limit(options[:limit]) if options[:limit]
+        scope = bulk_scope(scope, options) if options[:bulk_ids]
+        scope = query_scope(scope, options[:query]) if options[:query]
+        scope = filter_scope(scope, options[:filters]) if options[:filters]
+        scope = scope.send(Kaminari.config.page_method_name, options[:page]).per(options[:per]) if options[:page] && options[:per]
+        scope = sort_scope(scope, options) if options[:sort]
+        scope
+      end
+
+      def count(options = {}, scope = nil)
+        all(options.merge(limit: false, page: false), scope).count(:all)
+      end
+
+      def destroy(objects)
+        Array.wrap(objects).each(&:destroy)
+      end
+
+      def associations
+        model.reflect_on_all_associations.collect do |association|
+          Association.new(association, model)
+        end
+      end
+
+      def properties
+        columns = model.columns.reject do |c|
+          c.type.blank? ||
+            DISABLED_COLUMN_TYPES.include?(c.type.to_sym) ||
+            c.try(:array)
+        end
+        columns.collect do |property|
+          Property.new(property, model)
+        end
+      end
+
+      def base_class
+        model.base_class
+      end
+
+      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)
+            ::ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
+          else
+            ::ActiveRecord::Base.connection_config[:adapter]
+          end
+        case adapter
+        when 'postgresql'
+          ::ActiveRecord::Base.connection.select_one("SELECT ''::text AS str;").values.first.encoding
+        when 'mysql2'
+          if RUBY_ENGINE == 'jruby'
+            ::ActiveRecord::Base.connection.select_one("SELECT '' AS str;").values.first.encoding
+          else
+            ::ActiveRecord::Base.connection.raw_connection.encoding
+          end
+        when 'oracle_enhanced'
+          ::ActiveRecord::Base.connection.select_one('SELECT dummy FROM DUAL').values.first.encoding
+        else
+          ::ActiveRecord::Base.connection.select_one("SELECT '' AS str;").values.first.encoding
+        end
+      end
+
+      def embedded?
+        false
+      end
+
+      def cyclic?
+        false
+      end
+
+      def adapter_supports_joins?
+        true
+      end
+
+    private
+
+      def bulk_scope(scope, options)
+        scope.where(primary_key => options[:bulk_ids])
+      end
+
+      def sort_scope(scope, options)
+        direction = options[:sort_reverse] ? :asc : :desc
+        case options[:sort]
+        when String, Symbol
+          scope.reorder("#{options[:sort]} #{direction}")
+        when Array
+          scope.reorder(options[:sort].zip(Array.new(options[:sort].size) { direction }).to_h)
+        when Hash
+          scope.reorder(options[:sort].map { |table_name, column| "#{table_name}.#{column}" }.
+            zip(Array.new(options[:sort].size) { direction }).to_h)
+        else
+          raise ArgumentError.new("Unsupported sort value: #{options[:sort]}")
+        end
+      end
+
+      class WhereBuilder
+        def initialize(scope)
+          @statements = []
+          @values = []
+          @tables = []
+          @scope = scope
+        end
+
+        def add(field, value, operator)
+          field.searchable_columns.flatten.each do |column_infos|
+            statement, value1, value2 = StatementBuilder.new(column_infos[:column], column_infos[:type], value, operator, @scope.connection.adapter_name).to_statement
+            @statements << statement if statement.present?
+            @values << value1 unless value1.nil?
+            @values << value2 unless value2.nil?
+            table, column = column_infos[:column].split('.')
+            @tables.push(table) if column
+          end
+        end
+
+        def build
+          scope = @scope.where(@statements.join(' OR '), *@values)
+          scope = scope.references(*@tables.uniq) if @tables.any?
+          scope
+        end
+      end
+
+      def query_scope(scope, query, fields = config.list.fields.select(&:queryable?))
+        if config.list.search_by
+          scope.send(config.list.search_by, query)
+        else
+          wb = WhereBuilder.new(scope)
+          fields.each do |field|
+            value = parse_field_value(field, query)
+            wb.add(field, value, field.search_operator)
+          end
+          # OR all query statements
+          wb.build
+        end
+      end
+
+      # filters example => {"string_field"=>{"0055"=>{"o"=>"like", "v"=>"test_value"}}, ...}
+      # "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_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])
+
+            wb.add(field, value, (filter_dump[:o] || RailsAdmin::Config.default_search_operator))
+            # AND current filter statements to other filter statements
+            scope = wb.build
+          end
+        end
+        scope
+      end
+
+      def build_statement(column, type, value, operator)
+        StatementBuilder.new(column, type, value, operator, model.connection.adapter_name).to_statement
+      end
+
+      class StatementBuilder < RailsAdmin::AbstractModel::StatementBuilder
+        def initialize(column, type, value, operator, adapter_name)
+          super column, type, value, operator
+          @adapter_name = adapter_name
+        end
+
+      protected
+
+        def unary_operators
+          case @type
+          when :boolean
+            boolean_unary_operators
+          when :uuid
+            uuid_unary_operators
+          when :integer, :decimal, :float
+            numeric_unary_operators
+          else
+            generic_unary_operators
+          end
+        end
+
+      private
+
+        def generic_unary_operators
+          {
+            '_blank' => ["(#{@column} IS NULL OR #{@column} = '')"],
+            '_present' => ["(#{@column} IS NOT NULL AND #{@column} != '')"],
+            '_null' => ["(#{@column} IS NULL)"],
+            '_not_null' => ["(#{@column} IS NOT NULL)"],
+            '_empty' => ["(#{@column} = '')"],
+            '_not_empty' => ["(#{@column} != '')"],
+          }
+        end
+
+        def boolean_unary_operators
+          generic_unary_operators.merge(
+            '_blank' => ["(#{@column} IS NULL)"],
+            '_empty' => ["(#{@column} IS NULL)"],
+            '_present' => ["(#{@column} IS NOT NULL)"],
+            '_not_empty' => ["(#{@column} IS NOT NULL)"],
+          )
+        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
+            ["(#{@column} = ?)", min]
+          elsif min && max
+            ["(#{@column} BETWEEN ? AND ?)", min, max]
+          elsif min
+            ["(#{@column} >= ?)", min]
+          elsif max
+            ["(#{@column} <= ?)", max]
+          end
+        end
+
+        def build_statement_for_type
+          case @type
+          when :boolean                   then build_statement_for_boolean
+          when :integer, :decimal, :float then build_statement_for_integer_decimal_or_float
+          when :string, :text, :citext    then build_statement_for_string_or_text
+          when :enum                      then build_statement_for_enum
+          when :belongs_to_association    then build_statement_for_belongs_to_association
+          when :uuid                      then build_statement_for_uuid
+          end
+        end
+
+        def build_statement_for_boolean
+          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)
+          ["(#{@column} = ?)", value]
+        end
+
+        def build_statement_for_belongs_to_association
+          return if @value.blank?
+
+          ["(#{@column} = ?)", @value.to_i] if @value.to_i.to_s == @value
+        end
+
+        def build_statement_for_string_or_text
+          return if @value.blank?
+
+          return ["(#{@column} = ?)", @value] if ['is', '='].include?(@operator)
+
+          @value = @value.mb_chars.downcase unless %w[postgresql postgis].include? ar_adapter
+
+          @value =
+            case @operator
+            when 'default', 'like', 'not_like'
+              "%#{@value}%"
+            when 'starts_with'
+              "#{@value}%"
+            when 'ends_with'
+              "%#{@value}"
+            else
+              return
+            end
+
+          if %w[postgresql postgis].include? ar_adapter
+            if @operator == 'not_like'
+              ["(#{@column} NOT ILIKE ?)", @value]
+            else
+              ["(#{@column} ILIKE ?)", @value]
+            end
+          elsif @operator == 'not_like'
+            ["(LOWER(#{@column}) NOT LIKE ?)", @value]
+          else
+            ["(LOWER(#{@column}) LIKE ?)", @value]
+          end
+        end
+
+        def build_statement_for_enum
+          return if @value.blank?
+
+          ["(#{@column} IN (?))", Array.wrap(@value)]
+        end
+
+        def build_statement_for_uuid
+          column_for_value(@value) if /\A[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}\z/.match?(@value.to_s)
+        end
+
+        def ar_adapter
+          @adapter_name.downcase
+        end
+      end
+    end
+  end
+end

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

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
 
@@ -152,7 +153,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 +251,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/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
 
@@ -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