ultimate_turbo_modal 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1149adbc9b8dd940af463061bdfc46d09d1071531a0f08d73538a41c2d44ef52
-  data.tar.gz: d5ce0192c54ff6f731758515a9ed60f839315759b70e9ceaba57ce2847ed298f
+  metadata.gz: af46e6d6c899d0fcf8054272b157d5e0f286e183e9c0b15c4e3b883df629d4f4
+  data.tar.gz: 91a99b9b60ea2892b2c030027d073218b4d751dd155a0bb84420bc6e60db628e
 SHA512:
-  metadata.gz: 07b07aa40ab5c4000a6c06fa1d3ed410f7bebc3d44c46a670371e8e1044a168167cdd8a402865d26e3314b18c2e013b451a542c45a2a42e33d19cc8ce7b31f82
-  data.tar.gz: 5dc24349c452b9c7c8a9280d4f8dd8a0c36dd89efb261b5aa8ae6715f3921aab0e15a128e704ce2eb21f0a94158ba621ca7760289efc1df17fa7180a1e2cbc1f
+  metadata.gz: ccff10a4c4fee7a554c58632d9850507be533877333b0b8caadf2966fbc5244719f828fdb4507674668129c6bfebee1e7cb3e7a7fae5fc1b8238eae8fb5ea637
+  data.tar.gz: d636a2425ce101e4339cec01573e6a29aea861f36328bf4e6a8cd3513ccfe9a5979b4fa424fa69320a809ff94f80f4e28d3f39bbc7f6f6d6426217191fe9ea4c

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [1.1.2] - 2023-11-01
+
+- Added configuration block
+
+## [1.1.2] - 2023-10-31
+
+- Bug fix
 
 ## [1.1.0] - 2023-10-31
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ultimate_turbo_modal (1.1.1)
+    ultimate_turbo_modal (1.1.2)
       phlex-rails (>= 1.0, < 2.0)
       rails (>= 7)
       stimulus-rails

data/README.md

@@ -6,7 +6,7 @@ UTMR aims to be the be-all and end-all of Turbo Modals. I believe it is the best
 
 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 two flavors: Tailwind CSS, and regular, vanilla 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/vanilla.rb` for an example code.
+It currently ships in a two flavors: Tailwind CSS, and regular, vanilla CSS. It is easy to create your own variant to suit your needs. See `lib/ultimate_turbo_modal/flavors/vanilla.rb` for an example code.
 
 
  
@@ -34,7 +34,7 @@ It currently ships in a two flavors: Tailwind CSS, and regular, vanilla CSS. It
  
 ## 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)
+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/BVRDXLN1I78](https://youtu.be/BVRDXLN1I78).
 
 
  
@@ -59,10 +59,15 @@ A demo application can be found at https://github.com/cmer/ultimate_turbo_modal-
 <%= turbo_frame_tag "modal" %>
 ``````
 
-4. Set your desired flavor at `app/config/initializers/modal.rb`. The default is `:tailwind`.
+4. Set your desired flavor and default configuration at `app/config/initializers/ultimate_turbo_modal.rb`.
 
 ```ruby
-UltimateTurboModal.flavor = :tailwind # or :vanilla
+UltimateTurboModal.configure do |config|
+  config.flavor = :tailwind
+  config.padding = true
+  config.advance = true
+  config.close_button = true
+end
 ```
 
 5. Register the Stimulus controller in `app/javascript/controllers/index.js` adding the following lines at the end.
@@ -72,7 +77,33 @@ import setupUltimateTurboModal from "ultimate_turbo_modal";
 setupUltimateTurboModal(application);
 ```
 
-6. Optionally (but recommended), configure UTMR to use Idiomorph. See below for details.
+6. If using the Tailwind flavor, add the following to `tailwind.config.js`:
+
+```
+// For npm/yarn
+const { getUltimateTurboModalPath } = require('ultimate_turbo_modal/gemPath');
+
+// If using Importmaps, use the following instead:
+// const { execSync } = require('child_process');
+//
+// function getUltimateTurboModalPath() {
+//  const path = execSync('bundle show ultimate_turbo_modal').toString().trim();
+//  return `${path}/**/*.{erb,html,rb}`;
+//}
+```
+
+and then in the `content` section, add `getUltimateTurboModalPath()` as follow:
+
+```
+  content: [
+    './public/*.html',
+    './app/helpers/**/*.rb',
+    './app/javascript/**/*.js',
+    './app/views/**/*.{erb,haml,html,slim,rb}',
+    getUltimateTurboModalPath()
+```
+
+7. Optionally (but recommended), configure UTMR to use Idiomorph. See below for details.
 
 &nbsp;
 &nbsp;

data/lib/ultimate_turbo_modal/base.rb

@@ -1,29 +1,28 @@
 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 [Boolean] Whether to update the browser history when opening and closing the modal
   # @param advance_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: true, request: nil)
+  def initialize(
+    padding: UltimateTurboModal.configuration.padding,
+    close_button: UltimateTurboModal.configuration.close_button,
+    advance: UltimateTurboModal.configuration.advance,
+    request: nil
+  )
     @padding = padding
     @close_button = close_button
-    @advance = advance
-    @advance_url = advance if advance && advance.is_a?(String)
+    @advance = !!advance
+    @advance_url = advance if advance.present? && advance.is_a?(String)
     @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
+    unless self.class.include?(Turbo::FramesHelper)
+      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
   end
 
   def template(&)
@@ -71,16 +70,6 @@ class UltimateTurboModal::Base < Phlex::HTML
     @advance_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

data/lib/ultimate_turbo_modal/configuration.rb

@@ -0,0 +1,50 @@
+module UltimateTurboModal
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  delegate :flavor, :flavor=, :close_button, :close_button=,
+    :advance, :advance=, :padding, :padding=, to: :configuration
+
+  class Configuration
+    attr_reader :flavor, :close_button, :advance, :padding
+
+    def initialize
+      @flavor = :tailwind
+      @close_button = true
+      @advance = true
+      @padding = true
+    end
+
+    def flavor=(flavor)
+      raise ArgumentError.new("Flavor must be a symbol.") unless flavor.is_a?(Symbol) || flavor.is_a?(String)
+      @flavor = flavor.to_sym
+    end
+
+    def close_button=(close_button)
+      raise ArgumentError.new("Close button must be a boolean.") unless [true, false].include?(close_button)
+      @close_button = close_button
+    end
+
+    def advance=(advance)
+      raise ArgumentError.new("Advance must be a boolean.") unless [true, false].include?(advance)
+      @advance = advance
+    end
+
+    def padding=(padding)
+      if [true, false].include?(padding) || padding.is_a?(String)
+        @padding = padding
+      else
+        raise ArgumentError.new("Padding must be a boolean or a String.")
+      end
+    end
+  end
+end
+
+# Make sure the configuration object is set up when the gem is loaded.
+UltimateTurboModal.configure

data/lib/ultimate_turbo_modal/version.rb

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

data/lib/ultimate_turbo_modal.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "ultimate_turbo_modal/version"
+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|
@@ -10,8 +11,6 @@ end
 module UltimateTurboModal
   extend self
 
-  DEFAULT_FLAVOR = :tailwind
-
   def new(**)
     modal_class.new(**)
   end
@@ -20,13 +19,5 @@ module UltimateTurboModal
     "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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultimate_turbo_modal
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Carl Mercier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails
@@ -92,6 +92,7 @@ files:
 - Rakefile
 - 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