acts_as_tenant 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82765cfa1d00a63aa012f3ab5de9ddd60ae2c8041df405e08ae70ef20382d7ee
-  data.tar.gz: ba1920a299f84a4e6424304539c05ca69515e3b17e73ffb1b6635fbce79ae77c
+  metadata.gz: f5bed52bb9172b8035bbe0f9ac6d837acf6bfdf9f4bcec542556dddf3b3b3f5d
+  data.tar.gz: fe3c6219243da29201e4965c5906398e06df9e80a7e9de948bbe53b702804d8f
 SHA512:
-  metadata.gz: 62854b28ba5293d5437f5614032e992d914bc0741be3e8b925231116802d85b19d9631fc2e0ff2a7775e3259a998e4239f0b38c7ddf97c6817a0db96fbf488c5
-  data.tar.gz: 2e6c875895dd15882ffc4454f0c0bfae4fc3e77df17deae58710835e92bf32761247ab3b60cdfe9a83b81f72e2ea698c59f0155c046dfe2af5c62450a4bd65ca
+  metadata.gz: b5a499156656e313c113d2dddc9c922d49447bcecc2bb76a421c01fc8401a1a0501cb4515ac6323b48b71b046197da52dc3850634ba12435c44a6b95bb6724fc
+  data.tar.gz: c046fa7c06351158b437b83b61030abce8b7b95d0a453c9ee44b93a4518b50a6acfef59a00840a8624b6515a09979c12c2cc31783a959a412c21dad0f35d9ca3

data/README.md

@@ -137,6 +137,16 @@ end
 ```
 This is useful in shared routes such as admin panels or internal dashboards when `require_tenant` option is enabled throughout the app.
 
+### Allowing tenant updating for a block ###
+
+```ruby
+ActsAsTenant.with_mutable_tenant do
+  # Tenant updating is enabled for all code in this block
+end
+```
+
+This will allow you to change the tenant of a model. This feature is useful for admin screens, where it is ok to allow certain users to change the tenant on existing models in specific cases.
+
 ### Require tenant to be set always ###
 
 If you want to require the tenant to be set at all times, you can configure acts_as_tenant to raise an error when a query is made without a tenant available. See below under configuration options.

data/lib/acts_as_tenant/model_extensions.rb

@@ -5,11 +5,12 @@ module ActsAsTenant
     class_methods do
       def acts_as_tenant(tenant = :account, **options)
         ActsAsTenant.set_tenant_klass(tenant)
+        ActsAsTenant.mutable_tenant!(false)
 
         ActsAsTenant.add_global_record_model(self) if options[:has_global_records]
 
         # Create the association
-        valid_options = options.slice(:foreign_key, :class_name, :inverse_of, :optional, :primary_key, :counter_cache)
+        valid_options = options.slice(:foreign_key, :class_name, :inverse_of, :optional, :primary_key, :counter_cache, :polymorphic)
         fkey = valid_options[:foreign_key] || ActsAsTenant.fkey
         pkey = valid_options[:primary_key] || ActsAsTenant.pkey
         polymorphic_type = valid_options[:foreign_type] || ActsAsTenant.polymorphic_type
@@ -77,13 +78,13 @@ module ActsAsTenant
         to_include = Module.new {
           define_method "#{fkey}=" do |integer|
             write_attribute(fkey.to_s, integer)
-            raise ActsAsTenant::Errors::TenantIsImmutable if tenant_modified?
+            raise ActsAsTenant::Errors::TenantIsImmutable if !ActsAsTenant.mutable_tenant? && tenant_modified?
             integer
           end
 
           define_method "#{ActsAsTenant.tenant_klass}=" do |model|
             super(model)
-            raise ActsAsTenant::Errors::TenantIsImmutable if tenant_modified?
+            raise ActsAsTenant::Errors::TenantIsImmutable if !ActsAsTenant.mutable_tenant? && tenant_modified?
             model
           end
 
@@ -105,9 +106,9 @@ module ActsAsTenant
 
         fkey = reflect_on_association(ActsAsTenant.tenant_klass).foreign_key
 
-        validation_args = args.clone
+        validation_args = args.deep_dup
         validation_args[:scope] = if args[:scope]
-          Array(args[:scope]) << fkey
+          Array(args[:scope]) + [fkey]
         else
           fkey
         end

data/lib/acts_as_tenant/sidekiq.rb

@@ -1,6 +1,14 @@
 module ActsAsTenant::Sidekiq
+  class BaseMiddleware
+    def self.sidekiq_7_and_up?
+      Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7")
+    end
+  end
+
   # Get the current tenant and store in the message to be sent to Sidekiq.
-  class Client
+  class Client < BaseMiddleware
+    include Sidekiq::ClientMiddleware if sidekiq_7_and_up?
+
     def call(worker_class, msg, queue, redis_pool)
       if ActsAsTenant.current_tenant.present?
         msg["acts_as_tenant"] ||=
@@ -15,7 +23,9 @@ module ActsAsTenant::Sidekiq
   end
 
   # Pull the tenant out and run the current thread with it.
-  class Server
+  class Server < BaseMiddleware
+    include Sidekiq::ServerMiddleware if sidekiq_7_and_up?
+
     def call(worker_class, msg, queue)
       if msg.has_key?("acts_as_tenant")
         account = msg["acts_as_tenant"]["class"].constantize.find msg["acts_as_tenant"]["id"]

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/acts_as_tenant.rb

@@ -12,6 +12,7 @@ module ActsAsTenant
   @@configuration = nil
   @@tenant_klass = nil
   @@models_with_global_records = []
+  @@mutable_tenant = false
 
   class << self
     attr_writer :default_tenant
@@ -87,6 +88,14 @@ module ActsAsTenant
     @default_tenant unless unscoped
   end
 
+  def self.mutable_tenant!(toggle)
+    @@mutable_tenant = toggle
+  end
+
+  def self.mutable_tenant?
+    @@mutable_tenant
+  end
+
   def self.with_tenant(tenant, &block)
     if block.nil?
       raise ArgumentError, "block required"
@@ -120,6 +129,13 @@ module ActsAsTenant
     self.unscoped = old_unscoped
   end
 
+  def self.with_mutable_tenant(&block)
+    ActsAsTenant.mutable_tenant!(true)
+    without_tenant(&block)
+  ensure
+    ActsAsTenant.mutable_tenant!(false)
+  end
+
   def self.should_require_tenant?
     if configuration.require_tenant.respond_to?(:call)
       !!configuration.require_tenant.call

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Erwin Matthijssen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Add multi-tenancy to Rails applications using a shared db strategy