multi-tenant-support 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a0f7c5067f07151a631c2b67b7b4ab6fb65da04f5b67c8020fec6d89ffe0f6
-  data.tar.gz: dbde15d968752339fbc72ec3aed925fa706863c88cdf5f06cb0036fda4c8679c
+  metadata.gz: 2780344bf11a6b5bb065ebed1848d5630ba8b414ab1d5ed9d08a019cf7751265
+  data.tar.gz: feb76616d756d524e8c871afdf331d6a754e522c2951e6c3cf15d6cdf2463093
 SHA512:
-  metadata.gz: 38e715d1ad5361a4db0cbb2b4b8cde6df8572a72186be05a54949649aad6460e69ef13e2080dbbbe678c64caeb6d7e71e7b9bafc86734266dabe957b947493ca
-  data.tar.gz: 3bf0ff4690f643d531b897d487e3ca519df588ea2e08cd7036d3ba65dbbad3e68f129c0c6596b92bf222833112ac59d1ba6eb2c042ac8db8e990fc0267656c67
+  metadata.gz: 9e70944d15ffe56a7503f3de425b7c99c7a3bd9bbf17d9caa97912b5bddd692636acb4960ab670aba64c8996d6f2a74ced4cda071ee0e07728928a39dc42c953
+  data.tar.gz: 3543fc05811590fa14559213a02fd1a71569bc98ba562f93e6530483ba1c09e8a28fcb06f5ce0c80c07eee398ccc2bfa4bcf00b9321ca6a51315247bef7ea09e

data/README.md

@@ -240,18 +240,49 @@ end
 ### Set current tenant global
 
 ```ruby
-MultiTenantSupport::Current.tenant_account = account
+MultiTenantSupport.set_tenant_account(account)
 ```
 
-### Disallow read across tenant by default
+### Temp set current tenant to nil
 
-This gem disallow read across tenant by default. You can check current state through:
+```ruby
+MultiTenantSupport.without_current_tenant do
+  # ...
+end
+```
+
+### 3 protection states
+
+1. `MultiTenantSupport.full_protected?`
+2. `MultiTenantSupport.allow_read_across_tenant?`
+3. `MultiTenantSupport.unprotected?`
+
+#### Full protection(default)
+
+The default state is full protection. This gem disallow modify record across tenant by default.
+
+If `MultiTenantSupport.current_tenant` exist, you can only modify those records under this tenant, otherwise, you will get some errors like:
+
+- `MultiTenantSupport::MissingTenantError`
+- `MultiTenantSupport::ImmutableTenantError`
+- `MultiTenantSupport::NilTenantError`
+- `MultiTenantSupport::InvalidTenantAccess`
+- `ActiveRecord::RecordNotFound`
+
+If `MultiTenantSupport.current_tenant` is missing, you cannot modify or create any tenanted records.
+
+If you switched to other state, you can switch back through:
 
 ```ruby
-MultiTenantSupport.disallow_read_across_tenant?
+MultiTenantSupport.turn_on_full_protection
+
+# Or
+MultiTenantSupport.turn_on_full_protection do
+  # ...
+end
 ```
 
-### Allow read across tenant for super admin
+#### Allow read across tenant for super admin
 
 You can turn on the permission to read records across tenant through: 
 
@@ -266,19 +297,18 @@ end
 
 You can put it in a before action in SuperAdmin's controllers
 
-### Disallow modify records tenant
+#### Turn off protection
 
-This gem disallow modify record across tenant no matter you are super admin or not.
+Sometimes, as a super admin, we need to execute certain maintenatn operations over all tenant records. You can do this through:
 
-If `MultiTenantSupport.current_tenant` exist, you can only modify those records under this tenant, otherwise, you will get some errors like:
-
-- `MultiTenantSupport::MissingTenantError`
-- `MultiTenantSupport::ImmutableTenantError`
-- `MultiTenantSupport::NilTenantError`
-- `MultiTenantSupport::InvalidTenantAccess`
-- `ActiveRecord::RecordNotFound`
+```ruby
+MultiTenantSupport.turn_off_protection
 
-If `MultiTenantSupport.current_tenant` is missing, you cannot modify or create any tenanted records.
+# Or
+MultiTenantSupport.turn_off_protection do
+  # ...
+end
+```
 
 ### Set current tenant acccount in controller by default
 

data/lib/multi-tenant-support.rb

@@ -26,39 +26,70 @@ module MultiTenantSupport
     Current.tenant_account&.send(model.tenant_account_primary_key)
   end
 
+  def set_current_tenant(tenant)
+    Current.tenant_account = tenant
+    Current.protection_state = PROTECTED
+  end
+
   def under_tenant(tenant_account, &block)
     raise ArgumentError, "block is missing" if block.nil?
 
-    Current.set(tenant_account: tenant_account) do
+    Current.set(tenant_account: tenant_account, protection_state: PROTECTED) do
+      yield
+    end
+  end
+
+  def without_current_tenant(&block)
+    raise ArgumentError, "block is missing" if block.nil?
+
+    Current.set(tenant_account: nil) do
       yield
     end
   end
 
+  def full_protected?
+    current_tenant || Current.protection_state == PROTECTED
+  end
+
   def allow_read_across_tenant?
-    !disallow_read_across_tenant?
+    current_tenant.nil? && [PROTECTED_EXCEPT_READ, UNPROTECTED].include?(Current.protection_state)
   end
 
-  def disallow_read_across_tenant?
-    !Current.allow_read_across_tenant
+  def unprotected?
+    current_tenant.nil? && Current.protection_state == UNPROTECTED
   end
 
-  def disallow_read_across_tenant
+  def turn_off_protection
+    raise 'Cannot turn off protection, try wrap in without_current_tenant' if current_tenant
+
     if block_given?
-      Current.set(allow_read_across_tenant: false) do
+      Current.set(protection_state: UNPROTECTED) do
         yield
       end
     else
-      Current.allow_read_across_tenant = false
+      Current.protection_state = UNPROTECTED
     end
   end
 
   def allow_read_across_tenant
+    raise 'Cannot read across tenant, try wrap in without_current_tenant' if current_tenant
+
+    if block_given?
+      Current.set(protection_state: PROTECTED_EXCEPT_READ) do
+        yield
+      end
+    else
+      Current.protection_state = PROTECTED_EXCEPT_READ
+    end
+  end
+
+  def turn_on_full_protection
     if block_given?
-      Current.set(allow_read_across_tenant: true) do
+      Current.set(protection_state: PROTECTED) do
         yield
       end
     else
-      Current.allow_read_across_tenant = true
+      Current.protection_state = PROTECTED
     end
   end
 

data/lib/multi_tenant_support/concern/controller_concern.rb

@@ -12,7 +12,7 @@ module MultiTenantSupport
 
       def set_current_tenant_account
         tenant_account = find_current_tenant_account
-        MultiTenantSupport::Current.tenant_account = tenant_account
+        MultiTenantSupport.set_current_tenant(tenant_account)
         instance_variable_set("@#{MultiTenantSupport.current_tenant_account_method}", tenant_account)
       end
 

data/lib/multi_tenant_support/concern/model_concern.rb

@@ -18,7 +18,7 @@ module MultiTenantSupport
 
       def set_default_scope_under_current_tenant(foreign_key)
         default_scope lambda {
-          if MultiTenantSupport.disallow_read_across_tenant? || MultiTenantSupport.current_tenant
+          if MultiTenantSupport.full_protected?
             scope_under_current_tenant
           else
             where(nil)
@@ -37,7 +37,7 @@ module MultiTenantSupport
 
         override_unscoped = Module.new {
           define_method :unscoped do |&block|
-            if MultiTenantSupport.disallow_read_across_tenant? || MultiTenantSupport.current_tenant
+            if MultiTenantSupport.full_protected?
               block ? relation.scope_under_current_tenant.scoping { block.call } : relation.scope_under_current_tenant
             else
               super(&block)
@@ -48,13 +48,13 @@ module MultiTenantSupport
 
         override_insert_all = Module.new {
           define_method :insert_all do |attributes, **arguments|
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
+            raise MissingTenantError unless MultiTenantSupport.unprotected? || MultiTenantSupport.current_tenant
 
             super(attributes, **arguments)
           end
 
           define_method :insert_all! do |attributes, **arguments|
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
+            raise MissingTenantError unless MultiTenantSupport.unprotected? || MultiTenantSupport.current_tenant
 
             super(attributes, **arguments)
           end
@@ -63,7 +63,7 @@ module MultiTenantSupport
 
         override_upsert_all = Module.new {
           define_method :upsert_all do |attributes, **arguments|
-            warn "[WARNING] You are using upsert_all(or upsert) which may update records across tenants"
+            warn "[WARNING] You are using upsert_all(or upsert) which may update records across tenants" unless MultiTenantSupport.unprotected?
 
             super(attributes, **arguments)
           end
@@ -71,13 +71,16 @@ module MultiTenantSupport
         extend override_upsert_all
 
         after_initialize do |object|
-          if MultiTenantSupport.disallow_read_across_tenant? || object.new_record?
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
-            raise InvalidTenantAccess if object.send(foreign_key) != MultiTenantSupport.current_tenant_id
-          end
+          next if object.new_record? && MultiTenantSupport.unprotected?
+          next if object.persisted? && MultiTenantSupport.allow_read_across_tenant?
+
+          raise MissingTenantError unless MultiTenantSupport.current_tenant
+          raise InvalidTenantAccess if object.send(foreign_key) != MultiTenantSupport.current_tenant_id
         end
 
         before_save do |object|
+          next if MultiTenantSupport.unprotected?
+
           raise MissingTenantError unless MultiTenantSupport.current_tenant
           raise NilTenantError if object.send(foreign_key).nil?
           raise InvalidTenantAccess if object.send(foreign_key) != MultiTenantSupport.current_tenant_id
@@ -85,28 +88,24 @@ module MultiTenantSupport
 
         override_update_columns_module = Module.new {
           define_method :update_columns do |attributes|
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
-            raise NilTenantError if send(foreign_key).nil?
-            raise InvalidTenantAccess if send(foreign_key) != MultiTenantSupport.current_tenant_id
+            unless MultiTenantSupport.unprotected?
+              raise MissingTenantError unless MultiTenantSupport.current_tenant
+              raise NilTenantError if send(foreign_key).nil?
+              raise InvalidTenantAccess if send(foreign_key) != MultiTenantSupport.current_tenant_id
+            end
 
             super(attributes)
           end
-
-          define_method :update_column do |name, value|
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
-            raise NilTenantError if send(foreign_key).nil?
-            raise InvalidTenantAccess if send(foreign_key) != MultiTenantSupport.current_tenant_id
-
-            super(name, value)
-          end
         }
 
         include override_update_columns_module
 
         override_delete = Module.new {
           define_method :delete do
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
-            raise InvalidTenantAccess if send(foreign_key) != MultiTenantSupport.current_tenant_id
+            unless MultiTenantSupport.unprotected?
+              raise MissingTenantError unless MultiTenantSupport.current_tenant
+              raise InvalidTenantAccess if send(foreign_key) != MultiTenantSupport.current_tenant_id
+            end
 
             super()
           end
@@ -115,7 +114,9 @@ module MultiTenantSupport
 
         override_delete_by = Module.new {
           define_method :delete_by do |*args|
-            raise MissingTenantError unless MultiTenantSupport.current_tenant
+            unless MultiTenantSupport.unprotected?
+              raise MissingTenantError unless MultiTenantSupport.current_tenant
+            end
 
             super(*args)
           end
@@ -123,8 +124,10 @@ module MultiTenantSupport
         extend override_delete_by
 
         before_destroy do |object|
-          raise MissingTenantError unless MultiTenantSupport.current_tenant
-          raise InvalidTenantAccess if object.send(foreign_key) != MultiTenantSupport.current_tenant_id
+          unless MultiTenantSupport.unprotected?
+            raise MissingTenantError unless MultiTenantSupport.current_tenant
+            raise InvalidTenantAccess if object.send(foreign_key) != MultiTenantSupport.current_tenant_id
+          end
         end
       end
 
@@ -132,9 +135,12 @@ module MultiTenantSupport
         readonly_tenant_module = Module.new {
 
           define_method "#{tenant_name}=" do |tenant|
+            return super(tenant_account) if MultiTenantSupport.unprotected?
+
             raise NilTenantError if tenant.nil?
             raise MissingTenantError unless MultiTenantSupport.current_tenant
 
+
             if new_record? && tenant == MultiTenantSupport.current_tenant
               super tenant
             else
@@ -143,6 +149,8 @@ module MultiTenantSupport
           end
 
           define_method "#{foreign_key}=" do |key|
+            return super(tenant_account) if MultiTenantSupport.unprotected?
+
             raise NilTenantError if key.nil?
             raise MissingTenantError unless MultiTenantSupport.current_tenant
 
@@ -170,9 +178,11 @@ ActiveSupport.on_load(:active_record) do |base|
 
   override_delete_all = Module.new {
     define_method :delete_all do
-      current_tenant_exist = MultiTenantSupport.current_tenant
-      is_global_model = !MultiTenantSupport.model.tenanted_models.include?(klass.name)
-      raise MultiTenantSupport::MissingTenantError unless current_tenant_exist || is_global_model
+      unless MultiTenantSupport.unprotected?
+        current_tenant_exist = MultiTenantSupport.current_tenant
+        is_global_model = !MultiTenantSupport.model.tenanted_models.include?(klass.name)
+        raise MultiTenantSupport::MissingTenantError unless current_tenant_exist || is_global_model
+      end
 
       super()
     end
@@ -181,9 +191,11 @@ ActiveSupport.on_load(:active_record) do |base|
 
   override_update_all = Module.new {
     define_method :update_all do |updates|
-      current_tenant_exist = MultiTenantSupport.current_tenant
-      is_global_model = !MultiTenantSupport.model.tenanted_models.include?(klass.name)
-      raise MultiTenantSupport::MissingTenantError unless current_tenant_exist || is_global_model
+      unless MultiTenantSupport.unprotected?
+        current_tenant_exist = MultiTenantSupport.current_tenant
+        is_global_model = !MultiTenantSupport.model.tenanted_models.include?(klass.name)
+        raise MultiTenantSupport::MissingTenantError unless current_tenant_exist || is_global_model
+      end
 
       super(updates)
     end

data/lib/multi_tenant_support/current.rb

@@ -1,8 +1,23 @@
 require 'active_support'
 
 module MultiTenantSupport
+
+  # Scoped and proteced
+  PROTECTED = 1
+
+  # Scoped and protected except read across tenant
+  PROTECTED_EXCEPT_READ = 2
+
+  # Scoped but unprotected
+  UNPROTECTED = 3
+
+  # This class is for internal usage only
   class Current < ActiveSupport::CurrentAttributes
     attribute :tenant_account,
-              :allow_read_across_tenant
+              :protection_state
+
+    def protection_state
+      attributes[:protection_state] ||= PROTECTED
+    end
   end
 end

data/lib/multi_tenant_support/railtie.rb

@@ -13,7 +13,7 @@ module MultiTenantSupport
       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
+        MultiTenantSupport.turn_on_full_protection
       end
     end
 

data/lib/multi_tenant_support/version.rb

@@ -1,3 +1,3 @@
 module MultiTenantSupport
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi-tenant-support
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails