rails_admin 2.0.2 → 3.1.2

data/lib/generators/rails_admin/install_generator.rb

@@ -1,18 +1,130 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
-require File.expand_path('../utils', __FILE__)
+require 'rails_admin/version'
+require File.expand_path('utils', __dir__)
 
 module RailsAdmin
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
     include Generators::Utils::InstanceMethods
 
     argument :_namespace, type: :string, required: false, desc: 'RailsAdmin url namespace'
+    class_option :asset, type: :string, required: false, default: nil, desc: 'Asset delivery method [options: webpacker, webpack, sprockets, importmap]'
     desc 'RailsAdmin installation generator'
 
     def install
-      namespace = ask_for('Where do you want to mount rails_admin?', 'admin', _namespace)
-      route("mount RailsAdmin::Engine => '/#{namespace}', as: 'rails_admin'")
-      template 'initializer.erb', 'config/initializers/rails_admin.rb'
+      if File.read(File.join(destination_root, 'config/routes.rb')).include?('mount RailsAdmin::Engine')
+        display "Skipped route addition, since it's already there"
+      else
+        namespace = ask_for('Where do you want to mount rails_admin?', 'admin', _namespace)
+        route("mount RailsAdmin::Engine => '/#{namespace}', as: 'rails_admin'")
+      end
+      if File.exist? File.join(destination_root, 'config/initializers/rails_admin.rb')
+        insert_into_file 'config/initializers/rails_admin.rb', "  config.asset_source = :#{asset}\n", after: "RailsAdmin.config do |config|\n"
+      else
+        template 'initializer.erb', 'config/initializers/rails_admin.rb'
+      end
+      display "Using [#{asset}] for asset delivery method"
+      case asset
+      when 'webpack'
+        configure_for_webpack
+      when 'importmap'
+        configure_for_importmap
+      when 'webpacker'
+        configure_for_webpacker5
+      when 'sprockets'
+        configure_for_sprockets
+      else
+        raise "Unknown asset source: #{asset}"
+      end
+    end
+
+  private
+
+    def asset
+      return options['asset'] if options['asset']
+
+      if defined?(Webpacker)
+        'webpacker'
+      elsif Rails.root.join('webpack.config.js').exist?
+        'webpack'
+      elsif Rails.root.join('config/importmap.rb').exist?
+        'importmap'
+      else
+        'sprockets'
+      end
+    end
+
+    def configure_for_sprockets
+      gem 'sassc-rails'
+    end
+
+    def configure_for_webpacker5
+      run "yarn add rails_admin@#{RailsAdmin::Version.js}"
+      template 'rails_admin.webpacker.js', 'app/javascript/packs/rails_admin.js'
+      template 'rails_admin.scss.erb', 'app/javascript/stylesheets/rails_admin.scss'
+      # To work around https://github.com/railsadminteam/rails_admin/issues/3565
+      add_package_json_field('resolutions', {'rails_admin/@fortawesome/fontawesome-free' => '^5.15.0'})
+    end
+
+    def configure_for_webpack
+      run "yarn add rails_admin@#{RailsAdmin::Version.js}"
+      template 'rails_admin.js', 'app/javascript/rails_admin.js'
+      webpack_config = File.join(destination_root, 'webpack.config.js')
+      marker = %r{application: ["']./app/javascript/application.js["']}
+      if File.exist?(webpack_config) && File.read(webpack_config) =~ marker
+        insert_into_file 'webpack.config.js', %(,\n    rails_admin: "./app/javascript/rails_admin.js"), after: marker
+      else
+        say 'Add `rails_admin: "./app/javascript/rails_admin.js"` to the entry section in your webpack.config.js.', :red
+      end
+      setup_css({'build' => 'webpack --config webpack.config.js'})
+    end
+
+    def configure_for_importmap
+      run "yarn add rails_admin@#{RailsAdmin::Version.js}"
+      template 'rails_admin.js', 'app/javascript/rails_admin.js'
+      require_relative 'importmap_formatter'
+      add_file 'config/importmap.rails_admin.rb', ImportmapFormatter.new.format
+      setup_css
+    end
+
+    def setup_css(additional_script_entries = {})
+      gem 'cssbundling-rails'
+      rake 'css:install:sass'
+
+      @fa_font_path = '.'
+      template 'rails_admin.scss.erb', 'app/assets/stylesheets/rails_admin.scss'
+      asset_config = %{Rails.application.config.assets.paths << Rails.root.join("node_modules/@fortawesome/fontawesome-free/webfonts")\n}
+      if File.exist? File.join(destination_root, 'config/initializers/assets.rb')
+        append_to_file 'config/initializers/assets.rb', asset_config
+      else
+        add_file 'config/initializers/assets.rb', asset_config
+      end
+      add_package_json_field('scripts', additional_script_entries.merge({'build:css' => 'sass ./app/assets/stylesheets/rails_admin.scss:./app/assets/builds/rails_admin.css --no-source-map --load-path=node_modules'}), <<~INSTRUCTION)
+        Taking 'build:css' as an example, if you're already have application.sass.css for the sass build, the resulting script would look like:
+          sass ./app/assets/stylesheets/application.sass.scss:./app/assets/builds/application.css ./app/assets/stylesheets/rails_admin.scss:./app/assets/builds/rails_admin.css --no-source-map --load-path=node_modules
+      INSTRUCTION
+    end
+
+    def add_package_json_field(name, entries, instruction = nil)
+      display "Add #{name} to package.json"
+      package = begin
+        JSON.parse(File.read(File.join(destination_root, 'package.json')))
+      rescue Errno::ENOENT, JSON::ParserError
+        {}
+      end
+      if package[name] && (package[name].keys & entries.keys).any?
+        say <<~MESSAGE, :red
+          You need to merge "#{name}": #{JSON.pretty_generate(entries)} into the existing #{name} in your package.json.#{instruction && "\n#{instruction}"}
+        MESSAGE
+      else
+        package[name] ||= {}
+        entries.each do |entry, value|
+          package[name][entry] = value
+        end
+        add_file 'package.json', "#{JSON.pretty_generate(package)}\n"
+      end
     end
   end
 end

data/lib/generators/rails_admin/templates/initializer.erb

@@ -1,4 +1,5 @@
 RailsAdmin.config do |config|
+  config.asset_source = :<%= asset %>
 
   ### Popular gems integration
 
@@ -17,7 +18,7 @@ RailsAdmin.config do |config|
   ## == PaperTrail ==
   # config.audit_with :paper_trail, 'User', 'PaperTrail::Version' # PaperTrail >= 3.0.0
 
-  ### More at https://github.com/sferik/rails_admin/wiki/Base-configuration
+  ### More at https://github.com/railsadminteam/rails_admin/wiki/Base-configuration
 
   ## == Gravatar integration ==
   ## To disable Gravatar integration in Navigation Bar set to false

data/lib/generators/rails_admin/templates/rails_admin.js

@@ -0,0 +1 @@
+import "rails_admin/src/rails_admin/base";

data/lib/generators/rails_admin/templates/rails_admin.scss.erb

@@ -0,0 +1 @@
+<%= @fa_font_path ? %{$fa-font-path: "#{@fa_font_path}";\n} : '' %>@import "rails_admin/src/rails_admin/styles/base";

data/lib/generators/rails_admin/templates/rails_admin.webpacker.js

@@ -0,0 +1,2 @@
+import "rails_admin/src/rails_admin/base";
+import "../stylesheets/rails_admin.scss";

data/lib/generators/rails_admin/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Generators
     module Utils

data/lib/rails_admin/abstract_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/support/datetime'
 
 module RailsAdmin
@@ -19,7 +21,7 @@ module RailsAdmin
       def new(m)
         m = m.constantize unless m.is_a?(Class)
         (am = old_new(m)).model && am.adapter ? am : nil
-      rescue LoadError, NameError
+      rescue *([LoadError, NameError] + (defined?(ActiveRecord) ? ['ActiveRecord::NoDatabaseError'.constantize, 'ActiveRecord::ConnectionNotEstablished'.constantize] : []))
         puts "[RailsAdmin] Could not load model #{m}, assuming model is non existing. (#{$ERROR_INFO})" unless Rails.env.test?
         nil
       end
@@ -86,9 +88,8 @@ module RailsAdmin
       associations.each do |association|
         case association.type
         when :has_one
-          if child = object.send(association.name)
-            yield(association, [child])
-          end
+          child = object.send(association.name)
+          yield(association, [child]) if child
         when :has_many
           children = object.send(association.name)
           yield(association, Array.new(children))
@@ -100,8 +101,13 @@ module RailsAdmin
 
     def initialize_active_record
       @adapter = :active_record
-      require 'rails_admin/adapters/active_record'
-      extend Adapters::ActiveRecord
+      if defined?(::CompositePrimaryKeys)
+        require 'rails_admin/adapters/composite_primary_keys'
+        extend Adapters::CompositePrimaryKeys
+      else
+        require 'rails_admin/adapters/active_record'
+        extend Adapters::ActiveRecord
+      end
     end
 
     def initialize_mongoid
@@ -124,6 +130,7 @@ module RailsAdmin
 
       def to_statement
         return if [@operator, @value].any? { |v| v == '_discard' }
+
         unary_operators[@operator] || unary_operators[@value] ||
           build_statement_for_type_generic
       end
@@ -139,21 +146,22 @@ module RailsAdmin
           case @type
           when :date
             build_statement_for_date
-          when :datetime, :timestamp
+          when :datetime, :timestamp, :time
             build_statement_for_datetime_or_timestamp
           end
         end
       end
 
       def build_statement_for_type
-        raise('You must override build_statement_for_type in your StatementBuilder')
+        raise 'You must override build_statement_for_type in your StatementBuilder'
       end
 
       def build_statement_for_integer_decimal_or_float
         case @value
-        when Array then
+        when Array
           val, range_begin, range_end = *@value.collect do |v|
             next unless v.to_i.to_s == v || v.to_f.to_s == v
+
             @type == :integer ? v.to_i : v.to_f
           end
           case @operator
@@ -171,24 +179,36 @@ module RailsAdmin
 
       def build_statement_for_date
         start_date, end_date = get_filtering_duration
-        start_date = (start_date.to_date rescue nil) if start_date
-        end_date = (end_date.to_date rescue nil) if end_date
+        if start_date
+          start_date = begin
+            start_date.to_date
+          rescue StandardError
+            nil
+          end
+        end
+        if end_date
+          end_date = begin
+            end_date.to_date
+          rescue StandardError
+            nil
+          end
+        end
         range_filter(start_date, end_date)
       end
 
       def build_statement_for_datetime_or_timestamp
         start_date, end_date = get_filtering_duration
-        start_date = start_date.try(:beginning_of_day) if start_date
-        end_date = end_date.try(:end_of_day) if end_date
+        start_date = start_date.beginning_of_day if start_date.is_a?(Date)
+        end_date = end_date.end_of_day if end_date.is_a?(Date)
         range_filter(start_date, end_date)
       end
 
       def unary_operators
-        raise('You must override unary_operators in your StatementBuilder')
+        raise 'You must override unary_operators in your StatementBuilder'
       end
 
       def range_filter(_min, _max)
-        raise('You must override range_filter in your StatementBuilder')
+        raise 'You must override range_filter in your StatementBuilder'
       end
 
       class FilteringDuration

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord
@@ -21,6 +23,14 @@ module RailsAdmin
           association.macro
         end
 
+        def field_type
+          if polymorphic?
+            :polymorphic_association
+          else
+            :"#{association.macro}_association"
+          end
+        end
+
         def klass
           if options[:polymorphic]
             polymorphic_parents(:active_record, model.name.to_s, name) || []
@@ -30,7 +40,14 @@ module RailsAdmin
         end
 
         def primary_key
-          (options[:primary_key] || association.klass.primary_key).try(:to_sym) unless polymorphic?
+          return nil if polymorphic?
+
+          case type
+          when :has_one
+            association.klass.primary_key
+          else
+            association.association_primary_key
+          end.try(:to_sym)
         end
 
         def foreign_key
@@ -39,6 +56,7 @@ module RailsAdmin
 
         def foreign_key_nullable?
           return true if foreign_key.nil? || type != :has_many
+
           (column = klass.columns_hash[foreign_key.to_s]).nil? || column.null
         end
 
@@ -50,6 +68,17 @@ module RailsAdmin
           nil
         end
 
+        def key_accessor
+          case type
+          when :has_many, :has_and_belongs_to_many
+            "#{name.to_s.singularize}_ids".to_sym
+          when :has_one
+            "#{name}_id".to_sym
+          else
+            foreign_key
+          end
+        end
+
         def as
           options[:as].try :to_sym
         end
@@ -63,7 +92,7 @@ module RailsAdmin
         end
 
         def read_only?
-          (klass.all.instance_eval(&scope).readonly_value if scope.is_a? Proc) ||
+          (klass.all.instance_exec(&scope).readonly_value if scope.is_a?(Proc) && scope.arity == 0) ||
             association.nested? ||
             false
         end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord
@@ -42,13 +44,13 @@ module RailsAdmin
         end
 
         def read_only?
-          false
+          model.readonly_attributes.include? property.name.to_s
         end
 
       private
 
         def serialized?
-          model.type_for_attribute(property.name).class == ::ActiveRecord::Type::Serialized
+          model.type_for_attribute(property.name).instance_of?(::ActiveRecord::Type::Serialized)
         end
       end
     end

data/lib/rails_admin/adapters/active_record.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 require 'active_record'
-require 'rails_admin/adapters/active_record/abstract_object'
 require 'rails_admin/adapters/active_record/association'
+require 'rails_admin/adapters/active_record/object_extension'
 require 'rails_admin/adapters/active_record/property'
 
 module RailsAdmin
   module Adapters
     module ActiveRecord
-      DISABLED_COLUMN_TYPES = [:tsvector, :blob, :binary, :spatial, :hstore, :geometry].freeze
+      DISABLED_COLUMN_TYPES = %i[tsvector blob binary spatial hstore geometry].freeze
 
       def new(params = {})
-        AbstractObject.new(model.new(params))
+        model.new(params).extend(ObjectExtension)
       end
 
-      def get(id)
-        return unless object = model.where(primary_key => id).first
-        AbstractObject.new object
+      def get(id, scope = scoped)
+        object = scope.where(primary_key => id).first
+        return unless object
+
+        object.extend(ObjectExtension)
       end
 
       def scoped
@@ -29,13 +33,11 @@ module RailsAdmin
         scope ||= scoped
         scope = scope.includes(options[:include]) if options[:include]
         scope = scope.limit(options[:limit]) if options[:limit]
-        scope = scope.where(primary_key => options[:bulk_ids]) if options[:bulk_ids]
+        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]
-        if options[:page] && options[:per]
-          scope = scope.send(Kaminari.config.page_method_name, options[:page]).per(options[:per])
-        end
-        scope = scope.reorder("#{options[:sort]} #{options[:sort_reverse] ? 'asc' : 'desc'}") if options[:sort]
+        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
 
@@ -71,13 +73,23 @@ module RailsAdmin
       delegate :primary_key, :table_name, to: :model, prefix: false
 
       def encoding
-        case ::ActiveRecord::Base.connection_config[:adapter]
+        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'
-          ::ActiveRecord::Base.connection.instance_variable_get(:@connection).encoding
+          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
+          ::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
@@ -95,6 +107,27 @@ module RailsAdmin
         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 = []
@@ -199,7 +232,9 @@ module RailsAdmin
         alias_method :numeric_unary_operators, :boolean_unary_operators
 
         def range_filter(min, max)
-          if min && max
+          if min && max && min == max
+            ["(#{@column} = ?)", min]
+          elsif min && max
             ["(#{@column} BETWEEN ? AND ?)", min, max]
           elsif min
             ["(#{@column} >= ?)", min]
@@ -212,7 +247,7 @@ module RailsAdmin
           case @type
           when :boolean                   then build_statement_for_boolean
           when :integer, :decimal, :float then build_statement_for_integer_decimal_or_float
-          when :string, :text             then build_statement_for_string_or_text
+          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
@@ -220,8 +255,8 @@ 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)
+          return ["(#{@column} IS NULL OR #{@column} = ?)", false] if %w[false f 0].include?(@value)
+          return ["(#{@column} = ?)", true] if %w[true t 1].include?(@value)
         end
 
         def column_for_value(value)
@@ -230,6 +265,7 @@ module RailsAdmin
 
         def build_statement_for_belongs_to_association
           return if @value.blank?
+
           ["(#{@column} = ?)", @value.to_i] if @value.to_i.to_s == @value
         end
 
@@ -238,13 +274,11 @@ module RailsAdmin
 
           return ["(#{@column} = ?)", @value] if ['is', '='].include?(@operator)
 
-          unless ['postgresql', 'postgis'].include? ar_adapter
-            @value = @value.mb_chars.downcase
-          end
+          @value = @value.mb_chars.downcase unless %w[postgresql postgis].include? ar_adapter
 
-          @value = begin
+          @value =
             case @operator
-            when 'default', 'like'
+            when 'default', 'like', 'not_like'
               "%#{@value}%"
             when 'starts_with'
               "#{@value}%"
@@ -253,10 +287,15 @@ module RailsAdmin
             else
               return
             end
-          end
 
-          if ['postgresql', 'postgis'].include? ar_adapter
-            ["(#{@column} ILIKE ?)", @value]
+          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
@@ -264,13 +303,12 @@ module RailsAdmin
 
         def build_statement_for_enum
           return if @value.blank?
+
           ["(#{@column} IN (?))", Array.wrap(@value)]
         end
 
         def build_statement_for_uuid
-          if @value.to_s =~ /\A[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}\z/
-            column_for_value(@value)
-          end
+          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

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Adapters
+    module CompositePrimaryKeys
+      class Association < RailsAdmin::Adapters::ActiveRecord::Association
+        def field_type
+          if type == :belongs_to && association.foreign_key.is_a?(Array)
+            :composite_keys_belongs_to_association
+          else
+            super
+          end
+        end
+
+        def primary_key
+          return nil if polymorphic?
+
+          value = association.association_primary_key
+
+          if value.is_a? Array
+            :id
+          else
+            value.to_sym
+          end
+        end
+
+        def foreign_key
+          if association.foreign_key.is_a? Array
+            association.foreign_key.map(&:to_sym)
+          else
+            super
+          end
+        end
+
+        def key_accessor
+          if type == :belongs_to && foreign_key.is_a?(Array)
+            :"#{name}_id"
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end