activeadmin-rails 1.7.0

data/spec/support/active_admin_integration_spec_helper.rb

@@ -0,0 +1,79 @@
+module ActiveAdminIntegrationSpecHelper
+  extend self
+
+  def load_defaults!
+    ActiveAdmin.unload!
+    ActiveAdmin.load!
+    ActiveAdmin.register(Category)
+    ActiveAdmin.register(User)
+    ActiveAdmin.register(Post){ belongs_to :user, optional: true }
+  end
+
+  # Sometimes we need to reload the routes within
+  # the application to test them out
+  def reload_routes!
+    Rails.application.reload_routes!
+  end
+
+  # Helper method to load resources and ensure that Active Admin is
+  # setup with the new configurations.
+  #
+  # Eg:
+  #   load_resources do
+  #     ActiveAdmin.register(Post)
+  #   end
+  #
+  def load_resources
+    ActiveAdmin.unload!
+    yield
+    reload_routes!
+  end
+
+  def arbo(assigns = {}, helpers = mock_action_view, &block)
+    Arbo::Context.new(assigns, helpers, &block)
+  end
+
+  def render_component(assigns = {}, helpers = mock_action_view, &block)
+    arbo(assigns, helpers, &block).children.first
+  end
+
+  # A mock action view to test view helpers
+  class MockActionView < ::ActionView::Base
+    include ActiveAdmin::ViewHelpers
+    include Rails.application.routes.url_helpers
+
+    def compiled_method_container
+      self.class
+    end
+  end
+
+  # Returns a fake action view instance to use with our renderers
+  def mock_action_view(base = MockActionView)
+    controller = ActionView::TestCase::TestController.new
+    #this line needed because of rails bug https://github.com/rails/rails/commit/d8e98897b5703ac49bf0764da71a06d64ecda9b0
+    controller.params = ActionController::Parameters.new
+
+    base.new(view_paths, {}, controller)
+  end
+
+  def view_paths
+    paths = ActionController::Base.view_paths
+    # the constructor for ActionView::Base changed from Rails 6
+    # and now expects an instance of ActionView::LookupContext
+    return paths unless Rails::VERSION::MAJOR >= 6
+    ActionView::LookupContext.new(paths)
+  end
+
+  def with_translation(translation)
+    # If no translations have been loaded, any later calls to `I18n.t` will
+    # cause the full translation hash to be loaded, possibly overwritting what
+    # we've loaded via `store_translations`. We use this hack to prevent that.
+    # TODO: Might not be necessary anymore once
+    # https://github.com/svenfuchs/i18n/pull/353 lands.
+    I18n.backend.send(:init_translations)
+    I18n.backend.store_translations I18n.locale, translation
+    yield
+  ensure
+    I18n.backend.reload!
+  end
+end

data/spec/support/active_admin_request_helpers.rb

@@ -0,0 +1,39 @@
+require "action_dispatch"
+require "capybara/rails"
+require "capybara/dsl"
+
+module ActiveAdminRequestHelpers
+  extend ActiveSupport::Concern
+
+  include ActionDispatch::Integration::Runner
+  include RSpec::Rails::TestUnitAssertionAdapter
+  include ActionDispatch::Assertions
+  include Capybara::DSL
+  include RSpec::Matchers
+
+  def app
+    ::Rails.application
+  end
+
+  def last_response
+    page
+  end
+
+  included do
+    before do
+      @router = ::Rails.application.routes
+    end
+  end
+
+  def with_temp_application(application)
+    original_application = ActiveAdmin.application
+    ActiveAdmin.application = application
+    load_defaults!
+    reload_routes!
+
+    yield
+
+  ensure
+    ActiveAdmin.application = original_application
+  end
+end

data/spec/support/rails_template.rb

@@ -0,0 +1,224 @@
+# Rails template to build the sample app for specs
+
+copy_file File.expand_path('../templates/manifest.js', __FILE__), 'app/assets/config/manifest.js', force: true
+
+create_file 'app/assets/stylesheets/some-random-css.css'
+create_file 'app/assets/javascripts/some-random-js.js'
+create_file 'app/assets/images/a/favicon.ico'
+
+generate :model, 'post title:string body:text published_date:date author_id:integer ' +
+  'position:integer custom_category_id:integer starred:boolean foo_id:integer'
+
+create_file 'app/models/post.rb', <<-RUBY.strip_heredoc, force: true
+  class Post < ActiveRecord::Base
+    belongs_to :category, foreign_key: :custom_category_id, optional: true
+    belongs_to :author, class_name: 'User', optional: true
+    has_many :taggings
+    accepts_nested_attributes_for :author
+    accepts_nested_attributes_for :taggings, allow_destroy: true
+
+    ransacker :custom_title_searcher do |parent|
+      parent.table[:title]
+    end
+
+    ransacker :custom_created_at_searcher do |parent|
+      parent.table[:created_at]
+    end
+
+    ransacker :custom_searcher_numeric, type: :numeric do
+      # nothing to see here
+    end
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["author_id", "body", "created_at", "custom_category_id",
+       "custom_created_at_searcher", "custom_searcher_numeric",
+       "custom_title_searcher", "foo_id", "id", "position",
+       "published_date", "starred", "title", "updated_at"]
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      ["author", "category", "taggings", "kategory"]
+    end
+  end
+RUBY
+copy_file File.expand_path('../templates/post_decorator.rb', __FILE__), 'app/models/post_decorator.rb'
+
+generate :model, 'blog/post title:string body:text published_date:date author_id:integer ' +
+  'position:integer custom_category_id:integer starred:boolean foo_id:integer'
+create_file 'app/models/blog/post.rb', <<-RUBY.strip_heredoc, force: true
+  class Blog::Post < ActiveRecord::Base
+    belongs_to :category, foreign_key: :custom_category_id
+    belongs_to :author, class_name: 'User'
+    has_many :taggings
+    accepts_nested_attributes_for :author
+    accepts_nested_attributes_for :taggings, allow_destroy: true
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["author_id", "body", "created_at",
+       "custom_category_id", "foo_id", "id",
+       "position", "published_date", "starred", "title", "updated_at"]
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      ["author", "category", "taggings"]
+    end
+  end
+RUBY
+
+generate :model, 'profile user_id:integer bio:text'
+
+generate :model, 'user type:string first_name:string last_name:string username:string age:integer encrypted_password:string'
+create_file 'app/models/user.rb', <<-RUBY.strip_heredoc, force: true
+  class User < ActiveRecord::Base
+    class VIP < self
+    end
+    has_many :posts, foreign_key: 'author_id'
+    has_one :profile
+    accepts_nested_attributes_for :profile, allow_destroy: true
+    accepts_nested_attributes_for :posts, allow_destroy: true
+
+    ransacker :age_in_five_years, type: :numeric, formatter: proc { |v| v.to_i - 5 } do |parent|
+      parent.table[:age]
+    end
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["age", "age_in_five_years", "created_at",
+       "first_name", "id", "last_name", "type", "updated_at", "username"]
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      ["posts", "profile"]
+    end
+
+    def display_name
+      "\#{first_name} \#{last_name}"
+    end
+  end
+RUBY
+
+create_file 'app/models/profile.rb', <<-RUBY.strip_heredoc, force: true
+  class Profile < ActiveRecord::Base
+    belongs_to :user
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["bio", "created_at", "id", "updated_at", "user_id"]
+    end
+  end
+RUBY
+
+generate :model, 'publisher --migration=false --parent=User'
+
+generate :model, 'category name:string description:text'
+create_file 'app/models/category.rb', <<-RUBY.strip_heredoc, force: true
+  class Category < ActiveRecord::Base
+    has_many :posts, foreign_key: :custom_category_id
+    has_many :authors, through: :posts
+    accepts_nested_attributes_for :posts
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["created_at", "description", "id", "name", "updated_at"]
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      ["authors", "posts"]
+    end
+  end
+RUBY
+
+generate :model, 'store name:string user_id:integer'
+create_file 'app/models/store.rb', <<-RUBY.strip_heredoc, force: true
+  class Store < ActiveRecord::Base
+    def self.ransackable_attributes(auth_object = nil)
+      ["created_at", "id", "name", "updated_at", "user_id"]
+    end
+  end
+RUBY
+
+generate :model, 'tag name:string'
+create_file 'app/models/tag.rb', <<-RUBY.strip_heredoc, force: true
+  class Tag < ActiveRecord::Base
+  end
+RUBY
+
+generate :model, 'tagging post_id:integer tag_id:integer position:integer'
+create_file 'app/models/tagging.rb', <<-RUBY.strip_heredoc, force: true
+  class Tagging < ActiveRecord::Base
+    belongs_to :post, optional: true
+    belongs_to :tag, optional: true
+
+    delegate :name, to: :tag, prefix: true
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["created_at", "id", "position", "post_id", "tag_id", "updated_at"]
+    end
+  end
+RUBY
+
+gsub_file 'config/environments/test.rb', /  config.(cache_classes|enable_reloading) = .*$/, <<-RUBY
+
+  config.cache_classes = !ENV['CLASS_RELOADING']
+  config.action_mailer.default_url_options = {host: 'example.com'}
+  config.assets.precompile += %w( some-random-css.css some-random-js.js a/favicon.ico )
+
+  config.active_record.maintain_test_schema = false
+
+  if Rails::VERSION::MAJOR >= 6
+    config.hosts = [
+      IPAddr.new("0.0.0.0/0"), # All IPv4 addresses.
+      IPAddr.new("::/0"),      # All IPv6 addresses.
+      "www.example.com",
+      "localhost"              # The localhost reserved domain.
+    ]
+  end
+RUBY
+
+# TODO: remove this line after the STI pre-loading is fixed
+# The test commenting.feature/Commenting on a STI subclass fails with zeitwerk autoloader
+inject_into_file 'config/environments/test.rb', "\n  config.autoloader = :classic\n", after: 'Rails.application.configure do' if Rails::VERSION::MAJOR == 6
+
+# Override and revert rails/rails#46699 for now
+gsub_file "config/database.yml", /storage\/(.+)\.sqlite3$/, 'db/\1.sqlite3'
+
+# Add our local Active Admin to the application
+gem 'activeadmin-rails', path: '../..'
+gem 'devise', '~> 4.6'
+
+run 'bundle install'
+
+# Setup Active Admin
+generate 'active_admin:install'
+
+# Force strong parameters to raise exceptions
+inject_into_file 'config/application.rb', after: 'class Application < Rails::Application' do
+  "\n    config.action_controller.action_on_unpermitted_parameters = :raise\n"
+end
+
+inject_into_file 'app/models/admin_user.rb', '
+
+    def self.ransackable_attributes(auth_object = nil)
+      ["created_at", "email", "id", 
+       "remember_created_at", "reset_password_sent_at",
+       "updated_at"]
+    end
+', after: 'class AdminUser < ApplicationRecord'
+
+# Add some translations
+append_file 'config/locales/en.yml', File.read(File.expand_path('../templates/en.yml', __FILE__))
+
+# Add predefined admin resources
+directory File.expand_path('../templates/admin', __FILE__), 'app/admin'
+
+# Add predefined policies
+directory File.expand_path('../templates/policies', __FILE__), 'app/policies'
+
+if ENV['RAILS_ENV'] != 'test'
+  inject_into_file 'config/routes.rb', "\n  root to: redirect('admin')", after: /.*routes.draw do/
+end
+
+# Rails 7.1 doesn't write test.sqlite3 files if we run db:drop, db:create and db:migrate in a single command.
+rails_command "db:drop db:create", env: ENV["RAILS_ENV"]
+rails_command "db:migrate", env: ENV["RAILS_ENV"]
+
+if ENV['INSTALL_PARALLEL']
+  inject_into_file 'config/database.yml', "<%= ENV['TEST_ENV_NUMBER'] %>", after: 'test.sqlite3'
+end

data/spec/support/rails_template_with_data.rb

@@ -0,0 +1,328 @@
+apply File.expand_path("../rails_template.rb", __FILE__)
+
+inject_into_file 'config/initializers/active_admin.rb', <<-RUBY, after: "ActiveAdmin.setup do |config|\n"
+
+  config.comments_menu = { parent: 'Administrative' }
+RUBY
+
+inject_into_file 'app/admin/admin_users.rb', <<-RUBY, after: "ActiveAdmin.register AdminUser do\n"
+
+  menu parent: "Administrative", priority: 1
+RUBY
+
+generate :'active_admin:page', 'KitchenSink'
+
+gsub_file 'app/admin/kitchen_sink.rb', /^ *content.*?end/m, <<-RUBY
+
+  sidebar "Sample Sidebar" do
+    para "Sidebars can also be used on custom pages."
+    para do
+      a "Active Admin", href: "https://github.com/activeadmin/activeadmin"
+      text_node "is a Ruby on Rails framework for"
+      em "creating elegant backends"
+      text_node "for"
+      strong "website administration."
+    end
+    para do
+      abbr "HTML", title: "HyperText Markup Language"
+      text_node "is the most basic building block of the Web."
+    end
+  end
+
+  content do
+    columns do
+      column do
+        panel "Panel title" do
+          h1 "This is an h1"
+          h2 "This is an h2"
+          h3 "This is an h3"
+        end
+      end
+      column do
+        table_for User.all do
+          column :id
+          column :display_name
+          column :username
+          column :age
+          column :updated_at
+        end
+      end
+    end
+
+    tabs do
+      tab :first do
+        ul do
+          li "List item"
+          li "Another list item"
+          li "Last item"
+        end
+        ol do
+          li "First list item"
+          li "Second list item"
+          li "Third list item"
+        end
+      end
+      tab :second do
+        para "A popular quote."
+        blockquote do
+          text_node "&ldqou;Be yourself; everyone else is already taken.&rdqou;".html_safe
+          cite "― Oscar Wilde"
+        end
+      end
+      tab :third do
+        para "Third tab content."
+      end
+    end
+  end
+RUBY
+
+%w{Post User Category Tag}.each do |type|
+  generate :'active_admin:resource', type
+end
+
+inject_into_file 'app/admin/categories.rb', <<-RUBY, after: "ActiveAdmin.register Category do\n"
+
+  config.create_another = true
+
+  permit_params [:name, :description]
+RUBY
+
+inject_into_file 'app/admin/users.rb', <<-RUBY, after: "ActiveAdmin.register User do\n"
+
+  config.create_another = true
+
+  permit_params [:first_name, :last_name, :username, :age]
+
+  index as: :grid do |user|
+    div for: user do
+      resource_selection_cell user
+      h2 link_to(user.display_name, admin_user_path(user)), style: 'margin-bottom: 0'
+      para do
+        strong user.username, style: 'text-transform: uppercase; font-size: 10px;'
+        br
+        em user.age
+        text_node 'years old'
+      end
+    end
+  end
+
+  show do
+    attributes_table do
+      row :id
+      row :first_name
+      row :last_name
+      row :username
+      row :age
+      row :created_at
+      row :updated_at
+    end
+
+    panel 'Posts' do
+      table_for(user.posts.includes(:category).order(:updated_at).limit(10)) do
+        column :id do |post|
+          link_to post.id, admin_post_path(post)
+        end
+        column :title
+        column :published_date
+        column :category
+        column :created_at
+        column :updated_at
+      end
+      para do
+        link_to "View all posts", admin_posts_path('q[author_id_eq]' => user.id)
+      end
+    end
+  end
+RUBY
+
+inject_into_file 'app/admin/posts.rb', <<-'RUBY', after: "ActiveAdmin.register Post do\n"
+
+  permit_params :custom_category_id, :author_id, :title, :body, :published_date, :position, :starred, taggings_attributes: [ :id, :tag_id, :name, :position, :_destroy ]
+
+  includes :author, :category, :taggings
+
+  scope :all, default: true
+
+  scope :drafts, group: :status do |posts|
+    posts.where(["published_date IS NULL"])
+  end
+
+  scope :scheduled, group: :status do |posts|
+    posts.where(["posts.published_date IS NOT NULL AND posts.published_date > ?", Time.now.utc])
+  end
+
+  scope :published, group: :status do |posts|
+    posts.where(["posts.published_date IS NOT NULL AND posts.published_date < ?", Time.now.utc])
+  end
+
+  scope :my_posts, group: :author do |posts|
+    posts.where(author_id: current_admin_user.id)
+  end
+
+  batch_action :set_starred, form: { starred: :checkbox } do |ids, inputs|
+    Post.where(id: ids).update_all(starred: inputs['starred'].present?)
+    redirect_to collection_path, notice: "The posts have been updated."
+  end
+
+  index do
+    selectable_column
+    id_column
+    column :title
+    column :published_date
+    column :author
+    column :category
+    column :starred
+    column :position
+    column :created_at
+    column :updated_at
+  end
+
+  sidebar :author, only: :show do
+    attributes_table_for post.author do
+      row :id do |author|
+        link_to author.id, admin_user_path(author)
+      end
+      row :first_name
+      row :last_name
+      row :username
+      row :age
+    end
+  end
+
+  member_action :toggle_starred, method: :put do
+    resource.update(starred: !resource.starred)
+    redirect_to resource_path, notice: "Post updated."
+  end
+
+  action_item :toggle_starred, only: :show do
+    link_to 'Toggle Starred', toggle_starred_admin_post_path(post), method: :put
+  end
+
+  show do |post|
+    attributes_table do
+      row :id
+      row :title
+      row :published_date
+      row :author
+      row :body
+      row :category
+      row :starred
+      row :position
+      row :created_at
+      row :updated_at
+    end
+
+    columns do
+      column do
+        panel 'Tags' do
+          table_for(post.taggings.order(:position)) do
+            column :id do |tagging|
+              link_to tagging.tag_id, admin_tag_path(tagging.tag)
+            end
+            column :tag, &:tag_name
+            column :position
+            column :updated_at
+          end
+        end
+      end
+      column do
+        panel 'Category' do
+          attributes_table_for post.category do
+            row :id do |category|
+              link_to category.id, admin_category_path(category)
+            end
+            row :description
+          end
+        end
+      end
+    end
+  end
+
+  form do |f|
+    columns do
+      column do
+        f.inputs 'Details' do
+          f.input :title
+          f.input :author
+          f.input :published_date,
+            hint: f.object.persisted? && "Created at #{f.object.created_at}"
+          f.input :custom_category_id
+          f.input :category
+          f.input :position
+          f.input :starred
+        end
+      end
+      column do
+        f.inputs 'Content' do
+          f.input :body
+        end
+      end
+    end
+    f.inputs "Tags" do
+      f.has_many :taggings, sortable: :position do |t|
+        t.input :tag
+        t.input :_destroy, as: :boolean
+      end
+    end
+    para "Press cancel to return to the list without saving."
+    f.actions
+  end
+RUBY
+
+inject_into_file 'app/admin/tags.rb', <<-RUBY, after: "ActiveAdmin.register Tag do\n"
+
+  config.create_another = true
+
+  permit_params [:name]
+
+  index do
+    selectable_column
+    id_column
+    column :name
+    column :created_at
+    actions dropdown: true do |tag|
+      item "Preview", admin_tag_path(tag)
+    end
+  end
+
+RUBY
+
+append_file "db/seeds.rb", "\n\n" + <<-RUBY.strip_heredoc
+  users = ["Jimi Hendrix", "Jimmy Page", "Yngwie Malmsteen", "Eric Clapton", "Kirk Hammett"].collect do |name|
+    first, last = name.split(" ")
+    User.create!  first_name: first,
+                  last_name: last,
+                  username: [first,last].join('-').downcase,
+                  age: rand(80),
+                  encrypted_password: SecureRandom.hex
+  end
+
+  categories = ["Rock", "Pop Rock", "Alt-Country", "Blues", "Dub-Step"].collect do |name|
+    Category.create! name: name
+  end
+
+  published_at_values = [Time.now.utc - 5.days, Time.now.utc - 1.day, nil, Time.now.utc + 3.days]
+
+  1_000.times do |i|
+    user = users[i % users.size]
+    cat = categories[i % categories.size]
+    published = published_at_values[i % published_at_values.size]
+    Post.create title: "Blog Post \#{i}",
+                body: "Blog post \#{i} is written by \#{user.username} about \#{cat.name}",
+                category: cat,
+                published_date: published,
+                author: user,
+                starred: true
+  end
+
+  800.times do |i|
+    ActiveAdmin::Comment.create!(
+      namespace: :admin,
+      author: AdminUser.first,
+      body: "Test comment \#{i}",
+      resource: categories.sample
+    )
+  end
+RUBY
+
+rake 'db:seed'

data/spec/support/templates/admin/stores.rb

@@ -0,0 +1,7 @@
+ActiveAdmin.register Store do
+
+  permit_params :name
+
+  index pagination_total: false
+
+end

data/spec/support/templates/en.yml

@@ -0,0 +1,8 @@
+# Sample translations used to test ActiveAdmin's I18n integration.
+  activerecord:
+    models:
+      store:
+        one: Bookstore
+        other: Bookstores
+  active_admin:
+    download: "Download this:"

data/spec/support/templates/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/support/templates/policies/active_admin/comment_policy.rb

@@ -0,0 +1,9 @@
+module ActiveAdmin
+  class CommentPolicy < ApplicationPolicy
+    class Scope < Struct.new(:user, :scope)
+      def resolve
+        scope
+      end
+    end
+  end
+end