tenancy 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 960f4ccd4c80911a5f803c6865f782a468e166e7
-  data.tar.gz: 387cf8e4f3f74bc79ed2f28402c4c33b641788b3
+  metadata.gz: fe538f2809f42fdca981b88b3bbf9bb5ca19bc24
+  data.tar.gz: e65ce5cffe075fe7be07dd8d3525194d791e0199
 SHA512:
-  metadata.gz: 6a41030d55da3b492c2325f5b61c8feb4cf976793d3388d10eeeace10d354d4ad7fa6267c5c7f6084e62734468d0d05981042a40843cac3dfc0b8de6a4780e13
-  data.tar.gz: 943e3ccd96321fa385a5e0a689c4ff03b43cb5eaf445f70337e166484e5dd2ab7f6ae5a9f6fd285337f7dc0c43d86ed7b15d76de36c47fefa1d2cbad7b469404
+  metadata.gz: a8d0631db5f4f03b05e219d32f46e4b0f5eb57f60a5603331bff2eeba7c22590bb02967c65042bcbbcd40d819fd152f52a9e0b033ce1c6291e068f50d1156e59
+  data.tar.gz: d1425e735c6d9c125a749d8e41b52acd6f0b96351c7ee3bd668d5d393bb0842f05b10603d4b189dc3f2290253e0687955d127fc40b4fbdeca7898e3e02ec01d7

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: rKGLArZVmQzAMDN87mkpPahF5zlXDNbLL

data/.rspec

@@ -1 +1,2 @@
---colour
+--colour
+--profile

data/.rvmrc

@@ -4,7 +4,7 @@
 # development environment upon cd'ing into the directory
 
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-2.0.0-p247@tenancy"
+environment_id="ruby-2.1.0@tenancy"
 
 #
 # Uncomment the following lines if you want to verify rvm version per project

data/.travis.yml

@@ -1,15 +1,19 @@
+services: mongodb
 language: ruby
 script: "bundle exec rake spec"
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 env:
   - CODECLIMATE_REPO_TOKEN=891d362268d07d6ff0f5534f92252b6195f6be8795054d3627643eb6314a8c9e
 gemfile:
   - gemfiles/active_record_32.gemfile
   - gemfiles/active_record_40.gemfile
+  - gemfiles/mongoid_3.gemfile
+  - gemfiles/mongoid_4.gemfile
 notifications:
   email: false
 addons:
     code_climate:
-        repo_token: 891d362268d07d6ff0f5534f92252b6195f6be8795054d3627643eb6314a8c9e
+        repo_token: 891d362268d07d6ff0f5534f92252b6195f6be8795054d3627643eb6314a8c9e

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Overview
+
+For instructions on upgrading to newer versions, visit
+[mongoid.org](http://mongoid.org/en/mongoid/docs/upgrading.html).
+
+## 1.0.0
+
+### Major Changes (Backwards Incompatible)
+
+* Rename `#with` and `#use` to `#with_tenant` and `#use_tenant` because it conflicts with mongoid.
+* Replace `#without_scope` to `#tenant_scope`.
+* Support Mongoid 3/4.
+
+## 0.2.0
+
+* Add [request_store](https://github.com/steveklabnik/request_store) as dependency.
+* Add `#without_scope`.
+* Support ActiveRecord 4.
+
+## 0.1.0
+
+* First Release
+* Support ActiveRecord 3.
+* Add `tenany/matchers`.

data/Gemfile

@@ -1,6 +1,16 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tenancy.gemspec
-gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil
+gem "coveralls", require: false
+gem "activerecord", "~> 4.0.2", :require => "active_record"
+gem "mongoid", "~> 4.0.0.beta1"
+gem "rspec"
+gem "mongoid-rspec"
+gem "database_cleaner"
+gem "shoulda-matchers"
+gem "pry"
+gem "sqlite3"
+gem "rake"
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+# Specify your gem's dependencies in tenancy.gemspec
+gemspec

data/README.md

@@ -1,13 +1,15 @@
-# Tenancy [![Build Status](https://travis-ci.org/yoolk/tenancy.png?branch=master)](https://travis-ci.org/yoolk/tenancy) [![Code Climate](https://codeclimate.com/repos/527a1d45f3ea005378005fdb/badges/cfbc9ff8993d02e13b9d/gpa.png)](https://codeclimate.com/repos/527a1d45f3ea005378005fdb/feed)
+# Tenancy [![Gem Version](https://badge.fury.io/rb/tenancy.png)](http://badge.fury.io/rb/tenancy) [![Build Status](https://travis-ci.org/yoolk/tenancy.png?branch=master)](https://travis-ci.org/yoolk/tenancy) [![Dependency Status](https://gemnasium.com/yoolk/tenancy.png)](https://gemnasium.com/yoolk/tenancy) [![Coverage Status](https://coveralls.io/repos/yoolk/tenancy/badge.png?branch=master)](https://coveralls.io/r/yoolk/tenancy?branch=master)
 
-**Tenancy** is a simple gem that provides multi-tenancy support on activerecord through scoping. I suggest you to watch an excellent [RailsCast on Multitenancy with Scopes](http://railscasts.com/episodes/388-multitenancy-with-scopes) and read this book [Multitenancy with Rails](https://leanpub.com/multi-tenancy-rails).
+**Tenancy** is a simple gem that provides multi-tenancy support on activerecord/mongoid (3/4) through scoping. I suggest you to watch an excellent [RailsCast on Multitenancy with Scopes](http://railscasts.com/episodes/388-multitenancy-with-scopes) and read this book [Multitenancy with Rails](https://leanpub.com/multi-tenancy-rails).
+
+This `README.md` file is for the latest version, v1.0.0. For the previous version, check out this [README.md](https://github.com/yoolk/tenancy/blob/v0.2.0/README.md). Please, see the [CHANGELOG.md](https://github.com/yoolk/tenancy/blob/master/CHANGELOG.md#100) to do an upgrade.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tenancy'
+gem "tenancy"
 ```
 
 And then execute:
@@ -18,7 +20,7 @@ $ bundle
 
 ## Usage
 
-This gem provides two modules: `Tenancy::Resource` and `Tenancy::ResourceScope`.
+This gem provides two modules: `Tenancy::Resource` and `Tenancy::ResourceScope`. Include them into your activerecord/mongoid models.
 
 ### Tenancy::Resource
 
@@ -43,7 +45,7 @@ Portal.current
 # => <Portal id: 1, domain_name: 'yp.com.kh'>
 
 # scope with this portal
-Portal.with(camyp) do
+Portal.with_tenant(camyp) do
   # Do something here with this portal
 end
 ```
@@ -79,23 +81,23 @@ class ExtraCommunication < ActiveRecord::Base
 end
 
 > Portal.current = 1
-> Listing.find(1).to_sql
+> Listing.find(1)
 # => SELECT "listings".* FROM "listings" WHERE "portal_id" = 1 AND "id" = 1
 
 > Listing.current = 1
-> Communication.find(1).to_sql
+> Communication.find(1)
 # => SELECT "communications".* FROM "communications" WHERE "portal_id" = 1 AND "listing_id" = 1 AND "is_active" = true AND "id" = 1
 
-# unscoped :current_portal, :current_listing
-> Communication.without_scope(:portal).find(1)
-# => SELECT "communications".* FROM "communications" WHERE "listing_id" = 1 AND "is_active" = true AND "id" = 1
-> Communication.without_scope(:listing).find(1)
+# include/exclude tenant_scope :current_portal, :current_listing
+> Communication.tenant_scope(:portal).find(1)
 # => SELECT "communications".* FROM "communications" WHERE "portal_id" = 1 AND "is_active" = true AND "id" = 1
-> Communication.without_scope(:portal, :listing).find(1)
+> Communication.tenant_scope(:listing).find(1)
+# => SELECT "communications".* FROM "communications" WHERE "listing_id" = 1 AND "is_active" = true AND "id" = 1
+> Communication.tenant_scope(nil).find(1)
 # => SELECT "communications".* FROM "communications" WHERE "is_active" = true AND "id" = 1
 ```
 
-`scope_to :portal` does 4 things:
+`scope_to :portal` does these things:
 
 1. it adds `belongs_to :portal`.
 
@@ -105,42 +107,26 @@ end
 
 4. it overrides `#portal` so that it doesn't touch the database if `portal_id` in that record is the same as `Portal.current_id`.
 
-`validates :value, uniqueness: true` will validates uniqueness against the whole table. `validates_uniqueness_in_scope` validates uniqueness with the scopes you passed in `scope_to`.
-
-## Rails
-
-Because `#current` is using thread variable, it's advisable to set to `nil` after processing controller action. This can be easily achievable by using `around_filter` and `#with` inside `application_controller.rb`. Or, you can do it manually by using `#current=`.
-
-```ruby
-class ApplicationController < ActionController::Base
-  around_filter :route_domain
-
-  protected
+5. it overrides `#portal_id` so that it returns `Portal.current_id`. (mongoid 3 only)
 
-    def route_domain(&block)
-      Portal.with(current_portal, &block)
-    end
+6. it overrides `#shard_key_selector` so that every update/delete query includes current tenant_id. (mongoid 3/4)
 
-    def current_portal
-      @current_portal ||= Portal.find_by_domain_name(request.host)
-    end
-end
-```
+`validates :value, uniqueness: true` will validates uniqueness against the whole table. `validates_uniqueness_in_scope` validates uniqueness with the scopes you passed in `scope_to`.
 
-From version 0.2.0 up, you don't need to use `around_filter` because this gem add [request_store](https://github.com/steveklabnik/request_store) as dependency. It will clear threaded variables inside middleware on every request. You can just use `before_filter` to set the current tenant.
+## Rails
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_filter :set_current_portal
+  before_action :set_current_portal
 
   protected
 
     def current_portal
-      @current_portal
+      Portal.current
     end
 
     def set_current_portal
-      @current_portal = Portal.find_by_domain_name(request.host)
+      Portal.current = Portal.find_by_domain_name(request.host)
     end
 end
 ```
@@ -175,6 +161,40 @@ describe Listing do
 end
 ```
 
+```ruby
+describe Mongo::Listing do
+  it { should have_scope_to(:portal) }
+  it { should have_scope_to(:portal).of_type(Mongo::Portal) }
+end
+```
+
+I have this rspec configuration in my rails 4 apps:
+
+```ruby
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner[:active_record].strategy = :transaction
+    DatabaseCleaner[:mongoid].strategy       = :truncation
+
+    DatabaseCleaner[:active_record].clean_with(:truncation)
+    DatabaseCleaner[:mongoid].clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner[:active_record].start
+    DatabaseCleaner[:mongoid].start
+
+    current_portal = FactoryGirl.create(:portal, domain_name: "yellowpages-cambodia.dev")
+    Yoolk::Portal.use(current_portal) do
+      example.run
+    end
+
+    DatabaseCleaner[:active_record].clean
+    DatabaseCleaner[:mongoid].clean if example.metadata[:mongodb]
+  end
+end
+```
+
 ## Authors
 
-* [Chamnap Chhorn](https://github.com/chamnap)
+* [Chamnap Chhorn](https://github.com/chamnap)

data/Rakefile

@@ -10,19 +10,19 @@ end
 task :default => "spec:all"
 
 namespace :spec do
-  %w(active_record_40 active_record_32).each do |gemfile|
+  %w(active_record_40 active_record_32 mongoid_4 mongoid_3).each do |gemfile|
     desc "Run Tests against #{gemfile}"
     task gemfile do
       sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rspec"
     end
   end
 
   desc "Run Tests against active_record versions"
   task :all do
-    %w(active_record_40 active_record_32).each do |gemfile|
+    %w(active_record_40 active_record_32 mongoid_4 mongoid_3).each do |gemfile|
       sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rspec"
     end
   end
 end

data/gemfiles/active_record_32.gemfile

@@ -1,7 +1,13 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 3.2.13', :require => 'active_record'
+source "https://rubygems.org"
 
+gem "activerecord", "~> 3.2.16", :require => "active_record"
+gem "coveralls", require: false
 gem "codeclimate-test-reporter", group: :test, require: nil
+gem "rspec"
+gem "database_cleaner"
+gem "shoulda-matchers"
+gem "pry"
+gem "sqlite3"
+gem "rake"
 
-gemspec :path => '../'
+gemspec :path => "../"

data/gemfiles/active_record_40.gemfile

@@ -1,7 +1,13 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 4.0.1', :require => 'active_record'
+source "https://rubygems.org"
 
+gem "activerecord", "~> 4.0.2", :require => "active_record"
+gem "coveralls", require: false
 gem "codeclimate-test-reporter", group: :test, require: nil
+gem "rspec"
+gem "database_cleaner"
+gem "shoulda-matchers"
+gem "pry"
+gem "sqlite3"
+gem "rake"
 
-gemspec :path => '../'
+gemspec :path => "../"

data/gemfiles/mongoid_3.gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gem "mongoid", "~> 3.1.6"
+gem "coveralls", require: false
+gem "codeclimate-test-reporter", group: :test, require: nil
+gem "rspec"
+gem "database_cleaner"
+gem "mongoid-rspec"
+gem "pry"
+gem "rake"
+
+gemspec :path => "../"

data/gemfiles/mongoid_4.gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gem "mongoid", "~> 4.0.0.beta1"
+gem "coveralls", require: false
+gem "codeclimate-test-reporter", group: :test, require: nil
+gem "rspec"
+gem "database_cleaner"
+gem "mongoid-rspec"
+gem "pry"
+gem "rake"
+
+gemspec :path => "../"

data/lib/tenancy.rb

@@ -3,6 +3,8 @@ require "active_support/concern"
 require "request_store"
 
 module Tenancy
-  autoload :Resource,      'tenancy/resource'
-  autoload :ResourceScope, 'tenancy/resource_scope'
+  autoload :Resource,      "tenancy/resource"
+  autoload :ResourceScope, "tenancy/resource_scope"
+  autoload :Scoping,       "tenancy/scoping"
+  autoload :Tenant,        "tenancy/tenant"
 end

data/lib/tenancy/matchers.rb

@@ -1,4 +1,5 @@
-require 'shoulda-matchers'
+require "shoulda-matchers" if defined?(ActiveRecord)
+require "mongoid-rspec"    if defined?(Mongoid)
 
 module Tenancy
   module Shoulda
@@ -12,16 +13,29 @@ module Tenancy
       end
 
       class HaveScopeToMatcher
+        attr_reader :scope_name
+
         def initialize(scope_name)
-          @scope_name        = scope_name
-          @presence_matcher  = ::Shoulda::Matchers::ActiveModel::ValidatePresenceOfMatcher.new(@scope_name)
-          @belong_to_matcher = ::Shoulda::Matchers::ActiveRecord::AssociationMatcher.new(:belongs_to, @scope_name)
+          @scope_name             = scope_name
+          if defined?(ActiveRecord)
+            @ar_presence_matcher    = ::Shoulda::Matchers::ActiveModel::ValidatePresenceOfMatcher.new(@scope_name)
+            @ar_belong_to_matcher   = ::Shoulda::Matchers::ActiveRecord::AssociationMatcher.new(:belongs_to, @scope_name)
+          end
+          if defined?(Mongoid)
+            @mid_presence_matcher   = ::Mongoid::Matchers::Validations::HaveValidationMatcher.new(@scope_name, :presence)
+            @mid_belong_to_matcher  = ::Mongoid::Matchers::Associations::HaveAssociationMatcher.new(@scope_name, ::Mongoid::Matchers::Associations::BELONGS_TO)
+          end
         end
 
         def matches?(subject)
-          @presence_matches      = @presence_matcher.matches?(subject)
-          @belong_to_matches     = @belong_to_matcher.matches?(subject)
-          @default_scope_matches = default_scope_matches?(subject)
+          if defined?(ActiveRecord) && subject.class <= ::ActiveRecord::Base
+            @ar_presence_matcher.matches?(subject) &&
+            @ar_belong_to_matcher.matches?(subject) &&
+            ar_default_scope_matches?(subject)
+          elsif defined?(Mongoid) && subject.class <= ::Mongoid::Document
+            @mid_presence_matcher.matches?(subject) &&
+            @mid_belong_to_matcher.matches?(subject)
+          end
         end
 
         def failure_message
@@ -35,7 +49,8 @@ module Tenancy
         end
 
         private
-          def default_scope_matches?(subject)
+
+          def ar_default_scope_matches?(subject)
             actual_class = subject.class
             reflection   = actual_class.reflect_on_association(@scope_name.to_sym)
             scoped_class = reflection.class_name.constantize
@@ -48,8 +63,10 @@ module Tenancy
           end
 
           def method_missing(method, *args, &block)
-            if @belong_to_matcher.respond_to?(method)
-              @belong_to_matcher.send(method, *args, &block)
+            if @ar_belong_to_matcher && @ar_belong_to_matcher.respond_to?(method)
+              @ar_belong_to_matcher.send(method, *args, &block)
+            elsif @mid_belong_to_matcher && @mid_belong_to_matcher.respond_to?(method)
+              @mid_belong_to_matcher.send(method, *args, &block)
             else
               super
             end
@@ -77,7 +94,7 @@ module Tenancy
 end
 
 
-require 'rspec/core'
+require "rspec/core"
 RSpec.configure do |config|
   config.include Tenancy::Shoulda::Matchers
-end
+end

data/lib/tenancy/resource.rb

@@ -25,7 +25,7 @@ module Tenancy
         current.try(:id)
       end
 
-      def with(tenant, &block)
+      def with_tenant(tenant, &block)
         raise ArgumentError, "block required" if block.nil?
 
         begin
@@ -37,7 +37,7 @@ module Tenancy
           self.current = old
         end
       end
-      alias_method :use, :with
+      alias_method :use_tenant, :with_tenant
     end
   end
 end