ultimate_turbo_modal 1.7.0 → 2.0.0

data/lib/generators/ultimate_turbo_modal/install_generator.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "pathname" # Needed for Pathname helper
+
+module UltimateTurboModal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Installs UltimateTurboModal: copies initializer/flavor, sets up JS, registers Stimulus controller, adds Turbo Frame."
+
+      # Step 1: Determine CSS framework flavor
+      def determine_framework_flavor
+        @framework = prompt_for_flavor
+      end
+
+      # 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
+      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
+
+        import_line = "import { #{controller_name} } from \"#{controller_package}\"\n"
+        register_line = "application.register(\"#{stimulus_identifier}\", #{controller_name})\n"
+
+        say "\nAttempting to register Stimulus controller in #{stimulus_controller_path}...", :yellow
+
+        unless File.exist?(stimulus_controller_path)
+          say "❌ Stimulus controllers index file not found at #{stimulus_controller_path}.", :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
+        end
+
+        # Read the file content to check if lines already exist
+        file_content = File.read(stimulus_controller_path)
+
+        # 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
+          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/
+          say "✅ Added import statement (fallback position).", :green
+        else
+           say "⏩ Import statement already exists.", :blue
+        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
+        else
+           say "⏩ Controller registration already exists.", :blue
+        end
+      end
+
+      # Step 4: Add Turbo Frame to Layout
+      def add_modal_turbo_frame
+        layout_path = rails_root_join("app", "views", "layouts", "application.html.erb")
+        frame_tag = "<%= turbo_frame_tag \"modal\" %>\n"
+        body_tag_regex = /<body.*>\s*\n?/
+
+        say "\nAttempting to add modal Turbo Frame to #{layout_path}...", :yellow
+
+        unless File.exist?(layout_path)
+          say "❌ Layout file not found at #{layout_path}.", :red
+          say "   Please manually add the following line inside the <body> tag of your main layout:", :yellow
+          say "   #{frame_tag.strip}\n", :cyan
+          return
+        end
+
+        file_content = File.read(layout_path)
+
+        if file_content.include?(frame_tag.strip)
+          say "⏩ Turbo Frame tag already exists.", :blue
+        elsif file_content.match?(body_tag_regex)
+          # Insert after the opening body tag
+          insert_into_file layout_path, "  #{frame_tag}", after: body_tag_regex # Add indentation
+          say "✅ Added Turbo Frame tag inside the <body>.", :green
+        else
+          say "❌ Could not find the opening <body> tag in #{layout_path}.", :red
+          say "   Please manually add the following line inside the <body> tag:", :yellow
+          say "   #{frame_tag.strip}\n", :cyan
+        end
+      end
+
+
+      def copy_initializer_and_flavor
+        say "\nCreating initializer for `#{@framework}` flavor...", :green
+        copy_file "ultimate_turbo_modal.rb", "config/initializers/ultimate_turbo_modal.rb"
+        gsub_file "config/initializers/ultimate_turbo_modal.rb", "FLAVOR", ":#{@framework}"
+        say "✅ Initializer created at config/initializers/ultimate_turbo_modal.rb"
+
+        say "Copying flavor file...", :green
+        copy_file "flavors/#{@framework}.rb", "config/initializers/ultimate_turbo_modal_#{@framework}.rb"
+        say "✅ Flavor file copied to config/initializers/ultimate_turbo_modal_#{@framework}.rb\n"
+      end
+
+      def show_readme
+        say "\nUltimateTurboModal installation complete!\n", :magenta
+        say "Please review the initializer files, ensure JS is set up, and check your layout file.", :magenta
+        say "Don't forget to restart your Rails server!", :yellow
+      end
+
+      private
+
+      def prompt_for_flavor
+        say "Which CSS framework does your project use?\n", :blue
+        options = []
+        flavors_dir = File.expand_path("templates/flavors", __dir__)
+
+        options = Dir.glob(File.join(flavors_dir, "*.rb")).map { |file| File.basename(file, ".rb") }.sort
+        if options.include?("custom")
+          options.delete("custom")
+          options << "custom"
+        end
+
+        if options.empty?
+           raise Thor::Error, "No flavor templates found in #{flavors_dir}!"
+        end
+
+        say "Options:"
+        options.each_with_index do |option, index|
+          say "#{index + 1}. #{option}"
+        end
+
+        loop do
+          print "\nEnter the number: "
+          framework_choice = ask("").chomp.strip
+          framework_id = framework_choice.to_i - 1
+
+          if framework_id >= 0 && framework_id < options.size
+            return options[framework_id]
+          else
+            say "\nInvalid option '#{framework_choice}'. Please enter a number between 1 and #{options.size}.", :red
+          end
+        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/templates/flavors/custom.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Custom
+# TODO: define the classes for each HTML element.
+module UltimateTurboModal::Flavors
+  class Custom < UltimateTurboModal::Base
+    DIV_DIALOG_CLASSES = ""
+    DIV_OVERLAY_CLASSES = ""
+    DIV_OUTER_CLASSES = ""
+    DIV_INNER_CLASSES = ""
+    DIV_CONTENT_CLASSES = ""
+    DIV_MAIN_CLASSES = ""
+    DIV_HEADER_CLASSES = ""
+    DIV_TITLE_CLASSES = ""
+    DIV_TITLE_H_CLASSES = ""
+    DIV_FOOTER_CLASSES = ""
+    BUTTON_CLOSE_CLASSES = ""
+    BUTTON_CLOSE_SR_ONLY_CLASSES = ""
+    CLOSE_BUTTON_TAG_CLASSES = ""
+    ICON_CLOSE_CLASSES = ""
+  end
+end

data/lib/{ultimate_turbo_modal → generators/ultimate_turbo_modal/templates}/flavors/tailwind.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+# Tailwind CSS v4
 module UltimateTurboModal::Flavors
   class Tailwind < UltimateTurboModal::Base
     DIV_DIALOG_CLASSES = "relative group z-50"
-    DIV_OVERLAY_CLASSES = "fixed inset-0 bg-gray-900 bg-opacity-50 transition-opacity dark:bg-opacity-80"
+    DIV_OVERLAY_CLASSES = "fixed inset-0 bg-gray-900/70 transition-opacity dark:bg-gray-900/80"
     DIV_OUTER_CLASSES = "fixed inset-0 overflow-y-auto sm:max-w-[80%] md:max-w-3xl sm:mx-auto m-4"
-    DIV_INNER_CLASSES = "flex min-h-full items-center justify-center p-1 sm:p-4"
-    DIV_CONTENT_CLASSES = "relative transform overflow-hidden rounded-lg bg-white text-left shadow transition-all sm:my-8 sm:max-w-3xl dark:bg-gray-800 dark:text-white"
-    DIV_MAIN_CLASSES = "group-data-[padding=true]:p-4 group-data-[padding=true]:pt-2"
+    DIV_INNER_CLASSES = "flex min-h-full items-start justify-center pt-[10vh] sm:p-4"
+    DIV_CONTENT_CLASSES = "relative transform max-h-screen overflow-hidden rounded-lg bg-white text-left shadow-lg transition-all sm:my-8 sm:max-w-3xl dark:bg-gray-800 dark:text-white"
+    DIV_MAIN_CLASSES = "group-data-[padding=true]:p-4 group-data-[padding=true]:pt-2 overflow-y-auto max-h-[75vh]"
     DIV_HEADER_CLASSES = "flex justify-between items-center w-full py-4 rounded-t dark:border-gray-600 group-data-[header-divider=true]:border-b group-data-[header=false]:absolute"
     DIV_TITLE_CLASSES = "pl-4"
     DIV_TITLE_H_CLASSES = "group-data-[title=false]:hidden text-lg font-semibold text-gray-900 dark:text-white"

data/lib/generators/ultimate_turbo_modal/templates/flavors/tailwind3.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Tailwind CSS v3
+module UltimateTurboModal::Flavors
+  class Tailwind3 < UltimateTurboModal::Base
+    DIV_DIALOG_CLASSES = "relative z-50"
+    DIV_OVERLAY_CLASSES = "fixed inset-0 bg-gray-900 bg-opacity-70 transition-opacity dark:bg-gray-900 dark:bg-opacity-80"
+    DIV_OUTER_CLASSES = "fixed inset-0 overflow-y-auto sm:max-w-[80%] md:max-w-3xl sm:mx-auto m-4"
+    DIV_INNER_CLASSES = "flex min-h-full items-start justify-center pt-[10vh] sm:p-4"
+    DIV_CONTENT_CLASSES = "relative transform max-h-screen overflow-hidden rounded-lg bg-white text-left shadow-xl transition-all sm:my-8 sm:max-w-3xl dark:bg-gray-800 dark:text-white"
+    DIV_MAIN_CLASSES = "p-4 pt-2 overflow-y-auto max-h-[75vh]"
+    DIV_HEADER_CLASSES = "flex justify-between items-center w-full py-4 rounded-t dark:border-gray-600 border-b absolute"
+    DIV_TITLE_CLASSES = "pl-4"
+    DIV_TITLE_H_CLASSES = "text-lg font-semibold text-gray-900 dark:text-white"
+    DIV_FOOTER_CLASSES = "flex p-4 rounded-b dark:border-gray-600 border-t"
+    BUTTON_CLOSE_CLASSES = "mr-4 hidden"
+    BUTTON_CLOSE_SR_ONLY_CLASSES = "sr-only"
+    CLOSE_BUTTON_TAG_CLASSES = "text-gray-400 bg-transparent hover:bg-gray-200 hover:text-gray-900 rounded-lg text-sm p-1.5 ml-auto inline-flex items-center dark:hover:bg-gray-600 dark:hover:text-white"
+    ICON_CLOSE_CLASSES = "w-5 h-5"
+  end
+end

data/lib/{ultimate_turbo_modal → generators/ultimate_turbo_modal/templates}/flavors/vanilla.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Vanilla CSS
 module UltimateTurboModal::Flavors
   class Vanilla < UltimateTurboModal::Base
     DIV_DIALOG_CLASSES = "modal-container"
@@ -7,7 +8,7 @@ module UltimateTurboModal::Flavors
     DIV_OUTER_CLASSES = "modal-outer"
     DIV_INNER_CLASSES = "modal-inner"
     DIV_CONTENT_CLASSES = "modal-content"
-    DIV_MAIN_CLASSES =  "modal-main"
+    DIV_MAIN_CLASSES = "modal-main"
     DIV_HEADER_CLASSES = "modal-header"
     DIV_TITLE_CLASSES = "modal-title"
     DIV_TITLE_H_CLASSES = "modal-title-h"

data/lib/generators/ultimate_turbo_modal/templates/ultimate_turbo_modal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+UltimateTurboModal.configure do |config|
+  config.flavor = FLAVOR
+  # config.close_button = true
+  # config.advance = true
+  # config.padding = true
+  # config.header = true
+  # config.header_divider = true
+  # config.footer_divider = true
+  # config.allowed_click_outside_selector = []
+end

data/lib/ultimate_turbo_modal/base.rb

@@ -111,6 +111,7 @@ class UltimateTurboModal::Base < Phlex::HTML
   ## HTML components
 
   def modal(&block)
+    styles
     outer_divs do
       div_content do
         div_header
@@ -120,6 +121,12 @@ class UltimateTurboModal::Base < Phlex::HTML
     end
   end
 
+  def styles
+    style do
+      unsafe_raw("html:has(dialog[open]) {overflow: hidden;} html {scrollbar-gutter: stable;}".html_safe)
+    end
+  end
+
   def outer_divs(&block)
     div_dialog do
       div_overlay

data/lib/ultimate_turbo_modal/railtie.rb

@@ -9,7 +9,7 @@ require "ultimate_turbo_modal/helpers/stream_helper"
 module UltimateTurboModal
   class Railtie < Rails::Railtie
     initializer "ultimate_turbo_modal.action_controller" do
-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load(:action_controller_base) do
         include UltimateTurboModal::Helpers::ControllerHelper
       end
     end

data/lib/ultimate_turbo_modal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UltimateTurboModal
-  VERSION = "1.7.0"
+  VERSION = File.read(File.join(__dir__, "../../VERSION")).strip
 end

data/lib/ultimate_turbo_modal.rb

@@ -5,9 +5,7 @@ require "phlex/deferred_render_with_main_content"
 require "ultimate_turbo_modal/configuration"
 require "ultimate_turbo_modal/railtie"
 require "ultimate_turbo_modal/base"
-Dir[File.join(__dir__, "ultimate_turbo_modal/flavors", "*.rb")].sort.each do |file|
-  require file
-end
+require "generators/ultimate_turbo_modal/install_generator"
 
 module UltimateTurboModal
   extend self
@@ -18,6 +16,8 @@ module UltimateTurboModal
 
   def modal_class
     "UltimateTurboModal::Flavors::#{flavor.to_s.classify}".constantize
+  rescue NameError
+    raise Error, "Flavor `#{flavor.downcase}` not found. Please check your initializer file at `config/initializers/ultimate_turbo_modal.rb` and make sure to run `rails generate ultimate_turbo_modal:install`."
   end
 
   class Error < StandardError; end

data/script/build_and_release.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+cd $(dirname $0)/..
+
+# Check for uncommitted changes
+echo "Checking for uncommitted changes..."
+if ! git diff --quiet; then
+  echo "There are uncommitted changes. Aborting."
+  exit 1
+fi
+echo "No uncommitted changes found."
+
+echo "Building and releasing gem..."
+bundle exec rake build
+bundle exec rake release
+
+echo "Building JavaScript..."
+cd javascript
+./scripts/release-npm.sh
+
+echo "Done!"
+

data/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ultimate_turbo_modal
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Carl Mercier
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-28 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails
@@ -16,34 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: stimulus-rails
   requirement: !ruby/object:Gem::Requirement
@@ -90,18 +83,33 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
+- javascript/index.js
+- javascript/modal_controller.js
+- javascript/package.json
+- javascript/rollup.config.js
+- javascript/scripts/release-npm.sh
+- javascript/scripts/update-version.js
+- javascript/styles/vanilla.css
+- javascript/yarn.lock
+- 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
+- lib/generators/ultimate_turbo_modal/templates/flavors/tailwind3.rb
+- lib/generators/ultimate_turbo_modal/templates/flavors/vanilla.rb
+- lib/generators/ultimate_turbo_modal/templates/ultimate_turbo_modal.rb
 - lib/phlex/deferred_render_with_main_content.rb
 - lib/ultimate_turbo_modal.rb
 - lib/ultimate_turbo_modal/base.rb
 - lib/ultimate_turbo_modal/configuration.rb
-- lib/ultimate_turbo_modal/flavors/tailwind.rb
-- lib/ultimate_turbo_modal/flavors/vanilla.rb
 - lib/ultimate_turbo_modal/helpers/controller_helper.rb
 - lib/ultimate_turbo_modal/helpers/stream_helper.rb
 - lib/ultimate_turbo_modal/helpers/view_helper.rb
 - lib/ultimate_turbo_modal/railtie.rb
 - lib/ultimate_turbo_modal/version.rb
+- script/build_and_release.sh
 - sig/ultimate_turbo_modal.rbs
+- yarn.lock
 homepage: https://github.com/cmer/ultimate_turbo_modal
 licenses:
 - MIT
@@ -109,7 +117,6 @@ metadata:
   homepage_uri: https://github.com/cmer/ultimate_turbo_modal
   source_code_uri: https://github.com/cmer/ultimate_turbo_modal
   changelog_uri: https://github.com/cmer/ultimate_turbo_modal/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: UTMR aims to be the be-all and end-all of Turbo Modals.
 test_files: []