rails_multitenant 0.11.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c9936e0904797c7af7fb67e3a08102b5d4388be
-  data.tar.gz: 5ba8bb69723b5d3b83007d6b5ad2148aa9769a50
+SHA256:
+  metadata.gz: ab1547ea14417be1bbde8797d064b3c16e108ad698907e5ee5632ebd5d22468e
+  data.tar.gz: 6d03ee228b67715d3cd648e2ad9bf4396b68a2741f23941e560eac2000f1677e
 SHA512:
-  metadata.gz: c1affba9e932ba4ffd61a034382a05fcc7027701137bafd215345451173ec5d92ef087366acf101db4e8fa48220f33c1b4649b33cb1b57c77c05b99db2de5bda
-  data.tar.gz: d7e99b00fe2ef9bd7070b7074a0ea09e6a7a35a70554f62b095843318086da92a231543530132c95f316b913d01a3f71d062aa22b2d9cb2f3ee116188480e6be
+  metadata.gz: 30b2913470e4964030da8ce6c3a5d66a9ac9146aa9779f99ec65cf6c3a4fd2762b463e5ba21c43ab50a77e6b1f55eb90130638a3ba173ff052bee50f5cce92a2
+  data.tar.gz: ba249595b87ae32db7d8493277a69c54c2670dbbb10c2d5f2107176fdc9e54a09b177eb65c1b6eee28f48de7e5232aefafedcb8ae58b312c6b25857c94490490

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Salsify, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/rails_multitenant.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'active_support/all'
 require 'active_record'
 
-require "rails_multitenant/global_context_registry"
-require "rails_multitenant/multitenant_model"
+require 'rails_multitenant/global_context_registry'
+require 'rails_multitenant/multitenant_model'
 
-require "rails_multitenant/middleware/extensions"
+require 'rails_multitenant/middleware/extensions'
 
 module RailsMultitenant
   extend self
 
-  delegate :get, :[], :fetch, :set, :[]=, :delete, :with_isolated_registry, to: :GlobalContextRegistry
+  delegate :get, :[], :fetch, :set, :[]=, :delete, :with_isolated_registry, :merge!, :with_merged_registry,
+           to: :GlobalContextRegistry
 end
 
 # rails_multitenant/rspec has to be explicitly included by clients who want to use it

data/lib/rails_multitenant/global_context_registry.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'global_context_registry/current'
+require_relative 'global_context_registry/current_instance'
+require_relative 'global_context_registry/registry_dependent_on'
+
 # Handles storing of global state that may be swapped out or unset at
 # various points. We use this in dandelion to store the current user,
 # org, catalog, etc.
@@ -6,204 +12,8 @@
 #
 module RailsMultitenant
   module GlobalContextRegistry
-
     extend self
 
-    module RegistryDependentOn
-
-      # Is this class dependent on changes in another GlobalContextRegistry-
-      # stored object? Register that dependency here.
-      def global_context_dependent_on(*klasses)
-        klasses.each { |klass| GlobalContextRegistry.send(:add_dependency, klass, self) }
-      end
-    end
-
-    # This module allows your to have a current, thread-local instance
-    # of this class. It currently assumes your class has a zero-arg
-    # constructor.
-    module Current
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :default_provider, instance_writer: false
-      end
-
-      module ClassMethods
-        def current
-          GlobalContextRegistry.fetch(current_registry_obj) { __current_default }
-        end
-
-        def current=(object)
-          raise "#{object} is not a #{self}" if object.present? && !object.is_a?(self)
-          GlobalContextRegistry.set(current_registry_obj, object)
-          __clear_dependents!
-        end
-
-        def current?
-          GlobalContextRegistry.get(current_registry_obj).present?
-        end
-
-        def current!
-          current || raise("No current #{name} set")
-        end
-
-        def clear_current!
-          GlobalContextRegistry.delete(current_registry_obj)
-        end
-
-        def as_current(object)
-          old_object = current if current?
-          self.current = object
-          yield
-        ensure
-          self.current = old_object
-        end
-
-        include RegistryDependentOn
-
-        def provide_default(provider = nil, &block)
-          self.default_provider = provider ? provider.to_proc : block
-        end
-
-        private
-
-        def current_registry_obj
-          return @current_registry_obj if @current_registry_obj
-
-          @current_registry_obj = "#{__key_class.name.underscore}_obj".to_sym
-        end
-
-        def current_registry_default_provider
-          "#{__key_class.name.underscore}_default_provider".to_sym
-        end
-
-        def __current_default
-          if self.default_provider
-            default = self.default_provider.call(self)
-            raise "#{default} is not a #{self}" if default.present? && !default.is_a?(self)
-            default
-          end
-        end
-
-        def __clear_dependents!
-          GlobalContextRegistry.send(:dependencies_for, __key_class).each(&:clear_current!)
-        end
-
-        def __key_class
-          respond_to?(:base_class) ? base_class : self
-        end
-      end
-
-      def as_current
-        old_object = self.class.current if self.class.current?
-        self.class.current = self
-        yield
-      ensure
-        self.class.current = old_object
-      end
-
-      def current?
-        self.class.current? && self.equal?(self.class.current)
-      end
-
-    end
-
-    # This module allows you to have a current, thread-local instance
-    # of a class. This module assumes that you are mixing into a Rails
-    # model, and separately stores and id in thread local storage for
-    # lazy loading.
-    module CurrentInstance
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        def current_id=(id)
-          GlobalContextRegistry.delete(current_instance_registry_obj)
-          GlobalContextRegistry.set(current_instance_registry_id, id)
-          __clear_dependents!
-        end
-
-        def current=(object)
-          raise "#{object} is not a #{self}" if object.present? && !object.is_a?(self)
-          GlobalContextRegistry.set(current_instance_registry_obj, object)
-          GlobalContextRegistry.set(current_instance_registry_id, object.try(:id))
-          __clear_dependents!
-        end
-
-        def current_id
-          GlobalContextRegistry.get(current_instance_registry_id)
-        end
-
-        def current
-          GlobalContextRegistry.fetch(current_instance_registry_obj) do
-            (current_id ? find(current_id) : nil)
-          end
-        end
-
-        def current?
-          !!current
-        end
-
-        def current!
-          current || raise("No current #{name} set")
-        end
-
-        def as_current_id(id)
-          old_id = current_id
-          self.current_id = id
-          yield
-        ensure
-          self.current_id = old_id
-        end
-
-        def as_current(model)
-          old_model = current
-          self.current = model
-          yield
-        ensure
-          self.current = old_model
-        end
-
-        def clear_current!
-          GlobalContextRegistry.delete(current_instance_registry_obj)
-        end
-
-        private
-
-        def __clear_dependents!
-          key_class = respond_to?(:base_class) ? base_class : self
-          GlobalContextRegistry.send(:dependencies_for, key_class).each(&:clear_current!)
-        end
-
-        def current_instance_registry_id
-          return @current_instance_registry_id if @current_instance_registry_id
-
-          key_class = respond_to?(:base_class) ? base_class : self
-          @current_instance_registry_id = "#{key_class.name.underscore}_id".to_sym
-        end
-
-        def current_instance_registry_obj
-          return @current_instance_registry_obj if @current_instance_registry_obj
-
-          key_class = respond_to?(:base_class) ? base_class : self
-          @current_instance_registry_obj = "#{key_class.name.underscore}_obj".to_sym
-        end
-        include RegistryDependentOn
-      end
-
-      def as_current
-        old_id = self.class.current_id
-        self.class.current = self
-        yield
-      ensure
-        self.class.current_id = old_id
-      end
-
-      def current?
-        id == self.class.current_id
-      end
-
-    end
-
     # Set this global
     def set(symbol, value)
       globals[symbol] = value
@@ -231,10 +41,15 @@ module RailsMultitenant
     end
     alias_method :[], :get
 
+    # merge the given values into the registry
+    def merge!(values)
+      globals.merge!(values)
+    end
+
     # Duplicate the registry
     def duplicate_registry
       globals.each_with_object({}) do |(key, value), result|
-        result[key] = (value.nil? || value.is_a?(Integer)) ? value : value.dup
+        result[key] = value.nil? || value.is_a?(Integer) ? value : value.dup
       end
     end
 
@@ -246,6 +61,14 @@ module RailsMultitenant
       self.globals = prior_globals
     end
 
+    # Run a block of code with the given values merged into the current registry
+    def with_merged_registry(values = {})
+      prior_globals = new_registry(globals.merge(values))
+      yield
+    ensure
+      self.globals = prior_globals
+    end
+
     # Prefer .with_isolated_registry to the following two methods.
     # Note: these methods are intended for use in a manner like .with_isolated_registry,
     # but in contexts where around semantics are not allowed.
@@ -262,6 +85,29 @@ module RailsMultitenant
       self.globals = registry
     end
 
+    # Run a block of code that disregards scoping during read queries
+    def with_unscoped_queries
+      with_merged_registry(__use_unscoped_queries: true) do
+        yield
+      end
+    end
+
+    def use_unscoped_queries?
+      self[:__use_unscoped_queries] == true
+    end
+
+    # Prefer .with_unscoped_queries to the following two methods.
+    # Note: these methods are intended for use in a manner like .with_admin_registry,
+    # but in contexts where around semantics are not allowed.
+
+    def disable_scoped_queries
+      self[:__use_unscoped_queries] = true
+    end
+
+    def enable_scoped_queries
+      self[:__use_unscoped_queries] = nil
+    end
+
     private
 
     @dependencies = {}
@@ -285,7 +131,6 @@ module RailsMultitenant
 
     def globals=(value)
       Thread.current[:global_context_registry] = value
-      value
     end
   end
 end

data/lib/rails_multitenant/global_context_registry/current.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative 'registry_dependent_on'
+
+module RailsMultitenant
+  module GlobalContextRegistry
+    # This module allows your to have a current, thread-local instance
+    # of this class. It currently assumes your class has a zero-arg
+    # constructor.
+    module Current
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :default_provider, instance_writer: false
+      end
+
+      module ClassMethods
+        def current
+          GlobalContextRegistry.fetch(current_registry_obj) { __current_default }
+        end
+
+        def current=(object)
+          raise "#{object} is not a #{self}" if object.present? && !object.is_a?(self)
+
+          GlobalContextRegistry.set(current_registry_obj, object)
+          __clear_dependents!
+        end
+
+        def current?
+          GlobalContextRegistry.get(current_registry_obj).present?
+        end
+
+        def current!
+          current || raise("No current #{name} set")
+        end
+
+        def clear_current!
+          GlobalContextRegistry.delete(current_registry_obj)
+        end
+
+        def as_current(object)
+          old_object = current if current?
+          self.current = object
+          yield
+        ensure
+          self.current = old_object
+        end
+
+        include RegistryDependentOn
+
+        def provide_default(provider = nil, &block)
+          self.default_provider = provider ? provider.to_proc : block
+        end
+
+        private
+
+        def current_registry_obj
+          return @current_registry_obj if @current_registry_obj
+
+          @current_registry_obj = "#{__key_class.name.underscore}_obj".to_sym
+        end
+
+        def current_registry_default_provider
+          "#{__key_class.name.underscore}_default_provider".to_sym
+        end
+
+        def __current_default
+          if default_provider
+            default = default_provider.call(self)
+            raise "#{default} is not a #{self}" if default.present? && !default.is_a?(self)
+
+            default
+          end
+        end
+
+        def __clear_dependents!
+          GlobalContextRegistry.send(:dependencies_for, __key_class).each(&:clear_current!)
+        end
+
+        def __key_class
+          respond_to?(:base_class) ? base_class : self
+        end
+      end
+
+      def as_current
+        old_object = self.class.current if self.class.current?
+        self.class.current = self
+        yield
+      ensure
+        self.class.current = old_object
+      end
+
+      def current?
+        self.class.current? && equal?(self.class.current)
+      end
+    end
+  end
+end

data/lib/rails_multitenant/global_context_registry/current_instance.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative 'registry_dependent_on'
+
+module RailsMultitenant
+  module GlobalContextRegistry
+    # This module allows you to have a current, thread-local instance
+    # of a class. This module assumes that you are mixing into a Rails
+    # model, and separately stores and id in thread local storage for
+    # lazy loading.
+    module CurrentInstance
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def current_id=(id)
+          GlobalContextRegistry.delete(current_instance_registry_obj)
+          GlobalContextRegistry.set(current_instance_registry_id, id)
+          __clear_dependents!
+        end
+
+        def current=(object)
+          raise "#{object} is not a #{self}" if object.present? && !object.is_a?(self)
+
+          GlobalContextRegistry.set(current_instance_registry_obj, object)
+          GlobalContextRegistry.set(current_instance_registry_id, object.try(:id))
+          __clear_dependents!
+        end
+
+        def current_id
+          GlobalContextRegistry.get(current_instance_registry_id)
+        end
+
+        def current
+          GlobalContextRegistry.fetch(current_instance_registry_obj) do
+            (current_id ? find(current_id) : nil)
+          end
+        end
+
+        def current?
+          !!current
+        end
+
+        def current!
+          current || raise("No current #{name} set")
+        end
+
+        def as_current_id(id)
+          old_id = current_id
+          self.current_id = id
+          yield
+        ensure
+          self.current_id = old_id
+        end
+
+        def as_current(model)
+          old_model = current
+          self.current = model
+          yield
+        ensure
+          self.current = old_model
+        end
+
+        def clear_current!
+          GlobalContextRegistry.delete(current_instance_registry_obj)
+        end
+
+        private
+
+        def __clear_dependents!
+          key_class = respond_to?(:base_class) ? base_class : self
+          GlobalContextRegistry.send(:dependencies_for, key_class).each(&:clear_current!)
+        end
+
+        def current_instance_registry_id
+          return @current_instance_registry_id if @current_instance_registry_id
+
+          key_class = respond_to?(:base_class) ? base_class : self
+          @current_instance_registry_id = "#{key_class.name.underscore}_id".to_sym
+        end
+
+        def current_instance_registry_obj
+          return @current_instance_registry_obj if @current_instance_registry_obj
+
+          key_class = respond_to?(:base_class) ? base_class : self
+          @current_instance_registry_obj = "#{key_class.name.underscore}_obj".to_sym
+        end
+        include RegistryDependentOn
+      end
+
+      def as_current
+        old_id = self.class.current_id
+        self.class.current = self
+        yield
+      ensure
+        self.class.current_id = old_id
+      end
+
+      def current?
+        id == self.class.current_id
+      end
+    end
+  end
+end