rails_admin 3.0.0 → 3.1.0.rc

data/lib/rails_admin/extensions/paper_trail/auditing_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/string/strip'
 
 module RailsAdmin
@@ -49,43 +51,63 @@ module RailsAdmin
           created_at: :created_at,
           message: :event,
         }.freeze
-        E_VERSION_MODEL_NOT_SET = <<-ERROR.strip_heredoc.freeze
+        E_USER_CLASS_NOT_SET = <<~ERROR
+          Please set up PaperTrail's user class explicitly.
+
+              config.audit_with :paper_trail do
+                user_class { User }
+              end
+        ERROR
+        E_VERSION_MODEL_NOT_SET = <<~ERROR
           Please set up PaperTrail's version model explicitly.
 
-              config.audit_with :paper_trail, 'User', 'PaperTrail::Version'
+              config.audit_with :paper_trail do
+                version_class { PaperTrail::Version }
+              end
 
           If you have configured a model to use a custom version class
           (https://github.com/paper-trail-gem/paper_trail#6a-custom-version-classes)
-          that configuration will take precedence over what you specify in
-          `audit_with`.
+          that configuration will take precedence over what you specify in `audit_with`.
         ERROR
 
+        include RailsAdmin::Config::Configurable
+
         def self.setup
           raise 'PaperTrail not found' unless defined?(::PaperTrail)
 
           RailsAdmin::Extensions::ControllerExtension.include ControllerExtension
         end
 
-        def initialize(controller, user_class = 'User', version_class = '::Version')
+        def initialize(controller, user_class_name = nil, version_class_name = nil, &block)
           @controller = controller
           @controller&.send(:set_paper_trail_whodunnit)
-          begin
-            @user_class = user_class.to_s.constantize
-          rescue NameError
-            raise "Please set up Papertrail's user model explicitly. Ex: config.audit_with :paper_trail, 'User'"
-          end
 
-          begin
-            @version_class = version_class.to_s.constantize
-          rescue NameError
-            raise E_VERSION_MODEL_NOT_SET
-          end
+          user_class { user_class_name.to_s.constantize } if user_class_name
+          version_class { version_class_name.to_s.constantize } if version_class_name
+
+          instance_eval(&block) if block
+        end
+
+        register_instance_option :user_class do
+          User
+        rescue NameError
+          raise E_USER_CLASS_NOT_SET
+        end
+
+        register_instance_option :version_class do
+          PaperTrail::Version
+        rescue NameError
+          raise E_VERSION_MODEL_NOT_SET
+        end
+
+        register_instance_option :sort_by do
+          {id: :desc}
         end
 
         def latest(count = 100)
-          @version_class.
-            order(id: :desc).includes(:item).limit(count).
-            collect { |version| VersionProxy.new(version, @user_class) }
+          version_class.
+            order(sort_by).includes(:item).limit(count).
+            collect { |version| VersionProxy.new(version, user_class) }
         end
 
         def delete_object(_object, _model, _user)
@@ -112,18 +134,18 @@ module RailsAdmin
 
         # - model - a RailsAdmin::AbstractModel
         def listing_for_model_or_object(model, object, query, sort, sort_reverse, all, page, per_page)
-          if sort.present?
-            sort = COLUMN_MAPPING[sort.to_sym]
-          else
-            sort = :created_at
-            sort_reverse = 'true'
-          end
+          sort =
+            if sort.present?
+              {COLUMN_MAPPING[sort.to_sym] => sort_reverse ? :desc : :asc}
+            else
+              sort_by
+            end
 
           current_page = page.presence || '1'
 
           versions = object.nil? ? versions_for_model(model) : object.public_send(model.model.versions_association_name)
           versions = versions.where('event LIKE ?', "%#{query}%") if query.present?
-          versions = versions.order(sort_reverse == 'true' ? "#{sort} DESC" : sort)
+          versions = versions.order(sort)
           versions = all ? versions : versions.send(Kaminari.config.page_method_name, current_page).per(per_page)
           paginated_proxies = Kaminari.paginate_array([], total_count: versions.try(:total_count) || versions.count)
           paginated_proxies = paginated_proxies.send(
@@ -131,7 +153,7 @@ module RailsAdmin
             current_page,
           ).per(per_page)
           versions.each do |version|
-            paginated_proxies << VersionProxy.new(version, @user_class)
+            paginated_proxies << VersionProxy.new(version, user_class)
           end
           paginated_proxies
         end
@@ -157,7 +179,7 @@ module RailsAdmin
         # has_paper_trail versions: { class_name: 'MyVersion' }
         # ```
         def version_class_for(model)
-          model.paper_trail_options.dig(:versions, :class_name).try(:constantize) || @version_class
+          model.paper_trail.version_class
         end
       end
     end

data/lib/rails_admin/extensions/paper_trail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/paper_trail/auditing_adapter'
 
 RailsAdmin.add_extension(:paper_trail, RailsAdmin::Extensions::PaperTrail, auditing: true)

data/lib/rails_admin/extensions/pundit/authorization_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Extensions
     module Pundit

data/lib/rails_admin/extensions/pundit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/pundit/authorization_adapter'
 
 RailsAdmin.add_extension(:pundit, RailsAdmin::Extensions::Pundit, authorization: true)

data/lib/rails_admin/support/csv_converter.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 require 'csv'
 
@@ -40,7 +41,7 @@ module RailsAdmin
 
     def to_csv(options = {})
       if CSV::VERSION == '3.0.2'
-        raise <<-MSG.gsub(/^\s+/, '')
+        raise <<~MSG
           CSV library bundled with Ruby 2.6.0 has encoding issue, please upgrade Ruby to 2.6.1 or later.
           https://github.com/ruby/csv/issues/62
         MSG

data/lib/rails_admin/support/datetime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Support
     class Datetime
@@ -50,7 +52,7 @@ module RailsAdmin
             when '%z' # Time zone as hour and minute offset from UTC (e.g. +0900)
               Time.zone.formatted_offset(false)
             else
-              FLATPICKR_TRANSLATIONS[match] or raise <<-MSG.gsub(/^\s{16}/, '')
+              FLATPICKR_TRANSLATIONS[match] or raise <<~MSG
                 Unsupported strftime directive '#{match}' was found. Please consider explicitly setting flatpickr_format instance option for the field.
                   field(:name_of_field) { flatpickr_format '...' }
               MSG

data/lib/rails_admin/support/es_module_processor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Support
+    class ESModuleProcessor
+      def self.instance
+        @instance ||= new
+      end
+
+      def self.call(input)
+        instance.call(input)
+      end
+
+      def initialize; end
+
+      def call(input)
+        return unless input[:name] == 'rails_admin/application'
+
+        input[:data].gsub(/^((?:import|export) .+)$/) { "// #{Regexp.last_match(1)}" }
+      end
+    end
+  end
+end

data/lib/rails_admin/support/hash_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   class HashHelper
     def self.symbolize(obj)

data/lib/rails_admin/version.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   class Version
     MAJOR = 3
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
-    PRE = nil
+    PRE = 'rc'
 
     class << self
       # @return [String]

data/lib/rails_admin.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'rails_admin/engine'
 require 'rails_admin/abstract_model'
 require 'rails_admin/config'
+require 'rails_admin/config/const_load_suppressor'
 require 'rails_admin/extension'
 require 'rails_admin/extensions/cancancan'
 require 'rails_admin/extensions/pundit'
@@ -10,6 +13,8 @@ require 'rails_admin/support/hash_helper'
 require 'yaml'
 
 module RailsAdmin
+  extend RailsAdmin::Config::ConstLoadSuppressor
+
   # Setup RailsAdmin
   #
   # Given the first argument is a model class, a model class name
@@ -17,7 +22,7 @@ module RailsAdmin
   #
   # If only a block is passed it is stored to initializer stack to be evaluated
   # on first request in production mode and on each request in development. If
-  # initialization has already occured (in other words RailsAdmin.setup has
+  # initialization has already occurred (in other words RailsAdmin.setup has
   # been called) the block will be added to stack and evaluated at once.
   #
   # Otherwise returns RailsAdmin::Config class.
@@ -27,7 +32,7 @@ module RailsAdmin
     if entity
       RailsAdmin::Config.model(entity, &block)
     elsif block_given?
-      RailsAdmin::Config.apply(&block)
+      RailsAdmin::Config::ConstLoadSuppressor.suppressing { yield(RailsAdmin::Config) }
     else
       RailsAdmin::Config
     end

data/lib/tasks/rails_admin.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :rails_admin do
   desc 'Install rails_admin'
   task :install do

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_admin",
-  "version": "3.0.0",
+  "version": "3.1.0-rc",
   "description": "RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.",
   "homepage": "https://github.com/railsadminteam/rails_admin",
   "license": "MIT",
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.16.7",
-    "@fortawesome/fontawesome-free": "^5.15.4",
+    "@fortawesome/fontawesome-free": "^6.1.1",
     "@hotwired/turbo-rails": "^7.1.0",
     "@popperjs/core": "^2.11.0",
     "@rails/ujs": "^6.1.4-1",

data/src/rails_admin/base.js

@@ -3,7 +3,19 @@ import "@hotwired/turbo-rails";
 import jQuery from "jquery";
 import "./vendor/jquery_nested_form";
 import "bootstrap";
-import "flatpickr/dist/flatpickr";
+
+// These jQuery-UI indirect dependencies need to be preloaded to be used within Import maps
+import "jquery-ui/ui/version.js";
+import "jquery-ui/ui/keycode.js";
+import "jquery-ui/ui/position.js";
+import "jquery-ui/ui/safe-active-element.js";
+import "jquery-ui/ui/data.js";
+import "jquery-ui/ui/ie.js";
+import "jquery-ui/ui/scroll-parent.js";
+import "jquery-ui/ui/unique-id.js";
+import "jquery-ui/ui/widget.js";
+import "jquery-ui/ui/widgets/menu.js";
+import "jquery-ui/ui/widgets/mouse.js";
 
 import "./filter-box";
 import "./filtering-multiselect";