mongoid-multitenancy 0.4.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a20d8d26c776318f1eb6407d0dc19017a721cdb
-  data.tar.gz: 1404d16b8b568ebf9a7744ce7f6fa5c5338fa91b
+  metadata.gz: 95438e3e7adc7dc21d06a0deec16979183b37738
+  data.tar.gz: 61ce79abafb106d53af8dbf35c74523a04b43a31
 SHA512:
-  metadata.gz: bed65acf48172bfaac61012ebdb5bc67bb73e96500835273e7ef45743cc7e77bddd5a32ed4b2ed52f11441e735f484311d1a192047a2b594c11b07e4ba4e1dce
-  data.tar.gz: 1271fa93a141b513d1d5587b6d4bd7ce4c0b294635d243292f35cc62cfe60349abe78b499ba689bc7913868746cb1ee6a91400d4a5ecf7bb0e1a691bf196db5c
+  metadata.gz: 58cf2892dd86cd822f1fc436e745e53ffd128680164226323e5e32ac328bd14db877cd990ea29e01db130e4155b205a1de1a9b6cd040c7bc0381d1dfd89dc72a
+  data.tar.gz: 3ac676cd7c0df46eb10a703967f9375d51674f6a61f3a8ae637ea8cd7562b6361905def86aa52269af8dfcdfc1cbd29a9e4ea2eee8665ff35a1341207247d7fa

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--order random

data/.travis.yml

@@ -1,14 +1,15 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - ruby-head
   - jruby
   - jruby-head
 gemfile:
-  - gemfiles/Gemfile.mongoid-3.0
   - gemfiles/Gemfile.mongoid-4.0
+  - gemfiles/Gemfile.mongoid-5.0
   - Gemfile
 services:
-  - mongodb
+  - mongodb
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 1.0.0
+
+### New Features
+
+* Adds support for mongoid 5
+
+### Major Changes (Backwards Incompatible)
+
+* Drops support for mongoid 3
+
+* An optional tenant is now automatically set if a current tenant is defined.
+
+* A unique constraint with an optional tenant now uses the client scoping. An item cannot be shared if another client item has the same value.

data/Gemfile

@@ -1,15 +1,15 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 4.0'
+gem 'mongoid', '~> 5.0'
 
 gem 'rake', '~> 10.0'
 
 group :test do
-  gem 'coveralls', :require => false
-  gem 'rspec', '~> 2.12'
+  gem 'coveralls', require: false
+  gem 'rspec', '~> 3.1'
   gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 1.5'
-  gem 'database_cleaner', '~> 1.0'
+  gem 'mongoid-rspec', '~> 3.0'
+  gem 'rubocop', require: false
 end
 
 # Specify your gem's dependencies in mongoid-multitenancy.gemspec

data/README.md

@@ -1,16 +1,16 @@
-# mongoid-multitenancy [![Build Status](https://travis-ci.org/PerfectMemory/mongoid-multitenancy.png?branch=master)](https://travis-ci.org/PerfectMemory/mongoid-multitenancy.png?branch=master) [![Coverage Status](https://coveralls.io/repos/PerfectMemory/mongoid-multitenancy/badge.png?branch=master)](https://coveralls.io/r/PerfectMemory/mongoid-multitenancy) [![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://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 all 'tenant models' are always properly scoped to the current tenant: when viewing, searching and creating.
+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.
 
 It is directly inspired by the [acts_as_tenant gem](https://github.com/ErwinM/acts_as_tenant) for Active Record.
 
 In addition, mongoid-multitenancy:
 
 * allows you to set the current tenant
-* redefines some mongoid functions like `index`, `validates_with` and `delete_all` to take in account the multitenancy
 * allows shared items between the tenants
 * allows you to define an immutable tenant field once it is persisted
-* is thread safe.
+* is thread safe
+* redefines some mongoid functions like `index`, `validates_with` and `delete_all` to take in account the multitenancy.
 
 Installation
 ===============
@@ -30,7 +30,7 @@ Or install it yourself as:
 Usage
 ===============
 
-There are two steps in adding multi-tenancy to your app with acts_as_tenant:
+There are two steps to add multi-tenancy to your app with mongoid-multitenancy:
 
 1. setting the current tenant and
 2. scoping your models.
@@ -87,7 +87,8 @@ The association passed to the `tenant` function must be valid.
 
  * :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`)
- * :class_name, etc. : all the other options will be passed to the mongoid relation
+ * :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)
 
 Some examples to illustrate this behavior:
 
@@ -110,7 +111,9 @@ article.valid? # => false
 
 **Optional tenant**
 
-When setting an optional tenant, for example to allow shared instances between all the tenants, the default scope will return both the tenant and the free-tenant items. That means that using `Article.delete_all` or `Article.destroy_all` will **remove the shared items too**. And that means too that **the tenant must be set manually**.
+When setting an optional tenant, for example to allow shared instances between all the tenants, the default scope will return both the tenant and the free-tenant items. That means that using `Article.delete_all` or `Article.destroy_all` will **remove the shared items too**.
+
+Note: if a current tenant is set and you want to mark the item shared, you must explicitly set the tenant relation to nil after the initialization.
 
 ```ruby
 class Article
@@ -125,11 +128,13 @@ end
 Mongoid::Multitenancy.with_tenant(client_instance) do
   Article.all # => all articles where client_id.in [50ca04b86c82bfc125000025, nil]
   article = Article.new(:title => 'New article')
-  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: nil>
+  article.save # => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: 50ca04b86c82bfc125000025>
 
-  # tenant needs to be set manually
-  article.tenant = client_instance
-  article.save => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_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.tenant = nil
+  article.save => <#Article _id: 50ca04b86c82bfc125000044, title: 'New blog', client_id: nil>
 end
 ```
 
@@ -156,19 +161,43 @@ Setting the current_tenant yourself requires you to use a before_filter to set t
 Mongoid Uniqueness validators
 -------------------
 
-mongoid-multitenancy will automatically add the tenant foreign key in the scope list for each of uniqueness validators in order
-to avoid to redefine all your validators.
+mongoid-multitenancy brings a TenantUniqueness validator that will, depending on the tenant options, check that your uniqueness
+constraints are respected:
+
+* When used with a *mandatory* tenant, the uniqueness constraint is scoped to the current client.
+
+In the following case, 2 articles can have the same slug if they belongs to 2 different clients.
 
 ```ruby
 class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client)
+  tenant :client
+
+  field :slug
+
+  validates_tenant_uniqueness_of :slug
+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.
+
+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.
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :client, optional: true
 
   field :slug
 
-  validates_uniqueness_of :slug # => :scope => client_id is added automatically
+  validates_tenant_uniqueness_of :slug
 end
 ```
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'yard'
 YARD::Rake::YardocTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/Gemfile.mongoid-4.0

@@ -1,15 +1,14 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 4.0.alpha'
+gem 'mongoid', '~> 4.0'
 
 gem 'rake', '~> 10.0'
 
 group :test do
   gem 'coveralls', :require => false
-  gem 'rspec', '~> 2.12'
+  gem 'rspec', '~> 3.1'
   gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 1.5'
-  gem 'database_cleaner', '~> 1.0'
+  gem 'mongoid-rspec', '~> 2.1'
 end
 
 # Specify your gem's dependencies in mongoid-multitenancy.gemspec

data/gemfiles/{Gemfile.mongoid-3.0 → Gemfile.mongoid-5.0}

@@ -1,15 +1,14 @@
 source 'https://rubygems.org'
 
-gem 'mongoid', '~> 3.0'
+gem 'mongoid', '~> 5.0'
 
 gem 'rake', '~> 10.0'
 
 group :test do
   gem 'coveralls', :require => false
-  gem 'rspec', '~> 2.12'
+  gem 'rspec', '~> 3.1'
   gem 'yard', '~> 0.8'
-  gem 'mongoid-rspec', '~> 1.5'
-  gem 'database_cleaner', '~> 1.0'
+  gem 'mongoid-rspec', '~> 3.0'
 end
 
 # Specify your gem's dependencies in mongoid-multitenancy.gemspec

data/lib/mongoid/multitenancy.rb

@@ -1,17 +1,13 @@
-require "mongoid"
-require "mongoid/multitenancy/document"
-require "mongoid/multitenancy/version"
-require "mongoid/validators/tenant_validator"
+require 'mongoid'
+require 'mongoid/multitenancy/document'
+require 'mongoid/multitenancy/version'
+require 'mongoid/multitenancy/validators/tenancy'
+require 'mongoid/multitenancy/validators/tenant_uniqueness'
 
 module Mongoid
   module Multitenancy
     class << self
 
-      # Returns true if using Mongoid 4
-      def mongoid4?
-        Mongoid::VERSION.start_with? '4'
-      end
-
       # Set the current tenant. Make it Thread aware
       def current_tenant=(tenant)
         Thread.current[:current_tenant] = tenant
@@ -25,7 +21,7 @@ module Mongoid
       # Affects a tenant temporary for a block execution
       def with_tenant(tenant, &block)
         if block.nil?
-          raise ArgumentError, "block required"
+          raise ArgumentError, 'block required'
         end
 
         old_tenant = self.current_tenant

data/lib/mongoid/multitenancy/document.rb

@@ -6,64 +6,88 @@ module Mongoid
       module ClassMethods
         attr_accessor :tenant_field, :tenant_options
 
+        # List of authorized options
         MULTITENANCY_OPTIONS = [:optional, :immutable, :full_indexes, :index]
 
+        # Defines the tenant field for the document.
+        #
+        # @example Define a tenant.
+        #   tenant :client, optional: false, immutable: true, full_indexes: true
+        #
+        # @param [ Symbol ] name The name of the relation.
+        # @param [ Hash ] options The relation options.
+        #   All the belongs_to options are allowed plus the following ones:
+        #
+        # @option options [ Boolean ] :full_indexes If true the tenant field
+        #   will be added for each index.
+        # @option options [ Boolean ] :immutable If true changing the tenant
+        #   wil raise an Exception.
+        # @option options [ Boolean ] :optional If true allow the document
+        #   to be shared among all the tenants.
+        #
+        # @return [ Field ] The generated field
         def tenant(association = :account, options = {})
-          options = { full_indexes: true, immutable: true }.merge(options)
+          options = { full_indexes: true, immutable: true }.merge!(options)
+          assoc_options, multitenant_options = build_options(options)
 
           # Setup the association between the class and the tenant class
-          belongs_to association, extract_association_options(options)
+          belongs_to association, assoc_options
 
           # Get the tenant model and its foreign key
           self.tenant_field = reflect_on_association(association).foreign_key
-          self.tenant_options = extract_tenant_options(options)
+          self.tenant_options = multitenant_options
 
           # Validates the tenant field
-          validates tenant_field, tenant: options
+          validates_tenancy_of tenant_field, multitenant_options
 
-          # Set the default_scope to scope to current tenant
-          default_scope lambda {
-            if Multitenancy.current_tenant
-              if options[:optional]
-                where(self.tenant_field.to_sym.in => [Multitenancy.current_tenant.id, nil])
-              else
-                where(self.tenant_field => Multitenancy.current_tenant.id)
-              end
-            else
-              where(nil)
-            end
-          }
-
-          self.define_singleton_method(:inherited) do |child|
-            child.tenant association, options
-            super(child)
-          end
-
-          if options[:index]
-            index({self.tenant_field => 1}, { background: true })
-          end
+          define_default_scope
+          define_initializer association
+          define_inherited association, options
+          define_index if multitenant_options[:index]
         end
 
-        # Redefine 'validates_with' to add the tenant scope when using a UniquenessValidator
-        def validates_with(*args, &block)
-          if !self.tenant_options[:optional]
-            validator = if Mongoid::Multitenancy.mongoid4?
-              Validatable::UniquenessValidator
-            else
-              Validations::UniquenessValidator
-            end
-
-            if args.first.ancestors.include?(validator)
-              args.last[:scope] = Array(args.last[:scope]) << self.tenant_field
-            end
-          end
+        # Validates whether or not a field is unique against the documents in the
+        # database.
+        #
+        # @example
+        #
+        #   class Person
+        #     include Mongoid::Document
+        #     include Mongoid::Multitenancy::Document
+        #     field :title
+        #
+        #     validates_tenant_uniqueness_of :title
+        #   end
+        #
+        # @param [ Array ] *args The arguments to pass to the validator.
+        def validates_tenant_uniqueness_of(*args)
+          validates_with(TenantUniquenessValidator, _merge_attributes(args))
+        end
 
-          super(*args, &block)
+        # Validates whether or not a tenant field is correct.
+        #
+        # @example Define the tenant validator
+        #
+        #   class Person
+        #     include Mongoid::Document
+        #     include Mongoid::Multitenancy::Document
+        #     field :title
+        #     tenant :client
+        #
+        #     validates_tenant_of :client
+        #   end
+        #
+        # @param [ Array ] *args The arguments to pass to the validator.
+        def validates_tenancy_of(*args)
+          validates_with(TenancyValidator, _merge_attributes(args))
         end
 
         # Redefine 'index' to include the tenant field in first position
         def index(spec, options = nil)
-          spec = { self.tenant_field => 1 }.merge(spec) if self.tenant_options[:full_indexes]
+          if tenant_options[:full_indexes]
+            spec = { tenant_field => 1 }.merge(spec)
+          end
+
           super(spec, options)
         end
 
@@ -74,24 +98,68 @@ module Mongoid
 
         private
 
-        def extract_association_options(options)
-          new_options = {}
+        # @private
+        def build_options(options)
+          assoc_options = {}
+          multitenant_options = {}
 
           options.each do |k, v|
-            new_options[k] = v unless MULTITENANCY_OPTIONS.include?(k)
+            if MULTITENANCY_OPTIONS.include?(k)
+              multitenant_options[k] = v
+            else
+              assoc_options[k] = v
+            end
           end
 
-          new_options
+          [assoc_options, multitenant_options]
         end
 
-        def extract_tenant_options(options)
-          new_options = {}
+        # @private
+        #
+        # Define the after_initialize
+        def define_initializer(association)
+          # Apply the default value when the default scope is complex (optional tenant)
+          after_initialize lambda {
+            if Multitenancy.current_tenant && send(association.to_sym).nil?
+              send "#{association}=".to_sym, Multitenancy.current_tenant
+            end
+          }
+        end
 
-          options.each do |k, v|
-            new_options[k] = v if MULTITENANCY_OPTIONS.include?(k)
+        # @private
+        #
+        # Define the inherited method
+        def define_inherited(association, options)
+          define_singleton_method(:inherited) do |child|
+            child.tenant association, options
+            super(child)
           end
+        end
+
+        # @private
+        #
+        # Set the default scope
+        def define_default_scope
+          # Set the default_scope to scope to current tenant
+          default_scope lambda {
+            if Multitenancy.current_tenant
+              tenant_id = Multitenancy.current_tenant.id
+              if tenant_options[:optional]
+                where(tenant_field.to_sym.in => [tenant_id, nil])
+              else
+                where(tenant_field => tenant_id)
+              end
+            else
+              where(nil)
+            end
+          }
+        end
 
-          new_options
+        # @private
+        #
+        # Create the index
+        def define_index
+          index({ tenant_field => 1 }, background: true)
         end
       end
     end