mongoid-multitenancy 0.2 → 0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjY1NTgwNWVlNWJhZWQ5NGI2MjVkZmZlMTY0ZWIyMjUyZDg3ZTdlNw==
+    Njk4YWRlMTZhYzljNjc2ZjBiNjQwYWY1YmQ4NjAzMWM2OTIzZGExYw==
   data.tar.gz: !binary |-
-    YjFhODhkYjZiNTUwZDczYjA3NGZhMTViNDhkY2I3MWU1MTE1ODJhZA==
+    NjcwYzEwZDNiYTlhODBiMWExNjY5MGVjOWI3ZTQ5MmQwM2Q2OWNiMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    M2U5YjM5MWE0YWZjMWJiOTc0YzE3YmQ4ZDljNzgwYjc5YzE0YTRhMzczZmUy
-    YzBjMDJmYTNjY2FjMjBiNDljYTRlNDRiYTg1YTM0NjUzOGVmNjJmMjkyYzdh
-    N2NhMDcwMjI4MDc2MjJkOGJhMTEwNTg4ZGMzYTNkMjE2ZmQ4N2Q=
+    NzFmNjU1ODg0MzE0YzE4ODE0YTViODVhMGEzZWMyOGViZjBkNTg5MDg4ZWU4
+    M2ViY2MxMzE0YmU1MDY5NTAxNGQxN2NiOTJkNjg2NzM2ODA0ODMyYjJjYWM4
+    NmMyY2NjMzljMGJlY2VkNzMyYzA3OTJmYzk2NTY1ODhjOTllZWM=
   data.tar.gz: !binary |-
-    ODMwMDVjOTc4YTFiN2E2ZWQ5ODhlNmM1NTgyYWQ1MmEyMjI0ZTQwZmRlNjhj
-    NTMyY2U2YzE1N2U1MDNhM2I2MjdhMjhmOWRlZGJjM2U1ZWQyOGE0MTM4NmY3
-    NWY2MTdkMjY0M2EyZmY1YmFjZmYzMTk4MDA3MzlkNmEyM2FjYzQ=
+    M2RiMmYxZGU5NWE5MGZjNzkxZTljNjU1ZjVjM2U1ZGM2Yzg3ZmRkYjhkYTBh
+    YzZkZTYyMjJjYjRmZWUwOTdmNGU2M2U2NTVmMjY5MTJjODE4Mzg1NmIzMDA4
+    YTQzZWZjMTAyYzAwYWExZWQ1NGNhODFlOGQ1NTExOTBiYzQzZmE=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-multitenancy (0.2.0)
+    mongoid-multitenancy (0.3)
       mongoid (~> 3)
 
 GEM

data/README.md

@@ -8,7 +8,8 @@ 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
-* makes the tenant field immutable once it is persisted
+* allows shared items between the tenants
+* allows you to define an immutable tenant field once it is persisted
 * is thread safe.
 
 Installation
@@ -40,15 +41,19 @@ There are two ways to set the current tenant: (1) by setting the current tenant
 
 **Setting the current tenant in a controller, manually**
 
-    Mongoid::Multitenancy.current_tenant = client_instance
+```ruby
+Mongoid::Multitenancy.current_tenant = client_instance
+```
 
 Setting the current_tenant yourself requires you to use a before_filter to set the Mongoid::Multitenancy.current_tenant variable.
 
 **Setting the current tenant for a block**
 
-    Mongoid::Multitenancy.with_tenant(client_instance) do
-      # Current tenant is set for all code in this block
-    end
+```ruby
+Mongoid::Multitenancy.with_tenant(client_instance) do
+  # Current tenant is set for all code in this block
+end
+```
 
 This approach is useful when running background processes for a specified tenant. For example, by putting this in your worker's run method,
 any code in this block will be scoped to the current tenant. All methods that set the current tenant are thread safe.
@@ -57,51 +62,58 @@ any code in this block will be scoped to the current tenant. All methods that se
 
 Scoping your models
 -------------------
-    class Client
-      include Mongoid::Document
+```ruby
+class Client
+  include Mongoid::Document
 
-      field :name, :type => String
-      validates_uniqueness_of :name
-    end
+  field :name, :type => String
+  validates_uniqueness_of :name
+end
 
-    class Article
-      include Mongoid::Document
-      include Mongoid::Multitenancy::Document
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
 
-      tenant(:client)
+  tenant(:client)
 
-      field :title, :type => String
-    end
+  field :title, :type => String
+end
+```
 
 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
+ * :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
 
 Some examples to illustrate this behavior:
 
-    # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
-    Mongoid::Multitenancy.current_tenant = Client.find_by(:name => 'Perfect Memory') # => <#Client _id:50ca04b86c82bfc125000025, :name: "Perfect Memory">
+```ruby
+ # This manually sets the current tenant for testing purposes. In your app this is handled by the gem.
+Mongoid::Multitenancy.current_tenant = Client.find_by(:name => 'Perfect Memory') # => <#Client _id:50ca04b86c82bfc125000025, :name: "Perfect Memory">
 
-    # All searches are scoped by the tenant, the following searches will only return objects belonging to the current client.
-    Article.all # => all articles where client_id => 50ca04b86c82bfc125000025
+ # All searches are scoped by the tenant, the following searches will only return objects belonging to the current client.
+Article.all # => all articles where client_id => 50ca04b86c82bfc125000025
 
-    # New objects are scoped to the current tenant
-    Article.new(:title => 'New blog') # => <#Article _id: nil, title: 'New blog', :client_id: 50ca04b86c82bfc125000025>
+ # New objects are scoped to the current tenant
+Article.new(:title => 'New blog') # => <#Article _id: nil, title: 'New blog', :client_id: 50ca04b86c82bfc125000025>
 
-    # It makes the tenant field immutable once it is persisted to avoid inconsistency
-    article.persisted? # => true
-    article.client = another_client
-    article.valid? # => false
+ # It can make the tenant field immutable once it is persisted to avoid inconsistency
+article.persisted? # => true
+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]
+```ruby
+Article.all # => all articles where client_id.in [50ca04b86c82bfc125000025, nil]
+```
 
 Rails
 -------------------
@@ -110,14 +122,16 @@ If you are using Rails, you may want to set the current tenant at each request.
 
 **Manually set the current tenant in ApplicationController using the host request**
 
-    class ApplicationController < ActionController::Base
-      before_filter :set_current_client
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :set_current_client
 
-      def set_current_client
-        current_client = Client.find_by_host(request.host)
-        Mongoid::Multitenancy.current_tenant = current_client
-      end
-    end
+  def set_current_client
+    current_client = Client.find_by_host(request.host)
+    Mongoid::Multitenancy.current_tenant = current_client
+  end
+end
+```
 
 Setting the current_tenant yourself requires you to use a before_filter to set the Mongoid::Multitenancy.current_tenant variable.
 
@@ -127,32 +141,36 @@ 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.
 
-    class Article
-      include Mongoid::Document
-      include Mongoid::Multitenancy::Document
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
 
-      tenant(:client)
+  tenant(:client)
 
-      field :slug
+  field :slug
 
-      validates_uniqueness_of :slug # => :scope => client_id is added automatically
-    end
+  validates_uniqueness_of :slug # => :scope => client_id is added automatically
+end
+```
 
 Mongoid indexes
 -------------------
 
 mongoid-multitenancy will automatically add the tenant foreign key in all your mongoid indexes to avoid to redefine all your validators.
 
-    class Article
-      include Mongoid::Document
-      include Mongoid::Multitenancy::Document
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
 
-      tenant(:client)
+  tenant(:client)
 
-      field :title
+  field :title
 
-      index({ :title => 1 }) # => create an index with { :client_id => 1, :title => 1 }
-    end
+  index({ :title => 1 }) # => create an index with { :client_id => 1, :title => 1 }
+end
+```
 
 Author & Credits
 ----------------

data/lib/mongoid/multitenancy/document.rb

@@ -21,7 +21,7 @@ module Mongoid
         attr_reader :tenant_field, :tenant_options
 
         def tenant(association = :account, options={})
-          @tenant_options = { optional: options.delete(:optional) }
+          @tenant_options = { optional: options.delete(:optional), immutable: options.delete(:immutable) { true } }
           # 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, options
@@ -42,7 +42,7 @@ module Mongoid
           }
 
           # Rewrite accessors to make tenant foreign_key/association immutable
-          validate :check_tenant_immutability, :on => :update
+          validate :check_tenant_immutability, :on => :update if @tenant_options[:immutable]
 
           # Set the default_scope to scope to current tenant
           default_scope lambda {

data/lib/mongoid/multitenancy/version.rb

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

data/spec/models/article.rb

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

data/spec/models/page.rb

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

data/spec/mongoid-multitenancy_spec.rb

@@ -136,20 +136,41 @@ describe Article do
     before { Mongoid::Multitenancy.current_tenant = client }
     after { Mongoid::Multitenancy.current_tenant = nil }
 
-    let(:article) { Article.create!(:title => "title X", :slug => "article-x") }
+    context "with :immutable" do
+      let(:item) { Page.create!(:title => "title X", :slug => "article-x") }
+
+      context "when the tenant has not changed" do
+        it 'should be valid' do
+          item.title = "title X (2)"
+          item.should be_valid
+        end
+      end
 
-    context "when the tenant has not changed" do
-      it 'should be valid' do
-        article.title = "title X (2)"
-        article.should be_valid
+      context "when the tenant has changed" do
+        it 'should be invalid' do
+          item.title = "title X (2)"
+          item.client = another_client
+          item.should_not be_valid
+        end
       end
     end
 
-    context "when the tenant has changed" do
-      it 'should be invalid' do
-        article.title = "title X (2)"
-        article.client = another_client
-        article.should_not be_valid
+    context "without :immutable" do
+      let(:item) { Article.create!(:title => "title X", :slug => "article-x") }
+
+      context "when the tenant has not changed" do
+        it 'should be valid' do
+          item.title = "title X (2)"
+          item.should be_valid
+        end
+      end
+
+      context "when the tenant has changed" do
+        it 'should be valid' do
+          item.title = "title X (2)"
+          item.client = another_client
+          item.should be_valid
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-multitenancy
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid