mongoid-multitenancy 0.1.1 → 0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjY1NTgwNWVlNWJhZWQ5NGI2MjVkZmZlMTY0ZWIyMjUyZDg3ZTdlNw==
+  data.tar.gz: !binary |-
+    YjFhODhkYjZiNTUwZDczYjA3NGZhMTViNDhkY2I3MWU1MTE1ODJhZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2U5YjM5MWE0YWZjMWJiOTc0YzE3YmQ4ZDljNzgwYjc5YzE0YTRhMzczZmUy
+    YzBjMDJmYTNjY2FjMjBiNDljYTRlNDRiYTg1YTM0NjUzOGVmNjJmMjkyYzdh
+    N2NhMDcwMjI4MDc2MjJkOGJhMTEwNTg4ZGMzYTNkMjE2ZmQ4N2Q=
+  data.tar.gz: !binary |-
+    ODMwMDVjOTc4YTFiN2E2ZWQ5ODhlNmM1NTgyYWQ1MmEyMjI0ZTQwZmRlNjhj
+    NTMyY2U2YzE1N2U1MDNhM2I2MjdhMjhmOWRlZGJjM2U1ZWQyOGE0MTM4NmY3
+    NWY2MTdkMjY0M2EyZmY1YmFjZmYzMTk4MDA3MzlkNmEyM2FjYzQ=

data/Gemfile.lock

@@ -1,52 +1,52 @@
 PATH
   remote: .
   specs:
-    mongoid-multitenancy (0.1)
+    mongoid-multitenancy (0.2.0)
       mongoid (~> 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.9)
-      activesupport (= 3.2.9)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activesupport (3.2.9)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     builder (3.0.4)
-    database_cleaner (0.9.1)
-    diff-lcs (1.1.3)
+    database_cleaner (1.0.1)
+    diff-lcs (1.2.4)
     i18n (0.6.1)
-    mongoid (3.0.14)
-      activemodel (~> 3.1)
-      moped (~> 1.1)
+    mongoid (3.1.3)
+      activemodel (~> 3.2)
+      moped (~> 1.4.2)
       origin (~> 1.0)
       tzinfo (~> 0.3.22)
-    mongoid-rspec (1.5.5)
+    mongoid-rspec (1.8.1)
       mongoid (>= 3.0.1)
       rake
       rspec (>= 2.9)
-    moped (1.3.1)
-    multi_json (1.5.0)
-    origin (1.0.11)
-    rake (10.0.3)
+    moped (1.4.5)
+    multi_json (1.7.3)
+    origin (1.1.0)
+    rake (10.0.4)
     redcarpet (2.2.2)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.1)
-    rspec-expectations (2.12.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    tzinfo (0.3.35)
-    yard (0.8.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    tzinfo (0.3.37)
+    yard (0.8.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  database_cleaner (~> 0.9)
+  database_cleaner (~> 1.0)
   mongoid-multitenancy!
   mongoid-rspec (~> 1.5)
   rake (~> 10.0)

data/README.md

@@ -76,6 +76,11 @@ Scoping your models
 Adding `tenant` to your model declaration will scope that model to the current tenant **BUT ONLY if a current tenant has been set**.
 The association passed to the `tenant` function must be valid.
 
+`tenant` accepts several options:
+
+ * :optional : set to true when the tenant can be optional
+ * :class_name, etc. : all the other options will be passed to the mongoid relation
+
 Some examples to illustrate this behavior:
 
     # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
@@ -92,6 +97,12 @@ Some examples to illustrate this behavior:
     article.client = another_client
     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.
+
+    Article.all # => all articles where client_id.in [50ca04b86c82bfc125000025, nil]
+
 Rails
 -------------------
 

data/lib/mongoid/multitenancy/document.rb

@@ -18,29 +18,44 @@ module Mongoid
 
       module ClassMethods
         # Access to the tenant field
-        attr_reader :tenant_field
+        attr_reader :tenant_field, :tenant_options
 
-        def tenant(association = :account)
+        def tenant(association = :account, options={})
+          @tenant_options = { optional: options.delete(:optional) }
           # 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
+          belongs_to association, options
 
           # Get the tenant model and its foreign key
           fkey = reflect_on_association(association).foreign_key
           @tenant_field = fkey
 
           # Validates the presence of the association key
-          validates_presence_of fkey
+          validates_presence_of fkey unless @tenant_options[:optional]
 
           # Set the current_tenant on newly created objects
-          after_initialize lambda { |m| m.send "#{association}=".to_sym, Multitenancy.current_tenant if Multitenancy.current_tenant ; true }
+          after_initialize lambda { |m|
+            if Multitenancy.current_tenant #and !self.class.tenant_options[:optional]
+              m.send "#{association}=".to_sym, Multitenancy.current_tenant
+            end
+            true
+          }
 
           # Rewrite accessors to make tenant foreign_key/association immutable
           validate :check_tenant_immutability, :on => :update
 
           # Set the default_scope to scope to current tenant
           default_scope lambda {
-            where(Multitenancy.current_tenant ? { self.tenant_field => Multitenancy.current_tenant.id } : nil)
+            criteria = if Multitenancy.current_tenant
+              if self.tenant_options[:optional]
+                #any_of({ self.tenant_field => Multitenancy.current_tenant.id }, { self.tenant_field => nil })
+                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
           }
         end
 
@@ -60,7 +75,7 @@ module Mongoid
 
         # Redefine 'delete_all' to take in account the default scope
         def delete_all(conditions = nil)
-          self.where(conditions).delete
+          scoped.where(conditions).delete
         end
       end
     end

data/lib/mongoid/multitenancy/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Multitenancy
-    VERSION = "0.1.1"
+    VERSION = "0.2"
   end
 end

data/mongoid-multitenancy.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rspec', '~> 2.12')
   gem.add_development_dependency('yard', '~> 0.8')
   gem.add_development_dependency('mongoid-rspec', '~> 1.5')
-  gem.add_development_dependency('database_cleaner', '~> 0.9')
+  gem.add_development_dependency('database_cleaner', '~> 1.0')
   gem.add_development_dependency('redcarpet', '~> 2.2')
 end

data/spec/models/{client.rb → account.rb}

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

data/spec/models/article.rb

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

data/spec/models/page.rb

@@ -0,0 +1,15 @@
+class Page
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:client, :class_name => 'Account', :optional => true)
+
+  field :slug, :type => String
+  field :title, :type => String
+
+  validates_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index({ :title => 1 })
+end

data/spec/mongoid-multitenancy_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
 describe Mongoid::Multitenancy do
-  let(:client) { Client.create!(:name => "client") }
-  let(:another_client) { Client.create!(:name => "another client") }
+  let(:client) { Account.create!(:name => "client") }
+  let(:another_client) { Account.create!(:name => "another client") }
 
   before { Mongoid::Multitenancy.current_tenant = client }
   after { Mongoid::Multitenancy.current_tenant = nil }
@@ -21,28 +21,97 @@ describe Mongoid::Multitenancy do
   end
 end
 
-describe Article do
+shared_examples_for "a tenantable model" do
+
   it { should belong_to(:client) }
-  it { should validate_presence_of(:client_id) }
   it { should validate_uniqueness_of(:slug).scoped_to(:client_id) }
   it { should have_index_for(:client_id => 1, :title => 1) }
 
-  let(:client) { Client.create!(:name => "client") }
-  let(:another_client) { Client.create!(:name => "another client") }
+  let(:client) { Account.create!(:name => "client") }
+  let(:another_client) { Account.create!(:name => "another client") }
 
   describe ".initialize" do
     before { Mongoid::Multitenancy.current_tenant = client }
     after { Mongoid::Multitenancy.current_tenant = nil }
 
     it "should set the client field" do
-      Article.new.client.should eq client
+      described_class.new.client.should eq client
+    end
+  end
+
+end
+
+describe Page do
+
+  it_behaves_like "a tenantable model"
+
+  it { should_not validate_presence_of(:client_id) }
+
+  let(:client) { Account.create!(:name => "client") }
+  let(:another_client) { Account.create!(:name => "another client") }
+
+  describe ".default_scope" do
+    before {
+      @itemC = described_class.create!(:title => "title C", :slug => "article-c")
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = described_class.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = described_class.create!(:title => "title Y", :slug => "article-y") }
+    }
+
+    context "with a current tenant" do
+      before { Mongoid::Multitenancy.current_tenant = another_client }
+      after { Mongoid::Multitenancy.current_tenant = nil }
+
+      it "should filter on the current tenant / free-tenant items" do
+        described_class.all.to_a.should =~ [@itemY, @itemC]
+      end
+    end
+
+    context "without a current tenant" do
+      before { Mongoid::Multitenancy.current_tenant = nil }
+
+      it "should not filter on any tenant" do
+        described_class.all.to_a.should =~ [@itemC, @itemX, @itemY]
+      end
     end
   end
 
+  describe "#delete_all" do
+    before {
+      @itemC = described_class.create!(:title => "title C", :slug => "article-c")
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = described_class.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = described_class.create!(:title => "title Y", :slug => "article-y") }
+    }
+
+    context "with a current tenant" do
+      it "should only delete the current tenant / free-tenant items" do
+        Mongoid::Multitenancy.with_tenant(another_client) { described_class.delete_all }
+        described_class.all.to_a.should =~ [@itemX]
+      end
+    end
+
+    context "without a current tenant" do
+      it "should delete all the pages" do
+        described_class.delete_all
+        described_class.all.to_a.should be_empty
+      end
+    end
+  end
+
+end
+
+describe Article do
+
+  it_behaves_like "a tenantable model"
+
+  it { should validate_presence_of(:client_id) }
+
+  let(:client) { Account.create!(:name => "client") }
+  let(:another_client) { Account.create!(:name => "another client") }
+
   describe ".default_scope" do
     before {
-      Mongoid::Multitenancy.with_tenant(client) { @articleX = Article.create!(:title => "title X", :slug => "article-x") }
-      Mongoid::Multitenancy.with_tenant(another_client) { @articleY = Article.create!(:title => "title Y", :slug => "article-y") }
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = described_class.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = described_class.create!(:title => "title Y", :slug => "article-y") }
     }
 
     context "with a current tenant" do
@@ -50,7 +119,7 @@ describe Article do
       after { Mongoid::Multitenancy.current_tenant = nil }
 
       it "should filter on the current tenant" do
-        Article.all.to_a.should == [@articleY]
+        described_class.all.to_a.should =~ [@itemY]
       end
     end
 
@@ -58,7 +127,7 @@ describe Article do
       before { Mongoid::Multitenancy.current_tenant = nil }
 
       it "should not filter on any tenant" do
-        Article.all.to_a.should == [@articleX, @articleY]
+        described_class.all.to_a.should =~ [@itemX, @itemY]
       end
     end
   end
@@ -88,22 +157,23 @@ describe Article do
 
   describe "#delete_all" do
     before {
-      Mongoid::Multitenancy.with_tenant(client) { @articleX = Article.create!(:title => "title X", :slug => "article-x") }
-      Mongoid::Multitenancy.with_tenant(another_client) { @articleY = Article.create!(:title => "title Y", :slug => "article-y") }
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = described_class.create!(:title => "title X", :slug => "article-x") }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = described_class.create!(:title => "title Y", :slug => "article-y") }
     }
 
     context "with a current tenant" do
       it "should only delete the current tenant articles" do
-        Mongoid::Multitenancy.with_tenant(another_client) { Article.delete_all }
-        Article.all.to_a == [@articleX]
+        Mongoid::Multitenancy.with_tenant(another_client) { described_class.delete_all }
+        described_class.all.to_a.should =~ [@itemX]
       end
     end
 
     context "without a current tenant" do
       it "should delete all the articles" do
-        Article.delete_all
-        Article.all.to_a.should be_empty
+        described_class.delete_all
+        described_class.all.to_a.should be_empty
       end
     end
   end
+
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: '0.2'
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,23 +83,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,37 +127,38 @@ files:
 - lib/mongoid/multitenancy/document.rb
 - lib/mongoid/multitenancy/version.rb
 - mongoid-multitenancy.gemspec
+- spec/models/account.rb
 - spec/models/article.rb
-- spec/models/client.rb
+- spec/models/page.rb
 - spec/mongoid-multitenancy_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/PerfectMemory/mongoid-multitenancy
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Support of a multi-tenant database with Mongoid
 test_files:
+- spec/models/account.rb
 - spec/models/article.rb
-- spec/models/client.rb
+- spec/models/page.rb
 - spec/mongoid-multitenancy_spec.rb
 - spec/spec_helper.rb
 has_rdoc: