bp3-core 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02341017029035ce15928115c68d1b142a43d46474e8b7ea989c3c67d38ae323'
-  data.tar.gz: 4e54a3d0c7357386472cf811707c9c990cbbd20541dad265b73d5f24224bfbaa
+  metadata.gz: a439b2f50c821e45fba5119a749a2c7b16f103eab54b791d10df8b7b55352393
+  data.tar.gz: '0598a39328efacd1be9f524c89927bc084921a9f083f5ad55a2079e43af7b3b6'
 SHA512:
-  metadata.gz: 88c7855cd29ba6a7d33f404d8947d75df4ea27d11bfed33ea34a242e1fe3e31624c2619935d8f5018f2df684c5973f95954e016d125d009915923b87be44247d
-  data.tar.gz: bf68641f064961b9de03cc3cdf9a70b63d9c2e4a362d4b8b7dec70cee5564ceb550042826c480ed3d4eec68680d8bb95d0731a26f50df61352dce3e202a23606
+  metadata.gz: 799d9784bb24ffc560fa30b0047d4c510e52395bcbdda02ae77087aba2a947cf6d35e658ebc22194522f39b8b1ed7da0e97342a82eab04dcf5cbbe21beb09dea
+  data.tar.gz: 94823bea2f47fc9af0a4477c6842071ebec9bff750e7e50239c6a061e9e37ceecdf03ae06791a4232e735676154d162d188f531a74eded2e192d8c1391984043

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.3] - 2024-07-31
+
+- Ensure use of common global request state
+
 ## [0.1.2] - 2024-05-30
 
 - Explicit require active_support/parameter_filter

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    bp3-core (0.1.2)
+    bp3-core (0.1.4)
       actionview (>= 7.1.2, < 8)
       activesupport (>= 7.1.2, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (7.1.3)
-      activesupport (= 7.1.3)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -26,31 +26,30 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    builder (3.2.4)
-    concurrent-ruby (1.2.3)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
-    diff-lcs (1.5.0)
-    drb (2.2.0)
-      ruby2_keywords
-    erubi (1.12.0)
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    erubi (1.13.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.21.2)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    nokogiri (1.16.5-x86_64-darwin)
+    nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.0.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.1)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -59,47 +58,51 @@ GEM
       loofah (~> 2.21)
       nokogiri (~> 1.14)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.60.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.26.1)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)

data/README.md

@@ -1,6 +1,7 @@
 # Bp3::Core
 
-bp3-core provides core concerns for the persuavis/black_phoebe_3 multi-site multi-tenant rails application.
+bp3-core provides core concerns for BP3, the persuavis/black_phoebe_3 multi-site 
+multi-tenant rails application.
 
 ## Installation
 
@@ -38,10 +39,20 @@ In ActiveRecord models (or their base class) that are filtered/sorted with ransa
 ```ruby
 include Bp3::Core::Ransackable
 ```
+Then in your application's `config/initializers/bp3-core`, add:
+```ruby
+Bp3::Core::Ransackable.attribute_exceptions = %w[config config_id settable settable_id]
+Bp3::Core::Ransackable.association_exceptions = %w[config settable]
+```
 In all ActiveRecord models (or their base class) with a request-id attribute :rqid, add:
 ```ruby
 include Bp3::Core::Rqid
 ```
+Then in your application's `config/initializers/bp3-core`, add:
+```ruby
+Bp3::Core::Rqid.global_request_state_class_name = 'GlobalRequestState'
+Bp3::Core::Rqid.global_request_state_method = :request_id
+```
 In all ActiveRecord models (or their base class) with a sequence number attribute :sqnr, add:
 ```ruby
 include Bp3::Core::Sqnr
@@ -50,12 +61,13 @@ To use :sqnr for record ordering for a particular model, use the class macro:
 ```ruby
 use_sqnr_for_ordering
 ```
-In all ActiveRecord models (or their base class) that use site, tenant and/or workspace attributes that need
-to be populated from global state, add:
+In all ActiveRecord models (or their base class) that use site, tenant and/or workspace 
+attributes that need to be populated from global state, add:
 ```ruby
 include Bp3::Core::Tenantable
 ```
 The specific columns expected by `Tenantable` are:
+
 - site: `sites_site_id`
 - tenant: `tenant_id`
 - workspace: `workspaces_workspace_id`
@@ -63,20 +75,21 @@ Tenantable will use reflection to determine which one(s) exist, and will create
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You 
+can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `rake install`. To release a new version, 
+update the version number in `version.rb`, and then run `rake release`, which will create a git 
+tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Testing
 The `Bp3::Core::Test` class is for testing purposes.
 
+Run `rake` to run rspec tests and rubocop linting.
+
 ## Documentation
 A `.yardopts` file is provided to support yard documentation.
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/persuavis/bp3-core.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bp3-core.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Wim den Braven']
   spec.email = ['wimdenbraven@persuavis.com']
 
-  spec.summary = 'bp3-core provides core concerns for black_phoebe_3.'
+  spec.summary = 'bp3-core provides core concerns for BP3 (persuavis/black_phoebe_3).'
   # spec.description = "TODO: Write a longer description or delete this line."
   spec.homepage = 'https://www.black-phoebe.com'
   spec.license = 'MIT'

data/lib/bp3/core/actions.rb

@@ -2,6 +2,7 @@
 
 module Bp3
   module Core
+    # rubocop:disable Metrics/ModuleLength
     module Actions
       extend ActiveSupport::Concern
 
@@ -36,16 +37,16 @@ module Bp3
       private
 
       def set_global_request_state
-        GlobalRequestState.inbound_request = @global_request
-        GlobalRequestState.current_user = current_user
-        GlobalRequestState.current_admin = current_admin
-        GlobalRequestState.current_root = current_root
-        GlobalRequestState.locale = I18n.locale
-        GlobalRequestState.view_context = view_context
+        grsc.inbound_request = @global_request
+        grsc.current_user = current_user
+        grsc.current_admin = current_admin
+        grsc.current_root = current_root
+        grsc.locale = I18n.locale
+        grsc.view_context = view_context
       end
 
       def set_rqid
-        GlobalRequestState.request_id = global_rqid
+        grsc.request_id = global_rqid
       end
 
       def global_rqid
@@ -84,7 +85,7 @@ module Bp3
 
       def check_site
         current_site || create_site
-        GlobalRequestState.current_site = current_site
+        grsc.current_site = current_site
       end
 
       def current_site
@@ -100,7 +101,7 @@ module Bp3
       # TODO: cache the workspace/regex list
       def check_workspace
         current_workspace || create_workspace
-        GlobalRequestState.current_workspace = current_workspace
+        grsc.current_workspace = current_workspace
       end
 
       # TODO: move (some of) this into Workspace
@@ -127,7 +128,7 @@ module Bp3
 
       def check_tenant
         current_tenant || create_tenant
-        GlobalRequestState.current_tenant = current_tenant
+        grsc.current_tenant = current_tenant
       end
 
       def current_tenant
@@ -161,7 +162,7 @@ module Bp3
       end
 
       def info_for_paper_trail
-        state = GlobalRequestState.new
+        state = grsc.new
         {
           rqid: global_rqid,
           sites_site_id: state.current_site&.id,
@@ -187,7 +188,7 @@ module Bp3
       end
 
       def either_site
-        GlobalRequestState.either_site
+        grsc.either_site
       end
 
       def check_site_mode
@@ -203,6 +204,11 @@ module Bp3
           break
         end
       end
+
+      def grsc
+        @grsc ||= Bp3::Core::Rqid.global_request_state_class
+      end
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/bp3/core/cookies.rb

@@ -64,11 +64,11 @@ module Bp3
         return if cookie_value.blank? && do_not_track
 
         sites_site_id, tenant_id, identification = cookie_value&.split('/')
-        if sites_site_id && sites_site_id != GRS.current_site.id
-          Rails.logger.warn { "check_visitor_cookie: site mismatch! (#{sites_site_id} and #{GRS.current_site.id}" }
+        if sites_site_id && sites_site_id != grsc.current_site.id
+          Rails.logger.warn { "check_visitor_cookie: site mismatch! (#{sites_site_id} and #{grsc.current_site.id}" }
         end
-        if tenant_id && tenant_id != GRS.current_tenant.id
-          Rails.logger.warn { "check_visitor_cookie: tenant mismatch! (#{tenant_id} and #{GRS.current_tenant.id}" }
+        if tenant_id && tenant_id != grsc.current_tenant.id
+          Rails.logger.warn { "check_visitor_cookie: tenant mismatch! (#{tenant_id} and #{grsc.current_tenant.id}" }
         end
         visitor = Users::Visitor.find_by(sites_site_id:, tenant_id:, identification:)
         if visitor.nil?
@@ -80,7 +80,7 @@ module Bp3
             expires: 365.days.from_now
           }
         end
-        @current_visitor = GlobalRequestState.current_visitor = visitor
+        @current_visitor = grsc.current_visitor = visitor
         Rails.logger.debug do
           "check_visitor_cookie: cookie[#{visitor_cookie_name}]=#{cookies.signed[visitor_cookie_name]}"
         end
@@ -93,8 +93,8 @@ module Bp3
         return if cookie_value.blank? && do_not_track
 
         identification = cookie_value
-        sites_site_id = GRS.current_site_id
-        tenant_id = GRS.current_tenant_id
+        sites_site_id = grsc.current_site_id
+        tenant_id = grsc.current_tenant_id
         visitor = Users::Visitor.find_by(sites_site_id:, tenant_id:, identification:)
         if visitor.nil?
           visitor = create_visitor
@@ -105,7 +105,7 @@ module Bp3
             expires: 365.days.from_now
           }
         end
-        @current_visitor = GlobalRequestState.current_visitor = visitor
+        @current_visitor = grsc.current_visitor = visitor
         Rails.logger.debug do
           "check_visitor_cookie: cookie[#{new_visitor_cookie_name}]=#{cookies.signed[new_visitor_cookie_name]}"
         end
@@ -121,18 +121,18 @@ module Bp3
       end
 
       def create_visitor
-        Users::Visitor.create!(sites_site: GRS.current_site,
-                               tenant: GRS.current_tenant,
-                               workspaces_workspace: GRS.current_workspace,
+        Users::Visitor.create!(sites_site: grsc.current_site,
+                               tenant: grsc.current_tenant,
+                               workspaces_workspace: grsc.current_workspace,
                                identification: SecureRandom.uuid)
       end
 
       def cookie_site_id
-        GRS.current_site.id[0..7]
+        grsc.current_site.id[0..7]
       end
 
       def cookie_tenant_id
-        GRS.current_tenant.id[0..7]
+        grsc.current_tenant.id[0..7]
       end
     end
   end

data/lib/bp3/core/version.rb

@@ -2,6 +2,6 @@
 
 module Bp3
   module Core
-    VERSION = '0.1.2'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bp3-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Wim den Braven
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -179,5 +179,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: bp3-core provides core concerns for black_phoebe_3.
+summary: bp3-core provides core concerns for BP3 (persuavis/black_phoebe_3).
 test_files: []