activeadmin-rails 1.7.0

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

@@ -0,0 +1,68 @@
+require "active_admin/error"
+require "active_admin/dependency"
+
+module ActiveAdmin
+  module Generators
+    class DeviseGenerator < Rails::Generators::NamedBase
+      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?"
+
+      RESERVED_NAMES = [:active_admin_user]
+
+      class_option  :default_user, type: :boolean, default: true,
+                    desc: "Should a default user be created inside the migration?"
+
+      def install_devise
+        begin
+          Dependency.devise! Dependency::Requirements::DEVISE
+        rescue DependencyError => e
+          raise ActiveAdmin::GeneratorError, "#{e.message} If you don't want to use devise, run the generator with --skip-users."
+        end
+
+        require 'devise'
+
+        initializer_file =
+          File.join(destination_root, "config", "initializers", "devise.rb")
+
+        if File.exist?(initializer_file)
+          log :generate, "No need to install devise, already done."
+        else
+          log :generate, "devise:install"
+          invoke "devise:install"
+        end
+      end
+
+      def create_admin_user
+        if RESERVED_NAMES.include?(name.underscore)
+          raise ActiveAdmin::GeneratorError, "The name #{name} is reserved by Active Admin"
+        end
+        invoke "devise", [name]
+      end
+
+      def remove_registerable_from_model
+        unless options[:registerable]
+          model_file = File.join(destination_root, "app", "models", "#{file_path}.rb")
+          gsub_file model_file, /\:registerable([.]*,)?/, ""
+        end
+      end
+
+      def set_namespace_for_path
+        routes_file = File.join(destination_root, "config", "routes.rb")
+        gsub_file routes_file, /devise_for :#{plural_table_name}$/, "devise_for :#{plural_table_name}, ActiveAdmin::Devise.config"
+      end
+
+      def add_default_user_to_seed
+        seeds_paths = Rails.application.paths["db/seeds.rb"]
+        seeds_file = seeds_paths.existent.first
+        return if seeds_file.nil? || !options[:default_user]
+
+        create_user_code = "#{class_name}.create!(email: 'admin@example.com', password: 'password', password_confirmation: 'password') if Rails.env.development?"
+
+        append_to_file seeds_file, create_user_code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'rails/generators/active_record'
+
+module ActiveAdmin
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      desc "Installs Active Admin and generates the necessary migrations"
+      argument :name, type: :string, default: "AdminUser"
+
+      hook_for :users, default: "devise", desc: "Admin user generator to run. Skip with --skip-users"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        @underscored_user_name = name.underscore.gsub('/', '_')
+        @use_authentication_method = options[:users].present?
+        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'
+        if options[:users].present?
+          @user_class = name
+          template 'admin_users.rb.erb', "app/admin/#{name.underscore.pluralize}.rb"
+        end
+      end
+
+      def setup_routes
+        if options[:users] # Ensure Active Admin routes occur after Devise routes so that Devise has higher priority
+          inject_into_file "config/routes.rb", "\n  ActiveAdmin.routes(self)", after: /devise_for .*, ActiveAdmin::Devise\.config/
+        else
+          route "ActiveAdmin.routes(self)"
+        end
+      end
+
+      def create_assets
+        generate "active_admin:assets"
+      end
+
+      def create_migrations
+        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

@@ -0,0 +1,300 @@
+ActiveAdmin.setup do |config|
+  # == Site Title
+  #
+  # Set the title that is displayed on the main layout
+  # for each of the active admin pages.
+  #
+  config.site_title = "<%= Rails.application.class.name.split("::").first.titlecase %>"
+
+  # Set the link url for the title. For example, to take
+  # users to your main site. Defaults to no link.
+  #
+  # config.site_title_link = "/"
+
+  # Set an optional image to be displayed for the header
+  # instead of a string (overrides :site_title)
+  #
+  # Note: Aim for an image that's 21px high so it fits in the header.
+  #
+  # config.site_title_image = "logo.png"
+
+  # == Default Namespace
+  #
+  # Set the default namespace each administration resource
+  # will be added to.
+  #
+  # eg:
+  #   config.default_namespace = :hello_world
+  #
+  # This will create resources in the HelloWorld module and
+  # will namespace routes to /hello_world/*
+  #
+  # To set no namespace by default, use:
+  #   config.default_namespace = false
+  #
+  # Default:
+  # config.default_namespace = :admin
+  #
+  # You can customize the settings for each namespace by using
+  # a namespace block. For example, to change the site title
+  # within a namespace:
+  #
+  #   config.namespace :admin do |admin|
+  #     admin.site_title = "Custom Admin Title"
+  #   end
+  #
+  # This will ONLY change the title for the admin section. Other
+  # namespaces will continue to use the main "site_title" configuration.
+
+  # == User Authentication
+  #
+  # Active Admin will automatically call an authentication
+  # method in a before filter of all controller actions to
+  # ensure that there is a currently logged in admin user.
+  #
+  # This setting changes the method which Active Admin calls
+  # within the application controller.
+  <% unless @use_authentication_method %># <% end %>config.authentication_method = :authenticate_<%= @underscored_user_name %>!
+
+  # == User Authorization
+  #
+  # Active Admin will automatically call an authorization
+  # method in a before filter of all controller actions to
+  # ensure that there is a user with proper rights. You can use
+  # CanCanAdapter or make your own. Please refer to documentation.
+  # config.authorization_adapter = ActiveAdmin::CanCanAdapter
+
+  # In case you prefer Pundit over other solutions you can here pass
+  # the name of default policy class. This policy will be used in every
+  # case when Pundit is unable to find suitable policy.
+  # config.pundit_default_policy = "MyDefaultPunditPolicy"
+
+  # You can customize your CanCan Ability class name here.
+  # config.cancan_ability_class = "Ability"
+
+  # You can specify a method to be called on unauthorized access.
+  # This is necessary in order to prevent a redirect loop which happens
+  # because, by default, user gets redirected to Dashboard. If user
+  # doesn't have access to Dashboard, he'll end up in a redirect loop.
+  # Method provided here should be defined in application_controller.rb.
+  # config.on_unauthorized_access = :access_denied
+
+  # == Current User
+  #
+  # Active Admin will associate actions with the current
+  # user performing them.
+  #
+  # This setting changes the method which Active Admin calls
+  # (within the application controller) to return the currently logged in user.
+  <% unless @use_authentication_method %># <% end %>config.current_user_method = :current_<%= @underscored_user_name %>
+
+  # == Logging Out
+  #
+  # Active Admin displays a logout link on each screen. These
+  # settings configure the location and method used for the link.
+  #
+  # This setting changes the path where the link points to. If it's
+  # a string, the strings is used as the path. If it's a Symbol, we
+  # will call the method to return the path.
+  #
+  # Default:
+  config.logout_link_path = :destroy_<%= @underscored_user_name %>_session_path
+
+  # This setting changes the http method used when rendering the
+  # link. For example :get, :delete, :put, etc..
+  #
+  # Default:
+  # config.logout_link_method = :get
+
+  # == Root
+  #
+  # Set the action to call for the root path. You can set different
+  # roots for each namespace.
+  #
+  # Default:
+  # config.root_to = 'dashboard#index'
+
+  # == Admin Comments
+  #
+  # This allows your users to comment on any resource registered with Active Admin.
+  #
+  # You can completely disable comments:
+  # config.comments = false
+  #
+  # You can change the name under which comments are registered:
+  # config.comments_registration_name = 'AdminComment'
+  #
+  # You can change the order for the comments and you can change the column
+  # to be used for ordering:
+  # config.comments_order = 'created_at ASC'
+  #
+  # You can disable the menu item for the comments index page:
+  # config.comments_menu = false
+  #
+  # You can customize the comment menu:
+  # config.comments_menu = { parent: 'Admin', priority: 1 }
+
+  # == Batch Actions
+  #
+  # Enable and disable Batch Actions
+  #
+  config.batch_actions = true
+
+  # == Controller Filters
+  #
+  # You can add before, after and around filters to all of your
+  # Active Admin resources and pages from here.
+  #
+  # 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
+  #
+  config.localize_format = :long
+
+  # == Setting a Favicon
+  #
+  # config.favicon = 'favicon.ico'
+
+  # == Meta Tags
+  #
+  # Add additional meta tags to the head element of active admin pages.
+  #
+  # Add tags to all pages logged in users see:
+  #   config.meta_tags = { author: 'My Company' }
+
+  # By default, sign up/sign in/recover password pages are excluded
+  # from showing up in search engine results by adding a robots meta
+  # tag. You can reset the hash of meta tags included in logged out
+  # pages:
+  #   config.meta_tags_for_logged_out_pages = {}
+
+  # == Removing Breadcrumbs
+  #
+  # Breadcrumbs are enabled by default. You can customize them for individual
+  # resources or you can disable them globally from here.
+  #
+  # config.breadcrumb = false
+
+  # == Create Another Checkbox
+  #
+  # Create another checkbox is disabled by default. You can customize it for individual
+  # resources or you can enable them globally from here.
+  #
+  # config.create_another = true
+
+  # == Register Stylesheets & Javascripts
+  #
+  # We recommend using the built in Active Admin layout and loading
+  # up your own stylesheets / javascripts to customize the look
+  # and feel.
+  #
+  # To load a stylesheet:
+  #   config.register_stylesheet 'my_stylesheet.css'
+  #
+  # You can provide an options hash for more control, which is passed along to stylesheet_link_tag():
+  #   config.register_stylesheet 'my_print_stylesheet.css', media: :print
+  #
+  # To load a javascript file:
+  #   config.register_javascript 'my_javascript.js'
+
+  # == CSV options
+  #
+  # Set the CSV builder separator
+  # config.csv_options = { col_sep: ';' }
+  #
+  # Force the use of quotes
+  # config.csv_options = { force_quotes: true }
+
+  # == Menu System
+  #
+  # You can add a navigation menu to be used in your application, or configure a provided menu
+  #
+  # To change the default utility navigation to show a link to your website & a logout btn
+  #
+  #   config.namespace :admin do |admin|
+  #     admin.build_menu :utility_navigation do |menu|
+  #       menu.add label: "My Great Website", url: "http://www.mygreatwebsite.com", html_options: { target: :blank }
+  #       admin.add_logout_button_to_menu menu
+  #     end
+  #   end
+  #
+  # If you wanted to add a static menu item to the default menu provided:
+  #
+  #   config.namespace :admin do |admin|
+  #     admin.build_menu :default do |menu|
+  #       menu.add label: "My Great Website", url: "http://www.mygreatwebsite.com", html_options: { target: :blank }
+  #     end
+  #   end
+
+  # == Download Links
+  #
+  # You can disable download links on resource listing pages,
+  # or customize the formats shown per namespace/globally
+  #
+  # To disable/customize for the :admin namespace:
+  #
+  #   config.namespace :admin do |admin|
+  #
+  #     # Disable the links entirely
+  #     admin.download_links = false
+  #
+  #     # Only show XML & PDF options
+  #     admin.download_links = [:xml, :pdf]
+  #
+  #     # Enable/disable the links based on block
+  #     #   (for example, with cancan)
+  #     admin.download_links = proc { can?(:view_download_links) }
+  #
+  #   end
+
+  # == Pagination
+  #
+  # Pagination is enabled by default for all resources.
+  # You can control the default per page count for all resources here.
+  #
+  # config.default_per_page = 30
+  #
+  # You can control the max per page count too.
+  #
+  # config.max_per_page = 10_000
+
+  # == Filters
+  #
+  # By default the index screen includes a "Filters" sidebar on the right
+  # hand side with a filter for each attribute of the registered model.
+  # You can enable or disable them for all resources here.
+  #
+  # config.filters = true
+  #
+  # By default the filters include associations in a select, which means
+  # that every record will be loaded for each association.
+  # You can enabled or disable the inclusion
+  # of those filters by default here.
+  #
+  # config.include_default_association_filters = true
+
+  # == Footer
+  #
+  # By default, the footer shows the current Active Admin version. You can
+  # override the content of the footer here.
+  #
+  # config.footer = 'my custom footer text'
+
+  # == Sorting
+  #
+  # By default ActiveAdmin::OrderClause is used for sorting logic
+  # You can inherit it with own class and inject it for all resources
+  #
+  # config.order_clause = MyOrderClause
+end

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

@@ -0,0 +1,28 @@
+ActiveAdmin.register <%= @user_class %> do
+  permit_params :email, :password, :password_confirmation
+
+  index do
+    selectable_column
+    id_column
+    column :email
+    column :current_sign_in_at
+    column :sign_in_count
+    column :created_at
+    actions
+  end
+
+  filter :email
+  filter :current_sign_in_at
+  filter :sign_in_count
+  filter :created_at
+
+  form do |f|
+    f.inputs do
+      f.input :email
+      f.input :password
+      f.input :password_confirmation
+    end
+    f.actions
+  end
+
+end

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

@@ -0,0 +1,33 @@
+ActiveAdmin.register_page "Dashboard" do
+
+  menu priority: 1, label: proc{ I18n.t("active_admin.dashboard") }
+
+  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")
+        small I18n.t("active_admin.dashboard_welcome.call_to_action")
+      end
+    end
+
+    # Here is an example of a simple dashboard with columns and panels.
+    #
+    # columns do
+    #   column do
+    #     panel "Recent Posts" do
+    #       ul do
+    #         Post.recent(5).map do |post|
+    #           li link_to(post.title, admin_post_path(post))
+    #         end
+    #       end
+    #     end
+    #   end
+
+    #   column do
+    #     panel "Info" do
+    #       para "Welcome to ActiveAdmin."
+    #     end
+    #   end
+    # end
+  end # content
+end

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

@@ -0,0 +1,16 @@
+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
+      t.timestamps
+    end
+    add_index :active_admin_comments, [:namespace]
+  end
+
+  def self.down
+    drop_table :active_admin_comments
+  end
+end

data/lib/generators/active_admin/page/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Registers pages with Active Admin
+
+Example:
+    rails generate active_admin:page Thing
+
+    This will create:
+        app/admin/thing.rb

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

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

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

@@ -0,0 +1,5 @@
+ActiveAdmin.register_page "<%= class_name %>" do
+  content do
+    # your content
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'active_admin/generators/boilerplate'
+
+module ActiveAdmin
+  module Generators
+    class ResourceGenerator < Rails::Generators::NamedBase
+      desc "Registers resources with Active Admin"
+
+      class_option :include_boilerplate, type: :boolean, default: false,
+        desc: "Generate boilerplate code for your resource."
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_config_file
+        @boilerplate = ActiveAdmin::Generators::Boilerplate.new(class_name)
+        template "admin.rb.erb", "app/admin/#{file_path.tr('/', '_').pluralize}.rb"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+ActiveAdmin.configure_resource <%= class_name %> do |config|
+
+<% if options.include_boilerplate? %>
+
+<% end %>
+end

data/lib/ransack_ext.rb

@@ -0,0 +1,20 @@
+# This sets up aliases for old Metasearch query methods so they behave
+# 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]
+  end
+
+  {'equals'=>'eq', 'greater_than'=>'gt', 'less_than'=>'lt'}.each do |old, current|
+    config.add_predicate old, arel_predicate: current
+  end
+
+  config.add_predicate 'gteq_datetime',
+    arel_predicate: 'gteq',
+    formatter: ->(v) { v.beginning_of_day }
+
+  config.add_predicate 'lteq_datetime',
+  	arel_predicate: 'lt',
+  	formatter: ->(v) { v + 1.day }
+end

data/spec/bug_report_templates_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'open3'
+
+RSpec.describe 'bug_report_templates' do
+  subject do
+    Bundler.with_unbundled_env do
+      Dir.chdir(chdir_path) do
+        Open3.capture2e(
+          {'ACTIVE_ADMIN_PATH' => active_admin_root},
+          Gem.ruby,
+          template_path
+        )[1]
+      end
+    end
+  end
+
+  let(:active_admin_root) { File.expand_path('../..', __FILE__) }
+  let(:chdir_path) { File.join(active_admin_root, 'lib', 'bug_report_templates') }
+
+  context 'when runs active_admin_main.rb' do
+    let(:template_path) { 'active_admin_main.rb' }
+
+    it 'passes' do
+      expect(subject).to be_truthy
+    end
+  end
+
+end

data/spec/changelog_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe "Changelog" do
+  subject(:changelog) do
+    path = File.join(File.dirname(__dir__), "CHANGELOG.md")
+    File.read(path)
+  end
+
+  it 'has definitions for all implicit links' do
+    implicit_link_names = changelog.scan(/\[([^\]]+)\]\[\]/).flatten.uniq
+    implicit_link_names.each do |name|
+      expect(changelog).to include("[#{name}]: https")
+    end
+  end
+end

data/spec/javascripts/coffeescripts/jquery.aa.checkbox-toggler-spec.js.coffee

@@ -0,0 +1,50 @@
+describe "ActiveAdmin.CheckboxToggler", ->
+  
+  beforeEach ->
+    loadFixtures('checkboxes.html')
+
+    @collection = $("#collection")
+    @toggle_all = @collection.find(".toggle_all")
+
+    @checkboxes = @collection.find(":checkbox").not(@toggle_all)
+    
+    
+    new ActiveAdmin.CheckboxToggler({}, @collection)
+
+  describe "on init", ->
+    it "should raise an error if container not found", ->
+      expect( => new ActiveAdmin.CheckboxToggler({}) ).toThrow("Container element not found")
+
+    it "should raise an error if 'toggle all' checkbox not found", ->
+      @toggle_all.remove()
+      expect( => new ActiveAdmin.CheckboxToggler({}, @collection); ).toThrow("'toggle all' checkbox not found")
+
+  describe "'toggle all' checkbox", ->
+    it "should check all checkboxes when checked", ->
+      @toggle_all.trigger("click")
+      expect(@checkboxes).toHaveAttr("checked")
+
+    it "should uncheck all checkboxes when unchecked", ->
+      @toggle_all.trigger("click")
+      @toggle_all.trigger("click")
+      expect(@checkboxes).not.toHaveAttr("checked")
+
+  describe "individual checkboxes", ->
+
+    describe "when all checkboxes are selected and one is unchecked", ->
+      beforeEach ->
+        @collection.find(":checkbox").attr("checked", "checked")
+        @collection.find("#item_1").trigger("click")
+
+      it "should uncheck the 'toggle all' checkbox", ->
+        expect(@toggle_all).not.toHaveAttr("checked")
+
+    describe "when the last checkbox is checked", ->
+      beforeEach ->
+        @checkboxes.attr("checked", "checked")
+        @collection.find("#item_1").removeAttr("checked")
+        @collection.find("#item_1").trigger("click")
+
+      it "should check the 'toggle all' checkbox", ->
+        expect(@toggle_all).toHaveAttr("checked")
+