rails_admin 3.0.0 → 3.1.2

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/string'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/belongs_to_association'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/file_upload'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/string_like'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/base'
 
 module RailsAdmin
@@ -5,6 +7,10 @@ module RailsAdmin
     module Fields
       module Types
         class StringLike < RailsAdmin::Config::Fields::Base
+          register_instance_option :filter_operators do
+            %w[_discard like not_like is starts_with ends_with] + (required? ? [] : %w[_separator _present _blank])
+          end
+
           register_instance_option :treat_empty_as_nil? do
             properties.try(:nullable?)
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/string_like'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/datetime'
 
 module RailsAdmin
@@ -11,6 +13,10 @@ module RailsAdmin
             abstract_model.model.type_for_attribute(name.to_s).serialize(super)&.change(year: 2000, month: 1, day: 1)
           end
 
+          register_instance_option :filter_operators do
+            %w[default between] + (required? ? [] : %w[_separator _not_null _null])
+          end
+
           register_instance_option :datepicker_options do
             {
               allowInput: true,

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/datetime'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/string'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/association'

data/lib/rails_admin/config/fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Fields
@@ -20,7 +22,7 @@ module RailsAdmin
 
       # Registry of field factories.
       #
-      # Field factory is an anonymous function that recieves the parent object,
+      # Field factory is an anonymous function that receives the parent object,
       # an array of field properties and an array of fields already instantiated.
       #
       # If the factory returns true then that property will not be run through

data/lib/rails_admin/config/groupable.rb

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

data/lib/rails_admin/config/has_description.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # Provides accessor and autoregistering of model's description.

data/lib/rails_admin/config/has_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # Provides accessors and autoregistering of model's fields.
@@ -42,7 +44,7 @@ module RailsAdmin
         [*name].each { |field_name| field(field_name, type, false, &block) }
       end
 
-      # include fields by name and apply an optionnal block to each (through a call to fields),
+      # include fields by name and apply an optional block to each (through a call to fields),
       # or include fields by conditions if no field names
       def include_fields(*field_names, &block)
         if field_names.empty?

data/lib/rails_admin/config/has_groups.rb

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

data/lib/rails_admin/config/hideable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # Defines a visibility configuration

data/lib/rails_admin/config/inspectable.rb

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

data/lib/rails_admin/config/lazy_model.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'rails_admin/config/model'
+
+module RailsAdmin
+  module Config
+    class LazyModel < BasicObject
+      def initialize(entity, &block)
+        @entity = entity
+        @deferred_blocks = [*block]
+        @initialized = false
+      end
+
+      def add_deferred_block(&block)
+        if @initialized
+          @model.instance_eval(&block)
+        else
+          @deferred_blocks << block
+        end
+      end
+
+      def target
+        @model ||= ::RailsAdmin::Config::Model.new(@entity)
+        # When evaluating multiple configuration blocks, the order of
+        # execution is important. As one would expect (in my opinion),
+        # options defined within a resource should take precedence over
+        # more general options defined in an initializer. This way,
+        # general settings for a number of resources could be specified
+        # in the initializer, while models could override these settings
+        # later, if required.
+        #
+        # CAVEAT: It cannot be guaranteed that blocks defined in an initializer
+        # will be loaded (and adde to @deferred_blocks) first. For instance, if
+        # the initializer references a model class before defining
+        # a RailsAdmin configuration block, the configuration from the
+        # resource will get added to @deferred_blocks first:
+        #
+        #     # app/models/some_model.rb
+        #     class SomeModel
+        #       rails_admin do
+        #         :
+        #       end
+        #     end
+        #
+        #     # config/initializers/rails_admin.rb
+        #     model = 'SomeModel'.constantize # blocks from SomeModel get loaded
+        #     model.config model do           # blocks from initializer gets loaded
+        #       :
+        #     end
+        #
+        # Thus, sort all blocks to execute for a resource by Proc.source_path,
+        # to guarantee that blocks from 'config/initializers' evaluate before
+        # blocks defined within a model class.
+        unless @deferred_blocks.empty?
+          @deferred_blocks.
+            partition { |block| block.source_location.first =~ %r{config/initializers} }.
+            flatten.
+            each { |block| @model.instance_eval(&block) }
+          @deferred_blocks = []
+        end
+        @initialized = true
+        @model
+      end
+
+      def method_missing(method_name, *args, &block)
+        target.send(method_name, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super || target.respond_to?(method_name, include_private)
+      end
+    end
+  end
+end

data/lib/rails_admin/config/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config'
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
@@ -34,8 +36,10 @@ module RailsAdmin
           case entity
           when RailsAdmin::AbstractModel
             entity
-          when Class, String, Symbol
+          when Class, String
             RailsAdmin::AbstractModel.new(entity)
+          when Symbol
+            RailsAdmin::AbstractModel.new(entity.to_s)
           else
             RailsAdmin::AbstractModel.new(entity.class)
           end

data/lib/rails_admin/config/proxyable/proxy.rb

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

data/lib/rails_admin/config/proxyable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable/proxy'
 module RailsAdmin
   module Config

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

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

data/lib/rails_admin/config/sections/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/sections/edit'
 
 module RailsAdmin

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

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

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

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

data/lib/rails_admin/config/sections/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/sections/base'
 
 module RailsAdmin
@@ -28,6 +30,10 @@ module RailsAdmin
           nil
         end
 
+        register_instance_option :search_help do
+          nil
+        end
+
         register_instance_option :sort_by do
           parent.abstract_model.primary_key
         end

data/lib/rails_admin/config/sections/modal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/sections/edit'
 
 module RailsAdmin

data/lib/rails_admin/config/sections/nested.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/sections/edit'
 
 module RailsAdmin

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

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

data/lib/rails_admin/config/sections/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/sections/edit'
 
 module RailsAdmin

data/lib/rails_admin/config/sections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/inflections'
 require 'rails_admin/config/sections/base'
 require 'rails_admin/config/sections/edit'

data/lib/rails_admin/config.rb

@@ -1,4 +1,6 @@
-require 'rails_admin/config/model'
+# frozen_string_literal: true
+
+require 'rails_admin/config/lazy_model'
 require 'rails_admin/config/sections/list'
 require 'active_support/core_ext/module/attribute_accessors'
 
@@ -20,10 +22,6 @@ module RailsAdmin
 
     DEFAULT_CURRENT_USER = proc {}
 
-    # Variables to track initialization process
-    @initialized = false
-    @deferred_blocks = []
-
     class << self
       # Application title, can be an array of two elements
       attr_accessor :main_app_name
@@ -73,6 +71,9 @@ module RailsAdmin
       # @see RailsAdmin.config
       attr_reader :registry
 
+      # Bootstrap CSS classes used for Navigation bar
+      attr_accessor :navbar_css_classes
+
       # show Gravatar in Navigation bar
       attr_accessor :show_gravatar
 
@@ -83,22 +84,6 @@ module RailsAdmin
       # Set where RailsAdmin fetches JS/CSS from, defaults to :sprockets
       attr_writer :asset_source
 
-      # Finish initialization by executing deferred configuration blocks
-      def initialize!
-        @deferred_blocks.each { |block| block.call(self) }
-        @deferred_blocks.clear
-        @initialized = true
-      end
-
-      # Evaluate the given block either immediately or lazily, based on initialization status.
-      def apply(&block)
-        if @initialized
-          yield(self)
-        else
-          @deferred_blocks << block
-        end
-      end
-
       # Setup authentication to be run as a before filter
       # This is run inside the controller instance so you can setup any authentication you need to
       #
@@ -134,7 +119,7 @@ module RailsAdmin
           klass = RailsAdmin::AUDITING_ADAPTERS[extension]
           klass.setup if klass.respond_to? :setup
           @audit = proc do
-            @auditing_adapter = klass.new(*([self] + args).compact)
+            @auditing_adapter = klass.new(*([self] + args).compact, &block)
           end
         elsif block
           @audit = block
@@ -171,7 +156,7 @@ module RailsAdmin
           klass = RailsAdmin::AUTHORIZATION_ADAPTERS[extension]
           klass.setup if klass.respond_to? :setup
           @authorize = proc do
-            @authorization_adapter = klass.new(*([self] + args).compact)
+            @authorization_adapter = klass.new(*([self] + args).compact, &block)
           end
         elsif block
           @authorize = block
@@ -244,7 +229,7 @@ module RailsAdmin
           case entity
           when RailsAdmin::AbstractModel
             entity.model.try(:name).try :to_sym
-          when Class
+          when Class, ConstLoadSuppressor::ConstProxy
             entity.name.to_sym
           when String, Symbol
             entity.to_sym
@@ -252,19 +237,22 @@ module RailsAdmin
             entity.class.name.to_sym
           end
 
-        @registry[key] ||= RailsAdmin::Config::Model.new(entity)
-        @registry[key].instance_eval(&block) if block && @registry[key].abstract_model
+        @registry[key] ||= RailsAdmin::Config::LazyModel.new(key.to_s)
+        @registry[key].add_deferred_block(&block) if block
         @registry[key]
       end
 
       def asset_source
         @asset_source ||=
           begin
-            warn <<-MSG.gsub(/^ +/, '').freeze
-              [Warning] After upgrading RailsAdmin to 3.x you haven't set asset_source yet, using :sprockets as the default.
-              To suppress this message, run 'rails rails_admin:install' to setup the asset delivery method suitable to you.
-            MSG
-            :sprockets
+            detected = defined?(Sprockets) ? :sprockets : :invalid
+            unless ARGV.join(' ').include? 'rails_admin:install'
+              warn <<~MSG
+                [Warning] After upgrading RailsAdmin to 3.x you haven't set asset_source yet, using :#{detected} as the default.
+                To suppress this message, run 'rails rails_admin:install' to setup the asset delivery method suitable to you.
+              MSG
+            end
+            detected
           end
       end
 
@@ -282,10 +270,12 @@ module RailsAdmin
         @parent_controller = name
 
         if defined?(RailsAdmin::ApplicationController) || defined?(RailsAdmin::MainController)
-          RailsAdmin.send(:remove_const, :ApplicationController)
-          RailsAdmin.send(:remove_const, :MainController)
-          load RailsAdmin::Engine.root.join('app/controllers/rails_admin/application_controller.rb')
-          load RailsAdmin::Engine.root.join('app/controllers/rails_admin/main_controller.rb')
+          RailsAdmin::Config::ConstLoadSuppressor.allowing do
+            RailsAdmin.send(:remove_const, :ApplicationController)
+            RailsAdmin.send(:remove_const, :MainController)
+            load RailsAdmin::Engine.root.join('app/controllers/rails_admin/application_controller.rb')
+            load RailsAdmin::Engine.root.join('app/controllers/rails_admin/main_controller.rb')
+          end
         end
       end
 
@@ -334,6 +324,7 @@ module RailsAdmin
         @label_methods = %i[name title]
         @main_app_name = proc { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
         @registry = {}
+        @navbar_css_classes = %w[navbar-dark bg-primary border-bottom]
         @show_gravatar = true
         @navigation_static_links = {}
         @navigation_static_label = nil
@@ -354,10 +345,8 @@ module RailsAdmin
 
       # Perform reset, then load RailsAdmin initializer again
       def reload!
-        @initialized = false
         reset
         load RailsAdmin::Engine.config.initializer_path
-        initialize!
       end
 
       # Get all models that are configured as visible sorted by their weight and label.
@@ -375,23 +364,22 @@ module RailsAdmin
 
     private
 
-      def lchomp(base, arg)
-        base.to_s.reverse.chomp(arg.to_s.reverse).reverse
-      end
-
       def viable_models
         included_models.collect(&:to_s).presence || begin
           @@system_models ||= # memoization for tests
             ([Rails.application] + Rails::Engine.subclasses.collect(&:instance)).flat_map do |app|
               (app.paths['app/models'].to_a + app.config.eager_load_paths).collect do |load_path|
                 Dir.glob(app.root.join(load_path)).collect do |load_dir|
+                  path_prefix = "#{app.root.join(load_dir)}/"
                   Dir.glob("#{load_dir}/**/*.rb").collect do |filename|
                     # app/models/module/class.rb => module/class.rb => module/class => Module::Class
-                    lchomp(filename, "#{app.root.join(load_dir)}/").chomp('.rb').camelize
+                    filename.delete_prefix(path_prefix).chomp('.rb').camelize
                   end
                 end
               end
             end.flatten.reject { |m| m.starts_with?('Concerns::') } # rubocop:disable Style/MultilineBlockChain
+
+          @@system_models + @registry.keys.collect(&:to_s)
         end
       end
 

data/lib/rails_admin/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kaminari'
 require 'nested_form'
 require 'rails'
@@ -9,19 +11,9 @@ module RailsAdmin
   class Engine < Rails::Engine
     isolate_namespace RailsAdmin
 
-    config.action_dispatch.rescue_responses['RailsAdmin::ActionNotAllowed'] = :forbidden
+    attr_accessor :importmap
 
-    initializer 'RailsAdmin precompile hook', group: :all do |app|
-      if defined?(Sprockets)
-        app.config.assets.precompile += %w[
-          rails_admin/application.js
-          rails_admin/application.css
-        ]
-        app.config.assets.paths << RailsAdmin::Engine.root.join('src')
-        require 'rails_admin/support/esmodule_preprocessor'
-        Sprockets.register_preprocessor 'application/javascript', RailsAdmin::ESModulePreprocessor
-      end
-    end
+    config.action_dispatch.rescue_responses['RailsAdmin::ActionNotAllowed'] = :forbidden
 
     initializer 'RailsAdmin reload config in development' do |app|
       config.initializer_path = app.root.join('config/initializers/rails_admin.rb')
@@ -43,6 +35,21 @@ module RailsAdmin
       end
     end
 
+    initializer 'RailsAdmin precompile hook', group: :all do |app|
+      case RailsAdmin.config.asset_source
+      when :sprockets
+        app.config.assets.precompile += %w[
+          rails_admin/application.js
+          rails_admin/application.css
+        ]
+        app.config.assets.paths << RailsAdmin::Engine.root.join('src')
+        require 'rails_admin/support/es_module_processor'
+        Sprockets.register_bundle_processor 'application/javascript', RailsAdmin::Support::ESModuleProcessor
+      when :importmap
+        self.importmap = Importmap::Map.new.draw(app.root.join('config/importmap.rails_admin.rb'))
+      end
+    end
+
     # Check for required middlewares, users may forget to use them in Rails API mode
     config.after_initialize do |app|
       has_session_store = app.config.middleware.to_a.any? do |m|
@@ -66,11 +73,6 @@ module RailsAdmin
         ERROR
       end
 
-      RailsAdmin::Config.initialize!
-
-      # Force route reload, since it doesn't reflect RailsAdmin action configuration yet
-      app.reload_routes!
-
       RailsAdmin::Version.warn_with_js_version
     end
   end

data/lib/rails_admin/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/controller_extension'
 
 module RailsAdmin

data/lib/rails_admin/extensions/cancancan/authorization_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Extensions
     module CanCanCan
@@ -7,18 +9,33 @@ module RailsAdmin
           def current_ability
             # use _current_user instead of default current_user so it works with
             # whatever current user method is defined with RailsAdmin
-            @current_ability ||= @ability.new(_current_user)
+            @current_ability ||= ability_class.new(_current_user)
           end
         end
 
+        include RailsAdmin::Config::Configurable
+
+        def self.setup
+          RailsAdmin::Extensions::ControllerExtension.include ControllerExtension
+        end
+
         # See the +authorize_with+ config method for where the initialization happens.
-        def initialize(controller, ability = ::Ability)
+        def initialize(controller, ability = nil, &block)
           @controller = controller
-          @controller.instance_variable_set '@ability', ability
-          @controller.extend ControllerExtension
+          ability_class { ability } if ability
+          instance_eval(&block) if block
+
+          adapter = self
+          ControllerExtension.define_method(:ability_class) do
+            adapter.ability_class
+          end
           @controller.current_ability.authorize! :access, :rails_admin
         end
 
+        register_instance_option :ability_class do
+          Ability
+        end
+
         # This method is called in every controller action and should raise an exception
         # when the authorization fails. The first argument is the name of the controller
         # action as a symbol (:create, :bulk_delete, etc.). The second argument is the

data/lib/rails_admin/extensions/cancancan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/cancancan/authorization_adapter'
 
 RailsAdmin.add_extension(:cancancan, RailsAdmin::Extensions::CanCanCan, authorization: true)