rails_admin 1.4.2 → 3.1.2

data/lib/rails_admin/config/lazy_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/model'
 
 module RailsAdmin
@@ -6,11 +8,15 @@ module RailsAdmin
       def initialize(entity, &block)
         @entity = entity
         @deferred_blocks = [*block]
-        @existing_blocks = []
+        @initialized = false
       end
 
       def add_deferred_block(&block)
-        @deferred_blocks << block
+        if @initialized
+          @model.instance_eval(&block)
+        else
+          @deferred_blocks << block
+        end
       end
 
       def target
@@ -42,26 +48,26 @@ module RailsAdmin
         #       :
         #     end
         #
-        # Thus, sort all blocks to excute for a resource by Proc.source_path,
+        # 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?
-          @existing_blocks += @deferred_blocks
-          @existing_blocks.
-            partition { |block| block.source_location.first =~ %r{config\/initializers} }.
+          @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, *args, &block)
-        target.send(method, *args, &block)
+      def method_missing(method_name, *args, &block)
+        target.send(method_name, *args, &block)
       end
 
-      def respond_to?(method, include_private = false)
-        super || target.respond_to?(method, include_private)
+      def respond_to_missing?(method_name, include_private = false)
+        super || target.respond_to?(method_name, include_private)
       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'
@@ -21,30 +23,34 @@ module RailsAdmin
       include RailsAdmin::Config::Sections
       include RailsAdmin::Config::Inspectable
 
-      attr_reader :abstract_model
+      attr_reader :abstract_model, :parent, :root
       attr_accessor :groups
-      attr_reader :parent, :root
 
-      NAMED_INSTANCE_VARIABLES = [:@parent, :@root].freeze
+      NAMED_INSTANCE_VARIABLES = %i[@parent @root].freeze
 
       def initialize(entity)
         @parent = nil
         @root = self
 
-        @abstract_model = begin
-          if entity.is_a?(RailsAdmin::AbstractModel)
+        @abstract_model =
+          case entity
+          when RailsAdmin::AbstractModel
             entity
-          elsif entity.is_a?(Class) || entity.is_a?(String) || entity.is_a?(Symbol)
+          when Class, String
             RailsAdmin::AbstractModel.new(entity)
+          when Symbol
+            RailsAdmin::AbstractModel.new(entity.to_s)
           else
             RailsAdmin::AbstractModel.new(entity.class)
           end
-        end
+
         @groups = [RailsAdmin::Config::Fields::Group.new(self, :default).tap { |g| g.label { I18n.translate('admin.form.basic_info') } }]
       end
 
       def excluded?
-        @excluded ||= !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
+        return @excluded if defined?(@excluded)
+
+        @excluded = !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
       end
 
       def object_label
@@ -80,27 +86,34 @@ module RailsAdmin
       register_instance_option :parent do
         @parent_model ||= begin
           klass = abstract_model.model.superclass
-          klass = nil if klass.to_s.in?(%w(Object BasicObject ActiveRecord::Base))
+          klass = nil if klass.to_s.in?(%w[Object BasicObject ActiveRecord::Base])
           klass
         end
       end
 
       register_instance_option :navigation_label do
-        @navigation_label ||= begin
-          if (parent_module = abstract_model.model.parent) != Object
+        @navigation_label ||=
+          if (parent_module = abstract_model.model.try(:module_parent) || abstract_model.model.try!(:parent)) != Object
             parent_module.to_s
           end
-        end
       end
 
       register_instance_option :navigation_icon do
         nil
       end
 
+      register_instance_option :scope do
+        abstract_model.scoped
+      end
+
+      register_instance_option :last_created_at do
+        abstract_model.model.last.try(:created_at) if abstract_model.properties.detect { |c| c.name == :created_at }
+      end
+
       # Act as a proxy for the base section configuration that actually
       # store the configurations.
-      def method_missing(m, *args, &block)
-        send(:base).send(m, *args, &block)
+      def method_missing(method_name, *args, &block)
+        send(:base).send(method_name, *args, &block)
       end
     end
   end

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

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Proxyable
       class Proxy < BasicObject
-        attr_reader :bindings
-
         def initialize(object, bindings = {})
           @object = object
           @bindings = bindings
@@ -19,18 +19,18 @@ module RailsAdmin
           self
         end
 
-        def method_missing(name, *args, &block)
-          if @object.respond_to?(name)
-            reset = @object.instance_variable_get('@bindings')
+        def method_missing(method_name, *args, &block)
+          if @object.respond_to?(method_name)
+            reset = @object.bindings
             begin
-              @object.instance_variable_set('@bindings', @bindings)
-              response = @object.__send__(name, *args, &block)
+              @object.bindings = @bindings
+              response = @object.__send__(method_name, *args, &block)
             ensure
-              @object.instance_variable_set('@bindings', reset)
+              @object.bindings = reset
             end
             response
           else
-            super(name, *args, &block)
+            super(method_name, *args, &block)
           end
         end
       end

data/lib/rails_admin/config/proxyable.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable/proxy'
 module RailsAdmin
   module Config
     module Proxyable
-      attr_accessor :bindings
+      def bindings
+        Thread.current[:rails_admin_bindings] ||= {}
+        Thread.current[:rails_admin_bindings][self]
+      end
+
+      def bindings=(new_bindings)
+        Thread.current[:rails_admin_bindings] ||= {}
+        if new_bindings.nil?
+          Thread.current[:rails_admin_bindings].delete(self)
+        else
+          Thread.current[:rails_admin_bindings][self] = new_bindings
+        end
+      end
 
       def with(bindings = {})
         RailsAdmin::Config::Proxyable::Proxy.new(self, bindings)

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
@@ -24,12 +26,16 @@ module RailsAdmin
           false
         end
 
-        register_instance_option :sort_by do
-          parent.abstract_model.primary_key
+        register_instance_option :search_by do
+          nil
         end
 
-        register_instance_option :sort_reverse? do
-          true # By default show latest first
+        register_instance_option :search_help do
+          nil
+        end
+
+        register_instance_option :sort_by do
+          parent.abstract_model.primary_key
         end
 
         register_instance_option :scopes do
@@ -39,6 +45,18 @@ module RailsAdmin
         register_instance_option :row_css_class do
           ''
         end
+
+        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
+
+        register_deprecated_instance_option :sort_reverse do
+          ActiveSupport::Deprecation.warn('The sort_reverse configuration option is deprecated and has no effect.')
+        end
       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,11 +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
-
       # 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
@@ -72,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
 
@@ -79,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
@@ -110,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
@@ -138,14 +140,14 @@ module RailsAdmin
       #   end
       #
       # To use an authorization adapter, pass the name of the adapter. For example,
-      # to use with CanCan[https://github.com/ryanb/cancan], pass it like this.
+      # to use with CanCanCan[https://github.com/CanCanCommunity/cancancan/], pass it like this.
       #
-      # @example CanCan
+      # @example CanCanCan
       #   RailsAdmin.config do |config|
-      #     config.authorize_with :cancan
+      #     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)
@@ -154,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
@@ -198,18 +200,16 @@ 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
 
       # pool of all found model names from the whole application
       def models_pool
-        excluded = (excluded_models.collect(&:to_s) + %w(RailsAdmin::History PaperTrail::Version PaperTrail::VersionAssociation ActiveStorage::Attachment ActiveStorage::Blob))
-
-        (viable_models - excluded).uniq.sort
+        (viable_models - excluded_models.collect(&:to_s)).uniq.sort
       end
 
       # Loads a model configuration instance from the registry or registers
@@ -225,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 = {}
@@ -252,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
@@ -270,30 +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
-        @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.
@@ -304,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
@@ -328,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 MultilineBlockChain
+            end.flatten.reject { |m| m.starts_with?('Concerns::') } # rubocop:disable Style/MultilineBlockChain
+
+          @@system_models + @registry.keys.collect(&:to_s)
         end
       end