rails_admin 2.2.1 → 3.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f7dc936446d63b1ecdd6f711d291c25d8c69222a8b4694edc248c9930e67983
-  data.tar.gz: 4e89905db9dac3f8e7336e025fea98a7e03a5bd3d085406fa043f452999efc3c
+  metadata.gz: 142382cf0987b581cb64996e716ad77cf9ae76dab5aa1bf019b8ca38fb7daed0
+  data.tar.gz: 58a52e67fc458713f0245ea244e2a129f370309edc91511678ba06bbc756e9cc
 SHA512:
-  metadata.gz: 71faff5dae3bc4102bc8fb00a4deb42c601e49c5295fb17f88444f57409ab346d466dfd02b66a8998d9394cc270a6760c3586bc8fd7df83d4a6e078b830f93ce
-  data.tar.gz: fc96ebe4813b3621dea3eadde119932e7fd4ebcca303100cbdfc3172c7d8fa2f15f93c489554b581bcd2fe10ab4f636a5927536d94081eb75ae4f867a34b3d17
+  metadata.gz: 55fce15b0a7bf4f168b042ab7415fd24f0cefdb509d61efdb2f3f15de42b657bbbe24b62e686a359f18239f0c9ad36436bbd229c22b35c28be17d8f27fb5ef7f
+  data.tar.gz: 9d076ac618ecdbb0680e7d8e7dd3472b7d0e47d10d5d12b4bdfc260c43297ded2e430a410926d0a680cbe120406e20da3678b5adb5ef2050efebe9aa8e2f8e12

data/Gemfile

@@ -1,9 +1,10 @@
 source 'https://rubygems.org'
 
 gem 'appraisal', '>= 2.0'
-gem 'rails'
-gem 'haml'
 gem 'devise'
+gem 'rails'
+gem 'webpacker', require: false
+gem 'webrick', '~> 1.7'
 
 group :active_record do
   gem 'paper_trail'
@@ -21,30 +22,27 @@ end
 group :test do
   gem 'cancancan', '~> 3.0'
   gem 'carrierwave', ['>= 2.0.0.rc', '< 3']
-  gem 'database_cleaner', ['>= 1.2', '!= 1.4.0', '!= 1.5.0', '< 2.0']
+  gem 'cuprite'
+  gem 'database_cleaner-active_record', '>= 2.0', require: false
+  gem 'database_cleaner-mongoid', '>= 2.0', require: false
   gem 'dragonfly', '~> 1.0'
   gem 'factory_bot', '>= 4.2'
   gem 'generator_spec', '>= 0.8'
   gem 'launchy', '>= 2.2'
   gem 'mini_magick', '>= 3.4'
-  gem 'poltergeist', '~> 1.5'
   gem 'pundit'
   gem 'rack-cache', require: 'rack/cache'
-  gem 'rspec-rails', '>= 2.14'
   gem 'rspec-expectations', '!= 3.8.3'
+  gem 'rspec-rails', '>= 2.14'
   gem 'rspec-retry'
-  gem 'rubocop', '~> 0.68.1', require: false
+  gem 'rubocop', ['~> 1.20', '!= 1.22.2'], require: false
   gem 'rubocop-performance', require: false
   gem 'simplecov', '>= 0.9', require: false
   gem 'simplecov-lcov', require: false
   gem 'timecop', '>= 0.5'
 
-  platforms :ruby_19 do
-    gem 'tins', '~> 1.6.0', require: false
-  end
-
   # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-  gem 'tzinfo-data', platforms: %i(mingw mswin x64_mingw jruby)
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
 end
 
 gemspec

data/README.md

@@ -1,17 +1,15 @@
 # RailsAdmin
 
 [![Gem Version](https://img.shields.io/gem/v/rails_admin.svg)][gem]
-[![Build Status](https://img.shields.io/github/workflow/status/sferik/rails_admin/Test)][ghactions]
-[![Coverage Status](https://img.shields.io/coveralls/sferik/rails_admin.svg)][coveralls]
-[![Inline docs](http://inch-ci.org/github/sferik/rails_admin.svg)][inch]
-[![Code Climate](https://codeclimate.com/github/sferik/rails_admin.svg)][codeclimate]
+[![Build Status](https://img.shields.io/github/workflow/status/railsadminteam/rails_admin/Test)][ghactions]
+[![Coverage Status](https://img.shields.io/coveralls/railsadminteam/rails_admin.svg)][coveralls]
+[![Code Climate](https://codeclimate.com/github/railsadminteam/rails_admin.svg)][codeclimate]
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rails_admin&package-manager=bundler&version-scheme=semver)][semver]
 
 [gem]: https://rubygems.org/gems/rails_admin
-[ghactions]: https://github.com/sferik/rails_admin/actions
-[coveralls]: https://coveralls.io/r/sferik/rails_admin
-[inch]: http://inch-ci.org/github/sferik/rails_admin
-[codeclimate]: https://codeclimate.com/github/sferik/rails_admin
+[ghactions]: https://github.com/railsadminteam/rails_admin/actions
+[coveralls]: https://coveralls.io/r/railsadminteam/rails_admin
+[codeclimate]: https://codeclimate.com/github/railsadminteam/rails_admin
 [semver]: https://dependabot.com/compatibility-score.html?dependency-name=rails_admin&package-manager=bundler&version-scheme=semver
 
 RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.
@@ -20,49 +18,56 @@ RailsAdmin is a Rails engine that provides an easy-to-use interface for managing
 
 ### [Action required] Security issue
 
-**RailsAdmin 2.0.1, 2.0.0 and up to 1.4.2 have been reported to have XSS vulnerability.** We strongly recommend that you upgrade RailsAdmin to 2.0.2 (and higher) or 1.4.3 as soon as possible, if you are on those versions. See [d72090ec](https://github.com/sferik/rails_admin/commit/d72090ec6a07c3b9b7b48ab50f3d405f91ff4375) for the detail.
+**RailsAdmin 2.0.1, 2.0.0 and up to 1.4.2 have been reported to have XSS vulnerability.** We strongly recommend that you upgrade RailsAdmin to 2.0.2 (and higher) or 1.4.3 as soon as possible, if you are on those versions. See [d72090ec](https://github.com/railsadminteam/rails_admin/commit/d72090ec6a07c3b9b7b48ab50f3d405f91ff4375) for the detail.
 
 ## Getting started
 
-* Check out [the docs][docs].
-* Try the [live demo][demo]. ([Source code][dummy_app])
+- Check out [the docs][docs].
+- Try the [live demo][demo]. ([Source code][dummy_app])
 
 [demo]: http://rails-admin-tb.herokuapp.com/
 [dummy_app]: https://github.com/bbenezech/dummy_app
-[docs]: https://github.com/sferik/rails_admin/wiki
+[docs]: https://github.com/railsadminteam/rails_admin/wiki
 
 ## Features
-* CRUD any data with ease
-* Custom actions
-* Automatic form validation
-* Search and filtering
-* Export data to CSV/JSON/XML
-* Authentication (via [Devise](https://github.com/plataformatec/devise) or other)
-* Authorization (via [CanCanCan](https://github.com/CanCanCommunity/cancancan) or [Pundit](https://github.com/elabs/pundit))
-* User action history (via [PaperTrail](https://github.com/airblade/paper_trail))
-* Supported ORMs
-  * ActiveRecord
-  * Mongoid
-
 
+- CRUD any data with ease
+- Custom actions
+- Automatic form validation
+- Search and filtering
+- Export data to CSV/JSON/XML
+- Authentication (via [Devise](https://github.com/plataformatec/devise) or other)
+- Authorization (via [CanCanCan](https://github.com/CanCanCommunity/cancancan) or [Pundit](https://github.com/elabs/pundit))
+- User action history (via [PaperTrail](https://github.com/airblade/paper_trail))
+- Supported ORMs
+  - ActiveRecord
+  - Mongoid
 
 ## Installation
 
-1. On your gemfile: `gem 'rails_admin', '~> 2.0'`
+1. On your gemfile: `gem 'rails_admin', ['>= 3.0.0.rc2', '< 4']`
 2. Run `bundle install`
 3. Run `rails g rails_admin:install`
 4. Provide a namespace for the routes when asked
 5. Start a server `rails s` and administer your data at [/admin](http://localhost:3000/admin). (if you chose default namespace: /admin)
 
+## Upgrading from 2.x
+
+Due to introduction of Webpack/Webpacker support, some additional dependency and configuration will be needed.
+Running `rails g rails_admin:install` will suggest you some required changes, based on current setup of your app.
+
 ## Configuration
+
 ### Global
+
 In `config/initializers/rails_admin.rb`:
 
-[Details](https://github.com/sferik/rails_admin/wiki/Base-configuration)
+[Details](https://github.com/railsadminteam/rails_admin/wiki/Base-configuration)
 
-To begin with, you may be interested in setting up [Devise](https://github.com/sferik/rails_admin/wiki/Devise), [CanCanCan](https://github.com/sferik/rails_admin/wiki/Cancancan) or [Papertrail](https://github.com/sferik/rails_admin/wiki/Papertrail)!
+To begin with, you may be interested in setting up [Devise](https://github.com/railsadminteam/rails_admin/wiki/Devise), [CanCanCan](https://github.com/railsadminteam/rails_admin/wiki/Cancancan) or [Papertrail](https://github.com/railsadminteam/rails_admin/wiki/Papertrail)!
 
 ### Per model
+
 ```ruby
 class Ball < ActiveRecord::Base
   validates :name, presence: true
@@ -76,31 +81,29 @@ class Ball < ActiveRecord::Base
 end
 ```
 
-Details: [Models](https://github.com/sferik/rails_admin/wiki/Models), [Groups](https://github.com/sferik/rails_admin/wiki/Groups), [Fields](https://github.com/sferik/rails_admin/wiki/Fields)
+Details: [Models](https://github.com/railsadminteam/rails_admin/wiki/Models), [Groups](https://github.com/railsadminteam/rails_admin/wiki/Groups), [Fields](https://github.com/railsadminteam/rails_admin/wiki/Fields)
 
 ## Support
+
 If you have a question, please check this README, the wiki, and the [list of
 known issues][troubleshoot].
 
-[troubleshoot]: https://github.com/sferik/rails_admin/wiki/Troubleshoot
+[troubleshoot]: https://github.com/railsadminteam/rails_admin/wiki/Troubleshoot
 
 If you still have a question, you can ask the [official RailsAdmin mailing
 list][list].
 
 [list]: http://groups.google.com/group/rails_admin
 
-If you think you found a bug in RailsAdmin, you can [submit an issue](https://github.com/sferik/rails_admin/issues/new).
+If you think you found a bug in RailsAdmin, you can [submit an issue](https://github.com/railsadminteam/rails_admin/issues/new).
 
 ## Supported Ruby Versions
+
 This library aims to support and is [tested against][ghactions] the following Ruby implementations:
 
-* Ruby 2.2
-* Ruby 2.3
-* Ruby 2.4
-* Ruby 2.5
-* Ruby 2.6
-* Ruby 2.7
-* Ruby 3.0
-* [JRuby][]
+- Ruby 2.6
+- Ruby 2.7
+- Ruby 3.0
+- [JRuby][]
 
 [jruby]: http://jruby.org/

data/Rakefile

@@ -17,8 +17,19 @@ begin
 rescue LoadError
   desc 'Run RuboCop'
   task :rubocop do
-    $stderr.puts 'Rubocop is disabled'
+    warn 'Rubocop is disabled'
   end
 end
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
+
+namespace :vendorize do
+  desc 'Tasks for vendorizing assets'
+
+  task :flatpickr do
+    Dir.chdir(__dir__)
+    flatpickr = File.read('node_modules/flatpickr/dist/flatpickr.js')
+    locales = Dir.glob('node_modules/flatpickr/dist/l10n/*.js').map { |f| File.read(f) }
+    File.write('vendor/assets/javascripts/rails_admin/flatpickr-with-locales.js', ([flatpickr] + locales).join("\n"))
+  end
+end

data/app/assets/javascripts/rails_admin/application.js

@@ -0,0 +1,21 @@
+//=  require 'rails-ujs'
+//=  require 'turbo'
+//=  require 'rails_admin/jquery3'
+//=  require 'jquery_nested_form'
+//=  require 'rails_admin/jquery-ui/effect'
+//=  require 'rails_admin/jquery-ui/widgets/sortable'
+//=  require 'rails_admin/jquery-ui/widgets/autocomplete'
+//=  require 'rails_admin/flatpickr-with-locales'
+//=  require 'rails_admin/popper'
+//=  require 'rails_admin/bootstrap'
+
+//=  require 'rails_admin/filter-box'
+//=  require 'rails_admin/filtering-multiselect'
+//=  require 'rails_admin/filtering-select'
+//=  require 'rails_admin/remote-form'
+//=  require 'rails_admin/nested-form-hooks'
+//=  require 'rails_admin/i18n'
+//=  require 'rails_admin/widgets'
+//=  require 'rails_admin/sidescroll'
+//=  require 'rails_admin/ui'
+//=  require 'rails_admin/custom/ui'

data/app/assets/stylesheets/rails_admin/application.scss

@@ -0,0 +1,31 @@
+@charset "UTF-8";
+
+/***  Variables  ***/
+
+@import "rails_admin/custom/variables";
+@import "rails_admin/styles/base/variables";
+
+/***  Mixins  ***/
+
+@import "rails_admin/styles/base/mixins";
+@import "rails_admin/custom/mixins";
+
+/***  Bootstrap ***/
+
+@import "rails_admin/bootstrap/bootstrap";
+
+/***  Libraries  ***/
+
+@import "rails_admin/flatpickr";
+@import "rails_admin/styles/filtering-select";
+@import "rails_admin/styles/filtering-multiselect";
+@import "rails_admin/styles/widgets";
+
+/*** Font-awesome ***/
+
+@import "rails_admin/font-awesome";
+
+/***  RailsAdmin Theming  ***/
+
+@import "rails_admin/styles/base/theming";
+@import "rails_admin/custom/theming";

data/app/assets/stylesheets/rails_admin/custom/mixins.scss

@@ -6,6 +6,6 @@
   Available mixins to use/override:
 
   https://github.com/twbs/bootstrap-sass/tree/master/assets/stylesheets/bootstrap/mixins
-  https://github.com/sferik/rails_admin/blob/master/app/assets/stylesheets/rails_admin/base/mixins.scss
+  https://github.com/railsadminteam/rails_admin/blob/master/src/rails_admin/styles/base/mixins.scss
   Plus the ones from your theme.
 */

data/app/assets/stylesheets/rails_admin/custom/variables.scss

@@ -6,7 +6,7 @@
   Available variables to use/override:
 
   https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_variables.scss
-  https://github.com/sferik/rails_admin/blob/master/app/assets/stylesheets/rails_admin/base/variables.scss
+  https://github.com/railsadminteam/rails_admin/blob/master/src/rails_admin/styles/base/variables.scss
   Plus the ones from your themes.
 
   Test me: pink links

data/app/controllers/rails_admin/application_controller.rb

@@ -25,13 +25,14 @@ module RailsAdmin
 
     def get_model
       @model_name = to_model_name(params[:model_name])
-      raise(RailsAdmin::ModelNotFound) unless (@abstract_model = RailsAdmin::AbstractModel.new(@model_name))
-      raise(RailsAdmin::ModelNotFound) if (@model_config = @abstract_model.config).excluded?
+      raise RailsAdmin::ModelNotFound unless (@abstract_model = RailsAdmin::AbstractModel.new(@model_name))
+      raise RailsAdmin::ModelNotFound if (@model_config = @abstract_model.config).excluded?
+
       @properties = @abstract_model.properties
     end
 
     def get_object
-      raise(RailsAdmin::ObjectNotFound) unless (@object = @abstract_model.get(params[:id]))
+      raise RailsAdmin::ObjectNotFound unless (@object = @abstract_model.get(params[:id], @model_config.scope))
     end
 
     def to_model_name(param)

data/app/controllers/rails_admin/main_controller.rb

@@ -4,33 +4,16 @@ module RailsAdmin
     include RailsAdmin::MainHelper
     include RailsAdmin::ApplicationHelper
 
-    layout :get_layout
-
-    before_action :get_model, except: RailsAdmin::Config::Actions.all(:root).collect(&:action_name)
-    before_action :get_object, only: RailsAdmin::Config::Actions.all(:member).collect(&:action_name)
     before_action :check_for_cancel
 
-    RailsAdmin::Config::Actions.all.each do |action|
-      class_eval <<-EOS, __FILE__, __LINE__ + 1
-        def #{action.action_name}
-          action = RailsAdmin::Config::Actions.find('#{action.action_name}'.to_sym)
-          @authorization_adapter.try(:authorize, action.authorization_key, @abstract_model, @object)
-          @action = action.with({controller: self, abstract_model: @abstract_model, object: @object})
-          fail(ActionNotAllowed) unless @action.enabled?
-          @page_name = wording_for(:title)
-
-          instance_eval &@action.controller
-        end
-      EOS
-    end
-
     def bulk_action
-      send(params[:bulk_action]) if params[:bulk_action].in?(RailsAdmin::Config::Actions.all(controller: self, abstract_model: @abstract_model).select(&:bulkable?).collect(&:route_fragment))
+      get_model
+      process(params[:bulk_action]) if params[:bulk_action].in?(RailsAdmin::Config::Actions.all(:bulkable, controller: self, abstract_model: @abstract_model).collect(&:route_fragment))
     end
 
     def list_entries(model_config = @model_config, auth_scope_key = :index, additional_scope = get_association_scope_from_params, pagination = !(params[:associated_collection] || params[:all] || params[:bulk_ids]))
-      scope = model_config.abstract_model.scoped
-      if auth_scope = @authorization_adapter && @authorization_adapter.query(auth_scope_key, model_config.abstract_model)
+      scope = model_config.scope
+      if auth_scope = @authorization_adapter&.query(auth_scope_key, model_config.abstract_model)
         scope = scope.merge(auth_scope)
       end
       scope = scope.instance_eval(&additional_scope) if additional_scope
@@ -39,8 +22,36 @@ module RailsAdmin
 
   private
 
-    def get_layout
-      "rails_admin/#{request.headers['X-PJAX'] ? 'pjax' : 'application'}"
+    def action_missing(name, *_args)
+      action = RailsAdmin::Config::Actions.find(name.to_sym)
+      raise AbstractController::ActionNotFound.new("The action '#{name}' could not be found for #{self.class.name}") unless action
+
+      get_model unless action.root?
+      get_object if action.member?
+      @authorization_adapter.try(:authorize, action.authorization_key, @abstract_model, @object)
+      @action = action.with({controller: self, abstract_model: @abstract_model, object: @object})
+      raise(ActionNotAllowed) unless @action.enabled?
+
+      @page_name = wording_for(:title)
+
+      instance_eval(&@action.controller)
+    end
+
+    def method_missing(name, *args, &block)
+      action = RailsAdmin::Config::Actions.find(name.to_sym)
+      if action
+        action_missing name, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(sym, include_private)
+      if RailsAdmin::Config::Actions.find(sym)
+        true
+      else
+        super
+      end
     end
 
     def back_or_index
@@ -49,16 +60,14 @@ module RailsAdmin
 
     def get_sort_hash(model_config)
       abstract_model = model_config.abstract_model
-      params[:sort] = params[:sort_reverse] = nil unless model_config.list.fields.collect { |f| f.name.to_s }.include? params[:sort]
-      params[:sort] ||= model_config.list.sort_by.to_s
-      params[:sort_reverse] ||= 'false'
-
       field = model_config.list.fields.detect { |f| f.name.to_s == params[:sort] }
-      column = begin
-        if field.nil? || field.sortable == true # use params[:sort] on the base table
-          "#{abstract_model.table_name}.#{params[:sort]}"
-        elsif field.sortable == false # use default sort, asked field is not sortable
+
+      column =
+        if field.nil? || field.sortable == false # use default sort, asked field does not exist or is not sortable
+          field = model_config.list.possible_fields.detect { |f| f.name == model_config.list.sort_by.to_sym }
           "#{abstract_model.table_name}.#{model_config.list.sort_by}"
+        elsif field.sortable == true # use the given field
+          "#{abstract_model.table_name}.#{field.name}"
         elsif (field.sortable.is_a?(String) || field.sortable.is_a?(Symbol)) && field.sortable.to_s.include?('.') # just provide sortable, don't do anything smart
           field.sortable
         elsif field.sortable.is_a?(Hash) # just join sortable hash, don't do anything smart
@@ -68,10 +77,9 @@ module RailsAdmin
         else # use described column in the field conf.
           "#{abstract_model.table_name}.#{field.sortable}"
         end
-      end
 
-      reversed_sort = (field ? field.sort_reverse? : model_config.list.sort_reverse?)
-      {sort: column, sort_reverse: (params[:sort_reverse] == reversed_sort.to_s)}
+      params[:sort_reverse] ||= 'false'
+      {sort: column, sort_reverse: (params[:sort_reverse] == (field&.sort_reverse&.to_s || 'true'))}
     end
 
     def redirect_to_on_success
@@ -91,6 +99,7 @@ module RailsAdmin
 
     def sanitize_params_for!(action, model_config = @model_config, target_params = params[@abstract_model.param_key])
       return unless target_params.present?
+
       fields = visible_fields(action, model_config)
       allowed_methods = fields.collect(&:allowed_methods).flatten.uniq.collect(&:to_s) << 'id' << '_destroy'
       fields.each { |field| field.parse_input(target_params) }
@@ -110,20 +119,21 @@ module RailsAdmin
 
       respond_to do |format|
         format.html { render whereto, status: :not_acceptable }
-        format.js   { render whereto, layout: false, status: :not_acceptable }
+        format.js   { render whereto, layout: 'rails_admin/modal', status: :not_acceptable, content_type: Mime[:html].to_s }
       end
     end
 
     def check_for_cancel
       return unless params[:_continue] || (params[:bulk_action] && !params[:bulk_ids])
+
       redirect_to(back_or_index, notice: I18n.t('admin.flash.noaction'))
     end
 
     def get_collection(model_config, scope, pagination)
-      associations = model_config.list.fields.select { |f| f.try(:eager_load?) }.collect { |f| f.association.name }
+      eager_loads = model_config.list.fields.flat_map(&:eager_load_values)
       options = {}
       options = options.merge(page: (params[Kaminari.config.param_name] || 1).to_i, per: (params[:per] || model_config.list.items_per_page)) if pagination
-      options = options.merge(include: associations) unless associations.blank?
+      options = options.merge(include: eager_loads) unless eager_loads.blank?
       options = options.merge(get_sort_hash(model_config))
       options = options.merge(query: params[:query]) if params[:query].present?
       options = options.merge(filters: params[:f]) if params[:f].present?
@@ -133,10 +143,11 @@ module RailsAdmin
 
     def get_association_scope_from_params
       return nil unless params[:associated_collection].present?
+
       source_abstract_model = RailsAdmin::AbstractModel.new(to_model_name(params[:source_abstract_model]))
       source_model_config = source_abstract_model.config
       source_object = source_abstract_model.get(params[:source_object_id])
-      action = params[:current_action].in?(%w(create update)) ? params[:current_action] : 'edit'
+      action = params[:current_action].in?(%w[create update]) ? params[:current_action] : 'edit'
       @association = source_model_config.send(action).fields.detect { |f| f.name == params[:associated_collection].to_sym }.with(controller: self, object: source_object)
       @association.associated_collection_scope
     end