activeadmin 1.1.0 → 2.14.0

data/lib/active_admin/helpers/i18n.rb

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

data/lib/active_admin/helpers/optional_display.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   # Shareable module to give a #display_on?(action) method
@@ -15,7 +16,7 @@ module ActiveAdmin
 
   module OptionalDisplay
     def display_on?(action, render_context = self)
-      return false if @options[:only]   && !@options[:only].include?(action.to_sym)
+      return false if @options[:only] && !@options[:only].include?(action.to_sym)
       return false if @options[:except] && @options[:except].include?(action.to_sym)
 
       case condition = @options[:if]
@@ -31,7 +32,7 @@ module ActiveAdmin
     private
 
     def normalize_display_options!
-      @options[:only]   = Array(@options[:only])   if @options[:only]
+      @options[:only] = Array(@options[:only]) if @options[:only]
       @options[:except] = Array(@options[:except]) if @options[:except]
     end
   end

data/lib/active_admin/helpers/routes/url_helpers.rb

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

data/lib/active_admin/helpers/scope_chain.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ScopeChain
+    private
     # Scope an ActiveRecord::Relation chain
     #
     # Example:

data/lib/active_admin/inputs/datepicker_input.rb

@@ -1,18 +1,26 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     class DatepickerInput < ::Formtastic::Inputs::StringInput
       def input_html_options
         super.tap do |options|
-          options[:class] = [options[:class], "datepicker"].compact.join(' ')
+          options[:class] = [options[:class], "datepicker"].compact.join(" ")
           options[:data] ||= {}
           options[:data].merge! datepicker_options
         end
       end
 
+      # Can pass proc to filter label option
+      def label_from_options
+        res = super
+        res = res.call if res.is_a? Proc
+        res
+      end
+
       private
       def datepicker_options
         options = self.options.fetch(:datepicker_options, {})
-        options = Hash[options.map{ |k, v| [k.to_s.camelcase(:lower), v] }]
+        options = Hash[options.map { |k, v| [k.to_s.camelcase(:lower), v] }]
         { datepicker_options: options }
       end
     end

data/lib/active_admin/inputs/filters/base/search_method_select.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is a common set of Formtastic overrides needed to build a filter form
 # that lets you select from a set of search methods for a given attribute.
 #
@@ -31,15 +32,15 @@ module ActiveAdmin
 
           def wrapper_html_options
             opts = super
-            (opts[:class] ||= '') << ' select_and_search' unless seems_searchable?
+            (opts[:class] ||= "") << " select_and_search" unless seems_searchable?
             opts
           end
 
           def to_html
             input_wrapping do
-              label_html  << # your label
+              label_html << # your label
               select_html << # the dropdown that holds the available search methods
-              input_html     # your input field
+              input_html # your input field
             end
           end
 
@@ -48,7 +49,7 @@ module ActiveAdmin
           end
 
           def select_html
-            template.select_tag '', template.options_for_select(filter_options, current_filter)
+            template.select_tag "", template.options_for_select(filter_options, current_filter)
           end
 
           def filters
@@ -57,8 +58,8 @@ module ActiveAdmin
 
           def current_filter
             @current_filter ||= begin
-              methods = filters.map{ |f| "#{method}_#{f}" }
-              methods.detect{ |m| @object.public_send m } || methods.first
+              methods = filters.map { |f| "#{method}_#{f}" }
+              methods.detect { |m| @object.public_send m } || methods.first
             end
           end
 

data/lib/active_admin/inputs/filters/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     module Filters
@@ -25,7 +26,7 @@ module ActiveAdmin
 
         def wrapper_html_options
           opts = super
-          (opts[:class] ||= '') << " filter_form_field filter_#{as}"
+          (opts[:class] ||= "") << " filter_form_field filter_#{as}"
           opts
         end
 

data/lib/active_admin/inputs/filters/boolean_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     module Filters
@@ -16,7 +17,7 @@ module ActiveAdmin
 
         # Provide the AA translation to the blank input field.
         def include_blank
-          I18n.t 'active_admin.any' if super
+          I18n.t "active_admin.any" if super
         end
       end
     end

data/lib/active_admin/inputs/filters/check_boxes_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     module Filters
@@ -22,7 +23,7 @@ module ActiveAdmin
 
         # Add whitespace before label
         def choice_label(choice)
-          ' ' + super
+          " " + super
         end
 
         # Don't wrap in UL tag

data/lib/active_admin/inputs/filters/date_picker_input.rb

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

data/lib/active_admin/inputs/filters/date_range_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     module Filters
@@ -7,8 +8,8 @@ module ActiveAdmin
         def to_html
           input_wrapping do
             [ label_html,
-              builder.text_field(gt_input_name, input_html_options(gt_input_name, gt_input_placeholder)),
-              builder.text_field(lt_input_name, input_html_options(lt_input_name, lt_input_placeholder)),
+              builder.text_field(gt_input_name, input_html_options_for(gt_input_name, gt_input_placeholder)),
+              builder.text_field(lt_input_name, input_html_options_for(lt_input_name, lt_input_placeholder)),
             ].join("\n").html_safe
           end
         end
@@ -22,18 +23,21 @@ module ActiveAdmin
           column && column.type == :date ? "#{method}_lteq" : "#{method}_lteq_datetime"
         end
 
-        def input_html_options(input_name = gt_input_name, placeholder = gt_input_placeholder)
-          current_value = begin
-            #cast value to date object before rendering input
-            @object.public_send(input_name).to_s.to_date
-          rescue
-            nil
-          end
+        def input_html_options
           { size: 12,
             class: "datepicker",
-            maxlength: 10,
-            placeholder: placeholder,
-            value: current_value ? current_value.strftime("%Y-%m-%d") : "" }
+            maxlength: 10 }.merge(options[:input_html] || {})
+        end
+
+        def input_html_options_for(input_name, placeholder)
+          current_value = begin
+                            #cast value to date object before rendering input
+                            @object.public_send(input_name).to_s.to_date
+                          rescue
+                            nil
+                          end
+          { placeholder: placeholder,
+            value: current_value ? current_value.strftime("%Y-%m-%d") : "" }.merge(input_html_options)
         end
 
         def gt_input_placeholder

data/lib/active_admin/inputs/filters/numeric_input.rb

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

data/lib/active_admin/inputs/filters/select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     module Filters
@@ -7,7 +8,7 @@ module ActiveAdmin
         def input_name
           return method if seems_searchable?
 
-          searchable_method_name + (multiple? ? '_in' : '_eq')
+          searchable_method_name + (multiple? ? "_in" : "_eq")
         end
 
         def searchable_method_name
@@ -15,14 +16,14 @@ module ActiveAdmin
             "#{reflection.through_reflection.name}_#{reflection.foreign_key}"
           else
             name = method.to_s
-            name.concat '_id' if reflection
+            name.concat "_#{reflection.association_primary_key}" if reflection_searchable?
             name
           end
         end
 
         # Provide the AA translation to the blank input field.
         def include_blank
-          I18n.t 'active_admin.any' if super
+          I18n.t "active_admin.any" if super
         end
 
         def input_html_options_name
@@ -48,6 +49,10 @@ module ActiveAdmin
           klass.reorder("#{method} asc").distinct.pluck method
         end
 
+        def reflection_searchable?
+          reflection && !reflection.polymorphic?
+        end
+
       end
     end
   end

data/lib/active_admin/inputs/filters/string_input.rb

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

data/lib/active_admin/inputs/filters/text_input.rb

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

data/lib/active_admin/inputs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Inputs
     extend ActiveSupport::Autoload

data/lib/active_admin/localizers/resource_localizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Localizers
     class ResourceLocalizer
@@ -19,16 +20,16 @@ module ActiveAdmin
 
       def translate(key, options = {})
         scope = options.delete(:scope)
-        specific_key = array_to_key('resources', @model_name, scope, key)
+        specific_key = array_to_key("resources", @model_name, scope, key)
         defaults = [array_to_key(scope, key), key.to_s.titleize]
-        ::I18n.t specific_key, options.reverse_merge(model: @model, default: defaults, scope: 'active_admin')
+        ::I18n.t specific_key, **options.reverse_merge(model: @model, default: defaults, scope: "active_admin")
       end
       alias_method :t, :translate
 
       protected
 
       def array_to_key(*arr)
-        arr.flatten.compact.join('.').to_sym
+        arr.flatten.compact.join(".").to_sym
       end
     end
   end

data/lib/active_admin/localizers.rb

@@ -1,4 +1,5 @@
-require 'active_admin/localizers/resource_localizer'
+# frozen_string_literal: true
+require "active_admin/localizers/resource_localizer"
 
 module ActiveAdmin
   module Localizers

data/lib/active_admin/menu.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   # Each Namespace builds up it's own menu as the global navigation
@@ -47,7 +48,10 @@ module ActiveAdmin
       #   menu.add parent: 'Dashboard', label: 'My Child Dashboard'
       #
       def add(options)
-        item = if parent = options.delete(:parent)
+        parent_chain = Array.wrap(options.delete(:parent))
+
+        item = if parent = parent_chain.shift
+                 options[:parent] = parent_chain if parent_chain.any?
                  (self[parent] || add(label: parent)).add options
                else
                  _add options.merge parent: self
@@ -60,7 +64,7 @@ module ActiveAdmin
 
       # Whether any children match the given item.
       def include?(item)
-        @children.values.include? item
+        @children.values.include?(item) || @children.values.any? { |child| child.include?(item) }
       end
 
       # Used in the UI to visually distinguish which menu item is selected.
@@ -68,14 +72,8 @@ module ActiveAdmin
         self == item || include?(item)
       end
 
-      # Returns sorted array of menu items that should be displayed in this context.
-      # Sorts by priority first, then alphabetically by label if needed.
-      def items(context = nil)
-        @children.values.select{ |i| i.display?(context) }.sort do |a, b|
-          result = a.priority       <=> b.priority
-          result = a.label(context) <=> b.label(context) if result == 0
-          result
-        end
+      def items
+        @children.values
       end
 
       attr_reader :children
@@ -93,7 +91,7 @@ module ActiveAdmin
       def normalize_id(id)
         case id
         when String, Symbol, ActiveModel::Name
-          id.to_s.downcase.tr ' ', '_'
+          id.to_s.downcase.tr " ", "_"
         when ActiveAdmin::Resource::Name
           id.param_key
         else

data/lib/active_admin/menu_collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   DEFAULT_MENU = :default

data/lib/active_admin/menu_item.rb

@@ -1,9 +1,7 @@
-require 'active_admin/view_helpers/method_or_proc_helper'
-
+# frozen_string_literal: true
 module ActiveAdmin
   class MenuItem
     include Menu::MenuNode
-    include MethodOrProcHelper
 
     attr_reader :html_options, :parent, :priority
 
@@ -48,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
@@ -63,35 +61,10 @@ module ActiveAdmin
       @id ||= normalize_id @dirty_id
     end
 
-    def label(context = nil)
-      render_in_context context, @label
-    end
-
-    def url(context = nil)
-      render_in_context context, @url
-    end
+    attr_reader :label
+    attr_reader :url
 
     # Don't display if the :if option passed says so
-    # Don't display if the link isn't real, we have children, and none of the children are being displayed.
-    def display?(context = nil)
-      return false unless render_in_context(context, @should_display)
-      return false if     !real_url?(context) && @children.any? && !items(context).any?
-      true
-    end
-
-    # Returns an array of the ancestry of this menu item.
-    # The first item is the immediate parent of the item.
-    def ancestors
-      parent ? [parent, parent.ancestors].flatten : []
-    end
-
-    private
-
-    # URL is not nil, empty, or '#'
-    def real_url?(context = nil)
-      url = url context
-      url.present? && url != '#'
-    end
-
+    attr_reader :should_display
   end
 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
 
@@ -25,7 +26,13 @@ module ActiveAdmin
   # resource will be accessible from "/posts" and the controller will be PostsController.
   #
   class Namespace
-    RegisterEvent = 'active_admin.namespace.register'.freeze
+    class << self
+      def setting(name, default)
+        Deprecation.warn "This method does not do anything and will be removed."
+      end
+    end
+
+    RegisterEvent = "active_admin.namespace.register".freeze
 
     attr_reader :application, :resources, :menus
 
@@ -41,7 +48,19 @@ module ActiveAdmin
       @name.to_sym
     end
 
-    # Register a resource into this namespace. The preffered method to access this is to
+    def settings
+      @settings ||= SettingsNode.build(application.namespace_settings)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      settings.respond_to?(method) || super
+    end
+
+    def method_missing(method, *args)
+      settings.respond_to?(method) ? settings.send(method, *args) : super
+    end
+
+    # 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)
@@ -53,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
@@ -100,12 +119,6 @@ module ActiveAdmin
       resources[klass]
     end
 
-    # Override from ActiveAdmin::Settings to inherit default attributes
-    # from the application
-    def read_default_setting(name)
-      application.public_send name
-    end
-
     def fetch_menu(name)
       @menus.fetch(name)
     end
@@ -137,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
 
@@ -152,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
 
@@ -199,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

@@ -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