swal_rails 0.3.1.beta1

data/lib/swal_rails/configuration.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module SwalRails
+  # Holds runtime configuration for the gem.
+  #
+  # A default is created on first access; override via an initializer:
+  #
+  #   SwalRails.configure do |config|
+  #     config.confirm_mode = :turbo_override
+  #     config.flash_map[:notice] = { icon: "success", toast: true }
+  #   end
+  class Configuration
+    CONFIRM_MODES = %i[off data_attribute turbo_override both].freeze
+
+    attr_accessor :default_options,
+                  :flash_keys_as_meta,
+                  :respect_reduced_motion,
+                  :expose_window_swal
+    attr_reader :confirm_mode, :flash_map, :i18n_scope
+
+    def initialize
+      @confirm_mode = :data_attribute
+      @flash_keys_as_meta = true
+      @respect_reduced_motion = true
+      @expose_window_swal = true
+      @i18n_scope = "swal_rails"
+      @default_options = {
+        buttonsStyling: true,
+        reverseButtons: false,
+        focusConfirm: true,
+        returnFocus: true
+      }
+      @flash_map = default_flash_map
+    end
+
+    def confirm_mode=(value)
+      value = value.to_sym
+      raise ArgumentError, "confirm_mode must be one of #{CONFIRM_MODES.inspect}, got #{value.inspect}" unless CONFIRM_MODES.include?(value)
+
+      @confirm_mode = value
+    end
+
+    def i18n_scope=(value)
+      @i18n_scope = value.to_s
+    end
+
+    # Replace the full flash map. Prefer editing individual keys via `flash_map[:key] = ...`.
+    def flash_map=(value)
+      raise ArgumentError, "flash_map must be a Hash" unless value.is_a?(Hash)
+
+      @flash_map = value.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    end
+
+    # Snapshot safe for serialization into a meta tag / JSON.
+    def to_client_payload
+      {
+        confirmMode: confirm_mode,
+        respectReducedMotion: respect_reduced_motion,
+        exposeWindowSwal: expose_window_swal,
+        defaultOptions: default_options,
+        flashMap: flash_map,
+        i18n: i18n_payload
+      }
+    end
+
+    private
+
+    def default_flash_map
+      {
+        notice: { icon: "success", toast: true, position: "top-end", timer: 3000, timerProgressBar: true, showConfirmButton: false },
+        success: { icon: "success", toast: true, position: "top-end", timer: 3000, timerProgressBar: true, showConfirmButton: false },
+        alert: { icon: "error",   toast: false, timer: nil },
+        error: { icon: "error",   toast: false, timer: nil },
+        warning: { icon: "warning", toast: true, position: "top-end", timer: 4000, timerProgressBar: true, showConfirmButton: false },
+        info: { icon: "info", toast: true, position: "top-end", timer: 3000, timerProgressBar: true, showConfirmButton: false }
+      }
+    end
+
+    def i18n_payload
+      return {} unless defined?(I18n)
+
+      %i[confirm_button_text cancel_button_text deny_button_text close_button_aria_label].each_with_object({}) do |key, h|
+        translation = I18n.t("#{i18n_scope}.#{key}", default: nil)
+        h[key] = translation if translation
+      end
+    end
+  end
+end

data/lib/swal_rails/engine.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module SwalRails
+  class Engine < ::Rails::Engine
+    isolate_namespace SwalRails
+
+    config.swal_rails = SwalRails.configuration
+
+    initializer "swal_rails.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join("vendor/javascript/sweetalert2").to_s
+        app.config.assets.paths << root.join("vendor/stylesheets/sweetalert2").to_s
+        app.config.assets.paths << root.join("app/assets/javascripts").to_s
+        app.config.assets.paths << root.join("app/assets/stylesheets").to_s
+        app.config.assets.precompile += %w[
+          sweetalert2.js sweetalert2.min.js
+          sweetalert2.all.js sweetalert2.all.min.js
+          sweetalert2.esm.js sweetalert2.esm.min.js
+          sweetalert2.esm.all.js sweetalert2.esm.all.min.js
+          sweetalert2.css sweetalert2.min.css
+          themes/bootstrap-4.css themes/bootstrap-5.css
+          themes/borderless.css themes/bulma.css
+          themes/material-ui.css themes/minimal.css
+          swal_rails/index.js swal_rails/confirm.js swal_rails/flash.js swal_rails/chain.js
+          swal_rails/controllers/swal_controller.js
+        ]
+      end
+    end
+
+    initializer "swal_rails.importmap", before: "importmap" do |app|
+      next unless app.config.respond_to?(:importmap)
+
+      app.config.importmap.paths << root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+      app.config.importmap.cache_sweepers << root.join("vendor/javascript")
+    end
+
+    initializer "swal_rails.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper SwalRails::Helpers
+      end
+      ActiveSupport.on_load(:action_view) do
+        include SwalRails::Helpers
+      end
+    end
+
+    initializer "swal_rails.i18n" do
+      config.i18n.load_path += Dir[root.join("config/locales/*.yml").to_s]
+    end
+  end
+end
+
+require "swal_rails/helpers"

data/lib/swal_rails/helpers.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SwalRails
+  # View helpers exposed to ActionView and ActionController.
+  #
+  # Place `swal_rails_meta_tags` in your layout `<head>` to emit:
+  #   - the global client config (once per request)
+  #   - the per-request flash payload
+  module Helpers
+    # Emits the two meta tags the JS runtime reads on boot.
+    def swal_rails_meta_tags
+      safe_join([swal_config_meta_tag, swal_flash_meta_tag].compact, "\n")
+    end
+
+    def swal_config_meta_tag
+      payload = SwalRails.configuration.to_client_payload
+      tag.meta(name: "swal-config", content: payload.to_json)
+    end
+
+    def swal_flash_meta_tag
+      return unless SwalRails.configuration.flash_keys_as_meta
+      return if flash.blank?
+
+      payload = build_flash_payload
+      return if payload.empty?
+
+      tag.meta(name: "swal-flash", content: payload.to_json)
+    end
+
+    # Rails idiom: `flash[:notice] = model.errors.full_messages` — expand arrays
+    # into one entry per message so each fires its own Swal.
+    #
+    # Also accepts per-request option overrides:
+    #   flash[:notice] = "Saved"                                       # string shortcut
+    #   flash[:notice] = { text: "Saved", icon: "star", timer: 5000 }  # full SA2 options
+    def build_flash_payload
+      flash.to_h.flat_map do |key, message|
+        flash_messages(message).filter_map do |m|
+          next if m.blank?
+
+          options = m.is_a?(Hash) ? m.symbolize_keys : { text: m.to_s }
+          { key: key.to_s, options: options }
+        end
+      end
+    end
+
+    # Arrays expand into one entry per element. A Hash is a single entry —
+    # don't let `Array(hash)` destructure it into key/value pairs.
+    def flash_messages(message)
+      message.is_a?(Array) ? message : [message]
+    end
+
+    # Generates an inline `<script>` that fires a single Swal.
+    #
+    # Usage: `<%= swal_tag(title: "Hi", icon: "info") %>`
+    # Under a strict CSP: `<%= swal_tag({ title: "Hi" }, nonce: true) %>`
+    #
+    # When `nonce: true` is passed and ActionView's CSP helper is available,
+    # Rails substitutes the per-request nonce so the tag survives a
+    # `script-src 'self' 'nonce-…'` policy.
+    def swal_tag(options = {}, html_options = {})
+      # json_escape neutralizes `</script>`, `<!--`, U+2028 and U+2029 —
+      # the four sequences that can break out of a <script> block.
+      payload = ERB::Util.json_escape(options.to_json)
+      tag_options = { type: "module" }.merge(html_options)
+      tag_options.delete(:nonce) if tag_options[:nonce] == true && !respond_to?(:content_security_policy_nonce, true)
+      javascript_tag(<<~JS.strip, **tag_options)
+        import Swal from "sweetalert2";
+        Swal.fire(#{payload});
+      JS
+    end
+
+    # Fires a multi-step confirm chain inline on page load.
+    #
+    # Usage: `<%= swal_chain_tag([{ title: "Sure?" }, { title: "Really?" }]) %>`
+    # Under a strict CSP: `<%= swal_chain_tag(steps, nonce: true) %>`
+    #
+    # Same XSS hardening and CSP nonce handling as `swal_tag`. Each step is
+    # a full SweetAlert2 options Hash; `onConfirmed:` / `onDenied:` keys
+    # declare nested sub-chains for conditional branching.
+    def swal_chain_tag(steps, html_options = {})
+      # Array(hash) destructures a Hash into [[k, v], ...] pairs — wrap
+      # single Hash steps manually so shorthand `swal_chain_tag(title: "Hi")`
+      # produces `[{"title":"Hi"}]`, not `[["title","Hi"]]`.
+      steps = [steps] unless steps.is_a?(Array)
+      payload = ERB::Util.json_escape(steps.to_json)
+      tag_options = { type: "module" }.merge(html_options)
+      tag_options.delete(:nonce) if tag_options[:nonce] == true && !respond_to?(:content_security_policy_nonce, true)
+      javascript_tag(<<~JS.strip, **tag_options)
+        import Swal from "sweetalert2";
+        import { chainDialogs } from "swal_rails/chain";
+        chainDialogs(Swal, #{payload});
+      JS
+    end
+  end
+end

data/lib/swal_rails/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SwalRails
+  VERSION = "0.3.1.beta1"
+  SWEETALERT2_VERSION = "11.26.24"
+end

data/lib/swal_rails.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "swal_rails/version"
+
+module SwalRails
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end
+
+require_relative "swal_rails/configuration"
+require_relative "swal_rails/helpers"
+require_relative "swal_rails/engine" if defined?(Rails::Engine)

data/vendor/javascript/sweetalert2/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tristan Edwards & Limon Monte
+
+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.
+