activeadmin 2.4.0 → 2.13.1

data/lib/active_admin/menu_item.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class MenuItem
     include Menu::MenuNode
@@ -45,13 +46,13 @@ module ActiveAdmin
     #
     def initialize(options = {})
       super() # MenuNode
-      @label          = options[:label]
-      @dirty_id       = options[:id]           || options[:label]
-      @url            = options[:url]          || '#'
-      @priority       = options[:priority]     || 10
-      @html_options   = options[:html_options] || {}
-      @should_display = options[:if]           || proc { true }
-      @parent         = options[:parent]
+      @label = options[:label]
+      @dirty_id = options[:id] || options[:label]
+      @url = options[:url] || "#"
+      @priority = options[:priority] || 10
+      @html_options = options[:html_options] || {}
+      @should_display = options[:if] || proc { true }
+      @parent = options[:parent]
 
       yield(self) if block_given? # Builder style syntax
     end

data/lib/active_admin/namespace.rb

@@ -1,4 +1,5 @@
-require 'active_admin/resource_collection'
+# frozen_string_literal: true
+require "active_admin/resource_collection"
 
 module ActiveAdmin
 
@@ -31,7 +32,7 @@ module ActiveAdmin
       end
     end
 
-    RegisterEvent = 'active_admin.namespace.register'.freeze
+    RegisterEvent = "active_admin.namespace.register".freeze
 
     attr_reader :application, :resources, :menus
 
@@ -59,7 +60,7 @@ module ActiveAdmin
       settings.respond_to?(method) ? settings.send(method, *args) : super
     end
 
-    # Register a resource into this namespace. The preffered method to access this is to
+    # Register a resource into this namespace. The preferred method to access this is to
     # use the global registration ActiveAdmin.register which delegates to the proper
     # namespace instance.
     def register(resource_class, options = {}, &block)
@@ -71,7 +72,7 @@ module ActiveAdmin
       reset_menu!
 
       # Dispatch a registration event
-      ActiveSupport::Notifications.publish ActiveAdmin::Resource::RegisterEvent, config
+      ActiveSupport::Notifications.instrument ActiveAdmin::Resource::RegisterEvent, { active_admin_resource: config }
 
       # Return the config
       config
@@ -149,10 +150,10 @@ module ActiveAdmin
     def add_logout_button_to_menu(menu, priority = 20, html_options = {})
       if logout_link_path
         html_options = html_options.reverse_merge(method: logout_link_method || :get)
-        menu.add id: 'logout', priority: priority, html_options: html_options,
-          label: -> { I18n.t 'active_admin.logout' },
-          url:   -> { render_or_call_method_or_proc_on self, active_admin_namespace.logout_link_path },
-          if:    :current_active_admin_user?
+        menu.add id: "logout", priority: priority, html_options: html_options,
+                 label: -> { I18n.t "active_admin.logout" },
+                 url: -> { render_or_call_method_or_proc_on self, active_admin_namespace.logout_link_path },
+                 if: :current_active_admin_user?
       end
     end
 
@@ -164,10 +165,10 @@ module ActiveAdmin
     #
     def add_current_user_to_menu(menu, priority = 10, html_options = {})
       if current_user_method
-        menu.add id: 'current_user', priority: priority, html_options: html_options,
-          label: -> { display_name current_active_admin_user },
-          url:   -> { auto_url_for(current_active_admin_user) },
-          if:    :current_active_admin_user?
+        menu.add id: "current_user", priority: priority, html_options: html_options,
+                 label: -> { display_name current_active_admin_user },
+                 url: -> { auto_url_for(current_active_admin_user) },
+                 if: :current_active_admin_user?
       end
     end
 
@@ -211,8 +212,8 @@ module ActiveAdmin
 
     def unload_resources!
       resources.each do |resource|
-        parent = (module_name || 'Object').constantize
-        name   = resource.controller_name.split('::').last
+        parent = (module_name || "Object").constantize
+        name = resource.controller_name.split("::").last
         parent.send(:remove_const, name) if parent.const_defined?(name, false)
 
         # Remove circular references

data/lib/active_admin/namespace_settings.rb

@@ -1,4 +1,5 @@
-require 'active_admin/dynamic_settings_node'
+# frozen_string_literal: true
+require "active_admin/dynamic_settings_node"
 
 module ActiveAdmin
   class NamespaceSettings < DynamicSettingsNode
@@ -57,7 +58,7 @@ module ActiveAdmin
     register :filters, true
 
     # The namespace root
-    register :root_to, 'dashboard#index'
+    register :root_to, "dashboard#index"
 
     # Options that are passed to root_to
     register :root_to_options, {}
@@ -73,7 +74,7 @@ module ActiveAdmin
     register :create_another, false
 
     # Default CSV options
-    register :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
+    register :csv_options, { col_sep: ",", byte_order_mark: "\xEF\xBB\xBF" }
 
     # Default Download Links options
     register :download_links, true
@@ -102,7 +103,7 @@ module ActiveAdmin
     ]
 
     # Set flash message keys that shouldn't show in ActiveAdmin
-    register :flash_keys_to_except, ['timedout']
+    register :flash_keys_to_except, ["timedout"]
 
     # Include association filters by default
     register :include_default_association_filters, true
@@ -118,6 +119,9 @@ module ActiveAdmin
         :title,
         :email,
     ]
-    register :filter_method_for_large_association, '_starts_with'
+    register :filter_method_for_large_association, "_starts_with"
+
+    # Switch between asset pipeline and webpacker assets
+    register :use_webpacker, false
   end
 end

data/lib/active_admin/order_clause.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class OrderClause
     attr_reader :field, :order, :active_admin_config
@@ -20,7 +21,7 @@ module ActiveAdmin
     end
 
     def to_sql
-      [table_column, @op, ' ', @order].compact.join
+      [table_column, @op, " ", @order].compact.join
     end
 
     def table

data/lib/active_admin/orm/active_record/comments/comment.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Comment < ActiveRecord::Base
 
     self.table_name = "#{table_name_prefix}active_admin_comments#{table_name_suffix}"
 
     belongs_to :resource, polymorphic: true, optional: true
-    belongs_to :author,   polymorphic: true
+    belongs_to :author, polymorphic: true
 
     validates_presence_of :body, :namespace, :resource
 
@@ -18,8 +19,8 @@ module ActiveAdmin
     def self.find_for_resource_in_namespace(resource, namespace)
       where(
         resource_type: resource_type(resource),
-        resource_id:   resource.id,
-        namespace:     namespace.to_s
+        resource_id: resource.id,
+        namespace: namespace.to_s
       ).order(ActiveAdmin.application.namespaces[namespace.to_sym].comments_order)
     end
 

data/lib/active_admin/orm/active_record/comments/namespace_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Comments
 

data/lib/active_admin/orm/active_record/comments/resource_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Comments
 

data/lib/active_admin/orm/active_record/comments/show_page_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Comments
 

data/lib/active_admin/orm/active_record/comments/views/active_admin_comments.rb

@@ -1,5 +1,6 @@
-require 'active_admin/views'
-require 'active_admin/views/components/panel'
+# frozen_string_literal: true
+require "active_admin/views"
+require "active_admin/views/components/panel"
 
 module ActiveAdmin
   module Comments
@@ -22,13 +23,13 @@ module ActiveAdmin
         protected
 
         def title
-          I18n.t 'active_admin.comments.title_content', count: @comments.total_count
+          I18n.t "active_admin.comments.title_content", count: @comments.total_count
         end
 
         def build_comments
           if @comments.any?
             @comments.each(&method(:build_comment))
-            div page_entries_info(@comments).html_safe, class: 'pagination_information'
+            div page_entries_info(@comments).html_safe, class: "pagination_information"
           else
             build_empty_message
           end
@@ -42,56 +43,56 @@ module ActiveAdmin
 
         def build_comment(comment)
           div for: comment do
-            div class: 'active_admin_comment_meta' do
-              h4 class: 'active_admin_comment_author' do
-                comment.author ? auto_link(comment.author) : I18n.t('active_admin.comments.author_missing')
+            div class: "active_admin_comment_meta" do
+              h4 class: "active_admin_comment_author" do
+                comment.author ? auto_link(comment.author) : I18n.t("active_admin.comments.author_missing")
               end
               span pretty_format comment.created_at
               if authorized?(ActiveAdmin::Auth::DESTROY, comment)
-                text_node link_to I18n.t('active_admin.comments.delete'), comments_url(comment.id), method: :delete, data: { confirm: I18n.t('active_admin.comments.delete_confirmation') }
+                text_node link_to I18n.t("active_admin.comments.delete"), comments_url(comment.id), method: :delete, data: { confirm: I18n.t("active_admin.comments.delete_confirmation") }
               end
             end
-            div class: 'active_admin_comment_body' do
+            div class: "active_admin_comment_body" do
               simple_format comment.body
             end
           end
         end
 
         def build_empty_message
-          span I18n.t('active_admin.comments.no_comments_yet'), class: 'empty'
+          span I18n.t("active_admin.comments.no_comments_yet"), class: "empty"
         end
 
         def comments_url(*args)
           parts = []
           parts << active_admin_namespace.name unless active_admin_namespace.root?
           parts << active_admin_namespace.comments_registration_name.underscore
-          parts << 'path'
-          send parts.join('_'), *args
+          parts << "path"
+          send parts.join("_"), *args
         end
 
         def comment_form_url
           parts = []
           parts << active_admin_namespace.name unless active_admin_namespace.root?
           parts << active_admin_namespace.comments_registration_name.underscore.pluralize
-          parts << 'path'
-          send parts.join '_'
+          parts << "path"
+          send parts.join "_"
         end
 
         def build_comment_form
           active_admin_form_for(ActiveAdmin::Comment.new, url: comment_form_url) do |f|
             f.inputs do
-              f.input :resource_type, as: :hidden,  input_html: { value: ActiveAdmin::Comment.resource_type(parent.resource) }
-              f.input :resource_id,   as: :hidden,  input_html: { value: parent.resource.id }
-              f.input :body,          label: false, input_html: { size: '80x8' }
+              f.input :resource_type, as: :hidden, input_html: { value: ActiveAdmin::Comment.resource_type(parent.resource) }
+              f.input :resource_id, as: :hidden, input_html: { value: parent.resource.id }
+              f.input :body, label: false, input_html: { size: "80x8" }
             end
             f.actions do
-              f.action :submit, label: I18n.t('active_admin.comments.add')
+              f.action :submit, label: I18n.t("active_admin.comments.add")
             end
           end
         end
 
         def default_id_for_prefix
-          'active_admin_comments_for'
+          "active_admin_comments_for"
         end
       end
 

data/lib/active_admin/orm/active_record/comments/views.rb

@@ -1,2 +1,3 @@
-require 'active_admin/views'
-require 'active_admin/orm/active_record/comments/views/active_admin_comments'
+# frozen_string_literal: true
+require "active_admin/views"
+require "active_admin/orm/active_record/comments/views/active_admin_comments"

data/lib/active_admin/orm/active_record/comments.rb

@@ -1,21 +1,22 @@
-require 'active_admin/orm/active_record/comments/views'
-require 'active_admin/orm/active_record/comments/show_page_helper'
-require 'active_admin/orm/active_record/comments/namespace_helper'
-require 'active_admin/orm/active_record/comments/resource_helper'
+# frozen_string_literal: true
+require "active_admin/orm/active_record/comments/views"
+require "active_admin/orm/active_record/comments/show_page_helper"
+require "active_admin/orm/active_record/comments/namespace_helper"
+require "active_admin/orm/active_record/comments/resource_helper"
 
 # Add the comments configuration
-ActiveAdmin::Application.inheritable_setting :comments,                   true
-ActiveAdmin::Application.inheritable_setting :comments_registration_name, 'Comment'
-ActiveAdmin::Application.inheritable_setting :comments_order,             "created_at ASC"
-ActiveAdmin::Application.inheritable_setting :comments_menu,              {}
+ActiveAdmin::Application.inheritable_setting :comments, true
+ActiveAdmin::Application.inheritable_setting :comments_registration_name, "Comment"
+ActiveAdmin::Application.inheritable_setting :comments_order, "created_at ASC"
+ActiveAdmin::Application.inheritable_setting :comments_menu, {}
 
 # Insert helper modules
 ActiveAdmin::Namespace.send :include, ActiveAdmin::Comments::NamespaceHelper
-ActiveAdmin::Resource.send  :include, ActiveAdmin::Comments::ResourceHelper
+ActiveAdmin::Resource.send :include, ActiveAdmin::Comments::ResourceHelper
 ActiveAdmin.application.view_factory.show_page.send :include, ActiveAdmin::Comments::ShowPageHelper
 
 # Load the model as soon as it's referenced. By that point, Rails & Kaminari will be ready
-ActiveAdmin.autoload :Comment, 'active_admin/orm/active_record/comments/comment'
+ActiveAdmin.autoload :Comment, "active_admin/orm/active_record/comments/comment"
 
 # Hint i18n-tasks about model and attribute translations used by default install
 # i18n-tasks-use t('activerecord.models.comment')
@@ -36,7 +37,7 @@ ActiveAdmin.after_load do |app|
 
       menu namespace.comments ? namespace.comments_menu : false
 
-      config.comments      = false # Don't allow comments on comments
+      config.comments = false # Don't allow comments on comments
       config.batch_actions = false # The default destroy batch action isn't showing up anyway...
 
       scope :all, show_count: false
@@ -51,7 +52,7 @@ ActiveAdmin.after_load do |app|
       # Store the author and namespace
       before_save do |comment|
         comment.namespace = active_admin_config.namespace.name
-        comment.author    = current_active_admin_user
+        comment.author = current_active_admin_user
       end
 
       controller do
@@ -67,7 +68,7 @@ ActiveAdmin.after_load do |app|
               redirect_back fallback_location: active_admin_root
             end
             failure.html do
-              flash[:error] = I18n.t 'active_admin.comments.errors.empty_text'
+              flash[:error] = I18n.t "active_admin.comments.errors.empty_text"
               redirect_back fallback_location: active_admin_root
             end
           end
@@ -88,12 +89,12 @@ ActiveAdmin.after_load do |app|
       permit_params :body, :namespace, :resource_id, :resource_type
 
       index do
-        column I18n.t('active_admin.comments.resource_type'), :resource_type
-        column I18n.t('active_admin.comments.author_type'),   :author_type
-        column I18n.t('active_admin.comments.resource'),      :resource
-        column I18n.t('active_admin.comments.author'),        :author
-        column I18n.t('active_admin.comments.body'),          :body
-        column I18n.t('active_admin.comments.created_at'),    :created_at
+        column I18n.t("active_admin.comments.resource_type"), :resource_type
+        column I18n.t("active_admin.comments.author_type"), :author_type
+        column I18n.t("active_admin.comments.resource"), :resource
+        column I18n.t("active_admin.comments.author"), :author
+        column I18n.t("active_admin.comments.body"), :body
+        column I18n.t("active_admin.comments.created_at"), :created_at
         actions
       end
     end

data/lib/active_admin/orm/active_record.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 # ActiveRecord-specific plugins should be required here
 
 ActiveAdmin::DatabaseHitDuringLoad.database_error_classes << ActiveRecord::StatementInvalid
 
-require 'active_admin/orm/active_record/comments'
+require "active_admin/orm/active_record/comments"

data/lib/active_admin/orm/mongoid.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 # Mongoid-specific plugins should be required here

data/lib/active_admin/page.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   # Page is the primary data storage for page configuration in Active Admin
   #
@@ -65,7 +66,7 @@ module ActiveAdmin
     end
 
     def controller_name
-      [namespace.module_name, camelized_resource_name + "Controller"].compact.join('::')
+      [namespace.module_name, camelized_resource_name + "Controller"].compact.join("::")
     end
 
     # Override from `ActiveAdmin::Resource::Controllers`

data/lib/active_admin/page_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   # All Pages controllers inherit from this controller.

data/lib/active_admin/page_dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   # This is the class where all the register_page blocks are evaluated.
   class PageDSL < DSL

data/lib/active_admin/page_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   # A simple object that gets used to present different aspects of views

data/lib/active_admin/pundit_adapter.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 ActiveAdmin::Dependency.pundit!
 
-require 'pundit'
+require "pundit"
 
 # Add a setting to the application to configure the pundit default policy
 ActiveAdmin::Application.inheritable_setting :pundit_default_policy, nil
@@ -30,25 +31,22 @@ module ActiveAdmin
     end
 
     def retrieve_policy(subject)
-      case subject
-      when nil   then Pundit.policy!(user, namespace(resource))
-      when Class then Pundit.policy!(user, namespace(subject.new))
-      else Pundit.policy!(user, namespace(subject))
-      end
-    rescue Pundit::NotDefinedError => e
-      if default_policy_class
-        default_policy(user, subject)
+      target = policy_target(subject)
+      if (policy = policy(namespace(target)) || compat_policy(subject))
+        policy
+      elsif default_policy_class
+        default_policy(subject)
       else
-        raise e
+        raise Pundit::NotDefinedError, "unable to find a compatible policy for `#{target}`"
       end
     end
 
     def format_action(action, subject)
       # https://github.com/varvet/pundit/blob/master/lib/generators/pundit/install/templates/application_policy.rb
       case action
-      when Auth::CREATE  then :create?
-      when Auth::UPDATE  then :update?
-      when Auth::READ    then subject.is_a?(Class) ? :index? : :show?
+      when Auth::CREATE then :create?
+      when Auth::UPDATE then :update?
+      when Auth::READ then subject.is_a?(Class) ? :index? : :show?
       when Auth::DESTROY then subject.is_a?(Class) ? :destroy_all? : :destroy?
       else "#{action}?"
       end
@@ -56,8 +54,42 @@ module ActiveAdmin
 
     private
 
+    def policy_target(subject)
+      case subject
+      when nil then resource
+      when Class then subject.new
+      else subject
+      end
+    end
+
+    # This method is needed to fallback to our previous policy searching logic.
+    # I.e.: when class name contains `default_policy_namespace` (eg: ShopAdmin)
+    # we should try to search it without namespace. This is because that's
+    # the only thing that worked in this case before we fixed our buggy namespace
+    # detection, so people are probably relying on it.
+    # This fallback might be removed in future versions of ActiveAdmin, so
+    # pundit_adapter search will work consistently with provided namespaces
+    def compat_policy(subject)
+      return unless default_policy_namespace
+
+      target = policy_target(subject)
+
+      return unless target.class.to_s.include?(default_policy_module) &&
+        (policy = policy(target))
+
+      policy_name = policy.class.to_s
+
+      Deprecation.warn "You have `pundit_policy_namespace` configured as `#{default_policy_namespace}`, " \
+        "but ActiveAdmin was unable to find policy #{default_policy_module}::#{policy_name}. " \
+        "#{policy_name} will be used instead. " \
+        "This behavior will be removed in future versions of ActiveAdmin. " \
+        "To fix this warning, move your #{policy_name} policy to the #{default_policy_module} namespace"
+
+      policy
+    end
+
     def namespace(object)
-      if default_policy_namespace && !object.class.to_s.include?(default_policy_namespace.to_s.camelize)
+      if default_policy_namespace && !object.class.to_s.start_with?("#{default_policy_module}::")
         [default_policy_namespace.to_sym, object]
       else
         object
@@ -68,7 +100,7 @@ module ActiveAdmin
       ActiveAdmin.application.pundit_default_policy && ActiveAdmin.application.pundit_default_policy.constantize
     end
 
-    def default_policy(user, subject)
+    def default_policy(subject)
       default_policy_class.new(user, subject)
     end
 
@@ -76,6 +108,18 @@ module ActiveAdmin
       ActiveAdmin.application.pundit_policy_namespace
     end
 
+    def default_policy_module
+      default_policy_namespace.to_s.camelize
+    end
+
+    def policy(target)
+      policies[target] ||= Pundit.policy(user, target)
+    end
+
+    def policies
+      @policies ||= {}
+    end
+
   end
 
 end

data/lib/active_admin/resource/action_items.rb

@@ -1,4 +1,5 @@
-require 'active_admin/helpers/optional_display'
+# frozen_string_literal: true
+require "active_admin/helpers/optional_display"
 
 module ActiveAdmin
 
@@ -64,7 +65,7 @@ module ActiveAdmin
       # Adds the default New link on index
       def add_default_new_action_item
         add_action_item :new, only: :index do
-          if controller.action_methods.include?('new') && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
+          if controller.action_methods.include?("new") && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
             localizer = ActiveAdmin::Localizers.resource(active_admin_config)
             link_to localizer.t(:new_model), new_resource_path
           end
@@ -74,7 +75,7 @@ module ActiveAdmin
       # Adds the default Edit link on show
       def add_default_edit_action_item
         add_action_item :edit, only: :show do
-          if controller.action_methods.include?('edit') && authorized?(ActiveAdmin::Auth::UPDATE, resource)
+          if controller.action_methods.include?("edit") && authorized?(ActiveAdmin::Auth::UPDATE, resource)
             localizer = ActiveAdmin::Localizers.resource(active_admin_config)
             link_to localizer.t(:edit_model), edit_resource_path(resource)
           end
@@ -84,10 +85,10 @@ module ActiveAdmin
       # Adds the default Destroy link on show
       def add_default_show_action_item
         add_action_item :destroy, only: :show do
-          if controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, resource)
+          if controller.action_methods.include?("destroy") && authorized?(ActiveAdmin::Auth::DESTROY, resource)
             localizer = ActiveAdmin::Localizers.resource(active_admin_config)
             link_to localizer.t(:delete_model), resource_path(resource), method: :delete,
-              data: { confirm: localizer.t(:delete_confirmation) }
+                                                                         data: { confirm: localizer.t(:delete_confirmation) }
           end
         end
       end

data/lib/active_admin/resource/attributes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   class Resource
@@ -36,7 +37,7 @@ module ActiveAdmin
       end
 
       def counter_cache_col?(c)
-        c.name.end_with?('_count')
+        c.name.end_with?("_count")
       end
 
       def filtered_col?(c)

data/lib/active_admin/resource/belongs_to.rb

@@ -1,4 +1,5 @@
-require 'active_admin/resource'
+# frozen_string_literal: true
+require "active_admin/resource"
 
 module ActiveAdmin
   class Resource
@@ -46,7 +47,7 @@ module ActiveAdmin
       end
 
       def to_param
-        :"#{@target_name}_id"
+        (@options[:param] || "#{@target_name}_id").to_sym
       end
     end
   end

data/lib/active_admin/resource/controllers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module Controllers
@@ -6,7 +7,7 @@ module ActiveAdmin
       # Returns a properly formatted controller name for this
       # config within its namespace
       def controller_name
-        [namespace.module_name, resource_name.plural.camelize + "Controller"].compact.join('::')
+        [namespace.module_name, resource_name.plural.camelize + "Controller"].compact.join("::")
       end
 
       # Returns the controller for this config

data/lib/active_admin/resource/includes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module Includes