multi-tenant-support 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9834d4e3e978120e9a85d8da767d2079a34c416086557b84c4e54730819a1ffb
-  data.tar.gz: 41e2d934baa4668efc23bddb8d76dbb4a5b759ae4103f172c71b9406bc08c80d
+  metadata.gz: dce423fece46127c6f8f4f83f53b738524be0c7c84173d4aff9b02f51c077cae
+  data.tar.gz: d8e4328c0e0338831065b54bd38317c761af13a1b21025e2d98b14bcb20ac136
 SHA512:
-  metadata.gz: fc6ba9df8591e04abcc454981b15435261708ab23c39f54bcf9d321e362c8e631c5d74aa35c29a81030da7215b2e96e868acca238318f98a656ad38de37e6028
-  data.tar.gz: bdf08283a7363e65198a8de9d6ce1039886377d85870b7da13938cfe05c4d66d09c6281d743e6f9b6f8cd0792ae32cd218ea3513c9d21f8570318d74e797415e
+  metadata.gz: 46a70af78f3fb46731e8e5a989d3816d999eee75e17f13db11e111a18b7923549904621a787511455e6301234117d06a77a3df82f31c041c5f2930a7e39d1396
+  data.tar.gz: 18b80a4ca7dbbb0e24976d0748699abde53c7dfc00b370bcb2d44222c8b4c1990d6ad728073da5f08ffd7512f2d9bb67d1a1c369b0b717ad94e14c12f6bca26a

data/README.md

@@ -237,6 +237,12 @@ MultiTenantSupport.under_tenant amazon do
 end
 ```
 
+### Set current tenant global
+
+```ruby
+MultiTenantSupport::Current.tenant_account = account
+```
+
 ### Disallow read across tenant by default
 
 This gem disallow read across tenant by default. You can check current state through:
@@ -329,6 +335,44 @@ Console does not allow read across tenant by default. But you have several ways
     $ irb(main):001:0> MultiTenantSupport.allow_read_across_tenant
     ```
 
+## Testing
+### Minitest (Rails default)
+
+```ruby
+# test/test_helper.rb
+require 'multi_tenant_support/minitet'
+```
+### RSpec (with Capybara)
+
+```ruby
+# spec/rails_helper.rb or spec/spec_helper.rb
+require 'multi_tenant_support/rspec'
+```
+
+Above code will make sure the `MultiTenantSupport.current_tenant` won't accidentally be reset during integration and system tests. For example:
+
+With above testing requre code
+
+```ruby
+# Integration test
+test "a integration test" do
+  host! "apple.example.com"
+
+  assert_no_changes "MultiTenantSupport.current_tenant" do
+    get users_path
+  end
+end
+
+# System test
+test "a system test" do
+  Capybara.app_host = "http://apple.example.com"
+
+  assert_no_changes "MultiTenantSupport.current_tenant" do
+    visit users_path
+  end
+end
+```
+
 ## Code Example
 
 ### Database Schema

data/lib/multi_tenant_support/minitest.rb

@@ -0,0 +1,7 @@
+require_relative "./test/integration"
+require_relative "./test/system"
+require_relative "./test/capybara"
+
+ActionDispatch::IntegrationTest.prepend(MultiTenantSupport::Test::Integration)
+ActionDispatch::SystemTestCase.prepend(MultiTenantSupport::Test::System)
+Capybara::Node::Element.prepend(MultiTenantSupport::Test::Capybara)

data/lib/multi_tenant_support/rspec.rb

@@ -0,0 +1,13 @@
+require_relative "./test/integration"
+require_relative "./test/system"
+require_relative "./test/capybara"
+
+RSpec.configure do |config|
+  config.include MultiTenantSupport::Test::Integration, type: :request
+  config.include MultiTenantSupport::Test::Integration, type: :controller
+
+  config.include MultiTenantSupport::Test::System, type: :system
+  config.include MultiTenantSupport::Test::System, type: :feature
+end
+
+Capybara::Node::Element.prepend(MultiTenantSupport::Test::Capybara)

data/lib/multi_tenant_support/test/capybara.rb

@@ -0,0 +1,57 @@
+module MultiTenantSupport
+  module Test
+    module Capybara
+
+      def set(value, **options)
+        keep_context_tenant_unchange do
+          super(value, **options)
+        end
+      end
+
+      def select_option(wait: nil)
+        keep_context_tenant_unchange do
+          super(wait: wait)
+        end
+      end
+
+      def unselect_option(wait: nil)
+        keep_context_tenant_unchange do
+          super(wait: wait)
+        end
+      end
+
+      def perform_click_action(keys, wait: nil, **options)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def trigger(event)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def evaluate_script(script, *args)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def evaluate_async_script(script, *args)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end

data/lib/multi_tenant_support/test/integration.rb

@@ -0,0 +1,29 @@
+module MultiTenantSupport
+  module Test
+    module Integration
+
+      %i[get post patch put delete head options].each do |method|
+        define_method method do |path, **args|
+          keep_context_tenant_unchange do
+            super(path, **args)
+          end
+        end
+      end
+    
+      def follow_redirect(**args)
+        keep_context_tenant_unchange do
+          super(**args)
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end

data/lib/multi_tenant_support/test/system.rb

@@ -0,0 +1,38 @@
+module MultiTenantSupport
+  module Test
+    module System
+
+      %i[
+        visit refresh click_on go_back go_forward
+        check choose click_button click_link
+        fill_in uncheck check unselect select
+        execute_script evaluate_script
+      ].each do |method|
+        if RUBY_VERSION >= '2.7'
+          class_eval <<~METHOD, __FILE__, __LINE__ + 1
+            def #{method}(...)
+              keep_context_tenant_unchange do
+                super(...)
+              end
+            end
+          METHOD
+        else
+          define_method method do |*args, &block|
+            keep_context_tenant_unchange do
+              super(*args, &block)
+            end
+          end
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end

data/lib/multi_tenant_support/version.rb

@@ -1,3 +1,3 @@
 module MultiTenantSupport
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi-tenant-support
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,8 +51,13 @@ files:
 - lib/multi_tenant_support/current.rb
 - lib/multi_tenant_support/errors.rb
 - lib/multi_tenant_support/find_tenant_account.rb
+- lib/multi_tenant_support/minitest.rb
 - lib/multi_tenant_support/railtie.rb
+- lib/multi_tenant_support/rspec.rb
 - lib/multi_tenant_support/sidekiq.rb
+- lib/multi_tenant_support/test/capybara.rb
+- lib/multi_tenant_support/test/integration.rb
+- lib/multi_tenant_support/test/system.rb
 - lib/multi_tenant_support/version.rb
 - lib/tasks/multi_tenant_support_tasks.rake
 homepage: https://github.com/hoppergee/multi-tenant-support