mongoid-multitenancy 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57b6a36dd90e26ab59298efdd32bfeb5b92a1bfd
-  data.tar.gz: da726e93d69c677784b0bb5213d21bda3a77af3b
+SHA256:
+  metadata.gz: 485b7b5927867bd3f2e3d33aa0705a0f78422a81cba9b5f207b7c71ba56fda65
+  data.tar.gz: 07c63615e55a7a66d7776bf61b8fd741dd15105bfb14404742242dfe36cc0387
 SHA512:
-  metadata.gz: b11cda4238d5ef849b59ce910c70136692e04680c764159c128cf38eea5fd89851e8d9d728a3773edbf27ed0013d9fbc2e2777babe2b977c4bcab160198ecca2
-  data.tar.gz: bf624d27f91d4ac108f811445eaa9fbbb4837e88427cc4a5eb7d810c9adbb19f6310f7a94ac84592560f371ad9ed666999498a7395cc562f495d845be724880e
+  metadata.gz: 406b1104c97d9faa39822f114bb4c4b0687e2aedcf0f307e5dc2d90a96ef11a89509988a585f79030aec5ec2948ead959a351d558cc933152f55344b6ee3c96f
+  data.tar.gz: e46f79ec9b5dbe8adef7f3f5da17e6eb34397f600679e5c2f8c140b1c6911a88712b919b3c3e7a4fc9938f63731354c268e97345261441384ac821f83d2e3ebd

data/.travis.yml

@@ -6,6 +6,8 @@ rvm:
 gemfile:
   - gemfiles/Gemfile.mongoid-6
   - gemfiles/Gemfile.mongoid-7
+  - gemfiles/Gemfile.mongoid-8
+  - gemfiles/Gemfile.mongoid-9
   - Gemfile
 services:
   - mongodb

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.0.5] - 2024-09-20
+### Fixed
+
+* Fix uniqueness validator when used with conditions
+
+## [2.0.4] - 2024-06-17
+### Fixed
+
+* Full Support of mongoid 8 & 9
+
 ## [2.0.3] - 2020-06-25
 ### Fixed
 

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gem 'rake'
 
 group :test do
-  gem 'database_cleaner'
+  gem 'database_cleaner-mongoid'
   gem 'coveralls', require: false
   gem 'rspec', '~> 3.1'
   gem 'yard'

data/README.md

@@ -15,7 +15,7 @@ In addition, mongoid-multitenancy:
 Compatibility
 ===============
 
-mongoid-multitenancy 2.0 is compatible with mongoid 6/7. For mongoid 4/5 compatiblity, use mongoid-multitenancy 1.2.
+mongoid-multitenancy 2 is compatible with mongoid 6/7/8/9. For mongoid 4/5 compatiblity, use mongoid-multitenancy 1.2.
 
 Installation
 ===============
@@ -226,16 +226,32 @@ class Article
 end
 ```
 
+TenantUniqueness validator also allow to specify additional `conditions` to limit the uniqueness of the constraint.
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, optional: true
+
+  field :title
+  field :slug
+
+  validates_tenant_uniqueness_of :slug, exclude_shared: true, conditions: -> { ne(title: nil) }
+end
+```
+
 Mongoid indexes
 -------------------
 
-mongoid-multitenancy automatically adds the tenant foreign key in all your mongoid indexes to avoid to redefine all your validators. If you prefer to define manually the indexes, you can use the option `full_indexes: false`.
+mongoid-multitenancy automatically adds the tenant foreign key in all your mongoid indexes to avoid to redefine all your validators. If you prefer to define the indexes manually, you can use the option `full_indexes: false` on the tenant or `full_index: true/false` on the indexes.
 
 To create a single index on the tenant field, you can use the option `index: true` like any `belongs_to` declaration (false by default)
 
-On the example below, only one indexe will be created:
+On the example below, only one index will be created:
 
-* { 'title_id' => 1, 'tenant_id' => 1 }
+* { 'tenant_id' => 1, 'title' => 1 }
 
 ```ruby
 class Article
@@ -250,10 +266,11 @@ class Article
 end
 ```
 
-On the example below, 2 indexes will be created:
+On the example below, 3 indexes will be created:
 
 * { 'tenant_id' => 1 }
-* { 'title_id' => 1 }
+* { 'tenant_id' => 1, 'title' => 1 }
+* { 'name' => 1 }
 
 ```ruby
 class Article
@@ -263,8 +280,10 @@ class Article
   tenant :tenant, index: true
 
   field :title
+  field :name
 
   index({ :title => 1 })
+  index({ :name => 1 }, { full_index: false })
 end
 ```
 

data/gemfiles/Gemfile.mongoid-6

@@ -5,7 +5,7 @@ gem 'mongoid', '~> 6.0'
 gem 'rake'
 
 group :test do
-  gem 'database_cleaner'
+  gem 'database_cleaner-mongoid'
   gem 'coveralls', require: false
   gem 'rspec', '~> 3.1'
   gem 'yard'

data/gemfiles/Gemfile.mongoid-7

@@ -5,7 +5,7 @@ gem 'mongoid', '~> 7.0'
 gem 'rake'
 
 group :test do
-  gem 'database_cleaner'
+  gem 'database_cleaner-mongoid'
   gem 'coveralls', require: false
   gem 'rspec', '~> 3.1'
   gem 'yard'

data/gemfiles/Gemfile.mongoid-8

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'mongoid', '~> 8.0'
+
+gem 'rake'
+
+group :test do
+  gem 'database_cleaner-mongoid'
+  gem 'coveralls', require: false
+  gem 'rspec', '~> 3.1'
+  gem 'yard'
+  gem 'mongoid-rspec', git: 'https://github.com/mongoid-rspec/mongoid-rspec.git'
+  gem 'rubocop', require: false
+end

data/gemfiles/Gemfile.mongoid-9

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'mongoid', '~> 9.0'
+
+gem 'rake'
+
+group :test do
+  gem 'database_cleaner-mongoid'
+  gem 'coveralls', require: false
+  gem 'rspec', '~> 3.1'
+  gem 'yard'
+  gem 'mongoid-rspec', git: 'https://github.com/mongoid-rspec/mongoid-rspec.git'
+  gem 'rubocop', require: false
+end

data/lib/mongoid/multitenancy/document.rb

@@ -87,11 +87,13 @@ module Mongoid
 
         # Redefine 'index' to include the tenant field in first position
         def index(spec, options = nil)
-          if tenant_options[:full_indexes]
+          super_options = (options || {}).dup
+          full_index = super_options.delete(:full_index)
+          if full_index.nil? ? tenant_options[:full_indexes] : full_index
             spec = { tenant_field => 1 }.merge(spec)
           end
 
-          super(spec, options)
+          super(spec, super_options)
         end
 
         # Redefine 'delete_all' to take in account the default scope

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

@@ -37,7 +37,11 @@ module Mongoid
 
         # <<Add the tenant Criteria>>
         criteria = with_tenant_criterion(criteria, klass, document)
-        criteria = criteria.merge(options[:conditions].call) if options[:conditions]
+        # Add additional conditions
+        if options[:conditions]
+          conditions = klass.unscoped { options[:conditions].call }
+          criteria = criteria.merge(conditions)
+        end
 
         if criteria.read(mode: :primary).exists?
           add_error(document, attribute, value)

data/lib/mongoid/multitenancy/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   module Multitenancy
     # Version
-    VERSION = '2.0.3'.freeze
+    VERSION = '2.0.5'.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', '>= 6', '< 8')
+  gem.add_dependency('mongoid', '>= 6', '< 10')
 end

data/spec/conditional_uniqueness_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe ConditionalUniqueness do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  let(:item) do
+    ConditionalUniqueness.new(approved: true, slug: 'page-x')
+  end
+
+  it_behaves_like 'a tenantable model'
+
+  describe '#valid?' do
+    context 'with a tenant' do
+      before do
+        Mongoid::Multitenancy.current_tenant = client
+      end
+
+      it 'is valid' do
+        expect(item).to be_valid
+      end
+
+      context 'with a duplicate on the constraint' do
+        let(:duplicate) do
+          ConditionalUniqueness.new(approved: true, slug: 'page-x')
+        end
+
+        before do
+          item.save!
+        end
+
+        it 'is not valid' do
+          expect(duplicate).not_to be_valid
+        end
+
+        context 'with a duplicate outside the conditions' do
+          before do
+            item.update(approved: false)
+          end
+
+          it 'is valid' do
+            expect(duplicate).to be_valid
+          end
+        end
+
+        context 'with a different tenant' do
+          it 'is valid' do
+            Mongoid::Multitenancy.with_tenant(another_client) do
+              expect(duplicate).to be_valid
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/indexable_spec.rb

@@ -9,27 +9,62 @@ describe 'tenant' do
     Mongoid::Multitenancy.current_tenant = client
   end
 
-  context 'without index: true' do
-    it 'does not create an index' do
-      expect(Immutable).not_to have_index_for(tenant_id: 1)
+  describe 'tenant full_indexes option' do
+    context 'without index option' do
+      it 'does not create an index' do
+        expect(IndexableWithoutIndex).not_to have_index_for(tenant_id: 1)
+      end
     end
-  end
 
-  context 'with index: true' do
-    it 'creates an index' do
-      expect(Indexable).to have_index_for(tenant_id: 1)
+    context 'with index: false' do
+      it 'does not create an index' do
+        expect(IndexableWithIndexFalse).not_to have_index_for(tenant_id: 1)
+      end
     end
-  end
 
-  context 'with full_indexes: true' do
-    it 'add the tenant field on each index' do
-      expect(Immutable).to have_index_for(tenant_id: 1, title: 1)
+    context 'with index: true' do
+      it 'creates an index' do
+        expect(IndexableWithIndexTrue).to have_index_for(tenant_id: 1)
+      end
     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(tenant_id: 1, title: 1)
+  describe 'index full_index option' do
+    context 'without tenant full_indexes option specified' do
+      it 'adds the tenant field on each index' do
+        expect(IndexableWithoutFullIndexes).to have_index_for(tenant_id: 1, title: 1)
+      end
+
+      it 'adds the tenant field on the index with full_index: true' do
+        expect(IndexableWithoutFullIndexes).to have_index_for(tenant_id: 1, name: 1)
+      end
+
+      it 'does not add the tenant field on the index with full_index: false' do
+        expect(IndexableWithoutFullIndexes).not_to have_index_for(tenant_id: 1, slug: 1)
+        expect(IndexableWithoutFullIndexes).to have_index_for(slug: 1)
+      end
+    end
+
+    context 'with full_indexes: true' do
+      it 'adds the tenant field on each index' do
+        expect(IndexableWithFullIndexesTrue).to have_index_for(tenant_id: 1, title: 1)
+      end
+
+      it 'does not add the tenant field on the index with full_index: false' do
+        expect(IndexableWithFullIndexesTrue).not_to have_index_for(tenant_id: 1, name: 1)
+        expect(IndexableWithFullIndexesTrue).to have_index_for(name: 1)
+      end
+    end
+
+    context 'with full_indexes: false' do
+      it 'does not add the tenant field on each index' do
+        expect(IndexableWithFullIndexesFalse).not_to have_index_for(tenant_id: 1, title: 1)
+        expect(IndexableWithFullIndexesFalse).to have_index_for(title: 1)
+      end
+
+      it 'does add the tenant field on the index with full_index: true' do
+        expect(IndexableWithFullIndexesFalse).to have_index_for(tenant_id: 1, name: 1)
+      end
     end
   end
 end

data/spec/models/conditional_uniqueness.rb

@@ -0,0 +1,14 @@
+class ConditionalUniqueness
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:tenant, class_name: 'Account', optional: true)
+
+  field :slug, type: String
+  field :approved, type: Boolean, default: false
+
+  validates_tenant_uniqueness_of :slug, conditions: -> { where(approved: true) }
+  validates_presence_of :slug
+
+  index(title: 1)
+end

data/spec/models/indexable.rb

@@ -1,10 +1,61 @@
-class Indexable
+class IndexableWithoutIndex
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account'
+end
+
+class IndexableWithIndexTrue
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', index: true
+end
+
+class IndexableWithIndexFalse
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', index: false
+end
+
+class IndexableWithoutFullIndexes
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, type: String
+  field :name, type: String
+  field :slug, type: String
+
+  tenant :tenant, class_name: 'Account'
+
+  index(title: 1)
+  index({ name: 1 }, { full_index: true })
+  index({ slug: 1 }, { full_index: false })
+end
+
+class IndexableWithFullIndexesFalse
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, type: String
+  field :name, type: String
+
+  tenant :tenant, class_name: 'Account', full_indexes: false
+
+  index(title: 1)
+  index({ name: 1 }, { full_index: true })
+end
+
+class IndexableWithFullIndexesTrue
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
   field :title, type: String
+  field :name, type: String
 
-  tenant :tenant, class_name: 'Account', index: true, full_indexes: false
+  tenant :tenant, class_name: 'Account', full_indexes: true
 
   index(title: 1)
+  index({ name: 1 }, { full_index: false })
 end

data/spec/models/optional_exclude.rb

@@ -7,7 +7,7 @@ class OptionalExclude
   field :slug, type: String
   field :title, type: String
 
-  validates_tenant_uniqueness_of :slug, exclude_shared: true
+  validates_tenant_uniqueness_of :slug, exclude_shared: true, conditions: -> { ne(title: nil) }
   validates_presence_of :slug
   validates_presence_of :title
 

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ MODELS = File.join(File.dirname(__FILE__), 'models')
 
 require 'simplecov'
 require 'coveralls'
-require 'database_cleaner'
+require 'database_cleaner-mongoid'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.5
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -19,7 +19,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '10'
 description: MultiTenancy with Mongoid
 email:
 - aymeric.brisse@mperfect-memory.com
@@ -47,6 +47,8 @@ files:
 - Rakefile
 - gemfiles/Gemfile.mongoid-6
 - gemfiles/Gemfile.mongoid-7
+- gemfiles/Gemfile.mongoid-8
+- gemfiles/Gemfile.mongoid-9
 - lib/mongoid-multitenancy.rb
 - lib/mongoid/multitenancy.rb
 - lib/mongoid/multitenancy/document.rb
@@ -54,11 +56,13 @@ files:
 - lib/mongoid/multitenancy/validators/tenant_uniqueness.rb
 - lib/mongoid/multitenancy/version.rb
 - mongoid-multitenancy.gemspec
+- spec/conditional_uniqueness_spec.rb
 - spec/immutable_spec.rb
 - spec/indexable_spec.rb
 - spec/inheritance_spec.rb
 - spec/mandatory_spec.rb
 - spec/models/account.rb
+- spec/models/conditional_uniqueness.rb
 - spec/models/immutable.rb
 - spec/models/indexable.rb
 - spec/models/mandatory.rb
@@ -95,17 +99,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Support of a multi-tenant database with Mongoid
 test_files:
+- spec/conditional_uniqueness_spec.rb
 - spec/immutable_spec.rb
 - spec/indexable_spec.rb
 - spec/inheritance_spec.rb
 - spec/mandatory_spec.rb
 - spec/models/account.rb
+- spec/models/conditional_uniqueness.rb
 - spec/models/immutable.rb
 - spec/models/indexable.rb
 - spec/models/mandatory.rb