ultimate_turbo_modal 2.0.4 → 2.1.1

data/demo-app/.gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/app/assets/builds/*
+!/app/assets/builds/.keep
+
+/node_modules

data/demo-app/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.9

data/demo-app/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.3.9
+nodejs 22.14.0

data/demo-app/Gemfile

@@ -0,0 +1,41 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby file: ".tool-versions"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 8.0.2"
+
+# The modern asset pipeline for Rails [https://github.com/rails/propshaft]
+gem "propshaft"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Use sqlite3 as the database for Active Record
+gem "sqlite3"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 6.6"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+  gem "web-console"
+end
+
+group :development do
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+gem "cssbundling-rails"
+gem "jsbundling-rails"
+gem "faker"
+gem "ultimate_turbo_modal", path: "../"

data/demo-app/Gemfile.lock

@@ -0,0 +1,248 @@
+PATH
+  remote: ..
+  specs:
+    ultimate_turbo_modal (2.0.4)
+      actionpack
+      activesupport
+      phlex-rails
+      railties
+      stimulus-rails
+      turbo-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      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)
+      useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    bindex (0.8.1)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    cssbundling-rails (1.4.3)
+      railties (>= 6.0.0)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.1)
+    erubi (1.13.1)
+    faker (3.5.1)
+      i18n (>= 1.8.11, < 2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jsbundling-rails (1.3.1)
+      railties (>= 6.0.0)
+    logger (1.7.0)
+    loofah (2.24.0)
+      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.4)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.7-arm64-darwin)
+      racc (~> 1.4)
+    phlex (1.11.0)
+    phlex-rails (1.2.2)
+      phlex (>= 1.10, < 2)
+      railties (>= 6.1, < 9)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    propshaft (1.1.0)
+      actionpack (>= 7.0.0)
+      activesupport (>= 7.0.0)
+      rack
+      railties (>= 7.0.0)
+    psych (5.2.3)
+      date
+      stringio
+    puma (6.6.0)
+      nio4r (~> 2.0)
+    racc (1.8.1)
+    rack (3.1.12)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.2.1)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    securerandom (0.4.1)
+    sqlite3 (2.6.0-arm64-darwin)
+    stimulus-rails (1.3.4)
+      railties (>= 6.0.0)
+    stringio (3.1.6)
+    thor (1.3.2)
+    timeout (0.4.3)
+    turbo-rails (2.0.13)
+      actionpack (>= 7.1.0)
+      railties (>= 7.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    web-console (4.2.1)
+      actionview (>= 6.0.0)
+      activemodel (>= 6.0.0)
+      bindex (>= 0.4.0)
+      railties (>= 6.0.0)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
+  arm64-darwin-24
+
+DEPENDENCIES
+  cssbundling-rails
+  debug
+  faker
+  jsbundling-rails
+  propshaft
+  puma (~> 6.6)
+  rails (~> 8.0.2)
+  sqlite3
+  stimulus-rails
+  turbo-rails
+  tzinfo-data
+  ultimate_turbo_modal!
+  web-console
+
+RUBY VERSION
+   ruby 3.3.9p170
+
+BUNDLED WITH
+   2.6.7

data/demo-app/Procfile.dev

@@ -0,0 +1,3 @@
+web: bin/rails server -p 3000
+css: yarn build:css --watch
+js: yarn build --watch

data/demo-app/README.md

@@ -0,0 +1,15 @@
+# The Ultimate Turbo Modal for Rails - Demo
+
+This is a demo application. You can find the Ruby Gem and instructions on how to use
+it in your own application at https://github.com/cmer/ultimate_turbo_modal.
+
+ 
+ 
+# Getting up and running...
+
+```sh
+bin/rails db:create db:migrate db:seed
+yarn install
+bin/dev
+open http://localhost:3000
+```

data/demo-app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/demo-app/app/assets/stylesheets/application.css

@@ -0,0 +1,42 @@
+@import 'tailwindcss';
+@import 'ultimate_turbo_modal/dist/vanilla.css' layer(components);
+@import 'flatpickr/dist/flatpickr.css' layer(base);
+
+@plugin '@tailwindcss/aspect-ratio';
+@plugin '@tailwindcss/forms';
+@plugin '@tailwindcss/typography';
+
+@custom-variant dark (&:is(.dark *));
+
+@theme {
+  --font-sans:
+    Inter var, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
+    'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif,
+    'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
+}
+
+@layer base {
+
+  *,
+  ::after,
+  ::before,
+  ::backdrop,
+  ::file-selector-button {
+    border-color: var(--color-gray-200, currentcolor);
+  }
+}
+
+#ts-notice:not(:empty) {
+  position: fixed;
+  top: 0.5rem;
+  right: 0.5rem;
+  width: auto;
+  border: 1px solid;
+  padding: 1rem;
+  margin-top: 2.5rem;
+  margin-bottom: 2.5rem;
+  color: black;
+  border-color: rgba(0, 148, 0, 0.8);
+  background-color: rgba(176, 255, 176, 0.6);
+  max-width: 32rem;
+}

data/demo-app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+class ApplicationController < ActionController::Base
+  include SetFlavor
+
+  def set_modal_properties
+    %i[padding advance close_button].each do |it|
+      instance_variable_set("@#{it}", params[it] == "1")
+    end
+    @override_url = "/custom-advance-history-url" if @advance
+  end
+end

data/demo-app/app/controllers/concerns/set_flavor.rb

@@ -0,0 +1,10 @@
+module SetFlavor
+  extend ActiveSupport::Concern
+
+  included do
+    before_action do
+      UltimateTurboModal.flavor = request.params[:flavor] || cookies[:flavor] || "tailwind"
+      cookies.permanent[:flavor] = UltimateTurboModal.flavor
+    end
+  end
+end

data/demo-app/app/controllers/hide_from_backends_controller.rb

@@ -0,0 +1,34 @@
+# Sometimes it might be desirable to close the modal from the backend.
+# This can be done with Turbo Stream as such:
+#
+#   <%= turbo_stream.modal(:hide) %>
+#
+# This controller is an example of how to do that.
+class HideFromBackendsController < ApplicationController
+  def new
+    # Show form
+  end
+
+  def create
+    form_is_valid? ? close_modal : render(:new, status: :unprocessable_entity)
+  end
+
+  private
+
+  def close_modal
+    if inside_modal?
+      # `create.turbo_stream.erb` will be rendered.
+      # A message will appear in the browser, and the backend
+      # will trigger a modal close via turbo stream.
+    else
+      # if not inside a modal, simply redirect
+      redirect_to("/")
+    end
+  end
+
+  def form_is_valid?
+    return true if request.params[:action] == 'new'
+    params[:email].present?
+  end
+  helper_method :form_is_valid?
+end

data/demo-app/app/controllers/modal_controller.rb

@@ -0,0 +1,11 @@
+class ModalController < ApplicationController
+  before_action :set_modal_properties
+
+  def index
+    @post = Post.first
+  end
+
+  def show
+    @header = !(params[:id] == "photo")
+  end
+end

data/demo-app/app/controllers/posts_controller.rb

@@ -0,0 +1,69 @@
+class PostsController < ApplicationController
+  before_action :set_post, only: %i[show edit update destroy]
+  before_action :set_modal_properties
+
+  # GET /posts
+  def index
+    @posts = Post.all
+  end
+
+  # GET /posts/1
+  def show
+    @modal_title = @post.title
+  end
+
+  # GET /posts/new
+  def new
+    @post = Post.new
+    @modal_title = "New Post"
+  end
+
+  # GET /posts/1/edit
+  def edit
+    @modal_title = "Edit Post"
+  end
+
+  # POST /posts
+  def create
+    @post = Post.new(post_params)
+    @modal_title = "New Post"
+
+    if @post.save
+      redirect_to "/",
+                  notice: "Post was successfully created.",
+                  status: :see_other
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /posts/1
+  def update
+    if @post.update(post_params)
+      redirect_to "/",
+                  notice: "Post was successfully updated.",
+                  status: :see_other
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /posts/1
+  def destroy
+    redirect_to "/",
+                notice: "Post was successfully destroyed. (but not really)",
+                status: :see_other
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_post
+    @post = Post.find(params[:id])
+  end
+
+  # Only allow a list of trusted parameters through.
+  def post_params
+    params.require(:post).permit(:title, :body)
+  end
+end

data/demo-app/app/controllers/welcome_controller.rb

@@ -0,0 +1,2 @@
+class WelcomeController < ApplicationController
+end

data/demo-app/app/helpers/application_helper.rb

@@ -0,0 +1,9 @@
+module ApplicationHelper
+  def h1_classes
+    "text-2xl font-bold tracking-tight text-gray-900 sm:text-4xl border-b mb-2 dark:text-white"
+  end
+
+  def button_classes
+    "rounded-md bg-indigo-600 px-3.5 py-2.5 text-sm font-semibold text-white shadow-xs hover:bg-indigo-500 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-600"
+  end
+end

data/demo-app/app/javascript/application.js

@@ -0,0 +1,4 @@
+import { Turbo } from "@hotwired/turbo-rails";
+import "./controllers";
+
+window.Turbo = Turbo;

data/demo-app/app/javascript/controllers/application.js

@@ -0,0 +1,13 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus = application
+
+// Flatpickr
+import Flatpickr from "stimulus-flatpickr"
+application.register('flatpickr', Flatpickr)
+
+export { application }

data/demo-app/app/javascript/controllers/dark_mode_controller.js

@@ -0,0 +1,28 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["toggle"];
+
+  toggleTheme() {
+    // Toggle the dark class on the html element
+    if (document.documentElement.classList.contains('dark')) {
+      document.documentElement.classList.remove('dark');
+      this.setCookie('theme', 'light');
+    } else {
+      document.documentElement.classList.add('dark');
+      this.setCookie('theme', 'dark');
+    }
+  }
+
+  setCookie(name, value, days = 7) {
+    const expires = new Date(Date.now() + days * 864e5).toUTCString();
+    document.cookie = `${name}=${value};expires=${expires};path=/`;
+  }
+
+  getCookie(name) {
+    const value = `; ${document.cookie}`;
+    const parts = value.split(`; ${name}=`);
+    if (parts.length === 2) return parts.pop().split(';').shift();
+    return null;
+  }
+}

data/demo-app/app/javascript/controllers/flash_controller.js

@@ -0,0 +1,9 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    setTimeout(() => {
+      this.element.remove()
+    }, 3000)
+  }
+}

data/demo-app/app/javascript/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.element.textContent = "Hello World!"
+  }
+}

data/demo-app/app/javascript/controllers/index.js

@@ -0,0 +1,15 @@
+// This file is auto-generated by ./bin/rails stimulus:manifest:update
+// Run that command whenever you add a new controller or create them with
+// ./bin/rails generate stimulus controllerName
+
+import { application } from "./application"
+
+import DarkModeController from "./dark_mode_controller"
+application.register("dark-mode", DarkModeController)
+
+import FlashController from "./flash_controller"
+application.register("flash", FlashController)
+
+// import { UltimateTurboModalController } from "../../../../ultimate_turbo_modal-rails/javascript/dist/ultimate_turbo_modal.js"
+import { UltimateTurboModalController } from "ultimate_turbo_modal"
+application.register("modal", UltimateTurboModalController)

data/demo-app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/demo-app/app/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ApplicationRecord
+  validates :title, presence: true
+  validates :body, presence: true
+end

data/demo-app/app/views/hide_from_backends/_notice.html.erb

@@ -0,0 +1,10 @@
+<% if local_assigns[:message] %>
+  <div id="ts-notice">
+    <%= local_assigns[:message] %>
+    <div class="mt-3 font-medium">
+      <a href="#" onclick="document.getElementById('ts-notice').innerHTML=''; return false;">Close</a>
+    </div>
+  </div>
+<% else %>
+  <div id="ts-notice"></div>
+<% end %>

data/demo-app/app/views/hide_from_backends/create.turbo_stream.erb

@@ -0,0 +1,2 @@
+<%= turbo_stream.modal(:hide) %>
+<%= turbo_stream.replace "ts-notice", partial: "notice", locals: { message: "Modal close was triggered by the backend via Turbo Stream @ #{Time.now}!" } %>