multi-tenant-support 1.1.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7761ff1721fab8904557ae7af54aca1875d19fb6076bbe5038493c945009eec
-  data.tar.gz: 43df41f9e15014829828918d4703e77fe6f321bad2f10495e103860abe57cbbf
+  metadata.gz: d9a0f7c5067f07151a631c2b67b7b4ab6fb65da04f5b67c8020fec6d89ffe0f6
+  data.tar.gz: dbde15d968752339fbc72ec3aed925fa706863c88cdf5f06cb0036fda4c8679c
 SHA512:
-  metadata.gz: 7103aec88b69d628baed7e783495cc5e06b8fe49f5751d40aa5e676f2586aa7a0fcfe4d4f6015bfa4409017e533a3fff3a71b945d5426feb2ba5d7ba177f1ede
-  data.tar.gz: f2e5c63298eee511690622da0d0c47bf0fcdeb80aff543704da2a2a7a047165d5d6eebfda3d44862003329fcc739a3d8278d3ffb7616667087d540c7f9e49006
+  metadata.gz: 38e715d1ad5361a4db0cbb2b4b8cde6df8572a72186be05a54949649aad6460e69ef13e2080dbbbe678c64caeb6d7e71e7b9bafc86734266dabe957b947493ca
+  data.tar.gz: 3bf0ff4690f643d531b897d487e3ca519df588ea2e08cd7036d3ba65dbbad3e68f129c0c6596b92bf222833112ac59d1ba6eb2c042ac8db8e990fc0267656c67

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:
@@ -306,6 +312,67 @@ Currently, we don't have a good way to protect this method. So please use `upser
 
 This gem has override `unscoped` to prevent the default tenant scope be scoped out. But if you really want to scope out the default tenant scope, you can use `unscope_tenant`.
 
+### Console
+
+Console does not allow read across tenant by default. But you have several ways to change that:
+
+1. Set `allow_read_across_tenant_by_default` in the initialize file
+
+    ```ruby
+    console do |config|
+      config.allow_read_across_tenant_by_default = true
+    end
+    ```
+2. Set the environment variable `ALLOW_READ_ACROSS_TENANT` when call consoel command
+
+    ```bash
+    ALLOW_READ_ACROSS_TENANT=1 rails console
+    ```
+3. Manual change it in console
+
+    ```ruby
+    $ rails c
+    $ 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
@@ -340,6 +407,10 @@ MultiTenantSupport.configure do
     config.excluded_subdomains = ['www']
     config.host = 'example.com'
   end
+
+  console do |config|
+    config.allow_read_across_tenant_by_default = false
+  end
 end
 ```
 

data/lib/generators/multi_tenant_support/templates/initializer.rb.tt

@@ -12,6 +12,10 @@ MultiTenantSupport.configure do
     config.excluded_subdomains = ['www']
     config.host = 'REPLACE.ME'
   end
+
+  console do |config|
+    config.allow_read_across_tenant_by_default = false
+  end
 end
 
 # Uncomment if you are using sidekiq without ActiveJob

data/lib/multi-tenant-support.rb

@@ -4,6 +4,7 @@ require "multi_tenant_support/errors"
 require "multi_tenant_support/config/app"
 require "multi_tenant_support/config/controller"
 require "multi_tenant_support/config/model"
+require "multi_tenant_support/config/console"
 require "multi_tenant_support/current"
 require "multi_tenant_support/find_tenant_account"
 require "multi_tenant_support/concern/controller_concern"
@@ -33,6 +34,10 @@ module MultiTenantSupport
     end
   end
 
+  def allow_read_across_tenant?
+    !disallow_read_across_tenant?
+  end
+
   def disallow_read_across_tenant?
     !Current.allow_read_across_tenant
   end

data/lib/multi_tenant_support/active_job.rb

@@ -1,4 +1,5 @@
 module MultiTenantSupport
+
   module ActiveJob
     extend ActiveSupport::Concern
 
@@ -6,6 +7,40 @@ module MultiTenantSupport
       attr_accessor :current_tenant
     end
 
+    class_methods do
+
+      if Gem::Version.new(Rails.version) < Gem::Version.new("7.0.0.alpha1")
+        def perform_now(*args)
+          job = job_or_instantiate(*args)
+          job.current_tenant = MultiTenantSupport.current_tenant
+          job.perform_now
+        end
+      else
+        eval("
+          def perform_now(...)
+            job = job_or_instantiate(...)
+            job.current_tenant = MultiTenantSupport.current_tenant
+            job.perform_now
+          end
+        ")
+      end
+
+      def execute(job_data)
+        keep_current_tenant_unchange do
+          super(job_data)
+        end
+      end
+
+      private
+
+      def keep_current_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+    end
+
     def perform_now
       MultiTenantSupport.under_tenant(current_tenant) do
         super
@@ -43,6 +78,25 @@ module MultiTenantSupport
       tenant_klass.find tenant_id
     end
   end
+
+  module ConfiguredJob
+    if Gem::Version.new(Rails.version) < Gem::Version.new("7.0.0.alpha1")
+      def perform_now(*args)
+        job = @job_class.new(*args)
+        job.current_tenant = MultiTenantSupport.current_tenant
+        job.perform_now
+      end
+    else
+      eval("
+        def perform_now(...)
+          job = @job_class.new(...)
+          job.current_tenant = MultiTenantSupport.current_tenant
+          job.perform_now
+        end
+      ")
+    end
+  end
 end
 
-ActiveJob::Base.include(MultiTenantSupport::ActiveJob)
+ActiveJob::Base.include(MultiTenantSupport::ActiveJob)
+ActiveJob::ConfiguredJob.prepend(MultiTenantSupport::ConfiguredJob)

data/lib/multi_tenant_support/concern/controller_concern.rb

@@ -10,10 +10,6 @@ module MultiTenantSupport
 
       private
 
-      define_method(MultiTenantSupport.current_tenant_account_method) do
-        instance_variable_get("@#{MultiTenantSupport.current_tenant_account_method}")
-      end
-
       def set_current_tenant_account
         tenant_account = find_current_tenant_account
         MultiTenantSupport::Current.tenant_account = tenant_account
@@ -31,8 +27,12 @@ module MultiTenantSupport
   end
 
   module ViewHelper
-    define_method(MultiTenantSupport.current_tenant_account_method) do
-      instance_variable_get("@#{MultiTenantSupport.current_tenant_account_method}")
+    extend ActiveSupport::Concern
+
+    included do
+      define_method(MultiTenantSupport.current_tenant_account_method) do
+        instance_variable_get("@#{MultiTenantSupport.current_tenant_account_method}")
+      end
     end
   end
 end

data/lib/multi_tenant_support/config/console.rb

@@ -0,0 +1,21 @@
+module MultiTenantSupport
+
+  module Config
+    class Console
+      attr_writer :allow_read_across_tenant_by_default
+
+      def allow_read_across_tenant_by_default
+        @allow_read_across_tenant_by_default ||= false
+      end
+    end
+  end
+
+  module_function
+  def console
+    @console ||= Config::Console.new
+    return @console unless block_given?
+
+    yield @console
+  end
+
+end

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/railtie.rb

@@ -9,5 +9,13 @@ module MultiTenantSupport
       config.app_generators.templates.unshift(active_record_templates)
     end
 
+    console do
+      if ENV["ALLOW_READ_ACROSS_TENANT"] || MultiTenantSupport.console.allow_read_across_tenant_by_default
+        MultiTenantSupport.allow_read_across_tenant
+      else
+        MultiTenantSupport.disallow_read_across_tenant
+      end
+    end
+
   end
 end

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.1.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi-tenant-support
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,13 +45,19 @@ files:
 - lib/multi_tenant_support/concern/controller_concern.rb
 - lib/multi_tenant_support/concern/model_concern.rb
 - lib/multi_tenant_support/config/app.rb
+- lib/multi_tenant_support/config/console.rb
 - lib/multi_tenant_support/config/controller.rb
 - lib/multi_tenant_support/config/model.rb
 - 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