solidus_act_as_tenant 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21133e1e0cc428fdca8a7c70108361c008834111cf0a16ff76d513808adf01cc
+  data.tar.gz: 4766840233045195d2449ff960ba1ebb8bd92eb55ac804c44b79ef2c238ae802
+SHA512:
+  metadata.gz: 541ab0017f20b0bdf25268be074fb74882b10a74cd57361c6279a8eb7b7edf71bdd5a7277e7da707555967ec8b420df35c22f835618dc0d1422940f8a69d9353
+  data.tar.gz: 468b1a5c15e28faba9ab9f7a7da27b4047c463a42aea7e93fd4b7accfc604b12b2945a9cdfae5735d883dfba0e4646264bec4bbddced7609a26645c876bf3f5a

data/.circleci/config.yml

@@ -0,0 +1,62 @@
+version: 2.1
+
+orbs:
+  browser-tools: circleci/browser-tools@1.1
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-sqlite:
+    executor:
+      name: solidusio_extensions/sqlite
+      ruby_version: '3.1'
+    steps:
+      - browser-tools/install-chrome
+      - solidusio_extensions/run-tests
+  run-specs-with-postgres:
+    executor:
+      name: solidusio_extensions/postgres
+      ruby_version: '3.1'
+    steps:
+      - browser-tools/install-chrome
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor:
+      name: solidusio_extensions/mysql
+      ruby_version: '3.1'
+    steps:
+      - browser-tools/install-chrome
+      - solidusio_extensions/run-tests
+  lint-code:
+    executor:
+      name: solidusio_extensions/sqlite-memory
+      ruby_version: '3.1'
+    steps:
+      - solidusio_extensions/lint-code
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-sqlite:
+          context: acts_as_tenant
+      - run-specs-with-postgres:
+          context: acts_as_tenant
+      - run-specs-with-mysql:
+          context: acts_as_tenant
+      - lint-code:
+          context: acts_as_tenant
+
+  "Weekly run specs against main":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - run-specs-with-sqlite:
+          context: acts_as_tenant
+      - run-specs-with-postgres:
+          context: acts_as_tenant
+      - run-specs-with-mysql:
+          context: acts_as_tenant

data/.gem_release.yml

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

data/.github/stale.yml

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

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,5 @@
+require:
+  - solidus_dev_support/rubocop
+
+AllCops:
+  NewCops: disable

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,47 @@
+# 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
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV.fetch('DB', nil)
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3', '~> 1.4'
+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,100 @@
+# Solidus Act As Tenant
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/nebulab/solidus_acts_as_tenant/tree/Add-acts_as_tenant-to-Solidus.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/nebulab/solidus_acts_as_tenant/tree/Add-acts_as_tenant-to-Solidus)
+[![codecov](https://codecov.io/gh/solidusio-contrib/solidus_act_as_tenant/branch/main/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_act_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_act_as_tenant to your Gemfile:
+
+```ruby
+gem 'solidus_act_as_tenant'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bin/rails generate solidus_act_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 = SolidusActAsTenant::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(SolidusActAsTenant::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/spree/store_credit_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  module Spree
+    module StoreCreditDecorator
+      # Fixes no method error related to validations added through acts_as_tenant
+      def payment_method_id
+        super
+      rescue NoMethodError
+        nil
+      end
+
+      ::Spree::StoreCredit.prepend(self)
+    end
+  end
+end

data/app/decorators/spree/variant_decorator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  module Spree
+    module VariantDecorator
+      # Fixes no method error related to validations added through acts_as_tenant
+      def shipping_category_id
+        super
+      rescue NoMethodError
+        product && product_shipping_category_id
+      end
+
+      def shipping_category
+        super
+      rescue NoMethodError
+        product && product_shipping_category
+      end
+
+      ::Spree::Variant.prepend(self)
+    end
+  end
+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,9 @@
+# frozen_string_literal: true
+
+module Spree
+  class Tenant < Spree::Base
+    validates :name, presence: true, uniqueness: true
+    validates :subdomain, uniqueness: true
+    validates :domain, uniqueness: true
+  end
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_act_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_act_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,76 @@
+#!/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_act_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 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

data/db/migrate/20241204043609_add_tenant_id_to_solidus_tables.rb

@@ -0,0 +1,100 @@
+class AddTenantIdToSolidusTables < ActiveRecord::Migration[7.0]
+  # These are tables that don't need a tenancy but may be desired:
+  # spree_countries (also remove "iso" uniqueness index)
+  # spree_states
+  # spree_permission_sets
+  # spree_roles (also remove "name" uniqueness index)
+  # spree_role_permissions
+
+  TABLES = %w[
+    spree_addresses
+    spree_adjustments
+    spree_credit_cards
+    spree_payments
+    spree_refunds
+    spree_roles_users
+    spree_shipping_method_categories
+    spree_store_credit_types
+    spree_store_credits
+    spree_calculators
+    spree_users
+    spree_adjustment_reasons
+    spree_assets
+    spree_cartons
+    spree_customer_returns
+    spree_inventory_units
+    spree_line_item_actions
+    spree_line_items
+    spree_log_entries
+    spree_option_type_prototypes
+    spree_option_types
+    spree_option_values
+    spree_option_values_variants
+    spree_orders
+    spree_payment_capture_events
+    spree_payment_methods
+    spree_preferences
+    spree_prices
+    spree_product_option_types
+    spree_product_properties
+    spree_products
+    spree_products_taxons
+    spree_properties
+    spree_property_prototypes
+    spree_prototype_taxons
+    spree_prototypes
+    spree_refund_reasons
+    spree_reimbursement_credits
+    spree_reimbursement_types
+    spree_reimbursements
+    spree_return_authorizations
+    spree_return_items
+    spree_return_reasons
+    spree_shipments
+    spree_shipping_categories
+    spree_shipping_method_stock_locations
+    spree_shipping_method_zones
+    spree_shipping_methods
+    spree_shipping_rate_taxes
+    spree_shipping_rates
+    spree_state_changes
+    spree_stock_items
+    spree_stock_locations
+    spree_stock_movements
+    spree_store_credit_categories
+    spree_store_credit_events
+    spree_store_payment_methods
+    spree_stores
+    spree_store_shipping_methods
+    spree_store_credit_reasons
+    spree_tax_categories
+    spree_tax_rates
+    spree_taxonomies
+    spree_taxons
+    spree_tax_rate_tax_categories
+    spree_unit_cancels
+    spree_user_addresses
+    spree_user_stock_locations
+    spree_variant_property_rule_conditions
+    spree_variant_property_rule_values
+    spree_variant_property_rules
+    spree_variants
+    spree_wallet_payment_sources
+    spree_zone_members
+    spree_zones
+  ].push(::Spree.user_class.table_name).uniq.freeze
+
+  def up
+    TABLES.each do |table|
+      add_column table, :tenant_id, :bigint
+      add_index table, :tenant_id
+    end
+  end
+
+  def down
+    TABLES.each do |table|
+      remove_index table
+      remove_column table, :tenant_id
+    end
+  end
+end

data/db/migrate/20241204055845_update_spree_unique_indexes_with_tenant_scope.rb

@@ -0,0 +1,17 @@
+class UpdateSpreeUniqueIndexesWithTenantScope < ActiveRecord::Migration[7.0]
+  def up
+    remove_index :spree_preferences, name: :index_spree_preferences_on_key
+    remove_index :spree_products, name: :index_spree_products_on_slug
+
+    add_index :spree_preferences, %i[tenant_id key], unique: true, name: :index_spree_preferences_on_tenant_and_key
+    add_index :spree_products, %i[tenant_id slug], unique: true, name: :index_spree_products_on_tenant_and_slug
+  end
+
+  def down
+    remove_index :spree_preferences, name: :index_spree_preferences_on_tenant_and_key
+    remove_index :spree_products, name: :index_spree_products_on_tenant_and_slug
+
+    add_index :spree_preferences, :key, unique: true, name: :index_spree_preferences_on_key
+    add_index :spree_products, :slug, unique: true, name: :index_spree_products_on_slug
+  end
+end