bp3-activestorage 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e5c67003411959eb9a46ed29f88d43805422aff300e11b26891f94642beadc8
+  data.tar.gz: fe3712363cffc7ace5a83f6b18f4c5c6e1bba9fa2cfa0f21557519e204086866
+SHA512:
+  metadata.gz: 81d7eb9157e499bb9f82330c9c782c74cea00551390a704aafc85aa14b295c02dc31df244e9f46492ca80160d4a25afcdb789a4cca6de0fd3796048e1d41f7c4
+  data.tar.gz: 2bf61b92f8374745e0b4f622b4fde047474b284ccb2ee567c06e10debe5e9600b386cfc5a6e0a8d09a368d40ce3a07eb7a30ee80824d3ad9082c34901aca0fda

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/.yardopts

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.1] - 2024-05-31
+
+- Tweaks and documentation
+
+## [0.1.0] - 2024-01-08
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,164 @@
+PATH
+  remote: .
+  specs:
+    bp3-activestorage (0.1.1)
+      activestorage (~> 7.1)
+      bp3-core (>= 0.1.0, < 2)
+      paper_trail (~> 15.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.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)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3)
+      activesupport (= 7.1.3)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3)
+      activesupport (= 7.1.3)
+    activerecord (7.1.3)
+      activemodel (= 7.1.3)
+      activesupport (= 7.1.3)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3)
+      actionpack (= 7.1.3)
+      activejob (= 7.1.3)
+      activerecord (= 7.1.3)
+      activesupport (= 7.1.3)
+      marcel (~> 1.0)
+    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)
+    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.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)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    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)
+    marcel (1.0.2)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    nokogiri (1.16.0-x86_64-darwin)
+      racc (~> 1.4)
+    paper_trail (15.1.0)
+      activerecord (>= 6.1)
+      request_store (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.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)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    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)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bp3-activestorage!
+  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,45 @@
+# Bp3::Activestorage
+
+bp3-activestorage adapts various `ActiveStorage` classes 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-activestorage'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bp3-activestorage
+
+## Usage
+
+Just add the gem to your BP3 app.
+
+## 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-activestorage.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bp3/activestorage/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bp3-activestorage'
+  spec.version = Bp3::Activestorage::VERSION
+  spec.authors = ['Wim den Braven']
+  spec.email = ['wimdenbraven@persuavis.com']
+
+  spec.summary = 'bp3-activestorage adapts activestorage 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-activestorage'
+  spec.metadata['changelog_uri'] = 'https://github.com/persuavis/bp3-activestorage/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 'activestorage', '~> 7.1'
+  spec.add_dependency 'paper_trail', '~> 15.1'
+  spec.add_dependency 'bp3-core', ['>= 0.1.0', '< 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/activestorage/railtie.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# require 'rails/railtie'
+
+module Bp3
+  module Activestorage
+    if defined?(Rails.env)
+      class Railtie < Rails::Railtie
+        initializer 'bp3.activestorage.railtie.register' do |app|
+          app.config.after_initialize do
+            ::ActiveStorage::Attachment # preload
+            ::ActiveStorage::Blob # preload
+            ::ActiveStorage::VariantRecord # preload
+            ::ActiveStorage::BaseController # preload
+            ::ActiveStorage::Representations::ProxyController # preload
+            module ::ActiveStorage
+              # CAUTION: do not include Tenantable, it breaks things (it may set site/tenant behind the scenes,
+              #   and sets the default scope, and then later the blob can't be found
+              class Attachment
+                include Bp3::Core::Rqid
+                include Bp3::Core::Sqnr
+                include Bp3::Core::Ransackable
+
+                use_sqnr_for_ordering
+                has_paper_trail
+
+                belongs_to :sites_site, class_name: 'Sites::Site', optional: true
+                alias site sites_site
+                alias site= sites_site=
+                belongs_to :tenant, optional: true
+              end
+
+              class Blob
+                include Bp3::Core::Rqid
+                include Bp3::Core::Sqnr
+                include Bp3::Core::Displayable
+
+                use_sqnr_for_ordering
+                has_paper_trail
+
+                belongs_to :sites_site, class_name: 'Sites::Site', optional: true
+                alias site sites_site
+                alias site= sites_site=
+                belongs_to :tenant, optional: true
+
+                private
+
+                def version_filter_mask
+                  '[FILTERED][AB]'
+                end
+              end
+
+              class VariantRecord
+                include Bp3::Core::Rqid
+                include Bp3::Core::Sqnr
+
+                use_sqnr_for_ordering
+                has_paper_trail
+
+                belongs_to :sites_site, class_name: 'Sites::Site', optional: true
+                alias site sites_site
+                alias site= sites_site=
+                belongs_to :tenant, optional: true
+              end
+
+              class BaseController
+                include Bp3::Core::Actions
+                include Bp3::Core::Settings
+                include Bp3::Core::FeatureFlags
+                include Bp3::Core::Cookies
+
+                # TODO: is this needed?
+                # before_action :authenticate_root!
+              end
+
+              module Representations
+                class ProxyController
+                  include Bp3::Core::Actions
+                  include Bp3::Core::Settings
+                  include Bp3::Core::FeatureFlags
+                  include Bp3::Core::Cookies
+
+                  # using authenticate_root! breaks things
+                  # TODO: is this needed?
+                  # before_action :authenticate_root!
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bp3/activestorage/version.rb

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

data/lib/bp3/activestorage.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'activestorage/railtie'
+require_relative 'activestorage/version'
+
+module Bp3
+  module Activestorage
+  end
+end

data/lib/bp3-activestorage.rb

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

data/sig/bp3/activestorage.rbs

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

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: bp3-activestorage
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wim den Braven
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '15.1'
+- !ruby/object:Gem::Dependency
+  name: bp3-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '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"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bp3-activestorage.gemspec
+- lib/bp3-activestorage.rb
+- lib/bp3/activestorage.rb
+- lib/bp3/activestorage/railtie.rb
+- lib/bp3/activestorage/version.rb
+- sig/bp3/activestorage.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-activestorage
+  changelog_uri: https://github.com/persuavis/bp3-activestorage/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-activestorage adapts activestorage for BP3 (persuavis/black_phoebe_3).
+test_files: []