mongoid-multitenancy 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30fa52034535ce4524481877d5b9e048e1eeeaa5
-  data.tar.gz: 533f4f95ecb750443629027cac6d0dd9edc6bb73
+  metadata.gz: bc62ee7dad2407f285292511b1a3ff9487b2f658
+  data.tar.gz: de93ec4f6f8182bd4307c9cc865b585f215d9a68
 SHA512:
-  metadata.gz: efb3239aa595fe974954364f1b8b7cf2b0bb061d87dac50166294f54a219ed97b68504deead534086576016e840d38b125612a64d12a429d3b37c19ef90deb6a
-  data.tar.gz: f3a64574e2ef09ade685ab061806bd37885286ead3efe20d884887d14e42ab748e712a1635b9fc2724aa6bb520d614684e70b973bf4952b2866bad396e2125fd
+  metadata.gz: 1bbfd25a05be1f5bb1a873fa53f42df8546b6cc24a568b846500d6b8e429df9ebb6781e21fdac50b91f34f95a415f0c8a83dd9de0017e0d86919828c215b13b2
+  data.tar.gz: 747a8e3b7e5cc1ee8daaa5713a3e39f82978a27c10e0dac8bc4b7ef94eb38b561c982c8349252a6265b2dee08fc0981a796ff9149776c02f080687f9479f6274

data/Gemfile

@@ -1,11 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 5.0'
+gem 'mongoid', '~> 5.1'
 
-gem 'rake', '~> 10.0'
+gem 'rake', '~> 11.0'
 
 group :test do
-  gem 'database_cleaner', github: 'DatabaseCleaner/database_cleaner', ref: '1cab518'
+  gem 'database_cleaner'
   gem 'coveralls', require: false
   gem 'rspec', '~> 3.1'
   gem 'yard', '~> 0.8'

data/README.md

@@ -1,4 +1,4 @@
-# mongoid-multitenancy [![Build Status](https://travis-ci.org/PerfectMemory/mongoid-multitenancy.png?branch=master)](https://travis-ci.org/PerfectMemory/mongoid-multitenancy) [![Coverage Status](https://coveralls.io/repos/PerfectMemory/mongoid-multitenancy/badge.svg?branch=master&service=github)](https://coveralls.io/github/PerfectMemory/mongoid-multitenancy?branch=master) [![Code Climate](https://codeclimate.com/github/PerfectMemory/mongoid-multitenancy.png)](https://codeclimate.com/github/PerfectMemory/mongoid-multitenancy) [![Dependency Status](https://gemnasium.com/PerfectMemory/mongoid-multitenancy.png)](https://gemnasium.com/PerfectMemory/mongoid-multitenancy)
+# mongoid-multitenancy [![Build Status](https://api.travis-ci.org/PerfectMemory/mongoid-multitenancy.png?branch=master)](https://travis-ci.org/PerfectMemory/mongoid-multitenancy) [![Coverage Status](https://coveralls.io/repos/PerfectMemory/mongoid-multitenancy/badge.svg?branch=master&service=github)](https://coveralls.io/github/PerfectMemory/mongoid-multitenancy?branch=master) [![Code Climate](https://codeclimate.com/github/PerfectMemory/mongoid-multitenancy.png)](https://codeclimate.com/github/PerfectMemory/mongoid-multitenancy) [![Dependency Status](https://gemnasium.com/PerfectMemory/mongoid-multitenancy.png)](https://gemnasium.com/PerfectMemory/mongoid-multitenancy)
 
 mongoid-multitenancy adds the ability to scope [Mongoid](https://github.com/mongoid/mongoid) models to a tenant in a **shared database strategy**. Tenants are represented by a tenant model, such as `Client`. mongoid-multitenancy will help you set the current tenant on each request and ensures that all 'tenant models' are always properly scoped to the current tenant: when viewing, searching and creating.
 
@@ -85,10 +85,14 @@ The association passed to the `tenant` function must be valid.
 
 `tenant` accepts several options:
 
- * :optional : set to true when the tenant is optional (default value is `false`)
- * :immutable : set to true when the tenant field is immutable (default value is `true`)
- * :full_indexes : set to true to add the tenant field automatically to all the indexes (default value is `true`)
- * :class_name, etc. : all the other options will be passed to the mongoid relation (belongs_to)
+| Option  | Default | Description |
+| ------------- | ------------- | ------------- |
+| :optional  | false  | set to true when the tenant is optional |
+| :immutable  | true  | set to true when the tenant field is immutable |
+| :full_indexes  | true  | set to true to add the tenant field automatically to all the indexes |
+| :index  | false  | set to true to define an index for the tenant field |
+| :scopes  | true  | set to true to define scopes :shared and :unshared |
+| :class_name, etc. |   | all the other options will be passed to the mongoid relation (belongs_to) |
 
 Some examples to illustrate this behavior:
 
@@ -181,12 +185,12 @@ class Article
 end
 ```
 
-* When used with an *optional* tenant, the uniqueness constraint is not scoped if the item is shared, but is
-  scoped to the client new item otherwise. Note that a private item cannot have the the value if a shared item
-  already uses it.
+* When used with an *optional* tenant, the uniqueness constraint by default is not scoped if the item is shared, but is
+  scoped to the client new item otherwise. Note that by default in that case a private item cannot have a value if a shared item
+  already uses it. You can change that behaviour by setting the option `exclude_shared` to `true`.
 
 In the following case, 2 private articles can have the same slug if they belongs to 2 different clients. But if a shared
-article has the slug "slugA", no client will be able to use that slug again, like a standard validates_uniqueness_of does.
+article has the slug "slugA", no client will be able to use that slug again, like a standard `validates_uniqueness_of` does.
 
 ```ruby
 class Article
@@ -201,6 +205,22 @@ class Article
 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.
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :client, optional: true
+
+  field :slug
+
+  validates_tenant_uniqueness_of :slug, exclude_shared: true
+end
+```
+
 Mongoid indexes
 -------------------
 

data/gemfiles/Gemfile.mongoid-4.0

@@ -2,14 +2,15 @@ source 'https://rubygems.org'
 
 gem 'mongoid', '~> 4.0'
 
-gem 'rake', '~> 10.0'
+gem 'rake', '~> 11.0'
 
 group :test do
-  gem 'database_cleaner', github: 'DatabaseCleaner/database_cleaner', ref: '1cab518'
-  gem 'coveralls', :require => false
+  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

data/gemfiles/Gemfile.mongoid-5.0

@@ -1,15 +1,16 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 5.0'
+gem 'mongoid', '~> 5.1'
 
-gem 'rake', '~> 10.0'
+gem 'rake', '~> 11.0'
 
 group :test do
-  gem 'database_cleaner', github: 'DatabaseCleaner/database_cleaner', ref: '1cab518'
-  gem 'coveralls', :require => false
+  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

data/lib/mongoid/multitenancy/document.rb

@@ -7,7 +7,7 @@ module Mongoid
         attr_accessor :tenant_field, :tenant_options
 
         # List of authorized options
-        MULTITENANCY_OPTIONS = [:optional, :immutable, :full_indexes, :index]
+        MULTITENANCY_OPTIONS = [:optional, :immutable, :full_indexes, :index, :scopes].freeze
 
         # Defines the tenant field for the document.
         #
@@ -24,10 +24,13 @@ module Mongoid
         #   wil raise an Exception.
         # @option options [ Boolean ] :optional If true allow the document
         #   to be shared among all the tenants.
-        #
+        # @option options [ Boolean ] :index If true build an index for
+        #   the tenant field itself.
+        # @option options [ Boolean ] :scopes If true create scopes :shared
+        #   and :unshared.
         # @return [ Field ] The generated field
         def tenant(association = :account, options = {})
-          options = { full_indexes: true, immutable: true }.merge!(options)
+          options = { full_indexes: true, immutable: true, scopes: true }.merge!(options)
           assoc_options, multitenant_options = build_options(options)
 
           # Setup the association between the class and the tenant class
@@ -40,7 +43,7 @@ module Mongoid
           # Validates the tenant field
           validates_tenancy_of tenant_field, multitenant_options
 
-          define_scopes
+          define_scopes if multitenant_options[:scopes]
           define_initializer association
           define_inherited association, options
           define_index if multitenant_options[:index]
@@ -131,7 +134,7 @@ module Mongoid
         # Define the inherited method
         def define_inherited(association, options)
           define_singleton_method(:inherited) do |child|
-            child.tenant association, options
+            child.tenant association, options.merge(scopes: false)
             super(child)
           end
         end

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

@@ -16,18 +16,18 @@ module Mongoid
       def validate_each(object, attribute, value)
         # Immutable Check
         if options[:immutable]
-          if object.send(:attribute_changed?, attribute) and object.send(:attribute_was, attribute)
+          if object.send(:attribute_changed?, attribute) && object.send(:attribute_was, attribute)
             object.errors.add(attribute, 'is immutable and cannot be updated')
           end
         end
 
         # Ownership check
-        if value and Mongoid::Multitenancy.current_tenant and value != Mongoid::Multitenancy.current_tenant.id
-          object.errors.add(attribute, "not authorized")
+        if value && Mongoid::Multitenancy.current_tenant && value != Mongoid::Multitenancy.current_tenant.id
+          object.errors.add(attribute, 'not authorized')
         end
 
         # Optional Check
-        if !options[:optional] and value.nil?
+        if !options[:optional] && value.nil?
           object.errors.add(attribute, 'is mandatory')
         end
       end

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

@@ -58,8 +58,8 @@ module Mongoid
         name = document.database_field_name(item)
         tenant_value = document.attributes[name]
 
-        if document.class.tenant_options[:optional]
-          if document.attributes[name]
+        if document.class.tenant_options[:optional] && !options[:exclude_shared]
+          if tenant_value
             criteria = criteria.where(:"#{item}".in => [tenant_value, nil])
           end
         else

data/lib/mongoid/multitenancy/version.rb

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

data/lib/mongoid/multitenancy.rb

@@ -7,7 +7,6 @@ require 'mongoid/multitenancy/validators/tenant_uniqueness'
 module Mongoid
   module Multitenancy
     class << self
-
       # Set the current tenant. Make it Thread aware
       def current_tenant=(tenant)
         Thread.current[:current_tenant] = tenant
@@ -22,9 +21,9 @@ module Mongoid
       def with_tenant(tenant, &block)
         raise ArgumentError, 'block required' if block.nil?
 
-        old_tenant = self.current_tenant
+        old_tenant = current_tenant
         self.current_tenant = tenant
-        result = block.call
+        result = yield
         self.current_tenant = old_tenant
         result
       end

data/mongoid-multitenancy.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Support of a multi-tenant database with Mongoid'
   gem.homepage      = 'https://github.com/PerfectMemory/mongoid-multitenancy'
   gem.license       = 'MIT'
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'mongoid-multitenancy'
   gem.require_paths = ['lib']

data/spec/indexable_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'tenant' do
-
   let(:client) do
     Account.create!(name: 'client')
   end
@@ -12,26 +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(client_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(client_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(client_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(client_id: 1, title: 1)
     end
   end
-
 end

data/spec/mandatory_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Mandatory do
-
   let(:client) do
     Account.create!(name: 'client')
   end
@@ -17,6 +16,18 @@ describe Mandatory do
   it_behaves_like 'a tenantable model'
   it { is_expected.to validate_tenant_uniqueness_of(:slug) }
 
+  describe '.shared' do
+    it 'is defined' do
+      expect(Mandatory).to respond_to(:shared)
+    end
+  end
+
+  describe '.unshared' do
+    it 'is defined' do
+      expect(Mandatory).to respond_to(:unshared)
+    end
+  end
+
   describe '.default_scope' do
     before do
       Mongoid::Multitenancy.with_tenant(client) { @itemX = Mandatory.create!(title: 'title X', slug: 'article-x') }

data/spec/models/account.rb

@@ -1,5 +1,5 @@
 class Account
   include Mongoid::Document
 
-  field :name, :type => String
+  field :name, type: String
 end

data/spec/models/immutable.rb

@@ -4,12 +4,12 @@ class Immutable
 
   tenant(:client, class_name: 'Account', immutable: true)
 
-  field :slug, :type => String
-  field :title, :type => String
+  field :slug, type: String
+  field :title, type: String
 
   validates_tenant_uniqueness_of :slug
   validates_presence_of :slug
   validates_presence_of :title
 
-  index({ title: 1 })
+  index(title: 1)
 end

data/spec/models/indexable.rb

@@ -6,5 +6,5 @@ class Indexable
 
   tenant :client, class_name: 'Account', index: true, full_indexes: false
 
-  index({ title: 1 })
+  index(title: 1)
 end

data/spec/models/mandatory.rb

@@ -5,11 +5,11 @@ class Mandatory
   tenant(:client, class_name: 'Account')
 
   field :slug, type: String
-  field :title, type:String
+  field :title, type: String
 
   validates_tenant_uniqueness_of :slug
   validates_presence_of :slug
   validates_presence_of :title
 
-  index({ title: 1 })
+  index(title: 1)
 end

data/spec/models/mutable.rb

@@ -4,12 +4,12 @@ class Mutable
 
   tenant :client, class_name: 'Account', immutable: false, optional: false
 
-  field :slug, :type => String
-  field :title, :type => String
+  field :slug, type: String
+  field :title, type: String
 
   validates_tenant_uniqueness_of :slug
   validates_presence_of :slug
   validates_presence_of :title
 
-  index({ title: 1 })
+  index(title: 1)
 end

data/spec/models/mutable_child.rb

@@ -1,9 +1,9 @@
 require 'models/mutable'
 
 class MutableChild < Mutable
-	field :random, type: String
+  field :random, type: String
 end
 
 class AnotherMutableChild < Mutable
-	field :random, type: String
-end
+  field :random, type: String
+end

data/spec/models/no_scopable.rb

@@ -0,0 +1,11 @@
+class NoScopable
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :client, class_name: 'Account', scopes: false
+
+  field :slug, type: String
+  field :title, type: String
+
+  index(title: 1)
+end

data/spec/models/optional.rb

@@ -11,5 +11,5 @@ class Optional
   validates_presence_of :slug
   validates_presence_of :title
 
-  index({ title: 1 })
+  index(title: 1)
 end

data/spec/models/optional_exclude.rb

@@ -0,0 +1,15 @@
+class OptionalExclude
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:client, class_name: 'Account', optional: true)
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug, exclude_shared: true
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/mongoid-multitenancy_spec.rb

@@ -21,7 +21,7 @@ describe Mongoid::Multitenancy do
     end
 
     it 'restores the current tenant after the block' do
-      Mongoid::Multitenancy.with_tenant(another_client) do ; end
+      Mongoid::Multitenancy.with_tenant(another_client) { ; }
       expect(Mongoid::Multitenancy.current_tenant).to eq client
     end
   end

data/spec/mutable_child_spec.rb

@@ -43,5 +43,4 @@ describe MutableChild do
       end
     end
   end
-
 end

data/spec/optional_exclude_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe OptionalExclude do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  let(:item) do
+    OptionalExclude.new(title: 'title X', 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 uniqueness constraint' do
+        let(:duplicate) do
+          OptionalExclude.new(title: 'title Y', slug: 'page-x')
+        end
+
+        before do
+          item.save!
+        end
+
+        it 'does not allow duplicates on the same tenant' do
+          expect(duplicate).not_to be_valid
+        end
+
+        it 'allow duplicates on a different same tenant' do
+          Mongoid::Multitenancy.with_tenant(another_client) do
+            expect(duplicate).to be_valid
+          end
+        end
+      end
+    end
+
+    context 'without a tenant' do
+      it 'is valid' do
+        expect(item).to be_valid
+      end
+
+      context 'with a uniqueness constraint' do
+        let(:duplicate) do
+          OptionalExclude.new(title: 'title Y', slug: 'page-x')
+        end
+
+        before do
+          item.save!
+        end
+
+        it 'allow duplicates on any client' do
+          Mongoid::Multitenancy.with_tenant(client) do
+            expect(duplicate).to be_valid
+          end
+        end
+      end
+    end
+  end
+end

data/spec/optional_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Optional do
-
   let(:client) do
     Account.create!(name: 'client')
   end

data/spec/scopable_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe NoScopable do
+  it_behaves_like 'a tenantable model' do
+    let(:client) do
+      Account.create!(name: 'client')
+    end
+
+    let(:another_client) do
+      Account.create!(name: 'another client')
+    end
+
+    let(:item) do
+      NoScopable.new(title: 'title X', slug: 'page-x')
+    end
+  end
+
+  describe '.shared' do
+    it 'is not defined' do
+      expect(NoScopable).not_to respond_to(:shared)
+    end
+  end
+
+  describe '.unshared' do
+    it 'is not defined' do
+      expect(NoScopable).not_to respond_to(:unshared)
+    end
+  end
+end

data/spec/support/shared_examples.rb

@@ -1,5 +1,4 @@
 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) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -58,11 +58,15 @@ files:
 - spec/models/mandatory.rb
 - spec/models/mutable.rb
 - spec/models/mutable_child.rb
+- spec/models/no_scopable.rb
 - spec/models/optional.rb
+- spec/models/optional_exclude.rb
 - spec/mongoid-multitenancy_spec.rb
 - spec/mutable_child_spec.rb
 - spec/mutable_spec.rb
+- spec/optional_exclude_spec.rb
 - spec/optional_spec.rb
+- spec/scopable_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid_matchers.rb
 - spec/support/shared_examples.rb
@@ -86,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Support of a multi-tenant database with Mongoid
@@ -101,11 +105,15 @@ test_files:
 - spec/models/mandatory.rb
 - spec/models/mutable.rb
 - spec/models/mutable_child.rb
+- spec/models/no_scopable.rb
 - spec/models/optional.rb
+- spec/models/optional_exclude.rb
 - spec/mongoid-multitenancy_spec.rb
 - spec/mutable_child_spec.rb
 - spec/mutable_spec.rb
+- spec/optional_exclude_spec.rb
 - spec/optional_spec.rb
+- spec/scopable_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid_matchers.rb
 - spec/support/shared_examples.rb