solidus_act_as_tenant 0.0.2

data/db/migrate/20241204105318_create_spree_tenants.rb

@@ -0,0 +1,15 @@
+class CreateSpreeTenants < ActiveRecord::Migration[7.0]
+  def change
+    create_table :spree_tenants do |t|
+      t.string :name
+      t.string :subdomain # Only used if setting tenant by subdomain
+      t.string :domain # Only used if setting tenant by domain
+
+      t.timestamps
+    end
+
+    add_index :spree_tenants, :name, unique: true
+    add_index :spree_tenants, :subdomain, unique: true
+    add_index :spree_tenants, :domain, unique: true
+  end
+end

data/lib/generators/solidus_act_as_tenant/install/install_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path('templates', __dir__)
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_act_as_tenant.rb'
+      end
+
+      def copy_config
+        template 'tenant_aware_models.yml', 'config/tenant_aware_models.yml'
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_act_as_tenant'
+      end
+
+      def run_migrations
+        puts 'Remember to inspect and adapt the migration files before migrating!' # rubocop:disable Rails/Output
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(
+          ask('Would you like to run the migrations now? [Y/n]')
+        )
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_act_as_tenant/install/templates/initializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+SolidusActAsTenant.configure do |config|
+  # This configuration is used to dynamically prepend existing models with the acts_as_tenant concern.
+  # See the tenant_aware_classes.yml file for inormation on how to configure this file.
+  config.tenant_aware_models =
+    YAML.safe_load(ERB.new(File.read(Rails.root.join('config/tenant_aware_models.yml'))).result)
+end

data/lib/generators/solidus_act_as_tenant/install/templates/tenant_aware_models.yml

@@ -0,0 +1,95 @@
+# Any model that is already defined and has an a tenant_id column can be added to this list.
+# It is not restricted to the Solidus models so it can be used for any model that is inherited from a gem.
+
+# It is importnant to also note that any unique indexes on the database will need to replaced with a unique index on scoped to the tenant_id column.
+
+# Format:
+  # - [Class name, [uniqueness attributes to update with tenant scope]]
+  # The uniqueness attributes array are optional for cases where there is already a uniqueness validation on the model that are not scoped to the tenant_id column.
+
+# Notes regarding Solidus models:
+  # These are are classes that are created in this extention because they are not defined in Solidus:
+    # [Spree::ProductTaxon, []],
+    # [Spree::ReimbursementCredit, []],
+
+  # These are classes that don't need a tenancy but may be desired:
+    # [Spree::Country, []],
+    # [Spree::State, []],
+    # [Spree::PermissionSet, []],
+    # [Spree::Role, [:name]],
+    # [Spree::RolePermission, []],
+
+  # These are not needed at all as they are internal to Solidus (and may cause issues):
+    # [Spree::OrderMutex, []],
+
+
+---
+- [<%= ::Spree.user_class.to_s %>, [email]]
+- [Spree::Address, []]
+- [Spree::AdjustmentReason, [name, code]]
+- [Spree::Adjustment, []]
+- [Spree::Asset, []]
+- [Spree::Calculator, []]
+- [Spree::Carton, []]
+- [Spree::CreditCard, []]
+- [Spree::CustomerReturn, []]
+- [Spree::InventoryUnit, []]
+- [Spree::LineItemAction, []]
+- [Spree::LineItem, []]
+- [Spree::LogEntry, []]
+- [Spree::OptionType, [name]]
+- [Spree::OptionValue, [name]]
+- [Spree::OptionValuesVariant, []]
+- [Spree::Order, []]
+- [Spree::PaymentCaptureEvent, []]
+- [Spree::PaymentMethod, []]
+- [Spree::Payment, []]
+- [Spree::Preference, [key]]
+- [Spree::Price, []]
+- [Spree::ProductOptionType, []]
+- [Spree::ProductProperty, []]
+- [Spree::Product, [slug]]
+- [Spree::Property, []]
+- [Spree::RefundReason, [name]]
+- [Spree::Refund, []]
+- [Spree::ReimbursementType, [name]]
+- [Spree::Reimbursement, []]
+- [Spree::ReturnAuthorization, []]
+- [Spree::ReturnItem, []]
+- [Spree::ReturnReason, []]
+- [Spree::RoleUser, []]
+- [Spree::Shipment, []]
+- [Spree::ShippingCategory, []]
+- [Spree::ShippingMethodCategory, []]
+- [Spree::ShippingMethodStockLocation, []]
+- [Spree::ShippingMethodZone, []]
+- [Spree::ShippingMethod, []]
+- [Spree::ShippingRateTax, []]
+- [Spree::StateChange, []]
+- [Spree::ShippingRate, []]
+- [Spree::StockItem, []]
+- [Spree::StockLocation, [code]]
+- [Spree::StockMovement, []]
+- [Spree::StoreCreditCategory, []]
+- [Spree::StoreCreditEvent, []]
+- [Spree::StoreCreditType, []]
+- [Spree::StoreCredit, []]
+- [Spree::StorePaymentMethod, []]
+- [Spree::Store, [code]]
+- [Spree::StoreShippingMethod, []]
+- [Spree::StoreCreditReason, [name]]
+- [Spree::TaxCategory, [name]]
+- [Spree::Taxonomy, [name]]
+- [Spree::Taxon, []]
+- [Spree::TaxRate, []]
+- [Spree::TaxRateTaxCategory, []]
+- [Spree::UnitCancel, []]
+- [Spree::UserAddress, []]
+- [Spree::UserStockLocation, []]
+- [Spree::VariantPropertyRuleCondition, []]
+- [Spree::VariantPropertyRuleValue, []]
+- [Spree::VariantPropertyRule, []]
+- [Spree::Variant, [sku]]
+- [Spree::WalletPaymentSource, []]
+- [Spree::ZoneMember, []]
+- [Spree::Zone, [name]]

data/lib/solidus_act_as_tenant/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  class Configuration
+    attr_accessor :tenant_aware_models
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_act_as_tenant/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+module SolidusActAsTenant
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_act_as_tenant'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.after_initialize do
+      SolidusActAsTenant::TenantAware.setup_tenant_aware_models
+    end
+  end
+end

data/lib/solidus_act_as_tenant/factories/preference_factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :preference, class: Spree::Preference do
+    sequence(:key) { |i| "Key#{i}" }
+  end
+end

data/lib/solidus_act_as_tenant/factories/tenant_factory.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :tenant, class: Spree::Tenant do
+    sequence(:name) { |i| "Demo #{i}" }
+    sequence(:subdomain) { |i| "demo-#{i}" }
+    sequence(:domain) { |i| "demo-#{i}.com" }
+  end
+end

data/lib/solidus_act_as_tenant/tenant_aware.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  # TenantAware automatically adds multi-tenant support to models
+  # by adding tenant scoping and updating uniqueness validations to be tenant-aware.
+  module TenantAware
+    class << self
+      def setup_tenant_aware_models
+        tenant_aware_models = SolidusActAsTenant.config.tenant_aware_models || []
+
+        tenant_aware_models.each do |klass, validator_attributes|
+          Module.new do
+            @validator_attributes = validator_attributes
+            define_singleton_method(:prepended) do |base|
+              base.acts_as_tenant :tenant, class_name: 'Spree::Tenant'
+
+              @validator_attributes&.each do |attribute|
+                TenantAware.update_uniqueness_validation(base, attribute)
+              end
+            end
+
+            klass.constantize.prepend(self)
+          end
+        end
+      end
+
+      def update_uniqueness_validation(base, attribute)
+        attribute = attribute.to_sym
+        validator = base._validators[attribute].find { _1.kind == :uniqueness }
+        raise "No uniqueness validator found for #{attribute} on #{base}" unless validator
+
+        new_options = validator.options.dup
+        new_options[:scope] = Array(new_options[:scope]).push(:tenant_id)
+
+        remove_existing_validation(base, attribute)
+        base.validates_uniqueness_of attribute, **new_options
+      end
+
+      def remove_existing_validation(base, attribute)
+        base._validators[attribute].reject! { _1.kind == :uniqueness }
+        base._validate_callbacks.each do |callback|
+          next unless callback.filter.try(:attributes)&.include?(attribute) &&
+                      callback.filter.kind == :uniqueness
+
+          callback.filter.attributes.delete(attribute)
+        end
+      end
+    end
+  end
+end

data/lib/solidus_act_as_tenant/testing_support/factories.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/../factories/**"].each do |f|
+  require File.expand_path(f)
+end

data/lib/solidus_act_as_tenant/utils/tenant_selector.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  module Utils
+    class TenantSelector
+      MESSAGES = {
+        available: "Available tenants: %<tenants>s",
+        prompt: "Select tenant: ",
+        not_found: "Tenant not found in list '%<tenants>s'",
+        current: "You are now Tenant '%<name>s'"
+      }.freeze
+
+      def ask
+        return if tenants.empty?
+
+        puts format(MESSAGES[:available], tenants: tenants) # rubocop:disable Rails/Output
+        print MESSAGES[:prompt] # rubocop:disable Rails/Output
+
+        tenant_name = ENV["DEFAULT_TENANT"] || gets.strip
+        switch_tenant!(tenant_name) unless tenant_name.empty?
+      end
+
+      def tenants
+        @tenants ||= fetch_tenants
+      end
+
+      def switch_tenant!(tenant_name)
+        if exists?(tenant_name)
+          switch(tenant_name)
+        elsif numeric_tenant?(tenant_name)
+          switch(tenants[tenant_name.to_i])
+        else
+          puts format(MESSAGES[:not_found], tenants: tenants) # rubocop:disable Rails/Output
+          return false
+        end
+
+        puts format(MESSAGES[:current], name: current) # rubocop:disable Rails/Output
+        true
+      end
+
+      def current
+        ActsAsTenant.current_tenant&.name
+      end
+
+      private
+
+      def fetch_tenants
+        [*tenant_names].uniq
+                       .each_with_index
+                       .to_h { |name, index| [index, name] }
+      end
+
+      def tenant_names
+        @tenant_names ||= ::Spree::Tenant.pluck(:name).sort
+      end
+
+      def switch(tenant_name)
+        return false unless tenants.value?(tenant_name)
+
+        tenant = ::Spree::Tenant.find_by(name: tenant_name)
+        ActsAsTenant.current_tenant = tenant
+        true
+      end
+
+      def exists?(tenant_name)
+        tenant_names.include?(tenant_name)
+      end
+
+      def numeric_tenant?(tenant_name)
+        tenant_name =~ /^\d+$/ && tenants.key?(tenant_name.to_i)
+      end
+    end
+  end
+end

data/lib/solidus_act_as_tenant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusActAsTenant
+  VERSION = '0.0.2'
+end

data/lib/solidus_act_as_tenant.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'acts_as_tenant'
+require 'solidus_act_as_tenant/tenant_aware'
+require 'solidus_act_as_tenant/utils/tenant_selector'
+require 'solidus_act_as_tenant/configuration'
+require 'solidus_act_as_tenant/version'
+require 'solidus_act_as_tenant/engine'

data/solidus_act_as_tenant.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_act_as_tenant/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_act_as_tenant'
+  spec.version = SolidusActAsTenant::VERSION
+  spec.authors = ['Ikraam Ghoor']
+  spec.email = 'consult.ikraam@gmail.com'
+
+  spec.summary = 'Adds tenant functionality to solidus using the row level acts_as_tenant gem'
+  spec.description = 'Adds tenant functionality to solidus using the row level acts_as_tenant gem'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_act_as_tenant#readme'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_act_as_tenant'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_act_as_tenant/blob/main/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 4')
+
+  # 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.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'acts_as_tenant', '~> 1.0.1'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 5']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.9'
+end

data/spec/lib/solidus_act_as_tenant/tenant_aware_spec.rb

@@ -0,0 +1,48 @@
+describe SolidusActAsTenant::TenantAware do
+  describe '#setup_tenant_aware_models' do
+    let!(:tenant) { Spree::Tenant.find_or_create_by!(name: 'Test') }
+    let!(:tenant2) { create(:tenant, name: 'Test2') }
+
+    SolidusActAsTenant.config.tenant_aware_models.each do |klass, validator_attributes|
+      describe "for #{klass}" do
+        it 'has a tenant accessor and the current tenant is already set', set_tenant: true do
+          expect(klass.constantize.new.tenant).to eq tenant
+        end
+
+        validator_attributes.each do |attribute|
+          it "validates uniqueness of #{attribute}", set_tenant: true do
+            entry = create(klass.demodulize.underscore.downcase.to_sym, attribute => 'test@test.com')
+            duplicate = entry.dup
+
+            if klass == 'Spree::Product'
+              duplicate.master = entry.master
+              duplicate.slug = entry.slug
+            end
+
+            duplicate.valid?
+
+            expect(duplicate.errors[attribute]).to include('has already been taken')
+          end
+
+          it 'allows duplicate values across different tenants' do
+            ::ActsAsTenant.current_tenant = tenant
+            entry = create(klass.demodulize.underscore.downcase.to_sym, attribute => 'test@test.com',
+              tenant: tenant)
+            duplicate = entry.dup
+
+            if klass == 'Spree::Product'
+              duplicate.master = entry.master
+              duplicate.slug = entry.slug
+            end
+
+            ::ActsAsTenant.current_tenant = tenant2
+            duplicate.tenant = tenant2
+            duplicate.valid?
+
+            expect(duplicate.errors[attribute]).to be_empty
+          end
+        end
+      end
+    end
+  end
+end

data/spec/models/spree/store_credit_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+describe Spree::StoreCredit, set_tenant: true do
+  describe '#shipping_category' do
+    let(:store_credit) { described_class.new }
+
+    it 'does not raise an error when #payment_method_id is called' do
+      expect { store_credit.payment_method_id }.not_to raise_error
+    end
+
+    it 'returns nil for #payment_method_id' do
+      expect(store_credit.payment_method_id).to be_nil
+    end
+  end
+end

data/spec/models/spree/variant_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+describe Spree::Variant, set_tenant: true do
+  describe '#shipping_category' do
+    let(:variant) { described_class.new }
+    let(:shipping_category) { create(:shipping_category) }
+    let(:product) { create(:product, shipping_category: shipping_category) }
+
+    it 'returns nil for shipping_category when not set' do
+      expect(variant.shipping_category).to be_nil
+    end
+
+    it 'returns nil for shipping_category_id when not set' do
+      expect(variant.shipping_category_id).to be_nil
+    end
+
+    it 'returns the product shipping category when the variant shipping category is nil' do
+      variant.product = product
+      expect(variant.shipping_category).to eq(product.shipping_category)
+    end
+
+    it 'returns the product shipping category id when the variant shipping category is nil' do
+      variant.product = product
+      expect(variant.shipping_category_id).to eq(product.shipping_category_id)
+    end
+
+    it 'returns the correct shipping category id when the variant shipping category is set' do
+      variant.shipping_category = shipping_category
+      expect(variant.shipping_category_id).to eq(shipping_category.id)
+    end
+
+    it 'returns the correct shipping category when the variant shipping category is set' do
+      variant.shipping_category = shipping_category
+      expect(variant.shipping_category).to eq(shipping_category)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+# Create the dummy app if it's still missing.
+dummy_env = "#{__dir__}/dummy/config/environment.rb"
+system 'bin/rake extension:test_app' unless File.exist? dummy_env
+require dummy_env
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
+
+# Requires factories defined in Solidus core and this extension.
+# See: lib/solidus_act_as_tenant/testing_support/factories.rb
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusActAsTenant::Engine)
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+
+  if Spree.solidus_gem_version < Gem::Version.new('2.11')
+    config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :system
+  end
+end

data/spec/support/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+RSpec.configure do |config|
+  config.before(:each, set_tenant: true) do
+    unless ::ActsAsTenant.current_tenant
+      ::ActsAsTenant.current_tenant = Spree::Tenant.find_or_create_by!(name: 'Test')
+    end
+  end
+
+  config.before(:suite, set_tenant: true) do
+    unless ::ActsAsTenant.current_tenant
+      ::ActsAsTenant.current_tenant = Spree::Tenant.find_or_create_by!(name: 'Test')
+    end
+  end
+
+  config.after do
+    ::ActsAsTenant.current_tenant = nil
+  end
+end