activeadmin 1.3.0 → 2.13.1

data/lib/active_admin/namespace_settings.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+require "active_admin/dynamic_settings_node"
+
+module ActiveAdmin
+  class NamespaceSettings < DynamicSettingsNode
+    # The default number of resources to display on index pages
+    register :default_per_page, 30
+
+    # The max number of resources to display on index pages and batch exports
+    register :max_per_page, 10_000
+
+    # The title which gets displayed in the main layout
+    register :site_title, "", :string_symbol_or_proc
+
+    # Set the site title link href (defaults to AA dashboard)
+    register :site_title_link, ""
+
+    # Set the site title image displayed in the main layout (has precendence over :site_title)
+    register :site_title_image, "", :string_symbol_or_proc
+
+    # Add to the site head
+    register :head, "", :string_symbol_or_proc
+
+    # Set the site footer text (defaults to Powered by ActiveAdmin text with version)
+    register :footer, "", :string_symbol_or_proc
+
+    # Set a favicon
+    register :favicon, false
+
+    # Additional meta tags to place in head of logged in pages
+    register :meta_tags, {}
+
+    # Additional meta tags to place in head of logged out pages
+    register :meta_tags_for_logged_out_pages, { robots: "noindex, nofollow" }
+
+    # The view factory to use to generate all the view classes. Take
+    # a look at ActiveAdmin::ViewFactory
+    register :view_factory, ActiveAdmin::ViewFactory.new
+
+    # The method to call in controllers to get the current user
+    register :current_user_method, false
+
+    # The method to call in the controllers to ensure that there
+    # is a currently authenticated admin user
+    register :authentication_method, false
+
+    # The path to log user's out with. If set to a symbol, we assume
+    # that it's a method to call which returns the path
+    register :logout_link_path, :destroy_admin_user_session_path
+
+    # The method to use when generating the link for user logout
+    register :logout_link_method, :get
+
+    # Whether the batch actions are enabled or not
+    register :batch_actions, false
+
+    # Whether filters are enabled
+    register :filters, true
+
+    # The namespace root
+    register :root_to, "dashboard#index"
+
+    # Options that are passed to root_to
+    register :root_to_options, {}
+
+    # Options passed to the routes, i.e. { path: '/custom' }
+    register :route_options, {}
+
+    # Display breadcrumbs
+    register :breadcrumb, true
+
+    # Display create another checkbox on a new page
+    # @return [Boolean] (true)
+    register :create_another, false
+
+    # Default CSV options
+    register :csv_options, { col_sep: ",", byte_order_mark: "\xEF\xBB\xBF" }
+
+    # Default Download Links options
+    register :download_links, true
+
+    # The authorization adapter to use
+    register :authorization_adapter, ActiveAdmin::AuthorizationAdapter
+
+    # A proc to be used when a user is not authorized to view the current resource
+    register :on_unauthorized_access, :rescue_active_admin_access_denied
+
+    # A regex to detect unsupported browser, set to false to disable
+    register :unsupported_browser_matcher, /MSIE [1-8]\.0/
+
+    # Whether to display 'Current Filters' on search screen
+    register :current_filters, true
+
+    # class to handle ordering
+    register :order_clause, ActiveAdmin::OrderClause
+
+    # default show_count for scopes
+    register :scopes_show_count, true
+
+    # Request parameters that are permitted by default
+    register :permitted_params, [
+      :utf8, :_method, :authenticity_token, :commit, :id
+    ]
+
+    # Set flash message keys that shouldn't show in ActiveAdmin
+    register :flash_keys_to_except, ["timedout"]
+
+    # Include association filters by default
+    register :include_default_association_filters, true
+
+    register :maximum_association_filter_arity, :unlimited
+
+    register :filter_columns_for_large_association, [
+        :display_name,
+        :full_name,
+        :name,
+        :username,
+        :login,
+        :title,
+        :email,
+    ]
+    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,9 +1,10 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class OrderClause
     attr_reader :field, :order, :active_admin_config
 
     def initialize(active_admin_config, clause)
-      clause =~ /^([\w\_\.]+)(->'\w+')?_(desc|asc)$/
+      clause =~ /^([\w\.]+)(->'\w+')?_(desc|asc)$/
       @column = $1
       @op = $2
       @order = $3
@@ -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
-    belongs_to :author,   polymorphic: true
+    belongs_to :resource, polymorphic: true, optional: 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,
-        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
@@ -11,82 +12,87 @@ module ActiveAdmin
         attr_accessor :resource
 
         def build(resource)
-          @resource = resource
-          @comments = ActiveAdmin::Comment.find_for_resource_in_namespace(resource, active_admin_namespace.name).includes(:author).page(params[:page])
-          super(title, for: resource)
-          build_comments
+          if authorized?(ActiveAdmin::Auth::READ, ActiveAdmin::Comment)
+            @resource = resource
+            @comments = active_admin_authorization.scope_collection(ActiveAdmin::Comment.find_for_resource_in_namespace(resource, active_admin_namespace.name).includes(:author).page(params[:page]))
+            super(title, for: resource)
+            build_comments
+          end
         end
 
         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
 
           text_node paginate @comments
-          build_comment_form
+
+          if authorized?(ActiveAdmin::Auth::CREATE, ActiveAdmin::Comment)
+            build_comment_form
+          end
         end
 
         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,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.

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