rails_admin 3.3.0 → 4.0.0.beta

data/lib/rails_admin/config/model.rb

@@ -53,9 +53,29 @@ module RailsAdmin
         @excluded = !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
       end
 
-      def object_label
-        bindings[:object].send(object_label_method).presence ||
-          bindings[:object].send(:rails_admin_default_object_label_method)
+      # The label for one record: what object_label_method has to say about it.
+      # When it has nothing to say, +fallback+ if one is given; failing that, and
+      # for a model with no label method at all, a last resort built from the
+      # class and the id.
+      #
+      # Everything that shows a record by name goes through here, so that a
+      # record is called the same thing wherever it turns up.
+      #
+      # +fallback+ is positional because model configs are reached through
+      # proxies that do not forward keyword arguments.
+      def object_label(object = bindings[:object], fallback = nil)
+        return default_object_label(object) unless object_label_method
+
+        object.send(object_label_method).presence || fallback || default_object_label(object)
+      end
+
+      # What to call a record that has nothing to be called by.
+      #
+      # Models used to have to carry this themselves, as
+      # rails_admin_default_object_label_method, because it was reached by
+      # sending object_label_method to the record like any other label method.
+      def default_object_label(object)
+        object.new_record? ? "new #{object.class}" : "#{object.class} ##{object.id}"
       end
 
       # The display for a model instance (i.e. a single database record).
@@ -63,7 +83,9 @@ module RailsAdmin
       # any methods that may have been added to the label_methods array via Configuration.
       # Failing all of these, it'll return the class name followed by the model's id.
       register_instance_option :object_label_method do
-        @object_label_method ||= Config.label_methods.detect { |method| (@dummy_object ||= abstract_model.model.new).respond_to? method } || :rails_admin_default_object_label_method
+        # nil when the model answers to none of them, which #object_label reads
+        # as "nothing to call it by" and #default_object_label then handles.
+        @object_label_method ||= Config.label_methods.detect { |method| (@dummy_object ||= abstract_model.dummy_record).respond_to? method }
       end
 
       register_instance_option :label do
@@ -107,7 +129,7 @@ module RailsAdmin
       end
 
       register_instance_option :last_created_at do
-        abstract_model.model.last.try(:created_at) if abstract_model.properties.detect { |c| c.name == :created_at }
+        abstract_model.first(sort: abstract_model.primary_key).try(:created_at) if abstract_model.properties.detect { |c| c.name == :created_at }
       end
 
       # Act as a proxy for the base section configuration that actually

data/lib/rails_admin/config/sections/list.rb

@@ -46,17 +46,9 @@ module RailsAdmin
           ''
         end
 
-        register_deprecated_instance_option :sidescroll do
-          ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
-        end
-
         def fields_for_table
           visible_fields.partition(&:sticky?).flatten
         end
-
-        register_deprecated_instance_option :sort_reverse do
-          ActiveSupport::Deprecation.warn('The sort_reverse configuration option is deprecated and has no effect.')
-        end
       end
     end
   end

data/lib/rails_admin/config.rb

@@ -2,6 +2,7 @@
 
 require 'rails_admin/config/lazy_model'
 require 'rails_admin/config/sections/list'
+require 'rails_admin/support/asset_source'
 require 'rails_admin/support/composite_keys_serializer'
 require 'active_support/core_ext/module/attribute_accessors'
 
@@ -82,7 +83,9 @@ module RailsAdmin
       attr_accessor :navigation_static_links
       attr_accessor :navigation_static_label
 
-      # Set where RailsAdmin fetches JS/CSS from, defaults to :sprockets
+      # How RailsAdmin serves its JS/CSS: :propshaft / :sprockets (bundle shipped in the
+      # gem, no build step), :external (your app builds it), or a callable rendering the
+      # <head> tags itself. nil (default) auto-detects the pipeline.
       attr_writer :asset_source
 
       # For customization of composite keys representation
@@ -236,7 +239,8 @@ module RailsAdmin
           when Class, ConstLoadSuppressor::ConstProxy
             entity.name.to_sym
           when String, Symbol
-            entity.to_sym
+            # Class#name never has a leading '::', so strip it here too.
+            entity.to_s.delete_prefix('::').to_sym
           else
             entity.class.name.to_sym
           end
@@ -247,17 +251,7 @@ module RailsAdmin
       end
 
       def asset_source
-        @asset_source ||=
-          begin
-            detected = defined?(Sprockets) ? :sprockets : :invalid
-            unless ARGV.join(' ').include? 'rails_admin:install'
-              warn <<~MSG
-                [Warning] After upgrading RailsAdmin to 3.x you haven't set asset_source yet, using :#{detected} as the default.
-                To suppress this message, run 'rails rails_admin:install' to setup the asset delivery method suitable to you.
-              MSG
-            end
-            detected
-          end
+        @asset_source = RailsAdmin::Support::AssetSource.resolve(@asset_source)
       end
 
       def default_hidden_fields=(fields)
@@ -283,14 +277,6 @@ module RailsAdmin
         end
       end
 
-      def total_columns_width=(_)
-        ActiveSupport::Deprecation.warn('The total_columns_width configuration option is deprecated and has no effect.')
-      end
-
-      def sidescroll=(_)
-        ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
-      end
-
       # Setup actions to be used.
       def actions(&block)
         return unless block

data/lib/rails_admin/criteria/path.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Criteria
+    # An attribute addressed by name, optionally reached through associations:
+    # Path[:name], or Path[:team, :name] for the associated team's name.
+    #
+    # Fields say what to sort or search by in these terms and stop there. Each
+    # adapter decides what that means for its store -- a qualified column and a
+    # join, a two-step lookup by id, or a refusal. Before this, fields built
+    # "table.column" strings themselves, which forced the Mongoid adapter to
+    # take them apart again and guess what the prefix had meant.
+    #
+    # A path is not the same thing as one of those strings: its segments are
+    # association and attribute names, not table and column names. Legacy
+    # "table.column" values therefore stay as they are and are handed to the
+    # store untouched.
+    class Path
+      attr_reader :segments
+
+      def self.[](*segments)
+        new(segments)
+      end
+
+      def initialize(segments)
+        @segments = Array(segments).map(&:to_sym).freeze
+      end
+
+      # The attribute itself, the last segment of the path.
+      def attribute
+        segments.last
+      end
+
+      # The associations to travel through to reach the attribute, if any.
+      def associations
+        segments[0..-2]
+      end
+
+      # Whether the attribute belongs to the model the path starts from.
+      def root?
+        segments.size == 1
+      end
+
+      def to_a
+        segments
+      end
+
+      def to_s
+        segments.join('.')
+      end
+
+      def ==(other)
+        other.is_a?(Path) && segments == other.segments
+      end
+      alias eql? ==
+
+      def hash
+        segments.hash
+      end
+
+      def inspect
+        "#<RailsAdmin::Criteria::Path #{self}>"
+      end
+    end
+  end
+end

data/lib/rails_admin/criteria/period.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Criteria
+    # Resolves the period a date filter asks for into the two dates bounding it,
+    # so that what reaches a store is always absolute. Relative operators such as
+    # 'today' or 'this_week' are the config layer's vocabulary; no adapter needs
+    # to know them.
+    #
+    # Everything is read in the application time zone. Reading part of it from
+    # the system clock instead would let 'today' and 'yesterday' land on dates
+    # that are not a day apart whenever the two disagree.
+    class Period
+      def initialize(operator, value)
+        @operator = operator
+        @value = value
+      end
+
+      # [from, to], either of which may be nil for an open-ended period.
+      def bounds
+        case @operator
+        when 'between'   then between
+        when 'today'     then today
+        when 'yesterday' then yesterday
+        when 'this_week' then this_week
+        when 'last_week' then last_week
+        else default
+        end
+      end
+
+    private
+
+      def today
+        [Date.current, Date.current]
+      end
+
+      def yesterday
+        [Date.current.yesterday, Date.current.yesterday]
+      end
+
+      def this_week
+        [Date.current.beginning_of_week, Date.current.end_of_week]
+      end
+
+      def last_week
+        last_week_day = Date.current - 1.week
+        [last_week_day.beginning_of_week, last_week_day.end_of_week]
+      end
+
+      # The filter UI submits three values, of which the last two are the bounds.
+      # A hand-written URL may carry fewer, or none at all, leaving the period
+      # open at both ends -- which every caller already handles.
+      def between
+        bounds = Array.wrap(@value)
+        [bounds[1], bounds[2]]
+      end
+
+      def default
+        [default_date, default_date]
+      end
+
+      def default_date
+        Array.wrap(@value).first
+      end
+    end
+  end
+end

data/lib/rails_admin/engine.rb

@@ -12,14 +12,16 @@ module RailsAdmin
   class Engine < Rails::Engine
     isolate_namespace RailsAdmin
 
-    attr_accessor :importmap
-
     config.action_dispatch.rescue_responses['RailsAdmin::ActionNotAllowed'] = :forbidden
 
     initializer 'RailsAdmin load UrlForExtension' do
       RailsAdmin::Engine.routes.singleton_class.prepend(RailsAdmin::Extensions::UrlForExtension)
     end
 
+    initializer 'RailsAdmin deprecator' do |app|
+      app.deprecators[:rails_admin] = RailsAdmin.deprecator if app.respond_to?(:deprecators)
+    end
+
     initializer 'RailsAdmin reload config in development' do |app|
       config.initializer_path = app.root.join('config/initializers/rails_admin.rb')
 
@@ -40,19 +42,13 @@ module RailsAdmin
       end
     end
 
-    initializer 'RailsAdmin precompile hook', group: :all do |app|
-      case RailsAdmin.config.asset_source
-      when :sprockets
-        app.config.assets.precompile += %w[
-          rails_admin/application.js
-          rails_admin/application.css
-        ]
-        app.config.assets.paths << RailsAdmin::Engine.root.join('src')
-        require 'rails_admin/support/es_module_processor'
-        Sprockets.register_bundle_processor 'application/javascript', RailsAdmin::Support::ESModuleProcessor
-      when :importmap
-        self.importmap = Importmap::Map.new.draw(app.root.join('config/importmap.rails_admin.rb'))
-      end
+    initializer 'RailsAdmin assets', group: :all do |app|
+      next unless app.config.respond_to?(:assets)
+
+      builds_path = RailsAdmin::Engine.root.join('app/assets/builds').to_s
+      app.config.assets.paths << builds_path unless app.config.assets.paths.include?(builds_path)
+
+      app.config.assets.precompile += %w[rails_admin.js rails_admin.css] if RailsAdmin.config.asset_source == :sprockets
     end
 
     # Check for required middlewares, users may forget to use them in Rails API mode

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

@@ -42,9 +42,9 @@ module RailsAdmin
         # and bulk_delete/destroy actions and should return a scope which limits the records
         # to those which the user can perform the given action on.
         def query(_action, abstract_model)
-          @controller.send(:policy_scope, abstract_model.model.all)
+          @controller.send(:policy_scope, abstract_model.scoped)
         rescue ::Pundit::NotDefinedError
-          abstract_model.model.all
+          abstract_model.scoped
         end
 
         # This is called in the new/create actions to determine the initial attributes for new

data/lib/rails_admin/extensions/url_for_extension.rb

@@ -2,6 +2,14 @@
 
 module RailsAdmin
   module Extensions
+    # Writes a composite id into a URL for callers that hand url_for the id
+    # straight from a record.
+    #
+    # Everywhere RailsAdmin knows which model an id belongs to it asks that
+    # model's repository instead, which is the only place that decides how an id
+    # is written down. This is the net underneath: by the time url_for sees the
+    # id there is no model left to ask, so it can only fall back to the globally
+    # configured serializer.
     module UrlForExtension
       def url_for(options, *args)
         case options[:id]

data/lib/rails_admin/support/asset_source.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Support
+    # Resolves the value of RailsAdmin.config.asset_source: passes through the
+    # supported values, auto-detects when unset, maps deprecated values and
+    # rejects the removed ones.
+    module AssetSource
+      class << self
+        def resolve(value)
+          return value if value.respond_to?(:call)
+
+          case value
+          when :propshaft, :sprockets, :external
+            value
+          when nil
+            detect
+          when :webpack
+            warn '[RailsAdmin] config.asset_source = :webpack is deprecated, use :external instead.'
+            :external
+          when :importmap
+            warn '[RailsAdmin] config.asset_source = :importmap is deprecated; RailsAdmin ships a prebuilt bundle now. ' \
+                 'Use :propshaft / :sprockets or remove the setting.'
+            detect
+          when :webpacker, :vite
+            raise "config.asset_source = :#{value} is no longer supported. Serve the bundled assets with " \
+                  ':propshaft / :sprockets, build them yourself with :external, or pass a callable.'
+          else
+            raise "Unknown config.asset_source: #{value.inspect}"
+          end
+        end
+
+        def detect
+          return :propshaft if defined?(Propshaft)
+          return :sprockets if defined?(Sprockets)
+
+          :propshaft
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin/support/composite_keys_serializer.rb

@@ -2,14 +2,40 @@
 
 module RailsAdmin
   module Support
+    # Writes the values of a composite primary key as one string, and reads it
+    # back.
+    #
+    # The delimiter is the one ActiveRecord joins a composite id with, so an
+    # ordinary key comes out looking exactly like the record's own to_param. A
+    # key value is free to contain the delimiter, though, so it is escaped to a
+    # form that cannot: the escape character followed by the byte in hex.
+    #
+    # Doubling the delimiter, which is what this used to do, cannot be undone --
+    # ["a_", "b"] and ["a", "_b"] both come out as "a___b". Values holding a
+    # delimiter have therefore never round-tripped; nothing else changes shape.
     module CompositeKeysSerializer
+      DELIMITER = '_'
+      ESCAPE = '~' # unreserved in a URI, so it survives a path segment as it is
+      UNSAFE = /[#{Regexp.escape(ESCAPE + DELIMITER)}]/.freeze
+      ESCAPED = /#{Regexp.escape(ESCAPE)}([0-9A-Fa-f]{2})/.freeze
+
       def self.serialize(keys)
-        keys.map { |key| key&.to_s&.gsub('_', '__') }.join('_')
+        keys.map { |key| escape(key) }.join(DELIMITER)
       end
 
       def self.deserialize(string)
-        string.split('_').map { |key| key&.gsub('__', '_') }
+        string.split(DELIMITER, -1).map { |key| unescape(key) }
+      end
+
+      def self.escape(key)
+        key&.to_s&.gsub(UNSAFE) { |char| format('%s%02X', ESCAPE, char.ord) }
       end
+
+      def self.unescape(key)
+        key&.gsub(ESCAPED) { Regexp.last_match(1).hex.chr }
+      end
+
+      private_class_method :escape, :unescape
     end
   end
 end

data/lib/rails_admin/support/csv_converter.rb

@@ -9,7 +9,8 @@ module RailsAdmin
       @associations = []
       schema ||= {}
 
-      return self if (@objects = objects).blank?
+      # Not blank?, which loads a relation whole just to find out.
+      return self if (@objects = objects).nil? || objects.empty?
 
       @model = objects.dup.first.class
       @abstract_model = RailsAdmin::AbstractModel.new(@model)
@@ -39,13 +40,6 @@ module RailsAdmin
     end
 
     def to_csv(options = {})
-      if CSV::VERSION == '3.0.2'
-        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
-      end
-
       options = HashWithIndifferentAccess.new(options)
       encoding_to = Encoding.find(options[:encoding_to]) if options[:encoding_to].present?
 
@@ -70,12 +64,11 @@ module RailsAdmin
 
     def generate_csv_string(options)
       generator_options = (options[:generator] || {}).symbolize_keys.delete_if { |_, value| value.blank? }
-      method = @objects.respond_to?(:find_each) ? :find_each : :each
 
       CSV.generate(**generator_options) do |csv|
         csv << generate_csv_header unless options[:skip_header]
 
-        @objects.send(method) do |object|
+        @abstract_model&.each_record(@objects) do |object|
           csv << generate_csv_row(object)
         end
       end

data/lib/rails_admin/version.rb

@@ -2,10 +2,10 @@
 
 module RailsAdmin
   class Version
-    MAJOR = 3
-    MINOR = 3
+    MAJOR = 4
+    MINOR = 0
     PATCH = 0
-    PRE = nil
+    PRE = 'beta'
 
     class << self
       # @return [String]
@@ -18,8 +18,9 @@ module RailsAdmin
       end
 
       def actual_js_version
-        case RailsAdmin.config.asset_source
-        when :webpacker, :webpack
+        # :propshaft / :sprockets serve the bundle shipped in the gem, which always matches.
+        # Only an app-built (:external) setup can drift from the gem's expected version.
+        if RailsAdmin.config.asset_source == :external
           js_version_from_node_modules
         else
           js
@@ -33,7 +34,7 @@ module RailsAdmin
         when js
           # Good
         when nil
-          warn "[Warning] Failed to detect RailsAdmin npm package, did you run 'yarn install'?"
+          warn '[Warning] Failed to detect the RailsAdmin npm package, did you install it?'
         else
           warn <<~MSG
             [Warning] RailsAdmin npm package version inconsistency detected, expected #{js} but actually used is #{actual_js_version}.

data/lib/rails_admin.rb

@@ -38,6 +38,13 @@ module RailsAdmin
     end
   end
 
+  # RailsAdmin's own deprecation warnings go through this, so an application can
+  # configure or silence them independently. Registered as
+  # +app.deprecators[:rails_admin]+ on Rails 7.1+.
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('5.0', 'RailsAdmin')
+  end
+
   # Backwards-compatible with safe_yaml/load when SafeYAML isn't available.
   # Evaluates available YAML loaders at boot and creates appropriate method,
   # so no conditionals are required at runtime.

data/lib/tasks/assets.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace :rails_admin do
+  desc 'Compile the precompiled assets shipped with the gem (app/assets/builds)'
+  task :build_assets do
+    Dir.chdir(File.expand_path('../..', __dir__)) do
+      abort 'npm is required to build RailsAdmin assets' unless system('npm --version', out: File::NULL)
+      abort 'npm ci failed' unless system('npm ci --silent')
+      abort 'Asset build failed' unless system('npm run build')
+    end
+  end
+
+  desc 'Fail if the committed assets in app/assets/builds are out of date'
+  task verify_assets: :build_assets do
+    Dir.chdir(File.expand_path('../..', __dir__)) do
+      diff = `git diff --stat -- app/assets/builds`
+      unless diff.empty?
+        warn "app/assets/builds is out of date. Run `npm run build` and commit the result:\n#{diff}"
+        abort
+      end
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_admin",
-  "version": "3.3.0",
+  "version": "4.0.0-beta",
   "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",
@@ -8,23 +8,28 @@
   "files": [
     "src"
   ],
+  "type": "module",
   "main": "src/rails_admin/base.js",
+  "sass": "src/rails_admin/styles/base.scss",
   "scripts": {
-    "link": "yarn link && cd spec/dummy_app && yarn link rails_admin",
-    "format": "prettier -w ."
+    "build": "node bin/build.js",
+    "format": "prettier -w .",
+    "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@babel/runtime": "^7.16.7",
     "@fortawesome/fontawesome-free": ">=5.15.0 <7.0.0",
-    "@hotwired/turbo-rails": "^7.1.0",
+    "@hotwired/turbo-rails": "^8.0.21",
     "@popperjs/core": "^2.11.0",
-    "@rails/ujs": "^6.1.4-1",
+    "@rails/actiontext": "^7.1.0",
+    "@rails/activestorage": "^7.1.0",
     "bootstrap": "^5.1.3",
     "flatpickr": "^4.6.9",
     "jquery": "^3.6.0",
     "jquery-ui": "^1.12.1 <1.14.0"
   },
   "devDependencies": {
-    "prettier": "^2.4.1"
+    "esbuild": "^0.25.0",
+    "prettier": "^2.4.1",
+    "sass": "^1.83.0"
   }
 }

data/src/rails_admin/base.js

@@ -1,7 +1,12 @@
-import Rails from "@rails/ujs";
 import "@hotwired/turbo-rails";
-import "./jquery";
-import "./vendor/jquery_nested_form";
+import * as ActiveStorage from "@rails/activestorage";
+// The ActionText glue (~5 KB) so rich-text attachment uploads work out of the box.
+// Trix itself is not bundled - widgets.js loads it from a CDN when a <trix-editor>
+// appears without window.Trix. Bundle Trix yourself (asset_source :external) to
+// avoid the CDN entirely.
+import "@rails/actiontext";
+import "./jquery.js";
+import "./vendor/jquery_nested_form.js";
 import "bootstrap";
 
 // These jQuery-UI indirect dependencies need to be preloaded to be used within Import maps
@@ -17,16 +22,14 @@ import "jquery-ui/ui/widget.js";
 import "jquery-ui/ui/widgets/menu.js";
 import "jquery-ui/ui/widgets/mouse.js";
 
-import "./abstract-select";
-import "./filter-box";
-import "./filtering-multiselect";
-import "./filtering-select";
-import "./nested-form-hooks";
-import "./remote-form";
-import "./sidescroll";
-import "./ui";
-import "./widgets";
+import "./abstract-select.js";
+import "./filter-box.js";
+import "./filtering-multiselect.js";
+import "./filtering-select.js";
+import "./nested-form-hooks.js";
+import "./remote-form.js";
+import "./sidescroll.js";
+import "./ui.js";
+import "./widgets.js";
 
-if (!window._rails_loaded) {
-  Rails.start();
-}
+ActiveStorage.start();

data/src/rails_admin/filter-box.js

@@ -1,6 +1,6 @@
 import jQuery from "jquery";
-import I18n from "./i18n";
-import flatpickr from "flatpickr";
+import I18n from "./i18n.js";
+import flatpickr from "./flatpickr.js";
 
 (function ($) {
   var filters;
@@ -102,7 +102,10 @@ import flatpickr from "flatpickr";
                 $(this).attr("selected", true);
             });
             if (multiple)
-              control.find("option[value^=_],option[disabled]").hide();
+              control
+                .find("option[value^=_],option[disabled]")
+                .hide()
+                .prop("selected", false);
           }
           break;
         case "citext":
@@ -311,7 +314,7 @@ import flatpickr from "flatpickr";
     e.preventDefault();
     $.filters.append(
       $.extend(
-        { index: $.now().toString().slice(6, 11) },
+        { index: Date.now().toString().slice(6, 11) },
         $(this).data("options")
       )
     );

data/src/rails_admin/filtering-multiselect.js

@@ -1,6 +1,6 @@
 import jQuery from "jquery";
 import "jquery-ui/ui/widget.js";
-import I18n from "./i18n";
+import I18n from "./i18n.js";
 
 (function ($) {
   $.widget("ra.filteringMultiselect", $.ra.abstractSelect, {