bp3-noticed 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1193948dca5bcda90b8e2c1451a75ee2c93e8573175e178214d3c56a1c91f9b
-  data.tar.gz: 43df9cace6940523d31d82f2a45c75b3f705bbeb13f6580eca7655b2577c644e
+  metadata.gz: 17ac709db4d71552e25763221ab6f4ef95211242a1a138458da6a52b1ba84a96
+  data.tar.gz: 596bf31f9cf62f4f5c8133e3f5f8aa6808b0ccb95f9f50be16a16dc6d347ca61
 SHA512:
-  metadata.gz: d3c2ce7e7dd976b1a2a19f0a5989db81e8b76b9010a4e9bc54e52fc1d6c54e7d0e180f4c12f65774d4741534f947f84ef4d3d807ded7a77fa0fb40a51761b223
-  data.tar.gz: '09e6152cf5f3b49bc89b8c403cdc395b695ce83f301f7d7c84407ba0452f6f0962dfee93362b1de6f5ae3dfe82dbd9b4ae4fe7bf1407d01dece3dab3bd918c9e'
+  metadata.gz: b867d294631f28e7a4f39f0f2c842a166d38c7003504680866a077d4520d861f341a6b38a84785cdfdf8b8923afa348a2de42452e0e194f7d98fba1a1f4afdf2
+  data.tar.gz: fb876744be692af0fca93141185804a04434a575a1fcd2188bbdce17ed470d8ce725cc2a64651c87db4b3de6209f5daaf60b0e3c04a4453ebcfb2f475b3bfbdd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-07-31
+
+- Namespace include and prepend modules
+- Tweaks
+
 ## [0.1.1] - 2024-06-03
 
 - Tweaks and documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bp3-noticed (0.1.1)
+    bp3-noticed (0.2.0)
       activesupport (>= 7.1.2, < 8)
       bp3-action_dispatch (>= 0.1, < 1)
       bp3-core (>= 0.1, < 1)
@@ -10,35 +10,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actioncable (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activejob (= 7.1.3.3)
-      activerecord (= 7.1.3.3)
-      activestorage (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionmailbox (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      actionview (= 7.1.3.3)
-      activejob (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionmailer (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.2)
-    actionpack (7.1.3.3)
-      actionview (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -46,35 +46,35 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activerecord (= 7.1.3.3)
-      activestorage (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actiontext (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.1.3.3)
-      activesupport (= 7.1.3.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)
-    activejob (7.1.3.3)
-      activesupport (= 7.1.3.3)
+    activejob (7.1.3.4)
+      activesupport (= 7.1.3.4)
       globalid (>= 0.3.6)
-    activemodel (7.1.3.3)
-      activesupport (= 7.1.3.3)
-    activerecord (7.1.3.3)
-      activemodel (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       timeout (>= 0.4.0)
-    activestorage (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activejob (= 7.1.3.3)
-      activerecord (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    activestorage (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       marcel (~> 1.0)
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -87,28 +87,28 @@ GEM
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
-    bp3-action_dispatch (0.1.1)
+    bp3-action_dispatch (0.1.2)
       actionpack (>= 7.1.2, < 8)
       activesupport (>= 7.1.2, < 8)
       i18n (>= 1.8.11, < 2)
-    bp3-core (0.1.2)
+    bp3-core (0.1.4)
       actionview (>= 7.1.2, < 8)
       activesupport (>= 7.1.2, < 8)
-    builder (3.2.4)
+    builder (3.3.0)
     byebug (11.1.3)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
     diff-lcs (1.5.1)
     drb (2.2.1)
-    erubi (1.12.0)
+    erubi (1.13.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.13.1)
+    irb (1.14.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
@@ -123,9 +123,9 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.23.1)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    net-imap (0.4.12)
+    net-imap (0.4.14)
       date
       net-protocol
     net-pop (0.1.2)
@@ -135,18 +135,18 @@ GEM
     net-smtp (0.5.0)
       net-protocol
     nio4r (2.7.3)
-    nokogiri (1.16.5-x86_64-darwin)
+    nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    noticed (2.3.2)
+    noticed (2.4.1)
       rails (>= 6.1.0)
-    parallel (1.24.0)
-    parser (3.3.2.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.8.0)
-    rack (3.0.11)
+    racc (1.8.1)
+    rack (3.1.7)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -154,20 +154,20 @@ GEM
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
-    rails (7.1.3.3)
-      actioncable (= 7.1.3.3)
-      actionmailbox (= 7.1.3.3)
-      actionmailer (= 7.1.3.3)
-      actionpack (= 7.1.3.3)
-      actiontext (= 7.1.3.3)
-      actionview (= 7.1.3.3)
-      activejob (= 7.1.3.3)
-      activemodel (= 7.1.3.3)
-      activerecord (= 7.1.3.3)
-      activestorage (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    rails (7.1.3.4)
+      actioncable (= 7.1.3.4)
+      actionmailbox (= 7.1.3.4)
+      actionmailer (= 7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actiontext (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       bundler (>= 1.15.0)
-      railties (= 7.1.3.3)
+      railties (= 7.1.3.4)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -175,9 +175,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -188,51 +188,51 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.8)
+    reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    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.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.64.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.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    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.30.0)
+    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.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    stringio (3.1.0)
+    stringio (3.1.1)
     strscan (3.1.0)
     thor (1.3.1)
     timeout (0.4.1)
@@ -243,7 +243,7 @@ GEM
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.15)
+    zeitwerk (2.6.17)
 
 PLATFORMS
   x86_64-darwin-22

data/lib/bp3/noticed/common_includes.rb

@@ -1,69 +1,81 @@
 # frozen_string_literal: true
 
-module CommonIncludes
-  extend ActiveSupport::Concern
+module Bp3
+  module Noticed
+    module CommonIncludes
+      extend ActiveSupport::Concern
 
-  included do
-    attr_reader :args, :kwargs
-  end
+      included do
+        attr_reader :args, :kwargs
+      end
 
-  class_methods do
-    def global_request_state_class
-      Bp3::Core::Rqid.global_request_state_class
-    end
-  end
+      class_methods do
+        def global_request_state_class
+          Bp3::Core::Rqid.global_request_state_class
+        end
+      end
 
-  def global_request_state_class
-    Bp3::Core::Rqid.global_request_state_class
-  end
+      def global_request_state_class
+        Bp3::Core::Rqid.global_request_state_class
+      end
 
-  def run(...)
-    perform(...)
-  end
+      def run(...)
+        perform(...)
+      end
 
-  private
+      private
 
-  def set_global_request_state
-    global_request_state_class.from_hash(state)
-    global_request_state_class.current_site ||= ensure_site
-  end
+      def set_global_request_state
+        global_request_state_class.from_hash(state)
+        global_request_state_class.current_site ||= ensure_site
+      end
 
-  def state
-    run_attrs :state
-  end
+      def state
+        run_attrs :state
+      end
 
-  def ensure_site
-    id = run_attrs(:sites_site_id) || run_attrs(:site_id)
-    if id.present?
-      site = site_class.find_by(id:)
-      return site if site.present?
+      def ensure_site
+        id = run_attrs(:sites_site_id) || run_attrs(:site_id)
+        if id.present?
+          site = site_class.find_by(id:)
+          return site if site.present?
 
-      message = "Unable to find site #{id}"
-      include_log_error(key: 'prepend_state.ensure_site', message:)
-    end
+          message = "Unable to find site #{id}"
+          include_log_error(key: 'prepend_state.ensure_site', message:)
+        end
 
-    site_class.root_site || site_class.first
-  end
+        site_class.root_site || site_class.first
+      end
 
-  def site_class
-    Bp3::ActionDispatch.site_class
-  end
+      def include_log_error(key:, message:, details: {})
+        return log_error(key:, message:, details:) if respond_to?(:log_error, true)
 
-  def check(hash_or_array, key)
-    return nil if hash_or_array.blank?
+        message = "Warning: #{self.class.name}#log_info: unable to log error #{key}/#{message}/#{details}"
+        Rails.logger.warn { message }
+        nil
+      end
 
-    if hash_or_array.is_a?(Array)
-      hash_or_array.each do |obj|
-        value = check(obj, key)
-        return value if value
+      def site_class
+        Bp3::ActionDispatch.site_class
+      end
+
+      def check(hash_or_array, key)
+        return nil if hash_or_array.blank?
+
+        if hash_or_array.is_a?(Array)
+          hash_or_array.each do |obj|
+            value = check(obj, key)
+            return value if value
+          end
+          nil
+        elsif hash_or_array.is_a?(Hash)
+          hash_or_array[key.to_s] || hash_or_array[key.to_sym]
+        end
       end
-      nil
-    elsif hash_or_array.is_a?(Hash)
-      hash_or_array[key.to_s] || hash_or_array[key.to_sym]
-    end
-  end
 
-  def job_key
-    self.class.name.underscore
+      def job_key
+        self.class.name.underscore
+      end
+    end
   end
 end

data/lib/bp3/noticed/job_includes.rb

@@ -1,70 +1,66 @@
 # frozen_string_literal: true
 
-module JobIncludes
-  extend ActiveSupport::Concern
+module Bp3
+  module Noticed
+    module JobIncludes
+      extend ActiveSupport::Concern
 
-  class_methods do
-    def enqueue(...)
-      new.enqueue(...)
-    end
+      class_methods do
+        def enqueue(...)
+          new.enqueue(...)
+        end
 
-    def run_now(...)
-      perform_later(...) # don't use perform_now, as it won't run in the background
-    end
+        def run_now(...)
+          perform_later(...) # don't use perform_now, as it won't run in the background
+        end
 
-    def run_soon(...)
-      set(wait: 1.minute).perform_later(...)
-    end
+        def run_soon(...)
+          set(wait: 1.minute).perform_later(...)
+        end
 
-    def run_later(...)
-      set(wait: 1.hour).perform_later(...)
-    end
-  end
+        def run_later(...)
+          set(wait: 1.hour).perform_later(...)
+        end
+      end
 
-  def enqueue(*, **)
-    # Add state to arguments, not kwargs
-    # kwargs['state'] = GlobalRequestState.to_hash
-    arguments << { 'state' => global_request_state_class.to_hash }
-    super
-  end
+      def enqueue(*, **)
+        # Add state to arguments, not kwargs
+        # kwargs['state'] = GlobalRequestState.to_hash
+        arguments << { 'state' => global_request_state_class.to_hash }
+        super
+      end
 
-  private
+      private
 
-  def job_type
-    'job'
-  end
+      def job_type
+        'job'
+      end
 
-  def include_log_error(key:, message:, details: {})
-    return log_error(key:, message:, details:) if respond_to?(:log_error, true)
+      def run_attrs(key)
+        check(arguments, key)
+      end
 
-    message = "Warning: #{self.class.name}#log_info: unable to log error #{key}/#{message}/#{details}"
-    Rails.logger.warn { message }
-    nil
-  end
+      def check(hash_or_array, key)
+        return nil if hash_or_array.blank?
 
-  def run_attrs(key)
-    check(arguments, key)
-  end
+        if hash_or_array.is_a?(Array)
+          hash_or_array.each do |obj|
+            value = check(obj, key)
+            return value if value
+          end
+          nil
+        elsif hash_or_array.is_a?(Hash)
+          hash_or_array[key.to_s] || hash_or_array[key.to_sym]
+        end
+      end
 
-  def check(hash_or_array, key)
-    return nil if hash_or_array.blank?
+      def site
+        global_request_state_class.current_site
+      end
 
-    if hash_or_array.is_a?(Array)
-      hash_or_array.each do |obj|
-        value = check(obj, key)
-        return value if value
+      def job_key
+        self.class.name.underscore
       end
-      nil
-    elsif hash_or_array.is_a?(Hash)
-      hash_or_array[key.to_s] || hash_or_array[key.to_sym]
     end
   end
-
-  def site
-    global_request_state_class.current_site
-  end
-
-  def job_key
-    self.class.name.underscore
-  end
 end

data/lib/bp3/noticed/prepend_perform.rb

@@ -1,74 +1,79 @@
 # frozen_string_literal: true
 
-module PrependPerform
-  include CommonIncludes
+module Bp3
+  module Noticed
+    module PrependPerform
+      include CommonIncludes
 
-  # rubocop:disable Metrics/MethodLength
-  def perform(*args, **kwargs)
-    @args = args
-    @kwargs = kwargs
-    set_global_request_state
-    details = { args:, kwargs: }
-    log = nil
-    args = remove_state(args)
-    kwargs = remove_state(kwargs)
-    begin
-      super
-    rescue ArgumentError
-      super() # in case super is relying on run_attrs
-    end
-    disposition = 'finished'
-    log = prepend_log_info(key: "#{job_type}.#{disposition}.#{job_key}", message: "#{disposition} job_type", details:)
-  rescue StandardError => e
-    disposition = 'failed'
-    log = prepend_log_exception(e, key: "#{job_type}.#{disposition}.#{job_key}", details:)
-    raise e # to continue the normal job flow
-  ensure
-    prepend_add_event(eventable: log, disposition:)
-    global_request_state_class.clear!
-  end
-  # rubocop:enable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
+      def perform(*args, **kwargs)
+        @args = args
+        @kwargs = kwargs
+        set_global_request_state
+        details = { args:, kwargs: }
+        log = nil
+        args = remove_state(args)
+        kwargs = remove_state(kwargs)
+        begin
+          super
+        rescue ArgumentError
+          super() # in case super is relying on run_attrs
+        end
+        disposition = 'finished'
+        log = prepend_log_info(key: "#{job_type}.#{disposition}.#{job_key}", message: "#{disposition} job_type",
+                               details:)
+      rescue StandardError => e
+        disposition = 'failed'
+        log = prepend_log_exception(e, key: "#{job_type}.#{disposition}.#{job_key}", details:)
+        raise e # to continue the normal job flow
+      ensure
+        prepend_add_event(eventable: log, disposition:)
+        global_request_state_class.clear!
+      end
+      # rubocop:enable Metrics/MethodLength
 
-  private
+      private
 
-  def remove_state(obj)
-    if obj.is_a?(Hash)
-      obj.except(:state, 'state')
-    elsif obj.is_a?(Array)
-      obj.reject { |e| e.is_a?(Hash) && (e.key?(:state) || e.key?('state')) }
-    else
-      obj
-    end
-  end
+      def remove_state(obj)
+        if obj.is_a?(Hash)
+          obj.except(:state, 'state')
+        elsif obj.is_a?(Array)
+          obj.reject { |e| e.is_a?(Hash) && (e.key?(:state) || e.key?('state')) }
+        else
+          obj
+        end
+      end
 
-  # override in subclasses if needed
-  def prepend_add_event(eventable:, disposition:)
-    return add_event(eventable:, disposition:) if respond_to?(:add_event, true)
+      # override in subclasses if needed
+      def prepend_add_event(eventable:, disposition:)
+        return add_event(eventable:, disposition:) if respond_to?(:add_event, true)
 
-    creator = global_request_state_class.current_login || global_request_state_class.current_visitor
-    who = creator.nil? ? 'nil' : "#{creator.class.name}/#{creator.id}"
-    did = disposition
-    what = eventable.nil? ? 'nil' : "#{eventable.class.name}/#{eventable.id}"
-    message = "Warning: #{self.class.name}#add_event: unable to add event #{who}/#{did}/#{what}"
-    Rails.logger.warn { message }
-    nil
-  end
+        creator = global_request_state_class.current_login || global_request_state_class.current_visitor
+        who = creator.nil? ? 'nil' : "#{creator.class.name}/#{creator.id}"
+        did = disposition
+        what = eventable.nil? ? 'nil' : "#{eventable.class.name}/#{eventable.id}"
+        message = "Warning: #{self.class.name}#add_event: unable to add event #{who}/#{did}/#{what}"
+        Rails.logger.warn { message }
+        nil
+      end
 
-  # override in subclasses if needed
-  def prepend_log_info(key:, message:, details: {})
-    return log_info(key:, message:, details:) if respond_to?(:log_info, true)
+      # override in subclasses if needed
+      def prepend_log_info(key:, message:, details: {})
+        return log_info(key:, message:, details:) if respond_to?(:log_info, true)
 
-    message = "Warning: #{self.class.name}#log_info: unable to log info #{key}/#{message}/#{details}"
-    Rails.logger.warn { message }
-    nil
-  end
+        message = "Warning: #{self.class.name}#log_info: unable to log info #{key}/#{message}/#{details}"
+        Rails.logger.warn { message }
+        nil
+      end
 
-  # override in subclasses if needed
-  def prepend_log_exception(exception, key:, details: {})
-    return log_exception(exception, key:, details:) if respond_to?(:log_exception, true)
+      # override in subclasses if needed
+      def prepend_log_exception(exception, key:, details: {})
+        return log_exception(exception, key:, details:) if respond_to?(:log_exception, true)
 
-    message = "Warning: #{self.class.name}#log_exception: unable to log exception #{exception}/#{key}/#{details}"
-    Rails.logger.warn { message }
-    nil
+        message = "Warning: #{self.class.name}#log_exception: unable to log exception #{exception}/#{key}/#{details}"
+        Rails.logger.warn { message }
+        nil
+      end
+    end
   end
 end

data/lib/bp3/noticed/que_includes.rb

@@ -1,61 +1,65 @@
 # frozen_string_literal: true
 
-module QueIncludes
-  extend ActiveSupport::Concern
-
-  class_methods do
-    def enqueue(*args, **kwargs)
-      if ENV.fetch('BP_DEBUG', nil) =~ /quejobs/
-        Rails.logger.warn { "enqueue with #{args} and #{kwargs}" }
-        Rails.logger.warn { global_request_state_class.to_hash }
-      end
-      kwargs['state'] = global_request_state_class.to_hash
-      super
-    end
+module Bp3
+  module Noticed
+    module QueIncludes
+      extend ActiveSupport::Concern
 
-    def perform_now(...)
-      run(...)
-    end
+      class_methods do
+        def enqueue(*args, **kwargs)
+          if ENV.fetch('BP_DEBUG', nil) =~ /quejobs/
+            Rails.logger.warn { "enqueue with #{args} and #{kwargs}" }
+            Rails.logger.warn { global_request_state_class.to_hash }
+          end
+          kwargs['state'] = global_request_state_class.to_hash
+          super
+        end
 
-    def run_now(...)
-      enqueue(...) # don't use perform_now, as it won't run in the background
-    end
+        def perform_now(...)
+          run(...)
+        end
 
-    def run_soon(*, **kwargs)
-      kwargs[:job_options] ||= {}
-      kwargs[:job_options][:run_at] ||= 1.minute.from_now
-      enqueue(*, **kwargs)
-    end
+        def run_now(...)
+          enqueue(...) # don't use perform_now, as it won't run in the background
+        end
 
-    def run_later(*, **kwargs)
-      kwargs[:job_options] ||= {}
-      kwargs[:job_options][:run_at] ||= 1.hour.from_now
-      enqueue(*, **kwargs)
-    end
-  end
+        def run_soon(*, **kwargs)
+          kwargs[:job_options] ||= {}
+          kwargs[:job_options][:run_at] ||= 1.minute.from_now
+          enqueue(*, **kwargs)
+        end
 
-  # set the log level based on the job duration. elapsed is in seconds
-  def log_level(elapsed)
-    if elapsed > 5
-      :warn
-    elsif elapsed > 1
-      :info
-    else
-      false # no need to log
-    end
-  end
+        def run_later(*, **kwargs)
+          kwargs[:job_options] ||= {}
+          kwargs[:job_options][:run_at] ||= 1.hour.from_now
+          enqueue(*, **kwargs)
+        end
+      end
 
-  private
+      # set the log level based on the job duration. elapsed is in seconds
+      def log_level(elapsed)
+        if elapsed > 5
+          :warn
+        elsif elapsed > 1
+          :info
+        else
+          false # no need to log
+        end
+      end
 
-  def job_type
-    'que'
-  end
+      private
 
-  def run_attrs(key)
-    check(que_attrs, key) ||
-      check(que_attrs[:args], key) ||
-      check(que_attrs[:kwargs], key) ||
-      check(args, key) ||
-      check(kwargs, key)
+      def job_type
+        'que'
+      end
+
+      def run_attrs(key)
+        check(que_attrs, key) ||
+          check(que_attrs[:args], key) ||
+          check(que_attrs[:kwargs], key) ||
+          check(args, key) ||
+          check(kwargs, key)
+      end
+    end
   end
 end

data/lib/bp3/noticed/railtie.rb

@@ -31,9 +31,9 @@ module Bp3
                 private
 
                 def global_scope
-                  { # TODO: determine why only workspace needs to be provided to make it work
-                    # sites_site_id: global_site_id,
-                    # tenant_id: global_tenant_id,
+                  {
+                    sites_site_id: global_site_id,
+                    tenant_id: global_tenant_id,
                     workspaces_workspace_id: global_workspace_id
                   }
                 end
@@ -67,19 +67,19 @@ module Bp3
 
               class ApplicationJob
                 # include Que::ActiveJob::JobExtensions
-                include CommonIncludes
-                include JobIncludes
+                include Bp3::Noticed::CommonIncludes
+                include Bp3::Noticed::JobIncludes
 
                 # Automatically retry jobs that encountered a deadlock
                 retry_on ActiveRecord::Deadlocked
               end
 
               class EventJob
-                prepend PrependPerform
+                prepend Bp3::Noticed::PrependPerform
               end
 
               class DeliveryMethod
-                prepend PrependPerform
+                prepend Bp3::Noticed::PrependPerform
               end
             end
           end

data/lib/bp3/noticed/version.rb

@@ -2,6 +2,6 @@
 
 module Bp3
   module Noticed
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bp3-noticed
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Wim den Braven
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport