mongoid-multitenancy-forked 1.0.1

data/lib/mongoid/multitenancy/validators/tenant_uniqueness.rb

@@ -0,0 +1,67 @@
+module Mongoid
+  module Multitenancy
+    # Validates whether or not a field is unique against the documents in the
+    # database.
+    #
+    # @example Define the tenant uniqueness validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     include Mongoid::Multitenancy::Document
+    #     field :title
+    #     tenant :client
+    #
+    #     validates_tenant_uniqueness_of :title
+    #   end
+    #
+    # It is also possible to limit the uniqueness constraint to a set of
+    # records matching certain conditions:
+    #   class Person
+    #     include Mongoid::Document
+    #     include Mongoid::Multitenancy::Document
+    #     field :title
+    #     field :active, type: Boolean
+    #     tenant :client
+    #
+    #     validates_tenant_uniqueness_of :title, conditions: -> {where(active: true)}
+    #   end
+    class TenantUniquenessValidator < Mongoid::Validatable::UniquenessValidator
+      # Validate a tenant root document.
+      def validate_root(document, attribute, value)
+        klass = document.class
+
+        while klass.superclass.respond_to?(:validators) && klass.superclass.validators.include?(self)
+          klass = klass.superclass
+        end
+        criteria = create_criteria(klass, document, attribute, value)
+
+        # <<Add the tenant Criteria>>
+        criteria = with_tenant_criterion(criteria, klass, document)
+        criteria = criteria.merge(options[:conditions].call) if options[:conditions]
+
+        if criteria.read(mode: :primary).exists?
+          add_error(document, attribute, value)
+        end
+      end
+
+      # Add the scope criteria for a tenant model criteria.
+      #
+      # @api private
+      def with_tenant_criterion(criteria, base, document)
+        item = base.tenant_field.to_sym
+        name = document.database_field_name(item)
+        tenant_value = document.attributes[name]
+
+        if document.class.tenant_options[:optional] && !options[:exclude_shared]
+          if tenant_value
+            criteria = criteria.where(:"#{item}".in => [tenant_value, nil])
+          end
+        else
+          criteria = criteria.where(item => tenant_value)
+        end
+
+        criteria
+      end
+    end
+  end
+end

data/lib/mongoid/multitenancy/version.rb

@@ -0,0 +1,6 @@
+module Mongoid
+  module Multitenancy
+    # Version
+    VERSION = '1.0.1'.freeze
+  end
+end

data/lib/mongoid/multitenancy.rb

@@ -0,0 +1,34 @@
+require 'mongoid'
+require 'mongoid/multitenancy/document'
+require 'mongoid/multitenancy/version'
+require 'mongoid/multitenancy/validators/tenancy'
+require 'mongoid/multitenancy/validators/tenant_uniqueness'
+
+module Mongoid
+  module Multitenancy
+    class << self
+      # Set the current tenant. Make it Thread aware
+      def current_tenant=(tenant)
+        Thread.current[:current_tenant] = tenant
+      end
+
+      # Returns the current tenant
+      def current_tenant
+        Thread.current[:current_tenant]
+      end
+
+      # Affects a tenant temporary for a block execution
+      def with_tenant(tenant, &block)
+        raise ArgumentError, 'block required' if block.nil?
+
+        begin
+          old_tenant = current_tenant
+          self.current_tenant = tenant
+          yield
+        ensure
+          self.current_tenant = old_tenant
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-multitenancy-forked.rb

@@ -0,0 +1 @@
+require 'mongoid/multitenancy'

data/mongoid-multitenancy-forked.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid/multitenancy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Aymeric Brisse']
+  gem.email         = ['aymeric.brisse@mperfect-memory.com']
+  gem.description   = 'MultiTenancy with Mongoid - This is a fork for mongoid-multitenancy just to allow mongoid version < 10'
+  gem.summary       = 'Support of a multi-tenant database with Mongoid'
+  gem.homepage      = 'https://github.com/PerfectMemory/mongoid-multitenancy'
+  gem.license       = 'MIT'
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'mongoid-multitenancy-forked'
+  gem.require_paths = ['lib']
+  gem.version       = Mongoid::Multitenancy::VERSION
+
+  gem.add_dependency('mongoid', '>= 6', '< 10')
+end

data/spec/immutable_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Immutable do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  let(:item) do
+    Immutable.new(title: 'title X', slug: 'page-x')
+  end
+
+  it_behaves_like 'a tenantable model'
+
+  describe '#valid?' do
+    before do
+      Mongoid::Multitenancy.current_tenant = client
+    end
+
+    context 'when the tenant has not changed' do
+      before do
+        item.save!
+      end
+
+      it 'is valid' do
+        item.title = 'title X (2)'
+        expect(item).to be_valid
+      end
+    end
+
+    context 'when the tenant has changed' do
+      before do
+        item.save!
+        Mongoid::Multitenancy.current_tenant = another_client
+      end
+
+      it 'is not valid' do
+        item.tenant = another_client
+        expect(item).not_to be_valid
+      end
+    end
+  end
+end

data/spec/indexable_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe 'tenant' do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  before do
+    Mongoid::Multitenancy.current_tenant = client
+  end
+
+  describe 'tenant full_indexes option' do
+    context 'without index option' do
+      it 'does not create an index' do
+        expect(IndexableWithoutIndex).not_to have_index_for(tenant_id: 1)
+      end
+    end
+
+    context 'with index: false' do
+      it 'does not create an index' do
+        expect(IndexableWithIndexFalse).not_to have_index_for(tenant_id: 1)
+      end
+    end
+
+    context 'with index: true' do
+      it 'creates an index' do
+        expect(IndexableWithIndexTrue).to have_index_for(tenant_id: 1)
+      end
+    end
+  end
+
+  describe 'index full_index option' do
+    context 'without tenant full_indexes option specified' do
+      it 'adds the tenant field on each index' do
+        expect(IndexableWithoutFullIndexes).to have_index_for(tenant_id: 1, title: 1)
+      end
+
+      it 'adds the tenant field on the index with full_index: true' do
+        expect(IndexableWithoutFullIndexes).to have_index_for(tenant_id: 1, name: 1)
+      end
+
+      it 'does not add the tenant field on the index with full_index: false' do
+        expect(IndexableWithoutFullIndexes).not_to have_index_for(tenant_id: 1, slug: 1)
+        expect(IndexableWithoutFullIndexes).to have_index_for(slug: 1)
+      end
+    end
+
+    context 'with full_indexes: true' do
+      it 'adds the tenant field on each index' do
+        expect(IndexableWithFullIndexesTrue).to have_index_for(tenant_id: 1, title: 1)
+      end
+
+      it 'does not add the tenant field on the index with full_index: false' do
+        expect(IndexableWithFullIndexesTrue).not_to have_index_for(tenant_id: 1, name: 1)
+        expect(IndexableWithFullIndexesTrue).to have_index_for(name: 1)
+      end
+    end
+
+    context 'with full_indexes: false' do
+      it 'does not add the tenant field on each index' do
+        expect(IndexableWithFullIndexesFalse).not_to have_index_for(tenant_id: 1, title: 1)
+        expect(IndexableWithFullIndexesFalse).to have_index_for(title: 1)
+      end
+
+      it 'does add the tenant field on the index with full_index: true' do
+        expect(IndexableWithFullIndexesFalse).to have_index_for(tenant_id: 1, name: 1)
+      end
+    end
+  end
+end

data/spec/inheritance_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Inheritance' do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  before do
+    Mongoid::Multitenancy.current_tenant = client
+  end
+
+  describe 'class' do
+    it 'uses inheritance pattern' do
+      MutableChild.create!(title: 'title X', slug: 'page-x')
+      expect(Mutable.last).to be_a MutableChild
+    end
+
+    it 'keeps options' do
+      expect(AnotherMutableChild.new(title: 'title X', slug: 'page-x')).to be_valid
+    end
+  end
+end

data/spec/mandatory_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Mandatory do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  let(:item) do
+    Mandatory.new(title: 'title X', slug: 'page-x')
+  end
+
+  it_behaves_like 'a tenantable model'
+  it { is_expected.to validate_tenant_uniqueness_of(:slug) }
+
+  describe '.shared' do
+    it 'is defined' do
+      expect(Mandatory).to respond_to(:shared)
+    end
+  end
+
+  describe '.unshared' do
+    it 'is defined' do
+      expect(Mandatory).to respond_to(:unshared)
+    end
+  end
+
+  describe '.default_scope' do
+    before do
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = Mandatory.create!(title: 'title X', slug: 'article-x') }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = Mandatory.create!(title: 'title Y', slug: 'article-y') }
+    end
+
+    context 'with a current tenant' do
+      before do
+        Mongoid::Multitenancy.current_tenant = another_client
+      end
+
+      it 'filters on the current tenant' do
+        expect(Mandatory.all.to_a).to match_array [@itemY]
+      end
+    end
+
+    context 'without a current tenant' do
+      before do
+        Mongoid::Multitenancy.current_tenant = nil
+      end
+
+      it 'does not filter on any tenant' do
+        expect(Mandatory.all.to_a).to match_array [@itemX, @itemY]
+      end
+    end
+  end
+
+  describe '#delete_all' do
+    before do
+      Mongoid::Multitenancy.with_tenant(client) { @itemX = Mandatory.create!(title: 'title X', slug: 'article-x') }
+      Mongoid::Multitenancy.with_tenant(another_client) { @itemY = Mandatory.create!(title: 'title Y', slug: 'article-y') }
+    end
+
+    context 'with a current tenant' do
+      it 'only deletes the current tenant' do
+        Mongoid::Multitenancy.with_tenant(another_client) { Mandatory.delete_all }
+        expect(Mandatory.all.to_a).to match_array [@itemX]
+      end
+    end
+
+    context 'without a current tenant' do
+      it 'deletes all the items' do
+        Mandatory.delete_all
+        expect(Mandatory.all.to_a).to be_empty
+      end
+    end
+  end
+
+  describe '#valid?' do
+    context 'with a tenant' do
+      before do
+        Mongoid::Multitenancy.current_tenant = client
+      end
+
+      it 'is valid' do
+        expect(item).to be_valid
+      end
+
+      context 'with a uniqueness constraint' do
+        let(:duplicate) do
+          Mandatory.new(title: 'title Y', slug: 'page-x')
+        end
+
+        before do
+          item.save!
+        end
+
+        it 'does not allow duplicates on the same tenant' do
+          expect(duplicate).not_to be_valid
+        end
+
+        it 'allow duplicates on a different same tenant' do
+          Mongoid::Multitenancy.with_tenant(another_client) do
+            expect(duplicate).to be_valid
+          end
+        end
+      end
+    end
+
+    context 'without a tenant' do
+      it 'is not valid' do
+        expect(item).not_to be_valid
+      end
+    end
+  end
+end

data/spec/models/account.rb

@@ -0,0 +1,5 @@
+class Account
+  include Mongoid::Document
+
+  field :name, type: String
+end

data/spec/models/immutable.rb

@@ -0,0 +1,15 @@
+class Immutable
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:tenant, class_name: 'Account', immutable: true)
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/models/indexable.rb

@@ -0,0 +1,61 @@
+class IndexableWithoutIndex
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account'
+end
+
+class IndexableWithIndexTrue
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', index: true
+end
+
+class IndexableWithIndexFalse
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', index: false
+end
+
+class IndexableWithoutFullIndexes
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, type: String
+  field :name, type: String
+  field :slug, type: String
+
+  tenant :tenant, class_name: 'Account'
+
+  index(title: 1)
+  index({ name: 1 }, { full_index: true })
+  index({ slug: 1 }, { full_index: false })
+end
+
+class IndexableWithFullIndexesFalse
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, type: String
+  field :name, type: String
+
+  tenant :tenant, class_name: 'Account', full_indexes: false
+
+  index(title: 1)
+  index({ name: 1 }, { full_index: true })
+end
+
+class IndexableWithFullIndexesTrue
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  field :title, type: String
+  field :name, type: String
+
+  tenant :tenant, class_name: 'Account', full_indexes: true
+
+  index(title: 1)
+  index({ name: 1 }, { full_index: false })
+end

data/spec/models/mandatory.rb

@@ -0,0 +1,15 @@
+class Mandatory
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:tenant, class_name: 'Account')
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/models/mutable.rb

@@ -0,0 +1,15 @@
+class Mutable
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', immutable: false, optional: false
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/models/mutable_child.rb

@@ -0,0 +1,9 @@
+require 'models/mutable'
+
+class MutableChild < Mutable
+  field :random, type: String
+end
+
+class AnotherMutableChild < Mutable
+  field :random, type: String
+end

data/spec/models/no_scopable.rb

@@ -0,0 +1,11 @@
+class NoScopable
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant :tenant, class_name: 'Account', scopes: false
+
+  field :slug, type: String
+  field :title, type: String
+
+  index(title: 1)
+end

data/spec/models/optional.rb

@@ -0,0 +1,15 @@
+class Optional
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:tenant, class_name: 'Account', optional: true)
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/models/optional_exclude.rb

@@ -0,0 +1,15 @@
+class OptionalExclude
+  include Mongoid::Document
+  include Mongoid::Multitenancy::Document
+
+  tenant(:tenant, class_name: 'Account', optional: true)
+
+  field :slug, type: String
+  field :title, type: String
+
+  validates_tenant_uniqueness_of :slug, exclude_shared: true
+  validates_presence_of :slug
+  validates_presence_of :title
+
+  index(title: 1)
+end

data/spec/mongoid-multitenancy_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Mongoid::Multitenancy do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  before do
+    Mongoid::Multitenancy.current_tenant = client
+  end
+
+  describe '.with_tenant' do
+    it 'changes temporary the current tenant within the block' do
+      Mongoid::Multitenancy.with_tenant(another_client) do
+        expect(Mongoid::Multitenancy.current_tenant).to eq another_client
+      end
+    end
+
+    it 'restores the current tenant after the block' do
+      Mongoid::Multitenancy.with_tenant(another_client) { ; }
+      expect(Mongoid::Multitenancy.current_tenant).to eq client
+    end
+
+    context 'when the block fails' do
+      it 'restores the current tenant' do
+        begin
+          Mongoid::Multitenancy.with_tenant(another_client) { raise StandardError }
+        rescue StandardError; end
+        expect(Mongoid::Multitenancy.current_tenant).to eq client
+      end
+    end
+  end
+end

data/spec/mutable_child_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe MutableChild do
+  let(:client) do
+    Account.create!(name: 'client')
+  end
+
+  let(:another_client) do
+    Account.create!(name: 'another client')
+  end
+
+  let(:item) do
+    MutableChild.new(title: 'title X', slug: 'page-x')
+  end
+
+  it_behaves_like 'a tenantable model'
+
+  describe '#valid?' do
+    before do
+      Mongoid::Multitenancy.current_tenant = client
+    end
+
+    context 'when the tenant has not changed' do
+      before do
+        item.save!
+      end
+
+      it 'is valid' do
+        item.title = 'title X (2)'
+        expect(item).to be_valid
+      end
+    end
+
+    context 'when the tenant has changed' do
+      before do
+        item.save!
+        Mongoid::Multitenancy.current_tenant = another_client
+      end
+
+      it 'is valid' do
+        item.tenant = another_client
+        expect(item).to be_valid
+      end
+    end
+  end
+end