activeadmin 1.3.0 → 2.13.1

data/lib/active_admin/resource_controller/data_access.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class ResourceController < BaseController
 
@@ -23,9 +24,9 @@ module ActiveAdmin
 
       COLLECTION_APPLIES = [
         :authorization_scope,
-        :sorting,
         :filtering,
         :scoping,
+        :sorting,
         :includes,
         :pagination,
         :collection_decorator
@@ -128,7 +129,7 @@ module ActiveAdmin
       #
       # @return [ActiveRecord::Base] An un-saved active record base object
       def build_new_resource
-        scoped_collection.send(
+        apply_authorization_scope(scoped_collection).send(
           method_for_build,
           *resource_params.map { |params| params.slice(active_admin_config.resource_class.inheritance_column) }
         )
@@ -249,21 +250,32 @@ module ActiveAdmin
       end
 
       def apply_pagination(chain)
+        # skip pagination if CSV format was requested
+        return chain if params["format"] == "csv"
         # skip pagination if already was paginated by scope
         return chain if chain.respond_to?(:total_pages)
-        page_method_name = Kaminari.config.page_method_name
         page = params[Kaminari.config.param_name]
 
-        chain.public_send(page_method_name, page).per(per_page)
+        paginate(chain, page, per_page)
       end
 
       def collection_applies(options = {})
-        only   = Array(options.fetch(:only, COLLECTION_APPLIES))
+        only = Array(options.fetch(:only, COLLECTION_APPLIES))
         except = Array(options.fetch(:except, []))
 
         COLLECTION_APPLIES & only - except
       end
 
+      def in_paginated_batches(&block)
+        ActiveRecord::Base.uncached do
+          (1..paginated_collection.total_pages).each do |page|
+            paginated_collection(page).each do |resource|
+              yield apply_decorator(resource)
+            end
+          end
+        end
+      end
+
       def per_page
         if active_admin_config.paginate
           dynamic_per_page || configured_per_page
@@ -317,6 +329,20 @@ module ActiveAdmin
       def create_another?
         params[:create_another].present?
       end
+
+      def paginated_collection(page_no = 1)
+        paginate(collection, page_no, batch_size)
+      end
+
+      def paginate(chain, page, per_page)
+        page_method_name = Kaminari.config.page_method_name
+
+        chain.public_send(page_method_name, page).per(per_page)
+      end
+
+      def batch_size
+        1000
+      end
     end
   end
 end

data/lib/active_admin/resource_controller/decorators.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class ResourceController < BaseController
     module Decorators
 
-    protected
+      protected
 
       def apply_decorator(resource)
         decorate? ? decorator_class.new(resource) : resource
@@ -24,11 +25,11 @@ module ActiveAdmin
         end
       end
 
-    private
+      private
 
       def decorate?
         case action_name
-        when 'new', 'edit', 'create', 'update'
+        when "new", "edit", "create", "update"
           form = active_admin_config.get_page_presenter :form
           form && form.options[:decorate] && decorator_class.present?
         else
@@ -53,49 +54,27 @@ module ActiveAdmin
 
         def self.wrap(decorator)
           collection_decorator = find_collection_decorator(decorator)
-
-          if draper_collection_decorator? collection_decorator
-            name = "#{collection_decorator.name} of #{decorator} + ActiveAdmin"
-            @cache[name] ||= wrap! collection_decorator, name
-          else
-            collection_decorator
-          end
+          name = "#{collection_decorator.name} of #{decorator} + ActiveAdmin"
+          @cache[name] ||= wrap! collection_decorator, name
         end
 
-      private
-
         def self.wrap!(parent, name)
           ::Class.new parent do
             delegate :reorder, :page, :current_page, :total_pages, :limit_value,
-                     :total_count, :total_pages, :to_key, :group_values, :except,
-                     :find_each, :ransack
+                     :total_count, :total_pages, :offset, :to_key, :group_values,
+                     :except, :find_each, :ransack, to: :object
 
             define_singleton_method(:name) { name }
           end
         end
 
-        # Draper::CollectionDecorator was introduced in 1.0.0
-        # Draper::Decorator#collection_decorator_class was introduced in 1.3.0
         def self.find_collection_decorator(decorator)
-          if Dependency.draper?    '>= 1.3.0'
+          if decorator.respond_to?(:collection_decorator_class)
             decorator.collection_decorator_class
-          elsif Dependency.draper? '>= 1.0.0'
-            draper_collection_decorator
           else
-            decorator
+            CollectionDecorator
           end
         end
-
-        def self.draper_collection_decorator?(decorator)
-          decorator && decorator <= draper_collection_decorator
-        rescue NameError
-          false
-        end
-
-        def self.draper_collection_decorator
-          ::Draper::CollectionDecorator
-        end
-
       end
     end
   end

data/lib/active_admin/resource_controller/polymorphic_routes.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "active_admin/resource"
+require "active_admin/resource/model"
+
+module ActiveAdmin
+  class ResourceController < BaseController
+    module PolymorphicRoutes
+      def polymorphic_url(record_or_hash_or_array, options = {})
+        super(map_named_resources_for(record_or_hash_or_array), options)
+      end
+
+      def polymorphic_path(record_or_hash_or_array, options = {})
+        super(map_named_resources_for(record_or_hash_or_array), options)
+      end
+
+      private
+
+      def map_named_resources_for(record_or_hash_or_array)
+        return record_or_hash_or_array unless record_or_hash_or_array.is_a?(Array)
+
+        record_or_hash_or_array.map { |record| to_named_resource(record) }
+      end
+
+      def to_named_resource(record)
+        if record.is_a?(resource_class)
+          return ActiveAdmin::Model.new(active_admin_config, record)
+        end
+
+        belongs_to_resource = active_admin_config.belongs_to_config.try(:resource)
+        if belongs_to_resource && record.is_a?(belongs_to_resource.resource_class)
+          return ActiveAdmin::Model.new(belongs_to_resource, record)
+        end
+
+        record
+      end
+    end
+  end
+end

data/lib/active_admin/resource_controller/resource_class_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class ResourceController < BaseController
     module ResourceClassMethods
@@ -13,6 +14,8 @@ module ActiveAdmin
             @active_admin_config ? @active_admin_config.resource_class : nil
           end
 
+          private
+
           def resource_class
             self.class.resource_class
           end

data/lib/active_admin/resource_controller/scoping.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class ResourceController < BaseController
 
@@ -15,7 +16,7 @@ module ActiveAdmin
       # Collection can be scoped conditionally with an :if or :unless proc.
       def begin_of_association_chain
         return nil unless active_admin_config.scope_to?(self)
-        render_in_context(self, active_admin_config.scope_to_method)
+        MethodOrProcHelper.render_in_context(self, active_admin_config.scope_to_method)
       end
 
       # Overriding from InheritedResources::BaseHelpers

data/lib/active_admin/resource_controller/sidebars.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class ResourceController < BaseController
 

data/lib/active_admin/resource_controller/streaming.rb

@@ -1,4 +1,5 @@
-require 'csv'
+# frozen_string_literal: true
+require "csv"
 
 module ActiveAdmin
   class ResourceController < BaseController
@@ -18,23 +19,24 @@ module ActiveAdmin
       protected
 
       def stream_resource(&block)
-        headers['X-Accel-Buffering'] = 'no'
-        headers['Cache-Control'] = 'no-cache'
+        headers["X-Accel-Buffering"] = "no"
+        headers["Cache-Control"] = "no-cache"
+        headers["Last-Modified"] = Time.current.httpdate
 
         if ActiveAdmin.application.disable_streaming_in.include? Rails.env
-          self.response_body = block['']
+          self.response_body = block[String.new]
         else
           self.response_body = Enumerator.new &block
         end
       end
 
       def csv_filename
-        "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.zone.now.to_date.to_s(:default)}.csv"
+        "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.zone.now.to_date.to_formatted_s(:default)}.csv"
       end
 
       def stream_csv
-        headers['Content-Type'] = 'text/csv; charset=utf-8' # In Rails 5 it's set to HTML??
-        headers['Content-Disposition'] = %{attachment; filename="#{csv_filename}"}
+        headers["Content-Type"] = "text/csv; charset=utf-8" # In Rails 5 it's set to HTML??
+        headers["Content-Disposition"] = %{attachment; filename="#{csv_filename}"}
         stream_resource &active_admin_config.csv_builder.method(:build).to_proc.curry[self]
       end
 

data/lib/active_admin/resource_controller.rb

@@ -1,10 +1,13 @@
-require 'active_admin/resource_controller/action_builder'
-require 'active_admin/resource_controller/data_access'
-require 'active_admin/resource_controller/decorators'
-require 'active_admin/resource_controller/scoping'
-require 'active_admin/resource_controller/streaming'
-require 'active_admin/resource_controller/sidebars'
-require 'active_admin/resource_controller/resource_class_methods'
+# frozen_string_literal: true
+require "active_admin/collection_decorator"
+require "active_admin/resource_controller/action_builder"
+require "active_admin/resource_controller/data_access"
+require "active_admin/resource_controller/decorators"
+require "active_admin/resource_controller/polymorphic_routes"
+require "active_admin/resource_controller/scoping"
+require "active_admin/resource_controller/streaming"
+require "active_admin/resource_controller/sidebars"
+require "active_admin/resource_controller/resource_class_methods"
 
 module ActiveAdmin
   # All Resources Controller inherits from this controller.
@@ -18,17 +21,18 @@ module ActiveAdmin
     include ActionBuilder
     include Decorators
     include DataAccess
+    include PolymorphicRoutes
     include Scoping
     include Streaming
     include Sidebars
     include ViewHelpers::DownloadFormatLinksHelper
-    extend  ResourceClassMethods
+    extend ResourceClassMethods
 
     def self.active_admin_config=(config)
       if @active_admin_config = config
         defaults resource_class: config.resource_class,
-                 route_prefix:   config.route_prefix,
-                 instance_name:  config.resource_name.singular
+                 route_prefix: config.route_prefix,
+                 instance_name: config.resource_name.singular
       end
     end
 

data/lib/active_admin/resource_dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   # This is the class where all the register blocks are evaluated.
   class ResourceDSL < DSL
@@ -62,11 +63,12 @@ module ActiveAdmin
     #
     def permit_params(*args, &block)
       param_key = config.param_key.to_sym
-      belongs_to_param = config.belongs_to_param
-      create_another_param = :create_another if config.create_another
 
       controller do
         define_method :permitted_params do
+          belongs_to_param = active_admin_config.belongs_to_param
+          create_another_param = :create_another if active_admin_config.create_another
+
           permitted_params =
             active_admin_namespace.permitted_params +
               Array.wrap(belongs_to_param) +
@@ -74,6 +76,8 @@ module ActiveAdmin
 
           params.permit(*permitted_params, param_key => block ? instance_exec(&block) : args)
         end
+
+        private :permitted_params
       end
     end
 
@@ -119,7 +123,7 @@ module ActiveAdmin
     #
     #   ActiveAdmin.register Post do
     #     member_action :comments do
-    #       @post = Post.find(params[:id]
+    #       @post = Post.find(params[:id])
     #       @comments = @post.comments
     #     end
     #   end
@@ -131,14 +135,14 @@ module ActiveAdmin
     # action.
     #
     def action(set, name, options = {}, &block)
-      warn "Warning: method `#{name}` already defined" if controller.method_defined?(name)
+      warn "Warning: method `#{name}` already defined in #{controller.name}" if controller.method_defined?(name)
 
       set << ControllerAction.new(name, options)
       title = options.delete(:title)
 
       controller do
         before_action(only: [name]) { @page_title = title } if title
-        define_method(name, &block || Proc.new{})
+        define_method(name, &block || Proc.new {})
       end
     end
 
@@ -181,31 +185,15 @@ module ActiveAdmin
     # == Before / After Destroy
     # Called before and after the object is destroyed from the database.
     #
-    delegate :before_build,   :after_build,   to: :controller
-    delegate :before_create,  :after_create,  to: :controller
-    delegate :before_update,  :after_update,  to: :controller
-    delegate :before_save,    :after_save,    to: :controller
+    delegate :before_build, :after_build, to: :controller
+    delegate :before_create, :after_create, to: :controller
+    delegate :before_update, :after_update, to: :controller
+    delegate :before_save, :after_save, to: :controller
     delegate :before_destroy, :after_destroy, to: :controller
 
-    # This code defines both *_filter and *_action for Rails 4.0 to Rails 5 and  *_action for Rails >= 5.1
-    phases = [
-      :before, :skip_before,
-      :after,  :skip_after,
-      :around, :skip
-    ]
-    keywords = if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 1
-                 [:action]
-               else
-                 [:action, :filter]
-               end
-
-    keywords.each do |name|
-      phases.each do |action|
-       define_method "#{action}_#{name}" do |*args, &block|
-         controller.public_send "#{action}_action", *args, &block
-       end
-     end
-    end
+    standard_rails_filters =
+      AbstractController::Callbacks::ClassMethods.public_instance_methods.select { |m| m.match(/_action\z/) }
+    delegate *standard_rails_filters, to: :controller
 
     # Specify which actions to create in the controller
     #

data/lib/active_admin/router.rb

@@ -1,108 +1,115 @@
+# frozen_string_literal: true
 module ActiveAdmin
+  # @private
   class Router
-    def initialize(application)
-      @application = application
+    attr_reader :namespaces, :router
+
+    def initialize(router:, namespaces:)
+      @router = router
+      @namespaces = namespaces
     end
 
-    # 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
-    #
-    def apply(router)
-      define_root_routes router
-      define_resource_routes router
+    def apply
+      define_root_routes
+      define_resources_routes
     end
 
-    def define_root_routes(router)
-      router.instance_exec @application.namespaces do |namespaces|
-        namespaces.each do |namespace|
-          if namespace.root?
-            root namespace.root_to_options.merge(to: namespace.root_to)
-          else
-            namespace namespace.name, namespace.route_options.dup do
-              root namespace.root_to_options.merge(to: namespace.root_to, as: :root)
-            end
+    private
+
+    def define_root_routes
+      namespaces.each do |namespace|
+        if namespace.root?
+          router.root namespace.root_to_options.merge(to: namespace.root_to)
+        else
+          router.namespace namespace.name, namespace.route_options.dup do
+            router.root namespace.root_to_options.merge(to: namespace.root_to, as: :root)
           end
         end
       end
     end
 
     # Defines the routes for each resource
-    def define_resource_routes(router)
-      router.instance_exec @application.namespaces, self do |namespaces, aa_router|
-        resources = namespaces.flat_map{ |n| n.resources.values }
-        resources.each do |config|
-          routes = aa_router.resource_routes(config)
-
-          # Add in the parent if it exists
-          if config.belongs_to?
-            belongs_to = routes
-            routes     = Proc.new do
-              # If it's optional, make the normal resource routes
-              instance_exec &belongs_to if config.belongs_to_config.optional?
-
-              # Make the nested belongs_to routes
-              # :only is set to nothing so that we don't clobber any existing routes on the resource
-              resources config.belongs_to_config.target.resource_name.plural, only: [] do
-                instance_exec &belongs_to
-              end
-            end
-          end
+    def define_resources_routes
+      resources = namespaces.flat_map { |n| n.resources.values }
+      resources.each do |config|
+        define_resource_routes(config)
+      end
+    end
 
-          # Add on the namespace if required
-          unless config.namespace.root?
-            nested = routes
-            routes = Proc.new do
-              namespace config.namespace.name, config.namespace.route_options.dup do
-                instance_exec &nested
-              end
-            end
-          end
+    def define_resource_routes(config)
+      if config.namespace.root?
+        define_routes(config)
+      else
+        # Add on the namespace if required
+        define_namespace(config)
+      end
+    end
 
-          instance_exec &routes
-        end
+    def define_routes(config)
+      if config.belongs_to?
+        define_belongs_to_routes(config)
+      else
+        page_or_resource_routes(config)
       end
     end
 
+    def page_or_resource_routes(config)
+      config.is_a?(Page) ? page_routes(config) : resource_routes(config)
+    end
+
     def resource_routes(config)
-      Proc.new do
-        # Builds one route for each HTTP verb passed in
-        build_route = proc{ |verbs, *args|
-          [*verbs].each{ |verb| send verb, *args }
-        }
-        # Deals with +ControllerAction+ instances
-        build_action = proc{ |action|
-          build_route.call(action.http_verb, action.name)
-        }
-        case config
-        when ::ActiveAdmin::Resource
-          resources config.resource_name.route_key, only: config.defined_actions do
-            member do
-              config.member_actions.each &build_action
-            end
-
-            collection do
-              config.collection_actions.each &build_action
-              post :batch_action if config.batch_actions_enabled?
-            end
-          end
-        when ::ActiveAdmin::Page
-          page = config.underscored_resource_name
-          get "/#{page}" => "#{page}#index"
-          config.page_actions.each do |action|
-            Array.wrap(action.http_verb).each do |verb|
-              build_route.call verb, "/#{page}/#{action.name}" => "#{page}##{action.name}"
-            end
-          end
-        else
-          raise "Unsupported config class: #{config.class}"
+      router.resources config.resource_name.route_key, only: config.defined_actions do
+        define_actions(config)
+      end
+    end
+
+    def page_routes(config)
+      page = config.underscored_resource_name
+      router.get "/#{page}" => "#{page}#index"
+      config.page_actions.each do |action|
+        Array.wrap(action.http_verb).each do |verb|
+          build_route(verb, "/#{page}/#{action.name}" => "#{page}##{action.name}")
         end
       end
+    end
+
+    # Defines member and collection actions
+    def define_actions(config)
+      router.member do
+        config.member_actions.each { |action| build_action(action) }
+      end
+
+      router.collection do
+        config.collection_actions.each { |action| build_action(action) }
+        router.post :batch_action if config.batch_actions_enabled?
+      end
+    end
+
+    # Deals with +ControllerAction+ instances
+    # Builds one route for each HTTP verb passed in
+    def build_action(action)
+      build_route(action.http_verb, action.name)
+    end
+
+    def build_route(verbs, *args)
+      Array.wrap(verbs).each { |verb| router.send(verb, *args) }
+    end
+
+    def define_belongs_to_routes(config)
+      # If it's optional, make the normal resource routes
+      page_or_resource_routes(config) if config.belongs_to_config.optional?
+
+      # Make the nested belongs_to routes
+      # :only is set to nothing so that we don't clobber any existing routes on the resource
+      router.resources config.belongs_to_config.target.resource_name.plural, only: [] do
+        page_or_resource_routes(config)
+      end
+    end
 
+    def define_namespace(config)
+      router.namespace config.namespace.name, config.namespace.route_options.dup do
+        define_routes(config)
+      end
     end
   end
 end

data/lib/active_admin/scope.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Scope
 
-    attr_reader :scope_method, :id, :scope_block, :display_if_block, :show_count, :default_block
+    attr_reader :scope_method, :id, :scope_block, :display_if_block, :show_count, :default_block, :group
 
     # Create a Scope
     #
@@ -24,30 +25,38 @@ module ActiveAdmin
     #   Scope.new ->{Date.today.strftime '%A'}, :published_today
     #   # => Scope with dynamic title using the :published_today scope method
     #
+    #   Scope.new :published, nil, group: :status
+    #   # => Scope with the group :status
+    #
     def initialize(name, method = nil, options = {}, &block)
-      @name, @scope_method = name, method.try(:to_sym)
+      @name = name
+      @scope_method = method.try(:to_sym)
 
       if name.is_a? Proc
         raise "A string/symbol is required as the second argument if your label is a proc." unless method
-        @id = ActiveAdmin::Dependency.rails.parameterize method.to_s
+        @id = method.to_s.parameterize(separator: "_")
       else
         @scope_method ||= name.to_sym
-        @id = ActiveAdmin::Dependency.rails.parameterize name.to_s
+        @id = name.to_s.parameterize(separator: "_")
       end
 
-      @scope_method               = nil        if @scope_method == :all
-      @scope_method, @scope_block = nil, block if block_given?
+      @scope_method = nil if @scope_method == :all
+      if block_given?
+        @scope_method = nil
+        @scope_block = block
+      end
 
-      @localizer        = options[:localizer]
-      @show_count       = options.fetch(:show_count, true)
-      @display_if_block = options[:if]      || proc{ true }
-      @default_block    = options[:default] || proc{ false }
+      @localizer = options[:localizer]
+      @show_count = options.fetch(:show_count, true)
+      @display_if_block = options[:if] || proc { true }
+      @default_block = options[:default] || proc { false }
+      @group = options[:group].try(:to_sym)
     end
 
     def name
       case @name
       when String then @name
-      when Symbol then @localizer ? @localizer.t(@name, scope: 'scopes') : @name.to_s.titleize
+      when Symbol then @localizer ? @localizer.t(@name, scope: "scopes") : @name.to_s.titleize
       else @name
       end
     end