swal_rails 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c8d829f1cd2f384c7a40bde0a723bd3a3fd04dccb6fea15b3bd6c543e2a3a7
-  data.tar.gz: d1b4801ab03a209a14051665b0d410c35971dcc2e0bb17ca16d72e724f446a0f
+  metadata.gz: db0cf6b419c2e989dfcc877d644fc85244f2c85e0fc2e012661b594854d5cdad
+  data.tar.gz: f26da33eb89b79b5338eb822281f89d5bc43376ca3a22f39969aaba3c7440f66
 SHA512:
-  metadata.gz: a72b02157f593c15a9886e2e7c20ebcf6140048cd7f231742096f91215f28cb9273c50b9772405c8d611450d68b89715805f3015393ac15177e28cc981354f22
-  data.tar.gz: e4590aa66cbd7429b85b5d4a194911a3c1011144f96903293b40eb02ddc72ebb8153da0c0e0bb6fb0b41b327058bfb6a81e81108a66287845af7e4169fcfcf41
+  metadata.gz: 35d5a3a5d411f39870070332ab2516987d9f6345ca3cf17f3fb6b0958f1ae9680608bb1a355ce2ffad3257cabb3e384fee9533018756c90784a29fc176c456c9
+  data.tar.gz: e48305dfd6fdb0bcb3bab2cbafbf4f56a017006e5d2d95cb716ecff61fa15ffd4abea636206c04e7e57f76a15a7d9888bd64cf6f114ce21bf78a346b52b43424

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.3] - 2026-04-25
+
+### Added
+- Boot-time initializer drift detection. The gem ships
+  `SwalRails::INITIALIZER_VERSION`, the install template stamps
+  `config.initializer_version = "<current>"`, and a Rails initializer
+  hooked after `:load_config_initializers` logs a one-line warning when
+  the user's stamp is missing or trails the gem's expected value. Includes
+  the regenerate command in the message:
+  `bin/rails g swal_rails:install --skip-layout --force`.
+- `config.silence_initializer_warning` (Boolean, default `false`) opt-out
+  for users who don't want to regenerate.
+
 ## [0.3.2] - 2026-04-25
 
 First stable release on top of the `0.3.1.beta1` + `0.3.1.beta2`

data/lib/generators/swal_rails/install/templates/initializer.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 SwalRails.configure do |config|
+  # Stamps this initializer against the template version that shipped with
+  # the installed gem. The boot-time check warns if you upgrade the gem to
+  # a version with a newer template — regenerate with:
+  #   bin/rails g swal_rails:install --skip-layout --force
+  # Set `config.silence_initializer_warning = true` to silence.
+  config.initializer_version = "<%= SwalRails::INITIALIZER_VERSION %>"
+
   # How confirmation modals are wired.
   #   :off             — do nothing, use Swal manually
   #   :data_attribute  — intercept clicks/submits on [data-swal-confirm] (default, non-intrusive)

data/lib/swal_rails/configuration.rb

@@ -17,7 +17,9 @@ module SwalRails
                   :flash_keys_as_meta,
                   :respect_reduced_motion,
                   :expose_window_swal,
-                  :flash_stack_delay
+                  :flash_stack_delay,
+                  :initializer_version,
+                  :silence_initializer_warning
     attr_reader :confirm_mode, :flash_map, :i18n_scope, :flash_array_mode
 
     def initialize
@@ -28,6 +30,12 @@ module SwalRails
       @flash_array_mode = :sequential
       @flash_stack_delay = 500
       @i18n_scope = "swal_rails"
+      # `initializer_version` left nil — apps that haven't regenerated
+      # their initializer since `SwalRails::INITIALIZER_VERSION` was
+      # introduced (0.3.3) get a one-line warning at boot. Setting it
+      # explicitly in the initializer template silences it.
+      @initializer_version = nil
+      @silence_initializer_warning = false
       # `focusConfirm` / `returnFocus` are intentionally omitted: SA2 already
       # defaults both to `true` internally, and passing them explicitly makes
       # SA2 warn on every toast ("incompatible with toasts"). Listing them

data/lib/swal_rails/engine.rb

@@ -52,6 +52,13 @@ module SwalRails
     initializer "swal_rails.i18n" do
       config.i18n.load_path += Dir[root.join("config/locales/*.yml").to_s]
     end
+
+    # Run AFTER user initializers so we can read whatever value they set
+    # (or didn't set) for `config.initializer_version`. One-shot, idempotent,
+    # opt-out via `config.silence_initializer_warning = true`.
+    initializer "swal_rails.check_initializer_version", after: :load_config_initializers do
+      SwalRails::InitializerVersionCheck.run!
+    end
   end
 end
 

data/lib/swal_rails/initializer_version_check.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SwalRails
+  # Compares the user's `config.initializer_version` against the gem's
+  # `SwalRails::INITIALIZER_VERSION` and logs a one-line warning when the
+  # initializer is missing the stamp or trails the gem's expected value.
+  #
+  # Wired into the engine after `:load_config_initializers` so it sees
+  # whatever the user set. Silenced via
+  # `config.silence_initializer_warning = true`.
+  module InitializerVersionCheck
+    module_function
+
+    def run!(logger: default_logger, config: SwalRails.configuration)
+      return if config.silence_initializer_warning
+
+      message = stale_message(config)
+      return unless message
+
+      logger.warn(message)
+    end
+
+    def stale_message(config)
+      user = config.initializer_version
+      current = SwalRails::INITIALIZER_VERSION
+
+      return nil if user == current
+
+      regen = "Run `bin/rails g swal_rails:install --skip-layout --force` to regenerate, or set " \
+              "`config.silence_initializer_warning = true` to silence."
+
+      if user.nil?
+        "[swal_rails] config/initializers/swal_rails.rb predates v#{current} " \
+          "(no `config.initializer_version` set). New options may be missing. #{regen}"
+      else
+        "[swal_rails] initializer template advanced to v#{current} (yours: v#{user}). #{regen}"
+      end
+    end
+
+    def default_logger
+      defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger ? Rails.logger : Logger.new($stderr)
+    end
+  end
+end

data/lib/swal_rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module SwalRails
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
   SWEETALERT2_VERSION = "11.26.24"
 end

data/lib/swal_rails.rb

@@ -5,6 +5,14 @@ require_relative "swal_rails/version"
 module SwalRails
   class Error < StandardError; end
 
+  # The initializer template version this release of the gem ships.
+  # Bump only when the template content changes in a way users should
+  # know about (new option, removed option, default flip). Compared at
+  # boot against `config.initializer_version` to warn about stale
+  # config/initializers/swal_rails.rb files. Independent from gem VERSION
+  # so non-template-touching releases don't trigger spurious warnings.
+  INITIALIZER_VERSION = "0.3.3"
+
   class << self
     def configuration
       @configuration ||= Configuration.new
@@ -21,5 +29,6 @@ module SwalRails
 end
 
 require_relative "swal_rails/configuration"
+require_relative "swal_rails/initializer_version_check"
 require_relative "swal_rails/helpers"
 require_relative "swal_rails/engine" if defined?(Rails::Engine)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swal_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Florian Gagnaire
@@ -73,6 +73,7 @@ files:
 - lib/swal_rails/configuration.rb
 - lib/swal_rails/engine.rb
 - lib/swal_rails/helpers.rb
+- lib/swal_rails/initializer_version_check.rb
 - lib/swal_rails/version.rb
 - vendor/javascript/sweetalert2/LICENSE
 - vendor/javascript/sweetalert2/sweetalert2.all.js