bp3-core 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '02341017029035ce15928115c68d1b142a43d46474e8b7ea989c3c67d38ae323'
+  data.tar.gz: 4e54a3d0c7357386472cf811707c9c990cbbd20541dad265b73d5f24224bfbaa
+SHA512:
+  metadata.gz: 88c7855cd29ba6a7d33f404d8947d75df4ea27d11bfed33ea34a242e1fe3e31624c2619935d8f5018f2df684c5973f95954e016d125d009915923b87be44247d
+  data.tar.gz: bf68641f064961b9de03cc3cdf9a70b63d9c2e4a362d4b8b7dec70cee5564ceb550042826c480ed3d4eec68680d8bb95d0731a26f50df61352dce3e202a23606

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-capybara
+  - rubocop-factory_bot
+
+AllCops:
+  TargetRubyVersion: 3.2.2
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+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,2 @@
+ruby-3.2.2
+

data/.yardopts

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

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+## [0.1.2] - 2024-05-30
+
+- Explicit require active_support/parameter_filter
+
+## [0.1.1] - 2024-05-30
+
+- Tweaks and documentation
+
+## [0.1.0] - 2023-12-19
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    bp3-core (0.1.2)
+      actionview (>= 7.1.2, < 8)
+      activesupport (>= 7.1.2, < 8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.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.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.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)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.5-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.60.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.30.0, < 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 (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bp3-core!
+  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) 2023-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,82 @@
+# Bp3::Core
+
+bp3-core provides core concerns for the persuavis/black_phoebe_3 multi-site multi-tenant rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bp3-core'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bp3-core
+
+## Usage
+
+In all controllers (or their base class), add
+```ruby
+include Bp3::Core::Actions
+include Bp3::Core::Cookies
+```
+In ActiveRecord models(or their base class) that are displayed to users, add:
+```ruby
+include Bp3::Core::Displayable
+```
+In models, controllers, services and helpers that use feature flags, add:
+```ruby
+include Bp3::Core::FeatureFlags
+include Bp3::Core::Settings
+```
+In ActiveRecord models (or their base class) that are filtered/sorted with ransack, add:
+```ruby
+include Bp3::Core::Ransackable
+```
+In all ActiveRecord models (or their base class) with a request-id attribute :rqid, add:
+```ruby
+include Bp3::Core::Rqid
+```
+In all ActiveRecord models (or their base class) with a sequence number attribute :sqnr, add:
+```ruby
+include Bp3::Core::Sqnr
+```
+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:
+```ruby
+include Bp3::Core::Tenantable
+```
+The specific columns expected by `Tenantable` are:
+- site: `sites_site_id`
+- tenant: `tenant_id`
+- workspace: `workspaces_workspace_id`
+Tenantable will use reflection to determine which one(s) exist, and will create associations and callbacks accordingly. 
+
+## 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 `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).
+
+## Testing
+The `Bp3::Core::Test` class is for testing purposes.
+
+## 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/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-core.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bp3/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bp3-core'
+  spec.version = Bp3::Core::VERSION
+  spec.authors = ['Wim den Braven']
+  spec.email = ['wimdenbraven@persuavis.com']
+
+  spec.summary = 'bp3-core provides core concerns for 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-core'
+  spec.metadata['changelog_uri'] = 'https://github.com/persuavis/bp3-core/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 'actionview', ['>= 7.1.2', '< 8']
+  spec.add_dependency 'activesupport', ['>= 7.1.2', '< 8']
+
+  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/core/actions.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Bp3
+  module Core
+    module Actions
+      extend ActiveSupport::Concern
+
+      # include FeatureFlags # do not include here
+      # include Settings # do not include here
+
+      included do
+        # Order matters! don't change it. These prepends are from last to first
+        prepend_before_action :check_tenant
+        prepend_before_action :check_workspace
+        prepend_before_action :check_site
+        prepend_before_action :set_rqid
+        before_action :set_paper_trail_whodunnit # uses user_for_paper_trail
+        before_action :find_or_create_user_agent
+        before_action :create_request_record
+        before_action :check_site_mode
+
+        before_action :set_global_request_state
+      end
+
+      class_methods do
+        # To support Devise this needs to be a class method
+        def default_url_options(options = {})
+          out = super().merge(options)
+          ignore_locale = ENV.fetch('IGNORE_LOCALIZATION', false)
+          return out if ignore_locale
+
+          out.merge(locale: I18n.locale)
+        end
+      end
+
+      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
+      end
+
+      def set_rqid
+        GlobalRequestState.request_id = global_rqid
+      end
+
+      def global_rqid
+        @global_rqid ||= request.request_id || SecureRandom.uuid
+      end
+
+      def create_request_record
+        return if do_not_track
+        return unless create_request_record_is_on?
+
+        # Apparently, we can receive multiple requests with the same request_id
+        # TODO: relax the uniqueness constraint instead of re-using the existing record
+        @global_request = Inbound::Request.find_by(id: request.request_id)
+        return @global_request if @global_request
+
+        @global_request = Inbound::Request.create!(id: global_rqid,
+                                                   url: request.url,
+                                                   ip_address: request.ip,
+                                                   referer: request.referer,
+                                                   inbound_user_agent: @global_user_agent,
+                                                   sites_site: current_site)
+      end
+
+      def find_or_create_user_agent
+        return if do_not_track
+
+        user_agent = request.user_agent.presence || 'user-agent-is-blank'
+        @global_user_agent = Inbound::UserAgent.find_or_create_by!(user_agent:)
+      rescue ActiveRecord::RecordInvalid
+        # probably hit a race condition. Try again and log
+        @global_user_agent = Inbound::UserAgent.find_by!(user_agent:)
+        message = "User agent already existed (#{@global_user_agent.id}/#{user_agent})"
+        log_warn(key: 'find_or_create_user_agent', message:)
+        @global_user_agent
+      end
+
+      def check_site
+        current_site || create_site
+        GlobalRequestState.current_site = current_site
+      end
+
+      def current_site
+        return @current_site if @current_site
+
+        @current_site = request.request_site
+      end
+
+      def create_site
+        @current_site = Sites::Site.create!(request_domain:)
+      end
+
+      # TODO: cache the workspace/regex list
+      def check_workspace
+        current_workspace || create_workspace
+        GlobalRequestState.current_workspace = current_workspace
+      end
+
+      # TODO: move (some of) this into Workspace
+      def current_workspace
+        return @current_workspace if @current_workspace
+        return nil if current_site.nil?
+
+        current_site.workspaces.find_each do |workspace|
+          if workspace.has_pattern_match?(request.subdomain)
+            @current_workspace = workspace
+            return @current_workspace
+          end
+        end
+      end
+
+      # TODO: move (some of) this into Workspace
+      def create_workspace
+        workspace_type = Workspaces::WorkspaceType
+                         .find_or_create_by!(sites_site: current_site, name: 'default')
+        @current_workspace = Workspaces::Workspace.create!(sites_site: current_site,
+                                                           name: 'default', match_pattern: '\A.*\z',
+                                                           workspaces_workspace_type: workspace_type)
+      end
+
+      def check_tenant
+        current_tenant || create_tenant
+        GlobalRequestState.current_tenant = current_tenant
+      end
+
+      def current_tenant
+        return @current_tenant if @current_tenant
+
+        @current_tenant = current_site.tenants.find_by(tenantable:)
+      end
+
+      def create_tenant
+        @current_tenant = Tenant.create!(sites_site: current_site, tenantable:)
+      end
+
+      def tenantable
+        @tenantable ||= multi_tenant_is_on? ? current_workspace : current_site
+      end
+
+      def request_domain
+        @request_domain ||= DomainExtractor.extract_domain(request_host) || request.domain || request_host
+      end
+
+      def request_host
+        request.normalized_host
+      end
+
+      def request_subdomain
+        return @request_subdomain if @request_subdomain
+
+        subdomain = request_host.gsub(/#{request_domain}\z/, '')
+        subdomain = subdomain[0..-2] if subdomain.ends_with?('.')
+        @request_subdomain = subdomain
+      end
+
+      def info_for_paper_trail
+        state = GlobalRequestState.new
+        {
+          rqid: global_rqid,
+          sites_site_id: state.current_site&.id,
+          tenant_id: state.current_tenant&.id,
+          workspaces_workspace_id: state.current_workspace&.id,
+          root_id: state.current_root&.id,
+          sites_admin_id: state.current_admin&.id,
+          users_user_id: state.current_user&.id
+        }
+      end
+
+      def set_ransack_auth_object
+        current_root || current_admin || current_user
+      end
+
+      # used by set_paper_trail_whodunnit
+      def user_for_paper_trail
+        current_root || current_admin || current_user || current_visitor || 'guest'
+      end
+
+      def pundit_user
+        UserContext.new
+      end
+
+      def either_site
+        GlobalRequestState.either_site
+      end
+
+      def check_site_mode
+        return unless current_site.sites_modes.enabled.timely.any?
+
+        current_site.sites_modes.enabled.timely.each do |mode|
+          next unless mode.name == 'maintenance'
+
+          @resource = @sites_mode = mode
+          @content = @resource.content
+          @content_format = @resource.content_format
+          render template: 'sites/modes/maintenance'
+          break
+        end
+      end
+    end
+  end
+end