ultimate_turbo_modal 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f48f99a3169d751eb02f9efe0f357aa70b285097e03438e2d1b27d1693b9b59c
-  data.tar.gz: c333e8c524f3c2967d1ddc484aab887165f574e0969bdd1b1aa6d1a48752b7ba
+  metadata.gz: 8076c3d9802abd28ef2ff1858b7268f730455c69a214dfb2f8e04d3695c8f68f
+  data.tar.gz: fa211158221a41661229457a63874690eac7e07fb19159045362eb0341d4ccee
 SHA512:
-  metadata.gz: be4aa9c324429196062c98fd8845b484eb2f14f76e96ee2581063b05568f287e3e4f1961e55a5e6d11a2043a3785af13ebaaf1d9f6594abeb3750f785621f631
-  data.tar.gz: aaad99d25ccbd2bceb518a1a85ecf2e28a7e768e61ff478fddfc723aad170ef06cd7f325fc012e405008799f43f90600440cff93e29528c81cfcbb07b8c94184
+  metadata.gz: 9414a16b2a0de555727b258403230d5a65564e1158b95c61904cca0fd0b9280fe5433eaeb156962b1dbb1bbcdfe25a86d1ec7b1a65c03209211e5b97abb2fde7
+  data.tar.gz: 783c9c2af43c3b31e8e974642545ac094e2c5faf1925c84947186e215ba809daac4a6236afa7fc1e24768379f1a12376515982a48cd08350274a9a8a2230fc7b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [2.2.2] - 2026-03-12
+
+- Added `close` function on Stimulus Controller. Thanks @bendangelo
+- Focus bug fix. Thanks @pasl
+- Refactor generator and fix [bug #33](https://github.com/cmer/ultimate_turbo_modal/issues/33).
+
 ## [2.2.1] - 2025-08-08
 
 - Added `rails generate ultimate_turbo_modal:update` for easy updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ultimate_turbo_modal (2.2.1)
+    ultimate_turbo_modal (2.2.2)
       actionpack
       activesupport
       phlex-rails

data/VERSION

@@ -1 +1 @@
-2.2.1
+2.2.2

data/javascript/modal_controller.js

@@ -96,6 +96,10 @@ export default class extends Controller {
     this.hideModal();
   }
 
+  close() {
+    this.hideModal();
+  }
+
   refreshPage() {
     window.Turbo.visit(window.location.href, { action: "replace" });
   }
@@ -178,7 +182,7 @@ export default class extends Controller {
           initialFocus: () => {
             // Try to focus the first focusable element, or the modal itself
             const firstFocusable = this.contentTarget.querySelector(
-              'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])'
+              'button:not([tabindex="-1"]), [href]:not([tabindex="-1"]), input:not([tabindex="-1"]), select:not([tabindex="-1"]), textarea:not([tabindex="-1"]), [tabindex]:not([tabindex="-1"])'
             );
             return firstFocusable || this.contentTarget;
           }

data/javascript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate_turbo_modal",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "The ultimate Turbo / Stimulus / Hotwire modal window for Rails",
   "main": "dist/ultimate_turbo_modal.min.js",
   "module": "dist/ultimate_turbo_modal.min.js",

data/lib/generators/ultimate_turbo_modal/base.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "pathname"
+
+module UltimateTurboModal
+  module Generators
+    class Base < Rails::Generators::Base
+      protected
+
+      def package_name
+        "ultimate_turbo_modal"
+      end
+
+      # Add JS dependency (for install flow)
+      def add_js_dependency
+        say "Attempting to set up JavaScript dependencies...", :yellow
+
+        version_spec = "#{package_name}@#{UltimateTurboModal::VERSION}"
+
+        if uses_importmaps?
+          say "Detected Importmaps. Pinning #{version_spec}...", :green
+          run "bin/importmap pin #{version_spec}"
+          say "✅ Pinned '#{package_name}' via importmap.", :green
+          return
+        end
+
+        if uses_javascript_bundler?
+          say "Detected jsbundling-rails (Yarn/npm/Bun). Adding #{package_name} package...", :green
+          if uses_yarn?
+            run "yarn add #{version_spec}"
+            say "✅ Added '#{package_name}' using Yarn.", :green
+          elsif uses_npm?
+            run "npm install --save #{version_spec}"
+            say "✅ Added '#{package_name}' using npm.", :green
+          elsif uses_bun?
+            run "bun add #{version_spec}"
+            say "✅ Added '#{package_name}' using Bun.", :green
+          else
+            say "Attempting to add with Yarn. If you use npm or Bun, please add manually.", :yellow
+            run "yarn add #{version_spec}"
+            say "If this failed or you use npm/bun, please run:", :yellow
+            say "npm install --save #{version_spec}", :cyan
+            say "# or", :cyan
+            say "bun add #{version_spec}", :cyan
+          end
+        else
+          say "Could not automatically detect Importmaps or jsbundling-rails.", :yellow
+          say "Please manually add the '#{package_name}' JavaScript package.", :yellow
+          say "If using Importmaps: bin/importmap pin #{version_spec}", :cyan
+          say "If using Yarn: yarn add #{version_spec}", :cyan
+          say "If using npm: npm install --save #{version_spec}", :cyan
+          say "If using Bun: bun add #{version_spec}", :cyan
+          say "Then, import it in your app/javascript/application.js:", :yellow
+          say "import '#{package_name}'", :cyan
+        end
+      end
+
+      # Install all JS dependencies (for update flow)
+      def install_all_js_dependencies
+        if uses_importmaps?
+          version_spec = "#{package_name}@#{UltimateTurboModal::VERSION}"
+          say "Detected Importmaps. Ensuring pin for #{version_spec}...", :green
+          run "bin/importmap pin #{version_spec}"
+          say "✅ Pinned '#{package_name}' via importmap.", :green
+          return
+        end
+
+        unless uses_javascript_bundler?
+          say "Could not detect Importmaps or jsbundling-rails. Skipping JS install step.", :yellow
+          return
+        end
+
+        say "Installing JavaScript dependencies...", :yellow
+        if uses_yarn?
+          run "yarn install"
+          say "✅ Installed dependencies with Yarn.", :green
+        elsif uses_npm?
+          run "npm install"
+          say "✅ Installed dependencies with npm.", :green
+        elsif uses_bun?
+          run "bun install"
+          say "✅ Installed dependencies with Bun.", :green
+        else
+          say "Attempting to install with Yarn. If you use npm or Bun, please run the appropriate command.", :yellow
+          run "yarn install"
+        end
+      end
+
+      def uses_importmaps?
+        File.exist?(rails_root_join("config", "importmap.rb"))
+      end
+
+      def uses_javascript_bundler?
+        File.exist?(rails_root_join("package.json"))
+      end
+
+      def uses_yarn?
+        File.exist?(rails_root_join("yarn.lock"))
+      end
+
+      def uses_npm?
+        File.exist?(rails_root_join("package-lock.json")) && !uses_yarn? && !uses_bun?
+      end
+
+      def uses_bun?
+        File.exist?(rails_root_join("bun.lockb"))
+      end
+
+      def rails_root_join(*args)
+        Pathname.new(destination_root).join(*args)
+      end
+    end
+  end
+end
+
+

data/lib/generators/ultimate_turbo_modal/install_generator.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "rails/generators"
-require "pathname" # Needed for Pathname helper
+require_relative "base"
 
 module UltimateTurboModal
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallGenerator < UltimateTurboModal::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
       desc "Installs UltimateTurboModal: copies initializer/flavor, sets up JS, registers Stimulus controller, adds Turbo Frame."
@@ -17,99 +17,61 @@ module UltimateTurboModal
 
       # Step 2: Setup Javascript Dependencies (Yarn/npm/Bun or Importmap)
       def setup_javascript_dependencies
-        package_name = "ultimate_turbo_modal" # Or the actual npm package name if different
-
-        say "\nAttempting to set up JavaScript dependencies...", :yellow
-
-        if uses_importmaps?
-          say "Detected Importmaps. Pinning #{package_name}...", :green
-          run "bin/importmap pin #{package_name}"
-
-          say "\n✅ Pinned '#{package_name}' via importmap.", :green
-
-        elsif uses_javascript_bundler?
-          say "Detected jsbundling-rails (Yarn/npm/Bun). Adding #{package_name} package...", :green
-          if uses_yarn?
-             run "yarn add #{package_name}"
-             say "\n✅ Added '#{package_name}' using Yarn.", :green
-          elsif uses_npm?
-             run "npm install --save #{package_name}"
-             say "\n✅ Added '#{package_name}' using npm.", :green
-          elsif uses_bun?
-             run "bun add #{package_name}"
-             say "\n✅ Added '#{package_name}' using Bun.", :green
-          else
-             # Default or fallback: Try yarn, but provide instructions for others
-             say "Attempting to add with Yarn. If you use npm or Bun, please add manually.", :yellow
-             run "yarn add #{package_name}"
-             say "\n✅ Attempted to add '#{package_name}' using Yarn.", :green
-             say "   If this failed or you use npm/bun, please run:", :yellow
-             say "   npm install --save #{package_name}", :cyan
-             say "   # or", :cyan
-             say "   bun add #{package_name}\n", :cyan
-          end
-        else
-          # Fallback instructions if neither is clearly detected
-          say "\nCould not automatically detect Importmaps or jsbundling-rails.", :yellow
-          say "Please manually add the '#{package_name}' JavaScript package.", :yellow
-          say "If using Importmaps: bin/importmap pin #{package_name}", :cyan
-          say "If using Yarn: yarn add #{package_name}", :cyan
-          say "If using npm: npm install --save #{package_name}", :cyan
-          say "If using Bun: bun add #{package_name}", :cyan
-          say "Then, import it in your app/javascript/application.js:", :yellow
-          say "import '#{package_name}'\n", :cyan
-        end
+        add_js_dependency
       end
 
       # Step 3: Register Stimulus Controller
       def setup_stimulus_controller
-        stimulus_controller_path = rails_root_join("app", "javascript", "controllers", "index.js")
-        controller_package = "ultimate_turbo_modal" # Package name where the controller is defined
-        controller_name = "UltimateTurboModalController" # The exported controller class name
-        stimulus_identifier = "modal" # The identifier for application.register
+        index_path = rails_root_join("app", "javascript", "controllers", "index.js")
+        application_path = rails_root_join("app", "javascript", "controllers", "application.js")
+        controller_name = "UltimateTurboModalController"
+        stimulus_identifier = "modal"
 
-        import_line = "import { #{controller_name} } from \"#{controller_package}\"\n"
+        import_line = "import { #{controller_name} } from \"#{package_name}\"\n"
         register_line = "application.register(\"#{stimulus_identifier}\", #{controller_name})\n"
 
-        say "\nAttempting to register Stimulus controller in #{stimulus_controller_path}...", :yellow
+        # Determine which file contains Application.start() — it may be index.js or application.js
+        target_path, file_content = find_stimulus_target(index_path, application_path)
+
+        say "\nAttempting to register Stimulus controller...", :yellow
 
-        unless File.exist?(stimulus_controller_path)
-          say "❌ Stimulus controllers index file not found at #{stimulus_controller_path}.", :red
+        unless target_path
+          say "❌ Stimulus controllers file not found.", :red
           say "   Please manually add the following lines to your Stimulus setup:", :yellow
           say "   #{import_line.strip}", :cyan
           say "   #{register_line.strip}\n", :cyan
-          return # Exit this method if the file doesn't exist
+          return
         end
 
-        # Read the file content to check if lines already exist
-        file_content = File.read(stimulus_controller_path)
+        say "  Target file: #{target_path}", :yellow
 
-        # Insert the import statement after the last existing import or a common marker
-        # Using a regex to find the Stimulus import is often reliable
-        import_anchor = /import .* from "@hotwired\/stimulus"\n/
-        if file_content.match?(import_anchor) && !file_content.include?(import_line)
-          insert_into_file stimulus_controller_path, import_line, after: import_anchor
+        # Insert the import statement after an existing import from @hotwired/stimulus or ./application
+        import_anchor = /import .* from ["'](?:@hotwired\/stimulus|\.\/application)["']\n/
+        if file_content.include?(import_line)
+          say "⏩ Import statement already exists.", :blue
+        elsif file_content.match?(import_anchor)
+          insert_into_file target_path, import_line, after: import_anchor
           say "✅ Added import statement.", :green
-        elsif !file_content.include?(import_line)
-          # Fallback: insert at the beginning if Stimulus import wasn't found (less ideal)
-          insert_into_file stimulus_controller_path, import_line, before: /import/
+        elsif file_content.match?(/import/)
+          insert_into_file target_path, import_line, before: /import/
           say "✅ Added import statement (fallback position).", :green
         else
-           say "⏩ Import statement already exists.", :blue
+          prepend_to_file target_path, import_line
+          say "✅ Added import statement (prepended to file).", :green
         end
 
-
         # Insert the register statement after Application.start()
-        register_anchor = /Application\.start$$$$\n/
-        if file_content.match?(register_anchor) && !file_content.include?(register_line)
-           insert_into_file stimulus_controller_path, register_line, after: register_anchor
-           say "✅ Added controller registration.", :green
-        elsif !file_content.include?(register_line)
-          say "❌ Could not find `Application.start()` line to insert registration after.", :red
-          say "   Please manually add this line after your Stimulus application starts:", :yellow
-          say "   #{register_line.strip}\n", :cyan
+        register_anchor = /Application\.start\(\)\n/
+        if file_content.include?(register_line)
+          say "⏩ Controller registration already exists.", :blue
+        elsif file_content.match?(register_anchor)
+          insert_into_file target_path, register_line, after: register_anchor
+          say "✅ Added controller registration.", :green
         else
-           say "⏩ Controller registration already exists.", :blue
+          say "❌ Could not find `Application.start()` line in #{target_path}.", :red
+          say "   Please manually add these lines to your Stimulus setup:", :yellow
+          say "   #{import_line.strip}", :cyan
+          say "   #{register_line.strip}\n", :cyan
         end
       end
 
@@ -196,28 +158,17 @@ module UltimateTurboModal
         end
       end
 
-      def uses_importmaps?
-        File.exist?(rails_root_join("config", "importmap.rb"))
-      end
-
-      def uses_javascript_bundler?
-        File.exist?(rails_root_join("package.json"))
-      end
-
-      def uses_yarn?
-        File.exist?(rails_root_join("yarn.lock"))
-      end
-
-      def uses_npm?
-        File.exist?(rails_root_join("package-lock.json")) && !uses_yarn? && !uses_bun?
-      end
-
-       def uses_bun?
-        File.exist?(rails_root_join("bun.lockb"))
-      end
+      def find_stimulus_target(index_path, application_path)
+        [index_path, application_path].each do |path|
+          next unless File.exist?(path)
+          content = File.read(path)
+          return [path, content] if content.match?(/Application\.start\(\)/)
+        end
 
-      def rails_root_join(*args)
-         Pathname.new(destination_root).join(*args)
+        # Fall back to index.js even without Application.start()
+        if File.exist?(index_path)
+          [index_path, File.read(index_path)]
+        end
       end
     end
   end

data/lib/generators/ultimate_turbo_modal/update_generator.rb

@@ -3,10 +3,11 @@
 require "rails/generators"
 require "json"
 require "pathname"
+require_relative "base"
 
 module UltimateTurboModal
   module Generators
-    class UpdateGenerator < Rails::Generators::Base
+    class UpdateGenerator < UltimateTurboModal::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
       desc "Updates UltimateTurboModal: aligns npm package version to gem version and refreshes the configured flavor initializer."
@@ -29,6 +30,13 @@ module UltimateTurboModal
         package_name = "ultimate_turbo_modal"
         new_version = UltimateTurboModal::VERSION.to_s
 
+        # Special case: demo app links to local JS package; never update its version
+        if json.dig("dependencies", package_name) == "link:../javascript" ||
+           json.dig("devDependencies", package_name) == "link:../javascript"
+          say "Detected local link for '#{package_name}' (link:../javascript). Skipping version update.", :blue
+          return
+        end
+
         updated = false
 
         %w[dependencies devDependencies].each do |section|
@@ -49,6 +57,10 @@ module UltimateTurboModal
         end
       end
 
+      def install_js_dependencies
+        install_all_js_dependencies
+      end
+
       def copy_flavor_file
         flavor = detect_flavor
         unless flavor

data/lib/ultimate_turbo_modal/base.rb

@@ -55,7 +55,7 @@ class UltimateTurboModal::Base < Phlex::HTML
         modal(&block)
       end
     elsif turbo_stream?
-      Turbo::StreamsHelper.turbo_stream_action_tag("update", target: "modal") do
+      turbo_stream_action_tag("update", target: "modal") do
         modal(&block)
       end
     else

data/lib/ultimate_turbo_modal.rb

@@ -5,6 +5,7 @@ require "phlex/deferred_render_with_main_content"
 require "ultimate_turbo_modal/configuration"
 require "ultimate_turbo_modal/railtie"
 require "ultimate_turbo_modal/base"
+require "generators/ultimate_turbo_modal/base"
 require "generators/ultimate_turbo_modal/install_generator"
 require "generators/ultimate_turbo_modal/update_generator"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultimate_turbo_modal
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Carl Mercier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2026-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails
@@ -177,6 +177,7 @@ files:
 - javascript/scripts/update-version.js
 - javascript/styles/vanilla.css
 - javascript/yarn.lock
+- lib/generators/ultimate_turbo_modal/base.rb
 - lib/generators/ultimate_turbo_modal/install_generator.rb
 - lib/generators/ultimate_turbo_modal/templates/flavors/custom.rb
 - lib/generators/ultimate_turbo_modal/templates/flavors/tailwind.rb