ultimate_turbo_modal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 896c6379f97064006b57fbb612cab3c16560af307d2271da0c488785dfc366db
+  data.tar.gz: aa78d481f27597261e57ca07c0b80f0fc681529e63d92df803347a18c4c1b9da
+SHA512:
+  metadata.gz: 260a1fddf247e51ed411f0ae83d85faa2d581f18c8ef71664129b11ad1e7480c6be9da04f7e86321999c0ad9098643a23cb83480b39f79f847ee59939a47098f
+  data.tar.gz: 102593d43c1b8a94ca85787d53a2f8a8064fd3d17fdec96e382c2f6795baffa599d8478fcd759c85b23d694f091e643e76e6516d1fa8c1d3911487e43f0738f8

data/.rubocop.yml

@@ -0,0 +1,6 @@
+require:
+  - standard
+inherit_gem:
+  standard: config/base.yml
+AllCops:
+  SuggestExtensions: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.0

data/.standard.yml

@@ -0,0 +1,9 @@
+ruby_version: 3.2.0
+parallel: true
+formatter: progress
+plugins:
+  - standard-rails:
+      target_rails_version: 7.0
+
+ignore:
+  - 'vendor/**/*'

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.2.0
+nodejs 18.9.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-10-31
+
+- Initial release as a Ruby Gem

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ultimate_turbo_modal.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "standard", "~> 1.3"
+gem "standard-rails"

data/Gemfile.lock

@@ -0,0 +1,261 @@
+PATH
+  remote: .
+  specs:
+    ultimate_turbo_modal (1.0.0)
+      phlex-rails (>= 1.0, < 2.0)
+      rails (>= 7)
+      stimulus-rails
+      turbo-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.1)
+      actionpack (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.3.6)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activestorage (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activesupport (= 7.1.1)
+      marcel (~> 1.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    cgi (0.3.6)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.3)
+    drb (2.1.1)
+      ruby2_keywords
+    erb (4.0.3)
+      cgi (>= 0.3.3)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    phlex (1.8.1)
+      concurrent-ruby (~> 1.2)
+      erb (>= 4)
+      zeitwerk (~> 2.6)
+    phlex-rails (1.0.0)
+      phlex (~> 1.7)
+      rails (>= 6.1, < 8)
+      zeitwerk (~> 2.6)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.1)
+      actioncable (= 7.1.1)
+      actionmailbox (= 7.1.1)
+      actionmailer (= 7.1.1)
+      actionpack (= 7.1.1)
+      actiontext (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activemodel (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      bundler (>= 1.15.0)
+      railties (= 7.1.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.2)
+    reline (0.3.9)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    standard-rails (0.2.0)
+      lint_roller (~> 1.0)
+      rubocop-rails (~> 2.20.2)
+    stimulus-rails (1.3.0)
+      railties (>= 6.0.0)
+    stringio (3.0.8)
+    thor (1.3.0)
+    timeout (0.4.0)
+    turbo-rails (1.5.0)
+      actionpack (>= 6.0.0)
+      activejob (>= 6.0.0)
+      railties (>= 6.0.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  standard (~> 1.3)
+  standard-rails
+  ultimate_turbo_modal!
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Carl Mercier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,161 @@
+# The Ultimate Turbo Modal for Rails (UTMR)
+
+There are MANY Turbo/Hotwire/Stimulus modal dialog implementations out there, and it seems like everyone goes about it a different way. However, as you may have learned the hard way, the majority fall short in different, often subtle ways. They generally cover the basics quite well, but do not check all the boxes for real-world use.
+
+UTMR aims to be the be-all and end-all of Turbo Modals. I believe it is the best implementation and checks all the boxes. It is feature-rich, yet extremely easy to use.
+
+Under the hood, it uses [Stimulus](https://stimulus.hotwired.dev), [Turbo](https://turbo.hotwired.dev/), [el-transition](https://github.com/mmccall10/el-transition), and optionally [Idiomorph](https://github.com/bigskysoftware/idiomorph).
+
+It currently ships in a single flavor: Tailwind CSS. It is easy to create your own to suit your needs such as vanilla CSS or any other CSS framework you may prefer. See `lib/ultimate_turbo_modal/flavors/tailwind.rb` for the Tailwind code.
+
+
+ 
+ 
+## Features and capabilities
+
+- Extremely easy to use
+- Fully responsive
+- Does not break if a user navigates directly to a page that is usually shown in a modal
+- Opening a modal in a new browser tab (ie: right click) gracefully degrades without having to code a modal and non-modal version of the same page
+- Automatically handles URL history (ie: pushState) for shareable URLs
+- pushState URL optionally overrideable
+- Seamless support for multi-page navigation within the modal
+- Seamless support for forms with validations
+- Seamless support for Rails flash messages
+- Enter/leave animation (fade in/out)
+- Support for long, scrollable modals
+- Properly locks the background page when scrolling a long modal
+- Click outside the modal to dismiss
+- Keyboard control; ESC to dismiss
+- Automatic (or not) close button
+
+
+ 
+ 
+## Demo
+
+A demo application can be found at https://github.com/cmer/ultimate_turbo_modal-demo. A video demo can be seen here: [https://youtu.be/eG5uWTH74NA](https://youtu.be/eG5uWTH74NA)
+
+
+ 
+ 
+## Installation
+
+1. Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ultimate_turbo_modal
+
+2. Install the npm package:
+
+    $ yarn add ultimate_turbo_modal
+
+    - or -
+
+    $ bin/rails importmaps pin ultimate_turbo_modal
+
+3. Add the following as the first element in the `body` tag of `views/layouts/application.html.erb`:
+
+```erb
+<%= turbo_frame_tag "modal" %>
+``````
+
+4. Register the Stimulus controller in `app/javascript/controllers/index.js` adding the following lines at the end.
+
+```js
+import setupUltimateTurboModal from "ultimate_turbo_modal";
+setupUltimateTurboModal(application);
+```
+
+5. Optionally (but recommended), configure UTMR to use Idiomorph. See below for details.
+
+&nbsp;
+&nbsp;
+## Usage
+
+1. Wrap your view inside a `modal` block as follow:
+
+```erb
+<%= modal do %>
+  Hello World!
+<% end %>
+```
+
+2. Link to your view by specifying `modal` as the target Turbo Frame:
+
+```erb
+<%= link_to "Open Modal", "/hello_world", data: { turbo_frame: "modal" } %>
+```
+
+Clicking on the link will automatically open the content of the view inside a modal. If you open the link in a new tab, it will render normally outside of the modal. Nothing to do!
+
+If you need to do something a little bit more advanced when the view is shown outside of a modal, you can use the `#inside_modal?` method as such:
+
+```erb
+<% if inside_modal? %>
+  <h1 class="text-2xl mb-8">Hello from modal</h1>
+<% else %>
+  <h1 class="text-2xl mb-8">Hello from a normal page render</h1>
+<% end %>
+```
+
+&nbsp;
+&nbsp;
+## Options
+
+### `padding`, default: `true`
+
+Adds padding inside the modal.
+
+### `close_button`, default: `true`
+
+Shows or hide a close button (X) at the top right of the modal.
+
+### `advance_history`, default: `true`
+
+When opening the modal, the URL in the URL bar will change to the URL of the view being shown in the modal. The Back button dismisses the modal and navigates back.
+
+### `advance_history_url`, default: `nil`
+
+Override for the URL being shown in the URL bar when `advance_history` is enabled. Default is the actual URL.
+
+
+### Example usage with options
+
+```erb
+<%= modal(padding: true, close_button: false, advance_history_url: "/foo/bar") do %>
+  Hello World!
+<% end %>
+```
+
+## Installing & Configuring Idiomorph
+
+// Morph Turbo Frame rendering to allow navigation within Turbo Frames
+// without having to teardown the entire frame. This is needed to prevent
+// the leaving and entering animations from repeating when navigating
+// within the modal. You could optionally not use the code below if you
+// do not intend to allow navigation within the modal.
+//
+// Note that Turbo 8 will include Idiomorph by default.
+//
+// In the meantime, add `<script src="https://unpkg.com/idiomorph"></script>`
+// to your HTML <head>.
+addEventListener("turbo:before-frame-render", (event) => {
+  event.detail.render = (currentElement, newElement) => {
+    Idiomorph.morph(currentElement, newElement, {
+      morphstyle: 'innerHTML'
+    })
+  }
+})
+
+
+&nbsp;
+&nbsp;
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmer/ultimate_turbo_modal.
+
+&nbsp;
+&nbsp;
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/lib/ultimate_turbo_modal/base.rb

@@ -0,0 +1,93 @@
+class UltimateTurboModal::Base < Phlex::HTML
+  INCLUDES = %w[
+    Turbo::FramesHelper
+    Turbo::StreamsHelper
+    Phlex::Rails::Helpers::ContentTag
+    Phlex::Rails::Helpers::Routes
+    Phlex::Rails::Helpers::Tag
+  ].freeze
+
+  # @param padding [Boolean] Whether to add padding around the modal content
+  # @param close_button [Boolean] Whether to show a close button.
+  # @param advance_history [Boolean] Whether to update the browser history when opening and closing the modal
+  # @param advance_history_url [String] Override the URL to use when advancing the history
+  # @param request [ActionDispatch::Request] The current Rails request object
+  def initialize(padding: true, close_button: true, advance_history: true, advance_history_url: nil, request: nil)
+    @padding = padding
+    @close_button = close_button
+    @advance_history = advance_history
+    @advance_history_url = advance_history_url
+    @request = request
+
+    self.class.include Turbo::FramesHelper
+    self.class.include Turbo::StreamsHelper
+    self.class.include Phlex::Rails::Helpers::ContentTag
+    self.class.include Phlex::Rails::Helpers::Routes
+    self.class.include Phlex::Rails::Helpers::Tag
+  end
+
+  def template(&)
+    if turbo_frame?
+      turbo_frame_tag("modal") { modal(&) }
+    elsif turbo_stream?
+      Turbo::StreamsHelper.turbo_stream_action_tag("update", target: "modal") do
+        template { modal(&) }
+      end
+    else
+      modal(&)
+    end
+  end
+
+  private
+
+  attr_accessor :request
+
+  def padding?
+    !!@padding
+  end
+
+  def advance_history?
+    !!@advance_history
+  end
+
+  def close_button?
+    !!@close_button
+  end
+
+  def turbo_stream?
+    !!request&.format&.turbo_stream?
+  end
+
+  def turbo_frame?
+    !!request&.headers&.key?("Turbo-Frame")
+  end
+
+  def turbo?
+    turbo_stream? || turbo_frame?
+  end
+
+  def advance_history_url
+    return nil unless advance_history?
+    @advance_history_url || request.original_url
+  end
+
+  def method_missing(method, *, &block)
+    INCLUDES.each { |mod| include_if_defined(mod) }
+
+    if self.class.method_defined?(method)
+      send(method, *, &block)
+    else
+      super
+    end
+  end
+
+  def include_if_defined(mod_str)
+    if defined?(mod.constantize) && !self.class.included_modules.include?(mod.constantize)
+      self.class.include mod.constantize
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    self.class.included_modules.any? { |mod| mod.instance_methods.include?(method) } || super
+  end
+end

data/lib/ultimate_turbo_modal/flavors/tailwind.rb

@@ -0,0 +1,101 @@
+module UltimateTurboModal::Flavors
+  class Tailwind < UltimateTurboModal::Base
+    private
+
+    def modal(&)
+      div_dialog do
+        div_overlay
+        div_outer do
+          div_inner do
+            div_border do
+              button_close if close_button?
+              yield
+            end
+          end
+        end
+      end
+    end
+
+    def div_dialog(&)
+      div(id: "modal-container",
+        class: "relative z-10",
+        role: "dialog",
+        aria: {
+          labeled_by: "modal-title",
+          modal: true
+        },
+        data: {
+          controller: "modal",
+          modal_target: "container",
+          modal_advance_history_url_value: advance_history_url,
+          action: "turbo:submit-end->modal#submitEnd keyup@window->modal#closeWithKeyboard click@window->modal#outsideModalClicked click->modal#outsideModalClicked",
+          transition_enter: "ease-out duration-300",
+          transition_enter_start: "opacity-0",
+          transition_enter_end: "opacity-100",
+          transition_leave: "ease-in duration-200",
+          transition_leave_start: "opacity-100",
+          transition_leave_end: "opacity-0"
+        }, &)
+    end
+
+    def div_overlay(&)
+      div(id: "modal-overlay",
+        class: "fixed inset-0 bg-gray-500 bg-opacity-75 transition-opacity",
+        data: {
+          modal_target: "overlay",
+          action: "click->modal#outsideModalClicked"
+        })
+    end
+
+    def div_outer(&)
+      div(id: "modal-outer",
+        class: "fixed inset-0 z-10 overflow-y-auto sm:max-w-[80%] md:max-w-3xl sm:mx-auto m-4",
+        data: {
+          modal_target: "modal"
+        }, &)
+    end
+
+    def div_inner(&)
+      div(id: "modal-inner",
+        class: "flex min-h-full items-center justify-center p-1 sm:p-4",
+        data: {
+          modal_target: "innerModal"
+        }, &)
+    end
+
+    def div_border(&)
+      klass = "relative transform overflow-hidden rounded-lg bg-white text-left shadow-xl transition-all sm:my-8 sm:max-w-3xl"
+      klass = "#{klass} p-2 sm:p-4 md:p-6" if @padding == true
+      klass = "#{klass} #{@padding}" if @padding.is_a?(String)
+      div(id: "modal-border", class: klass, &)
+    end
+
+    def button_close(&)
+      div(class: "absolute top-3 right-3") do
+        button(type: "button",
+          aria: {label: "close"},
+          class: "ml-auto inline-flex items-center rounded bg-transparent p-1 text-sm text-gray-400 bg-white bg-opacity-20 hover:bg-gray-100 hover:bg-opacity-70 hover:text-gray-900",
+          data: {
+            action: "modal#hideModal"
+          }) { icon_close }
+      end
+    end
+
+    def icon_close
+      svg(
+        xmlns: "http://www.w3.org/2000/svg",
+        fill: "none",
+        viewbox: "0 0 24 24",
+        stroke_width: "1.5",
+        stroke: "currentColor",
+        class: "w-5 h-5"
+      ) do |s|
+        s.path(
+          stroke_linecap: "round",
+          stroke_linejoin: "round",
+          d: "M6 18L18 6M6 6l12 12"
+        )
+      end
+    end
+  end
+end

data/lib/ultimate_turbo_modal/helpers/controller_helper.rb

@@ -0,0 +1,13 @@
+module UltimateTurboModal::Helpers
+  module ControllerHelper
+    extend ActiveSupport::Concern
+
+    def inside_modal?
+      request.headers["Turbo-Frame"] == "modal"
+    end
+
+    included do
+      helper_method :inside_modal?
+    end
+  end
+end

data/lib/ultimate_turbo_modal/helpers/stream_helper.rb

@@ -0,0 +1,12 @@
+module UltimateTurboModal::Helpers
+  module StreamHelper
+    def modal(message)
+      case message.to_s.downcase.to_sym
+      when :close, :hide
+        turbo_stream_action_tag "modal", message: "hide"
+      else
+        raise ArgumentError, "Unknown modal message: #{message}"
+      end
+    end
+  end
+end

data/lib/ultimate_turbo_modal/helpers/view_helper.rb

@@ -0,0 +1,9 @@
+module UltimateTurboModal::Helpers
+  module ViewHelper
+    def modal(**)
+      render UltimateTurboModal.new(request:, **) do
+        yield
+      end
+    end
+  end
+end

data/lib/ultimate_turbo_modal/railtie.rb

@@ -0,0 +1,24 @@
+require "rails"
+require "rails/railtie"
+require "phlex-rails"
+require "turbo-rails"
+require "ultimate_turbo_modal/helpers/controller_helper"
+require "ultimate_turbo_modal/helpers/view_helper"
+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
+        include UltimateTurboModal::Helpers::ControllerHelper
+      end
+    end
+
+    initializer "ultimate_turbo_modal.action_view" do
+      ActiveSupport.on_load(:action_view) do
+        include UltimateTurboModal::Helpers::ViewHelper
+      end
+      Turbo::Streams::TagBuilder.include(UltimateTurboModal::Helpers::StreamHelper)
+    end
+  end
+end

data/lib/ultimate_turbo_modal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UltimateTurboModal
+  VERSION = "1.0.0"
+end

data/lib/ultimate_turbo_modal.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "ultimate_turbo_modal/version"
+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
+
+module UltimateTurboModal
+  extend self
+
+  DEFAULT_FLAVOR = :tailwind
+
+  def new(**)
+    modal_class.new(**)
+  end
+
+  def modal_class
+    "UltimateTurboModal::Flavors::#{flavor.to_s.classify}".constantize
+  end
+
+  def flavor=(flavor)
+    @flavor = flavor
+  end
+
+  def flavor
+    defined?(@flavor) ? @flavor&.to_sym : DEFAULT_FLAVOR
+  end
+
+  class Error < StandardError; end
+end

data/sig/ultimate_turbo_modal.rbs

@@ -0,0 +1,3 @@
+module UltimateTurboModal
+  VERSION: String
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ultimate_turbo_modal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phlex-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy-to-use, flexible, and powerful Turbo Modal solution for Rails
+  7+ built with Stimulus.js, Tailwind CSS and Hotwire.
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- ".standard.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ultimate_turbo_modal.rb
+- lib/ultimate_turbo_modal/base.rb
+- lib/ultimate_turbo_modal/flavors/tailwind.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
+- sig/ultimate_turbo_modal.rbs
+homepage: https://github.com/cmer/ultimate_turbo_modal
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: UTMR aims to be the be-all and end-all of Turbo Modals.
+test_files: []