rails_onboarding 0.8.13 → 0.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593e5e47988a8b3f81d6ea034f186669a099d98b09707723ed723128bcdad01d
-  data.tar.gz: 790f85934b3f9573cc6421488b882fcf3ac80340e27a0b6b587cc2de93bcdcab
+  metadata.gz: 92019b01af432fe5d1e17c6f116c224d6123f15aeda35798193a3d2a6eb46b3d
+  data.tar.gz: ddb5d7f350286ab8512626eae34967b524dfa5284547794b801ca4d1b11fdcbc
 SHA512:
-  metadata.gz: f9bc4b4bd26ace6d84e153b906a0b687035e6d0ccb1b81d13ed15f6219bcc1e7be6c02ae30aa85658fc3c79933c5a7c374243bdffc9bf0197b923172ce1c2a36
-  data.tar.gz: 1d1bed61cc8462db8e23fe1e92a114d7df9be93cc7254e6f0cecfe8d56a8fcae765ffe072769c768044f5315795510c0c9533339f9835ac57fc48213a6f83e77
+  metadata.gz: da8ba6db11ce280647bee31ad9a718f63cb251d420d2c65d86412363db586d8d16d9c09c95e0ddd128b72bb3cbdd3903f7559391dc271339e6db32451f40405c
+  data.tar.gz: ef5428f53020a250d118eb58316ec24dffaa06cc0e364d91fe40bf23c78f97ca56ec7ae15b928e93be7e2e3dfb4d093d2ccd3e8e6957d118df775e7285f27b6f

data/app/models/concerns/rails_onboarding/ab_testable.rb

@@ -26,7 +26,14 @@ module RailsOnboarding
     included do
       # Store A/B test assignments as JSON
       # Expected column: ab_test_assignments (jsonb or text)
-      serialize :ab_test_assignments, coder: JSON unless column_names.include?("ab_test_assignments") && columns_hash["ab_test_assignments"].type == :jsonb
+      # column_names and columns_hash both query the database, and this runs
+      # when the host model is loaded -- possibly before the table exists.
+      # See RailsOnboarding::SchemaGuard.
+      if RailsOnboarding::SchemaGuard.columns_queryable?(self)
+        unless column_names.include?("ab_test_assignments") && columns_hash["ab_test_assignments"].type == :jsonb
+          serialize :ab_test_assignments, coder: JSON
+        end
+      end
 
       # Callbacks
       after_initialize :assign_ab_test_variants, if: :new_record?

data/app/models/concerns/rails_onboarding/onboardable.rb

@@ -7,43 +7,10 @@ module RailsOnboarding
     MAX_MILESTONES_ACHIEVED = 500
     MAX_JSON_SIZE_BYTES = 65_535 # ~64KB for TEXT columns
 
-    # Whether the host model's table can be inspected right now.
-    #
-    # `columns_hash` and `column_names` both query the database, and the
-    # `included do` block below runs the moment the host model is loaded --
-    # which can be long before that table exists. A host that references its
-    # user model from an initializer hits this immediately: the common OmniAuth
-    # `:identity` setup passes `model: User`, so the model loads during boot,
-    # the include queries `columns_hash`, and against an empty database the
-    # whole process dies with "Table 'users' doesn't exist".
-    #
-    # That is circular and unrecoverable: loading the schema requires booting
-    # the app, and booting the app requires the schema. It stops `db:prepare`
-    # bootstrapping a genuinely new database, a restore into an empty schema,
-    # and CI against a fresh database service.
-    #
-    # A missing table, a missing database and an absent connection all mean the
-    # same thing here -- the column types cannot be known yet -- so degrade
-    # instead of raising. Nothing is lost: a process that boots against an empty
-    # database is bootstrapping it, not serving from it, and the next process
-    # configures everything normally once the schema is in place.
-    #
-    # Only ever answers false when the table is positively known to be absent.
-    # This concern is deliberately includable into plain classes that are not
-    # ActiveRecord models -- hence the `respond_to?(:has_many)` and
-    # `respond_to?(:validate)` guards below -- and such a class has no
-    # `table_exists?` while still answering `columns_hash`. Saying "not
-    # available" for those would silently stop configuring them, so anything
-    # that cannot be asked is treated as queryable and left to the callers'
-    # own guards, exactly as before this check existed.
+    # Whether the host model's columns can be read yet. See
+    # RailsOnboarding::SchemaGuard, which three concerns share.
     def self.columns_queryable?(model)
-      return true unless model.respond_to?(:table_exists?)
-
-      model.table_exists?
-    rescue ActiveRecord::NoDatabaseError,
-           ActiveRecord::ConnectionNotEstablished,
-           ActiveRecord::StatementInvalid
-      false
+      SchemaGuard.columns_queryable?(model)
     end
 
     included do
@@ -62,8 +29,8 @@ module RailsOnboarding
 
       # Fix for Rails 8: Use the new serialize syntax.
       # Guarded because columns_hash queries the database -- see
-      # Onboardable.columns_queryable? above.
-      if RailsOnboarding::Onboardable.columns_queryable?(self)
+      # RailsOnboarding::SchemaGuard.
+      if RailsOnboarding::SchemaGuard.columns_queryable?(self)
         if columns_hash["feature_tooltips_shown"]&.type == :text
           serialize :feature_tooltips_shown, coder: JSON
         end
@@ -99,7 +66,7 @@ module RailsOnboarding
       # than raising on a column that isn't there.
       def onboarding_replay_supported?
         return false unless respond_to?(:column_names)
-        return false unless RailsOnboarding::Onboardable.columns_queryable?(self)
+        return false unless RailsOnboarding::SchemaGuard.columns_queryable?(self)
 
         column_names.include?("onboarding_replay_started_at") &&
           column_names.include?("onboarding_replay_steps")

data/app/models/concerns/rails_onboarding/progressive_disclosure.rb

@@ -36,7 +36,14 @@ module RailsOnboarding
     included do
       # Store revealed features as JSON
       # Expected column: revealed_features (jsonb or text)
-      serialize :revealed_features, coder: JSON unless column_names.include?("revealed_features") && columns_hash["revealed_features"].type == :jsonb
+      # column_names and columns_hash both query the database, and this runs
+      # when the host model is loaded -- possibly before the table exists.
+      # See RailsOnboarding::SchemaGuard.
+      if RailsOnboarding::SchemaGuard.columns_queryable?(self)
+        unless column_names.include?("revealed_features") && columns_hash["revealed_features"].type == :jsonb
+          serialize :revealed_features, coder: JSON
+        end
+      end
 
       # Callback to check and reveal features
       after_save :check_progressive_features, if: :saved_change_to_onboarding_current_step?

data/app/models/concerns/rails_onboarding/schema_guard.rb

@@ -0,0 +1,38 @@
+module RailsOnboarding
+  # Whether a host model's columns can be read yet.
+  #
+  # Three concerns inspect columns the moment they are included -- to decide
+  # whether to configure JSON serialization -- and `columns_hash` and
+  # `column_names` both query the database. That runs when the host model is
+  # loaded, which can be long before the table exists.
+  #
+  # A host that references its user model from an initializer hits this
+  # immediately. The common OmniAuth `:identity` setup passes `model: User`, so
+  # the model loads during boot and the process dies with
+  # `Table 'users' doesn't exist`. That is circular and unrecoverable: loading
+  # the schema requires booting the app, and booting the app requires the
+  # schema. It stops `db:prepare` bootstrapping a genuinely new database, a
+  # restore into an empty schema, and CI against a fresh database service.
+  module SchemaGuard
+    module_function
+
+    # Only ever answers false when the table is positively known to be absent.
+    #
+    # These concerns are deliberately includable into plain classes that are not
+    # ActiveRecord models -- hence the `respond_to?(:has_many)` and
+    # `respond_to?(:validate)` guards in Onboardable -- and such a class answers
+    # `columns_hash` while having no `table_exists?`. Vetoing those would
+    # silently stop configuring them, so anything that cannot be asked is
+    # treated as queryable and left to the callers' own guards, exactly as
+    # before this check existed.
+    def columns_queryable?(model)
+      return true unless model.respond_to?(:table_exists?)
+
+      model.table_exists?
+    rescue ActiveRecord::NoDatabaseError,
+           ActiveRecord::ConnectionNotEstablished,
+           ActiveRecord::StatementInvalid
+      false
+    end
+  end
+end

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.8.13"
+  VERSION = "0.8.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_onboarding
 version: !ruby/object:Gem::Version
-  version: 0.8.13
+  version: 0.8.14
 platform: ruby
 authors:
 - David Lewis
@@ -183,6 +183,7 @@ files:
 - app/models/concerns/rails_onboarding/onboardable.rb
 - app/models/concerns/rails_onboarding/personalizable.rb
 - app/models/concerns/rails_onboarding/progressive_disclosure.rb
+- app/models/concerns/rails_onboarding/schema_guard.rb
 - app/models/rails_onboarding/analytics.rb
 - app/models/rails_onboarding/analytics_event.rb
 - app/models/rails_onboarding/application_record.rb
@@ -282,7 +283,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/bunnahabhain/rails_onboarding
-  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.13
+  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.14
   changelog_uri: https://github.com/bunnahabhain/rails_onboarding/blob/master/docs/CHANGELOG.md
 rdoc_options: []
 require_paths: