activeadmin 1.4.3 → 3.0.0

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,20 @@ 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::READ then subject.is_a?(Class) ? :index? : :show?
       when Auth::DESTROY then subject.is_a?(Class) ? :destroy_all? : :destroy?
       else "#{action}?"
       end
@@ -55,14 +52,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
 
@@ -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::NEW, 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::EDIT, 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
@@ -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

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

data/lib/active_admin/resource/pagination.rb

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

data/lib/active_admin/resource/routes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module Routes
@@ -20,7 +21,11 @@ module ActiveAdmin
       end
 
       def route_edit_instance_path(resource, additional_params = {})
-        route_builder.edit_instance_path(resource, additional_params)
+        route_builder.member_action_path(:edit, resource, additional_params)
+      end
+
+      def route_member_action_path(action, resource, additional_params = {})
+        route_builder.member_action_path(action, resource, additional_params)
       end
 
       # Returns the routes prefix for this config
@@ -38,8 +43,6 @@ module ActiveAdmin
         config[:route_collection_name] == config[:route_instance_name]
       end
 
-      private
-
       class RouteBuilder
         def initialize(resource)
           @resource = resource
@@ -75,12 +78,13 @@ module ActiveAdmin
           routes.public_send route_name, *route_instance_params(instance), additional_params
         end
 
-        # @return [String] the path to the edit page of this resource
+        # @return [String] the path to the member action of this resource
+        # @param action [Symbol]
         # @param instance [ActiveRecord::Base] the instance we want the path of
         # @example "/admin/posts/1/edit"
-        def edit_instance_path(instance, additional_params = {})
+        def member_action_path(action, instance, additional_params = {})
           path = resource.resources_configuration[:self][:route_instance_name]
-          route_name = route_name(path, action: :edit)
+          route_name = route_name(path, action: action)
 
           routes.public_send route_name, *route_instance_params(instance), additional_params
         end
@@ -93,19 +97,19 @@ module ActiveAdmin
           suffix = options[:suffix] || "path"
           route = []
 
-          route << options[:action]           # "batch_action", "edit" or "new"
-          route << resource.route_prefix      # "admin"
+          route << options[:action] # "batch_action", "edit" or "new"
+          route << resource.route_prefix # "admin"
           route << belongs_to_name if nested? # "category"
-          route << resource_path_name         # "posts" or "post"
-          route << suffix                     # "path" or "index path"
+          route << resource_path_name # "posts" or "post"
+          route << suffix # "path" or "index path"
 
-          route.compact.join('_').to_sym      # :admin_category_posts_path
+          route.compact.join("_").to_sym # :admin_category_posts_path
         end
 
         # @return params to pass to instance path
         def route_instance_params(instance)
           if nested?
-            [instance.public_send(belongs_to_name).to_param, instance.to_param]
+            [instance.public_send(belongs_to_target_name).to_param, instance.to_param]
           else
             instance.to_param
           end
@@ -118,11 +122,19 @@ module ActiveAdmin
         end
 
         def nested?
-          resource.belongs_to? && resource.belongs_to_config.required?
+          resource.belongs_to? && belongs_to_config.required?
+        end
+
+        def belongs_to_target_name
+          belongs_to_config.target_name
         end
 
         def belongs_to_name
-          resource.belongs_to_config.target.resource_name.singular if nested?
+          belongs_to_config.target.resource_name.singular
+        end
+
+        def belongs_to_config
+          resource.belongs_to_config
         end
 
         def routes

data/lib/active_admin/resource/scope_to.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module ScopeTo
@@ -38,10 +39,10 @@ module ActiveAdmin
         options = args.extract_options!
         method = args.first
 
-        scope_to_config[:method]              = block || method
-        scope_to_config[:association_method]  = options[:association_method]
-        scope_to_config[:if]                  = options[:if]
-        scope_to_config[:unless]              = options[:unless]
+        scope_to_config[:method] = block || method
+        scope_to_config[:association_method] = options[:association_method]
+        scope_to_config[:if] = options[:if]
+        scope_to_config[:unless] = options[:unless]
 
       end
 
@@ -55,10 +56,10 @@ module ActiveAdmin
 
       def scope_to_config
         @scope_to_config ||= {
-          method:             nil,
+          method: nil,
           association_method: nil,
-          if:                 nil,
-          unless:             nil
+          if: nil,
+          unless: nil
         }
       end
 

data/lib/active_admin/resource/scopes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Resource
     module Scopes
@@ -10,7 +11,7 @@ module ActiveAdmin
       # Returns a scope for this object by its identifier
       def get_scope_by_id(id)
         id = id.to_s
-        scopes.find{|s| s.id == id }
+        scopes.find { |s| s.id == id }
       end
 
       def default_scope(context = nil)
@@ -27,7 +28,7 @@ module ActiveAdmin
       # If you want to internationalize the scope name, you can add
       # to your i18n files a key like "active_admin.scopes.scope_method".
       def scope(*args, &block)
-        default_options = {show_count: namespace.scopes_show_count}
+        default_options = { show_count: namespace.scopes_show_count }
         options = default_options.merge(args.extract_options!)
         title = args[0] rescue nil
         method = args[1] rescue nil
@@ -36,7 +37,7 @@ module ActiveAdmin
         scope = ActiveAdmin::Scope.new(title, method, options, &block)
 
         # Finds and replaces a scope by the same name if it already exists
-        existing_scope_index = scopes.index{|existing_scope| existing_scope.id == scope.id }
+        existing_scope_index = scopes.index { |existing_scope| existing_scope.id == scope.id }
         if existing_scope_index
           scopes.delete_at(existing_scope_index)
           scopes.insert(existing_scope_index, scope)

data/lib/active_admin/resource/sidebars.rb

@@ -1,4 +1,5 @@
-require 'active_admin/helpers/optional_display'
+# frozen_string_literal: true
+require "active_admin/helpers/optional_display"
 
 module ActiveAdmin
 
@@ -14,7 +15,7 @@ module ActiveAdmin
       end
 
       def sidebar_sections_for(action, render_context = nil)
-        sidebar_sections.select{|section| section.display_on?(action, render_context) }
+        sidebar_sections.select { |section| section.display_on?(action, render_context) }
           .sort_by(&:priority)
       end
 

data/lib/active_admin/resource.rb

@@ -1,17 +1,19 @@
-require 'active_admin/resource/action_items'
-require 'active_admin/resource/attributes'
-require 'active_admin/resource/controllers'
-require 'active_admin/resource/menu'
-require 'active_admin/resource/page_presenters'
-require 'active_admin/resource/pagination'
-require 'active_admin/resource/routes'
-require 'active_admin/resource/naming'
-require 'active_admin/resource/scopes'
-require 'active_admin/resource/includes'
-require 'active_admin/resource/scope_to'
-require 'active_admin/resource/sidebars'
-require 'active_admin/resource/belongs_to'
-require 'active_admin/resource/ordering'
+# frozen_string_literal: true
+require "active_admin/resource/action_items"
+require "active_admin/resource/attributes"
+require "active_admin/resource/controllers"
+require "active_admin/resource/menu"
+require "active_admin/resource/page_presenters"
+require "active_admin/resource/pagination"
+require "active_admin/resource/routes"
+require "active_admin/resource/naming"
+require "active_admin/resource/scopes"
+require "active_admin/resource/includes"
+require "active_admin/resource/scope_to"
+require "active_admin/resource/sidebars"
+require "active_admin/resource/belongs_to"
+require "active_admin/resource/ordering"
+require "active_admin/resource/model"
 
 module ActiveAdmin
 
@@ -26,7 +28,7 @@ module ActiveAdmin
   class Resource
 
     # Event dispatched when a new resource is registered
-    RegisterEvent = 'active_admin.resource.register'.freeze
+    RegisterEvent = "active_admin.resource.register".freeze
 
     # The namespace this config belongs to
     attr_reader :namespace
@@ -43,7 +45,7 @@ module ActiveAdmin
     # The default sort order to use in the controller
     attr_writer :sort_order
     def sort_order
-      @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : 'id') + '_desc'
+      @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : "id") + "_desc"
     end
 
     # Set the configuration for the CSV
@@ -69,9 +71,10 @@ module ActiveAdmin
       def initialize(namespace, resource_class, options = {})
         @namespace = namespace
         @resource_class_name = "::#{resource_class.name}"
-        @options    = options
+        @options = options
         @sort_order = options[:sort_order]
-        @member_actions, @collection_actions = [], []
+        @member_actions = []
+        @collection_actions = []
       end
     end
 
@@ -96,11 +99,15 @@ module ActiveAdmin
     # The class this resource wraps. If you register the Post model, Resource#resource_class
     # will point to the Post class
     def resource_class
-      ActiveSupport::Dependencies.constantize(resource_class_name)
+      resource_class_name.constantize
     end
 
     def decorator_class
-      ActiveSupport::Dependencies.constantize(decorator_class_name) if decorator_class_name
+      decorator_class_name&.constantize
+    end
+
+    def resource_name_extension
+      @resource_name_extension ||= define_resource_name_extension(self)
     end
 
     def resource_table_name
@@ -132,6 +139,7 @@ module ActiveAdmin
     def belongs_to(target, options = {})
       @belongs_to = Resource::BelongsTo.new(self, target, options)
       self.menu_item_options = false if @belongs_to.required?
+      options[:class_name] ||= @belongs_to.resource.resource_class_name if @belongs_to.resource
       controller.send :belongs_to, target, options.dup
     end
 
@@ -181,11 +189,11 @@ module ActiveAdmin
     end
 
     def association_columns
-      @association_columns ||= resource_attributes.select{ |key, value| key != value }.values
+      @association_columns ||= resource_attributes.select { |key, value| key != value }.values
     end
 
     def content_columns
-      @content_columns ||= resource_attributes.select{ |key, value| key == value }.values
+      @content_columns ||= resource_attributes.select { |key, value| key == value }.values
     end
 
     private
@@ -202,5 +210,12 @@ module ActiveAdmin
       @default_csv_builder ||= CSVBuilder.default_for_resource(self)
     end
 
+    def define_resource_name_extension(resource)
+      Module.new do
+        define_method :model_name do
+          resource.resource_name
+        end
+      end
+    end
   end # class Resource
 end # module ActiveAdmin

data/lib/active_admin/resource_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   # This is a container for resources, which acts much like a Hash.
   # It's assumed that an added resource responds to `resource_name`.
@@ -38,12 +39,12 @@ module ActiveAdmin
         r.resource_class.to_s == obj.to_s
       end ||
       if obj.respond_to? :base_class
-        resources.detect{ |r| r.resource_class.to_s == obj.base_class.to_s }
+        resources.detect { |r| r.resource_class.to_s == obj.base_class.to_s }
       end
     end
 
     def resources
-      select{ |r| r.class <= Resource } # can otherwise be a Page
+      select { |r| r.class <= Resource } # can otherwise be a Page
     end
 
     def raise_if_mismatched!(existing, given)