activeadmin 1.0.0 → 2.13.1

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

@@ -1,21 +1,33 @@
-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')
+# i18n-tasks-use t('activerecord.models.active_admin/comment')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.author_type')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.body')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.created_at')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.namespace')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.resource_type')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.updated_at')
+# i18n-tasks-use t('active_admin.scopes.all')
 
 # Walk through all the loaded namespaces after they're loaded
 ActiveAdmin.after_load do |app|
@@ -25,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
@@ -40,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
@@ -53,21 +65,21 @@ ActiveAdmin.after_load do |app|
         def create
           create! do |success, failure|
             success.html do
-              ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+              redirect_back fallback_location: active_admin_root
             end
             failure.html do
-              flash[:error] = I18n.t 'active_admin.comments.errors.empty_text'
-              ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+              flash[:error] = I18n.t "active_admin.comments.errors.empty_text"
+              redirect_back fallback_location: active_admin_root
             end
           end
 
           def destroy
             destroy! do |success, failure|
               success.html do
-                ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+                redirect_back fallback_location: active_admin_root
               end
               failure.html do
-                ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+                redirect_back fallback_location: active_admin_root
               end
             end
           end
@@ -77,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.
@@ -10,7 +11,7 @@ module ActiveAdmin
 
     before_action :authorize_access!
 
-    def index(options={}, &block)
+    def index(options = {}, &block)
       render "active_admin/page/index"
     end
 

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
@@ -21,7 +22,7 @@ module ActiveAdmin
     def page_action(name, options = {}, &block)
       config.page_actions << ControllerAction.new(name, options)
       controller do
-        define_method(name, &block || Proc.new{})
+        define_method(name, &block || Proc.new {})
       end
     end
 

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
@@ -21,7 +22,8 @@ module ActiveAdmin
     delegate :has_key?, :fetch, to: :options
 
     def initialize(options = {}, &block)
-      @options, @block = options, block
+      @options = options
+      @block = block
     end
 
     def [](key)

data/lib/active_admin/pundit_adapter.rb

@@ -1,9 +1,11 @@
+# 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
+ActiveAdmin::Application.inheritable_setting :pundit_policy_namespace, nil
 
 module ActiveAdmin
 
@@ -19,7 +21,7 @@ module ActiveAdmin
     def scope_collection(collection, action = Auth::READ)
       # scoping is appliable only to read/index action
       # which means there is no way how to scope other actions
-      Pundit.policy_scope!(user, collection)
+      Pundit.policy_scope!(user, namespace(collection))
     rescue Pundit::NotDefinedError => e
       if default_policy_class && default_policy_class.const_defined?(:Scope)
         default_policy_class::Scope.new(user, collection).resolve
@@ -29,25 +31,22 @@ module ActiveAdmin
     end
 
     def retrieve_policy(subject)
-      case subject
-      when nil   then Pundit.policy!(user, resource)
-      when Class then Pundit.policy!(user, subject.new)
-      else Pundit.policy!(user, 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/elabs/pundit/blob/master/lib/generators/pundit/install/templates/application_policy.rb
+      # 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
@@ -55,14 +54,72 @@ 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.start_with?("#{default_policy_module}::")
+        [default_policy_namespace.to_sym, object]
+      else
+        object
+      end
+    end
+
     def default_policy_class
       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
 
+    def default_policy_namespace
+      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
 
@@ -24,6 +25,7 @@ module ActiveAdmin
       #                         this action item on.
       #                 :except: A single or array of controller actions not to
       #                          display this action item on.
+      #                 :priority: A single integer value. To control the display order. Default is 10.
       def add_action_item(name, options = {}, &block)
         self.action_items << ActiveAdmin::ActionItem.new(name, options, &block)
       end
@@ -38,7 +40,7 @@ module ActiveAdmin
       #
       # @return [Array] Array of ActionItems for the controller actions
       def action_items_for(action, render_context = nil)
-        action_items.select{ |item| item.display_on? action, render_context }
+        action_items.select { |item| item.display_on? action, render_context }.sort_by(&:priority)
       end
 
       # Clears all the existing action items for this resource
@@ -63,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
@@ -73,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
@@ -83,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
@@ -106,6 +108,14 @@ module ActiveAdmin
       @block = block
       normalize_display_options!
     end
+
+    def html_class
+      "action_item #{@options[:class]}".rstrip
+    end
+
+    def priority
+      @options[:priority] || 10
+    end
   end
 
 end

data/lib/active_admin/resource/attributes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   class Resource
@@ -18,13 +19,13 @@ module ActiveAdmin
 
       def foreign_methods
         @foreign_methods ||= resource_class.reflect_on_all_associations.
-          select{ |r| r.macro == :belongs_to }.
-          reject{ |r| r.chain.length > 2 && !r.options[:polymorphic] }.
-          index_by{ |r| r.foreign_key.to_sym }
+          select { |r| r.macro == :belongs_to }.
+          reject { |r| r.chain.length > 2 && !r.options[:polymorphic] }.
+          index_by { |r| r.foreign_key.to_sym }
       end
 
       def reject_col?(c)
-        primary_col?(c) || sti_col?(c) || counter_cache_col?(c)
+        primary_col?(c) || sti_col?(c) || counter_cache_col?(c) || filtered_col?(c)
       end
 
       def primary_col?(c)
@@ -36,9 +37,12 @@ module ActiveAdmin
       end
 
       def counter_cache_col?(c)
-        c.name.end_with?('_count')
+        c.name.end_with?("_count")
       end
 
+      def filtered_col?(c)
+        ActiveAdmin.application.filter_attributes.include?(c.name.to_sym)
+      end
     end
   end
-end
+end

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
@@ -14,8 +15,13 @@ module ActiveAdmin
       # The resource which initiated this relationship
       attr_reader :owner
 
+      # The name of the relation
+      attr_reader :target_name
+
       def initialize(owner, target_name, options = {})
-        @owner, @target_name, @options = owner, target_name, options
+        @owner = owner
+        @target_name = target_name
+        @options = options
       end
 
       # Returns the target resource class or raises an exception if it doesn't exist
@@ -41,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

data/lib/active_admin/resource/menu.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
 
@@ -7,12 +8,12 @@ module ActiveAdmin
       # To disable this menu item, call `menu(false)` from the DSL
       def menu_item_options=(options)
         if options == false
-          @include_in_menu   = false
+          @include_in_menu = false
           @menu_item_options = {}
         else
           @include_in_menu = true
           @navigation_menu_name = options[:menu_name]
-          @menu_item_options    = default_menu_options.merge options
+          @menu_item_options = default_menu_options.merge options
         end
       end
 
@@ -26,9 +27,9 @@ module ActiveAdmin
         resource = self
         {
           id: resource_name.plural,
-          label: proc{ resource.plural_resource_label },
-          url:   proc{ resource.route_collection_path(params, url_options) },
-          if:    proc{ authorized?(Auth::READ, menu_resource_class) }
+          label: proc { resource.plural_resource_label },
+          url: proc { resource.route_collection_path(params, url_options) },
+          if: proc { authorized?(Auth::READ, menu_resource_class) }
         }
       end
 

data/lib/active_admin/resource/model.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  class Model
+    def initialize(resource, record)
+      @record = record
+
+      if resource
+        @record.extend(resource.resource_name_extension)
+      end
+    end
+
+    def to_model
+      @record
+    end
+  end
+end

data/lib/active_admin/resource/naming.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
 
     module Naming
       def resource_name
         @resource_name ||= begin
-          as = @options[:as].gsub /\s/, '' if @options[:as]
+          as = @options[:as].gsub /\s/, "" if @options[:as]
 
           if as || !resource_class.respond_to?(:model_name)
             Name.new resource_class, as
@@ -17,13 +18,13 @@ module ActiveAdmin
       # Returns the name to call this resource such as "Bank Account"
       def resource_label
         resource_name.translate count: 1,
-          default: resource_name.to_s.gsub('::', ' ').titleize
+                                default: resource_name.to_s.gsub("::", " ").titleize
       end
 
       # Returns the plural version of this resource such as "Bank Accounts"
       def plural_resource_label(options = {})
-        defaults = {count:   Helpers::I18n::PLURAL_MANY_COUNT,
-                    default: resource_label.pluralize.titleize}
+        defaults = { count: Helpers::I18n::PLURAL_MANY_COUNT,
+                     default: resource_label.pluralize.titleize }
         resource_name.translate defaults.merge options
       end
 
@@ -46,7 +47,7 @@ module ActiveAdmin
       end
 
       def translate(options = {})
-        I18n.t i18n_key, {scope: [:activerecord, :models]}.merge(options)
+        I18n.t i18n_key, **{ scope: [:activerecord, :models] }.merge(options)
       end
 
       def route_key

data/lib/active_admin/resource/ordering.rb

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

data/lib/active_admin/resource/page_presenters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module PagePresenters
@@ -33,7 +34,7 @@ module ActiveAdmin
       # @param [Symbol, String] action The action to get the config for
       # @param [String] type The string specified in the presenters index_name method
       # @return [PagePresenter, nil]
-      def get_page_presenter(action, type=nil)
+      def get_page_presenter(action, type = nil)
 
         if action.to_s == "index" && type && page_presenters[:index].kind_of?(Hash)
           page_presenters[:index][type.to_sym]

data/lib/active_admin/resource/pagination.rb

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