bp3-noticed 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1193948dca5bcda90b8e2c1451a75ee2c93e8573175e178214d3c56a1c91f9b
+  data.tar.gz: 43df9cace6940523d31d82f2a45c75b3f705bbeb13f6580eca7655b2577c644e
+SHA512:
+  metadata.gz: d3c2ce7e7dd976b1a2a19f0a5989db81e8b76b9010a4e9bc54e52fc1d6c54e7d0e180f4c12f65774d4741534f947f84ef4d3d807ded7a77fa0fb40a51761b223
+  data.tar.gz: '09e6152cf5f3b49bc89b8c403cdc395b695ce83f301f7d7c84407ba0452f6f0962dfee93362b1de6f5ae3dfe82dbd9b4ae4fe7bf1407d01dece3dab3bd918c9e'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,51 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-capybara
+  - rubocop-factory_bot
+
+AllCops:
+  TargetRubyVersion: 3.2.2
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - lib/bp3/**/railtie.rb
+
+Lint/Void:
+  Exclude:
+    - lib/bp3/**/railtie.rb
+
+Metrics/AbcSize:
+  Max: 26
+
+Metrics/BlockLength:
+  Max: 66
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/FileName:
+  Exclude:
+    - lib/bp3-*.rb
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.2

data/.yardopts

@@ -0,0 +1,8 @@
+--charset utf-8
+--readme README.md
+--markup markdown
+--title "bp3-noticed"
+--private
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.1] - 2024-06-03
+
+- Tweaks and documentation
+
+## [0.1.0] - 2024-05-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bp3-noticed.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,261 @@
+PATH
+  remote: .
+  specs:
+    bp3-noticed (0.1.1)
+      activesupport (>= 7.1.2, < 8)
+      bp3-action_dispatch (>= 0.1, < 1)
+      bp3-core (>= 0.1, < 1)
+      noticed (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.3)
+      actionpack (= 7.1.3.3)
+      activesupport (= 7.1.3.3)
+      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)
+      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)
+      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)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      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)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.3)
+      activesupport (= 7.1.3.3)
+      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)
+      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)
+      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)
+      marcel (~> 1.0)
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    bp3-action_dispatch (0.1.1)
+      actionpack (>= 7.1.2, < 8)
+      activesupport (>= 7.1.2, < 8)
+      i18n (>= 1.8.11, < 2)
+    bp3-core (0.1.2)
+      actionview (>= 7.1.2, < 8)
+      activesupport (>= 7.1.2, < 8)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.3.1)
+    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)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.12)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.16.5-x86_64-darwin)
+      racc (~> 1.4)
+    noticed (2.3.2)
+      rails (>= 6.1.0)
+    parallel (1.24.0)
+    parser (3.3.2.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.0.11)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    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)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    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)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.8)
+      io-console (~> 0.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    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)
+      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)
+      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)
+      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 (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.30.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)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    strscan (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.15)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bp3-noticed!
+  byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.25)
+
+BUNDLED WITH
+   2.5.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Wim den Braven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Bp3::Noticed
+
+bp3-noticed adapts `noticed` for BP3, the persuavis/black_phoebe_3
+multi-site multi-tenant rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bp3-noticed'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bp3-noticed
+
+## Usage
+
+Do NOT change Noticed.parent_class, as this gem is making the necessary changes.
+
+In your app's `ApplicationJob`:
+```ruby
+include Bp3::Noticed::CommonIncludes
+include Bp3::Noticed::JobIncludes
+```
+In every custom job class that inherits from `ApplicationJob`:
+```ruby
+prepend Bp3::Noticed::PrependPerform
+```
+If there is que job class (outside of ActiveJob), inheriting from `Que::Job`:
+```ruby
+include Bp3::Noticed::CommonIncludes
+include Bp3::Noticed::QueIncludes
+```
+In every custom job class that inherits from that que job class`:
+```ruby
+prepend Bp3::Noticed::PrependPerform
+```
+
+## 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.
+
+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
+Run `rake` to run rspec tests and rubocop linting.
+
+## Documentation
+A `.yardopts` file is provided to support yard documentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bp3-noticed.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bp3/noticed/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bp3-noticed'
+  spec.version = Bp3::Noticed::VERSION
+  spec.authors = ['Wim den Braven']
+  spec.email = ['wimdenbraven@persuavis.com']
+
+  spec.summary = 'bp3-noticed adapts noticed 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'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/persuavis/bp3-noticed'
+  spec.metadata['changelog_uri'] = 'https://github.com/persuavis/bp3-noticed/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', ['>= 7.1.2', '< 8']
+  spec.add_dependency 'bp3-action_dispatch', ['>= 0.1', '< 1']
+  spec.add_dependency 'bp3-core', ['>= 0.1', '< 1']
+  spec.add_dependency 'noticed', '~> 2.2'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.25'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/bp3/noticed/common_includes.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module CommonIncludes
+  extend ActiveSupport::Concern
+
+  included do
+    attr_reader :args, :kwargs
+  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 run(...)
+    perform(...)
+  end
+
+  private
+
+  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 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
+
+    site_class.root_site || site_class.first
+  end
+
+  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
+
+  def job_key
+    self.class.name.underscore
+  end
+end

data/lib/bp3/noticed/job_includes.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module JobIncludes
+  extend ActiveSupport::Concern
+
+  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_soon(...)
+      set(wait: 1.minute).perform_later(...)
+    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
+
+  private
+
+  def job_type
+    'job'
+  end
+
+  def include_log_error(key:, message:, details: {})
+    return log_error(key:, message:, details:) if respond_to?(:log_error, true)
+
+    message = "Warning: #{self.class.name}#log_info: unable to log error #{key}/#{message}/#{details}"
+    Rails.logger.warn { message }
+    nil
+  end
+
+  def run_attrs(key)
+    check(arguments, key)
+  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
+
+  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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+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
+
+  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
+
+  # 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
+
+  # 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
+
+  # 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
+  end
+end

data/lib/bp3/noticed/que_includes.rb

@@ -0,0 +1,61 @@
+# 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
+
+    def perform_now(...)
+      run(...)
+    end
+
+    def run_now(...)
+      enqueue(...) # don't use perform_now, as it won't run in the background
+    end
+
+    def run_soon(*, **kwargs)
+      kwargs[:job_options] ||= {}
+      kwargs[:job_options][:run_at] ||= 1.minute.from_now
+      enqueue(*, **kwargs)
+    end
+
+    def run_later(*, **kwargs)
+      kwargs[:job_options] ||= {}
+      kwargs[:job_options][:run_at] ||= 1.hour.from_now
+      enqueue(*, **kwargs)
+    end
+  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
+
+  private
+
+  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

data/lib/bp3/noticed/railtie.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# require 'rails/railtie'
+
+module Bp3
+  module Noticed
+    if defined?(Rails.env)
+      class Railtie < Rails::Railtie
+        initializer 'bp3.noticed.railtie.register' do |app|
+          app.config.after_initialize do
+            ::Noticed::Event # preload
+            ::Noticed::Notification # preload
+            ::Noticed::ApplicationJob # preload
+            ::Noticed::EventJob # preload
+            ::Noticed::DeliveryMethod # preload
+            module ::Noticed
+              class Event
+                include Bp3::Core::Rqid
+                include Bp3::Core::Sqnr
+                include Bp3::Core::Tenantable
+
+                configure_tenancy
+                use_sqnr_for_ordering
+                # has_paper_trail
+
+                def recipient_attributes_for(recipient)
+                  # TODO: determine why this is needed, since global state and Tenantable should take care of this
+                  super.merge(global_scope)
+                end
+
+                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,
+                    workspaces_workspace_id: global_workspace_id
+                  }
+                end
+
+                def global_site_id
+                  global_request_state_class.current_site_id
+                end
+
+                def global_tenant_id
+                  global_request_state_class.current_tenant_id
+                end
+
+                def global_workspace_id
+                  global_request_state_class.current_workspace_id
+                end
+
+                def global_request_state_class
+                  Bp3::Core::Rqid.global_request_state_class
+                end
+              end
+
+              class Notification
+                include Bp3::Core::Rqid
+                include Bp3::Core::Sqnr
+                include Bp3::Core::Tenantable
+
+                configure_tenancy
+                use_sqnr_for_ordering
+                # has_paper_trail
+              end
+
+              class ApplicationJob
+                # include Que::ActiveJob::JobExtensions
+                include CommonIncludes
+                include JobIncludes
+
+                # Automatically retry jobs that encountered a deadlock
+                retry_on ActiveRecord::Deadlocked
+              end
+
+              class EventJob
+                prepend PrependPerform
+              end
+
+              class DeliveryMethod
+                prepend PrependPerform
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bp3/noticed/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bp3
+  module Noticed
+    VERSION = '0.1.1'
+  end
+end

data/lib/bp3/noticed.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'noticed/common_includes'
+require_relative 'noticed/job_includes'
+require_relative 'noticed/que_includes'
+require_relative 'noticed/prepend_perform'
+require_relative 'noticed/railtie'
+require_relative 'noticed/version'
+
+module Bp3
+  module Noticed
+  end
+end

data/lib/bp3-noticed.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bp3/noticed'

data/sig/bp3/noticed.rbs

@@ -0,0 +1,6 @@
+module Bp3
+  module Noticed
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: bp3-noticed
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wim den Braven
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: bp3-action_dispatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bp3-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: noticed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+description:
+email:
+- wimdenbraven@persuavis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bp3-noticed.gemspec
+- lib/bp3-noticed.rb
+- lib/bp3/noticed.rb
+- lib/bp3/noticed/common_includes.rb
+- lib/bp3/noticed/job_includes.rb
+- lib/bp3/noticed/prepend_perform.rb
+- lib/bp3/noticed/que_includes.rb
+- lib/bp3/noticed/railtie.rb
+- lib/bp3/noticed/version.rb
+- sig/bp3/noticed.rbs
+homepage: https://www.black-phoebe.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.black-phoebe.com
+  source_code_uri: https://github.com/persuavis/bp3-noticed
+  changelog_uri: https://github.com/persuavis/bp3-noticed/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: bp3-noticed adapts noticed for BP3 (persuavis/black_phoebe_3).
+test_files: []