mongoid-multitenancy 1.2.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc62ee7dad2407f285292511b1a3ff9487b2f658
-  data.tar.gz: de93ec4f6f8182bd4307c9cc865b585f215d9a68
+  metadata.gz: 431219928a15faa3df3004d3b81b840bc8650691
+  data.tar.gz: 41c7101a950c1ae7539912038befff3c9e4cac63
 SHA512:
-  metadata.gz: 1bbfd25a05be1f5bb1a873fa53f42df8546b6cc24a568b846500d6b8e429df9ebb6781e21fdac50b91f34f95a415f0c8a83dd9de0017e0d86919828c215b13b2
-  data.tar.gz: 747a8e3b7e5cc1ee8daaa5713a3e39f82978a27c10e0dac8bc4b7ef94eb38b561c982c8349252a6265b2dee08fc0981a796ff9149776c02f080687f9479f6274
+  metadata.gz: 6c7e4c5902e9da5050c1bf14797a93d06a1303fa61fed4ad9cb6b32ea57309f6abbe8ecef530f37457e9474fc18bd2eeb99812229c67abbaf9e8a7b3cceec1fe
+  data.tar.gz: 14df29dad2f6946275bbc152823003a04c701b44f3bac4774fdbbf11faabe7d4d5aad0b1f49b7f544d298c7ef6d0ed056874fe8a26c047b09de7986ddc1c13b6

data/.travis.yml

@@ -1,13 +1,9 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.2.2
   - 2.3.0
-  - jruby
+  - 2.4.1
 gemfile:
-  - gemfiles/Gemfile.mongoid-4.0
-  - gemfiles/Gemfile.mongoid-5.0
   - Gemfile
 services:
   - mongodb

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.0
+
+### New Features
+
+* Add support for mongoid 6
+* Remove support for mongoid 4 & 5
+
+## 1.2
+
+### New Features
+
+* Add *exclude_shared* option for the TenantUniquenessValidator
+
 ## 1.1
 
 ### New Features
@@ -12,7 +25,7 @@
 
 ### New Features
 
-* Adds support for mongoid 5
+* Add support for mongoid 5
 
 ### Major Changes (Backwards Incompatible)
 

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 5.1'
+gem 'mongoid', '~> 6.0'
 
 gem 'rake', '~> 11.0'
 
@@ -9,7 +9,7 @@ group :test do
   gem 'coveralls', require: false
   gem 'rspec', '~> 3.1'
   gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 3.0'
+  gem 'mongoid-rspec', git: 'https://github.com/mongoid-rspec/mongoid-rspec.git'
   gem 'rubocop', require: false
 end
 

data/README.md

@@ -12,12 +12,17 @@ In addition, mongoid-multitenancy:
 * is thread safe
 * redefines some mongoid functions like `index`, `validates_with` and `delete_all` to take in account the multitenancy.
 
+Compatibility
+===============
+
+mongoid-multitenancy 2.0 is only compatible with mongoid 6. For mongoid 4 & 5 compatiblity, use mongoid-multitenancy 1.2.
+
 Installation
 ===============
 
 Add this line to your application's Gemfile:
 
-    gem 'mongoid-multitenancy'
+    gem 'mongoid-multitenancy', '~> 2.0'
 
 And then execute:
 
@@ -74,7 +79,7 @@ class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client)
+  tenant(:tenant)
 
   field :title, :type => String
 end
@@ -101,15 +106,15 @@ Some examples to illustrate this behavior:
 Mongoid::Multitenancy.current_tenant = Client.find_by(:name => 'Perfect Memory') # => <#Client _id:50ca04b86c82bfc125000025, :name: "Perfect Memory">
 
  # All searches are scoped by the tenant, the following searches will only return objects belonging to the current client.
-Article.all # => all articles where client_id => 50ca04b86c82bfc125000025
+Article.all # => all articles where tenant_id => 50ca04b86c82bfc125000025
 
  # New objects are scoped to the current tenant
 article = Article.new(:title => 'New blog')
-article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: 50ca04b86c82bfc125000025>
+article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', tenant_id: 50ca04b86c82bfc125000025>
 
  # It can make the tenant field immutable once it is persisted to avoid inconsistency
 article.persisted? # => true
-article.client = another_client
+article.tenant = another_client
 article.valid? # => false
 ```
 
@@ -124,21 +129,21 @@ class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client, optional: true)
+  tenant(:tenant, optional: true)
 
   field :title, :type => String
 end
 
 Mongoid::Multitenancy.with_tenant(client_instance) do
-  Article.all # => all articles where client_id.in [50ca04b86c82bfc125000025, nil]
+  Article.all # => all articles where tenant_id.in [50ca04b86c82bfc125000025, nil]
   article = Article.new(:title => 'New article')
-  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: 50ca04b86c82bfc125000025>
+  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', tenant_id: 50ca04b86c82bfc125000025>
 
   # tenant needs to be set manually to nil
-  article = Article.new(:title => 'New article', :client => nil)
-  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: 50ca04b86c82bfc125000025>
+  article = Article.new(:title => 'New article', :tenant => nil)
+  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', tenant_id: 50ca04b86c82bfc125000025>
   article.tenant = nil
-  article.save => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: nil>
+  article.save => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', tenant_id: nil>
 end
 ```
 
@@ -177,7 +182,7 @@ class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client
+  tenant :tenant
 
   field :slug
 
@@ -197,7 +202,7 @@ class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, optional: true
+  tenant :tenant, optional: true
 
   field :slug
 
@@ -206,14 +211,14 @@ end
 ```
 
 In the following case, 2 private articles can have the same slug if they belongs to 2 different clients even if a shared
-article already uses that same slug, like a `validates_uniqueness_of scope: :client` does.
+article already uses that same slug, like a `validates_uniqueness_of scope: :tenant` does.
 
 ```ruby
 class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, optional: true
+  tenant :tenant, optional: true
 
   field :slug
 
@@ -230,14 +235,14 @@ To create a single index on the tenant field, you can use the option `index: tru
 
 On the example below, only one indexe will be created:
 
-* { 'title_id' => 1, 'client_id' => 1 }
+* { 'title_id' => 1, 'tenant_id' => 1 }
 
 ```ruby
 class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, full_indexes: true
+  tenant :tenant, full_indexes: true
 
   field :title
 
@@ -247,7 +252,7 @@ end
 
 On the example below, 2 indexes will be created:
 
-* { 'client_id' => 1 }
+* { 'tenant_id' => 1 }
 * { 'title_id' => 1 }
 
 ```ruby
@@ -255,7 +260,7 @@ class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, index: true
+  tenant :tenant, index: true
 
   field :title
 

data/lib/mongoid/multitenancy/document.rb

@@ -109,6 +109,7 @@ module Mongoid
           options.each do |k, v|
             if MULTITENANCY_OPTIONS.include?(k)
               multitenant_options[k] = v
+              assoc_options[k] = v if k == :optional
             else
               assoc_options[k] = v
             end

data/lib/mongoid/multitenancy/validators/tenant_uniqueness.rb

@@ -39,14 +39,8 @@ module Mongoid
         criteria = with_tenant_criterion(criteria, klass, document)
         criteria = criteria.merge(options[:conditions].call) if options[:conditions]
 
-        if Mongoid::VERSION.start_with?('4')
-          if criteria.with(persistence_options(criteria)).exists?
-            add_error(document, attribute, value)
-          end
-        else
-          if criteria.with(criteria.persistence_options).read(mode: :primary).exists?
-            add_error(document, attribute, value)
-          end
+        if criteria.read(mode: :primary).exists?
+          add_error(document, attribute, value)
         end
       end
 

data/lib/mongoid/multitenancy/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   module Multitenancy
     # Version
-    VERSION = '1.2.0'.freeze
+    VERSION = '2.0'.freeze
   end
 end

data/mongoid-multitenancy.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Mongoid::Multitenancy::VERSION
 
-  gem.add_dependency('mongoid', '>= 4.0')
+  gem.add_dependency('mongoid', '~> 6.0')
 end

data/spec/immutable_spec.rb

@@ -38,7 +38,7 @@ describe Immutable do
       end
 
       it 'is not valid' do
-        item.client = another_client
+        item.tenant = another_client
         expect(item).not_to be_valid
       end
     end

data/spec/indexable_spec.rb

@@ -11,25 +11,25 @@ describe 'tenant' do
 
   context 'without index: true' do
     it 'does not create an index' do
-      expect(Immutable).not_to have_index_for(client_id: 1)
+      expect(Immutable).not_to have_index_for(tenant_id: 1)
     end
   end
 
   context 'with index: true' do
     it 'creates an index' do
-      expect(Indexable).to have_index_for(client_id: 1)
+      expect(Indexable).to have_index_for(tenant_id: 1)
     end
   end
 
   context 'with full_indexes: true' do
     it 'add the tenant field on each index' do
-      expect(Immutable).to have_index_for(client_id: 1, title: 1)
+      expect(Immutable).to have_index_for(tenant_id: 1, title: 1)
     end
   end
 
   context 'with full_indexes: false' do
     it 'does not add the tenant field on each index' do
-      expect(Indexable).not_to have_index_for(client_id: 1, title: 1)
+      expect(Indexable).not_to have_index_for(tenant_id: 1, title: 1)
     end
   end
 end

data/spec/models/immutable.rb

@@ -2,7 +2,7 @@ class Immutable
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client, class_name: 'Account', immutable: true)
+  tenant(:tenant, class_name: 'Account', immutable: true)
 
   field :slug, type: String
   field :title, type: String

data/spec/models/indexable.rb

@@ -4,7 +4,7 @@ class Indexable
 
   field :title, type: String
 
-  tenant :client, class_name: 'Account', index: true, full_indexes: false
+  tenant :tenant, class_name: 'Account', index: true, full_indexes: false
 
   index(title: 1)
 end

data/spec/models/mandatory.rb

@@ -2,7 +2,7 @@ class Mandatory
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client, class_name: 'Account')
+  tenant(:tenant, class_name: 'Account')
 
   field :slug, type: String
   field :title, type: String

data/spec/models/mutable.rb

@@ -2,7 +2,7 @@ class Mutable
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, class_name: 'Account', immutable: false, optional: false
+  tenant :tenant, class_name: 'Account', immutable: false, optional: false
 
   field :slug, type: String
   field :title, type: String

data/spec/models/no_scopable.rb

@@ -2,7 +2,7 @@ class NoScopable
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant :client, class_name: 'Account', scopes: false
+  tenant :tenant, class_name: 'Account', scopes: false
 
   field :slug, type: String
   field :title, type: String

data/spec/models/optional.rb

@@ -2,7 +2,7 @@ class Optional
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client, class_name: 'Account', optional: true)
+  tenant(:tenant, class_name: 'Account', optional: true)
 
   field :slug, type: String
   field :title, type: String

data/spec/models/optional_exclude.rb

@@ -2,7 +2,7 @@ class OptionalExclude
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client, class_name: 'Account', optional: true)
+  tenant(:tenant, class_name: 'Account', optional: true)
 
   field :slug, type: String
   field :title, type: String

data/spec/mutable_child_spec.rb

@@ -38,7 +38,7 @@ describe MutableChild do
       end
 
       it 'is valid' do
-        item.client = another_client
+        item.tenant = another_client
         expect(item).to be_valid
       end
     end

data/spec/mutable_spec.rb

@@ -42,7 +42,7 @@ describe Mutable do
       end
 
       it 'is valid' do
-        item.client = another_client
+        item.tenant = another_client
         expect(item).to be_valid
       end
     end

data/spec/optional_spec.rb

@@ -24,13 +24,13 @@ describe Optional do
 
       context 'when persisted' do
         before do
-          item.client = nil
+          item.tenant = nil
           item.save!
         end
 
         it 'does not override the client' do
           item.reload
-          expect(Optional.last.client).to be_nil
+          expect(Optional.last.tenant).to be_nil
         end
       end
     end

data/spec/spec_helper.rb

@@ -30,7 +30,8 @@ Mongoid.configure do |config|
   config.connect_to 'mongoid_multitenancy'
 end
 
-Mongoid.logger = nil
+Mongoid.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO
 
 RSpec.configure do |config|
   config.include Mongoid::Matchers

data/spec/support/shared_examples.rb

@@ -1,6 +1,6 @@
 shared_examples_for 'a tenantable model' do
-  it { is_expected.to belong_to(:client) }
-  it { is_expected.to have_index_for(client_id: 1, title: 1) }
+  it { is_expected.to belong_to(:tenant) }
+  it { is_expected.to have_index_for(tenant_id: 1, title: 1) }
 
   describe '#initialize' do
     context 'within a client context' do
@@ -9,7 +9,7 @@ shared_examples_for 'a tenantable model' do
       end
 
       it 'set the client' do
-        expect(item.client).to eq client
+        expect(item.tenant).to eq client
       end
     end
 
@@ -19,7 +19,7 @@ shared_examples_for 'a tenantable model' do
       end
 
       it 'does not set any client' do
-        expect(item.client).to be_nil
+        expect(item.tenant).to be_nil
       end
     end
   end
@@ -32,7 +32,7 @@ shared_examples_for 'a tenantable model' do
 
       context 'with the client id' do
         before do
-          item.client = client
+          item.tenant = client
         end
 
         it 'is valid' do
@@ -42,7 +42,7 @@ shared_examples_for 'a tenantable model' do
 
       context 'with another client id' do
         before do
-          item.client = another_client
+          item.tenant = another_client
         end
 
         it 'is not valid' do
@@ -58,7 +58,7 @@ shared_examples_for 'a tenantable model' do
 
       context 'with the client id' do
         before do
-          item.client = client
+          item.tenant = client
         end
 
         it 'is valid' do
@@ -68,7 +68,7 @@ shared_examples_for 'a tenantable model' do
 
       context 'with another client id' do
         before do
-          item.client = another_client
+          item.tenant = another_client
         end
 
         it 'is valid' do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: '2.0'
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 description: MultiTenancy with Mongoid
 email:
 - aymeric.brisse@mperfect-memory.com
@@ -39,8 +39,6 @@ files:
 - LICENSE.TXT
 - README.md
 - Rakefile
-- gemfiles/Gemfile.mongoid-4.0
-- gemfiles/Gemfile.mongoid-5.0
 - lib/mongoid-multitenancy.rb
 - lib/mongoid/multitenancy.rb
 - lib/mongoid/multitenancy/document.rb
@@ -90,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Support of a multi-tenant database with Mongoid
@@ -117,4 +115,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/mongoid_matchers.rb
 - spec/support/shared_examples.rb
-has_rdoc: 

data/gemfiles/Gemfile.mongoid-4.0

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'mongoid', '~> 4.0'
-
-gem 'rake', '~> 11.0'
-
-group :test do
-  gem 'database_cleaner'
-  gem 'coveralls', require: false
-  gem 'rspec', '~> 3.1'
-  gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 2.1'
-  gem 'rubocop', require: false
-end
-
-# Specify your gem's dependencies in mongoid-multitenancy.gemspec
-gemspec :path => '..'

data/gemfiles/Gemfile.mongoid-5.0

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'mongoid', '~> 5.1'
-
-gem 'rake', '~> 11.0'
-
-group :test do
-  gem 'database_cleaner'
-  gem 'coveralls', require: false
-  gem 'rspec', '~> 3.1'
-  gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 3.0'
-  gem 'rubocop', require: false
-end
-
-# Specify your gem's dependencies in mongoid-multitenancy.gemspec
-gemspec :path => '..'