rails_admin 2.0.2 → 3.1.2

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'
@@ -18,10 +20,9 @@ module RailsAdmin
         include RailsAdmin::Config::HasGroups
         include RailsAdmin::Config::HasDescription
 
-        attr_reader :abstract_model
-        attr_reader :parent, :root
+        attr_reader :abstract_model, :parent, :root
 
-        NAMED_INSTANCE_VARIABLES = [:@parent, :@root, :@abstract_model].freeze
+        NAMED_INSTANCE_VARIABLES = %i[@parent @root @abstract_model].freeze
 
         def initialize(parent)
           @parent = parent

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,12 +30,12 @@ module RailsAdmin
           nil
         end
 
-        register_instance_option :sort_by do
-          parent.abstract_model.primary_key
+        register_instance_option :search_help do
+          nil
         end
 
-        register_instance_option :sort_reverse? do
-          true # By default show latest first
+        register_instance_option :sort_by do
+          parent.abstract_model.primary_key
         end
 
         register_instance_option :scopes do
@@ -44,23 +46,16 @@ module RailsAdmin
           ''
         end
 
-        register_instance_option :sidescroll do
-          nil
+        register_deprecated_instance_option :sidescroll do
+          ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
+        end
+
+        def fields_for_table
+          visible_fields.partition(&:sticky?).flatten
         end
 
-        def sidescroll_frozen_columns
-          global_config = RailsAdmin::Config.sidescroll
-          model_config = sidescroll
-          enabled = model_config.nil? ? global_config : model_config
-          if enabled
-            num_frozen = model_config[:num_frozen_columns] if model_config.is_a?(Hash)
-            unless num_frozen
-              num_frozen = global_config[:num_frozen_columns] if global_config.is_a?(Hash)
-              num_frozen ||= 3 # by default, freeze checkboxes, links & first property (usually primary key / id?)
-              num_frozen -= 1 unless checkboxes? # model config should be explicit about this, only adjust if using global config
-            end
-            num_frozen
-          end
+        register_deprecated_instance_option :sort_reverse do
+          ActiveSupport::Deprecation.warn('The sort_reverse configuration option is deprecated and has no effect.')
         end
       end
     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'
@@ -25,7 +27,7 @@ module RailsAdmin
           section = RailsAdmin::Config::Sections.const_get(name)
           name = name.to_s.underscore.to_sym
           klass.send(:define_method, name) do |&block|
-            @sections = {} unless @sections
+            @sections ||= {}
             @sections[name] = section.new(self) unless @sections[name]
             @sections[name].instance_eval(&block) if block
             @sections[name]

data/lib/rails_admin/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/lazy_model'
 require 'rails_admin/config/sections/list'
 require 'active_support/core_ext/module/attribute_accessors'
@@ -27,15 +29,15 @@ module RailsAdmin
       # Configuration option to specify which models you want to exclude.
       attr_accessor :excluded_models
 
-      # Configuration option to specify a whitelist of models you want to RailsAdmin to work with.
-      # The excluded_models list applies against the whitelist as well and further reduces the models
+      # Configuration option to specify a allowlist of models you want to RailsAdmin to work with.
+      # The excluded_models list applies against the allowlist as well and further reduces the models
       # RailsAdmin will use.
       # If included_models is left empty ([]), then RailsAdmin will automatically use all the models
       # in your application (less any excluded_models you may have specified).
       attr_accessor :included_models
 
       # Fields to be hidden in show, create and update views
-      attr_accessor :default_hidden_fields
+      attr_reader :default_hidden_fields
 
       # Default items per page value used if a model level option has not
       # been configured
@@ -56,14 +58,8 @@ module RailsAdmin
       # Tell browsers whether to use the native HTML5 validations (novalidate form option).
       attr_accessor :browser_validations
 
-      # Set the max width of columns in list view before a new set is created
-      attr_accessor :total_columns_width
-
-      # Enable horizontal-scrolling table in list view, ignore total_columns_width
-      attr_accessor :sidescroll
-
       # set parent controller
-      attr_accessor :parent_controller
+      attr_reader :parent_controller
 
       # set settings for `protect_from_forgery` method
       # By default, it raises exception upon invalid CSRF tokens
@@ -75,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
 
@@ -82,8 +81,8 @@ module RailsAdmin
       attr_accessor :navigation_static_links
       attr_accessor :navigation_static_label
 
-      # yell about fields that are not marked as accessible
-      attr_accessor :yell_for_non_accessible_fields
+      # Set where RailsAdmin fetches JS/CSS from, defaults to :sprockets
+      attr_writer :asset_source
 
       # 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
@@ -113,14 +112,14 @@ module RailsAdmin
         @authenticate || DEFAULT_AUTHENTICATION
       end
 
-      # Setup auditing/history/versioning provider that observe objects lifecycle
+      # Setup auditing/versioning provider that observe objects lifecycle
       def audit_with(*args, &block)
         extension = args.shift
         if extension
           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
@@ -148,7 +147,7 @@ module RailsAdmin
       #     config.authorize_with :cancancan
       #   end
       #
-      # See the wiki[https://github.com/sferik/rails_admin/wiki] for more on authorization.
+      # See the wiki[https://github.com/railsadminteam/rails_admin/wiki] for more on authorization.
       #
       # @see RailsAdmin::Config::DEFAULT_AUTHORIZE
       def authorize_with(*args, &block)
@@ -157,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
@@ -201,10 +200,10 @@ module RailsAdmin
       end
 
       def default_search_operator=(operator)
-        if %w(default like starts_with ends_with is =).include? operator
+        if %w[default like not_like starts_with ends_with is =].include? operator
           @default_search_operator = operator
         else
-          raise(ArgumentError.new("Search operator '#{operator}' not supported"))
+          raise ArgumentError.new("Search operator '#{operator}' not supported")
         end
       end
 
@@ -226,23 +225,37 @@ module RailsAdmin
       #
       # @see RailsAdmin::Config.registry
       def model(entity, &block)
-        key = begin
-          if entity.is_a?(RailsAdmin::AbstractModel)
+        key =
+          case entity
+          when RailsAdmin::AbstractModel
             entity.model.try(:name).try :to_sym
-          elsif entity.is_a?(Class)
+          when Class, ConstLoadSuppressor::ConstProxy
             entity.name.to_sym
-          elsif entity.is_a?(String) || entity.is_a?(Symbol)
+          when String, Symbol
             entity.to_sym
           else
             entity.class.name.to_sym
           end
-        end
 
-        @registry[key] ||= RailsAdmin::Config::LazyModel.new(entity)
+        @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
+            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
+
       def default_hidden_fields=(fields)
         if fields.is_a?(Array)
           @default_hidden_fields = {}
@@ -253,9 +266,33 @@ module RailsAdmin
         end
       end
 
-      # Returns action configuration object
+      def parent_controller=(name)
+        @parent_controller = name
+
+        if defined?(RailsAdmin::ApplicationController) || defined?(RailsAdmin::MainController)
+          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
+
+      def total_columns_width=(_)
+        ActiveSupport::Deprecation.warn('The total_columns_width configuration option is deprecated and has no effect.')
+      end
+
+      def sidescroll=(_)
+        ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
+      end
+
+      # Setup actions to be used.
       def actions(&block)
-        RailsAdmin::Config::Actions.instance_eval(&block) if block
+        return unless block
+
+        RailsAdmin::Config::Actions.reset
+        RailsAdmin::Config::Actions.instance_eval(&block)
       end
 
       # Returns all model configurations
@@ -271,31 +308,31 @@ module RailsAdmin
       def reset
         @compact_show_view = true
         @browser_validations = true
-        @yell_for_non_accessible_fields = true
         @authenticate = nil
         @authorize = nil
         @audit = nil
         @current_user = nil
         @default_hidden_fields = {}
         @default_hidden_fields[:base] = [:_type]
-        @default_hidden_fields[:edit] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
-        @default_hidden_fields[:show] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
+        @default_hidden_fields[:edit] = %i[id _id created_at created_on deleted_at updated_at updated_on deleted_on]
+        @default_hidden_fields[:show] = %i[id _id created_at created_on deleted_at updated_at updated_on deleted_on]
         @default_items_per_page = 20
         @default_associated_collection_limit = 100
         @default_search_operator = 'default'
         @excluded_models = []
         @included_models = []
-        @total_columns_width = 697
-        @sidescroll = nil
-        @label_methods = [:name, :title]
+        @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
+        @asset_source = nil
         @parent_controller = '::ActionController::Base'
         @forgery_protection_settings = {with: :exception}
         RailsAdmin::Config::Actions.reset
+        RailsAdmin::AbstractModel.reset
       end
 
       # Reset a provided model's configuration.
@@ -306,22 +343,19 @@ module RailsAdmin
         @registry.delete(key)
       end
 
-      # Reset all models configuration
-      # Used to clear all configurations when reloading code in development.
-      # @see RailsAdmin::Engine
-      # @see RailsAdmin::Config.registry
-      def reset_all_models
-        @registry = {}
+      # Perform reset, then load RailsAdmin initializer again
+      def reload!
+        reset
+        load RailsAdmin::Engine.config.initializer_path
       end
 
       # Get all models that are configured as visible sorted by their weight and label.
       #
       # @see RailsAdmin::Config::Hideable
-
       def visible_models(bindings)
         visible_models_with_bindings(bindings).sort do |a, b|
           if (weight_order = a.weight <=> b.weight) == 0
-            a.label.downcase <=> b.label.downcase
+            a.label.casecmp(b.label)
           else
             weight_order
           end
@@ -330,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.paths.eager_load).collect do |load_path|
+              (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|
-                  Dir.glob(load_dir + '/**/*.rb').collect do |filename|
+                  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,68 +1,79 @@
-require 'jquery-rails'
-require 'jquery-ui-rails'
+# frozen_string_literal: true
+
 require 'kaminari'
 require 'nested_form'
-require 'rack-pjax'
 require 'rails'
 require 'rails_admin'
-require 'remotipart'
+require 'rails_admin/version'
+require 'turbo-rails'
 
 module RailsAdmin
   class Engine < Rails::Engine
     isolate_namespace RailsAdmin
 
+    attr_accessor :importmap
+
     config.action_dispatch.rescue_responses['RailsAdmin::ActionNotAllowed'] = :forbidden
 
-    initializer 'RailsAdmin precompile hook', group: :all do |app|
-      app.config.assets.precompile += %w(
-        rails_admin/rails_admin.js
-        rails_admin/rails_admin.css
-        rails_admin/jquery.colorpicker.js
-        rails_admin/jquery.colorpicker.css
-      )
-    end
+    initializer 'RailsAdmin reload config in development' do |app|
+      config.initializer_path = app.root.join('config/initializers/rails_admin.rb')
 
-    initializer 'RailsAdmin setup middlewares' do |app|
-      app.config.middleware.use Rack::Pjax
-    end
+      unless Rails.application.config.cache_classes
+        ActiveSupport::Reloader.before_class_unload do
+          RailsAdmin::Config.reload!
+        end
 
-    initializer 'RailsAdmin reload config in development' do
-      if Rails.application.config.cache_classes
-        if defined?(ActiveSupport::Reloader)
-          ActiveSupport::Reloader.before_class_unload do
-            RailsAdmin::Config.reset_all_models
-          end
-          # else
-          # For Rails 4 not implemented
+        reloader = app.config.file_watcher.new([config.initializer_path], []) do
+          # Do nothing, ActiveSupport::Reloader will trigger class_unload! anyway
         end
+
+        app.reloaders << reloader
+        app.reloader.to_run do
+          reloader.execute_if_updated { require_unload_lock! }
+        end
+        reloader.execute
       end
     end
 
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |f| load f }
+    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|
         m.klass.try(:<=, ActionDispatch::Session::AbstractStore) ||
+          m.klass.try(:<=, ActionDispatch::Session::AbstractSecureStore) ||
           m.klass.name =~ /^ActionDispatch::Session::/
       end
       loaded = app.config.middleware.to_a.map(&:name)
-      required = %w(ActionDispatch::Cookies ActionDispatch::Flash Rack::MethodOverride)
+      required = %w[ActionDispatch::Cookies ActionDispatch::Flash Rack::MethodOverride]
       missing = required - loaded
       unless missing.empty? && has_session_store
         configs = missing.map { |m| "config.middleware.use #{m}" }
         configs << "config.middleware.use #{app.config.session_store.try(:name) || 'ActionDispatch::Session::CookieStore'}, #{app.config.session_options}" unless has_session_store
-        raise <<-EOM
-Required middlewares for RailsAdmin are not added
-To fix this, add
+        raise <<~ERROR
+          Required middlewares for RailsAdmin are not added
+          To fix this, add
 
-  #{configs.join("\n  ")}
+            #{configs.join("\n  ")}
 
-to config/application.rb.
-        EOM
+          to config/application.rb.
+        ERROR
       end
+
+      RailsAdmin::Version.warn_with_js_version
     end
   end
 end

data/lib/rails_admin/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/controller_extension'
 
 module RailsAdmin
@@ -15,27 +17,19 @@ module RailsAdmin
 
     EXTENSIONS << extension_key
 
-    if options[:authorization]
-      AUTHORIZATION_ADAPTERS[extension_key] = extension_definition::AuthorizationAdapter
-    end
+    AUTHORIZATION_ADAPTERS[extension_key] = extension_definition::AuthorizationAdapter if options[:authorization]
 
-    if options[:configuration]
-      CONFIGURATION_ADAPTERS[extension_key] = extension_definition::ConfigurationAdapter
-    end
+    CONFIGURATION_ADAPTERS[extension_key] = extension_definition::ConfigurationAdapter if options[:configuration]
 
-    if options[:auditing]
-      AUDITING_ADAPTERS[extension_key] = extension_definition::AuditingAdapter
-    end
+    AUDITING_ADAPTERS[extension_key] = extension_definition::AuditingAdapter if options[:auditing]
   end
 
   # Setup all extensions for testing
   def self.setup_all_extensions
     (AUTHORIZATION_ADAPTERS.values + AUDITING_ADAPTERS.values).each do |klass|
-      begin
-        klass.setup if klass.respond_to? :setup
-      rescue # rubocop:disable Lint/HandleExceptions, Style/RescueStandardError
-        # ignore errors
-      end
+      klass.setup if klass.respond_to? :setup
+    rescue # rubocop:disable Style/RescueStandardError
+      # ignore errors
     end
   end
 end

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
@@ -26,6 +43,7 @@ module RailsAdmin
         # instance if it is available.
         def authorize(action, abstract_model = nil, model_object = nil)
           return unless action
+
           action, subject = resolve_action_and_subject(action, abstract_model, model_object)
           @controller.current_ability.authorize!(action, subject)
         end
@@ -36,6 +54,7 @@ module RailsAdmin
         # return a boolean whereas +authorize+ will raise an exception when not authorized.
         def authorized?(action, abstract_model = nil, model_object = nil)
           return unless action
+
           action, subject = resolve_action_and_subject(action, abstract_model, model_object)
           @controller.current_ability.can?(action, subject)
         end
@@ -51,13 +70,13 @@ module RailsAdmin
         # records. It should return a hash of attributes which match what the user
         # is authorized to create.
         def attributes_for(action, abstract_model)
-          @controller.current_ability.attributes_for(action, abstract_model && abstract_model.model)
+          @controller.current_ability.attributes_for(action, abstract_model&.model)
         end
 
       private
 
         def resolve_action_and_subject(action, abstract_model, model_object)
-          subject = model_object || abstract_model && abstract_model.model
+          subject = model_object || abstract_model&.model
           if subject
             [action, subject]
           else

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)

data/lib/rails_admin/extensions/controller_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Extensions
     module ControllerExtension