activerecord-multi-tenant 0.2.1 → 0.3.0

data/lib/activerecord-multi-tenant/version.rb

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/activerecord-multi-tenant/controller_extensions_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class Account
+  attr_accessor :name
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  set_current_tenant_through_filter
+  before_action :your_method_that_finds_the_current_tenant
+
+  def your_method_that_finds_the_current_tenant
+    current_account = Account.new
+    current_account.name = 'account1'
+    set_current_tenant(current_account)
+  end
+end
+
+describe ApplicationController, type: :controller do
+  controller do
+    def index
+      render body: 'custom called'
+    end
+  end
+
+  it 'Finds the correct tenant using the filter command' do
+    get :index
+    expect(MultiTenant.current_tenant.name).to eq 'account1'
+  end
+end

data/spec/activerecord-multi-tenant/model_extensions_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+describe MultiTenant do
+  after { MultiTenant.current_tenant = nil }
+
+  # Setting and getting
+  describe 'Setting the current tenant' do
+    before { MultiTenant.current_tenant = :foo }
+    it { MultiTenant.current_tenant == :foo }
+  end
+
+  describe 'is_scoped_as_tenant should return the correct value when true' do
+    it {expect(Project.respond_to?(:scoped_by_tenant?)).to eq(true)}
+  end
+
+  describe 'is_scoped_as_tenant should return the correct value when false' do
+    it {expect(UnscopedModel.respond_to?(:scoped_by_tenant?)).to eq(false)}
+  end
+
+  context 'immutability' do
+    before do
+      @account = Account.create! name: 'foo'
+      @project = @account.projects.create! name: 'bar'
+    end
+
+    describe 'tenant_id should be immutable, if already set' do
+      it { expect { @project.account_id = @account.id + 1 }.to raise_error(MultiTenant::TenantIsImmutable) }
+    end
+
+    describe 'setting tenant_id to the same value should not error' do
+      it { expect { @project.account_id = @account.id }.not_to raise_error }
+    end
+
+    describe 'setting tenant_id to a string with same to_i value should not error' do
+      it { expect { @project.account_id = @account.id.to_s }.not_to raise_error }
+    end
+  end
+
+  describe 'tenant_id should auto populate after initialization' do
+    before do
+      @account = Account.create! name: 'foo'
+      MultiTenant.current_tenant = @account
+    end
+    it {expect(Project.new.account_id).to eq(@account.id)}
+  end
+
+  describe 'Handles custom partition_key on tenant model' do
+    before do
+      @account  = Account.create! name: 'foo'
+      MultiTenant.current_tenant = @account
+      @custom_partition_key_task = CustomPartitionKeyTask.create! name: 'foo'
+    end
+
+    it { expect(@custom_partition_key_task.account).to eq(@account) }
+  end
+
+  # Scoping models
+  describe 'Project.all should be scoped to the current tenant if set' do
+    before do
+      @account1 = Account.create! name: 'foo'
+      @account2 = Account.create! name: 'bar'
+
+      @project1 = @account1.projects.create! name: 'foobar'
+      @project2 = @account2.projects.create! name: 'baz'
+
+      MultiTenant.current_tenant = @account1
+      @projects = Project.all
+    end
+
+    it { expect(@projects.length).to eq(1) }
+    it { expect(@projects).to eq([@project1]) }
+  end
+
+  describe 'Querying the tenant from a scoped model with a tenant set' do
+    before do
+      @account = Account.create! name: 'foo'
+      @project = @account.projects.create! name: 'foobar'
+      MultiTenant.current_tenant= @account1
+    end
+
+    it { @project.account }
+  end
+
+  # Associations
+  describe 'Associations should be correctly scoped by current tenant' do
+    before do
+      @account = Account.create! name: 'foo'
+      @project = Project.create! name: 'foobar', account: @account
+
+      MultiTenant.current_tenant = @account
+      @task = @project.tasks.create! name: 'baz'
+    end
+
+    it 'should correctly set the tenant on the task created with current_tenant set' do
+      expect(@task.account).to eq(@account)
+    end
+  end
+
+  describe "It should be possible to use aliased associations" do
+    before do
+      @account = Account.create! name: 'baz'
+      MultiTenant.current_tenant = @account
+    end
+
+    it { expect(AliasedTask.create(:name => 'foo', :project_alias => @project2).valid?).to eq(true) }
+  end
+
+  describe "It should be possible to use associations with partition_key from polymorphic" do
+    before do
+      @account = Account.create!(name: 'foo')
+      MultiTenant.current_tenant = @account
+      @project = Project.create!(name: 'project', account: @account)
+      @comment = Comment.new commentable: @project, account: @account
+    end
+
+    it { expect(@comment.save!).to eq(true) }
+  end
+
+  # ::with
+  describe "::with" do
+    it "should set current_tenant to the specified tenant inside the block" do
+      @account = Account.create!(:name => 'baz')
+
+      MultiTenant.with(@account) do
+        expect(MultiTenant.current_tenant).to eq(@account)
+      end
+    end
+
+    it "should reset current_tenant to the previous tenant once exiting the block" do
+      @account1 = Account.create!(:name => 'foo')
+      @account2 = Account.create!(:name => 'bar')
+
+      MultiTenant.current_tenant = @account1
+      MultiTenant.with @account2 do
+
+      end
+
+      expect(MultiTenant.current_tenant).to eq(@account1)
+    end
+
+    it "should return the value of the block" do
+      @account1 = Account.create!(:name => 'foo')
+      @account2 = Account.create!(:name => 'bar')
+
+      MultiTenant.current_tenant = @account1
+      value = MultiTenant.with @account2 do
+        "something"
+      end
+
+      expect(value).to eq "something"
+    end
+  end
+end

data/spec/activerecord-multi-tenant/record_callback_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+class ProjectWithCallbacks < ActiveRecord::Base
+  self.table_name = :projects
+
+  multi_tenant :account
+
+  after_update do |record|
+    # Ensure that we don't have TenantIdWrapper here
+    record.account.update! name: 'callback'
+  end
+end
+
+describe MultiTenant, 'Callbacks' do
+  let(:account) { Account.create! name: 'test' }
+  let(:project) { ProjectWithCallbacks.create! account: account, name: 'something' }
+
+  it 'takes callbacks into account' do
+    project.update! name: 'something else'
+    expect(account.reload.name).to eq 'callback'
+  end
+end

data/spec/activerecord-multi-tenant/record_finding_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe MultiTenant, 'Record finding' do
+  it 'searches for tenant object using the scope' do
+    account = Account.create! name: 'test'
+    project = account.projects.create! name: 'something'
+    MultiTenant.with(account) do
+      expect(Project.find(project.id)).to be_present
+    end
+  end
+end

data/spec/activerecord-multi-tenant/record_modifications_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe MultiTenant, 'Record modifications' do
+  let(:account) { Account.create! name: 'test' }
+  let(:project) { account.projects.create! name: 'something' }
+
+  it 'includes the tenant_id in UPDATEs' do
+    project.update! name: 'something else'
+    MultiTenant.with(account) do
+      expect(Project.find(project.id).name).to eq 'something else'
+    end
+  end
+
+  it 'includes the tenant_id in DELETEs' do
+    project.destroy!
+    MultiTenant.with(account) do
+      expect(Project.find_by(id: project.id)).not_to be_present
+    end
+  end
+end

data/spec/database.yml

@@ -0,0 +1,9 @@
+test:
+  adapter: postgresql
+  username: postgres
+  database: postgres
+  host: localhost
+  port: 5600
+  pool: 5
+  timeout: 5000
+  prepared_statements: false

data/spec/schema.rb

@@ -0,0 +1,104 @@
+false && ActiveRecord::Schema.define(version: 1) do
+  create_table :accounts, force: true do |t|
+    t.column :name, :string
+    t.column :subdomain, :string
+    t.column :domain, :string
+  end
+
+  create_table :projects, force: true, partition_key: :account_id do |t|
+    t.column :name, :string
+    t.column :account_id, :integer
+  end
+
+  create_table :managers, force: true, partition_key: :account_id do |t|
+    t.column :name, :string
+    t.column :project_id, :integer
+    t.column :account_id, :integer
+  end
+
+  create_table :tasks, force: true, partition_key: :account_id do |t|
+    t.column :name, :string
+    t.column :account_id, :integer
+    t.column :project_id, :integer
+    t.column :completed, :boolean
+  end
+
+  create_table :countries, force: true do |t|
+    t.column :name, :string
+  end
+
+  create_table :unscoped_models, force: true do |t|
+    t.column :name, :string
+  end
+
+  create_table :aliased_tasks, force: true, partition_key: :account_id do |t|
+    t.column :name, :string
+    t.column :project_alias_id, :integer
+    t.column :account_id, :integer
+  end
+
+  create_table :custom_partition_key_tasks, force: true, partition_key: :accountID do |t|
+    t.column :name, :string
+    t.column :accountID, :integer
+  end
+
+  create_table :comments, force: true, partition_key: :account_id do |t|
+    t.column :commentable_id, :integer
+    t.column :commentable_type, :string
+    t.column :account_id, :integer
+  end
+
+  create_distributed_table :accounts, :id
+  create_distributed_table :projects, :account_id
+  create_distributed_table :managers, :account_id
+  create_distributed_table :tasks, :account_id
+  create_distributed_table :aliased_tasks, :account_id
+  create_distributed_table :custom_partition_key_tasks, :accountID
+  create_distributed_table :comments, :account_id
+end
+
+class Account < ActiveRecord::Base
+  multi_tenant :account
+  has_many :projects
+end
+
+class Project < ActiveRecord::Base
+  multi_tenant :account
+  has_one :manager
+  has_many :tasks
+
+  validates_uniqueness_of :name, scope: [:account]
+end
+
+class Manager < ActiveRecord::Base
+  multi_tenant :account
+  belongs_to :project
+end
+
+class Task < ActiveRecord::Base
+  multi_tenant :account
+  belongs_to :project
+  default_scope -> { where(completed: nil).order('name') }
+
+  validates_uniqueness_of :name
+end
+
+class UnscopedModel < ActiveRecord::Base
+  validates_uniqueness_of :name
+end
+
+class AliasedTask < ActiveRecord::Base
+  multi_tenant :account
+  belongs_to :project_alias, class_name: 'Project'
+end
+
+class CustomPartitionKeyTask < ActiveRecord::Base
+  multi_tenant :account, partition_key: 'accountID'
+  validates_uniqueness_of :name, scope: [:account]
+end
+
+class Comment < ActiveRecord::Base
+  multi_tenant :account
+  belongs_to :commentable, polymorphic: true
+  belongs_to :task, -> { where(comments: { commentable_type: 'Task'  }) }, foreign_key: 'commentable_id'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'rspec/rails'
+require 'database_cleaner'
+
+require 'activerecord-multi-tenant'
+
+dbconfig = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(dbconfig['test'])
+
+RSpec.configure do |config|
+  config.after(:each) do
+    MultiTenant.current_tenant = nil
+  end
+
+  config.before(:suite) do
+    DatabaseCleaner[:active_record].strategy = :transaction
+    DatabaseCleaner[:active_record].clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner[:active_record].start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner[:active_record].clean
+  end
+
+  config.infer_base_class_for_anonymous_controllers = true
+end
+
+module MultiTenantTest
+  class Application < Rails::Application; end
+end
+
+MultiTenantTest::Application.config.secret_token = 'x' * 40
+MultiTenantTest::Application.config.secret_key_base = 'y' * 40
+
+require 'schema'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Citus Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: acts_as_tenant
+  name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,13 +100,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- activerecord-multi-tenant.gemspec
+- docker-compose.yml
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_3.2.gemfile.lock
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_4.2.gemfile.lock
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.0.gemfile.lock
 - lib/activerecord-multi-tenant.rb
+- lib/activerecord-multi-tenant/controller_extensions.rb
 - lib/activerecord-multi-tenant/copy_from_client.rb
 - lib/activerecord-multi-tenant/default_scope.rb
 - lib/activerecord-multi-tenant/migrations.rb
+- lib/activerecord-multi-tenant/model_extensions.rb
 - lib/activerecord-multi-tenant/multi_tenant.rb
 - lib/activerecord-multi-tenant/referential_integrity.rb
 - lib/activerecord-multi-tenant/version.rb
+- spec/activerecord-multi-tenant/controller_extensions_spec.rb
+- spec/activerecord-multi-tenant/model_extensions_spec.rb
+- spec/activerecord-multi-tenant/record_callback_spec.rb
+- spec/activerecord-multi-tenant/record_finding_spec.rb
+- spec/activerecord-multi-tenant/record_modifications_spec.rb
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb
 homepage: https://github.com/citusdata/activerecord-multi-tenant
 licenses:
 - MIT