acts_as_tenant 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157bb94b2c59bdc0699a43f247141e44f4f8b9f41979186d678e996adfdbda2e
-  data.tar.gz: c4f559b0b12e8e92fc5025f9c926f437f01742cca85c91f4e3d306373a0e3492
+  metadata.gz: 0e1def42ea987db7d6104355979247c9e3c7294b91dadf937d8056d0e50ccbc7
+  data.tar.gz: 9d834dc2d3a9b67ac2bcff475cd355ca9a17a81bb957f99141df77de219a4b57
 SHA512:
-  metadata.gz: f843cea7abb50c0745b51e0850b93176c4a0713dcc875d62c733b4ff1df3b5cd7d9d2bf0b46de892af7009dfe106a3932d6698ed0132a2411466f43ecf243123
-  data.tar.gz: 1efe052c243a8fc2a7d857d559945f99646f237cb16c22dd6219ea4f94697f2ecd299384ca86bb57758cd37e7773186f2f75becb66998c5c00218ffa0a42f3fd
+  metadata.gz: c1291eb290dbe3c79dc9ff6ba4a3e302a3b3d9b65ef94f9f34d5155e0d73ec8554facc2b32bf80d2f813521121f59d64dc9961d313db271f3c0adcdb974ded36
+  data.tar.gz: '0596e6fc3b49ef6220b88d6fec0ecbf9e3b7396fb6cfecd894b5324447268268e46301548f59a873a4e10f86d7e345d4e9ad9b7babfe8cda96cce71f86eac38d'

data/README.md

@@ -35,7 +35,6 @@ Want to see how it works? Check out [the ActsAsTenant walkthrough video](https:/
 
 Installation
 ------------
-acts_as_tenant will only work on Rails 5.2 and up. This is due to changes made to the handling of `default_scope`, an essential pillar of the gem.
 
 To use it, add it to your Gemfile:
 
@@ -45,6 +44,7 @@ gem 'acts_as_tenant'
 
 Getting started
 ===============
+
 There are two steps in adding multi-tenancy to your app with acts_as_tenant:
 
 1. setting the current tenant and
@@ -52,6 +52,7 @@ There are two steps in adding multi-tenancy to your app with acts_as_tenant:
 
 Setting the current tenant
 --------------------------
+
 There are three ways to set the current tenant:
 
 1. by using the subdomain to lookup the current tenant,
@@ -59,6 +60,7 @@ There are three ways to set the current tenant:
 3. by setting the current tenant for a block.
 
 ### Looking Up Tenants
+
 #### By Subdomain to lookup the current tenant
 
 ```ruby
@@ -115,7 +117,7 @@ end
 
 This allows the tenant to be set before any other code runs so everything is within the current tenant.
 
-### Setting the current tenant for a block ###
+### Setting the current tenant for a block
 
 ```ruby
 ActsAsTenant.with_tenant(current_account) do
@@ -128,16 +130,17 @@ any code in this block will be scoped to the current tenant. All methods that se
 
 **Note:** If the current tenant is not set by one of these methods, Acts_as_tenant will be unable to apply the proper scope to your models. So make sure you use one of the two methods to tell acts_as_tenant about the current tenant.
 
-### Disabling tenant checking for a block ###
+### Disabling tenant checking for a block
 
 ```ruby
 ActsAsTenant.without_tenant do
   # Tenant checking is disabled for all code in this block
 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 ###
+### Allowing tenant updating for a block
 
 ```ruby
 ActsAsTenant.with_mutable_tenant do
@@ -147,7 +150,7 @@ 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 ###
+### 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.
 
@@ -194,7 +197,7 @@ Project.tasks.all #  => all tasks with account_id => 3
 
 Acts_as_tenant uses Rails' `default_scope` method to scope models. Rails 3.1 changed the way `default_scope` works in a good way. A user defined `default_scope` should integrate seamlessly with the one added by `acts_as_tenant`.
 
-### Validating attribute uniqueness ###
+### Validating attribute uniqueness
 
 If you need to validate for uniqueness, chances are that you want to scope this validation to a tenant. You can do so by using:
 
@@ -204,7 +207,7 @@ validates_uniqueness_to_tenant :name, :email
 
 All options available to Rails' own `validates_uniqueness_of` are also available to this method.
 
-### Custom foreign_key ###
+### Custom foreign_key
 
 You can explicitly specifiy a foreign_key for AaT to use should the key differ from the default:
 
@@ -212,7 +215,7 @@ You can explicitly specifiy a foreign_key for AaT to use should the key differ f
 acts_as_tenant(:account, :foreign_key => 'accountID') # by default AaT expects account_id
 ```
 
-### Custom primary_key ###
+### Custom primary_key
 
 You can also explicitly specifiy a primary_key for AaT to use should the key differ from the default:
 
@@ -220,8 +223,7 @@ You can also explicitly specifiy a primary_key for AaT to use should the key dif
 acts_as_tenant(:account, :primary_key => 'primaryID') # by default AaT expects id
 ```
 
-
-### Has and belongs to many ###
+### Has and belongs to many
 
 You can scope a model that is part of a HABTM relationship by using the `through` option.
 
@@ -244,12 +246,16 @@ end
 
 Configuration options
 ---------------------
+
 An initializer can be created to control (currently one) option in ActsAsTenant. Defaults
 are shown below with sample overrides following. In `config/initializers/acts_as_tenant.rb`:
 
 ```ruby
 ActsAsTenant.configure do |config|
   config.require_tenant = false # true
+
+  # Customize the query for loading the tenant in background jobs
+  config.job_scope = ->{ all }
 end
 ```
 
@@ -269,8 +275,34 @@ end
 
 `ActsAsTenant.should_require_tenant?` is used to determine if a tenant is required in the current context, either by evaluating the lambda provided, or by returning the boolean value assigned to `config.require_tenant`.
 
+When using `config.require_tenant` alongside the `rails console`, a nice quality of life tweak is to set the tenant in the console session in your initializer script. For example in `config/initializers/acts_as_tenant.rb`:
+
+```ruby
+SET_TENANT_PROC = lambda do
+  if defined?(Rails::Console)
+    puts "> ActsAsTenant.current_tenant = Account.first"
+    ActsAsTenant.current_tenant = Account.first
+  end
+end
+
+Rails.application.configure do
+  if Rails.env.development?
+    # Set the tenant to the first account in development on load
+    config.after_initialize do
+      SET_TENANT_PROC.call
+    end
+
+    # Reset the tenant after calling 'reload!' in the console
+    ActiveSupport::Reloader.to_complete do
+      SET_TENANT_PROC.call
+    end
+  end
+end
+```
+
 belongs_to options
----------------------
+------------------
+
 `acts_as_tenant :account` includes the belongs_to relationship.
 So when using acts_as_tenant on a model, do not add `belongs_to :account` alongside `acts_as_tenant :account`:
 
@@ -286,16 +318,22 @@ You can add the following `belongs_to` options to `acts_as_tenant`:
 
 Example: `acts_as_tenant(:account, counter_cache: true)`
 
-Sidekiq support
----------------
+Background Processing libraries
+-------------------------------
+
+ActsAsTenant supports
 
-ActsAsTenant supports [Sidekiq](http://sidekiq.org/). A background processing library.
-Add the following code to your `config/initializers/acts_as_tenant.rb`:
+- ActiveJob - ActsAsTenant will automatically save the current tenant in ActiveJob arguments and set it when the job runs.
+
+- [Sidekiq](//sidekiq.org/)
+Add the following code to `config/initializers/acts_as_tenant.rb`:
 
 ```ruby
 require 'acts_as_tenant/sidekiq'
 ```
 
+- DelayedJob - [acts_as_tenant-delayed_job](https://github.com/nunommc/acts_as_tenant-delayed_job)
+
 Testing
 ---------------
 
@@ -311,7 +349,6 @@ Rails.application.configure do
   config.middleware.use ActsAsTenant::TestTenantMiddleware
 end
 ```
-
 ```ruby
 # spec_helper.rb
 config.before(:suite) do |example|
@@ -335,9 +372,9 @@ config.after(:each) do |example|
   ActsAsTenant.test_tenant = nil
 end
 ```
-
 Bug reports & suggested improvements
 ------------------------------------
+
 If you have found a bug or want to suggest an improvement, please use our issue tracked at:
 
 [github.com/ErwinM/acts_as_tenant/issues](http://github.com/ErwinM/acts_as_tenant/issues)
@@ -357,10 +394,12 @@ We use the Appraisal gem to run tests against supported versions of Rails to tes
 
 Author & Credits
 ----------------
+
 acts_as_tenant is written by Erwin Matthijssen & Chris Oliver.
 
 This gem was inspired by Ryan Sonnek's [Multitenant](https://github.com/wireframe/multitenant) gem and its use of default_scope.
 
 License
 -------
+
 Copyright (c) 2011 Erwin Matthijssen, released under the MIT license

data/lib/acts_as_tenant/active_job_extensions.rb

@@ -0,0 +1,13 @@
+module ActsAsTenant
+  module ActiveJobExtensions
+    def serialize
+      super.merge("current_tenant" => ActsAsTenant.current_tenant&.to_global_id)
+    end
+
+    def deserialize(job_data)
+      tenant_global_id = job_data.delete("current_tenant")
+      ActsAsTenant.current_tenant = tenant_global_id ? GlobalID::Locator.locate(tenant_global_id) : nil
+      super
+    end
+  end
+end

data/lib/acts_as_tenant/configuration.rb

@@ -9,5 +9,23 @@ module ActsAsTenant
     def pkey
       @pkey ||= :id
     end
+
+    def job_scope
+      @job_scope || ->(relation) { relation.all }
+    end
+
+    # Used for looking job tenants in background jobs
+    #
+    # Format matches Rails scopes
+    #
+    #   job_scope = ->(relation) {}
+    #   job_scope = -> {}
+    def job_scope=(scope)
+      @job_scope = if scope && scope.arity == 0
+        proc { instance_exec(&scope) }
+      else
+        scope
+      end
+    end
   end
 end

data/lib/acts_as_tenant/model_extensions.rb

@@ -3,7 +3,7 @@ module ActsAsTenant
     extend ActiveSupport::Concern
 
     class_methods do
-      def acts_as_tenant(tenant = :account, **options)
+      def acts_as_tenant(tenant = :account, scope = nil, **options)
         ActsAsTenant.set_tenant_klass(tenant)
         ActsAsTenant.mutable_tenant!(false)
 
@@ -14,7 +14,7 @@ module ActsAsTenant
         fkey = valid_options[:foreign_key] || ActsAsTenant.fkey
         pkey = valid_options[:primary_key] || ActsAsTenant.pkey
         polymorphic_type = valid_options[:foreign_type] || ActsAsTenant.polymorphic_type
-        belongs_to tenant, **valid_options
+        belongs_to tenant, scope, **valid_options
 
         default_scope lambda {
           if ActsAsTenant.should_require_tenant? && ActsAsTenant.current_tenant.nil? && !ActsAsTenant.unscoped?
@@ -61,12 +61,16 @@ module ActsAsTenant
         reflect_on_all_associations(:belongs_to).each do |a|
           unless a == reflect_on_association(tenant) || polymorphic_foreign_keys.include?(a.foreign_key)
             validates_each a.foreign_key.to_sym do |record, attr, value|
+              next if value.nil?
+              next unless record.will_save_change_to_attribute?(attr)
+
               primary_key = if a.respond_to?(:active_record_primary_key)
                 a.active_record_primary_key
               else
                 a.primary_key
               end.to_sym
-              record.errors.add attr, "association is invalid [ActsAsTenant]" unless value.nil? || a.klass.where(primary_key => value).any?
+              scope = a.scope || ->(relation) { relation }
+              record.errors.add attr, "association is invalid [ActsAsTenant]" unless a.klass.class_eval(&scope).where(primary_key => value).any?
             end
           end
         end

data/lib/acts_as_tenant/sidekiq.rb

@@ -28,7 +28,9 @@ module ActsAsTenant::Sidekiq
 
     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"]
+        klass = msg["acts_as_tenant"]["class"].constantize
+        id = msg["acts_as_tenant"]["id"]
+        account = klass.class_eval(&ActsAsTenant.configuration.job_scope).find(id)
         ActsAsTenant.with_tenant account do
           yield
         end

data/lib/acts_as_tenant/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTenant
-  VERSION = "0.6.1"
+  VERSION = "1.0.0"
 end

data/lib/acts_as_tenant.rb

@@ -1,5 +1,4 @@
-require "request_store"
-
+require "active_support/current_attributes"
 require "acts_as_tenant/version"
 require "acts_as_tenant/errors"
 
@@ -8,12 +7,17 @@ module ActsAsTenant
   autoload :ControllerExtensions, "acts_as_tenant/controller_extensions"
   autoload :ModelExtensions, "acts_as_tenant/model_extensions"
   autoload :TenantHelper, "acts_as_tenant/tenant_helper"
+  autoload :ActiveJobExtensions, "acts_as_tenant/active_job_extensions"
 
   @@configuration = nil
   @@tenant_klass = nil
   @@models_with_global_records = []
   @@mutable_tenant = false
 
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :current_tenant, :acts_as_tenant_unscoped
+  end
+
   class << self
     attr_writer :default_tenant
   end
@@ -57,11 +61,11 @@ module ActsAsTenant
   end
 
   def self.current_tenant=(tenant)
-    RequestStore.store[:current_tenant] = tenant
+    Current.current_tenant = tenant
   end
 
   def self.current_tenant
-    RequestStore.store[:current_tenant] || test_tenant || default_tenant
+    Current.current_tenant || test_tenant || default_tenant
   end
 
   def self.test_tenant=(tenant)
@@ -73,11 +77,11 @@ module ActsAsTenant
   end
 
   def self.unscoped=(unscoped)
-    RequestStore.store[:acts_as_tenant_unscoped] = unscoped
+    Current.acts_as_tenant_unscoped = unscoped
   end
 
   def self.unscoped
-    RequestStore.store[:acts_as_tenant_unscoped]
+    Current.acts_as_tenant_unscoped
   end
 
   def self.unscoped?
@@ -157,3 +161,7 @@ end
 ActiveSupport.on_load(:action_view) do |base|
   base.include ActsAsTenant::TenantHelper
 end
+
+ActiveSupport.on_load(:active_job) do |base|
+  base.prepend ActsAsTenant::ActiveJobExtensions
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tenant
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Erwin Matthijssen
@@ -9,126 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: request_store
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.2
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 description: Integrates multi-tenancy into a Rails application in a convenient and
   out-of-your way manner
 email:
@@ -142,6 +38,7 @@ files:
 - README.md
 - Rakefile
 - lib/acts_as_tenant.rb
+- lib/acts_as_tenant/active_job_extensions.rb
 - lib/acts_as_tenant/configuration.rb
 - lib/acts_as_tenant/controller_extensions.rb
 - lib/acts_as_tenant/controller_extensions/filter.rb
@@ -171,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Add multi-tenancy to Rails applications using a shared db strategy