safer_initialize 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31eb1c05500e2d20207203e3d4d65a29507920d6f0da6b0cadaef0d87df81b12
-  data.tar.gz: 9d8f0360e41cb13a56314c79c3bb64e46ba892ffcc40351d1ec241ab96f53b0e
+  metadata.gz: bd32a618d97effbb7546a3a02377b877291583dac0aa12c2d7269bc73f4c9f65
+  data.tar.gz: bd01330e3335b3a33d5414b43330ecaf438f160e9e97f7d72b76a6079130f9b3
 SHA512:
-  metadata.gz: f1cb3bbc1654debbf28f5e336bd46bc7f03ad9ed3e65d1e651f41e3a83bff1591a3e5e4418f41027cc557e78796e299c40537a590cbb5ebc34b762e14df0a8c0
-  data.tar.gz: 5dd462b38e4b9058de7eccf5853aa788133d2374282f3af2297b02cdacef1b20e22a77600f7546e0cb6ca4c9785f17d92e0ffea4c171dbd46710c31e30a38482
+  metadata.gz: 6bbe298665a9188db3c440a6f5fa37a9e15499c51479179cafd29759f42e024f4036200df689b721d25940d57dc9771e51bcd326be9de9e3d55bbb55811f6252
+  data.tar.gz: 5c1b45239a851a50bb4231721e624940693d2240797c333dbfb7d51f7f36556d9d27509642983021b4683c054717ead6207d1abc41d1c8e8171b4f29f6a0fd65

data/.claude/skills/ruby-rails-ci-matrix/SKILL.md

@@ -0,0 +1,108 @@
+---
+description: Maintain the Ruby and Rails version matrix tested in CI for a Ruby gem. Use this when you need to remove EOL versions, add the latest supported versions, and update gemfiles and gemspec accordingly. Always use this for requests like 'remove unsupported Ruby/Rails versions', 'add the latest Rails', or 'update the CI matrix'.
+license: MIT
+metadata:
+    github-path: skills/ruby/ruby-rails-ci-matrix
+    github-ref: refs/heads/main
+    github-repo: https://github.com/aki77/skills
+    github-tree-sha: 59898557bcf3dd4e734ae3f25c8ab025a43341be
+name: ruby-rails-ci-matrix
+---
+# ruby-rails-ci-matrix
+
+Maintain the Ruby and Rails versions tested in CI for a Ruby gem that uses GitHub Actions matrix strategy with `gemfiles/railsXX.gemfile` and a gemspec. This skill keeps the test matrix aligned with the current support status.
+
+Remove EOL (End of Life) versions and add currently supported and latest stable versions. The gemfile, gemspec, and workflow YAML must be updated **in sync** — updating only one will break CI.
+
+## 1. Assess the Current State
+
+Before making any changes, read all three types of files involved.
+
+| File | What to check |
+| --- | --- |
+| `.github/workflows/*.yml` | `strategy.matrix.include` entries (`{ ruby:, gemfile: }`), `ruby/setup-ruby` version |
+| `gemfiles/*.gemfile` | Per-Rails-version gemfiles — `source` URL and `gem 'rails', '~> X.Y.0'` |
+| `*.gemspec` | `required_ruby_version` and the lower bound of `add_dependency "rails", ...` |
+
+Note that the `gemfile:` values in the matrix correspond 1:1 with `gemfiles/<value>.gemfile`.
+
+## 2. Research EOL Status
+
+**Use today's date as the reference** and fetch the latest support information — do not rely on memory.
+
+- Ruby: <https://endoflife.date/ruby>
+- Rails: <https://endoflife.date/rails>
+
+If endoflife.date is unreachable, use WebSearch as a fallback. Confirm the following three things:
+
+1. EOL date for each version (including security support end date) — has it passed as of today?
+2. Full list of currently supported versions
+3. Latest stable releases (check whether a new major like Ruby 4.0 or Rails 8.1 has been released)
+
+> Ruby releases a new version every December with ~3 years 3 months of support. Rails 7.2+ receives 1 year of standard support and 2 years of security support.
+
+## 3. Decide What to Add and Remove
+
+- **Remove**: Ruby / Rails versions that are EOL (security support also ended) as of today.
+- **Add**: Supported versions not yet in the matrix, plus the latest stable releases.
+- **Keep**: Versions still under security support. For versions expiring within a few months, ask the user whether to keep them.
+- Build the matrix as **each Rails version × the compatible Ruby versions**. Pay attention to compatibility — older Rails versions may not support the newest Ruby.
+
+## 4. Update Files
+
+Keep all three files consistent. **If you remove a gemfile, remove the matrix entry too** (and vice versa).
+
+### Workflow YAML Matrix
+
+Update the `include:` entries. Use short-form Ruby version strings (`"4.0"`) so `ruby/setup-ruby` automatically picks the latest patch.
+
+```yaml
+strategy:
+  matrix:
+    include:
+      - { ruby: "3.3", gemfile: "rails72" }
+      - { ruby: "3.4", gemfile: "rails72" }
+      - { ruby: "4.0", gemfile: "rails72" }
+      - { ruby: "3.3", gemfile: "rails80" }
+      - { ruby: "3.4", gemfile: "rails80" }
+      - { ruby: "4.0", gemfile: "rails80" }
+      - { ruby: "3.3", gemfile: "rails81" }
+      - { ruby: "3.4", gemfile: "rails81" }
+      - { ruby: "4.0", gemfile: "rails81" }
+```
+
+### Create / Delete Gemfiles
+
+For a new Rails version, copy an existing gemfile and change only the `~> X.Y.0` constraint.
+
+```ruby
+source "https://rubygems.org"
+
+gem 'rails', '~> 8.1.0'
+gem 'sqlite3'
+
+gemspec path: '../'
+```
+
+Delete the gemfile for any Rails version being dropped.
+
+### Update gemspec Lower Bounds
+
+Update two lines to match the minimum supported versions.
+
+```ruby
+spec.required_ruby_version = '>= 3.3.0'      # minimum supported Ruby
+spec.add_dependency "rails", ">= 7.2.0"      # minimum supported Rails
+```
+
+## Notes
+
+- **Always use `https://rubygems.org`** as the `source` — fix any `http://` occurrences.
+- **`ruby/setup-ruby@v1` and new majors**: For brand-new majors like Ruby 4.0, verify that setup-ruby already supports it (it usually does very quickly).
+- **Raising `required_ruby_version` is a breaking change**. Users on the old Ruby version will no longer be able to install the gem, so a minor or major gem version bump is required at release time. Handle this in a separate PR / commit, not as part of this matrix update.
+
+## Pitfalls
+
+- **Forgetting to update the gemspec lower bounds** means the old Ruby/Rails version you removed from CI can still be `gem install`-ed, creating a mismatch between stated and actual support.
+- **Updating only the gemfile or only the matrix** breaks CI — either a missing gemfile is referenced, or an unused gemfile is left behind. Always update both together.
+- **Mixing unrelated changes** (e.g., fixing `http://` → `https://` sources) into the same commit as version removals obscures intent. Commit each logical unit separately.

data/.github/workflows/rspec.yml

@@ -0,0 +1,38 @@
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: "3.3", gemfile: "gemfiles/7.2.gemfile" }
+          - { ruby: "3.4", gemfile: "gemfiles/7.2.gemfile" }
+          - { ruby: "4.0", gemfile: "gemfiles/7.2.gemfile" }
+          - { ruby: "3.3", gemfile: "gemfiles/8.0.gemfile" }
+          - { ruby: "3.4", gemfile: "gemfiles/8.0.gemfile" }
+          - { ruby: "4.0", gemfile: "gemfiles/8.0.gemfile" }
+          - { ruby: "3.3", gemfile: "gemfiles/8.1.gemfile" }
+          - { ruby: "3.4", gemfile: "gemfiles/8.1.gemfile" }
+          - { ruby: "4.0", gemfile: "gemfiles/8.1.gemfile" }
+    steps:
+      - name: Install packages
+        run: |
+          sudo apt update -y
+          sudo apt install -y libsqlite3-dev
+      - uses: actions/checkout@v7
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+test.sqlite3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Unreleased
+
+## 0.4.0
+
+- Add `SaferInitialize.defer` to avoid N+1 checks (#6)
+- Drop support for Ruby < 3.3 and Rails < 7.2; test against Ruby 3.3/3.4/4.0 and Rails 7.2/8.0/8.1
+
+## 0.3.0
+
+- Support message option with Proc (#3)
+
 ## 0.2.0
 
 - Add `error_handle` config

data/Gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in safer_initialize.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem "rake"
+gem "rspec"
+gem "sqlite3"

data/README.md

@@ -26,7 +26,7 @@ In `config/initializers/safer_initialize.rb`:
 SaferInitialize::Globals.attribute :tenant
 
 SaferInitialize.configure do |config|
-  config.error_handle = -> (e) { Rails.env.production? ? Bugsnag.notify(e) : raise e } # default: -> (e) { raise e }
+  config.error_handle = -> (e) { Rails.env.production? ? Bugsnag.notify(e) : raise(e) } # default: -> (e) { raise e }
 end
 ```
 
@@ -78,6 +78,41 @@ In `app/views/projects/index.html.haml`:
     = project.name
 ```
 
+## Deferred evaluation (avoiding N+1)
+
+`safer_initialize` runs inside `after_initialize`, which fires while each record
+is being built — *before* Rails resolves `includes`/`preload`. If your check
+touches an association, it triggers a query per record (N+1), even when the
+query eager-loads that association.
+
+Wrap the load in `SaferInitialize.defer` to queue the checks and evaluate them
+after the block finishes, once preloading is done:
+
+```ruby
+SaferInitialize.defer do
+  # Loading through `user.projects` sets the inverse for `project.user`, but not for
+  # `project.tenant` — so the tenant check's `project.tenant` needs a query per row.
+  # `includes(:tenant)` eager-loads it, but the check runs in `after_initialize` —
+  # before the preload resolves — so it still N+1s without `defer`.
+  projects = current_user.projects.includes(:tenant).to_a
+  # checks are queued here, not evaluated yet
+  render_something(projects)
+end
+# checks run at the block end — the preload is done, so `project.tenant` is cached (no N+1)
+```
+
+(`current_tenant.projects` would not N+1 here: loading through that association sets the
+inverse, so `project.tenant` is already resolved and `includes(:tenant)` is unnecessary.)
+
+Notes:
+
+- Outside a `defer` block the behavior is unchanged (immediate evaluation).
+- Globals (e.g. `tenant`) are expected to stay constant inside the block; set
+  them before entering `defer`, not within it. `with_safe` still skips checks
+  as usual.
+- If the block raises, the queue is discarded without running the checks.
+- `defer` cannot be nested.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/gemfiles/7.2.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 7.2.0'
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec :path => "../"

data/gemfiles/8.0.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 8.0.0'
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "sqlite3", "~> 2.1"
+
+gemspec :path => "../"

data/gemfiles/8.1.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 8.1.0'
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "sqlite3", "~> 2.1"
+
+gemspec :path => "../"

data/lib/safer_initialize/active_record/extensions.rb

@@ -6,15 +6,25 @@ module SaferInitialize
       class_methods do
         def safer_initialize(filter = nil, message: 'initialize error', &block)
           after_initialize do |object|
-            unless SaferInitialize::Globals.safe?
-              result = filter ? object.send(filter) : object.instance_exec(object, &block)
-              unless result
-                SaferInitialize.configuration.error_handle.call(SaferInitialize::Error.new(message))
-              end
+            next if SaferInitialize::Globals.safe?
+
+            check = -> { SaferInitialize::ActiveRecord::Extensions.run_check(object, filter, message, block) }
+            if SaferInitialize::Globals.deferring?
+              SaferInitialize::Globals.__deferred_checks << check
+            else
+              check.call
             end
           end
         end
       end
+
+      def self.run_check(object, filter, message, block)
+        result = filter ? object.send(filter) : object.instance_exec(object, &block)
+        return if result
+
+        message_text = message.respond_to?(:call) ? message.call(object) : message
+        SaferInitialize.configuration.error_handle.call(SaferInitialize::Error.new(message_text))
+      end
     end
   end
 end

data/lib/safer_initialize/globals.rb

@@ -2,10 +2,14 @@ require 'active_support'
 
 module SaferInitialize
   class Globals < ActiveSupport::CurrentAttributes
-    attribute :__safe
+    attribute :__safe, :__deferring, :__deferred_checks
 
     def safe?
       !!__safe
     end
+
+    def deferring?
+      !!__deferring
+    end
   end
 end

data/lib/safer_initialize/version.rb

@@ -1,3 +1,3 @@
 module SaferInitialize
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

data/lib/safer_initialize.rb

@@ -21,4 +21,27 @@ module SaferInitialize
   def with_safe(&block)
     Globals.set(__safe: true, &block)
   end
+
+  # Defer safer_initialize checks queued inside the block until the block
+  # finishes, so associations preloaded by the enclosed queries are already
+  # resolved by the time the checks run (avoids N+1). Globals must not be
+  # mutated inside the block. On an exception the queue is discarded without
+  # flushing. Cannot be nested.
+  def defer
+    raise Error, 'SaferInitialize.defer cannot be nested' if Globals.deferring?
+
+    Globals.__deferring = true
+    Globals.__deferred_checks = []
+
+    result = yield
+
+    checks = Globals.__deferred_checks
+    Globals.__deferring = nil
+    Globals.__deferred_checks = nil
+    checks.each(&:call)
+    result
+  ensure
+    Globals.__deferring = nil
+    Globals.__deferred_checks = nil
+  end
 end

data/safer_initialize.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Make ActiveRecord initialization less dangerous.}
   spec.homepage      = "https://github.com/aki77/safer_initialize"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 6.0.0'
+  spec.add_dependency 'rails', '>= 7.2.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: safer_initialize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - aki77
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.2.0
 description: Make ActiveRecord initialization less dangerous.
 email:
 - aki77@users.noreply.github.com
@@ -31,6 +30,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/skills/ruby-rails-ci-matrix/SKILL.md"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -42,6 +43,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/7.2.gemfile
+- gemfiles/8.0.gemfile
+- gemfiles/8.1.gemfile
 - lib/safer_initialize.rb
 - lib/safer_initialize/active_record/extensions.rb
 - lib/safer_initialize/configuration.rb
@@ -55,7 +59,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/aki77/safer_initialize
   source_code_uri: https://github.com/aki77/safer_initialize
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -63,15 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Make ActiveRecord initialization less dangerous.
 test_files: []