demo_mode 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68c310d6d0797c6f17fb85f41ec11f72305619323bf7bf2174d6b6a44c2954f4
-  data.tar.gz: fd5fe9b737d929072e50576ffedfe93d5e516414adb384a4e6d2b4cdc856868a
+  metadata.gz: 32fe807f48ace30d24a2172d0b73965272b6d93057dd2447cb4587d386ef93a2
+  data.tar.gz: 568795bf8f52234c1d4ead6882762bfa6ec631e6a3242eada9848a7e050c6a0b
 SHA512:
-  metadata.gz: a235b3dd997af98b44b1947fc3a8832f33793ef0600a027a935cf8cfc0d6c40f9232b2fe969dc146845e319ae9c150001d33308568e6876b9667a4968f8279d1
-  data.tar.gz: f848277ff5fa0a11e27e2c6f0d701069a17b818eceba5e0d86a7e9ce12c5592dfa0b7fe86da1248f07f07122824ccb84a2e3090cb6d0909fbb702f65824a0acf
+  metadata.gz: f5d183a6c1de1c237dfca4adf333e637223c6d89525249d36841888a432c5c6e8727d01debba0f790f86d5f732441848c8f6ba2e816f89e254666b65e661b72a
+  data.tar.gz: a29b4fef772ebb421e4f8236c911316bb5078c29a231e5241788b2c1053a2bef9fe760edf4cfc629b5de21897107564265d3e5a0106adeda39ed57ae22088da5

data/README.md

@@ -472,7 +472,16 @@ begin_demo do
 end
 ```
 
-### FactoryBot `sequence` extension
+### FactoryBot extensions
+
+Factory bot ships two patches that may be manually loaded after loading FactoryBot:
+
+```ruby
+require 'factory_bot'
+require 'demo_mode/factory_bot_ext'
+```
+
+#### `sequence`
 
 `DemoMode` comes with a patch designed to be a drop-in replacement for
 [factory_bot](https://github.com/thoughtbot/factory_bot)'s `sequence` feature,
@@ -487,11 +496,19 @@ records in the DB (rather than starting at "Something 1" each time). This
 feature is necessary wherever you rely on `UNIQUE` constraints in the database,
 or uniqueness validations on your models.
 
-This patch must be manually loaded after loading FactoryBot:
+#### `around_each` hook
+
+Use `FactoryBot.around_each` to wrap all factory execution, which can be used to
+skip expensive callbacks/logging:
 
 ```ruby
-require 'factory_bot'
-require 'demo_mode/factory_bot_ext'
+FactoryBot.around_each do |&blk|
+  was_enabled = MyLogger.enabled?
+  MyLogger.disable!
+  blk.call
+ensure
+  MyLogger.enable! if was_enabled
+end
 ```
 
 #### Considerations

data/app/controllers/demo_mode/sessions_controller.rb

@@ -26,6 +26,7 @@ module DemoMode
     def create
       @session = Session.new(create_params)
       @session.save_and_generate_account_later!(**options_params.to_unsafe_h.deep_symbolize_keys)
+      @session.reload
       session[:demo_session] = { 'id' => @session.id, 'last_request_at' => Time.zone.now }
       respond_to do |f|
         f.html { redirect_to @session, status: :see_other }
@@ -58,6 +59,7 @@ module DemoMode
           status: @session.status,
           username: @session.signinable_username,
           password: @session.signinable_password,
+          metadata: @session.signinable_metadata,
         }
       end
     end

data/app/models/demo_mode/session.rb

@@ -22,6 +22,7 @@ module DemoMode
     delegate :begin_demo,
       :custom_sign_in?,
       :display_credentials?,
+      :metadata,
       to: :persona,
       allow_nil: true
 
@@ -29,6 +30,10 @@ module DemoMode
       signinable.public_send(DemoMode.signinable_username_method)
     end
 
+    def signinable_metadata
+      successful? ? metadata.call(self) : {}
+    end
+
     # Heads up: finding a persona is not guaranteed (e.g. past sessions)
     def persona
       DemoMode.personas.find { |p| p.name.to_s == persona_name.to_s }

data/lib/demo_mode/factory_bot_ext.rb

@@ -10,3 +10,25 @@ module FactoryBot
     alias sequence clever_sequence
   end
 end
+
+module DemoMode
+  module FactoryBotExt
+    def around_each(&block)
+      @around_each ||= ->(&blk) { blk.call }
+      if block_given?
+        previous = @around_each
+        @around_each = ->(&blk) { previous.call { block.call(&blk) } }
+      end
+      @around_each
+    end
+  end
+
+  module FactoryBotRunnerExt
+    def run(...)
+      ::FactoryBot.around_each.call { super }
+    end
+  end
+
+  ::FactoryBot.extend(FactoryBotExt)
+  ::FactoryBot::FactoryRunner.prepend(FactoryBotRunnerExt)
+end

data/lib/demo_mode/persona.rb

@@ -38,6 +38,14 @@ module DemoMode
       end
     end
 
+    def metadata(&block)
+      if block
+        @metadata = block
+      else
+        @metadata ||= ->(_) { {} }
+      end
+    end
+
     def sign_in_as(&signinable_generator)
       variant(:default) do
         sign_in_as(&signinable_generator)

data/lib/demo_mode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DemoMode
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: demo_mode
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Nathan Griffith
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -351,7 +350,6 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/Betterment/demo_mode/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -366,8 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A configurable demo mode for your Rails app.
 test_files: []