activeadmin 1.1.0 → 2.5.0

data/lib/active_admin/views/index_as_table.rb

@@ -110,7 +110,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 +121,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 +130,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.
     #
@@ -192,6 +192,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
@@ -362,18 +369,19 @@ module ActiveAdmin
           end
         end
 
-      private
+        private
 
         def defaults(resource, options = {})
+          localizer = ActiveAdmin::Localizers.resource(active_admin_config)
           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')
+            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')
+            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')}
+            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
 

data/lib/active_admin/views/pages/base.rb

@@ -4,33 +4,36 @@ module ActiveAdmin
       class Base < Arbre::HTML::Document
 
         def build(*args)
-          super
-          add_classes_to_body
+          set_attribute :lang, I18n.locale
           build_active_admin_head
           build_page
         end
 
+        alias_method :html_title, :title # Arbre::HTML::Title
+        def title
+          self.class.name
+        end
+
+        def main_content
+          I18n.t('active_admin.main_content', model: title).html_safe
+        end
+
         private
 
         delegate :active_admin_config, :controller, :params, to: :helpers
 
-        def add_classes_to_body
-          @body.add_class(params[:action])
-          @body.add_class(params[:controller].tr('/', '_'))
-          @body.add_class("active_admin")
-          @body.add_class("logged_in")
-          @body.add_class(active_admin_namespace.name.to_s + "_namespace")
-        end
-
         def build_active_admin_head
-          within @head do
-            insert_tag Arbre::HTML::Title, [title, render_or_call_method_or_proc_on(self, active_admin_namespace.site_title)].compact.join(" | ")
+          within head do
+            html_title [title, helpers.active_admin_namespace.site_title(self)].compact.join(" | ")
+
+            text_node(active_admin_namespace.head)
+
             active_admin_application.stylesheets.each do |style, options|
               text_node stylesheet_link_tag(style, options).html_safe
             end
 
             active_admin_namespace.meta_tags.each do |name, content|
-              text_node(tag(:meta, name: name, content: content))
+              text_node(meta(name: name, content: content))
             end
 
             active_admin_application.javascripts.each do |path|
@@ -46,36 +49,37 @@ module ActiveAdmin
         end
 
         def build_page
-          within @body do
+          within body(class: body_classes) do
             div id: "wrapper" do
               build_unsupported_browser
-              build_header
-              build_title_bar
+              header active_admin_namespace, current_menu
+              title_bar title, action_items_for_action
               build_page_content
-              build_footer
+              footer active_admin_namespace
             end
           end
         end
 
+        def body_classes
+          Arbre::HTML::ClassList.new [
+            params[:action],
+            params[:controller].tr('/', '_'),
+            'active_admin', 'logged_in',
+            active_admin_namespace.name.to_s + '_namespace'
+          ]
+        end
+
         def build_unsupported_browser
           if active_admin_namespace.unsupported_browser_matcher =~ controller.request.user_agent
-            insert_tag view_factory.unsupported_browser
+            unsupported_browser
           end
         end
 
-        def build_header
-          insert_tag view_factory.header, active_admin_namespace, current_menu
-        end
-
-        def build_title_bar
-          insert_tag view_factory.title_bar, title, action_items_for_action
-        end
-
         def build_page_content
           build_flash_messages
           div id: "active_admin_content", class: (skip_sidebar? ? "without_sidebar" : "with_sidebar") do
             build_main_content_wrapper
-            build_sidebar unless skip_sidebar?
+            sidebar sidebar_sections_for_action, id: 'sidebar' unless skip_sidebar?
           end
         end
 
@@ -95,19 +99,6 @@ module ActiveAdmin
           end
         end
 
-        def main_content
-          I18n.t('active_admin.main_content', model: title).html_safe
-        end
-
-        def title
-          self.class.name
-        end
-
-        # Set's the page title for the layout to render
-        def set_page_title
-          set_ivar_on_view "@page_title", title
-        end
-
         # Returns the sidebar sections to render for the current action
         def sidebar_sections_for_action
           if active_admin_config && active_admin_config.sidebar_sections?
@@ -125,24 +116,10 @@ module ActiveAdmin
           end
         end
 
-        # Renders the sidebar
-        def build_sidebar
-          div id: "sidebar" do
-            sidebar_sections_for_action.collect do |section|
-              sidebar_section(section)
-            end
-          end
-        end
-
         def skip_sidebar?
           sidebar_sections_for_action.empty? || assigns[:skip_sidebar] == true
         end
 
-        # Renders the content for the footer
-        def build_footer
-          insert_tag view_factory.footer, active_admin_namespace
-        end
-
       end
     end
   end

data/lib/active_admin/views/pages/index.rb

@@ -124,6 +124,7 @@ module ActiveAdmin
 
         def render_index
           renderer_class = find_index_renderer_class(config[:as])
+
           paginator        = config.fetch(:paginator, true)
           download_links   = config.fetch(:download_links, active_admin_config.namespace.download_links)
           pagination_total = config.fetch(:pagination_total, true)

data/lib/active_admin/views/tabbed_navigation.rb

@@ -1,65 +1,10 @@
+require_relative 'components/menu'
+
 module ActiveAdmin
   module Views
-
-    # Renders an ActiveAdmin::Menu as a set of unordered list items.
-    #
-    # This component takes cares of deciding which items should be
-    # displayed given the current context and renders them appropriately.
-    #
-    # The entire component is rendered within one ul element.
-    class TabbedNavigation < Component
-
-      attr_reader :menu
-
-      # Build a new tabbed navigation component.
-      #
-      # @param [ActiveAdmin::Menu] menu the Menu to render
-      # @param [Hash] options the options as passed to the underlying ul element.
-      #
+    class TabbedNavigation < Menu
       def build(menu, options = {})
-        @menu = menu
-        super(default_options.merge(options))
-        build_menu
-      end
-
-      # The top-level menu items that should be displayed.
-      def menu_items
-        menu.items(self)
-      end
-
-      def tag_name
-        'ul'
-      end
-
-      private
-
-      def build_menu
-        menu_items.each do |item|
-          build_menu_item(item)
-        end
-      end
-
-      def build_menu_item(item)
-        li id: item.id do |li|
-          li.add_class "current" if item.current? assigns[:current_tab]
-
-          if url = item.url(self)
-            text_node link_to item.label(self), url, item.html_options
-          else
-            span item.label(self), item.html_options
-          end
-
-          if children = item.items(self).presence
-            li.add_class "has_nested"
-            ul do
-              children.each{ |child| build_menu_item child }
-            end
-          end
-        end
-      end
-
-      def default_options
-        { id: "tabs" }
+        super(menu, options.reverse_merge(id: 'tabs'))
       end
     end
   end

data/lib/active_admin/views.rb

@@ -2,7 +2,7 @@ module ActiveAdmin
   module Views
 
     # Loads all the classes in views/*.rb
-    Dir[File.expand_path('../views', __FILE__) + "/**/*.rb"].sort.each{ |f| require f }
+    Dir[File.expand_path('views', __dir__) + "/**/*.rb"].sort.each { |f| require f }
 
   end
 end

data/lib/active_admin.rb

@@ -8,7 +8,7 @@ require 'formtastic'
 require 'formtastic_i18n'
 require 'inherited_resources'
 require 'jquery-rails'
-require 'coffee-rails'
+require 'sassc-rails'
 require 'arbre'
 
 require 'active_admin/helpers/i18n'
@@ -30,7 +30,6 @@ module ActiveAdmin
   autoload :Deprecation,              'active_admin/deprecation'
   autoload :Devise,                   'active_admin/devise'
   autoload :DSL,                      'active_admin/dsl'
-  autoload :Event,                    'active_admin/event'
   autoload :FormBuilder,              'active_admin/form_builder'
   autoload :Inputs,                   'active_admin/inputs'
   autoload :Localizers,               'active_admin/localizers'
@@ -90,7 +89,7 @@ module ActiveAdmin
     #
     # @param [Block] block A block to call each time (before) AA loads resources
     def before_load(&block)
-      ActiveSupport::Notifications.subscribe ActiveAdmin::Application::BeforeLoadEvent, &ActiveAdmin::Event.wrap_block_for_active_support_notifications(block)
+      ActiveSupport::Notifications.subscribe ActiveAdmin::Application::BeforeLoadEvent, &wrap_block_for_active_support_notifications(block)
     end
 
     # A callback is triggered each time (after) Active Admin loads the configuration files. This
@@ -108,7 +107,13 @@ module ActiveAdmin
     #
     # @param [Block] block A block to call each time (after) AA loads resources
     def after_load(&block)
-      ActiveSupport::Notifications.subscribe ActiveAdmin::Application::AfterLoadEvent, &ActiveAdmin::Event.wrap_block_for_active_support_notifications(block)
+      ActiveSupport::Notifications.subscribe ActiveAdmin::Application::AfterLoadEvent, &wrap_block_for_active_support_notifications(block)
+    end
+
+    private
+
+    def wrap_block_for_active_support_notifications block
+      proc { |event, *args| block.call *args }
     end
 
   end

data/lib/generators/active_admin/assets/assets_generator.rb

@@ -2,10 +2,10 @@ module ActiveAdmin
   module Generators
     class AssetsGenerator < Rails::Generators::Base
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def install_assets
-        template 'active_admin.js.coffee', 'app/assets/javascripts/active_admin.js.coffee'
+        template 'active_admin.js', 'app/assets/javascripts/active_admin.js'
         template "active_admin.scss", "app/assets/stylesheets/active_admin.scss"
       end
 

data/lib/generators/active_admin/assets/templates/active_admin.js

@@ -0,0 +1 @@
+//= require active_admin/base

data/lib/generators/active_admin/install/install_generator.rb

@@ -7,12 +7,14 @@ module ActiveAdmin
       argument :name, type: :string, default: "AdminUser"
 
       hook_for :users, default: "devise", desc: "Admin user generator to run. Skip with --skip-users"
+      class_option :skip_comments, type: :boolean, default: false, desc: "Skip installation of comments"
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def copy_initializer
         @underscored_user_name = name.underscore.gsub('/', '_')
         @use_authentication_method = options[:users].present?
+        @skip_comments = options[:skip_comments]
         template 'active_admin.rb.erb', 'config/initializers/active_admin.rb'
       end
 
@@ -21,7 +23,7 @@ module ActiveAdmin
         template 'dashboard.rb', 'app/admin/dashboard.rb'
         if options[:users].present?
           @user_class = name
-          template 'admin_user.rb.erb', "app/admin/#{name.underscore}.rb"
+          template 'admin_users.rb.erb', "app/admin/#{name.underscore.pluralize}.rb"
         end
       end
 
@@ -38,7 +40,9 @@ module ActiveAdmin
       end
 
       def create_migrations
-        migration_template 'migrations/create_active_admin_comments.rb.erb', 'db/migrate/create_active_admin_comments.rb'
+        unless options[:skip_comments]
+          migration_template 'migrations/create_active_admin_comments.rb.erb', 'db/migrate/create_active_admin_comments.rb'
+        end
       end
     end
   end

data/lib/generators/active_admin/install/templates/active_admin.rb.erb

@@ -69,6 +69,11 @@ ActiveAdmin.setup do |config|
   # case when Pundit is unable to find suitable policy.
   # config.pundit_default_policy = "MyDefaultPunditPolicy"
 
+  # If you wish to maintain a separate set of Pundit policies for admin
+  # resources, you may set a namespace here that Pundit will search
+  # within when looking for a resource's policy.
+  # config.pundit_policy_namespace = :admin
+
   # You can customize your CanCan Ability class name here.
   # config.cancan_ability_class = "Ability"
 
@@ -119,7 +124,7 @@ ActiveAdmin.setup do |config|
   # This allows your users to comment on any resource registered with Active Admin.
   #
   # You can completely disable comments:
-  # config.comments = false
+  <% unless @skip_comments %># <% end %>config.comments = false
   #
   # You can change the name under which comments are registered:
   # config.comments_registration_name = 'AdminComment'
@@ -147,11 +152,21 @@ ActiveAdmin.setup do |config|
   #
   # config.before_action :do_something_awesome
 
+  # == Attribute Filters
+  #
+  # You can exclude possibly sensitive model attributes from being displayed,
+  # added to forms, or exported by default by ActiveAdmin
+  #
+  config.filter_attributes = [:encrypted_password, :password, :password_confirmation]
+
   # == Localize Date/Time Format
   #
   # Set the localize format to display dates and times.
   # To understand how to localize your app with I18n, read more at
-  # https://github.com/svenfuchs/i18n/blob/master/lib%2Fi18n%2Fbackend%2Fbase.rb#L52
+  # https://guides.rubyonrails.org/i18n.html
+  #
+  # You can run `bin/rails runner 'puts I18n.t("date.formats")'` to see the
+  # available formats in your application.
   #
   config.localize_format = :long
 
@@ -271,12 +286,32 @@ ActiveAdmin.setup do |config|
   # config.filters = true
   #
   # By default the filters include associations in a select, which means
-  # that every record will be loaded for each association.
+  # that every record will be loaded for each association (up
+  # to the value of config.maximum_association_filter_arity).
   # You can enabled or disable the inclusion
   # of those filters by default here.
   #
   # config.include_default_association_filters = true
 
+  # config.maximum_association_filter_arity = 256 # default value of :unlimited will change to 256 in a future version
+  # config.filter_columns_for_large_association, [
+  #    :display_name,
+  #    :full_name,
+  #    :name,
+  #    :username,
+  #    :login,
+  #    :title,
+  #    :email,
+  #  ]
+  # config.filter_method_for_large_association, '_starts_with'
+
+  # == Head
+  #
+  # You can add your own content to the site head like analytics. Make sure
+  # you only pass content you trust.
+  #
+  # config.head = ''.html_safe
+
   # == Footer
   #
   # By default, the footer shows the current Active Admin version. You can

data/lib/generators/active_admin/install/templates/dashboard.rb

@@ -1,8 +1,7 @@
 ActiveAdmin.register_page "Dashboard" do
+  menu priority: 1, label: proc { I18n.t("active_admin.dashboard") }
 
-  menu priority: 1, label: proc{ I18n.t("active_admin.dashboard") }
-
-  content title: proc{ I18n.t("active_admin.dashboard") } do
+  content title: proc { I18n.t("active_admin.dashboard") } do
     div class: "blank_slate_container", id: "dashboard_default_message" do
       span class: "blank_slate" do
         span I18n.t("active_admin.dashboard_welcome.welcome")

data/lib/generators/active_admin/install/templates/migrations/create_active_admin_comments.rb.erb

@@ -1,27 +1,13 @@
-<%
-  parent_class = ActiveRecord::Migration
-  parent_class = parent_class[parent_class.current_version] if Rails::VERSION::MAJOR >= 5
--%>
-class CreateActiveAdminComments < <%= parent_class.to_s %>
+class CreateActiveAdminComments < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
   def self.up
     create_table :active_admin_comments do |t|
       t.string :namespace
       t.text   :body
       t.references :resource, polymorphic: true
       t.references :author, polymorphic: true
-      <%- if Rails::VERSION::MAJOR >= 5 -%>
       t.timestamps
-      <%- else -%>
-      t.timestamps null: false
-      <%- end -%>
     end
     add_index :active_admin_comments, [:namespace]
-    <%- unless Rails::VERSION::MAJOR >= 5 -%>
-
-    add_index :active_admin_comments, [:author_type, :author_id]
-    add_index :active_admin_comments, [:resource_type, :resource_id]
-    <%- end -%>
-
   end
 
   def self.down

data/lib/generators/active_admin/page/page_generator.rb

@@ -1,7 +1,7 @@
 module ActiveAdmin
   module Generators
     class PageGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def generate_config_file
         template "page.rb", "app/admin/#{file_path.tr('/', '_')}.rb"

data/lib/generators/active_admin/resource/resource_generator.rb

@@ -8,11 +8,11 @@ module ActiveAdmin
       class_option :include_boilerplate, type: :boolean, default: false,
         desc: "Generate boilerplate code for your resource."
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def generate_config_file
         @boilerplate = ActiveAdmin::Generators::Boilerplate.new(class_name)
-        template "admin.rb.erb", "app/admin/#{file_path.tr('/', '_')}.rb"
+        template "admin.rb.erb", "app/admin/#{file_path.tr('/', '_').pluralize}.rb"
       end
 
     end

data/lib/generators/active_admin/resource/templates/admin.rb.erb

@@ -1,43 +1,46 @@
 ActiveAdmin.register <%= class_name %> do
-# See permitted parameters documentation:
-# https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
-#
-# permit_params :list, :of, :attributes, :on, :model
-#
-# or
-#
-# permit_params do
-#   permitted = [:permitted, :attributes]
-#   permitted << :other if params[:action] == 'create' && current_user.admin?
-#   permitted
-# end
-<% if options.include_boilerplate? %>
-# Limit actions available to your users by adding them to the 'except' array
-# actions :all, except: []
 
-# Add or remove filters (you can use any ActiveRecord scope) to toggle their
-# visibility in the sidebar
-<%= @boilerplate.filters %>
+  # See permitted parameters documentation:
+  # https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
+  #
+  # Uncomment all parameters which should be permitted for assignment
+  #
+  # permit_params <%= @boilerplate.permit_params %>
+  #
+  # or
+  #
+  # permit_params do
+  #   permitted = [<%= @boilerplate.permit_params %>]
+  #   permitted << :other if params[:action] == 'create' && current_user.admin?
+  #   permitted
+  # end
+  <% if options.include_boilerplate? %>
+  # Limit actions available to your users by adding them to the 'except' array
+  # actions :all, except: []
 
-# Add or remove columns to toggle their visiblity in the index action
-# index do
-#   selectable_column
-#   id_column
-<%= @boilerplate.columns %>
-#   actions
-# end
+  # Add or remove filters (you can use any ActiveRecord scope) to toggle their
+  # visibility in the sidebar
+  <%= @boilerplate.filters %>
 
-# Add or remove rows to toggle their visiblity in the show action
-# show do |<%= class_name.downcase %>|
-<%= @boilerplate.rows %>
-# end
+  # Add or remove columns to toggle their visiblity in the index action
+  # index do
+  #   selectable_column
+  #   id_column
+  <%= @boilerplate.columns %>
+  #   actions
+  # end
 
-# Add or remove fields to toggle their visibility in the form
-# form do |f|
-#   f.inputs do
-<%= @boilerplate.form_inputs %>
-#   end
-#   f.actions
-# end
-<% end %>
+  # Add or remove rows to toggle their visiblity in the show action
+  # show do |<%= class_name.downcase %>|
+  <%= @boilerplate.rows %>
+  # end
+
+  # Add or remove fields to toggle their visibility in the form
+  # form do |f|
+  #   f.inputs do
+  <%= @boilerplate.form_inputs %>
+  #   end
+  #   f.actions
+  # end
+  <% end %>
 end

data/lib/ransack_ext.rb

@@ -2,11 +2,11 @@
 # identically to the versions given in Ransack.
 #
 Ransack.configure do |config|
-  {'contains'=>'cont', 'starts_with'=>'start', 'ends_with'=>'end'}.each do |old, current|
-    config.add_predicate old, Ransack::Constants::DERIVED_PREDICATES.detect{ |q, _| q == current }[1]
+  { 'contains' => 'cont', 'starts_with' => 'start', 'ends_with' => 'end' }.each do |old, current|
+    config.add_predicate old, Ransack::Constants::DERIVED_PREDICATES.detect { |q, _| q == current }[1]
   end
 
-  {'equals'=>'eq', 'greater_than'=>'gt', 'less_than'=>'lt'}.each do |old, current|
+  { 'equals' => 'eq', 'greater_than' => 'gt', 'less_than' => 'lt' }.each do |old, current|
     config.add_predicate old, arel_predicate: current
   end