activeadmin 1.0.0 → 2.11.0

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,16 +6,15 @@ 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, type = nil, options = {})
+      # @overload status_tag(status, options = {})
       #   @param [String] status the status to display. One of the span classes will be an underscored version of the status.
-      #   @param [Symbol] type type of status. Will become a class of the span. ActiveAdmin provide style for :ok, :warning and :error.
       #   @param [Hash] options
       #   @option options [String] :class to override the default class
       #   @option options [String] :id to override the default id
@@ -26,31 +26,23 @@ module ActiveAdmin
       #   # => <span class='status_tag in_progress'>In Progress</span>
       #
       # @example
-      #   status_tag('active', :ok)
-      #   # => <span class='status_tag active ok'>Active</span>
+      #   status_tag('active', class: 'important', id: 'status_123', label: 'on')
+      #   # => <span class='status_tag active important' id='status_123'>on</span>
       #
-      # @example
-      #   status_tag('active', :ok, class: 'important', id: 'status_123', label: 'on')
-      #   # => <span class='status_tag active ok 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)
 
         if status
           content = label || if s = status.to_s and s.present?
-            I18n.t "active_admin.status_tag.#{s.downcase}", default: s.titleize
-          end
+                               I18n.t "active_admin.status_tag.#{s.downcase}", default: s.titleize
+                             end
         end
 
         super(content, options)
 
         add_class(status_to_class(status)) if status
-        add_class(type.to_s) if type
         add_class(classes) if classes
       end
 
@@ -58,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
@@ -69,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)
-        options = options.reverse_merge({})
-        li { link_to title, "##{title.parameterize}", options }
+        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,22 +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
@@ -89,7 +90,6 @@ module ActiveAdmin
         @title
       end
 
-
       # Setter method for the configuration of the body
       #
       def body(method = nil, &block)
@@ -124,7 +124,7 @@ module ActiveAdmin
         if @title
           h3 do
             a(href: resource_path(post)) do
-             render_method_on_post_or_call_proc post, @title
+              render_method_on_post_or_call_proc post, @title
             end
           end
         else
@@ -136,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

data/lib/active_admin/views/index_as_grid.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
-     # # Index as a Grid
-     #
-     # Sometimes you want to display the index screen for a set of resources as a grid
-     # (possibly a grid of thumbnail images). To do so, use the :grid option for the
-     # index block.
-     #
-     # ```ruby
-     # index as: :grid do |product|
-     #   link_to image_tag(product.image_path), admin_product_path(product)
-     # end
-     # ```
-     #
-     # The block is rendered within a cell in the grid once for each resource in the
-     # collection. The resource is passed into the block for you to use in the view.
-     #
-     # You can customize the number of columns that are rendered using the columns
-     # option:
-     #
-     # ```ruby
-     # index as: :grid, columns: 5 do |product|
-     #   link_to image_tag(product.image_path), admin_product_path(product)
-     # end
-     # ```
-     #
-     class IndexAsGrid < ActiveAdmin::Component
+    # # Index as a Grid
+    #
+    # Sometimes you want to display the index screen for a set of resources as a grid
+    # (possibly a grid of thumbnail images). To do so, use the :grid option for the
+    # index block.
+    #
+    # ```ruby
+    # index as: :grid do |product|
+    #   link_to image_tag(product.image_path), admin_product_path(product)
+    # end
+    # ```
+    #
+    # The block is rendered within a cell in the grid once for each resource in the
+    # collection. The resource is passed into the block for you to use in the view.
+    #
+    # You can customize the number of columns that are rendered using the columns
+    # option:
+    #
+    # ```ruby
+    # index as: :grid, columns: 5 do |product|
+    #   link_to image_tag(product.image_path), admin_product_path(product)
+    # end
+    # ```
+    #
+    class IndexAsGrid < ActiveAdmin::Component
 
       def build(page_presenter, collection)
         @page_presenter = page_presenter
@@ -68,7 +69,7 @@ module ActiveAdmin
       end
 
       def build_empty_cell
-        td '&nbsp;'.html_safe
+        td "&nbsp;".html_safe
       end
 
       def default_number_of_columns

data/lib/active_admin/views/index_as_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveAdmin
   module Views
 
@@ -110,7 +111,8 @@ module ActiveAdmin
     # end
     # ```
     #
-    # In addition, you can insert the position of the row in the greater collection by using the index_column special command:
+    # In addition, you can insert the position of the row in the greater
+    # collection by using the index_column special command:
     #
     # ```ruby
     # index do
@@ -120,7 +122,8 @@ module ActiveAdmin
     # end
     # ```
     #
-    # index_column take an optional offset parameter to allow a developer to set the starting number for the index (default is 1).
+    # index_column take an optional offset parameter to allow a developer to set
+    # the starting number for the index (default is 1).
     #
     # ## Sorting
     #
@@ -128,9 +131,7 @@ module ActiveAdmin
     # sortable by default. If you are creating a custom column, you may need to give
     # Active Admin a hint for how to sort the table.
     #
-    # If a column is defined using a block, you must pass the key to turn on sorting. The key
-    # is the attribute which gets used to sort objects using Active Record.
-    #
+    # You can pass the key specifying the attribute which gets used to sort objects using Active Record.
     # By default, this is the column on the resource's table that the attribute corresponds to.
     # Otherwise, any attribute that the resource collection responds to can be used.
     #
@@ -159,6 +160,24 @@ module ActiveAdmin
     # end
     # ```
     #
+    # ## Custom sorting
+    #
+    # It is also possible to use database specific expressions and options for sorting by column
+    #
+    # ```ruby
+    # order_by(:title) do |order_clause|
+    #    if order_clause.order == 'desc'
+    #      [order_clause.to_sql, 'NULLS LAST'].join(' ')
+    #    else
+    #      [order_clause.to_sql, 'NULLS FIRST'].join(' ')
+    #    end
+    # end
+    #
+    # index do
+    #   column :title
+    # end
+    # ```
+    #
     # ## Associated Sorting
     #
     # You're normally able to sort columns alphabetically, but by default you
@@ -174,6 +193,13 @@ module ActiveAdmin
     # end
     # ```
     #
+    # You can also define associated objects to include outside of the
+    # `scoped_collection` method:
+    #
+    # ```ruby
+    # includes :publisher
+    # ```
+    #
     # Then it's simple to sort by any Publisher attribute from within the index table:
     #
     # ```ruby
@@ -253,13 +279,13 @@ module ActiveAdmin
         # Display a column for checkbox
         def selectable_column
           return unless active_admin_config.batch_actions.any?
-          column resource_selection_toggle_cell, class: 'col-selectable', sortable: false do |resource|
+          column resource_selection_toggle_cell, class: "col-selectable", sortable: false do |resource|
             resource_selection_cell resource
           end
         end
 
         def index_column(start_value = 1)
-          column '#', class: 'col-index', sortable: false do |resource|
+          column "#", class: "col-index", sortable: false do |resource|
             @collection.offset_value + @collection.index(resource) + start_value
           end
         end
@@ -268,9 +294,9 @@ module ActiveAdmin
         def id_column
           raise "#{resource_class.name} has no primary_key!" unless resource_class.primary_key
           column(resource_class.human_attribute_name(resource_class.primary_key), sortable: resource_class.primary_key) do |resource|
-            if controller.action_methods.include?('show')
+            if controller.action_methods.include?("show")
               link_to resource.id, resource_path(resource), class: "resource_id_link"
-            elsif controller.action_methods.include?('edit')
+            elsif controller.action_methods.include?("edit")
               link_to resource.id, edit_resource_path(resource), class: "resource_id_link"
             else
               resource.id
@@ -279,7 +305,7 @@ module ActiveAdmin
         end
 
         def default_actions
-          raise '`default_actions` is no longer provided in ActiveAdmin 1.x. Use `actions` instead.'
+          raise "`default_actions` is no longer provided in ActiveAdmin 1.x. Use `actions` instead."
         end
 
         # Add links to perform actions.
@@ -319,12 +345,12 @@ module ActiveAdmin
         #
         # ```
         def actions(options = {}, &block)
-          name          = options.delete(:name)     { '' }
-          defaults      = options.delete(:defaults) { true }
-          dropdown      = options.delete(:dropdown) { false }
-          dropdown_name = options.delete(:dropdown_name) { I18n.t 'active_admin.dropdown_actions.button_label', default: 'Actions' }
+          name = options.delete(:name) { "" }
+          defaults = options.delete(:defaults) { true }
+          dropdown = options.delete(:dropdown) { false }
+          dropdown_name = options.delete(:dropdown_name) { I18n.t "active_admin.dropdown_actions.button_label", default: "Actions" }
 
-          options[:class] ||= 'col-actions'
+          options[:class] ||= "col-actions"
 
           column name, options do |resource|
             if dropdown
@@ -344,30 +370,31 @@ module ActiveAdmin
           end
         end
 
-      private
+        private
 
         def defaults(resource, options = {})
-          if controller.action_methods.include?('show') && authorized?(ActiveAdmin::Auth::READ, resource)
-            item I18n.t('active_admin.view'), resource_path(resource), class: "view_link #{options[:css_class]}", title: I18n.t('active_admin.view')
+          localizer = ActiveAdmin::Localizers.resource(active_admin_config)
+          if controller.action_methods.include?("show") && authorized?(ActiveAdmin::Auth::READ, resource)
+            item localizer.t(:view), resource_path(resource), class: "view_link #{options[:css_class]}", title: localizer.t(:view)
           end
-          if controller.action_methods.include?('edit') && authorized?(ActiveAdmin::Auth::UPDATE, resource)
-            item I18n.t('active_admin.edit'), edit_resource_path(resource), class: "edit_link #{options[:css_class]}", title: I18n.t('active_admin.edit')
+          if controller.action_methods.include?("edit") && authorized?(ActiveAdmin::Auth::UPDATE, resource)
+            item localizer.t(:edit), edit_resource_path(resource), class: "edit_link #{options[:css_class]}", title: localizer.t(:edit)
           end
-          if controller.action_methods.include?('destroy') && authorized?(ActiveAdmin::Auth::DESTROY, resource)
-            item I18n.t('active_admin.delete'), resource_path(resource), class: "delete_link #{options[:css_class]}", title: I18n.t('active_admin.delete'),
-              method: :delete, data: {confirm: I18n.t('active_admin.delete_confirmation')}
+          if controller.action_methods.include?("destroy") && authorized?(ActiveAdmin::Auth::DESTROY, resource)
+            item localizer.t(:delete), resource_path(resource), class: "delete_link #{options[:css_class]}", title: localizer.t(:delete),
+                                                                method: :delete, data: { confirm: localizer.t(:delete_confirmation) }
           end
         end
 
         class TableActions < ActiveAdmin::Component
           builder_method :table_actions
 
-          def item *args
-            text_node link_to *args
+          def item *args, **kwargs
+            text_node link_to(*args, **kwargs)
           end
         end
       end # IndexTableFor
 
-    end # IndexAsTable
+    end
   end
 end