rails_multitenant 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a58f005f75cca12de2a1faaee149d98a0810a64d268e602bc4c64af56047ba95
-  data.tar.gz: a979bf78f8c98deb80bd71e3bda893cc1d3cc35a7b50b224c7a3dd98c869db2e
+  metadata.gz: 7cee7c42f683984c490e56705e9de15107c6cdca9458abae424e733907450d1e
+  data.tar.gz: 0be7d4f76a8ba047e66b4316d601f507c4c2c0b97bad4015dff06e8368280bc1
 SHA512:
-  metadata.gz: 8375cb4f2c2a0676f1cc8b049ee4b416025840f085bc270f3ace7ecb2d4cf2b32f7715418d0888ce71ed63667ecc33bd722502a04dc3683d71663ece746a53c3
-  data.tar.gz: 450cb63b8d3b13c8e4fe4d4f2800933ec276faece554d3b5021eda1508f2d8a085282c7fa1e700e6b6aca666dc960a04721fe850d2bd68ee533b7d8420ee175d
+  metadata.gz: cb2fb69f85325ddc3a05af7a26a244e1a40fe2c7eb5082711bd3c33f3ff27339fb911d80f5b689dcc86f5d3842bc450aa31c78901afb3926041ce5711d594ccc
+  data.tar.gz: 4bb540fec11d2f8eaa77468bd7b35cf3d823ce35f4c057757c136b581dd0935455ad62b2245cf3425806f4ea176d04c5adb9c3b2acbcdcf5381c3ebf3d52df8a

data/lib/rails_multitenant/global_context_registry.rb

@@ -1,5 +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.
@@ -8,207 +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 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
-
-    # 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
@@ -280,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 = {}

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

data/lib/rails_multitenant/global_context_registry/registry_dependent_on.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsMultitenant
+  module GlobalContextRegistry
+    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
+  end
+end

data/lib/rails_multitenant/multitenant_model.rb

@@ -18,7 +18,9 @@ module RailsMultitenant
         scope_sym = "from_current_#{context_entity}".to_sym
 
         scope scope_sym, -> do
-          where(context_entity_id_field => GlobalContextRegistry[context_entity_id_field])
+          unless GlobalContextRegistry.use_unscoped_queries?
+            where(context_entity_id_field => GlobalContextRegistry[context_entity_id_field])
+          end
         end
 
         default_scope { send(scope_sym) }

data/lib/rails_multitenant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMultitenant
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Pat Breault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -172,6 +172,9 @@ files:
 - LICENSE.txt
 - lib/rails_multitenant.rb
 - lib/rails_multitenant/global_context_registry.rb
+- lib/rails_multitenant/global_context_registry/current.rb
+- lib/rails_multitenant/global_context_registry/current_instance.rb
+- lib/rails_multitenant/global_context_registry/registry_dependent_on.rb
 - lib/rails_multitenant/middleware/extensions.rb
 - lib/rails_multitenant/middleware/isolated_context_registry.rb
 - lib/rails_multitenant/middleware/railtie.rb