activeadmin 3.1.0 → 4.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f41c15703a7796ce3b6395820049062ffd4f9fbfe7e95baeffadf283b1262d93
-  data.tar.gz: 6d78d624d8cf0fb7e8cc629b9d3145abf4a3180d2b1df206f4a765db5e2f66dd
+  metadata.gz: 7854f33fa96f9ceb3ef104d2ce30dc2a347ab345037e1864fcbf25b7139f9da6
+  data.tar.gz: 8553d9a6fcfd189d3b60dd03526f68c8527115e7af1a4dfdca4b2ed9da78f8c2
 SHA512:
-  metadata.gz: c530b7246911f1e83c9181795a969eafa11a83dc2ca7271e67d8944bb7d4a1391b5880c050bb77e6bb5535e44fc70460a53e42e838e6d694d2542f42efb37555
-  data.tar.gz: 8ca9cd7d704eb7c1eeda4b4210f6db07d8f9ce72caacdd8bc46ae9b188fe518316d8a2714350986960492b6aafc56dd9462ab2ac3272b25361b7e8777034525f
+  metadata.gz: 25117be07ec53152259ab5b7308897d8e6288978ac8eb4bf113cbb9d38a41a2c10701604056cbebeb8d087257b5acc2bc6066e4dc2fc2d4eae42183e15463793
+  data.tar.gz: 0b62aafe018b86b4493a01c636dd6831c73fa54a6269977497a904fb7afe8a0ee06acb26da23f134cd4a41a699be29252b324b64c73365e324f0cdb431216c45

data/CHANGELOG.md

@@ -595,7 +595,7 @@ _No changes_.
 
 * Prevents access to formats that the user not permitted to see. [#4867] by [@Fivell] and [@timoschilling]
 * Prevents potential DOS attack via Ruby symbols. [#1926] by [@seanlinsley]
-  * [this isn't an issue for those using Ruby >= 2.2](http://rubykaigi.org/2014/presentation/S-NarihiroNakamura)
+  * [this isn't an issue for those using Ruby >= 2.2](https://rubykaigi.org/2014/presentation/S-NarihiroNakamura)
 
 ### Bug Fixes
 
@@ -878,6 +878,7 @@ Please check [0-6-stable] for previous changes.
 [#8105]: https://github.com/activeadmin/activeadmin/pull/8105
 [#8106]: https://github.com/activeadmin/activeadmin/pull/8106
 
+
 [@1000ship]: https://github.com/1000ship
 [@5t111111]: https://github.com/5t111111
 [@aarek]: https://github.com/aarek

data/CONTRIBUTING.md

@@ -1,54 +1,36 @@
-## Contributing
+# Contributing
 
-First off, thank you for considering contributing to Active Admin. It's people
-like you that make Active Admin such a great tool.
+Thanks for your interest in contributing to ActiveAdmin! Please take a moment to review this document **before submitting a pull request**.
 
-### Where do I go from here?
+## Pull requests
 
-If you've noticed a bug or have a feature request, [make one][new issue]! It's
-generally best if you get confirmation of your bug or approval for your feature
-request this way before starting to code.
+**Please ask first before starting work on any significant new features.**
 
-If you have a general question about activeadmin, you can post it on [Stack
-Overflow], the issue tracker is only for bugs and feature requests.
+It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create [a feature request](https://github.com/activeadmin/activeadmin/discussions/new?category=ideas) to first discuss any new ideas. Your ideas and suggestions are welcome!
 
-### Fork & create a branch
+Please ensure that the tests are passing when submitting a pull request. If you're adding new features to ActiveAdmin, please include tests.
 
-If this is something you think you can fix, then [fork Active Admin] and create
-a branch with a descriptive name.
+## Where do I go from here?
 
-A good branch name would be (where issue #325 is the ticket you're working on):
+For any questions, support, or ideas, etc. [please create a GitHub discussion](https://github.com/activeadmin/activeadmin/discussions/new). If you've noticed a bug, [please submit an issue][new issue].
 
-```sh
-git checkout -b 325-add-japanese-translations
-```
+### Fork and create a branch
 
-### Get the test suite running
+If this is something you think you can fix, then [fork Active Admin] and create
+a branch with a descriptive name.
 
-Make sure you're using a recent Ruby version.
+### Get the test suite running
 
-You'll also need chrome installed in order to run cucumber scenarios.
+Make sure you're using a recent Ruby and Node version. You'll also need Chrome installed in order to run Cucumber scenarios.
 
 Now install the development dependencies:
 
 ```sh
+gem install foreman
 bundle install
-```
-
-Then install javascript dependencies with [Yarn] (requires a current version of [Node.js]):
-
-```sh
 bin/yarn install
 ```
 
-JS assets are located in `app/javascript/active_admin`. The config will take care of compiling a complete bundle with [Rollup] using the `build` script and exported to `app/assets/javascripts/active_admin/base.js` ready to be used by Sprockets.
-
-To update javascript bundle run (add `-w` flag for watch mode):
-
-```sh
-bin/yarn build
-```
-
 Now you should be able to run the entire suite using:
 
 ```sh
@@ -65,20 +47,13 @@ you use the correct Gemfile, for example:
 export BUNDLE_GEMFILE=gemfiles/rails_61/Gemfile
 ```
 
-**Warning** SCSS assets are aimed to be used indifferently with Sprockets **and** webpacker.
-As such, make sure not to use any sass-rails directives such as `asset-url` or `image-url`.
-
 ### Implement your fix or feature
 
-At this point, you're ready to make your changes! Feel free to ask for help;
-everyone is a beginner at first :smile_cat:
+At this point, you're ready to make your changes. Feel free to ask for help.
 
 ### View your changes in a Rails application
 
-Active Admin is meant to be used by humans, not cucumbers. So make sure to take
-a look at your changes in a browser.
-
-To boot up a test Rails app:
+Make sure to take a look at your changes in a browser. To boot up a test Rails app:
 
 ```sh
 bin/rake local server
@@ -87,11 +62,7 @@ bin/rake local server
 This will automatically create a Rails app if none already exists, and store it
 in the `tmp/development_apps` folder.
 
-You should now be able to open <http://localhost:3000/admin> in your browser.
-You can log in using:
-
-*User*: admin@example.com
-*Password*: password
+You should now be able to open <http://localhost:3000/admin> in your browser and log in using `admin@example.com` and `password`.
 
 If you need to perform any other commands on the test application, just pass
 them to the `local` rake task. For example, to boot the rails console:
@@ -100,69 +71,24 @@ them to the `local` rake task. For example, to boot the rails console:
 bin/rake local console
 ```
 
-Or to migrate the database, if you create a new migration or just play around
-with the db:
+Or to migrate the database for a new migration:
 
 ```sh
 bin/rake local db:migrate
 ```
 
-### Make a Pull Request
-
-At this point, you should switch back to your master branch and make sure it's
-up to date with Active Admin's master branch:
-
-```sh
-git remote add upstream git@github.com:activeadmin/activeadmin.git
-git checkout master
-git pull upstream master
-```
-
-Then update your feature branch from your local copy of master, and push it!
-
-```sh
-git checkout 325-add-japanese-translations
-git rebase master
-git push --set-upstream origin 325-add-japanese-translations
-```
-
-Finally, go to GitHub and [make a Pull Request][] :D
-
-Github Actions will run our test suite against all supported Rails versions. We
-care about quality, so your PR won't be merged until all tests pass. It's
-unlikely, but it's possible that your changes pass tests in one Rails version
-but fail in another. In that case, you'll have to setup your development
-environment (as explained in step 3) to use the problematic Rails version, and
-investigate what's going on!
-
-### Keeping your Pull Request updated
-
-If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
-has changed, and that you need to update your branch so it's easier to merge.
-
-To learn more about rebasing in Git, there are a lot of [good][git rebasing]
-[resources][interactive rebase] but here's the suggested workflow:
-
-```sh
-git checkout 325-add-japanese-translations
-git pull --rebase upstream master
-git push --force-with-lease 325-add-japanese-translations
-```
+### Create a Pull Request
 
-### Merging a PR (maintainers only)
+At this point, if your changes look good and tests are passing, you are ready to create a pull request.
 
-A PR can only be merged into master by a maintainer if:
+Github Actions will run our test suite against all supported Rails versions. It's possible that your changes pass tests in one Rails version but fail in another. In that case, you'll have to setup your development
+environment with the Gemfile for the problematic Rails version, and investigate what's going on.
 
-* It is passing CI.
-* It has been approved by at least two maintainers. If it was a maintainer who
-  opened the PR, only one extra approval is needed.
-* It has no requested changes.
-* It is up to date with current master.
+## Merging a PR (maintainers only)
 
-Any maintainer is allowed to merge a PR if all of these conditions are
-met.
+A PR can only be merged into master by a maintainer if: CI is passing, approved by another maintainer and is up to date with the default branch. Any maintainer is allowed to merge a PR if all of these conditions ae met.
 
-### Shipping a release (maintainers only)
+## Shipping a release (maintainers only)
 
 Maintainers need to do the following to push out a release:
 
@@ -175,13 +101,4 @@ Maintainers need to do the following to push out a release:
 * Run `bin/rake release` from the target branch once the PR is merged.
 
 [chandler]: https://github.com/mattbrictson/chandler#2-configure-credentials
-[Stack Overflow]: http://stackoverflow.com/questions/tagged/activeadmin
 [new issue]: https://github.com/activeadmin/activeadmin/issues/new
-[fork Active Admin]: https://help.github.com/articles/fork-a-repo
-[make a pull request]: https://help.github.com/articles/creating-a-pull-request
-[git rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
-[interactive rebase]: https://help.github.com/en/github/using-git/about-git-rebase
-[shortcut reference links]: https://github.github.com/gfm/#shortcut-reference-link
-[Rollup]: https://rollupjs.org/guide/en/#quick-start
-[Yarn]: https://yarnpkg.com/en/docs/install
-[Node.js]: https://nodejs.org/en/

data/README.md

@@ -3,11 +3,10 @@
 [Active Admin](https://activeadmin.info) is a Ruby on Rails framework for
 creating elegant backends for website administration.
 
-[![Version         ][rubygems_badge]][rubygems]
-[![Github Actions  ][actions_badge]][actions]
-[![Coverage        ][coverage_badge]][coverage]
-[![Tidelift        ][tidelift_badge]][tidelift]
-[![Inch CI         ][inch_badge]][inch]
+[![Version][rubygems_badge]][rubygems]
+[![Github Actions][actions_badge]][actions]
+[![Coverage][coverage_badge]][coverage]
+[![Tidelift][tidelift_badge]][tidelift]
 
 ## Goals
 
@@ -17,8 +16,8 @@ creating elegant backends for website administration.
 
 ## Getting started
 
-* Check out [the docs][docs].
-* Try the [live demo][demo].
+* Review [the documentation][docs].
+* For help, questions, etc. [discuss ActiveAdmin on GitHub](https://github.com/activeadmin/activeadmin/discussions) or use [StackOverflow][stackoverflow]
 * The [wiki] includes links to tutorials, articles and sample projects.
 
 ## For enterprise
@@ -26,15 +25,6 @@ creating elegant backends for website administration.
 Active Admin for enterprise is available via the Tidelift subscription. [Learn
 More][tidelift_enterprise].
 
-## Need help?
-
-Please use [StackOverflow][stackoverflow] for help requests and how-to questions.
-
-Please open GitHub issues for bugs and enhancements only, not general help requests.
-Please search previous issues (and Google and StackOverflow) before creating a new issue.
-
-Google Groups, IRC #activeadmin and Gitter are not actively monitored.
-
 ## Want to contribute?
 
 If you want to contribute through code or documentation, the [Contributing
@@ -58,14 +48,14 @@ sponsor for the project, and also submit expenses to it.
 
 We try not to reinvent the wheel, so Active Admin is built with other open source projects:
 
-Tool                  | Description
---------------------- | -----------
-[Arbre]               | Ruby -> HTML, just like that.
-[Devise]              | Powerful, extensible user authentication
-[Formtastic]          | A Rails form builder plugin with semantically rich and accessible markup
-[Inherited Resources] | Simplifies controllers with pre-built RESTful controller actions
-[Kaminari]            | Elegant pagination for any sort of collection
-[Ransack]             | Provides a simple search API to query your data
+* [Arbre]
+* [Devise]
+* [Flowbite](https://flowbite.com)
+* [Formtastic]
+* [Inherited Resources]
+* [Kaminari]
+* [Ransack]
+* [TailwindCSS](https://tailwindcss.com)
 
 ## Security contact information
 
@@ -91,23 +81,20 @@ Thanks to [Open Collective][opencollective contributors] and all our Open Collec
 [Kaminari]: https://github.com/kaminari/kaminari
 [Ransack]: https://github.com/activerecord-hackery/ransack
 
-[rubygems_badge]: http://img.shields.io/gem/v/activeadmin.svg
+[rubygems_badge]: https://img.shields.io/gem/v/activeadmin.svg
 [rubygems]: https://rubygems.org/gems/activeadmin
 [actions_badge]: https://github.com/activeadmin/activeadmin/workflows/ci/badge.svg
 [actions]: https://github.com/activeadmin/activeadmin/actions
 [coverage_badge]: https://codecov.io/gh/activeadmin/activeadmin/branch/master/graph/badge.svg?token=NAjeBdkQXW
 [coverage]: https://codecov.io/gh/activeadmin/activeadmin
-[inch_badge]: http://inch-ci.org/github/activeadmin/activeadmin.svg?branch=master
-[inch]: http://inch-ci.org/github/activeadmin/activeadmin
 [tidelift_badge]: https://tidelift.com/badges/github/activeadmin/activeadmin
 [tidelift]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=readme
 [tidelift_enterprise]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=enterprise
 [tidelift_support]: https://tidelift.com/subscription/pkg/rubygems-activeadmin?utm_source=rubygems-activeadmin&utm_medium=referral&utm_campaign=github&utm_content=support
 
-[docs]: http://activeadmin.info/0-installation.html
-[demo]: http://demo.activeadmin.info/admin
+[docs]: https://activeadmin.info/0-installation.html
 [wiki]: https://github.com/activeadmin/activeadmin/wiki
-[stackoverflow]: http://stackoverflow.com/questions/tagged/activeadmin
+[stackoverflow]: https://stackoverflow.com/questions/tagged/activeadmin
 [contributing]: https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md
 [Liberapay]: https://liberapay.com/Active-Admin/donate
 [Tidelift security contact]: https://tidelift.com/security

data/app/assets/config/active_admin_manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js

data/app/controllers/active_admin/base_controller/menu.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module ActiveAdmin
+  class BaseController < ::InheritedResources::Base
+    module Menu
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_current_menu_item
+
+        helper_method :current_menu
+        helper_method :current_menu_item?
+      end
+
+      protected
+
+      def current_menu
+        active_admin_config.navigation_menu
+      end
+
+      def current_menu_item?(item)
+        item.current?(@current_menu_item)
+      end
+
+      def set_current_menu_item
+        @current_menu_item = if current_menu && active_admin_config.belongs_to? && parent?
+                               parent_item = active_admin_config.belongs_to_config.target.menu_item
+                               if current_menu.include? parent_item
+                                 parent_item
+                               else
+                                 active_admin_config.menu_item
+                               end
+                             else
+                               active_admin_config.menu_item
+                             end
+      end
+
+    end
+  end
+end

data/{lib → app/controllers}/active_admin/base_controller.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
-require "active_admin/base_controller/authorization"
-require "active_admin/base_controller/menu"
-
 module ActiveAdmin
   # BaseController for ActiveAdmin.
   # It implements ActiveAdmin controllers core features.
   class BaseController < ::InheritedResources::Base
-    helper ::ActiveAdmin::ViewHelpers
+    helper MethodOrProcHelper
+    helper LayoutHelper
+    helper FormHelper
+    helper BreadcrumbHelper
+    helper AutoLinkHelper
+    helper DisplayHelper
+    helper IndexHelper
 
-    layout :determine_active_admin_layout
+    layout "active_admin"
 
     before_action :only_render_implemented_actions
     before_action :authenticate_active_admin_user
@@ -22,8 +25,8 @@ module ActiveAdmin
       attr_accessor :active_admin_config
     end
 
-    include Authorization
-    include Menu
+    include BaseController::Authorization
+    include BaseController::Menu
 
     private
 
@@ -61,22 +64,47 @@ module ActiveAdmin
 
     ACTIVE_ADMIN_ACTIONS = [:index, :show, :new, :create, :edit, :update, :destroy]
 
-    # Determine which layout to use.
-    #
-    #   1.  If we're rendering a standard Active Admin action, we want layout(false)
-    #       because these actions are subclasses of the Base page (which implements
-    #       all the required layout code)
-    #   2.  If we're rendering a custom action, we'll use the active_admin layout so
-    #       that users can render any template inside Active Admin.
-    def determine_active_admin_layout
-      ACTIVE_ADMIN_ACTIONS.include?(params[:action].to_sym) ? false : "active_admin"
-    end
-
     def active_admin_root
       controller, action = active_admin_namespace.root_to.split "#"
       { controller: controller, action: action }
     end
 
+    def page_presenter
+      active_admin_config.get_page_presenter(params[:action].to_sym) || default_page_presenter
+    end
+    helper_method :page_presenter
+
+    def default_page_presenter
+      PagePresenter.new
+    end
+
+    def page_title
+      if page_presenter[:title]
+        helpers.render_or_call_method_or_proc_on(self, page_presenter[:title])
+      else
+        default_page_title
+      end
+    end
+    helper_method :page_title
+
+    def default_page_title
+      active_admin_config.name
+    end
+
+    DEFAULT_DOWNLOAD_FORMATS = [:csv, :xml, :json]
+
+    def build_download_formats(download_links)
+      download_links = instance_exec(&download_links) if download_links.is_a?(Proc)
+      if download_links.is_a?(Array) && !download_links.empty?
+        download_links
+      elsif download_links == false
+        []
+      else
+        DEFAULT_DOWNLOAD_FORMATS
+      end
+    end
+    helper_method :build_download_formats
+
     ActiveSupport.run_load_hooks(:active_admin_controller, self)
   end
 end

data/{lib → app/controllers}/active_admin/page_controller.rb

@@ -15,10 +15,6 @@ module ActiveAdmin
       render "active_admin/page/index"
     end
 
-    def clear_page_actions!
-      active_admin_config.clear_page_actions!
-    end
-
     private
 
     def authorize_access!

data/{lib → app/controllers}/active_admin/resource_controller/action_builder.rb

@@ -20,7 +20,7 @@ module ActiveAdmin
         private
 
         def remove_action_methods(actions_type)
-          active_admin_config.public_send("#{actions_type}_actions").each do |action|
+          active_admin_config.public_send(:"#{actions_type}_actions").each do |action|
             remove_method action.name
           end
         end

data/{lib → app/controllers}/active_admin/resource_controller/data_access.rb

@@ -57,7 +57,7 @@ module ActiveAdmin
       def find_collection(options = {})
         collection = scoped_collection
         collection_applies(options).each do |applyer|
-          collection = send("apply_#{applyer}", collection)
+          collection = send(:"apply_#{applyer}", collection)
         end
         collection
       end
@@ -215,7 +215,7 @@ module ActiveAdmin
       # Applies any Ransack search methods to the currently scoped collection.
       # Both `search` and `ransack` are provided, but we use `ransack` to prevent conflicts.
       def apply_filtering(chain)
-        @search = chain.ransack(params[:q] || {})
+        @search = chain.ransack(params[:q] || {}, auth_object: active_admin_authorization)
         @search.result
       end
 

data/{lib → app/controllers}/active_admin/resource_controller/scoping.rb

@@ -16,7 +16,7 @@ module ActiveAdmin
       # Collection can be scoped conditionally with an :if or :unless proc.
       def begin_of_association_chain
         return nil unless active_admin_config.scope_to?(self)
-        MethodOrProcHelper.render_in_context(self, active_admin_config.scope_to_method)
+        helpers.render_in_context(self, active_admin_config.scope_to_method)
       end
 
       # Overriding from InheritedResources::BaseHelpers

data/{lib → app/controllers}/active_admin/resource_controller/streaming.rb

@@ -24,14 +24,14 @@ module ActiveAdmin
         headers["Last-Modified"] = Time.current.httpdate
 
         if ActiveAdmin.application.disable_streaming_in.include? Rails.env
-          self.response_body = block[String.new]
+          self.response_body = block[String.new] # rubocop:disable Performance/UnfreezeString to preserve encoding
         else
           self.response_body = Enumerator.new &block
         end
       end
 
       def csv_filename
-        "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.zone.now.to_date.to_s}.csv"
+        "#{resource_collection_name.to_s.tr('_', '-')}-#{Time.zone.now.to_date.to_s}.csv"
       end
 
       def stream_csv

data/app/controllers/active_admin/resource_controller.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+require "active_admin/collection_decorator"
+
+module ActiveAdmin
+  # All Resources Controller inherits from this controller.
+  # It implements actions and helpers for resources.
+  class ResourceController < BaseController
+    respond_to :html, :xml, :json
+    respond_to :csv, only: :index
+
+    before_action :restrict_download_format_access!, only: [:index, :show]
+
+    include ResourceController::ActionBuilder
+    include ResourceController::Decorators
+    include ResourceController::DataAccess
+    include ResourceController::PolymorphicRoutes
+    include ResourceController::Scoping
+    include ResourceController::Streaming
+    extend ResourceClassMethods
+
+    def self.active_admin_config=(config)
+      if @active_admin_config = config
+        defaults resource_class: config.resource_class,
+                 route_prefix: config.route_prefix,
+                 instance_name: config.resource_name.singular
+      end
+    end
+
+    # Inherited Resources uses the `self.inherited(base)` hook to add
+    # in `self.resource_class`. To override it, we need to install
+    # our resource_class method each time we're inherited from.
+    def self.inherited(base)
+      super(base)
+      base.override_resource_class_methods!
+    end
+
+    private
+
+    def page_presenter
+      case params[:action].to_sym
+      when :index
+        active_admin_config.get_page_presenter(params[:action], params[:as])
+      when :new, :edit
+        active_admin_config.get_page_presenter(:form)
+      end || super
+    end
+
+    def default_page_presenter
+      case params[:action].to_sym
+      when :index
+        PagePresenter.new(as: :table)
+      when :new, :edit
+        PagePresenter.new
+      end || super
+    end
+
+    def page_title
+      if page_presenter[:title]
+        case params[:action].to_sym
+        when :index
+          case page_presenter[:title]
+          when Symbol, Proc
+            instance_exec(&page_presenter[:title])
+          else
+            page_presenter[:title]
+          end
+        else
+          helpers.render_or_call_method_or_proc_on(resource, page_presenter[:title])
+        end
+      else
+        default_page_title
+      end
+    end
+
+    def default_page_title
+      case params[:action].to_sym
+      when :index
+        active_admin_config.plural_resource_label
+      when :show
+        helpers.display_name(resource)
+      when :new, :edit, :create, :update
+        normalized_action = params[:action]
+        normalized_action = 'new' if normalized_action == 'create'
+        normalized_action = 'edit' if normalized_action == 'update'
+
+        ActiveAdmin::Localizers.resource(active_admin_config).t("#{normalized_action}_model")
+      else
+        I18n.t("active_admin.#{params[:action]}", default: params[:action].to_s.titleize)
+      end
+    end
+
+    def restrict_download_format_access!
+      unless request.format.html?
+        presenter = active_admin_config.get_page_presenter(:index)
+        download_formats = (presenter || {}).fetch(:download_links, active_admin_config.namespace.download_links)
+        unless build_download_formats(download_formats).include?(request.format.symbol)
+          raise ActiveAdmin::AccessDenied.new(current_active_admin_user, :index)
+        end
+      end
+    end
+  end
+end