activeadmin 1.0.0 → 2.11.0

data/lib/active_admin/router.rb

@@ -1,108 +1,115 @@
+# frozen_string_literal: true
 module ActiveAdmin
+  # @private
   class Router
-    def initialize(application)
-      @application = application
+    attr_reader :namespaces, :router
+
+    def initialize(router:, namespaces:)
+      @router = router
+      @namespaces = namespaces
     end
 
-    # Creates all the necessary routes for the ActiveAdmin configurations
-    #
-    # Use this within the routes.rb file:
-    #
-    #   Application.routes.draw do |map|
-    #     ActiveAdmin.routes(self)
-    #   end
-    #
-    def apply(router)
-      define_root_routes router
-      define_resource_routes router
+    def apply
+      define_root_routes
+      define_resources_routes
     end
 
-    def define_root_routes(router)
-      router.instance_exec @application.namespaces do |namespaces|
-        namespaces.each do |namespace|
-          if namespace.root?
-            root namespace.root_to_options.merge(to: namespace.root_to)
-          else
-            namespace namespace.name, namespace.route_options.dup do
-              root namespace.root_to_options.merge(to: namespace.root_to, as: :root)
-            end
+    private
+
+    def define_root_routes
+      namespaces.each do |namespace|
+        if namespace.root?
+          router.root namespace.root_to_options.merge(to: namespace.root_to)
+        else
+          router.namespace namespace.name, namespace.route_options.dup do
+            router.root namespace.root_to_options.merge(to: namespace.root_to, as: :root)
           end
         end
       end
     end
 
     # Defines the routes for each resource
-    def define_resource_routes(router)
-      router.instance_exec @application.namespaces, self do |namespaces, aa_router|
-        resources = namespaces.flat_map{ |n| n.resources.values }
-        resources.each do |config|
-          routes = aa_router.resource_routes(config)
-
-          # Add in the parent if it exists
-          if config.belongs_to?
-            belongs_to = routes
-            routes     = Proc.new do
-              # If it's optional, make the normal resource routes
-              instance_exec &belongs_to if config.belongs_to_config.optional?
-
-              # Make the nested belongs_to routes
-              # :only is set to nothing so that we don't clobber any existing routes on the resource
-              resources config.belongs_to_config.target.resource_name.plural, only: [] do
-                instance_exec &belongs_to
-              end
-            end
-          end
+    def define_resources_routes
+      resources = namespaces.flat_map { |n| n.resources.values }
+      resources.each do |config|
+        define_resource_routes(config)
+      end
+    end
 
-          # Add on the namespace if required
-          unless config.namespace.root?
-            nested = routes
-            routes = Proc.new do
-              namespace config.namespace.name, config.namespace.route_options.dup do
-                instance_exec &nested
-              end
-            end
-          end
+    def define_resource_routes(config)
+      if config.namespace.root?
+        define_routes(config)
+      else
+        # Add on the namespace if required
+        define_namespace(config)
+      end
+    end
 
-          instance_exec &routes
-        end
+    def define_routes(config)
+      if config.belongs_to?
+        define_belongs_to_routes(config)
+      else
+        page_or_resource_routes(config)
       end
     end
 
+    def page_or_resource_routes(config)
+      config.is_a?(Page) ? page_routes(config) : resource_routes(config)
+    end
+
     def resource_routes(config)
-      Proc.new do
-        # Builds one route for each HTTP verb passed in
-        build_route  = proc{ |verbs, *args|
-          [*verbs].each{ |verb| send verb, *args }
-        }
-        # Deals with +ControllerAction+ instances
-        build_action = proc{ |action|
-          build_route.call(action.http_verb, action.name)
-        }
-        case config
-        when ::ActiveAdmin::Resource
-          resources config.resource_name.route_key, only: config.defined_actions do
-            member do
-              config.member_actions.each &build_action
-            end
-
-            collection do
-              config.collection_actions.each &build_action
-              post :batch_action if config.batch_actions_enabled?
-            end
-          end
-        when ::ActiveAdmin::Page
-          page = config.underscored_resource_name
-          get "/#{page}" => "#{page}#index"
-          config.page_actions.each do |action|
-            Array.wrap(action.http_verb).each do |verb|
-              build_route.call verb, "/#{page}/#{action.name}" => "#{page}##{action.name}"
-            end
-          end
-        else
-          raise "Unsupported config class: #{config.class}"
+      router.resources config.resource_name.route_key, only: config.defined_actions do
+        define_actions(config)
+      end
+    end
+
+    def page_routes(config)
+      page = config.underscored_resource_name
+      router.get "/#{page}" => "#{page}#index"
+      config.page_actions.each do |action|
+        Array.wrap(action.http_verb).each do |verb|
+          build_route(verb, "/#{page}/#{action.name}" => "#{page}##{action.name}")
         end
       end
+    end
+
+    # Defines member and collection actions
+    def define_actions(config)
+      router.member do
+        config.member_actions.each { |action| build_action(action) }
+      end
+
+      router.collection do
+        config.collection_actions.each { |action| build_action(action) }
+        router.post :batch_action if config.batch_actions_enabled?
+      end
+    end
+
+    # Deals with +ControllerAction+ instances
+    # Builds one route for each HTTP verb passed in
+    def build_action(action)
+      build_route(action.http_verb, action.name)
+    end
+
+    def build_route(verbs, *args)
+      Array.wrap(verbs).each { |verb| router.send(verb, *args) }
+    end
+
+    def define_belongs_to_routes(config)
+      # If it's optional, make the normal resource routes
+      page_or_resource_routes(config) if config.belongs_to_config.optional?
+
+      # Make the nested belongs_to routes
+      # :only is set to nothing so that we don't clobber any existing routes on the resource
+      router.resources config.belongs_to_config.target.resource_name.plural, only: [] do
+        page_or_resource_routes(config)
+      end
+    end
 
+    def define_namespace(config)
+      router.namespace config.namespace.name, config.namespace.route_options.dup do
+        define_routes(config)
+      end
     end
   end
 end

data/lib/active_admin/scope.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module ActiveAdmin
   class Scope
 
-    attr_reader :scope_method, :id, :scope_block, :display_if_block, :show_count, :default_block
+    attr_reader :scope_method, :id, :scope_block, :display_if_block, :show_count, :default_block, :group
 
     # Create a Scope
     #
@@ -24,31 +25,39 @@ module ActiveAdmin
     #   Scope.new ->{Date.today.strftime '%A'}, :published_today
     #   # => Scope with dynamic title using the :published_today scope method
     #
+    #   Scope.new :published, nil, group: :status
+    #   # => Scope with the group :status
+    #
     def initialize(name, method = nil, options = {}, &block)
-      @name, @scope_method = name, method.try(:to_sym)
+      @name = name
+      @scope_method = method.try(:to_sym)
 
       if name.is_a? Proc
         raise "A string/symbol is required as the second argument if your label is a proc." unless method
-        @id = ActiveAdmin::Dependency.rails.parameterize method.to_s
+        @id = method.to_s.parameterize(separator: "_")
       else
         @scope_method ||= name.to_sym
-        @id = ActiveAdmin::Dependency.rails.parameterize name.to_s
+        @id = name.to_s.parameterize(separator: "_")
       end
 
-      @scope_method               = nil        if @scope_method == :all
-      @scope_method, @scope_block = nil, block if block_given?
+      @scope_method = nil if @scope_method == :all
+      if block_given?
+        @scope_method = nil
+        @scope_block = block
+      end
 
-      @localizer        = options[:localizer]
-      @show_count       = options.fetch(:show_count, true)
-      @display_if_block = options[:if]      || proc{ true }
-      @default_block    = options[:default] || proc{ false }
+      @localizer = options[:localizer]
+      @show_count = options.fetch(:show_count, true)
+      @display_if_block = options[:if] || proc { true }
+      @default_block = options[:default] || proc { false }
+      @group = options[:group].try(:to_sym)
     end
 
     def name
       case @name
-        when String then @name
-        when Symbol then @localizer ? @localizer.t(@name, scope: 'scopes') : @name.to_s.titleize
-        else             @name
+      when String then @name
+      when Symbol then @localizer ? @localizer.t(@name, scope: "scopes") : @name.to_s.titleize
+      else @name
       end
     end
 

data/lib/active_admin/settings_node.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module ActiveAdmin
+
+  class SettingsNode
+    class << self
+      # Never instantiated.  Variables are stored in the singleton_class.
+      private_class_method :new
+
+      # @return anonymous class with same accessors as the superclass.
+      def build(superclass = self)
+        Class.new(superclass)
+      end
+
+      def register(name, value)
+        class_attribute name
+        send "#{name}=", value
+      end
+    end
+  end
+end

data/lib/active_admin/sidebar_section.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
 
   class SidebarSection
@@ -6,7 +7,9 @@ module ActiveAdmin
     attr_accessor :name, :options, :block
 
     def initialize(name, options = {}, &block)
-      @name, @options, @block = name.to_s, options, block
+      @name = name.to_s
+      @options = options
+      @block = block
       normalize_display_options!
     end
 

data/lib/active_admin/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
-  VERSION = '1.0.0'
+  VERSION = "2.11.0"
 end

data/lib/active_admin/view_factory.rb

@@ -1,27 +1,28 @@
-require 'active_admin/abstract_view_factory'
+# frozen_string_literal: true
+require "active_admin/abstract_view_factory"
 
 module ActiveAdmin
   class ViewFactory < AbstractViewFactory
 
     # Register Helper Renderers
-    register  global_navigation:   ActiveAdmin::Views::TabbedNavigation,
-              utility_navigation:  ActiveAdmin::Views::TabbedNavigation,
-              site_title:          ActiveAdmin::Views::SiteTitle,
-              unsupported_browser: ActiveAdmin::Views::UnsupportedBrowser,
-              action_items:        ActiveAdmin::Views::ActionItems,
-              title_bar:           ActiveAdmin::Views::TitleBar,
-              header:              ActiveAdmin::Views::Header,
-              footer:              ActiveAdmin::Views::Footer,
-              index_scopes:        ActiveAdmin::Views::Scopes,
-              blank_slate:         ActiveAdmin::Views::BlankSlate
+    register global_navigation: ActiveAdmin::Views::TabbedNavigation,
+             utility_navigation: ActiveAdmin::Views::TabbedNavigation,
+             site_title: ActiveAdmin::Views::SiteTitle,
+             unsupported_browser: ActiveAdmin::Views::UnsupportedBrowser,
+             action_items: ActiveAdmin::Views::ActionItems,
+             title_bar: ActiveAdmin::Views::TitleBar,
+             header: ActiveAdmin::Views::Header,
+             footer: ActiveAdmin::Views::Footer,
+             index_scopes: ActiveAdmin::Views::Scopes,
+             blank_slate: ActiveAdmin::Views::BlankSlate
 
     # Register All The Pages
-    register  index_page: ActiveAdmin::Views::Pages::Index,
-              show_page:  ActiveAdmin::Views::Pages::Show,
-              new_page:   ActiveAdmin::Views::Pages::Form,
-              edit_page:  ActiveAdmin::Views::Pages::Form,
-              layout:     ActiveAdmin::Views::Pages::Layout,
-              page:       ActiveAdmin::Views::Pages::Page
+    register index_page: ActiveAdmin::Views::Pages::Index,
+             show_page: ActiveAdmin::Views::Pages::Show,
+             new_page: ActiveAdmin::Views::Pages::Form,
+             edit_page: ActiveAdmin::Views::Pages::Form,
+             layout: ActiveAdmin::Views::Pages::Layout,
+             page: ActiveAdmin::Views::Pages::Page
 
   end
 end

data/lib/active_admin/view_helpers/active_admin_application_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module ActiveAdminApplicationHelper

data/lib/active_admin/view_helpers/auto_link_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module AutoLinkHelper

data/lib/active_admin/view_helpers/breadcrumb_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module BreadcrumbHelper
@@ -6,22 +7,22 @@ module ActiveAdmin
       def breadcrumb_links(path = request.path)
         # remove leading "/" and split up the URL
         # and remove last since it's used as the page title
-        parts = path.split('/').select(&:present?)[0..-2]
+        parts = path.split("/").select(&:present?)[0..-2]
 
         parts.each_with_index.map do |part, index|
           # 1. try using `display_name` if we can locate a DB object
           # 2. try using the model name translation
           # 3. default to calling `titlecase` on the URL fragment
-          if part =~ /\A(\d+|[a-f0-9]{24}|(?:[a-f0-9]{8}-(?:[a-f0-9]{4}-){3}[a-f0-9]{12}))\z/ && parts[index-1]
+          if part =~ /\A(\d+|[a-f0-9]{24}|(?:[a-f0-9]{8}-(?:[a-f0-9]{4}-){3}[a-f0-9]{12}))\z/ && parts[index - 1]
             parent = active_admin_config.belongs_to_config.try :target
-            config = parent && parent.resource_name.route_key == parts[index-1] ? parent : active_admin_config
-            name   = display_name config.find_resource part
+            config = parent && parent.resource_name.route_key == parts[index - 1] ? parent : active_admin_config
+            name = display_name config.find_resource part
           end
           name ||= I18n.t "activerecord.models.#{part.singularize}", count: ::ActiveAdmin::Helpers::I18n::PLURAL_MANY_COUNT, default: part.titlecase
 
           # Don't create a link if the resource's show action is disabled
           if !config || config.defined_actions.include?(:show)
-            link_to name, '/' + parts[0..index].join('/')
+            link_to name, "/" + parts[0..index].join("/")
           else
             name
           end

data/lib/active_admin/view_helpers/display_helper.rb

@@ -1,21 +1,30 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module DisplayHelper
 
-      DISPLAY_NAME_FALLBACK = ->{
-        name, klass = "", self.class
-        name << klass.model_name.human         if klass.respond_to? :model_name
-        name << " ##{send(klass.primary_key)}" if klass.respond_to? :primary_key
+      DISPLAY_NAME_FALLBACK = -> {
+        klass = self.class
+        name = if klass.respond_to?(:model_name)
+                 if klass.respond_to?(:primary_key)
+                   "#{klass.model_name.human} ##{send(klass.primary_key)}"
+                 else
+                   klass.model_name.human
+                 end
+               elsif klass.respond_to?(:primary_key)
+                 " ##{send(klass.primary_key)}"
+               end
         name.present? ? name : to_s
       }
+
       def DISPLAY_NAME_FALLBACK.inspect
-        'DISPLAY_NAME_FALLBACK'
+        "DISPLAY_NAME_FALLBACK"
       end
 
       # Attempts to call any known display name methods on the resource.
       # See the setting in `application.rb` for the list of methods and their priority.
       def display_name(resource)
-        render_in_context resource, display_name_method_for(resource) unless resource.nil?
+        ERB::Util.html_escape(render_in_context(resource, display_name_method_for(resource))) unless resource.nil?
       end
 
       # Looks up and caches the first available display name method.
@@ -25,7 +34,7 @@ module ActiveAdmin
         @@display_name_methods_cache ||= {}
         @@display_name_methods_cache[resource.class] ||= begin
           methods = active_admin_application.display_name_methods - association_methods_for(resource)
-          method  = methods.detect{ |method| resource.respond_to? method }
+          method = methods.detect { |method| resource.respond_to? method }
 
           if method != :to_s || resource.method(method).source_location
             method
@@ -69,20 +78,28 @@ module ActiveAdmin
           object.to_s
         when Date, Time
           I18n.localize object, format: active_admin_application.localize_format
+        when Array
+          format_collection(object)
         else
           if defined?(::ActiveRecord) && object.is_a?(ActiveRecord::Base) ||
-             defined?(::Mongoid)      && object.class.include?(Mongoid::Document)
+             defined?(::Mongoid) && object.class.include?(Mongoid::Document)
             auto_link object
+          elsif defined?(::ActiveRecord) && object.is_a?(ActiveRecord::Relation)
+            format_collection(object)
           else
             display_name object
           end
         end
       end
 
+      def format_collection(collection)
+        safe_join(collection.map { |item| pretty_format(item) }, ", ")
+      end
+
       def boolean_attr?(resource, attr, value)
         case value
         when TrueClass, FalseClass
-           true
+          true
         else
           if resource.class.respond_to? :columns_hash
             column = resource.class.columns_hash[attr.to_s] and column.type == :boolean

data/lib/active_admin/view_helpers/download_format_links_helper.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module DownloadFormatLinksHelper
+      private
 
       def build_download_formats(download_links)
         download_links = instance_exec(&download_links) if download_links.is_a?(Proc)
@@ -17,7 +19,7 @@ module ActiveAdmin
       def build_download_format_links(formats = self.class.formats)
         params = request.query_parameters.except :format, :commit
         div class: "download_links" do
-          span I18n.t('active_admin.download')
+          span I18n.t("active_admin.download")
           formats.each do |format|
             a format.upcase, href: url_for(params: params, format: format)
           end

data/lib/active_admin/view_helpers/fields_for.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module FormHelper
@@ -15,7 +16,7 @@ module ActiveAdmin
       #
       def fields_for_params(params, options = {})
         namespace = options[:namespace]
-        except    = Array.wrap(options[:except]).map &:to_s
+        except = Array.wrap(options[:except]).map &:to_s
 
         params.flat_map do |k, v|
           next if namespace.nil? && %w(controller action commit utf8).include?(k.to_s)
@@ -37,7 +38,7 @@ module ActiveAdmin
               { "#{k}[]" => v }
             end
           when nil
-            { k => '' }
+            { k => "" }
           when TrueClass, FalseClass
             { k => v }
           else

data/lib/active_admin/view_helpers/flash_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module FlashHelper

data/lib/active_admin/view_helpers/form_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module FormHelper
@@ -8,7 +9,7 @@ module ActiveAdmin
         end.content
       end
 
-      def hidden_field_tags_for(params, options={})
+      def hidden_field_tags_for(params, options = {})
         fields_for_params(params.to_unsafe_hash, options).map do |kv|
           k, v = kv.first
           hidden_field_tag k, v, id: sanitize_to_id("hidden_active_admin_#{k}")

data/lib/active_admin/view_helpers/method_or_proc_helper.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+# Utility methods for internal use.
+# @private
 module MethodOrProcHelper
+  extend self
 
   # This method will either call the symbol on self or instance_exec the Proc
   # within self. Any args will be passed along to the method dispatch.

data/lib/active_admin/view_helpers/scope_name_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  module ViewHelpers
+    module ScopeNameHelper
+
+      def scope_name(scope)
+        case scope.name
+        when Proc then
+          self.instance_exec(&scope.name).to_s
+        else
+          scope.name.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/view_helpers/sidebar_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module SidebarHelper

data/lib/active_admin/view_helpers/title_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module TitleHelper

data/lib/active_admin/view_helpers/view_factory_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
     module ViewFactoryHelper

data/lib/active_admin/view_helpers.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module ViewHelpers
 
     # Require all ruby files in the view helpers dir
-    Dir[File.expand_path('../view_helpers', __FILE__) + "/*.rb"].each{|f| require f }
+    Dir[File.expand_path("view_helpers", __dir__) + "/*.rb"].each { |f| require f }
 
     include ActiveAdminApplicationHelper
     include AutoLinkHelper
@@ -14,6 +15,7 @@ module ActiveAdmin
     include TitleHelper
     include ViewFactoryHelper
     include FlashHelper
+    include ScopeNameHelper
 
   end
 end

data/lib/active_admin/views/action_items.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
@@ -5,7 +6,7 @@ module ActiveAdmin
 
       def build(action_items)
         action_items.each do |action_item|
-          span class: "action_item" do
+          span class: action_item.html_class do
             instance_exec(&action_item.block)
           end
         end