rails_multitenant 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20d2743f52770c7de4e81ae6936148c6c1f474f2
-  data.tar.gz: a533e376642c62f6beb78570ef94eaa99d57f6d8
+  metadata.gz: 7fa50760b463e1f9b31abc6a19d13e863dc5604a
+  data.tar.gz: 7af84280e893555c5c40a4e55cfad57bba8d4252
 SHA512:
-  metadata.gz: 213daa229aaf72402c6964eeddb045b5f33f2da1dbd2eecf01eeb568f04f97336ddad5af5c3fee90de13531b4090511432438796746dd2694d4af454f081e5f5
-  data.tar.gz: 00ab17d047dc6117014bbb86b93ad7fcc731a067347c6d8437fc575350b8ea314096ba89a76dfbc6a8e0ca413be2db2108492c85e8771d00016072d3919cd0b8
+  metadata.gz: b7aca78e340f93da77d625dae54d1c372053fe732032ec7f4acf2b651a436d75fa502895ef212df9a37318a080bf683fa0d4ed785301138bc79ff70d20d06be3
+  data.tar.gz: 91f20b900cd76a6e8afae4ebd8d239b456c74ea1cc0170d660e05109156ac2b28c459fd330c54d56169de7efda6ee935489f1b64fc8697d3e69ed86c33181558

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+### 0.2.0 (unreleased)
+* Merged [PR 2](https://github.com/salsify/rails-multitenant/pull/2) which adds support for 
+  multi-tenancy based on a foreign key to an external model. As part of this the `multitenant_model_on`
+  method was renamed to `multitenant_on_model`.

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+end
+
+task default: :spec

data/lib/rails_multitenant/global_context_registry.rb

@@ -39,7 +39,7 @@ module RailsMultitenant
 
         def current_registry_obj
           key_class = respond_to?(:base_class) ? base_class : self
-          "#{key_class.name.downcase}_obj".to_sym
+          "#{key_class.name.underscore}_obj".to_sym
         end
       end
 
@@ -103,12 +103,12 @@ module RailsMultitenant
 
         def current_instance_registry_id
           key_class = respond_to?(:base_class) ? base_class : self
-          "#{key_class.name.downcase}_id".to_sym
+          "#{key_class.name.underscore}_id".to_sym
         end
 
         def current_instance_registry_obj
           key_class = respond_to?(:base_class) ? base_class : self
-          "#{key_class.name.downcase}_obj".to_sym
+          "#{key_class.name.underscore}_obj".to_sym
         end
 
         include RegistryDependentOn
@@ -132,6 +132,7 @@ module RailsMultitenant
     def set(symbol, value)
       globals[symbol] = value
     end
+    alias_method :[]=, :set
 
     # delete this global
     def delete(symbol)
@@ -152,6 +153,7 @@ module RailsMultitenant
     def get(symbol)
       globals[symbol]
     end
+    alias_method :[], :get
 
     # Duplicate the registry
     def duplicate_registry
@@ -160,10 +162,10 @@ module RailsMultitenant
       end
     end
 
-    # Run a block of code with an empty registry
-    def with_isolated_registry
+    # Run a block of code with an the given registry
+    def with_isolated_registry(registry = {})
       prior_globals = globals
-      self.globals = {}
+      self.globals = registry
       yield
     ensure
       self.globals = prior_globals

data/lib/rails_multitenant/multitenant_model.rb

@@ -1,14 +1,6 @@
 module RailsMultitenant
   module MultitenantModel
     extend ActiveSupport::Concern
-=begin
-    included do
-      belongs_to :organization
-      validates_presence_of :organization_id
-      scope :from_current_org, -> { where(organization_id: Organization.current_id) }
-      default_scope { from_current_org }
-    end
-=end
 
     included do
       class << self
@@ -18,19 +10,29 @@ module RailsMultitenant
 
     module ClassMethods
 
-      def multitenant_model_on(context_entity)
-        @context_entity_id_field = "#{context_entity}_id"
+      def multitenant_on(context_entity_id_field)
+        self.context_entity_id_field = context_entity_id_field
+        validates_presence_of context_entity_id_field
+
+        context_entity = context_entity_id_field.to_s.gsub(/_id$/, '')
         scope_sym = "from_current_#{context_entity}".to_sym
 
-        belongs_to context_entity
-        validates_presence_of context_entity_id_field
-        scope scope_sym, -> { where(context_entity_id_field => context_entity.to_s.classify.constantize.current_id) }
+        scope scope_sym, -> do
+          where(context_entity_id_field => GlobalContextRegistry[context_entity_id_field])
+        end
+
         default_scope { send(scope_sym) }
+
         define_method "strip_#{context_entity}_scope" do
           unscope(where: context_entity_id_field)
         end
       end
 
+      def multitenant_on_model(context_entity)
+        multitenant_on("#{context_entity}_id".to_sym)
+        belongs_to context_entity
+      end
+
       def validates_multitenant_uniqueness_of(*attr_names)
         options = attr_names.extract_options!.symbolize_keys
         existing_scope = Array.wrap(options.delete(:scope))

data/lib/rails_multitenant/rspec.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define(:be_multitenant_on) do |expected|
+  match do |actual|
+    actual.context_entity_id_field == expected
+  end
+end

data/lib/rails_multitenant/version.rb

@@ -1,3 +1,3 @@
 module RailsMultitenant
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/rails_multitenant.rb

@@ -3,3 +3,5 @@ require 'active_record'
 
 require "rails_multitenant/global_context_registry"
 require "rails_multitenant/multitenant_model"
+
+# rails_multitenant/rspec has to be explicitly included by clients who want to use it

data/spec/be_multitenant_on_matcher_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'rails_multitenant/rspec'
+
+describe "be_multitenant_on matcher" do
+  it "accepts a valid context field id" do
+    expect(ExternalItem).to be_multitenant_on(:external_organization_id)
+  end
+
+  it "rejects an invalid context field id" do
+    expect(ExternalItem).not_to be_multitenant_on(:other_field)
+  end
+end

data/spec/db/schema.rb

@@ -1,16 +1,16 @@
 # encoding: UTF-8
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Schema.define(version: 0) do
 
-  create_table(:organizations, force: true) do |t|
-    t.string :name
-  end
+  create_table(:organizations, force: true)
 
   create_table(:items, force: true) do |t|
-    t.string :name
     t.integer :organization_id
   end
 
+  create_table(:external_items, force: true) do |t|
+    t.integer :external_organization_id
+  end
 end
 
 class Organization < ActiveRecord::Base
@@ -19,5 +19,11 @@ end
 
 class Item < ActiveRecord::Base
   include RailsMultitenant::MultitenantModel
-  multitenant_model_on :organization
+  multitenant_on_model :organization
+end
+
+class ExternalItem < ActiveRecord::Base
+  include RailsMultitenant::MultitenantModel
+  multitenant_on :external_organization_id
 end
+

data/spec/external_item_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+include RailsMultitenant
+
+describe ExternalItem do
+
+  let!(:external_item1) { as_external_org(1) { ExternalItem.create! } }
+
+  let!(:external_item2) { as_external_org(2) { ExternalItem.create! } }
+  let!(:external_item3) { as_external_org(2) { ExternalItem.create! } }
+
+  specify 'org1 has the correct external items' do
+    as_external_org(1) do
+      expect(ExternalItem.all).to eq [external_item1]
+    end
+  end
+
+  specify 'org2 has the correct external items' do
+    as_external_org(2) do
+      expect(ExternalItem.all).to match_array [external_item2, external_item3]
+    end
+  end
+
+  it 'does not return external items from other orgs' do
+    as_external_org(2) do
+      expect(ExternalItem.where(id: external_item1.id)).to eq []
+    end
+  end
+
+  def as_external_org(id, &block)
+    GlobalContextRegistry.with_isolated_registry(external_organization_id: id, &block)
+  end
+
+end

data/spec/global_context_registry_spec.rb

@@ -15,6 +15,16 @@ describe GlobalContextRegistry do
     end
   end
 
+  describe '.[] and .[]=' do
+    before do
+      GlobalContextRegistry[:boo] = 'baz'
+    end
+
+    specify do
+      expect(GlobalContextRegistry[:boo]).to eq 'baz'
+    end
+  end
+
   describe '.delete' do
     specify do
       expect(GlobalContextRegistry.delete(:foo)).to eq 'bar'
@@ -28,6 +38,12 @@ describe GlobalContextRegistry do
         expect(GlobalContextRegistry.get(:foo)).to be_nil
       end
     end
+
+    specify do
+      GlobalContextRegistry.with_isolated_registry(foo: 'updated') do
+        expect(GlobalContextRegistry.get(:foo)).to eq 'updated'
+      end
+    end
   end
 
   describe '.replace_registry and .new_registry' do

data/spec/item_spec.rb

@@ -6,11 +6,11 @@ require 'spec_helper'
 
 describe Item do
 
-  let!(:item1) { Item.create(name: 'item1') }
+  let!(:item1) { Item.create! }
 
-  let!(:org2) { Organization.create(name: 'org2') }
-  let!(:item2) { org2.as_current { Item.create(name: 'item2') } }
-  let!(:item3) { org2.as_current { Item.create(name: 'item3') } }
+  let!(:org2) { Organization.create! }
+  let!(:item2) { org2.as_current { Item.create! } }
+  let!(:item3) { org2.as_current { Item.create! } }
 
   specify 'default org should have one item' do
     expect(Item.all).to eq [ item1 ]

data/spec/spec_helper.rb

@@ -30,8 +30,6 @@ require 'db/schema'
 RSpec.configure do |config|
   config.order = 'random'
 
-  config.add_setting :test_org_id
-
   config.before(:suite) do
     DatabaseCleaner.clean_with(:truncation)
   end
@@ -40,9 +38,7 @@ RSpec.configure do |config|
     DatabaseCleaner.strategy = :transaction
     DatabaseCleaner.start
     RailsMultitenant::GlobalContextRegistry.new_registry
-    org = Organization.create(name: 'test org')
-    RSpec.configuration.test_org_id = org.id
-    Organization.current_id = RSpec.configuration.test_org_id
+    Organization.current_id = Organization.create!.id
   end
 
   config.after(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Breault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-23 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,7 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -167,11 +168,13 @@ files:
 - lib/rails_multitenant.rb
 - lib/rails_multitenant/global_context_registry.rb
 - lib/rails_multitenant/multitenant_model.rb
+- lib/rails_multitenant/rspec.rb
 - lib/rails_multitenant/version.rb
-- log/test.log
 - rails_multitenant.gemspec
+- spec/be_multitenant_on_matcher_spec.rb
 - spec/db/database.yml
 - spec/db/schema.rb
+- spec/external_item_spec.rb
 - spec/global_context_registry_spec.rb
 - spec/item_spec.rb
 - spec/spec_helper.rb
@@ -200,8 +203,10 @@ signing_key:
 specification_version: 4
 summary: Automatically configures multiple tenants in a Rails environment
 test_files:
+- spec/be_multitenant_on_matcher_spec.rb
 - spec/db/database.yml
 - spec/db/schema.rb
+- spec/external_item_spec.rb
 - spec/global_context_registry_spec.rb
 - spec/item_spec.rb
 - spec/spec_helper.rb