rails_multitenant 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a0e8e9b129d21e888c56a07658779a32b4a4a8
-  data.tar.gz: a6004fe24c2671ca3153cbff26b7215059033ae9
+  metadata.gz: 8d8856c2619c65c969920012e0774c5852bc081a
+  data.tar.gz: 4aa3eeeba97039b149972437611479a9ca7e90f5
 SHA512:
-  metadata.gz: f406387794a47eff446ba20ec4e8adac962adf50f393cc0946122d49d29de456ed3bb1adef6dd128228924a1aa8813c8ea2886883f301621c62c7848aadda2c5
-  data.tar.gz: fd621cc380a647a82ebd9e888bd0e7c0ed2e10d3206ade3bc82e7623e8adf8e7d265181dbea98193cbc6b18df6fd6963b503c9202c656c238296773c1d3cabe8
+  metadata.gz: c8a855a064e37e57cbbad37a28c59e07d05415ccf865d28a947cda8283a831a442e6a45f1d05bfe472791ae16a6d7a56b1fedf9970606ae172197b0c50b11939
+  data.tar.gz: 8bd7e80e120213484c6057df63595f83938b7af8afc10300b354cf2125dd35ecc266f00933d3b883786b915c7ba878d67df56dbc9aa8a192075508c402b6a7dd

data/.gitignore

@@ -10,3 +10,5 @@
 /log/
 
 bundle
+.idea
+*.iml

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 0.9.0 
+* Modify `Current.current` to return a specified default, when not already initialized, or `nil` 
+  when no default is specified.    
+* Add `Current.provide_default` to optionally specify a default value for `Current.current`.    
+* Add `Current.current=` / `Current.current?` / `Current.current!` / `Current.as_current`.
+
 ### 0.8.0
 * Switch usage of Fixnum to Integer for Ruby > 2.4 
 * Test with multiple Rubies

data/lib/rails_multitenant/global_context_registry.rb

@@ -24,25 +24,88 @@ module RailsMultitenant
     module Current
       extend ActiveSupport::Concern
 
+      included do
+        class_attribute :default_provider, instance_writer: false
+      end
+
       module ClassMethods
         def current
-          GlobalContextRegistry.fetch(current_registry_obj) { new }
+          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
-          key_class = respond_to?(:base_class) ? base_class : self
-          "#{key_class.name.underscore}_obj".to_sym
+          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

data/lib/rails_multitenant/version.rb

@@ -1,3 +1,3 @@
 module RailsMultitenant
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/current_spec.rb

@@ -0,0 +1,118 @@
+describe RailsMultitenant::GlobalContextRegistry::Current do
+
+  class TestClass
+    include RailsMultitenant::GlobalContextRegistry::Current
+    provide_default :new
+
+    attr_accessor :id
+
+    def initialize(id: :default)
+      @id = id
+    end
+  end
+
+  class SubClass < TestClass
+  end
+
+  class DependentClass
+    include RailsMultitenant::GlobalContextRegistry::Current
+    provide_default { new }
+    global_context_dependent_on TestClass
+  end
+
+  class NoDefaultTestClass
+    include RailsMultitenant::GlobalContextRegistry::Current
+  end
+
+  describe 'current' do
+    it 'returns default value when supplied' do
+      expect(TestClass.current.id).to eq(:default)
+      expect(SubClass.current.id).to eq(:default)
+    end
+
+    it 'returns nil when no default supplied' do
+      expect(NoDefaultTestClass.current).to be_nil
+    end
+  end
+
+  describe 'current!' do
+    it 'returns current value when set' do
+      expect(TestClass.current.id).to eq(:default)
+    end
+
+    it 'raises an error when current not set' do
+      NoDefaultTestClass.clear_current!
+      expect { NoDefaultTestClass.current! }.to raise_error
+    end
+  end
+
+  describe 'current=' do
+    it 'stores the provided object' do
+      provided = TestClass.new(id: :provided)
+      TestClass.current = provided
+      expect(TestClass.current).to equal(provided)
+    end
+
+    it 'clears dependencies' do
+      dependent = DependentClass.current
+      TestClass.current = TestClass.new
+      expect(DependentClass.current).not_to equal(dependent)
+    end
+  end
+
+  describe 'current?' do
+    it 'returns false when uninitialized' do
+      TestClass.clear_current!
+      expect(TestClass.current?).to be false
+    end
+
+    it 'returns true when initialized' do
+      TestClass.current = TestClass.new
+      expect(TestClass.current?).to be true
+    end
+  end
+
+  describe 'as_current' do
+    let(:test_class1) { TestClass.new }
+    let(:test_class2) { TestClass.new }
+
+    it 'sets and restores current' do
+      TestClass.current = test_class1
+      TestClass.as_current(test_class2) do
+        expect(TestClass.current).to equal(test_class2)
+      end
+      expect(TestClass.current).to equal(test_class1)
+    end
+  end
+
+  context 'instance methods' do
+    describe 'current?' do
+      it 'returns false when not the current instance' do
+        TestClass.clear_current!
+        expect(TestClass.new.current?).to be false
+
+        TestClass.current = TestClass.new
+        expect(TestClass.new.current?).to be false
+      end
+
+      it 'returns true when it is the current instance' do
+        test_class = TestClass.new
+        TestClass.current = test_class
+        expect(test_class.current?).to be true
+      end
+    end
+
+    describe 'as_current' do
+      let(:test_class1) { TestClass.new }
+      let(:test_class2) { TestClass.new }
+
+      it 'sets and restores current' do
+        TestClass.current = test_class1
+        test_class2.as_current do
+          expect(TestClass.current).to equal(test_class2)
+        end
+        expect(TestClass.current).to equal(test_class1)
+      end
+    end
+  end
+end

data/spec/current_spec.rb.dis

@@ -0,0 +1,80 @@
+# Create multiple orgs
+# Create an item in each
+# Make sure you can only see one org's item in one org
+
+describe RailsMultitenant::GlobalContextRegistry::Current do
+
+  class Parent
+    include RailsMultitenant::GlobalContextRegistry::Current
+
+    attr_accessor :id
+
+    def initialize(id: 0)
+      @id = id
+    end
+  end
+
+  class Dependent
+    include RailsMultitenant::GlobalContextRegistry::Current
+    global_context_dependent_on Parent
+  end
+
+  class StepParent < Parent
+  end
+
+  it 'current' do
+    expect(Parent.current.id).to eq(0)
+    expect(Parent.current).to eq(Parent.current)
+  end
+
+  it 'current=' do
+    Parent.current = Parent.new(id: 42)
+    expect(Parent.current.id).to eq(42)
+  end
+
+
+  it 'clear_current!' do
+    Parent.clear_current!
+    expect(Parent.current.id).to eq(0)
+  end
+
+  it 'current?' do
+    Parent.clear_current!
+    expect(Parent.current?).to be_falsey
+    Parent.current = Parent.new(id: 42)
+    expect(Parent.current?).to be_truthy
+  end
+
+  context 'with dependencies' do
+    it 'dependent is cleared' do
+      Parent.current = Parent.new(id: 78)
+      Dependent.current = Dependent.new
+      Parent.current = Parent.new(id: 78)
+      expect(Dependent.current?).to be_falsey
+    end
+
+    it 'dependent subclass is cleared' do
+      Parent.current = Parent.new(id: 78)
+      Dependent.current = Dependent.new
+      Parent.current = StepParent.new(id: 78)
+      expect(Dependent.current?).to be_falsey
+    end
+
+
+    #let(dependent_id) { Organization.current.id }
+
+    it 'dependent model subclass is cleared' do
+      #Organization.current = Organization.create!
+      DependsOnOrganization.current = DependsOnOrganization.create!
+      dependent_id = DependsOnOrganization.current.object_id
+      SubOrganization.current = SubOrganization.create!
+      expect(DependsOnOrganization.current.object_id).not_to eq(dependent_id)
+
+
+
+
+
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Pat Breault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,8 @@ files:
 - lib/rails_multitenant/version.rb
 - rails_multitenant.gemspec
 - spec/be_multitenant_on_matcher_spec.rb
+- spec/current_spec.rb
+- spec/current_spec.rb.dis
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/external_item_spec.rb
@@ -215,6 +217,8 @@ test_files:
 - spec/global_context_registry_spec.rb
 - spec/external_item_spec.rb
 - spec/item_subtype_spec.rb
+- spec/current_spec.rb.dis
+- spec/current_spec.rb
 - spec/item_spec.rb
 - spec/external_item_with_optional_org_spec.rb
 - spec/db/schema.rb