solidus_acts_as_tenant 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c67f9e35b620f97b3a738708559055f85d92ac6b43591779aa50f6cf43eb4d76
+  data.tar.gz: 0c4a3960d9d2a8e9fe7800638a88be038ee08f4ba9aaf10b86b532941d733e82
+SHA512:
+  metadata.gz: 3f63e4c205f38a72b8158e93842dea657703fd762f8fc9780e13463e4f97cfebcf25df664c565481e7fe4b59901b84c02b50811fb405e7441d78d6937cf08b26
+  data.tar.gz: 3939842985001922147fa66e81b080144db9a57270bbace73fcc94308a7802546cd8286efc2fa3abb8bdc8f30c3e9167d08685177a35e957f8dbfd0cfe0668d8

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_acts_as_tenant/version.rb'
+  message: Bump SolidusActsAsTenant to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1 @@
+_extends: .github

data/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on: [pull_request]
+
+concurrency:
+  group: lint-${{ github.ref_name }}
+  cancel-in-progress: ${{ github.ref_name != 'main' }}
+
+permissions:
+  contents: read
+
+jobs:
+  ruby:
+    name: Check Ruby
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+      - name: Lint Ruby files
+        run: bundle exec rubocop -ESP

data/.github/workflows/test.yml

@@ -0,0 +1,71 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  schedule:
+    - cron: "0 0 * * 4" # every Thursday
+
+concurrency:
+  group: test-${{ github.ref_name }}
+  cancel-in-progress: ${{ github.ref_name != 'main' }}
+
+permissions:
+  contents: read
+
+jobs:
+  rspec:
+    name: Solidus ${{ matrix.solidus-branch }}, Rails ${{ matrix.rails-version }} and Ruby ${{ matrix.ruby-version }} on ${{ matrix.database }}
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: true
+      matrix:
+        rails-version:
+          - "7.0"
+          - "7.1"
+          - "7.2"
+        ruby-version:
+          - "3.1"
+          - "3.4"
+        solidus-branch:
+          - "v4.1"
+          - "v4.2"
+          - "v4.3"
+          - "v4.4"
+          - "v4.5"
+        database:
+          - "postgresql"
+          - "mysql"
+          - "sqlite"
+        exclude:
+          - rails-version: "7.2"
+            solidus-branch: "v4.3"
+          - rails-version: "7.2"
+            solidus-branch: "v4.2"
+          - rails-version: "7.2"
+            solidus-branch: "v4.1"
+          - rails-version: "7.1"
+            solidus-branch: "v4.2"
+          - rails-version: "7.1"
+            solidus-branch: "v4.1"
+          - ruby-version: "3.4"
+            rails-version: "7.0"
+    env:
+      CODECOV_COVERAGE_PATH: ./coverage/coverage.xml
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run extension tests
+        uses: solidusio/test-solidus-extension@main
+        with:
+          database: ${{ matrix.database }}
+          rails-version: ${{ matrix.rails-version }}
+          ruby-version: ${{ matrix.ruby-version }}
+          solidus-branch: ${{ matrix.solidus-branch }}
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        continue-on-error: true
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ${{ env.CODECOV_COVERAGE_PATH }}

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+issues=false
+exclude-labels=infrastructure

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+Gemfile-local
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - solidus_dev_support/rubocop
+
+FactoryBot/CreateList:
+  Enabled: false
+
+FactoryBot/AssociationStyle:
+  Enabled: false
+
+FactoryBot/FactoryNameStyle:
+  Enabled: false
+
+FactoryBot/ConsistentParenthesesStyle:
+  Enabled: false
+
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.2 # Matching the .github/workflow/lint.yml ruby version

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+See https://github.com/nebulab/solidus_acts_as_tenant/releases or OLD_CHANGELOG.md for older versions.

data/Gemfile

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'main')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# The solidus_frontend gem has been pulled out since v3.2
+if branch >= 'v3.2'
+  gem 'solidus_frontend'
+elsif branch == 'main'
+  gem 'solidus_frontend', github: 'solidusio/solidus_frontend'
+else
+  gem 'solidus_frontend', github: 'solidusio/solidus', branch: branch
+end
+
+rails_version = ENV.fetch('RAILS_VERSION', '7.0')
+gem 'rails', "~> #{rails_version}"
+
+case ENV.fetch('DB', nil)
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3', rails_version < '7.2' ? '~> 1.4' : '~> 2.0'
+end
+
+if rails_version == '7.0'
+  gem 'concurrent-ruby', '< 1.3.5'
+end
+
+if RUBY_VERSION >= '3.4'
+  # Solidus Promotions uses CSV but does not have it as dependency yet.
+  gem 'csv'
+end
+
+# While we still support Ruby < 3 we need to workaround a limitation in
+# the 'async' gem that relies on the latest ruby, since RubyGems doesn't
+# resolve gems based on the required ruby version.
+gem 'async', '< 3' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3')
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2024 Solidus Contrib
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,99 @@
+# Solidus Acts As Tenant
+
+[![codecov](https://codecov.io/gh/nebulab/solidus_acts_as_tenant/branch/main/graph/badge.svg)](https://codecov.io/gh/nebulab/solidus_acts_as_tenant)
+
+
+This extension adds multi-tenant support to solidus using the row-level tenancy [acts_as_tenant](https://github.com/ErwinM/acts_as_tenant/commits/master/) gem.
+
+It adds tenant scoping to a configurabale set of models and adds a console utility to switch between tenants.
+
+## Installation
+
+Add solidus_acts_as_tenant to your Gemfile:
+
+```ruby
+gem 'solidus_acts_as_tenant'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bin/rails generate solidus_acts_as_tenant:install
+```
+
+## Usage
+
+See the [acts_as_tenant](https://github.com/ErwinM/acts_as_tenant) gem for an explanation of how tenant scoping works.
+
+To configure this extension for your project, see:
+
+- The generated migration files
+- The generated tenant_aware_models.yml file
+- The generated initializer.rb file
+
+
+There is also a console utility that can be used to simply manage tenants in the console.
+To use it, you can add it to your `~/.irbrc` file or `~/.pryrc` file:
+
+```ruby
+if defined?(Rails)
+  TS = SolidusActsAsTenant::Utils::TenantSelector.new
+
+  IRB.conf[:IRB_RC] = proc do
+    #   * TS.ask             => anytime in console, to switch tenant from a list
+    #   * TS.current         => same as Apartment::Tenant.current
+    #   * TS.tenants         => hash of tenants. Example: { 0 => "Demo Company" }
+    #   * TS.switch_tenant!(tenant_name) => same as ActsAsTenant.current_tenant = Tenant.find_by(name: tenant_name)
+    TS.ask
+  end
+end
+```
+
+## Development
+
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
+app if it does not exist, then it will run specs. The dummy app can be regenerated by using
+`bin/rake extension:test_app`.
+
+```shell
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+You can load Solidus core factories along with this extension's factories using this statement:
+
+```ruby
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusActsAsTenant::Engine)
+```
+
+### Running the sandbox
+
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
+
+Here's an example:
+
+```
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Releasing new versions
+
+Please refer to the [dedicated page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) in the Solidus wiki.
+
+## License
+
+Copyright (c) 2024 Solidus Contrib, released under the New BSD License.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/decorators/solidus_acts_as_tenant/store_credit_decorator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SolidusActsAsTenant::StoreCreditDecorator # rubocop:disable Style/ClassAndModuleChildren
+  # Fixes no method error related to validations added through acts_as_tenant
+  def payment_method_id
+    return if payment_method.nil?
+
+    super
+  end
+
+  ::Spree::StoreCredit.prepend(self)
+end

data/app/decorators/solidus_acts_as_tenant/variant_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusActsAsTenant::VariantDecorator # rubocop:disable Style/ClassAndModuleChildren
+  # Fixes errors related to validations added through acts_as_tenant
+
+  def product_shipping_category_id
+    return if product.nil?
+
+    super
+  end
+
+  def product_shipping_category
+    return if product.nil?
+
+    super
+  end
+
+  def product_tax_category_id
+    return if product.nil?
+
+    super
+  end
+
+  def product_tax_category
+    return if product.nil?
+
+    super
+  end
+
+  ::Spree::Variant.prepend(self)
+end

data/app/models/spree/products_taxon.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Spree
+  class ProductsTaxon < Spree::Base
+    acts_as_tenant :tenant
+    belongs_to :product
+    belongs_to :taxon
+  end
+end

data/app/models/spree/reimbursement_credit.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Spree
+  class ReimbursementCredit < Spree::Base
+    acts_as_tenant :tenant
+    belongs_to :reimbursement
+    belongs_to :creditable, polymorphic: true
+  end
+end

data/app/models/spree/tenant.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spree
+  class Tenant < Spree::Base
+    if SolidusActsAsTenant.config.class_name == 'Spree::Tenant'
+      validates :name, presence: true, uniqueness: true
+      validates :subdomain, uniqueness: true
+      validates :domain, uniqueness: true
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_acts_as_tenant"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_acts_as_tenant/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+set -e
+test -z "${DEBUG+empty_string}" || set -x
+
+test "$DB" = "sqlite" && export DB="sqlite3"
+
+if [ -z "$PAYMENT_METHOD" ]
+then
+  PAYMENT_METHOD="none"
+fi
+
+if [ -z "$SOLIDUS_BRANCH" ]
+then
+  echo "~~> Use 'export SOLIDUS_BRANCH=[main|v4.0|...]' to control the Solidus branch"
+  SOLIDUS_BRANCH="main"
+fi
+echo "~~> Using branch $SOLIDUS_BRANCH of solidus"
+
+extension_name="solidus_acts_as_tenant"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'
+      Bundler.with_unbundled_env {system *ARGV}' -- \
+        env BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES=true $@
+}
+
+echo "~~~> Removing the old sandbox"
+rm -rf ./sandbox
+
+echo "~~~> Creating a pristine Rails app"
+rails_version=`bundle exec ruby -e'require "rails"; puts Rails.version'`
+rails _${rails_version}_ new sandbox \
+  --database="${DB:-sqlite3}" \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-bootsnap \
+  --skip-test
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+echo "~~~> Adding solidus (with i18n) to the Gemfile"
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$SOLIDUS_BRANCH'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+gem 'solidus_auth_devise'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate solidus:install \
+  --auto-accept \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install --auto-run-migrations
+unbundled bundle exec rails generate ${extension_name}:install --auto-run-migrations
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🧪 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end