activeadmin 1.0.0 → 2.11.0

data/lib/active_admin/devise.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 ActiveAdmin::Dependency.devise! ActiveAdmin::Dependency::Requirements::DEVISE
 
-require 'devise'
+require "devise"
 
 module ActiveAdmin
   module Devise
@@ -9,7 +10,7 @@ module ActiveAdmin
       {
         path: ActiveAdmin.application.default_namespace || "/",
         controllers: ActiveAdmin::Devise.controllers,
-        path_names: { sign_in: 'login', sign_out: "logout" },
+        path_names: { sign_in: "login", sign_out: "logout" },
         sign_out_via: [*::Devise.sign_out_via, ActiveAdmin.application.logout_link_method].uniq
       }
     end
@@ -27,14 +28,14 @@ module ActiveAdmin
     module Controller
       extend ::ActiveSupport::Concern
       included do
-        layout 'active_admin_logged_out'
+        layout "active_admin_logged_out"
         helper ::ActiveAdmin::ViewHelpers
       end
 
       # Redirect to the default namespace on logout
       def root_path
         namespace = ActiveAdmin.application.default_namespace.presence
-        root_path_method = [namespace, :root_path].compact.join('_')
+        root_path_method = [namespace, :root_path].compact.join("_")
 
         path = if Helpers::Routes.respond_to? root_path_method
                  Helpers::Routes.send root_path_method
@@ -45,29 +46,39 @@ module ActiveAdmin
 
         # NOTE: `relative_url_root` is deprecated by Rails.
         #       Remove prefix here if it is removed completely.
-        prefix = Rails.configuration.action_controller[:relative_url_root] || ''
+        prefix = Rails.configuration.action_controller[:relative_url_root] || ""
         prefix + path
       end
     end
 
     class SessionsController < ::Devise::SessionsController
       include ::ActiveAdmin::Devise::Controller
+
+      ActiveSupport.run_load_hooks(:active_admin_controller, self)
     end
 
     class PasswordsController < ::Devise::PasswordsController
       include ::ActiveAdmin::Devise::Controller
+
+      ActiveSupport.run_load_hooks(:active_admin_controller, self)
     end
 
     class UnlocksController < ::Devise::UnlocksController
       include ::ActiveAdmin::Devise::Controller
+
+      ActiveSupport.run_load_hooks(:active_admin_controller, self)
     end
 
     class RegistrationsController < ::Devise::RegistrationsController
-       include ::ActiveAdmin::Devise::Controller
+      include ::ActiveAdmin::Devise::Controller
+
+      ActiveSupport.run_load_hooks(:active_admin_controller, self)
     end
 
     class ConfirmationsController < ::Devise::ConfirmationsController
-       include ::ActiveAdmin::Devise::Controller
+      include ::ActiveAdmin::Devise::Controller
+
+      ActiveSupport.run_load_hooks(:active_admin_controller, self)
     end
 
     def self.controllers_for_filters

data/lib/active_admin/dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   # The Active Admin DSL. This class is where all the registration blocks
@@ -83,14 +84,7 @@ module ActiveAdmin
     #                         this action item on.
     #                 :except: A single or array of controller actions not to
     #                          display this action item on.
-    def action_item(name = nil, options = {}, &block)
-      if name.is_a?(Hash)
-        options = name
-        name = nil
-      end
-
-      Deprecation.warn "using `action_item` without a name is deprecated! Use `action_item(:edit)`." unless name
-
+    def action_item(name, options = {}, &block)
       config.add_action_item(name, options, &block)
     end
 
@@ -108,7 +102,7 @@ module ActiveAdmin
     def batch_action(title, options = {}, &block)
       # Create symbol & title information
       if title.is_a? String
-        sym = title.titleize.tr(' ', '').underscore.to_sym
+        sym = title.titleize.tr(" ", "").underscore.to_sym
       else
         sym = title
         title = sym.to_s.titleize
@@ -116,7 +110,7 @@ module ActiveAdmin
 
       # Either add/remove the batch action
       unless options == false
-        config.add_batch_action( sym, title, options, &block )
+        config.add_batch_action(sym, title, options, &block)
       else
         config.remove_batch_action sym
       end
@@ -137,7 +131,7 @@ module ActiveAdmin
     # Pass a block returning the name of a menu you want rendered for the request, being
     # executed in the context of the controller
     #
-    def navigation_menu(menu_name=nil, &block)
+    def navigation_menu(menu_name = nil, &block)
       config.navigation_menu_name = menu_name || block
     end
 

data/lib/active_admin/dynamic_setting.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module ActiveAdmin
+
+  class DynamicSetting
+    def self.build(setting, type)
+      (type ? klass(type) : self).new(setting)
+    end
+
+    def self.klass(type)
+      klass = "#{type.to_s.camelcase}Setting"
+      raise ArgumentError, "Unknown type: #{type}" unless ActiveAdmin.const_defined?(klass)
+      ActiveAdmin.const_get(klass)
+    end
+
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def value(*_args)
+      @setting
+    end
+  end
+
+  # Many configuration options (Ex: site_title, title_image) could either be
+  # static (String), methods (Symbol) or procs (Proc). This wrapper takes care of
+  # returning the content when String or using instance_eval when Symbol or Proc.
+  #
+  class StringSymbolOrProcSetting < DynamicSetting
+    def value(context = self)
+      case @setting
+      when Symbol, Proc
+        context.instance_eval(&@setting)
+      else
+        @setting
+      end
+    end
+  end
+
+end

data/lib/active_admin/dynamic_settings_node.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require "active_admin/dynamic_setting"
+require "active_admin/settings_node"
+
+module ActiveAdmin
+
+  class DynamicSettingsNode < SettingsNode
+    class << self
+      def register(name, value, type = nil)
+        class_attribute "#{name}_setting"
+        add_reader(name)
+        add_writer(name, type)
+        send "#{name}=", value
+      end
+
+      def add_reader(name)
+        define_singleton_method(name) do |*args|
+          send("#{name}_setting").value(*args)
+        end
+      end
+
+      def add_writer(name, type)
+        define_singleton_method("#{name}=") do |value|
+          send("#{name}_setting=", DynamicSetting.build(value, type))
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/engine.rb

@@ -1,16 +1,25 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Engine < ::Rails::Engine
+    # Set default values for app_path and load_paths before running initializers
+    initializer "active_admin.load_app_path", before: :load_config_initializers do |app|
+      ActiveAdmin::Application.setting :app_path, app.root
+      ActiveAdmin::Application.setting :load_paths, [File.expand_path("app/admin", app.root)]
+    end
+
     initializer "active_admin.precompile", group: :all do |app|
-      ActiveAdmin.application.stylesheets.each do |path, _|
-        app.config.assets.precompile << path
-      end
-      ActiveAdmin.application.javascripts.each do |path|
-        app.config.assets.precompile << path
+      unless ActiveAdmin.application.use_webpacker
+        ActiveAdmin.application.stylesheets.each do |path, _|
+          app.config.assets.precompile << path
+        end
+        ActiveAdmin.application.javascripts.each do |path|
+          app.config.assets.precompile << path
+        end
       end
     end
 
-    initializer 'active_admin.routes' do
-      require 'active_admin/helpers/routes/url_helpers'
+    initializer "active_admin.routes" do
+      require "active_admin/helpers/routes/url_helpers"
     end
   end
 end

data/lib/active_admin/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   # Exception class to raise when there is an authorized access
   # exception thrown. The exception has a few goodies that may
@@ -6,7 +7,9 @@ module ActiveAdmin
     attr_reader :user, :action, :subject
 
     def initialize(user, action, subject = nil)
-      @user, @action, @subject = user, action, subject
+      @user = user
+      @action = action
+      @subject = subject
 
       super()
     end
@@ -22,7 +25,7 @@ module ActiveAdmin
   class ErrorLoading < Error
     # Locates the most recent file and line from the caught exception's backtrace.
     def find_cause(folder, backtrace)
-      backtrace.grep(/\/(#{folder}\/.*\.rb):(\d+)/){ [$1, $2] }.first
+      backtrace.grep(/\/(#{folder}\/.*\.rb):(\d+)/) { [$1, $2] }.first
     end
   end
 
@@ -43,8 +46,6 @@ module ActiveAdmin
       raise new exception
     end
 
-    private
-
     def self.database_error_classes
       @classes ||= []
     end

data/lib/active_admin/filters/active.rb

@@ -1,29 +1,29 @@
-require 'active_admin/filters/humanized'
+# frozen_string_literal: true
+require "active_admin/filters/active_filter"
 
 module ActiveAdmin
   module Filters
 
     class Active
-      attr_accessor :filters, :scope
+      attr_accessor :filters, :resource
 
-      def initialize(resource_class, params)
-        @resource_class = resource_class
-        @params = params.to_unsafe_h
-        @scope = humanize_scope
-        @filters = build_filters
+      # Instantiate a `Active` object containing collection of current active filters
+
+      # @param resource [ActiveAdmin::Resource] current resource
+      # @param search [Ransack::Search] search object
+      #
+      # @see ActiveAdmin::ResourceController::DataAcces#apply_filtering
+      def initialize(resource, search)
+        @resource = resource
+        @filters = build_filters(search.conditions)
       end
 
       private
 
-      def build_filters
-        filters = @params['q'] || []
-        filters.map{ |param| Humanized.new(param) }
+      def build_filters(conditions)
+        conditions.map { |condition| ActiveFilter.new(resource, condition.dup) }
       end
 
-      def humanize_scope
-        scope = @params['scope']
-        scope ? scope.humanize : "All"
-      end
     end
 
   end

data/lib/active_admin/filters/active_filter.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  module Filters
+
+    class ActiveFilter
+      include ActiveAdmin::ViewHelpers
+
+      attr_reader :resource, :condition, :related_class
+
+      # Instantiate a `ActiveFilter`
+      #
+      # @param resource [ActiveAdmin::Resource] current resource
+      # @param condition [Ransack::Nodes::Condition] applied ransack condition
+      def initialize(resource, condition)
+        @resource = resource
+        @condition = condition
+        @related_class = find_class if find_class?
+      end
+
+      def values
+        condition_values = condition.values.map(&:value)
+        if related_class
+          related_class.where(related_primary_key => condition_values)
+        else
+          condition_values
+        end
+      end
+
+      def label
+        translated_predicate = predicate_name.downcase
+        if filter_label && filter_label.is_a?(Proc)
+          "#{filter_label.call} #{translated_predicate}"
+        elsif filter_label
+          "#{filter_label} #{translated_predicate}"
+        elsif related_class
+          "#{related_class_name} #{translated_predicate}"
+        else
+          "#{attribute_name} #{translated_predicate}"
+        end.strip
+      end
+
+      def predicate_name
+        I18n.t(
+          "active_admin.filters.predicates.#{condition.predicate.name}",
+          default: ransack_predicate_name)
+      end
+
+      def html_options
+        { class: "current_filter current_filter_#{condition.key}" }
+      end
+
+      private
+
+      def resource_class
+        resource.resource_class
+      end
+
+      def attribute_name
+        resource_class.human_attribute_name(name)
+      end
+
+      def related_class_name
+        return unless related_class
+
+        related_class.model_name.human
+      end
+
+      def filter_label
+        return unless filter
+
+        filter[:label] || I18n.t(name, scope: ["formtastic", "labels"], default: nil)
+      end
+
+      #@return Ransack::Nodes::Attribute
+      def condition_attribute
+        condition.attributes[0]
+      end
+
+      def name
+        condition_attribute.attr_name
+      end
+
+      def ransack_predicate_name
+        Ransack::Translate.predicate(condition.predicate.name)
+      end
+
+      def find_class?
+        ["eq", "in"].include? condition.predicate.arel_predicate
+      end
+
+      # detect related class for Ransack::Nodes::Attribute
+      def find_class
+        if condition_attribute.klass != resource_class && condition_attribute.klass.primary_key == name.to_s
+          condition_attribute.klass
+        elsif predicate_association
+          predicate_association.klass
+        end
+      end
+
+      def filter
+        resource.filters[name.to_sym] || resource.filters[condition.key.to_sym]
+      end
+
+      def related_primary_key
+        if predicate_association
+          predicate_association.association_primary_key
+        elsif related_class
+          related_class.primary_key
+        end
+      end
+
+      def predicate_association
+        @predicate_association = find_predicate_association unless defined?(@predicate_association)
+        @predicate_association
+      end
+
+      def find_predicate_association
+        condition_attribute.klass.reflect_on_all_associations.
+          reject { |r| r.options[:polymorphic] }. #skip polymorphic
+          detect { |r| r.foreign_key.to_s == name.to_s }
+      end
+    end
+  end
+end

data/lib/active_admin/filters/active_sidebar.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "active_admin/filters/active"
+
+module ActiveAdmin
+  module Filters
+    class ActiveSidebar < ActiveAdmin::SidebarSection
+
+      def initialize
+        super "search_status", sidebar_options
+      end
+
+      def block
+        -> { active_filters_sidebar_content }
+      end
+
+      def title
+        I18n.t("active_admin.search_status.headline")
+      end
+
+      protected
+
+      def sidebar_options
+        { only: :index, if: -> { active_admin_config.current_filters_enabled? && (params[:q] || params[:scope]) } }
+      end
+
+    end
+  end
+end

data/lib/active_admin/filters/dsl.rb

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

data/lib/active_admin/filters/forms.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Filters
     # This form builder defines methods to build filter forms such
@@ -41,7 +42,6 @@ module ActiveAdmin
       end
     end
 
-
     # This module is included into the view
     module ViewHelper
 
@@ -49,22 +49,25 @@ module ActiveAdmin
       def active_admin_filters_form_for(search, filters, options = {})
         defaults = { builder: ActiveAdmin::Filters::FormBuilder,
                      url: collection_path,
-                     html: {class: 'filter_form'} }
-        required = { html: {method: :get},
+                     html: { class: "filter_form" } }
+        required = { html: { method: :get },
                      as: :q }
-        options  = defaults.deep_merge(options).deep_merge(required)
+        options = defaults.deep_merge(options).deep_merge(required)
 
         form_for search, options do |f|
           filters.each do |attribute, opts|
-            next if opts.key?(:if)     && !call_method_or_proc_on(self, opts[:if])
-            next if opts.key?(:unless) &&  call_method_or_proc_on(self, opts[:unless])
+            next if opts.key?(:if) && !call_method_or_proc_on(self, opts[:if])
+            next if opts.key?(:unless) && call_method_or_proc_on(self, opts[:unless])
+
+            filter_opts = opts.except(:if, :unless)
+            filter_opts[:input_html] = instance_exec(&filter_opts[:input_html]) if filter_opts[:input_html].is_a?(Proc)
 
-            f.filter attribute, opts.except(:if, :unless)
+            f.filter attribute, filter_opts
           end
 
           buttons = content_tag :div, class: "buttons" do
-            f.submit(I18n.t('active_admin.filters.buttons.filter')) +
-              link_to(I18n.t('active_admin.filters.buttons.clear'), '#', class: 'clear_filters_btn') +
+            f.submit(I18n.t("active_admin.filters.buttons.filter")) +
+              link_to(I18n.t("active_admin.filters.buttons.clear"), "#", class: "clear_filters_btn") +
               hidden_field_tags_for(params, except: except_hidden_fields)
           end
 

data/lib/active_admin/filters/formtastic_addons.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Filters
     module FormtasticAddons
@@ -37,7 +38,7 @@ module ActiveAdmin
       end
 
       def polymorphic_foreign_type?(method)
-        klass.reflect_on_all_associations.select{ |r| r.macro == :belongs_to && r.options[:polymorphic] }
+        klass.reflect_on_all_associations.select { |r| r.macro == :belongs_to && r.options[:polymorphic] }
           .map(&:foreign_type).include? method.to_s
       end
 
@@ -54,7 +55,7 @@ module ActiveAdmin
       end
 
       def seems_searchable?
-        has_predicate? || scope?
+        column_for(method).nil? && (has_predicate? || scope?)
       end
 
       # If the given method has a predicate (like _eq or _lteq), it's pretty
@@ -63,11 +64,6 @@ module ActiveAdmin
         !!Ransack::Predicate.detect_from_string(method.to_s)
       end
 
-      # Ransack lets you define custom search methods, called ransackers.
-      def ransacker?
-        klass._ransackers.key? method.to_s
-      end
-
       # Ransack supports exposing selected scopes on your model for advanced searches.
       def scope?
         context = Ransack::Context.for klass

data/lib/active_admin/filters/resource_extension.rb

@@ -1,5 +1,4 @@
-require 'active_admin/filters/active'
-
+# frozen_string_literal: true
 module ActiveAdmin
   module Filters
 
@@ -85,7 +84,7 @@ module ActiveAdmin
         @filters_to_remove = nil
       end
 
-    private
+      private
 
       # Collapses the waveform, if you will, of which filters should be displayed.
       # Removes filters and adds in default filters as desired.
@@ -125,58 +124,56 @@ module ActiveAdmin
       # Returns a default set of filters for the associations
       def default_association_filters
         if resource_class.respond_to?(:reflect_on_all_associations)
-          poly, not_poly = resource_class.reflect_on_all_associations.partition{ |r| r.macro == :belongs_to && r.options[:polymorphic] }
+          poly, not_poly = resource_class.reflect_on_all_associations.partition { |r| r.macro == :belongs_to && r.options[:polymorphic] }
 
           # remove deeply nested associations
-          not_poly.reject!{ |r| r.chain.length > 2 }
+          not_poly.reject! { |r| r.chain.length > 2 }
 
           filters = poly.map(&:foreign_type) + not_poly.map(&:name)
+
+          # Check high-arity associations for filterable columns
+          max = namespace.maximum_association_filter_arity
+          if max != :unlimited
+            high_arity, low_arity = not_poly.partition do |r|
+              r.klass.reorder(nil).limit(max + 1).count > max
+            end
+
+            # Remove high-arity associations with no searchable column
+            high_arity = high_arity.select(&method(:searchable_column_for))
+
+            high_arity = high_arity.map { |r| r.name.to_s + "_" + searchable_column_for(r) + namespace.filter_method_for_large_association }
+
+            filters = poly.map(&:foreign_type) + low_arity.map(&:name) + high_arity
+          end
+
           filters.map &:to_sym
         else
           []
         end
       end
 
+      def search_columns
+        @search_columns ||= namespace.filter_columns_for_large_association.map(&:to_s)
+      end
+
+      def searchable_column_for(relation)
+        relation.klass.column_names.find { |name| search_columns.include?(name) }
+      end
+
       def add_filters_sidebar_section
         self.sidebar_sections << filters_sidebar_section
       end
 
       def filters_sidebar_section
-        ActiveAdmin::SidebarSection.new :filters, only: :index, if: ->{ active_admin_config.filters.any? } do
-          active_admin_filters_form_for assigns[:search], active_admin_config.filters
+        ActiveAdmin::SidebarSection.new :filters, only: :index, if: -> { active_admin_config.filters.any? } do
+          active_admin_filters_form_for assigns[:search], **active_admin_config.filters
         end
       end
 
       def add_search_status_sidebar_section
-        self.sidebar_sections << search_status_section
-      end
-
-      def search_status_section
-        ActiveAdmin::SidebarSection.new I18n.t("active_admin.search_status.headline"), only: :index, if: -> {active_admin_config.current_filters_enabled? && (params[:q] || params[:scope]) } do
-          active = ActiveAdmin::Filters::Active.new(resource_class, params)
-
-          span do
-            h4 I18n.t("active_admin.search_status.current_scope"), style: 'display: inline'
-            b active.scope, style: "display: inline"
-
-            div style: "margin-top: 10px" do
-              h4 I18n.t("active_admin.search_status.current_filters"), style: 'margin-bottom: 10px'
-              ul do
-                if active.filters.blank?
-                  li I18n.t("active_admin.search_status.no_current_filters")
-                else
-                  active.filters.each do |filter|
-                    li do
-                      span filter.body
-                      b filter.value
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
+        self.sidebar_sections << ActiveAdmin::Filters::ActiveSidebar.new
       end
+
     end
 
   end

data/lib/active_admin/filters.rb

@@ -1,9 +1,12 @@
-require 'active_admin/filters/dsl'
-require 'active_admin/filters/resource_extension'
-require 'active_admin/filters/formtastic_addons'
-require 'active_admin/filters/forms'
+# frozen_string_literal: true
+require "active_admin/filters/dsl"
+require "active_admin/filters/resource_extension"
+require "active_admin/filters/formtastic_addons"
+require "active_admin/filters/forms"
+require "active_admin/helpers/optional_display"
+require "active_admin/filters/active_sidebar"
 
 # Add our Extensions
 ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Filters::DSL
-ActiveAdmin::Resource.send    :include, ActiveAdmin::Filters::ResourceExtension
+ActiveAdmin::Resource.send :include, ActiveAdmin::Filters::ResourceExtension
 ActiveAdmin::ViewHelpers.send :include, ActiveAdmin::Filters::ViewHelper