activeadmin 1.2.1 → 2.13.1

data/lib/active_admin/views/components/menu_item.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  module Views
+
+    # Arbre component used to render ActiveAdmin::MenuItem
+    class MenuItem < Component
+      builder_method :menu_item
+      attr_reader :label
+      attr_reader :url
+      attr_reader :priority
+
+      def build(item, options = {})
+        super(options.merge(id: item.id))
+        @label = helpers.render_in_context self, item.label
+        @url = helpers.render_in_context self, item.url
+        @priority = item.priority
+        @submenu = nil
+
+        add_class "current" if item.current? assigns[:current_tab]
+
+        if url
+          text_node link_to label, url, **item.html_options
+        else
+          span label, item.html_options
+        end
+
+        if item.items.any?
+          add_class "has_nested"
+          @submenu = menu(item)
+        end
+      end
+
+      def tag_name
+        "li"
+      end
+
+      # Sorts by priority first, then alphabetically by label if needed.
+      def <=>(other)
+        result = priority <=> other.priority
+        result == 0 ? label <=> other.label : result
+      end
+
+      def visible?
+        url.nil? || real_url? || @submenu && @submenu.children.any?
+      end
+
+      def to_s
+        visible? ? super : ""
+      end
+
+      private
+
+      # URL is not nil, empty, or '#'
+      def real_url?
+        url && url.present? && url != "#"
+      end
+    end
+  end
+end

data/lib/active_admin/views/components/paginated_collection.rb

@@ -1,5 +1,6 @@
-require 'active_admin/helpers/collection'
-require 'active_admin/view_helpers/download_format_links_helper'
+# frozen_string_literal: true
+require "active_admin/helpers/collection"
+require "active_admin/view_helpers/download_format_links_helper"
 
 module ActiveAdmin
   module Views
@@ -38,12 +39,12 @@ module ActiveAdmin
       #   download_links => Download links override (false or [:csv, :pdf])
       #
       def build(collection, options = {})
-        @collection     = collection
-        @params         = options.delete(:params)
-        @param_name     = options.delete(:param_name)
+        @collection = collection
+        @params = options.delete(:params)
+        @param_name = options.delete(:param_name)
         @download_links = options.delete(:download_links)
-        @display_total  = options.delete(:pagination_total) { true }
-        @per_page       = options.delete(:per_page)
+        @display_total = options.delete(:pagination_total) { true }
+        @per_page = options.delete(:per_page)
 
         unless collection.respond_to?(:total_pages)
           raise(StandardError, "Collection is not a paginated scope. Set collection.page(params[:page]).per(10) before calling :paginated_collection.")
@@ -92,22 +93,22 @@ module ActiveAdmin
       end
 
       def build_pagination
-        options = { theme: 'active_admin' }
-        options[:params]     = @params     if @params
+        options = { theme: @display_total ? "active_admin" : "active_admin_countless" }
+        options[:params] = @params if @params
         options[:param_name] = @param_name if @param_name
 
-        if !@display_total && collection.respond_to?(:offset)
+        if !@display_total
           # The #paginate method in kaminari will query the resource with a
           # count(*) to determine how many pages there should be unless
           # you pass in the :total_pages option. We issue a query to determine
           # if there is another page or not, but the limit/offset make this
           # query fast.
-          offset = collection.offset(collection.current_page * @per_page.to_i).limit(1).count
+          offset = collection.offset(collection.current_page * collection.limit_value).limit(1).count
           options[:total_pages] = collection.current_page + offset
           options[:right] = 0
         end
 
-        text_node paginate collection, options
+        text_node paginate collection, **options
       end
 
       include ::ActiveAdmin::Helpers::Collection
@@ -116,27 +117,28 @@ module ActiveAdmin
       # modified from will_paginate
       def page_entries_info(options = {})
         if options[:entry_name]
-          entry_name   = options[:entry_name]
+          entry_name = options[:entry_name]
           entries_name = options[:entries_name] || entry_name.pluralize
         elsif collection_is_empty?
-          entry_name   = I18n.t "active_admin.pagination.entry", count: 1, default: 'entry'
-          entries_name = I18n.t "active_admin.pagination.entry", count: 2, default: 'entries'
+          entry_name = I18n.t "active_admin.pagination.entry", count: 1, default: "entry"
+          entries_name = I18n.t "active_admin.pagination.entry", count: 2, default: "entries"
         else
           key = "activerecord.models." + collection.first.class.model_name.i18n_key.to_s
-          entry_name   = I18n.translate key, count: 1,               default: collection.first.class.name.underscore.sub('_', ' ')
+
+          entry_name = I18n.translate key, count: 1, default: collection.first.class.name.underscore.sub("_", " ")
           entries_name = I18n.translate key, count: collection.size, default: entry_name.pluralize
         end
 
         if @display_total
           if collection.total_pages < 2
             case collection_size
-            when 0; I18n.t("active_admin.pagination.empty",    model: entries_name)
-            when 1; I18n.t("active_admin.pagination.one",      model: entry_name)
-            else;   I18n.t("active_admin.pagination.one_page", model: entries_name, n: collection.total_count)
+            when 0; I18n.t("active_admin.pagination.empty", model: entries_name)
+            when 1; I18n.t("active_admin.pagination.one", model: entry_name)
+            else; I18n.t("active_admin.pagination.one_page", model: entries_name, n: collection.total_count)
             end
           else
             offset = (collection.current_page - 1) * collection.limit_value
-            total  = collection.total_count
+            total = collection.total_count
             I18n.t "active_admin.pagination.multiple",
                    model: entries_name,
                    total: total,

data/lib/active_admin/views/components/panel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
@@ -29,7 +30,7 @@ module ActiveAdmin
       def header_action(*args)
         action = args[0]
 
-        @title << div(class: 'header_action') do
+        @title << div(class: "header_action") do
           action
         end
       end

data/lib/active_admin/views/components/scopes.rb

@@ -1,5 +1,6 @@
-require 'active_admin/helpers/collection'
-require 'active_admin/view_helpers/method_or_proc_helper'
+# frozen_string_literal: true
+require "active_admin/helpers/collection"
+require "active_admin/view_helpers/method_or_proc_helper"
 
 module ActiveAdmin
   module Views
@@ -13,16 +14,22 @@ module ActiveAdmin
       include ::ActiveAdmin::Helpers::Collection
 
       def default_class_name
-        "scopes table_tools_segmented_control"
+        "scopes"
       end
 
       def tag_name
-        'ul'
+        "div"
       end
 
       def build(scopes, options = {})
-        scopes.each do |scope|
-          build_scope(scope, options) if call_method_or_proc_on(self, scope.display_if_block)
+        scopes.group_by(&:group).each do |group, group_scopes|
+          ul class: "table_tools_segmented_control #{group_class(group)}" do
+            group_scopes.each do |scope|
+              build_scope(scope, options) if call_method_or_exec_proc(scope.display_if_block)
+            end
+
+            nil
+          end
         end
       end
 
@@ -32,9 +39,9 @@ module ActiveAdmin
         li class: classes_for_scope(scope) do
           params = request.query_parameters.except :page, :scope, :commit, :format
 
-          a href: url_for(scope: scope.id, params: params), class: 'table_tools_button' do
+          a href: url_for(scope: scope.id, params: params), class: "table_tools_button" do
             text_node scope_name(scope)
-            span class: 'count' do
+            span class: "count" do
               "(#{get_scope_count(scope)})"
             end if options[:scope_count] && scope.show_count
           end
@@ -60,6 +67,9 @@ module ActiveAdmin
         collection_size(scope_chain(scope, collection_before_scope))
       end
 
+      def group_class(group)
+        group.present? ? "scope-group-#{group}" : "scope-default-group"
+      end
     end
   end
 end

data/lib/active_admin/views/components/sidebar.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  module Views
+
+    class Sidebar < Component
+      builder_method :sidebar
+
+      def build(sections, attributes = {})
+        super(attributes)
+        sections.map(&method(:sidebar_section))
+      end
+    end
+  end
+end

data/lib/active_admin/views/components/sidebar_section.rb

@@ -1,11 +1,9 @@
-require 'active_admin/helpers/output_safety_helper'
-
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
     class SidebarSection < Panel
       builder_method :sidebar_section
-      include OutputSafetyHelper
 
       # Takes a ActiveAdmin::SidebarSection instance
       def build(section)

data/lib/active_admin/views/components/site_title.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
     class SiteTitle < Component
 
       def tag_name
-        'h1'
+        "h1"
       end
 
       def build(namespace)
@@ -22,8 +23,8 @@ module ActiveAdmin
         @namespace.site_title_link.present?
       end
 
-      def site_title_image?
-        @namespace.site_title_image.present?
+      def site_title_image
+        @site_title_image ||= @namespace.site_title_image(helpers)
       end
 
       private
@@ -33,7 +34,7 @@ module ActiveAdmin
       end
 
       def site_title_content
-        if site_title_image?
+        if site_title_image.present?
           title_image
         else
           title_text
@@ -41,12 +42,11 @@ module ActiveAdmin
       end
 
       def title_text
-        helpers.render_or_call_method_or_proc_on(helpers, @namespace.site_title)
+        @title_text ||= @namespace.site_title(helpers)
       end
 
       def title_image
-        path = helpers.render_or_call_method_or_proc_on(helpers, @namespace.site_title_image)
-        helpers.image_tag(path, id: "site_title_image", alt: title_text)
+        helpers.image_tag(site_title_image, id: "site_title_image", alt: title_text)
       end
 
     end

data/lib/active_admin/views/components/status_tag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     # Build a StatusTag
@@ -5,11 +6,11 @@ module ActiveAdmin
       builder_method :status_tag
 
       def tag_name
-        'span'
+        "span"
       end
 
       def default_class_name
-        'status_tag'
+        "status_tag"
       end
 
       # @overload status_tag(status, options = {})
@@ -28,11 +29,7 @@ module ActiveAdmin
       #   status_tag('active', class: 'important', id: 'status_123', label: 'on')
       #   # => <span class='status_tag active important' id='status_123'>on</span>
       #
-      def build(*args)
-        options = args.extract_options!
-        status = args[0]
-        type = args[1]
-
+      def build(status, options = {})
         label = options.delete(:label)
         classes = options.delete(:class)
         status = convert_to_boolean_status(status)
@@ -46,19 +43,6 @@ module ActiveAdmin
         super(content, options)
 
         add_class(status_to_class(status)) if status
-
-        if type
-          Deprecation.warn <<-MSG.strip_heredoc
-            The `type` parameter has been deprecated. Provide the "#{type}" type as
-            a class instead. For example, `status_tag(status, :#{type}, class: "abc")`
-            would change to `status_tag(status, class: "#{type} abc")`. Also note that
-            the "#{type}" CSS rule will be removed too, so you'll have to provide
-            the styles yourself. See https://github.com/activeadmin/activeadmin/blob/master/CHANGELOG.md#110-
-            for more information.
-          MSG
-          add_class(type.to_s)
-        end
-
         add_class(classes) if classes
       end
 
@@ -66,10 +50,12 @@ module ActiveAdmin
 
       def convert_to_boolean_status(status)
         case status
-        when true, 'true'
-          'Yes'
-        when false, 'false', nil
-          'No'
+        when true, "true"
+          "Yes"
+        when false, "false"
+          "No"
+        when nil
+          "Unset"
         else
           status
         end
@@ -77,10 +63,12 @@ module ActiveAdmin
 
       def status_to_class(status)
         case status
+        when "Unset"
+          "unset no"
         when String, Symbol
-          status.to_s.titleize.gsub(/\s/, '').underscore
+          status.to_s.titleize.gsub(/\s/, "").underscore
         else
-          ''
+          ""
         end
       end
     end

data/lib/active_admin/views/components/table_for.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     class TableFor < Arbre::HTML::Table
       builder_method :table_for
 
       def tag_name
-        'table'
+        "table"
       end
 
       def build(obj, *attrs)
-        options         = attrs.extract_options!
-        @sortable       = options.delete(:sortable)
-        @collection     = obj.respond_to?(:each) && !obj.is_a?(Hash) ? obj : [obj]
+        options = attrs.extract_options!
+        @sortable = options.delete(:sortable)
+        @collection = obj.respond_to?(:each) && !obj.is_a?(Hash) ? obj : [obj]
         @resource_class = options.delete(:i18n)
         @resource_class ||= @collection.klass if @collection.respond_to? :klass
-        @columns        = []
-        @row_class      = options.delete(:row_class)
+
+        @columns = []
+        @row_class = options.delete(:row_class)
 
         build_table
         super(options)
@@ -22,13 +24,13 @@ module ActiveAdmin
       end
 
       def columns(*attrs)
-        attrs.each {|attr| column(attr) }
+        attrs.each { |attr| column(attr) }
       end
 
       def column(*args, &block)
         options = default_options.merge(args.extract_options!)
         title = args[0]
-        data  = args[1] || args[0]
+        data = args[1] || args[0]
 
         col = Column.new(title, data, @resource_class, options, &block)
         @columns << col
@@ -64,12 +66,12 @@ module ActiveAdmin
       end
 
       def build_table_header(col)
-        classes  = Arbre::HTML::ClassList.new
+        classes = Arbre::HTML::ClassList.new
         sort_key = sortable? && col.sortable? && col.sort_key
-        params   = request.query_parameters.except :page, :order, :commit, :format
+        params = request.query_parameters.except :page, :order, :commit, :format
 
-        classes << 'sortable'                         if sort_key
-        classes << "sorted-#{current_sort[1]}"        if sort_key && current_sort[0] == sort_key
+        classes << "sortable" if sort_key
+        classes << "sorted-#{current_sort[1]}" if sort_key && current_sort[0] == sort_key
         classes << col.html_class
 
         if sort_key
@@ -85,13 +87,13 @@ module ActiveAdmin
         @tbody = tbody do
           # Build enough rows for our collection
           @collection.each do |elem|
-            classes = [helpers.cycle('odd', 'even')]
+            classes = [helpers.cycle("odd", "even")]
 
             if @row_class
               classes << @row_class.call(elem)
             end
 
-            tr(class: classes.flatten.join(' '), id: dom_id_for(elem))
+            tr(class: classes.flatten.join(" "), id: dom_id_for(elem))
           end
         end
       end
@@ -125,8 +127,8 @@ module ActiveAdmin
       # 'desc' it will return 'asc'
       def order_for_sort_key(sort_key)
         current_key, current_order = current_sort
-        return 'desc' unless current_key == sort_key
-        current_order == 'desc' ? 'asc' : 'desc'
+        return "desc" unless current_key == sort_key
+        current_order == "desc" ? "asc" : "desc"
       end
 
       def default_options
@@ -137,7 +139,7 @@ module ActiveAdmin
 
       class Column
 
-        attr_accessor :title, :data , :html_class
+        attr_accessor :title, :data, :html_class
 
         def initialize(*args, &block)
           @options = args.extract_options!
@@ -147,9 +149,9 @@ module ActiveAdmin
           if @options.has_key?(:class)
             html_classes << @options.delete(:class)
           elsif @title.present?
-            html_classes << "col-#{ActiveAdmin::Dependency.rails.parameterize(@title.to_s)}"
+            html_classes << "col-#{@title.to_s.parameterize(separator: "_")}"
           end
-          @html_class = html_classes.join(' ')
+          @html_class = html_classes.join(" ")
           @data = args[1] || args[0]
           @data = block if block
           @resource_class = args[2]
@@ -176,18 +178,9 @@ module ActiveAdmin
         # to the sortable option:
         #   column :username, sortable: 'other_column_to_sort_on'
         #
-        # If you pass a block to be rendered for this column, the column
-        # will not be sortable unless you pass a string to sortable to
-        # sort the column on:
-        #
-        #   column('Username', sortable: 'login'){ @user.pretty_name }
-        #   # => Sort key will be 'login'
-        #
         def sort_key
           # If boolean or nil, use the default sort key.
-          if @options[:sortable] == true || @options[:sortable] == false
-            @data.to_s
-          elsif @options[:sortable].nil?
+          if @options[:sortable].nil? || @options[:sortable] == true || @options[:sortable] == false
             sort_column_name
           else
             @options[:sortable].to_s

data/lib/active_admin/views/components/tabs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     class Tabs < ActiveAdmin::Component
@@ -10,19 +11,31 @@ module ActiveAdmin
       end
 
       def build(&block)
-        @menu = ul(class: 'nav nav-tabs', role: "tablist")
-        @tabs_content = div(class: 'tab-content')
+        @menu = ul(class: "nav nav-tabs", role: "tablist")
+        @tabs_content = div(class: "tab-content")
       end
 
       def build_menu_item(title, options, &block)
-        fragment = options.fetch(:id, title.parameterize)
-        li { link_to title, "##{fragment}" }
+        fragment = options.fetch(:id, fragmentize(title))
+
+        html_options = options.fetch(:html_options, {})
+        li html_options do
+          link_to title, "##{fragment}"
+        end
       end
 
       def build_content_item(title, options, &block)
-        options = options.reverse_merge(id: title.parameterize)
+        options = options.reverse_merge(id: fragmentize(title))
         div(options, &block)
       end
+
+      private
+
+      def fragmentize(string)
+        result = string.parameterize
+        result = CGI.escape(string) if result.blank?
+        result
+      end
     end
   end
 end

data/lib/active_admin/views/components/unsupported_browser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     class UnsupportedBrowser < Component

data/lib/active_admin/views/footer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     class Footer < Component
@@ -6,26 +7,23 @@ module ActiveAdmin
         super id: "footer"
         @namespace = namespace
 
-        if footer?
+        if footer_text.present?
           para footer_text
         else
           para powered_by_message
         end
       end
 
-      def footer?
-        @namespace.footer.present?
-      end
-
       private
 
       def footer_text
-        helpers.render_or_call_method_or_proc_on(self, @namespace.footer)
+        @footer_text ||= @namespace.footer(self)
       end
 
       def powered_by_message
-        I18n.t('active_admin.powered_by',
-          active_admin: link_to("Active Admin", "http://www.activeadmin.info"),
+        I18n.t(
+          "active_admin.powered_by",
+          active_admin: link_to("Active Admin", "https://activeadmin.info"),
           version: ActiveAdmin::VERSION).html_safe
       end
 

data/lib/active_admin/views/header.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
     class Header < Component
@@ -9,21 +10,9 @@ module ActiveAdmin
         @menu = menu
         @utility_menu = @namespace.fetch_menu(:utility_navigation)
 
-        build_site_title
-        build_global_navigation
-        build_utility_navigation
-      end
-
-      def build_site_title
-        insert_tag view_factory.site_title, @namespace
-      end
-
-      def build_global_navigation
-        insert_tag view_factory.global_navigation, @menu, class: 'header-item tabs'
-      end
-
-      def build_utility_navigation
-        insert_tag view_factory.utility_navigation, @utility_menu, id: "utility_nav", class: 'header-item tabs'
+        site_title @namespace
+        global_navigation @menu, class: "header-item tabs"
+        utility_navigation @utility_menu, id: "utility_nav", class: "header-item tabs"
       end
 
     end

data/lib/active_admin/views/index_as_block.rb

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

data/lib/active_admin/views/index_as_blog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
@@ -27,7 +28,7 @@ module ActiveAdmin
     # ```
     #
     # Second, you can pass a block to the tile option which will then be
-    # used as the contents fo the title. The resource being rendered
+    # used as the contents of the title. The resource being rendered
     # is passed in to the block. For Example:
     #
     # ```ruby
@@ -135,7 +136,7 @@ module ActiveAdmin
 
       def build_body(post)
         if @body
-          div class: 'content' do
+          div class: "content" do
             render_method_on_post_or_call_proc post, @body
           end
         end