activeadmin 1.3.0 → 2.13.1

data/lib/active_admin.rb

@@ -1,59 +1,58 @@
-require 'active_support/core_ext'
-require 'set'
+# frozen_string_literal: true
+require "active_support/core_ext"
+require "set"
 
-require 'ransack'
-require 'ransack_ext'
-require 'kaminari'
-require 'formtastic'
-require 'formtastic_i18n'
-require 'inherited_resources'
-require 'jquery-rails'
-require 'coffee-rails'
-require 'arbre'
+require "ransack"
+require "ransack_ext"
+require "kaminari"
+require "formtastic"
+require "formtastic_i18n"
+require "inherited_resources"
+require "jquery-rails"
+require "arbre"
 
-require 'active_admin/helpers/i18n'
+require "active_admin/helpers/i18n"
 
 module ActiveAdmin
 
-  autoload :VERSION,                  'active_admin/version'
-  autoload :Application,              'active_admin/application'
-  autoload :AssetRegistration,        'active_admin/asset_registration'
-  autoload :Authorization,            'active_admin/authorization_adapter'
-  autoload :AuthorizationAdapter,     'active_admin/authorization_adapter'
-  autoload :Callbacks,                'active_admin/callbacks'
-  autoload :Component,                'active_admin/component'
-  autoload :BaseController,           'active_admin/base_controller'
-  autoload :CanCanAdapter,            'active_admin/cancan_adapter'
-  autoload :ControllerAction,         'active_admin/controller_action'
-  autoload :CSVBuilder,               'active_admin/csv_builder'
-  autoload :Dependency,               'active_admin/dependency'
-  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'
-  autoload :Menu,                     'active_admin/menu'
-  autoload :MenuCollection,           'active_admin/menu_collection'
-  autoload :MenuItem,                 'active_admin/menu_item'
-  autoload :Namespace,                'active_admin/namespace'
-  autoload :OrderClause,              'active_admin/order_clause'
-  autoload :Page,                     'active_admin/page'
-  autoload :PagePresenter,            'active_admin/page_presenter'
-  autoload :PageController,           'active_admin/page_controller'
-  autoload :PageDSL,                  'active_admin/page_dsl'
-  autoload :PunditAdapter,            'active_admin/pundit_adapter'
-  autoload :Resource,                 'active_admin/resource'
-  autoload :ResourceController,       'active_admin/resource_controller'
-  autoload :ResourceDSL,              'active_admin/resource_dsl'
-  autoload :Scope,                    'active_admin/scope'
-  autoload :ScopeChain,               'active_admin/helpers/scope_chain'
-  autoload :SidebarSection,           'active_admin/sidebar_section'
-  autoload :TableBuilder,             'active_admin/table_builder'
-  autoload :ViewFactory,              'active_admin/view_factory'
-  autoload :ViewHelpers,              'active_admin/view_helpers'
-  autoload :Views,                    'active_admin/views'
+  autoload :VERSION, "active_admin/version"
+  autoload :Application, "active_admin/application"
+  autoload :AssetRegistration, "active_admin/asset_registration"
+  autoload :Authorization, "active_admin/authorization_adapter"
+  autoload :AuthorizationAdapter, "active_admin/authorization_adapter"
+  autoload :Callbacks, "active_admin/callbacks"
+  autoload :Component, "active_admin/component"
+  autoload :BaseController, "active_admin/base_controller"
+  autoload :CanCanAdapter, "active_admin/cancan_adapter"
+  autoload :ControllerAction, "active_admin/controller_action"
+  autoload :CSVBuilder, "active_admin/csv_builder"
+  autoload :Dependency, "active_admin/dependency"
+  autoload :Deprecation, "active_admin/deprecation"
+  autoload :Devise, "active_admin/devise"
+  autoload :DSL, "active_admin/dsl"
+  autoload :FormBuilder, "active_admin/form_builder"
+  autoload :Inputs, "active_admin/inputs"
+  autoload :Localizers, "active_admin/localizers"
+  autoload :Menu, "active_admin/menu"
+  autoload :MenuCollection, "active_admin/menu_collection"
+  autoload :MenuItem, "active_admin/menu_item"
+  autoload :Namespace, "active_admin/namespace"
+  autoload :OrderClause, "active_admin/order_clause"
+  autoload :Page, "active_admin/page"
+  autoload :PagePresenter, "active_admin/page_presenter"
+  autoload :PageController, "active_admin/page_controller"
+  autoload :PageDSL, "active_admin/page_dsl"
+  autoload :PunditAdapter, "active_admin/pundit_adapter"
+  autoload :Resource, "active_admin/resource"
+  autoload :ResourceController, "active_admin/resource_controller"
+  autoload :ResourceDSL, "active_admin/resource_dsl"
+  autoload :Scope, "active_admin/scope"
+  autoload :ScopeChain, "active_admin/helpers/scope_chain"
+  autoload :SidebarSection, "active_admin/sidebar_section"
+  autoload :TableBuilder, "active_admin/table_builder"
+  autoload :ViewFactory, "active_admin/view_factory"
+  autoload :ViewHelpers, "active_admin/view_helpers"
+  autoload :Views, "active_admin/views"
 
   class << self
 
@@ -70,11 +69,11 @@ module ActiveAdmin
       application.prepare!
     end
 
-    delegate :register,      to: :application
+    delegate :register, to: :application
     delegate :register_page, to: :application
-    delegate :unload!,       to: :application
-    delegate :load!,         to: :application
-    delegate :routes,        to: :application
+    delegate :unload!, to: :application
+    delegate :load!, to: :application
+    delegate :routes, to: :application
 
     # A callback is triggered each time (before) Active Admin loads the configuration files.
     # In development mode, this will happen whenever the user changes files. In production
@@ -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 { |_name, _start, _finish, _id, payload| block.call payload[:active_admin_application] }
     end
 
   end
@@ -116,13 +121,13 @@ module ActiveAdmin
 end
 
 # Require things that don't support autoload
-require 'active_admin/engine'
-require 'active_admin/error'
+require "active_admin/engine"
+require "active_admin/error"
 
 # Require internal plugins
-require 'active_admin/batch_actions'
-require 'active_admin/filters'
+require "active_admin/batch_actions"
+require "active_admin/filters"
 
 # Require ORM-specific plugins
-require 'active_admin/orm/active_record' if defined? ActiveRecord
-require 'active_admin/orm/mongoid'       if defined? Mongoid
+require "active_admin/orm/active_record" if defined? ActiveRecord
+require "active_admin/orm/mongoid" if defined? Mongoid

data/lib/activeadmin.rb

@@ -1 +1,2 @@
-require 'active_admin'
+# frozen_string_literal: true
+require "active_admin"

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

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 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/assets/templates/active_admin.scss

@@ -1,4 +1,4 @@
-// SASS variable overrides must be declared before loading up Active Admin's styles.
+// Sass variable overrides must be declared before loading up Active Admin's styles.
 //
 // To view the variables that Active Admin provides, take a look at
 // `app/assets/stylesheets/active_admin/mixins/_variables.scss` in the
@@ -11,7 +11,7 @@
 @import "active_admin/mixins";
 @import "active_admin/base";
 
-// Overriding any non-variable SASS must be done after the fact.
+// Overriding any non-variable Sass must be done after the fact.
 // For example, to change the default status-tag color:
 //
 //   .status_tag { background: #6090DB; }

data/lib/generators/active_admin/devise/devise_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "active_admin/error"
 require "active_admin/dependency"
 
@@ -7,13 +8,13 @@ module ActiveAdmin
       desc "Creates an admin user and uses Devise for authentication"
       argument :name, type: :string, default: "AdminUser"
 
-      class_option  :registerable, type: :boolean, default: false,
-                    desc: "Should the generated resource be registerable?"
+      class_option :registerable, type: :boolean, default: false,
+                                  desc: "Should the generated resource be registerable?"
 
       RESERVED_NAMES = [:active_admin_user]
 
-      class_option  :default_user, type: :boolean, default: true,
-                    desc: "Should a default user be created inside the migration?"
+      class_option :default_user, type: :boolean, default: true,
+                                  desc: "Should a default user be created inside the migration?"
 
       def install_devise
         begin
@@ -22,7 +23,7 @@ module ActiveAdmin
           raise ActiveAdmin::GeneratorError, "#{e.message} If you don't want to use devise, run the generator with --skip-users."
         end
 
-        require 'devise'
+        require "devise"
 
         initializer_file =
           File.join(destination_root, "config", "initializers", "devise.rb")

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

@@ -1,4 +1,5 @@
-require 'rails/generators/active_record'
+# frozen_string_literal: true
+require "rails/generators/active_record"
 
 module ActiveAdmin
   module Generators
@@ -7,21 +8,25 @@ 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"
+      class_option :use_webpacker, type: :boolean, default: false, desc: "Use Webpacker assets instead of Sprockets"
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def copy_initializer
-        @underscored_user_name = name.underscore.gsub('/', '_')
+        @underscored_user_name = name.underscore.gsub("/", "_")
         @use_authentication_method = options[:users].present?
-        template 'active_admin.rb.erb', 'config/initializers/active_admin.rb'
+        @skip_comments = options[:skip_comments]
+        @use_webpacker = options[:use_webpacker]
+        template "active_admin.rb.erb", "config/initializers/active_admin.rb"
       end
 
       def setup_directory
         empty_directory "app/admin"
-        template 'dashboard.rb', 'app/admin/dashboard.rb'
+        template "dashboard.rb", "app/admin/dashboard.rb"
         if options[:users].present?
           @user_class = name
-          template 'admin_users.rb.erb', "app/admin/#{name.underscore.pluralize}.rb"
+          template "admin_users.rb.erb", "app/admin/#{name.underscore.pluralize}.rb"
         end
       end
 
@@ -34,11 +39,17 @@ module ActiveAdmin
       end
 
       def create_assets
-        generate "active_admin:assets"
+        if options[:use_webpacker]
+          generate "active_admin:webpacker"
+        else
+          generate "active_admin:assets"
+        end
       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
@@ -290,4 +325,11 @@ ActiveAdmin.setup do |config|
   # You can inherit it with own class and inject it for all resources
   #
   # config.order_clause = MyOrderClause
+
+  # == Webpacker
+  #
+  # By default, Active Admin uses Sprocket's asset pipeline.
+  # You can switch to using Webpacker here.
+  #
+  <% unless @use_webpacker %># <% end %>config.use_webpacker = true
 end

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

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 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,8 @@
+# frozen_string_literal: true
 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/page/templates/page.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ActiveAdmin.register_page "<%= class_name %>" do
   content do
     # your content

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

@@ -1,4 +1,5 @@
-require 'active_admin/generators/boilerplate'
+# frozen_string_literal: true
+require "active_admin/generators/boilerplate"
 
 module ActiveAdmin
   module Generators
@@ -6,9 +7,9 @@ module ActiveAdmin
       desc "Registers resources with Active Admin"
 
       class_option :include_boilerplate, type: :boolean, default: false,
-        desc: "Generate boilerplate code for your resource."
+                                         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)

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/generators/active_admin/webpacker/plugins/jquery.js

@@ -0,0 +1,7 @@
+const webpack = require('webpack')
+
+module.exports = new webpack.ProvidePlugin({
+  "$":"jquery",
+  "jQuery":"jquery",
+  "window.jQuery":"jquery"
+});

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

@@ -0,0 +1,5 @@
+// Load Active Admin's styles into Webpacker,
+// see `active_admin.scss` for customization.
+import "../stylesheets/active_admin";
+
+import "@activeadmin/activeadmin";

data/lib/generators/active_admin/webpacker/templates/active_admin.scss

@@ -0,0 +1,17 @@
+// Sass variable overrides must be declared before loading up Active Admin's styles.
+//
+// To view the variables that Active Admin provides, take a look at
+// `app/assets/stylesheets/active_admin/mixins/_variables.scss` in the
+// Active Admin source.
+//
+// For example, to change the sidebar width:
+// $sidebar-width: 242px;
+
+// Active Admin's got SASS!
+@import "~@activeadmin/activeadmin/src/scss/mixins";
+@import "~@activeadmin/activeadmin/src/scss/base";
+
+// Overriding any non-variable Sass must be done after the fact.
+// For example, to change the default status-tag color:
+//
+//   .status_tag { background: #6090DB; }

data/lib/generators/active_admin/webpacker/templates/print.scss

@@ -0,0 +1,2 @@
+/* Active Admin Print Stylesheet */
+@import "~@activeadmin/activeadmin/src/scss/print";

data/lib/generators/active_admin/webpacker/webpacker_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  module Generators
+    class WebpackerGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("templates", __dir__)
+
+      def install_assets
+        template "active_admin.js", "app/javascript/packs/active_admin.js"
+        template "active_admin.scss", "app/javascript/stylesheets/active_admin.scss"
+        template "print.scss", "app/javascript/packs/active_admin/print.scss"
+
+        copy_file "#{__dir__}/plugins/jquery.js", Rails.root.join("config/webpack/plugins/jquery.js").to_s
+
+        insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
+                         "const jquery = require('./plugins/jquery')\n",
+                         after: /require\(('|")@rails\/webpacker\1\);?\n/
+
+        insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
+                         "environment.plugins.prepend('jquery', jquery)\n",
+                         before: "module.exports"
+
+        run "yarn add @activeadmin/activeadmin"
+      end
+    end
+  end
+end