mongoid-tenant 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d98d3fcee576f2aa4fd6d1c72225b0491b614694
-  data.tar.gz: 600205308c2e42bc4c4b8ea8c855b89af2402797
+  metadata.gz: 13200e42649305b163500529ef5cf49d9f72b6af
+  data.tar.gz: 3d7df78088d6668b12b1e1f371ff2dd283c2f1fe
 SHA512:
-  metadata.gz: a04ab62aa4848479701228f93b75f2fad985c489284ac95d5c0922d0b697baccfb974424678374d030a9274e80a344b6c19e35b94fd5e78a4bde30124870f3a4
-  data.tar.gz: 4c44fd1d7bc9b70dc58cad1720ea93e094574903656ecdb1e6eda79590b18f3fb3ca97c391d62bad61c734949612c743fe8a74a17b1331fbae9b4d5d2aeac645
+  metadata.gz: 890d1639ca4a5b59fe6a49c72ba53942c223c25f766ad84d2ffc1bd15f40a42bb8127810c5af0f6ce69b1bc48efa0f29f5ade830e302ae3c25af2e5ee4a31b6e
+  data.tar.gz: b3784c0a6748cc5380bec1bafab4cd1f317f3d92193d732bc3c5fd1852223a579781a6d2471f8d23a344414e9d4a617d660e9b406d7454ccea4b89fc857a8f2f

data/.travis.yml

@@ -24,3 +24,5 @@ services:
 env: CI="travis"
 
 script: "bundle exec rspec"
+
+sudo: false

data/Gemfile

@@ -2,6 +2,8 @@ source 'http://rubygems.org'
 
 gemspec
 
+gem 'mongoid', '5.0.0.beta'
+
 group :test do
   gem 'guard'
   gem 'guard-rspec'
@@ -9,5 +11,5 @@ group :test do
   gem 'rspec', '>= 3.2.0'
   gem 'coveralls', require: false
   gem 'codeclimate-test-reporter', require: nil
-  gem 'mongoid-rspec', git: 'https://github.com/nofxx/mongoid-rspec'
+  gem 'mongoid-rspec'
 end

data/Guardfile

@@ -9,14 +9,14 @@
 
 # guard :rubocop do
 guard :rubocop, all_on_start: false, keep_failed: false, cli: ['-D'] do
-  watch(%r{.+\.rb$})
+  watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end
 
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch(/^generators\/(.+)\.rb$/) { |_m| 'spec/schemaless/worker_spec' }
+  watch(%r{^generators/(.+)\.rb$}) { |_m| 'spec/schemaless/worker_spec' }
 
   watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,9 +1,9 @@
 Mongoid::Tenant
 ===============
 
-[![Gem Version](https://badge.fury.io/rb/mongoid-tenant.png)](http://badge.fury.io/rb/mongoid-tenant)
+[![Gem Version](https://badge.fury.io/rb/mongoid-tenant.svg)](http://badge.fury.io/rb/mongoid-tenant)
 [![Dependency Status](https://gemnasium.com/nofxx/mongoid-tenant.svg)](https://gemnasium.com/nofxx/mongoid-tenant)
-[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-tenant.png)](http://travis-ci.org/nofxx/mongoid-tenant)
+[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-tenant.svg)](http://travis-ci.org/nofxx/mongoid-tenant)
 
 ## Mongoid::Tenant
 
@@ -35,6 +35,8 @@ And that's all. But we need a tenancy:
 class Shop
   include Mongoid::Document
   include Mongoid::Tenancy
+
+  tenant_key :url
 end
 ```
 
@@ -54,10 +56,20 @@ Shop.first.tenancy!
 
 ### Tenancy.tenants
 
-Helper to execute something on each tenant namespace. Eg:
+Helper to execute something on each tenant namespace.
+has_many substitute. Eg:
 
 ```
-Shop.tenants { |t| puts "#{t} has #{Bike.count}" }
+class Shop
+   ...
+   has_tenant :bikes
+end
+```
+
+Or raw:
+
+```
+Shop.tenants { |tenant| puts "#{tenant} have #{Bike.count} bike(s)" }
 ```
 
 
@@ -69,3 +81,20 @@ You'll need to provide which Tenancy to scope. In our example:
 ```
 TENANCY=Shop bundle exec rails db:mongoid:create_indexes
 ```
+
+## ApplicationController
+
+Write your logic:
+
+```
+def app_domain
+  @domain ||= Shop.find_by(uri: /^#{request.env["SERVER_NAME"]}/)
+  @domain.tenancy!
+end
+```
+
+
+## Issues
+
+
+http://github.com/nofxx/mongoid-tenant

data/benchmarks/benchmark.rb

@@ -1,3 +1,3 @@
-$: << File.expand_path("../../lib", __FILE__)
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
 # Maybe benchmark stringex vs babosa just for fun...

data/lib/mongoid/tenancy.rb

@@ -1,24 +1,49 @@
 module Mongoid
+  #
+  # Tenancy Module
+  #
+  # Provides #tenant_key and #tenancy!
+  #
   module Tenancy
     extend ActiveSupport::Concern
+    #
+    # Model instance
+    module ClassMethods
+      def tenant_key(key, options = {})
+        field key,    type: Symbol
+        options[:validates] ||= { presence: true }
+        options[:index] ||= {}
 
-    included do
-      field :uri,     type: String
+        validates key, { uniqueness: true }.merge(options[:validates])
 
-      validates :uri, uniqueness: true
+        index({ key => 1 }, {  unique: true }.merge(options[:index]))
 
-      index({ uri: 1 }, unique: true)
+        define_method(:tenant_key) do
+          send(key).to_s
+        end
+
+        define_singleton_method(:clear_tenancy!) do
+          Thread.current[:tenancy] = nil
+        end
+
+        define_singleton_method(:with_tenants) do |&block|
+          all.each do |t|
+            t.tenancy!
+            block.call(t)
+          end
+          clear_tenancy!
+        end
+      end
 
-      def self.tenants
-        all.each do |t|
-          t.tenancy!
-          yield t
+      def has_tenant(relative)
+        define_method(relative) do
+          tenancy! && relative.to_s.classify.constantize
         end
       end
     end
 
     def tenancy!
-      Thread.current[:mongodb] = _id.to_s
+      Thread.current[:tenancy] = tenant_key
     end
   end # Tenancy
 end # Mongoid

data/lib/mongoid/tenant/railtie.rb

@@ -1,10 +1,13 @@
 module Rails
-  module Mongoid::Tenant
-    class Railtie < Rails::Railtie
-      rake_tasks do
-        load "mongoid/tenant/tasks/tenant.rake"
+  module Mongoid
+    module Tenant
+      # Load rake tasks
+      # MongoDB Indexes
+      class Railtie < Rails::Railtie
+        rake_tasks do
+          load 'mongoid/tenant/tasks/tenant.rake'
+        end
       end
-
-    end
-  end
-end
+    end # Tenant
+  end # Mongoid
+end # Rails

data/lib/mongoid/tenant/tasks/tenant.rake

@@ -1,25 +1,26 @@
-Rake::Task["db:mongoid:create_indexes"].clear
-Rake::Task["db:mongoid:remove_undefined_indexes"].clear
+Rake::Task['db:mongoid:create_indexes'].clear
+Rake::Task['db:mongoid:remove_undefined_indexes'].clear
 
 namespace :db do
   namespace :mongoid do
-
-    def get_tenancy
+    def tenancy_env
       ENV['TENANCY'] ||
         fail("Provide a tenancy model: `TENANCY=Foo #{ARGV.join}`")
     end
 
-    task :create_indexes => [:environment, :load_models] do
-      Rake::Task["db:mongoid:create_indexes"].clear
-      Object.const_get(get_tenancy).all.each do |t|
+    desc 'Create Mongoid indexes, tenant aware'
+    task create_indexes: [:environment, :load_models] do
+      Rake::Task['db:mongoid:create_indexes'].clear
+      Object.const_get(tenancy_env).all.each do |t|
         puts "Tenant #{t}"
         t.tenancy!
         ::Mongoid::Tasks::Database.create_indexes
       end
     end
 
-    task :remove_undefined_indexes => [:environment, :load_models] do
-      Object.const_get(get_tenancy).all.each do |t|
+    desc 'Removes undefined Mongoid indexes, tenant aware'
+    task remove_undefined_indexes: [:environment, :load_models] do
+      Object.const_get(tenancy_env).all.each do |t|
         puts "Tenant #{t}"
         t.tenancy!
         ::Mongoid::Tasks::Database.remove_undefined_indexes

data/lib/mongoid/tenant/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   # Mongoid::Tenant::VERSION
   module Tenant
-    VERSION = '0.0.5'
+    VERSION = '0.0.7'
   end
 end

data/lib/mongoid/tenant.rb

@@ -1,14 +1,17 @@
 require 'mongoid'
-require_relative 'tenancy'
+require 'mongoid/tenancy'
 
 require 'mongoid/tenant/railtie' if defined?(Rails)
 
 module Mongoid
+  #
+  # The tenant
+  #
   module Tenant
     extend ActiveSupport::Concern
 
     included do
-      store_in database: -> { Thread.current[:mongodb] }
+      store_in database: -> { Thread.current[:tenancy] }
     end
   end # Tenant
 end # Mongoid

data/mongoid-tenant.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'mongoid/tenant/version'
 
 Gem::Specification.new do |s|
@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Marcos Piccinini']
   s.homepage    = 'http://github.com/nofxx/mongoid-tenant'
-  s.summary     = 'Multi Database/Tenants models for Mongoid documents.'
-  s.description = 'Mongoid Tenant with multiple database per client.'
+  s.summary     = 'Multiple databases Models for Mongoid documents.'
+  s.description = 'Multiple databases Mongoid Models. Good for SaaS Apps.'
   s.license     = 'MIT'
 
   s.rubyforge_project = 'mongoid-tenant'
@@ -17,6 +17,5 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 end

data/spec/mongoid/tenancy_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Mongoid::Tenancy do
+  def clear_tenancy!
+    Thread.current[:tenancy] = nil
+  end
+
+  describe 'A Journal' do
+    let(:journal) { Journal.create!(url: 'a_casseta_test', name: 'A Casseta') }
+    let(:other) { Journal.create!(url: 'a_planeta_test', name: 'O Planeta') }
+
+    it 'should work' do
+      journal.tenancy!
+      expect { Article.create!(title: 'Nice Coffeeshop') }.to_not raise_error
+      expect(Article.count).to eq 1
+    end
+
+    it 'should not interfer with mongoid' do
+      journal.tenancy!
+      expect(Journal.count).to eq 1
+      expect(Journal.all.to_a).to eq [journal]
+    end
+
+    it 'should switch from tenant to tenant' do
+      journal.tenancy!
+      expect { Article.create!(title: 'Nice Coffeeshop') }.to_not raise_error
+      expect(Article.count).to eq 1
+      other.tenancy!
+      expect(Article.count).to eq 0
+    end
+
+    it 'should switch back from tenant' do
+      other.tenancy!
+      expect { Article.create!(title: 'Nice Coffeeshop') }.to_not raise_error
+      expect(Article.count).to eq 1
+      journal.tenancy!
+      expect(Article.count).to eq 0
+    end
+
+    it 'should switch another test' do
+      journal.tenancy!
+      expect { Article.create!(title: 'Nice Coffeeshop 1') }.to_not raise_error
+      other.tenancy!
+      expect { Article.create!(title: 'Nice Coffeeshop 2') }.to_not raise_error
+      expect(Article.count).to eq 1
+      journal.tenancy!
+      expect(Article.count).to eq 1
+    end
+
+    it 'should have a multiple helper' do
+      journal.tenancy!
+      Article.create!(title: 'Nice Coffeeshop')
+      clear_tenancy!
+      expect(journal.articles.count).to eq 1
+    end
+
+    it 'should have a multiple helper' do
+      journal.tenancy!
+      article = Article.create!(title: 'Nice Coffeeshop')
+      clear_tenancy!
+      expect(journal.articles.first).to eq article
+    end
+
+    it 'should not leak tenancy key' do
+      journal && other
+      Journal.with_tenants { Article.create!(title: 'Hello') }
+      expect(Thread.current[:tenancy]).to be nil
+    end
+
+    it 'should have a multiple helper' do
+      journal && other
+      Journal.with_tenants { Article.create!(title: 'Hello') }
+      Journal.with_tenants { Article.create!(title: 'Hello') }
+      journal.tenancy!
+      expect(Article.count).to eq 2
+    end
+  end
+
+  describe 'A Blog' do
+    let(:blog) { Blog.create!(url: 'b_casseta_test', name: 'A Casseta') }
+    let(:other) { Blog.create!(url: 'b_planeta_test', name: 'O Planeta') }
+
+    it 'should not validate key' do
+      expect(Blog.create!(name: 'Monty News')).to be_valid
+      expect(Blog.count).to eq 1
+    end
+
+    it 'should work fine w/o key' do
+      Blog.create!(name: 'Monty News')
+      expect(Blog.first.name).to eq 'Monty News'
+    end
+
+    it 'should not create database if it`s sparse' do
+      expect { Blog.create!(name: 'Monty News')  }
+        .to_not change(self, :fetch_dbs)
+    end
+
+    it 'should create database if it`s sparse' do
+      expect { blog && blog.tenancy! && Article.create! }
+        .to change(self, :fetch_dbs)
+    end
+
+  end
+end

data/spec/mongoid/tenant_spec.rb

@@ -1,4 +1,35 @@
 require 'spec_helper'
 
 describe Mongoid::Tenant do
+  it 'should have a tenancy' do
+    expect(Journal).to include(Mongoid::Tenancy)
+  end
+
+  it 'should not have both modules' do
+    expect(Journal).to_not include(Mongoid::Tenant)
+  end
+
+  it 'should have a tenant' do
+    expect(Article).to include(Mongoid::Tenant)
+  end
+
+  it 'should not have both modules' do
+    expect(Article).to_not include(Mongoid::Tenancy)
+  end
+
+  it 'should not interfer with tenancy' do
+    expect do
+      Journal.create!(url: 'a_planeta_test', name: 'Planeta Diário')
+    end.to_not raise_error
+    expect(Journal.count).to eq 1
+  end
+
+  it 'should not interfer other models' do
+    expect { City.create!(name: 'Sin City') }.to_not raise_error
+  end
+
+  it 'should interfer with tenant w/o tenancy' do
+    expect { Article.create!(title: 'A Very Nice Coffeeshop') }
+      .to raise_error(NoMethodError)
+  end
 end

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ require 'mongoid/tenant'
 
 ENV['MONGOID_ENV'] = 'test'
 
-db_config = {
+DB_CONFIG = {
   default: {
     database: 'mongoid_tenant_test',
     hosts: ["localhost: #{ENV['MONGODB_PORT'] || 27_017}"],
@@ -24,12 +24,28 @@ db_config = {
   }
 }
 
+def new_conn(db = '')
+  Mongo::Client.new(DB_CONFIG[:default][:hosts], database: db)
+end
+
+def fetch_dbs
+  new_conn.database_names.to_a # each { |n| START_DBS << n }
+end
+
+def drop_shared
+  %w( a_casseta_test a_planeta_test b_casseta_test b_planeta_test ).each do |db|
+    new_conn(db).database.drop
+  end
+end
+
+START_DBS = fetch_dbs
+
 Mongoid.configure do |config|
   config.load_configuration(
     if Mongoid::VERSION >= '5'
-      { clients: db_config }
+      { clients: DB_CONFIG }
     else
-      { sessions: db_config }
+      { sessions: DB_CONFIG }
     end
   )
 end
@@ -42,10 +58,19 @@ RSpec.configure do |config|
   config.include Mongoid::Matchers
 
   config.before(:each) do
-    Mongoid.purge!
+    Thread.current[:tenancy] = nil
+    drop_shared
+    # HACK: Mongoid.purge!
+    [Journal, Blog, City].each(&:delete_all)
+  end
+
+  config.after(:each) do
+    drop_shared
   end
 
   config.after(:suite) do
+    extra_dbs = fetch_dbs - START_DBS
+    fail "Extra DBs: #{extra_dbs.inspect}" unless extra_dbs.empty?
     puts "\n# With Mongoid v#{Mongoid::VERSION}"
   end
 end

data/spec/support/models.rb

@@ -1,14 +1,42 @@
-# A nice model for a blog!
+# A nice model for jornalistic SaaS!
 class Journal
   include Mongoid::Document
   include Mongoid::Tenancy
 
   field :name
+  tenant_key :url
+
+  has_tenant :articles
 end
 
+# Reporter -> Journal tenant
+class Reporter
+  include Mongoid::Document
+  include Mongoid::Tenant
+
+  field :name
+end
+
+# Article -> Journal tenant
 class Article
   include Mongoid::Document
   include Mongoid::Tenant
+
   field :title
   field :body
 end
+
+# City normal model
+class City
+  include Mongoid::Document
+  field :name
+end
+
+class Blog
+  include Mongoid::Document
+  include Mongoid::Tenancy
+  field :name
+  tenant_key :url, validates: { allow_nil: true }, index: { sparse: true }
+
+  has_tenant :articles
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-tenant
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Marcos Piccinini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-18 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -24,7 +24,7 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: Mongoid Tenant with multiple database per client.
+description: Multiple databases Mongoid Models. Good for SaaS Apps.
 email: 
 executables: []
 extensions: []
@@ -45,6 +45,7 @@ files:
 - lib/mongoid/tenant/tasks/tenant.rake
 - lib/mongoid/tenant/version.rb
 - mongoid-tenant.gemspec
+- spec/mongoid/tenancy_spec.rb
 - spec/mongoid/tenant_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
@@ -68,11 +69,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid-tenant
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Multi Database/Tenants models for Mongoid documents.
+summary: Multiple databases Models for Mongoid documents.
 test_files:
+- spec/mongoid/tenancy_spec.rb
 - spec/mongoid/tenant_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
+has_rdoc: