activeadmin 1.1.0 → 2.5.0

data/lib/active_admin/application.rb

@@ -1,156 +1,45 @@
 require 'active_admin/router'
-require 'active_admin/reloader'
-require 'active_admin/helpers/settings'
+require 'active_admin/application_settings'
+require 'active_admin/namespace_settings'
 
 module ActiveAdmin
   class Application
-    include Settings
-    include Settings::Inheritance
 
-    settings_inherited_by Namespace
-
-    # The default namespace to put controllers and routes inside. Set this
-    # in config/initializers/active_admin.rb using:
-    #
-    #   config.default_namespace = :super_admin
-    #
-    setting :default_namespace, :admin
+    class << self
+      def setting(name, default)
+        ApplicationSettings.register name, default
+      end
 
-    attr_reader :namespaces
-    def initialize
-      @namespaces = Namespace::Store.new
+      def inheritable_setting(name, default)
+        NamespaceSettings.register name, default
+      end
     end
 
-    # Load paths for admin configurations. Add folders to this load path
-    # to load up other resources for administration. External gems can
-    # include their paths in this load path to provide active_admin UIs
-    setting :load_paths, [File.expand_path('app/admin', Rails.root)]
-
-    # The default number of resources to display on index pages
-    inheritable_setting :default_per_page, 30
-
-    # The max number of resources to display on index pages and batch exports
-    inheritable_setting :max_per_page, 10_000
-
-    # The title which gets displayed in the main layout
-    inheritable_setting :site_title, ""
-
-    # Set the site title link href (defaults to AA dashboard)
-    inheritable_setting :site_title_link, ""
-
-    # Set the site title image displayed in the main layout (has precendence over :site_title)
-    inheritable_setting :site_title_image, ""
-
-    # Set the site footer text (defaults to Powered by ActiveAdmin text with version)
-    inheritable_setting :footer, ""
-
-    # Set a favicon
-    inheritable_setting :favicon, false
-
-    # Additional meta tags to place in head of logged in pages.
-    inheritable_setting :meta_tags, {}
-
-    # Additional meta tags to place in head of logged out pages.
-    inheritable_setting :meta_tags_for_logged_out_pages, { robots: "noindex, nofollow" }
-
-    # The view factory to use to generate all the view classes. Take
-    # a look at ActiveAdmin::ViewFactory
-    inheritable_setting :view_factory, ActiveAdmin::ViewFactory.new
-
-    # The method to call in controllers to get the current user
-    inheritable_setting :current_user_method, false
-
-    # The method to call in the controllers to ensure that there
-    # is a currently authenticated admin user
-    inheritable_setting :authentication_method, false
-
-    # The path to log user's out with. If set to a symbol, we assume
-    # that it's a method to call which returns the path
-    inheritable_setting :logout_link_path, :destroy_admin_user_session_path
-
-    # The method to use when generating the link for user logout
-    inheritable_setting :logout_link_method, :get
-
-    # Whether the batch actions are enabled or not
-    inheritable_setting :batch_actions, false
-
-    # Whether filters are enabled
-    inheritable_setting :filters, true
-
-    # The namespace root.
-    inheritable_setting :root_to, 'dashboard#index'
-
-    # Options that a passed to root_to.
-    inheritable_setting :root_to_options, {}
-
-    # Options passed to the routes, i.e. { path: '/custom' }
-    inheritable_setting :route_options, {}
-
-    # Display breadcrumbs
-    inheritable_setting :breadcrumb, true
-
-    # Display create another checkbox on a new page
-    # @return [Boolean] (true)
-    inheritable_setting :create_another, false
-
-    # Default CSV options
-    inheritable_setting :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
-
-    # Default Download Links options
-    inheritable_setting :download_links, true
-
-    # The authorization adapter to use
-    inheritable_setting :authorization_adapter, ActiveAdmin::AuthorizationAdapter
-
-    # A proc to be used when a user is not authorized to view the current resource
-    inheritable_setting :on_unauthorized_access, :rescue_active_admin_access_denied
-
-    # A regex to detect unsupported browser, set to false to disable
-    inheritable_setting :unsupported_browser_matcher, /MSIE [1-8]\.0/
-
-    # Whether to display 'Current Filters' on search screen
-    inheritable_setting :current_filters, true
-
-    # class to handle ordering
-    inheritable_setting :order_clause, ActiveAdmin::OrderClause
-
-    # default show_count for scopes
-    inheritable_setting :scopes_show_count, true
-
-    # Request parameters that are permitted by default
-    inheritable_setting :permitted_params, [
-      :utf8, :_method, :authenticity_token, :commit, :id
-    ]
-
-    # Set flash message keys that shouldn't show in ActiveAdmin
-    inheritable_setting :flash_keys_to_except, ['timedout']
-
-    # Set default localize format for Date/Time values
-    setting :localize_format, :long
-
-    # Include association filters by default
-    inheritable_setting :include_default_association_filters, true
+    def settings
+      @settings ||= SettingsNode.build(ApplicationSettings)
+    end
 
-    # Active Admin makes educated guesses when displaying objects, this is
-    # the list of methods it tries calling in order
-    # Note that Formtastic also has 'collection_label_methods' similar to this
-    # used by auto generated dropdowns in filter or belongs_to field of Active Admin
-    setting :display_name_methods, [ :display_name,
-                                      :full_name,
-                                      :name,
-                                      :username,
-                                      :login,
-                                      :title,
-                                      :email,
-                                      :to_s ]
+    def namespace_settings
+      @namespace_settings ||= SettingsNode.build(NamespaceSettings)
+    end
 
-    # To make debugging easier, by default don't stream in development
-    setting :disable_streaming_in, ['development']
+    def respond_to_missing?(method, include_private = false)
+      [settings, namespace_settings].any? { |sets| sets.respond_to?(method) } || super
+    end
 
-    # == Deprecated Settings
+    def method_missing(method, *args)
+      if settings.respond_to?(method)
+        settings.send(method, *args)
+      elsif namespace_settings.respond_to?(method)
+        namespace_settings.send(method, *args)
+      else
+        super
+      end
+    end
 
-    def allow_comments=(*)
-      raise "`config.allow_comments` is no longer provided in ActiveAdmin 1.x. Use `config.comments` instead."
+    attr_reader :namespaces
+    def initialize
+      @namespaces = Namespace::Store.new
     end
 
     include AssetRegistration
@@ -172,7 +61,7 @@ module ActiveAdmin
 
     # Registers a brand new configuration for the given resource.
     def register(resource, options = {}, &block)
-      ns = options.fetch(:namespace){ default_namespace }
+      ns = options.fetch(:namespace) { default_namespace }
       namespace(ns).register resource, options, &block
     end
 
@@ -184,7 +73,7 @@ module ActiveAdmin
     def namespace(name)
       name ||= :root
 
-      namespace = namespaces[name] ||= begin
+      namespace = namespaces[name.to_sym] ||= begin
         namespace = Namespace.new(self, name)
         ActiveSupport::Notifications.publish ActiveAdmin::Namespace::RegisterEvent, namespace
         namespace
@@ -202,7 +91,7 @@ module ActiveAdmin
     # @&block The registration block.
     #
     def register_page(name, options = {}, &block)
-      ns = options.fetch(:namespace){ default_namespace }
+      ns = options.fetch(:namespace) { default_namespace }
       namespace(ns).register_page name, options, &block
     end
 
@@ -223,7 +112,7 @@ module ActiveAdmin
     def load!
       unless loaded?
         ActiveSupport::Notifications.publish BeforeLoadEvent, self # before_load hook
-        files.each{ |file| load file }                             # load files
+        files.each { |file| load file }                            # load files
         namespace(default_namespace)                               # init AA resources
         ActiveSupport::Notifications.publish AfterLoadEvent, self  # after_load hook
         @@loaded = true
@@ -231,22 +120,26 @@ module ActiveAdmin
     end
 
     def load(file)
-      DatabaseHitDuringLoad.capture{ super }
+      DatabaseHitDuringLoad.capture { super }
     end
 
     # Returns ALL the files to be loaded
     def files
-      load_paths.flatten.compact.uniq.flat_map{ |path| Dir["#{path}/**/*.rb"] }
-    end
-
-    def router
-      @router ||= Router.new(self)
+      load_paths.flatten.compact.uniq.flat_map { |path| Dir["#{path}/**/*.rb"] }
     end
 
-    # One-liner called by user's config/routes.rb file
+    # Creates all the necessary routes for the ActiveAdmin configurations
+    #
+    # Use this within the routes.rb file:
+    #
+    #   Application.routes.draw do |map|
+    #     ActiveAdmin.routes(self)
+    #   end
+    #
+    # @param rails_router [ActionDispatch::Routing::Mapper]
     def routes(rails_router)
       load!
-      router.apply(rails_router)
+      Router.new(router: rails_router, namespaces: namespaces).apply
     end
 
     # Adds before, around and after filters to all controllers.
@@ -268,12 +161,12 @@ module ActiveAdmin
       controllers
     end
 
-  private
+    private
 
     def register_default_assets
-      stylesheets['active_admin.css'] = { media: 'screen' }
-      stylesheets['active_admin/print.css'] = { media: 'print' }
-      javascripts.add 'active_admin.js'
+      register_stylesheet 'active_admin.css', media: 'screen'
+      register_stylesheet 'active_admin/print.css', media: 'print'
+      register_javascript 'active_admin.js'
     end
 
     # Since app/admin is alphabetically before app/models, we have to remove it
@@ -300,11 +193,11 @@ module ActiveAdmin
           # Rails is about to unload all the app files (e.g. models), so we
           # should first unload the classes generated by Active Admin, otherwise
           # they will contain references to the stale (unloaded) classes.
-          Reloader.to_prepare(prepend: true, &unload_active_admin)
+          ActiveSupport::Reloader.to_prepare(prepend: true, &unload_active_admin)
         else
           # If the user has configured the app to always reload app files after
           # each request, so we should unload the generated classes too.
-          Reloader.to_complete(&unload_active_admin)
+          ActiveSupport::Reloader.to_complete(&unload_active_admin)
         end
 
         admin_dirs = {}
@@ -319,7 +212,7 @@ module ActiveAdmin
 
         app.reloaders << routes_reloader
 
-        Reloader.to_prepare do
+        ActiveSupport::Reloader.to_prepare do
           # Rails might have reloaded the routes for other reasons (e.g.
           # routes.rb has changed), in which case Active Admin would have been
           # loaded via the `ActiveAdmin.routes` call in `routes.rb`.

data/lib/active_admin/application_settings.rb

@@ -0,0 +1,42 @@
+require 'active_admin/settings_node'
+
+module ActiveAdmin
+  class ApplicationSettings < SettingsNode
+
+    # The default namespace to put controllers and routes inside. Set this
+    # in config/initializers/active_admin.rb using:
+    #
+    #   config.default_namespace = :super_admin
+    #
+    register :default_namespace, :admin
+
+    register :app_path, Rails.root
+
+    # Load paths for admin configurations. Add folders to this load path
+    # to load up other resources for administration. External gems can
+    # include their paths in this load path to provide active_admin UIs
+    register :load_paths, [File.expand_path('app/admin', Rails.root)]
+
+    # Set default localize format for Date/Time values
+    register :localize_format, :long
+
+    # Active Admin makes educated guesses when displaying objects, this is
+    # the list of methods it tries calling in order
+    # Note that Formtastic also has 'collection_label_methods' similar to this
+    # used by auto generated dropdowns in filter or belongs_to field of Active Admin
+    register :display_name_methods, [ :display_name,
+                                      :full_name,
+                                      :name,
+                                      :username,
+                                      :login,
+                                      :title,
+                                      :email,
+                                      :to_s ]
+
+    # To make debugging easier, by default don't stream in development
+    register :disable_streaming_in, ['development']
+
+    # Remove sensitive attributes from being displayed, made editable, or exported by default
+    register :filter_attributes, [:encrypted_password, :password, :password_confirmation]
+  end
+end

data/lib/active_admin/asset_registration.rb

@@ -2,10 +2,6 @@ module ActiveAdmin
   module AssetRegistration
 
     def register_stylesheet(path, options = {})
-      Deprecation.warn <<-MSG.strip_heredoc
-        The `register_stylesheet` config is deprecated and will be removed
-        in v2. Import your "#{path}" stylesheet in the active_admin.scss.
-      MSG
       stylesheets[path] = options
     end
 
@@ -18,10 +14,6 @@ module ActiveAdmin
     end
 
     def register_javascript(name)
-      Deprecation.warn <<-MSG.strip_heredoc
-        The `register_javascript` config is deprecated and will be removed
-        in v2. Import your "#{name}" javascript in the active_admin.js.
-      MSG
       javascripts.add name
     end
 

data/lib/active_admin/base_controller/authorization.rb

@@ -1,7 +1,6 @@
 module ActiveAdmin
   class BaseController < ::InheritedResources::Base
     module Authorization
-      include MethodOrProcHelper
       extend ActiveSupport::Concern
 
       ACTIONS_DICTIONARY = {
@@ -19,6 +18,7 @@ module ActiveAdmin
 
         helper_method :authorized?
         helper_method :authorize!
+        helper_method :active_admin_authorization
       end
 
       protected
@@ -100,7 +100,7 @@ module ActiveAdmin
       end
 
       def dispatch_active_admin_access_denied(exception)
-        call_method_or_exec_proc active_admin_namespace.on_unauthorized_access, exception
+        instance_exec(self, exception, &active_admin_namespace.on_unauthorized_access.to_proc)
       end
 
       def rescue_active_admin_access_denied(exception)
@@ -112,16 +112,14 @@ module ActiveAdmin
             redirect_backwards_or_to_root
           end
 
-          body = ActiveAdmin::Dependency.rails.render_key
-
-          format.csv  { render body =>        error,           status: :unauthorized }
+          format.csv  { render body:          error,           status: :unauthorized }
           format.json { render json: { error: error },         status: :unauthorized }
           format.xml  { render xml: "<error>#{error}</error>", status: :unauthorized }
         end
       end
 
       def redirect_backwards_or_to_root
-        ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+        redirect_back fallback_location: active_admin_root
       end
 
     end

data/lib/active_admin/base_controller.rb

@@ -22,6 +22,11 @@ module ActiveAdmin
       attr_accessor :active_admin_config
     end
 
+    include Authorization
+    include Menu
+
+    private
+
     # By default Rails will render un-implemented actions when the view exists. Because Active
     # Admin allows you to not render any of the actions by using the #actions method, we need
     # to check if they are implemented.
@@ -29,11 +34,6 @@ module ActiveAdmin
       raise AbstractController::ActionNotFound unless action_methods.include?(params[:action])
     end
 
-    include Authorization
-    include Menu
-
-    private
-
     # Calls the authentication method as defined in ActiveAdmin.authentication_method
     def authenticate_active_admin_user
       send(active_admin_namespace.authentication_method) if active_admin_namespace.authentication_method
@@ -74,7 +74,7 @@ module ActiveAdmin
 
     def active_admin_root
       controller, action = active_admin_namespace.root_to.split '#'
-      {controller: controller, action: action}
+      { controller: controller, action: action }
     end
 
   end

data/lib/active_admin/batch_actions/controller.rb

@@ -7,7 +7,7 @@ module ActiveAdmin
         if action_present?
           selection  =            params[:collection_selection] || []
           inputs     = JSON.parse params[:batch_action_inputs]  || '{}'
-          valid_keys = render_in_context(self, current_batch_action.inputs).try(:keys)
+          valid_keys = MethodOrProcHelper.render_in_context(self, current_batch_action.inputs).try(:keys)
           inputs     = inputs.with_indifferent_access.slice *valid_keys
           instance_exec selection, inputs, &current_batch_action.block
         else
@@ -22,7 +22,7 @@ module ActiveAdmin
       end
 
       def current_batch_action
-        active_admin_config.batch_actions.detect{ |action| action.sym.to_s == params[:batch_action] }
+        active_admin_config.batch_actions.detect { |action| action.sym.to_s == params[:batch_action] }
       end
 
       COLLECTION_APPLIES = [

data/lib/active_admin/batch_actions/resource_extension.rb

@@ -57,8 +57,8 @@ module ActiveAdmin
       def add_default_batch_action
         destroy_options = {
           priority: 100,
-          confirm: proc{ I18n.t('active_admin.batch_actions.delete_confirmation', plural_model: active_admin_config.plural_resource_label.downcase) },
-          if: proc{ controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, active_admin_config.resource_class) }
+          confirm: proc { I18n.t('active_admin.batch_actions.delete_confirmation', plural_model: active_admin_config.plural_resource_label.downcase) },
+          if: proc { controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, active_admin_config.resource_class) }
         }
 
         add_batch_action :destroy, proc { I18n.t('active_admin.delete') }, destroy_options do |selected_ids|
@@ -84,7 +84,7 @@ module ActiveAdmin
 
     attr_reader :block, :title, :sym
 
-    DEFAULT_CONFIRM_MESSAGE = proc{ I18n.t 'active_admin.batch_actions.default_confirmation' }
+    DEFAULT_CONFIRM_MESSAGE = proc { I18n.t 'active_admin.batch_actions.default_confirmation' }
 
     # Create a Batch Action
     #
@@ -112,7 +112,11 @@ module ActiveAdmin
     # => You can pass a hash of options to `:form` that will be rendered as form input fields for the user to fill out.
     #
     def initialize(sym, title, options = {}, &block)
-      @sym, @title, @options, @block, @confirm = sym, title, options, block, options[:confirm]
+      @sym = sym
+      @title = title
+      @options = options
+      @block = block
+      @confirm = options[:confirm]
       @block ||= proc {}
     end
 
@@ -133,7 +137,7 @@ module ActiveAdmin
     # Returns the display if block. If the block was not explicitly defined
     # a default block always returning true will be returned.
     def display_if_block
-      @options[:if] || proc{ true }
+      @options[:if] || proc { true }
     end
 
     # Used for sorting

data/lib/active_admin/callbacks.rb

@@ -75,7 +75,7 @@ module ActiveAdmin
 
           # def run_create_callbacks
           define_method "run_#{name}_callbacks" do |*args, &block|
-            self.class.send("before_#{name}_callbacks").each{ |cbk| run_callback(cbk, *args) }
+            self.class.send("before_#{name}_callbacks").each { |cbk| run_callback(cbk, *args) }
             value = block.try :call
             self.class.send("after_#{name}_callbacks").each { |cbk| run_callback(cbk, *args) }
             return value

data/lib/active_admin/controller_action.rb

@@ -2,7 +2,8 @@ module ActiveAdmin
   class ControllerAction
     attr_reader :name
     def initialize(name, options = {})
-      @name, @options = name, options
+      @name = name
+      @options = options
     end
 
     def http_verb

data/lib/active_admin/csv_builder.rb

@@ -32,7 +32,9 @@ module ActiveAdmin
 
     def initialize(options = {}, &block)
       @resource = options.delete(:resource)
-      @columns, @options, @block = [], options, block
+      @columns = []
+      @options = ActiveAdmin.application.csv_options.merge options
+      @block = block
     end
 
     def column(name, options = {}, &block)
@@ -42,7 +44,6 @@ module ActiveAdmin
     def build(controller, csv)
       @collection  = controller.send :find_collection, except: :pagination
       columns      = exec_columns controller.view_context
-      options      = ActiveAdmin.application.csv_options.merge self.options
       bom          = options.delete :byte_order_mark
       column_names = options.delete(:column_names) { true }
       csv_options  = options.except :encoding_options, :humanize_name
@@ -50,13 +51,15 @@ module ActiveAdmin
       csv << bom if bom
 
       if column_names
-        csv << CSV.generate_line(columns.map{ |c| encode c.name, options }, csv_options)
+        csv << CSV.generate_line(columns.map { |c| encode c.name, options }, csv_options)
       end
 
-      (1..paginated_collection.total_pages).each do |page|
-        paginated_collection(page).each do |resource|
-          resource = controller.send :apply_decorator, resource
-          csv << CSV.generate_line(build_row(resource, columns, options), csv_options)
+      ActiveRecord::Base.uncached do
+        (1..paginated_collection.total_pages).each do |page|
+          paginated_collection(page).each do |resource|
+            resource = controller.send :apply_decorator, resource
+            csv << CSV.generate_line(build_row(resource, columns, options), csv_options)
+          end
         end
       end
 

data/lib/active_admin/dependency.rb

@@ -1,7 +1,7 @@
 module ActiveAdmin
   module Dependency
     module Requirements
-      DEVISE = '>= 3.2', '< 5'
+      DEVISE = '>= 4.0', '< 5'
     end
 
     # Provides a clean interface to check for gem dependencies at runtime.
@@ -55,8 +55,8 @@ module ActiveAdmin
       Matcher.new name.to_s
     end
 
-    def self.rails5?
-      rails >= '5.x'
+    def self.supports_zeitwerk?
+      rails >= "6.0.0.beta3" && RUBY_ENGINE != "jruby"
     end
 
     class Matcher
@@ -94,70 +94,6 @@ module ActiveAdmin
         info = spec ? "#{spec.name} #{spec.version}" : '(missing)'
         "<ActiveAdmin::Dependency::Matcher for #{info}>"
       end
-
-      def adapter
-        @adapter ||= Adapter.const_get(@name.camelize).new self
-      end
-
-      def method_missing(method, *args, &block)
-        if respond_to_missing?(method)
-          adapter.send method, *args, &block
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method, include_private = false)
-        adapter.respond_to?(method) || super
-      rescue NameError
-        # 🐾
-      end
-    end
-
-    # Dependency adapters provide an easy way to wrap the conditional logic
-    # necessary to support multiple versions of a gem.
-    #
-    # ActiveAdmin::Dependency.rails.adapter.parameterize 'a b'
-    # => 'a_b'
-    #
-    # ActiveAdmin::Dependency.rails.parameterize 'a b'
-    # => 'a_b'
-    #
-    # ActiveAdmin::Dependency.devise.adapter
-    # -> NameError: uninitialized constant ActiveAdmin::Dependency::Adapter::Devise
-    #
-    module Adapter
-      class Base
-        def initialize(version)
-          @version = version
-        end
-      end
-
-      class Rails < Base
-        def parameterize(string)
-          if Dependency.rails5?
-            string.parameterize separator: '_'
-          else
-            string.parameterize '_'
-          end
-        end
-
-        def redirect_back(controller, fallback_location)
-          controller.instance_exec do
-            if Dependency.rails5?
-              redirect_back fallback_location: fallback_location
-            elsif controller.request.headers.key? 'HTTP_REFERER'
-              redirect_to :back
-            else
-              redirect_to fallback_location
-            end
-          end
-        end
-
-        def render_key
-          Dependency.rails5? ? :body : :text
-        end
-      end
     end
 
   end

data/lib/active_admin/deprecation.rb

@@ -6,30 +6,5 @@ module ActiveAdmin
       ActiveSupport::Deprecation.warn "Active Admin: #{message}", callstack
     end
 
-    # Deprecate a method.
-    #
-    # @param [Module] klass the Class or Module to deprecate the method on
-    # @param [Symbol] method the method to deprecate
-    # @param [String] message the message to display to the end user
-    #
-    # Example:
-    #
-    #     class MyClass
-    #       def my_method
-    #         # ...
-    #       end
-    #       ActiveAdmin::Deprecation.deprecate self, :my_method,
-    #         "MyClass#my_method is being removed in the next release"
-    #     end
-    #
-    def deprecate(klass, method, message)
-      klass.send :define_method, "deprecated_#{method}", klass.instance_method(method)
-
-      klass.send :define_method, method do |*args|
-        ActiveAdmin::Deprecation.warn "#{message}", caller
-        send "deprecated_#{method}", *args
-      end
-    end
-
   end
 end