bp3-request_state 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94a3e6bacbd1d73edd2db167c54ba3e8af9e6d4f88763453f6a104a541e6b60
-  data.tar.gz: 4943fc4b23ae39b5c3150057fbc521eba2f7a0f82686bd9619522ef1add774a1
+  metadata.gz: df0c3852fcdfcee1a0ff7d9c703e3afe5e60165df36758de5e017bf95eb06982
+  data.tar.gz: 9883f750f5eb32271d7a16a39589db7615cc1602fb2660c8f7c6f586be23b9ec
 SHA512:
-  metadata.gz: 63db363e87856e8224c90fae505fb313f1e9aae2e7ae3041e25c39800d375f68ec3d99a43b1d209af5c2ca638d4b8a8b44a9cd645361ea69614ee8d328bd10b9
-  data.tar.gz: dafc593792e8853c77f936cb158ef0f987be0acd3e75a7fe23fd5b98ca7b7a2afa81fcdd1f4b5470817884924777785fcc910cceb0e45dfef95ec6512115124a
+  metadata.gz: e70ee9cfd542c162ce1c8511e681732f1ca1a8ff90136f951d11c052db225d6203d6b4c41938891cf4b43b3915ab80dedc694dc5e65febf4ddc75f13e20e81a4
+  data.tar.gz: 75d1906b23737d48cccf5284643ab8bbf35ac15f18b9cabf107b8e0d17dd0ef03a2193516f49ca13d1f474968767cb0402944e8a2eacfd35406ebadce0b59071

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.1.4] - 2026-11-01
+
+- Add ostruct dependency
+- Update gems
+
 ## [0.1.3] - 2026-01-09
 
 - Update gems

data/CLAUDE.md

@@ -0,0 +1,62 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+bp3-request_state provides `Bp3::RequestState::Base`, the parent of BP3's `GlobalRequestState`. BP3
+(persuavis/black_phoebe_3) is a multi-site multi-tenant Rails application, and the request state is how
+every layer knows the current site, tenant, workspace and login without passing them around. bp3-core's
+Tenantable default scopes, Rqid and the job wrappers in bp3-noticed are all built on this API.
+
+## Commands
+
+The gems run on Ruby 3.4.6 (`.ruby-version`). Prefix commands with `~/.rvm/bin/rvm 3.4.6 do` when the
+shell is not already on it; a missing `rspec` means the wrong Ruby, not a missing bundle.
+
+- `bundle exec rake` - specs and RuboCop (the default task)
+- `bundle exec rspec spec/path/to/file_spec.rb[:LINE]` - one file or example
+- `bundle exec rubocop` / `bundle exec rubocop -a`
+- `bin/setup`, `bin/console`, `rake install`
+
+## Architecture
+
+`lib/bp3/request_state/base.rb`. Everything is class-level state in `RequestStore` under
+`:bp3_request_state`, so it is per request (and per job, once the job sets it) and thread-safe.
+
+**What a subclass declares**, then calls `define_accessors`:
+- `hash_key_map`: state member to class name, used to load records back from ids
+- `base_attrs`: the members; each gets a class getter and setter, an `_id` getter and setter, and an
+  instance getter
+- `hash_attrs`: the `_id` members `to_hash` serializes
+
+**What the base provides**
+- `current`, `clear!`, `request_id`, `started`, `duration`, `now`
+- `to_hash` / `from_hash`: string-keyed hash of ids, request id, start time and locale, and back. This is
+  how jobs carry the caller's state
+- `either_site`, `either_tenant`, `either_workspace` (and `_id`): the `target_*` member if set, else
+  `current_*`. `target_*` only exists in subclasses that declare it, as the application's does
+- `either_admin`: `current_root || current_admin`
+- `current_login`: `current_user || current_admin || current_root`, the least privileged login signed in.
+  bp3-core decides how far default scopes reach from it
+- `highest_privilege`: the reverse order. Neither includes `current_visitor`, who is not logged in
+- `with_current(site:, tenant:, workspace:)`: clears and sets the state, then yields. It does not restore
+  the previous state; the application's override does
+
+`lib/bp3/request_state/test.rb` is a subclass with only `current_site` and `target_site`, backed by the
+id-only stand-in `site.rb`. Neither is required by `lib/bp3/request_state.rb`; specs require them.
+
+The application's `GlobalRequestState` (black_phoebe_3, `app/services/global_request_state.rb`) adds the
+target members, `inbound_request`, and a `with_current` that restores the previous state; the README shows
+it. A change to the names or semantics here reaches every bp3 gem that reads the state.
+
+## Code Style
+
+- RuboCop (`.rubocop.yml`): target Ruby 3.2.2, NewCops, rubocop-rake and rubocop-rspec
+- Every file starts with `# frozen_string_literal: true`
+- American English; no trailing whitespace on any added or modified line
+
+## Release
+
+Bump `lib/bp3/request_state/version.rb` and add a `CHANGELOG.md` entry. `rake release` tags, pushes and
+publishes to rubygems.org; leave releasing and committing to the user.

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    bp3-request_state (0.1.3)
+    bp3-request_state (0.1.4)
       actionpack (~> 8.1)
       activesupport (~> 8.1)
+      ostruct (>= 0.6)
       request_store (>= 1.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (8.1.2)
-      actionview (= 8.1.2)
-      activesupport (= 8.1.2)
+    actionpack (8.1.4)
+      actionview (= 8.1.4)
+      activesupport (= 8.1.4)
       nokogiri (>= 1.8.5)
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
@@ -19,13 +20,13 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (8.1.2)
-      activesupport (= 8.1.2)
+    actionview (8.1.4)
+      activesupport (= 8.1.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (8.1.2)
+    activesupport (8.1.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -40,50 +41,56 @@ GEM
       uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.3)
     builder (3.3.0)
-    byebug (12.0.0)
-    concurrent-ruby (1.3.6)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
+    concurrent-ruby (1.3.8)
     connection_pool (3.0.2)
-    crass (1.0.6)
+    crass (1.0.8)
     diff-lcs (1.6.2)
     drb (2.2.3)
     erubi (1.13.1)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    json (2.18.0)
-    language_server-protocol (3.17.0.5)
+    io-console (0.9.4)
+    json (3.1.0)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loofah (2.25.0)
+    loofah (2.25.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (6.0.1)
+    minitest (6.0.6)
+      drb (~> 2.0)
       prism (~> 1.5)
-    nokogiri (1.19.0-x86_64-darwin)
+    nokogiri (1.19.4-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.27.0)
-    parser (3.3.10.0)
+    ostruct (0.6.3)
+    parallel (2.3.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
       racc
-    prism (1.7.0)
+    prism (1.9.0)
     racc (1.8.1)
-    rack (3.2.4)
-    rack-session (2.1.1)
+    rack (3.2.7)
+    rack-session (2.1.2)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
-    rack-test (2.2.0)
+    rack-test (2.3.0)
       rack (>= 1.3)
     rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     rainbow (3.1.1)
-    rake (13.3.1)
-    regexp_parser (2.11.3)
+    rake (13.4.2)
+    regexp_parser (2.13.1)
+    reline (0.7.0)
+      io-console (~> 0.5)
     request_store (1.7.0)
       rack (>= 1.4)
     rspec (3.13.2)
@@ -95,38 +102,39 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubocop (1.82.1)
-      json (~> 2.3)
+    rspec-support (3.13.7)
+    rubocop (1.92.1)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.48.0, < 2.0)
+      regexp_parser (>= 2.11.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
-    uri (1.1.1)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
+    uri (1.1.2)
     useragent (0.16.11)
 
 PLATFORMS

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-In your app, create a model or service that inherits from `Bp3::Request::State`, and 
+In your app, create a model or service that inherits from `Bp3::RequestState::Base`, and
 specify
 - `hash_key_map`, mapping members of the global state to their class,
 - `base_attrs`, defining the list of global state member objects, and

data/bp3-request_state.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '~> 8.1'
   spec.add_dependency 'activesupport', '~> 8.1'
+  spec.add_dependency 'ostruct', '>= 0.6'
   spec.add_dependency 'request_store', '>= 1.5.1'
 
   spec.add_development_dependency 'byebug'

data/lib/bp3/request_state/base.rb

@@ -11,7 +11,7 @@ require 'ostruct'
 
 module Bp3
   module RequestState
-    # rubocop:disable Metrics/ClassLength, Style/ClassVars
+    # rubocop:disable-next Metrics/ClassLength, Style/ClassVars
     class Base
       extend Forwardable
 
@@ -210,6 +210,5 @@ module Bp3
         end
       end
     end
-    # rubocop:enable Metrics/ClassLength, Style/ClassVars
   end
 end

data/lib/bp3/request_state/version.rb

@@ -2,6 +2,6 @@
 
 module Bp3
   module RequestState
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bp3-request_state
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Wim den Braven
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,7 @@ files:
 - ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -181,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.23
 specification_version: 4
 summary: bp3-request_state provides the Bp3::RequestState::Base class for BP3 (persuavis/black_phoebe_3).
 test_files: []