rails_admin 3.0.0 → 3.1.2

data/lib/generators/rails_admin/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails_admin/version'
 require File.expand_path('utils', __dir__)
@@ -8,7 +10,7 @@ module RailsAdmin
     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, sprockets]'
+    class_option :asset, type: :string, required: false, default: nil, desc: 'Asset delivery method [options: webpacker, webpack, sprockets, importmap]'
     desc 'RailsAdmin installation generator'
 
     def install
@@ -27,10 +29,14 @@ module RailsAdmin
       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
 
@@ -41,6 +47,10 @@ module RailsAdmin
 
       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
@@ -52,17 +62,69 @@ module RailsAdmin
 
     def configure_for_webpacker5
       run "yarn add rails_admin@#{RailsAdmin::Version.js}"
-      @scss_relative_dir = '../stylesheets/'
-      template 'rails_admin.js.erb', 'app/javascript/packs/rails_admin.js'
-      template 'rails_admin.scss', 'app/javascript/stylesheets/rails_admin.scss'
+      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} css-loader mini-css-extract-plugin sass sass-loader"
-      @scss_relative_dir = './'
-      template 'rails_admin.js.erb', 'app/javascript/rails_admin.js'
-      template 'rails_admin.scss', 'app/javascript/rails_admin.scss'
-      template 'webpack.config.js', 'webpack.config.js'
+      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/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
@@ -99,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

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) || []
@@ -82,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module ActiveRecord

data/lib/rails_admin/adapters/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'rails_admin/adapters/active_record/association'
 require 'rails_admin/adapters/active_record/object_extension'
@@ -31,11 +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]
         scope = scope.send(Kaminari.config.page_method_name, options[:page]).per(options[:per]) if options[:page] && options[:per]
-        scope = scope.reorder("#{options[:sort]} #{options[:sort_reverse] ? 'asc' : 'desc'}") if options[:sort]
+        scope = sort_scope(scope, options) if options[:sort]
         scope
       end
 
@@ -105,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 = []

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

data/lib/rails_admin/adapters/composite_primary_keys.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails_admin/adapters/active_record'
+require 'rails_admin/adapters/composite_primary_keys/association'
+
+module RailsAdmin
+  module Adapters
+    module CompositePrimaryKeys
+      include RailsAdmin::Adapters::ActiveRecord
+
+      def get(id, scope = scoped)
+        begin
+          object = scope.find(id)
+        rescue ::ActiveRecord::RecordNotFound
+          return nil
+        end
+
+        object.extend(RailsAdmin::Adapters::ActiveRecord::ObjectExtension)
+      end
+
+      def associations
+        model.reflect_on_all_associations.collect do |association|
+          RailsAdmin::Adapters::CompositePrimaryKeys::Association.new(association, model)
+        end
+      end
+
+    private
+
+      def bulk_scope(scope, options)
+        if primary_key.is_a? Array
+          options[:bulk_ids].map do |id|
+            scope.where(primary_key.zip(::CompositePrimaryKeys::CompositeKeys.parse(id)).to_h)
+          end.reduce(&:or)
+        else
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid
@@ -34,6 +36,14 @@ module RailsAdmin
           end
         end
 
+        def field_type
+          if polymorphic?
+            :polymorphic_association
+          else
+            :"#{type}_association"
+          end
+        end
+
         def klass
           if polymorphic? && %i[referenced_in belongs_to].include?(macro)
             polymorphic_parents(:mongoid, model.name, name) || []
@@ -111,10 +121,10 @@ module RailsAdmin
         def nested_options
           nested = nested_attributes_options.try { |o| o[name] }
           if !nested && %i[embeds_one embeds_many].include?(macro.to_sym) && !cyclic?
-            raise <<-MSG.gsub(/^\s+/, '')
-            Embbeded association without accepts_nested_attributes_for can't be handled by RailsAdmin,
-            because embedded model doesn't have top-level access.
-            Please add `accepts_nested_attributes_for :#{association.name}' line to `#{model}' model.
+            raise <<~MSG
+              Embedded association without accepts_nested_attributes_for can't be handled by RailsAdmin,
+              because embedded model doesn't have top-level access.
+              Please add `accepts_nested_attributes_for :#{association.name}' line to `#{model}' model.
             MSG
           end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid
@@ -9,9 +11,7 @@ module RailsAdmin
           self.nested_attributes_options = {}
           class << self
             def rails_admin(&block)
-              RailsAdmin.config do |config|
-                config.model(self, &block)
-              end
+              RailsAdmin.config(self, &block)
             end
 
             alias_method :accepts_nested_attributes_for_without_rails_admin, :accepts_nested_attributes_for

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Adapters
     module Mongoid

data/lib/rails_admin/adapters/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 require 'rails_admin/config/sections/list'
 require 'rails_admin/adapters/mongoid/association'
@@ -52,7 +54,7 @@ module RailsAdmin
         scope
       rescue NoMethodError => e
         if /page/.match?(e.message)
-          e = e.exception <<-ERROR.gsub(/^\s{12}/, '')
+          e = e.exception <<~ERROR
             #{e.message}
             If you don't have kaminari-mongoid installed, add `gem 'kaminari-mongoid'` to your Gemfile.
           ERROR
@@ -199,7 +201,7 @@ module RailsAdmin
         case target_association.type
         when :belongs_to, :has_and_belongs_to_many
           [{target_association.foreign_key.to_s => {'$in' => model.where('$or' => conditions).all.collect { |r| r.send(target_association.primary_key) }}}]
-        when :has_many
+        when :has_many, :has_one
           [{target_association.primary_key.to_s => {'$in' => model.where('$or' => conditions).all.collect { |r| r.send(target_association.foreign_key) }}}]
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
 require 'rails_admin/config/hideable'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'activemodel-serializers-xml'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

data/lib/rails_admin/config/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions

data/lib/rails_admin/config/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # A module for all configurables.

data/lib/rails_admin/config/const_load_suppressor.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Config
+    module ConstLoadSuppressor
+      class << self
+        @original_const_missing = nil
+
+        def suppressing
+          raise 'Constant Loading is already suppressed' if @original_const_missing
+
+          begin
+            @original_const_missing = Object.method(:const_missing)
+            intercept_const_missing
+            yield
+          ensure
+            Object.define_singleton_method(:const_missing, @original_const_missing)
+            @original_const_missing = nil
+          end
+        end
+
+        def allowing
+          if @original_const_missing
+            begin
+              Object.define_singleton_method(:const_missing, @original_const_missing)
+              yield
+            ensure
+              intercept_const_missing
+            end
+          else
+            yield
+          end
+        end
+
+      private
+
+        def intercept_const_missing
+          Object.define_singleton_method(:const_missing) do |name|
+            ConstProxy.new(name.to_s)
+          end
+        end
+      end
+
+      class ConstProxy < BasicObject
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def klass
+          @klass ||=
+            begin
+              unless ::Object.const_defined?(name)
+                ::Kernel.raise <<~MESSAGE
+                  The constant #{name} is not loaded yet upon the execution of the RailsAdmin initializer.
+                  We don't recommend to do this and may lead to issues, but if you really have to do so you can explicitly require it by adding:
+
+                    require '#{name.underscore}'
+
+                  on top of config/initializers/rails_admin.rb.
+                MESSAGE
+              end
+              name.constantize
+            end
+        end
+
+        def method_missing(method_name, *args, &block)
+          klass.send(method_name, *args, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super || klass.respond_to?(method_name, include_private)
+        end
+      end
+    end
+  end
+end

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

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