active_scaffold 4.4.0 → 4.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cafbb1cbb0273e33d48ba6efb723a4ac6abd3678c559031bbc10d1b608f61ad5
-  data.tar.gz: 7e835a08a8b21df39301360a62db0257826b5e1a654c18ef2e8fbc92d4278436
+  metadata.gz: b212c764ce6307b7968f811cd89c2042b8cb5d1f79b448ddd838360efc8375ab
+  data.tar.gz: 4f44ea2e0e00189d67f4027e95decea8b3589e5f3d372d1c53cd289ca70188c7
 SHA512:
-  metadata.gz: 475d62edc638cfefd7d43bf86a033d842f387968d9e90fc83b61b3da5cfc3f688e3ab8ee200ba7a56f7cebfe9659ad108494618207104ff65b1c9bad67a738c9
-  data.tar.gz: b4eb39a97611806f10c625111a41aa67061d35093c5caae3f89673516f3785c1692d04a3e87de3f7e8174a0b286818c10a253ec449d10f1ab8aada1ef1547cbd
+  metadata.gz: 264149ca1905e0bae13b93a71a3720d9e09d3b2bae57b15a702474dfb40d2d8fad33ea04a8708991d6c983ef6c45159a5fd7133ad143cf95e3d5c74f5b830a34
+  data.tar.gz: b8bf1c62d6fc8e9063ccb46df88709630a0ce6d1eb9edebcb3058df8e43535f7e0420a4781614bd479197f00f5cdcce423bf1298b15ddd264515701fa7c83b03

data/CHANGELOG.rdoc

@@ -1,3 +1,21 @@
+= 4.4.4
+- Fix the inconsistent behaviour for constraints containing an array with only one value
+- Wait for dynamically loaded plugins and bridges to finish registering their ready and setup callbacks before initial setup, fixing initialization on directly rendered forms
+- Show all association records in select and multi-select search UIs instead of applying form association conditions
+
+= 4.4.3 (yanked)
+- Yanked because it accidentally included unreleased 4.5 functionality
+
+= 4.4.2 (yanked)
+- Yanked because it accidentally included unreleased 4.5 functionality
+
+= 4.4.1
+- Avoid unnecessary DISTINCT in searches without joins or with only belongs_to joins, fixing PostgreSQL searches on models with json columns
+- Update install generator for the supported rails versions and asset pipelines
+- Fix rendering field descriptions and tabbed forms when custom input helpers return frozen strings
+- Fix inline action links with rails-ujs on Rails 8.1 by inserting the raw HTML response instead of its parsed Document
+- Preserve nested ActiveScaffold session changes with activerecord-session_store 2.3.0
+
 = 4.4.0
 - Add support for local sorting using JS when the list has no pagination
 - Add UI rendering customization for CSS framework and theme integration: configure tags and HTML attributes for named elements, use context-aware procs, and override focused helpers when structural markup must change

data/README.md

@@ -41,11 +41,9 @@ Add jquery-rails to Gemfile, or handle jquery with other tools like webpack or i
 gem 'jquery-rails'
 ```
 
-For rails 7.x, install generator will add `active_scaffold` to `config/importmap.rb`, `app/javascript/application.js`, and `active_scaffold/manifest.js` to `app/assets/config/manifest.js`. It will add `jquery` and `jquery_ujs` to all the 3 files if jquery-rails gem is available.
+On supported Rails versions (7.2 and 8.x), the install generator adds the ActiveScaffold route concerns and the lines required to load its JavaScript and stylesheets for the detected asset pipeline. With import maps, this includes both the pins in `config/importmap.rb` and the imports in `app/javascript/application.js`. With Propshaft, it adds the required helpers to the application layout; with Sprockets, it updates the asset manifests instead.
 
-For rails 6.1, install generator will create `app/assets/javascripts/application.js`, add it, and `active_scaffold/manifest.js`, to `app/assets/config/manifest.js` and add `javascript_include_tag` in the layout, as ActiveScaffold doesn't work with webpack. It will add `jquery` to `app/assets/javascripts/application.js` too if query-rails gem is available, although Jquery may be loaded by packs too and it will work, it won't add `jquery_ujs` or `@rails/ujs` as it's added to `app/javascript/packs/application.js` by default.
-
--- TODO: Add notes about dartsass-rails for propshaft or dartsass-sprockets for sprockets.
+For Dart Sass, the generator adds the appropriate `@use` line to `app/assets/stylesheets/application.scss`. It can also update an older `application.css` or `application.css.erb` that contains Sprockets require directives. If `jquery-rails` is installed, the generator adds `jquery` and `jquery_ujs` to the same JavaScript setup. The exact lines for each supported setup are described in [Stylesheet Loading](#stylesheet-loading) and [Javascript Loading](#javascript-loading).
 
 Run the following commands
 
@@ -131,7 +129,7 @@ In the layout, load the importmap modules and call active_scaffold_javascript_ta
     <%= active_scaffold_javascript_tag %>
 ```
 
-### Propshaft
+### Propshaft without import maps
 
 If you're not using importmaps, then you can load the JS files individually, but you only need to load jquery and jquery_ujs or rails_ujs, and then call active_scaffold_javascript_tag:
 

data/app/assets/javascripts/active_scaffold/active_scaffold.js

@@ -1339,7 +1339,12 @@
         return true;
       });
       jQuery(document).on('ajax:success', 'a.as_action', function(event, response) {
-        if (event.detail && !response) response = event.detail[0];
+        if (event.detail && !response) {
+          response = event.detail[0];
+          // rails-ujs parses text/html responses into a Document, which cannot be inserted and
+          // loses table rows parsed outside a table, so use the raw response from the XHR.
+          if (response instanceof Document && event.detail[2]) response = event.detail[2].responseText;
+        }
         var action_link = ActiveScaffold.ActionLink.get(jQuery(this));
         if (action_link) {
           if (action_link.position) {
@@ -1690,8 +1695,10 @@
 
       // call setup on document.ready if Turbolinks not enabled
       if ((typeof(Turbolinks) == 'undefined' || !Turbolinks.supported) && typeof(Turbo) == 'undefined') {
-        ActiveScaffold.setup_history_state();
-        ActiveScaffold.setup(document);
+        if (!ActiveScaffold.config.deferInitialSetup) {
+          ActiveScaffold.setup_history_state();
+          ActiveScaffold.setup(document);
+        }
       }
       if (ActiveScaffold.config.warn_changes) ActiveScaffold.setup_warn_changes();
       jQuery(document).on('as:element_updated as:element_created', function(e, action_link) {
@@ -1727,7 +1734,7 @@
     });
 
     jQuery(document).on('turbolinks:load turbo:load', function($) {
-      ActiveScaffold.setup(document);
+      if (!ActiveScaffold.config.deferInitialSetup) ActiveScaffold.setup(document);
     });
     jQuery(window).on('scroll resize', ActiveScaffold.update_floating_form_footer);
   };

data/app/assets/javascripts/active_scaffold/load.js

@@ -1,6 +1,10 @@
 // ActiveScaffold main entry point
 (function() {
   const config = window.ActiveScaffold?.config || {};
+  config.deferInitialSetup = true;
+  const scriptLoads = new Map();
+  const readyHeld = typeof window.jQuery?.holdReady === 'function';
+  if (readyHeld) window.jQuery.holdReady(true);
 
   // Load dependencies based on configuration
   const loadDependencies = async () => {
@@ -17,23 +21,14 @@
     await loadScript(RAILS_ASSET_URL('/active_scaffold/active_scaffold.js'));
     await loadScript(RAILS_ASSET_URL('/active_scaffold/jquery.editinplace.js'));
 
-    // Load plugins
-    if (config.plugins) {
-      for (const plugin of config.plugins) {
-        await loadScript(plugin);
-      }
-    }
-
-    // Load bridges
-    if (config.bridges) {
-      for (const bridge of config.bridges) {
-        await loadScript(bridge);
-      }
-    }
+    // Load plugins and bridges in order. Some of them depend on scripts loaded
+    // before them and register callbacks while they are being evaluated.
+    await loadScripts(config.plugins);
+    await loadScripts(config.bridges);
 
     // ALL DEPENDENCIES ARE LOADED NOW
     // Initialize everything
-    initializeActiveScaffold();
+    await initializeActiveScaffold();
   };
 
   const loadJQueryUI = async () => {
@@ -57,8 +52,16 @@
     initializeJQueryUI();
   };
 
+  const loadScripts = async (paths = []) => {
+    for (const path of paths || []) {
+      await loadScript(path);
+    }
+  };
+
   const loadScript = (path) => {
-    return new Promise((resolve, reject) => {
+    if (scriptLoads.has(path)) return scriptLoads.get(path);
+
+    const promise = new Promise((resolve, reject) => {
       // Check if already loaded
       if (document.querySelector(`script[src*="${path}"]`)) {
         resolve();
@@ -72,6 +75,9 @@
       script.onerror = reject;
       document.head.appendChild(script);
     });
+
+    scriptLoads.set(path, promise);
+    return promise;
   };
 
   const initializeJQueryUI = function() {
@@ -100,13 +106,26 @@
     }
   };
 
-  // NEW: Initialize everything after all scripts are loaded
-  const initializeActiveScaffold = () => {
-    // Run any post-load initialization
-    if (window.jQuery) {
-      jQuery(document).trigger('active-scaffold:loaded');
+  // Initialize only after plugins and bridges are available. This is especially
+  // important when this file is loaded as a regular script after DOM ready.
+  const initializeActiveScaffold = () => new Promise((resolve) => {
+    if (!window.jQuery || !window.ActiveScaffold) {
+      resolve();
+      return;
     }
-  };
+
+    jQuery(function() {
+      config.deferInitialSetup = false;
+      if ((typeof(Turbolinks) == 'undefined' || !Turbolinks.supported) && typeof(Turbo) == 'undefined') {
+        ActiveScaffold.setup_history_state();
+      }
+      ActiveScaffold.setup(document);
+      jQuery(document).trigger('active-scaffold:loaded');
+      resolve();
+    });
+
+    if (readyHeld) window.jQuery.holdReady(false);
+  });
 
   // Start loading when DOM is ready
   if (document.readyState === 'loading') {
@@ -114,4 +133,4 @@
   } else {
     loadDependencies();
   }
-})();
+})();

data/lib/active_scaffold/actions/common_search.rb

@@ -35,7 +35,7 @@ module ActiveScaffold::Actions
       end
 
       def set_outer_joins_for_search(columns) # rubocop:disable Naming/AccessorMethodName
-        active_scaffold_outer_joins.concat columns.flat_map(&:search_joins).uniq
+        active_scaffold_outer_joins.concat columns.flat_map(&:search_joins).compact.uniq
       end
 
       def store_search_params_into_session

data/lib/active_scaffold/constraints.rb

@@ -163,8 +163,9 @@ module ActiveScaffold
       elsif association.polymorphic?
         apply_constraint_on_polymorphic_association(record, association, value)
       elsif !association.source_reflection&.through? && # regular singular association, or one-level through association
-            !value.is_a?(Array)
-        record.send(:"#{association.name}=", association.klass.find(value))
+            (!value.is_a?(Array) || value.size == 1)
+        constraint_value = value.is_a?(Array) ? value.first : value
+        record.send(:"#{association.name}=", association.klass.find(constraint_value))
 
         # setting the belongs_to side of a has_one isn't safe. if the has_one was already
         # specified, rails won't automatically clear out the previous associated record.

data/lib/active_scaffold/engine.rb

@@ -57,6 +57,12 @@ module ActiveScaffold
       require 'active_scaffold/extensions/paginator_extensions'
     end
 
+    initializer 'active_scaffold.active_record_session_store', after: :load_config_initializers do |app|
+      require 'active_scaffold/extensions/active_record_session_store'
+      extension = ActiveScaffold::Extensions::ActiveRecordSessionStore
+      ActiveScaffold::Core.prepend(extension::Core) if extension.affected?(app)
+    end
+
     initializer 'active_scaffold.assets' do |app|
       if defined?(::Sprockets)
         # Tell sprockets where your assets are located

data/lib/active_scaffold/extensions/active_record_session_store.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActiveScaffold
+  module Extensions
+    module ActiveRecordSessionStore
+      AFFECTED_VERSION = Gem::Version.new('2.3.0')
+
+      # activerecord-session_store 2.3.0 keeps references to nested values in
+      # the request session, so in-place changes can also alter the value used
+      # for dirty comparison. Keep ActiveScaffold's request storage detached.
+      module Core
+        def active_scaffold_session_storage(id = nil)
+          session_index = active_scaffold_session_storage_key(id)
+          @active_scaffold_session_storage ||= {}
+
+          storage = @active_scaffold_session_storage[session_index]
+          return storage if storage && session[session_index].equal?(storage)
+
+          storage = session[session_index]&.deep_dup || {}
+          session[session_index] = storage
+          @active_scaffold_session_storage[session_index] = storage
+        end
+      end
+
+      def self.affected?(application = Rails.application)
+        store_class = active_record_store
+        version = session_store_version
+        return false unless store_class && version
+
+        configured_store = application.config.session_store
+        uses_active_record_store =
+          configured_store == store_class ||
+          (configured_store.is_a?(Class) && configured_store < store_class)
+
+        uses_active_record_store && Gem::Version.new(version) == AFFECTED_VERSION
+      end
+
+      def self.active_record_store
+        ::ActionDispatch::Session::ActiveRecordStore if defined?(::ActionDispatch::Session::ActiveRecordStore)
+      end
+      private_class_method :active_record_store
+
+      def self.session_store_version
+        ::ActiveRecord::SessionStore::VERSION if defined?(::ActiveRecord::SessionStore::VERSION)
+      end
+      private_class_method :session_store_version
+    end
+  end
+end

data/lib/active_scaffold/finder.rb

@@ -776,7 +776,14 @@ module ActiveScaffold
     end
 
     def distinct_query?(options)
-      options[:left_outer_joins].present? || options[:left_joins].present?
+      joins = [options[:left_outer_joins], options[:left_joins]].flatten.compact
+      model = active_scaffold_config.model
+
+      joins.any? do |join|
+        next true unless join.is_a?(Symbol)
+
+        model.reflect_on_association(join)&.macro != :belongs_to
+      end
     end
 
     def joins_for_finder

data/lib/active_scaffold/helpers/form_column_helpers.rb

@@ -259,12 +259,12 @@ module ActiveScaffold
           if column.association.nil? || column.association.belongs_to?
             # hidden field probably not needed, but leaving it just in case
             # but it isn't working for assocations which are not belongs_to
-            field << hidden_field(:record, column.association&.foreign_key || column.name, column_options)
+            field = safe_join([field, hidden_field(:record, column.association&.foreign_key || column.name, column_options)])
           end
         else
           field ||= active_scaffold_input_for column, scope, column_options, form_columns: form_columns
         end
-        field << loading_indicator_tag(action: :render_field, id: params[:id]) if field && column.update_columns
+        field = safe_join([field, loading_indicator_tag(action: :render_field, id: params[:id])]) if field && column.update_columns
         description = column_description(column, record, scope)
 
         label = label_tag(label_for(column, column_options), form_column_label(column, record, scope))
@@ -273,7 +273,7 @@ module ActiveScaffold
       end
 
       def form_attribute_html(column, label, field, description, attributes, collapsible_id: nil)
-        (field ||= h('')) << description if description.present?
+        field = safe_join([field, description].compact) if description.present?
         context = {column: column}
         as_element :form_attribute, proc_options: context, **attributes do
           as_element(:form_attribute_label, label, proc_options: context) <<

data/lib/active_scaffold/helpers/search_column_helpers.rb

@@ -93,7 +93,7 @@ module ActiveScaffold
           associated.collect!(&:to_i)
           method = ui_options[:label_method] || :to_label
           helper_method = association_helper_method(column.association, :sorted_association_options_find)
-          select_options = send(helper_method, column.association, nil, record).collect do |r|
+          select_options = send(helper_method, column.association, {}, record).collect do |r|
             [r.send(method), r.id]
           end
         else
@@ -119,7 +119,7 @@ module ActiveScaffold
           associated = associated.is_a?(Array) ? associated.map(&:to_i) : associated.to_i unless associated.nil?
           method = column.association.belongs_to? ? column.association.foreign_key : column.name
           helper_method = association_helper_method(column.association, :sorted_association_options_find)
-          select_options = send(helper_method, column.association, false, record)
+          select_options = send(helper_method, column.association, {}, record)
         else
           method = column.name
           select_options = active_scaffold_translated_enum_options(column, record, ui_options: ui_options)

data/lib/active_scaffold/helpers/tabs_helpers.rb

@@ -10,9 +10,11 @@ module ActiveScaffold
         tab_options = send(override_helper_per_model(:active_scaffold_tab_options, record.class), column, record)
         used_tabs = send(override_helper_per_model(:active_scaffold_current_tabs, record.class), column, record, tab_options)
         input_helper = override_helper_per_model(:active_scaffold_input_for_tabbed, record.class)
-        send(input_helper, column, record, subsection_id, tab_options, used_tabs.map { |v, _| v }) <<
-          active_scaffold_refresh_link(nil, {'data-update_url' => url_for(add_tab_url)}, record, refresh_opts) <<
-          active_scaffold_tabs_for(column, record, subsection_id, tab_options, used_tabs, &)
+        safe_join([
+                    send(input_helper, column, record, subsection_id, tab_options, used_tabs.map { |v, _| v }),
+                    active_scaffold_refresh_link(nil, {'data-update_url' => url_for(add_tab_url)}, record, refresh_opts),
+                    active_scaffold_tabs_for(column, record, subsection_id, tab_options, used_tabs, &)
+                  ])
       end
 
       def active_scaffold_input_for_tabbed(column, record, subsection_id, tab_options, used_tabs)

data/lib/active_scaffold/version.rb

@@ -4,7 +4,7 @@ module ActiveScaffold
   module Version
     MAJOR = 4
     MINOR = 4
-    PATCH = 0
+    PATCH = 4
     FIX = nil
 
     STRING = [MAJOR, MINOR, PATCH, FIX].compact.join('.')

data/lib/generators/active_scaffold/install/install_generator.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
 require 'rails/generators/base'
-# require 'generators/active_scaffold_controller/active_scaffold_controller_generator'
 
 module ActiveScaffold
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      IMPORTMAP = 'config/importmap.rb'
+      JS_ASSET = 'app/assets/javascripts/application.js'
+      JS_APP = 'app/javascript/application.js'
+      LAYOUT = 'app/views/layouts/application.html.erb'
+      MANIFEST = 'app/assets/config/manifest.js'
+      SCSS_ASSET = 'app/assets/stylesheets/application.scss'
+      CSS_ASSETS = %w[app/assets/stylesheets/application.css app/assets/stylesheets/application.css.erb].freeze
+
       def self.base_root
         File.expand_path '../..', __dir__
       end
@@ -15,151 +22,249 @@ module ActiveScaffold
         route 'concern :active_scaffold_association, ActiveScaffold::Routing::Association.new'
       end
 
-      IMPORTMAP = 'config/importmap.rb'
-      JS_ASSET = 'app/assets/javascripts/application.js'
-      JS_APP = 'app/javascript/application.js'
-      MANIFEST = 'app/assets/config/manifest.js'
-
       def add_javascript
         if File.exist?(IMPORTMAP)
-          add_to_importmap
-          add_to_js_app
-        elsif File.exist?(JS_ASSET) # rails 6.1
-          original_js = File.binread(JS_ASSET)
-          if original_js.include?('require active_scaffold')
-            say_status('skipped', "insert into #{JS_ASSET}", :yellow)
-          else
-            insert_into_file JS_ASSET, after: %r{//= require +.*ujs['"]?\n} do
-              "//= require active_scaffold\n"
-            end
-            add_to_manifest 'active_scaffold/manifest.js'
-          end
-          setup_jquery JS_ASSET, original_js
+          add_importmap_javascript
+        elsif use_sprockets_javascript?
+          add_sprockets_javascript
+        elsif propshaft? || File.exist?(JS_APP)
+          add_propshaft_javascript_tags
         else
-          create_javascript_manifest JS_ASSET
+          raise Thor::Error, 'Unable to configure ActiveScaffold JavaScript: no import map, Propshaft setup, ' \
+                             "#{JS_APP}, or #{JS_ASSET} was found"
         end
       end
 
-      def add_to_stylesheet_manifest
-        file = 'app/assets/stylesheets/application.css'
-        return unless File.exist?(file)
-
-        original_css = File.binread(file)
-        if original_css.match?(/require active_scaffold$/)
-          say_status('skipped', 'insert into app/assets/stylesheets/application.css', :yellow)
+      def add_stylesheet
+        if File.exist?(SCSS_ASSET)
+          add_to_scss_asset
         else
-          insert_into_file 'app/assets/stylesheets/application.css', before: %r{ *\*/} do
-            " *= require active_scaffold\n"
-          end
+          add_to_css_asset
         end
       end
 
       protected
 
+      def add_importmap_javascript
+        unless File.exist?(JS_APP)
+          raise Thor::Error, "Unable to configure import maps: #{JS_APP} does not exist"
+        end
+
+        add_to_importmap
+        add_to_js_app
+        add_importmap_layout_tags if propshaft?
+      end
+
       def add_to_importmap
         original_js = File.binread(IMPORTMAP)
-        if original_js.match?(/^pin +['"]active_scaffold['"](?=,|$)/)
+        pin = propshaft? ? "pin 'active_scaffold', to: 'active_scaffold/load.js'" : "pin 'active_scaffold'"
+        current_pin = original_js[/^pin +['"]active_scaffold['"].*$/, 0]
+        if current_pin == pin
           say_status('skipped', "append active_scaffold to #{IMPORTMAP}", :yellow)
+        elsif current_pin && generated_active_scaffold_pin?(current_pin)
+          gsub_file IMPORTMAP, current_pin, pin
         else
-          append_to_file IMPORTMAP do
-            "pin 'active_scaffold'\n"
-          end
+          append_to_file IMPORTMAP, "#{pin}\n"
         end
-        if Object.const_defined?(:Jquery)
-          if original_js.match?(/^pin +['"]jquery['"](?=,|$)/)
-            say_status('skipped', "append jquery to #{IMPORTMAP}", :yellow)
-          else
-            append_to_file IMPORTMAP do
-              "pin 'jquery'\n"
-            end
-          end
-          if original_js.match?(%r{^pin +['"](jquery_ujs|@rails/ujs)['"](?=,|$)})
-            say_status('skipped', "append jquery_ujs to #{IMPORTMAP}", :yellow)
-          else
-            append_to_file IMPORTMAP do
-              "pin 'jquery_ujs'\n"
-            end
-          end
+
+        if jquery?
+          add_importmap_pin original_js, 'jquery'
+          add_importmap_pin original_js, 'jquery_ujs', alternatives: ['@rails/ujs']
         else
-          say_status('missing', 'no jquery-rails gem, load jquery, and jquery_ujs or @rails/ujs, in your layout, or add jquery-rails ' \
-                                "to Gemfile and add pin \"jquery\" and pin \"jquery_ujs\" or pin \"@rails/ujs\", to #{IMPORTMAP}", :red)
+          say_status('missing', 'no jquery-rails gem; load jquery and jquery_ujs or @rails/ujs manually', :red)
         end
       end
 
-      def add_to_js_app
-        original_js = File.binread(JS_APP)
-        if original_js.match?(/^import +['"]active_scaffold['"]/)
-          say_status('skipped', "append active_scaffold to #{JS_APP}", :yellow)
+      def add_importmap_pin(original_js, name, alternatives: [])
+        names = [name, *alternatives].map { |item| Regexp.escape(item) }.join('|')
+        if original_js.match?(/^pin +['"](?:#{names})['"](?=,|$)/)
+          say_status('skipped', "append #{name} to #{IMPORTMAP}", :yellow)
         else
-          append_to_file JS_APP do
-            "import 'active_scaffold'\n"
-          end
+          append_to_file IMPORTMAP, "pin '#{name}'\n"
         end
-        manifest = ['active_scaffold/manifest.js']
-        if Object.const_defined?(:Jquery)
-          if original_js.match?(/^import +['"]jquery['"]/)
-            say_status('skipped', "append jquery to #{JS_APP}", :yellow)
-          else
-            manifest << 'jquery.js'
-            insert_into_file JS_APP, before: /import +['"]active_scaffold['"]\n/ do
-              "import 'jquery'\n"
-            end
+      end
+
+      def generated_active_scaffold_pin?(pin)
+        pin.match?(%r{\Apin +['"]active_scaffold['"](?:, *to: *['"]active_scaffold/load\.js['"])?\z})
+      end
+
+      def add_to_js_app
+        original_js = File.binread(JS_APP)
+        add_js_import original_js, 'active_scaffold'
+        manifest_files = ['active_scaffold/manifest.js']
+
+        if jquery?
+          unless js_import?(original_js, 'jquery')
+            add_js_import original_js, 'jquery', before: 'active_scaffold'
+            manifest_files << 'jquery.js'
           end
-          if original_js.match?(%r{^import +(['"]jquery_ujs['"]|Rails from ['"]@rails/ujs['"])})
-            say_status('skipped', "append jquery_ujs to #{JS_APP}", :yellow)
-          else
-            manifest << 'jquery_ujs.js'
-            insert_into_file JS_APP, before: /import +['"]active_scaffold['"]\n/ do
-              "import 'jquery_ujs'\n"
-            end
+          unless original_js.match?(%r{^import +(['"]jquery_ujs['"]|Rails from ['"]@rails/ujs['"])})
+            add_js_import original_js, 'jquery_ujs', before: 'active_scaffold'
+            manifest_files << 'jquery_ujs.js'
           end
         end
-        add_to_manifest(*manifest)
-      end
-
-      def create_javascript_manifest(file)
-        FileUtils.mkdir_p File.dirname(file)
-        js_content = "// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
-// vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require active_scaffold
-"
-        File.open(file, 'w') { |f| f << js_content } unless options[:pretend]
-        say_status('create', file)
-        insert_into_file 'app/views/layouts/application.html.erb', after: /javascript_pack_tag 'application'.*\n/ do
-          "    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload', 'data-turbo-track': 'reload' %>\n"
-        end
-        add_to_manifest 'application.js', 'active_scaffold/manifest.js'
-        setup_jquery file, js_content, where: 'active_scaffold'
+
+        add_to_manifest(*manifest_files) if sprockets?
+      end
+
+      def add_js_import(original_js, name, before: nil)
+        if js_import?(original_js, name)
+          say_status('skipped', "add #{name} to #{JS_APP}", :yellow)
+        elsif before
+          insert_into_file JS_APP, "import '#{name}'\n", before: /^import +['"]#{Regexp.escape(before)}['"]\n/
+        else
+          append_to_file JS_APP, "import '#{name}'\n"
+        end
+      end
+
+      def js_import?(content, name)
+        content.match?(/^import +['"]#{Regexp.escape(name)}['"]/)
+      end
+
+      def add_importmap_layout_tags
+        tags = []
+        content = layout_content
+        tags << '<%= javascript_importmap_tags %>' unless content.include?('javascript_importmap_tags')
+        tags << '<%= active_scaffold_javascript_tag %>' unless content.include?('active_scaffold_javascript_tag')
+        add_layout_tags tags
+      end
+
+      def add_propshaft_javascript_tags
+        tags = []
+        content = layout_content
+        if jquery? && !content.match?(/javascript_include_tag .*jquery/)
+          tags << "<%= javascript_include_tag 'jquery', 'jquery_ujs' %>"
+        elsif !jquery?
+          say_status('missing', 'no jquery-rails gem; load jquery and jquery_ujs or @rails/ujs in the layout', :red)
+        end
+        tags << '<%= active_scaffold_javascript_tag %>' unless content.include?('active_scaffold_javascript_tag')
+        add_layout_tags tags
+      end
+
+      def layout_content
+        unless File.exist?(LAYOUT)
+          raise Thor::Error, "Unable to configure ActiveScaffold JavaScript: #{LAYOUT} does not exist"
+        end
+
+        File.binread(LAYOUT)
+      end
+
+      def add_layout_tags(tags)
+        return if tags.empty?
+
+        content = File.binread(LAYOUT)
+        unless content.include?('</head>')
+          raise Thor::Error, "Unable to configure ActiveScaffold JavaScript: no </head> tag found in #{LAYOUT}"
+        end
+
+        insert_into_file LAYOUT, tags.map { |tag| "    #{tag}\n" }.join, before: %r{^[ \t]*</head>}
+      end
+
+      def add_sprockets_javascript
+        original_js = File.binread(JS_ASSET)
+        unless original_js.match?(%r{//= require +active_scaffold(?:\s|$)})
+          append_to_file JS_ASSET, "\n//= require active_scaffold\n"
+        end
+        setup_sprockets_jquery original_js
+        add_to_manifest 'active_scaffold/manifest.js'
+      end
+
+      def use_sprockets_javascript?
+        File.exist?(JS_ASSET) && (sprockets? || (!propshaft? && !File.exist?(JS_APP)))
+      end
+
+      def setup_sprockets_jquery(original_js)
+        if jquery?
+          return if original_js.match?(%r{//= require +jquery(?:\s|$)})
+
+          insert_into_file JS_ASSET, "//= require jquery\n", before: %r{//= require +active_scaffold(?:\s|$)}
+        else
+          say_status('missing', 'no jquery-rails gem; load jquery manually before ActiveScaffold', :red)
+        end
       end
 
       def add_to_manifest(*files)
-        append_to_file MANIFEST do
-          files.map { |file| "//= link #{file}\n" }.join
+        original_manifest = File.exist?(MANIFEST) ? File.binread(MANIFEST) : ''
+        files.each do |file|
+          next if original_manifest.match?(%r{^//= link #{Regexp.escape(file)}$})
+
+          append_to_file MANIFEST, "//= link #{file}\n"
         end
       end
 
-      def setup_jquery(file, original_js = nil, where: 'ujs')
-        original_js ||= File.binread(file)
-        if Object.const_defined?(:Jquery)
-          unless original_js.include?('require jquery')
-            insert_into_file file, before: %r{//= require +.*#{where}['"]?\n} do
-              "//= require jquery\n"
-            end
-          end
+      def add_to_scss_asset
+        dependency = scss_dependency
+        unless dependency
+          say_status('missing', "could not detect dartsass-rails or dartsass-sprockets; update #{SCSS_ASSET} manually", :red)
+          return
+        end
+
+        original_scss = File.binread(SCSS_ASSET)
+        if original_scss.match?(%r{^@use +['"]active_scaffold(?:/core)?['"]})
+          say_status('skipped', "add ActiveScaffold to #{SCSS_ASSET}", :yellow)
+        else
+          prepend_to_file SCSS_ASSET, "@use '#{dependency}';\n"
+        end
+      end
+
+      def scss_dependency
+        if gem_loaded?('dartsass-sprockets')
+          'active_scaffold'
+        elsif gem_loaded?('dartsass-rails')
+          'active_scaffold/core'
+        end
+      end
+
+      def add_to_css_asset
+        file = CSS_ASSETS.find do |path|
+          File.exist?(path) && File.binread(path).match?(/\*= require(?:_tree)?\b/)
+        end
+        unless file
+          say_status('missing', 'no Dart Sass entrypoint or Sprockets stylesheet manifest found', :red)
+          return
+        end
+
+        original_css = File.binread(file)
+        if original_css.match?(/\*= require +active_scaffold(?:\s|$)/)
+          say_status('skipped', "add ActiveScaffold to #{file}", :yellow)
         else
-          say_status('missing', 'no jquery-rails gem, load jquery in your layout, or add jquery-rails to Gemfile and add //= require jquery to application.js', :red)
+          insert_into_file file, " *= require active_scaffold\n", after: /^[ \t]*\*= require(?:_tree)?\b.*\n/
         end
       end
+
+      def propshaft?
+        asset_pipeline == :propshaft
+      end
+
+      def sprockets?
+        asset_pipeline == :sprockets
+      end
+
+      def asset_pipeline
+        return :propshaft if propshaft_active?
+        return :sprockets if sprockets_active?
+        return :propshaft if gem_loaded?('propshaft')
+
+        :sprockets if gem_loaded?('sprockets-rails')
+      end
+
+      def propshaft_active?
+        defined?(Propshaft::Assembly) && Rails.application.respond_to?(:assets) &&
+          Rails.application.assets.is_a?(Propshaft::Assembly)
+      end
+
+      def sprockets_active?
+        defined?(Sprockets::Environment) && Rails.application.respond_to?(:assets) &&
+          Rails.application.assets.is_a?(Sprockets::Environment)
+      end
+
+      def jquery?
+        Object.const_defined?(:Jquery)
+      end
+
+      def gem_loaded?(name)
+        Gem.loaded_specs.key?(name)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.4
 platform: ruby
 authors:
 - Many, see README
@@ -325,6 +325,7 @@ files:
 - lib/active_scaffold/extensions/action_controller_rendering.rb
 - lib/active_scaffold/extensions/action_controller_rescueing.rb
 - lib/active_scaffold/extensions/action_view_rendering.rb
+- lib/active_scaffold/extensions/active_record_session_store.rb
 - lib/active_scaffold/extensions/connection_adapter.rb
 - lib/active_scaffold/extensions/ice_nine.rb
 - lib/active_scaffold/extensions/localize.rb