mongoid-multitenancy 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTdmMTA4ODVhMTI1Njk1YzMyMGI3OTA5ZDUxYmNkMDkzMmY3MTE4Nw==
-  data.tar.gz: !binary |-
-    NGY5ZGFlNmJjMjQ5MzhlOWI4M2NhY2FkMGRkZTk0MjQzNmI3ZDY1MQ==
+SHA1:
+  metadata.gz: e0e3e8744c3c18e29194af6955cd8a2fba4562fd
+  data.tar.gz: 6fdadff774736f91927770271e2a28f7e64dd38b
 SHA512:
-  metadata.gz: !binary |-
-    ZDQwNDZmZDc3N2NlYmRiMDJhMzQ0YmVlZDc2NWVmZmY4ZWRkYTY0ZjgzMzVk
-    Yzg1M2I5ZDZkOWM4ZDk1YTJhODk4YWNhNjVkY2I1NTM0MTNjNTRlNDZmNzBi
-    ZTM0NDAzYTM3YmI5NDZhOTI5ODQ4MTEzMGRhNWViOTc0NWZmY2Y=
-  data.tar.gz: !binary |-
-    OTkwYmNkMzIwY2MwNjRhNTIwZTVkNjliNDM0NWZiNzUzNTI3NWQ0YTY3NGZk
-    YjgxYzQ0M2RmZWMzNjYxZGNiNDUzZjNhOTkyNjJlYmU4ZGVlZDA3NmNiZjJi
-    OWFjMzEzYjdjNWY3MTcxZWRjN2JlNzBhMDE5YzVlMzMyOTBhZmU=
+  metadata.gz: 3a8995b28ca405dddb5b9c45f2c505ffa89d6c40ac722137cd9e408310dc43a6ac8d659af3952fcae698b858a5a05c4708430d949b50ec30355f5040be05b7d1
+  data.tar.gz: a9b3e25dd1dcbfb7969f2d0913e04e980db5d2dafc9c3f3dee50a7306505b0d9bab46a730de5f9b6ab5ef4a3461a3d8e556baa328a402eeef3d73a9b9726546d

data/README.md

@@ -157,18 +157,42 @@ end
 Mongoid indexes
 -------------------
 
-mongoid-multitenancy will automatically add the tenant foreign key in all your mongoid indexes to avoid to redefine all your validators.
+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`.
+
+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:
+
+* { 'title_id' => 1, 'client_id' => 1 }
 
 ```ruby
 class Article
   include Mongoid::Document
   include Mongoid::Multitenancy::Document
 
-  tenant(:client)
+  tenant :client, full_indexes: true
+
+  field :title
+
+  index({ :title => 1 })
+end
+```
+
+On the example below, 2 indexes will be created:
+
+* { 'client_id' => 1 }
+* { 'title_id' => 1 }
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :client, index: true
 
   field :title
 
-  index({ :title => 1 }) # => create an index with { :client_id => 1, :title => 1 }
+  index({ :title => 1 })
 end
 ```
 

data/lib/mongoid/multitenancy/document.rb

@@ -4,13 +4,16 @@ module Mongoid
       extend ActiveSupport::Concern
 
       module ClassMethods
-        attr_accessor :tenant_field
+        attr_accessor :tenant_field, :full_indexes
 
-        def tenant(association = :account, options={})
+        def tenant(association = :account, options = {})
+          options = { full_indexes: true }.merge(options)
           active_model_options = options.clone
+          to_index = active_model_options.delete(:index)
           tenant_options = { optional: active_model_options.delete(:optional), immutable: active_model_options.delete(:immutable) { true } }
+          self.full_indexes = active_model_options.delete(:full_indexes)
+
           # Setup the association between the class and the tenant class
-          # TODO: should index this association if no other indexes are defined => , index: true
           belongs_to association, active_model_options
 
           # Get the tenant model and its foreign key
@@ -46,6 +49,10 @@ module Mongoid
             child.tenant association, options
             super(child)
           end
+
+          if to_index
+            index({self.tenant_field => 1}, { background: true })
+          end
         end
 
         # Redefine 'validates_with' to add the tenant scope when using a UniquenessValidator
@@ -64,7 +71,7 @@ module Mongoid
 
         # Redefine 'index' to include the tenant field in first position
         def index(spec, options = nil)
-          spec = { self.tenant_field => 1 }.merge(spec)
+          spec = { self.tenant_field => 1 }.merge(spec) if self.full_indexes
           super(spec, options)
         end
 

data/lib/mongoid/multitenancy/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Multitenancy
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/indexable_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'tenant' do
+
+  let(:client) do
+    Account.create!(:name => "client")
+  end
+
+  before do
+    Mongoid::Multitenancy.current_tenant = client
+  end
+
+  context 'without index: true' do
+    it 'does not create an index' do
+      Immutable.should_not have_index_for(:client_id => 1)
+    end
+  end
+
+  context 'with index: true' do
+    it 'creates an index' do
+      Indexable.should have_index_for(:client_id => 1)
+    end
+  end
+
+  context 'with full_indexes: true' do
+    it 'add the tenant field on each index' do
+      Immutable.should 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
+      Indexable.should_not have_index_for(:client_id => 1, :title => 1)
+    end
+  end
+
+end

data/spec/models/indexable.rb

@@ -0,0 +1,10 @@
+class Indexable
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, :type => String
+
+  tenant :client, class_name: 'Account', index: true, full_indexes: false
+
+  index({ :title => 1 })
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: MultiTenancy with Mongoid
@@ -31,9 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.TXT
 - README.md
@@ -47,10 +47,12 @@ files:
 - lib/mongoid/validators/tenant_validator.rb
 - mongoid-multitenancy.gemspec
 - spec/immutable_spec.rb
+- spec/indexable_spec.rb
 - spec/inheritance_spec.rb
 - spec/mandatory_spec.rb
 - spec/models/account.rb
 - spec/models/immutable.rb
+- spec/models/indexable.rb
 - spec/models/mandatory.rb
 - spec/models/mutable.rb
 - spec/models/mutable_child.rb
@@ -71,26 +73,28 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Support of a multi-tenant database with Mongoid
 test_files:
 - spec/immutable_spec.rb
+- spec/indexable_spec.rb
 - spec/inheritance_spec.rb
 - spec/mandatory_spec.rb
 - spec/models/account.rb
 - spec/models/immutable.rb
+- spec/models/indexable.rb
 - spec/models/mandatory.rb
 - spec/models/mutable.rb
 - spec/models/mutable_child.rb