activerecord-multi-tenant 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 261f0a075c9a14524dfc43455a030e710bd140a1
-  data.tar.gz: 3bdd3d5ef7aec6fa07d67a8226a600accb3eeadd
+  metadata.gz: 1c30e8a7b37b923b66c5043fb73f3c9e776cea85
+  data.tar.gz: 63a2537270723a549cab19a3a75e5c9eaee4fdac
 SHA512:
-  metadata.gz: 2b2c5621e0de6308ebc36169873318fd4975e7b54ae7e409a05d58978f65407e8ef6e99e82e2f7399dafdfb659421123cb849e825b93426c28e742ea4ff434a8
-  data.tar.gz: 0ced6530c9654b4dcfc4d326d6c97a1225d4a47b2300221a8b2fbf05ec3243fc27af128b9da975c73053d23235c333ff79fd10aaf378f7c0f3fb0c844395b4f0
+  metadata.gz: 5fe0741bcd4279f6852aa8fc64a25921bb8fb9953cbce564a81ec611602bc0321ca6ededc84ade5053795d64c3e1d3b2a055c6e5c19aa54003ea18c65aa5651e
+  data.tar.gz: f59653a116f517ceafdd91677518113299bf86b281259a0816c66299c3ac5b2fa8ec2d347078034ace050adb21aeb12c40ff476e36fe8f9e238f695d99c1f3ad

data/.travis.yml

@@ -1,12 +1,11 @@
+sudo: required
+cache: bundler
+
 language: ruby
 
 rvm:
   - 2.1
-  - 2.2.6
   - 2.3.3
-  - 2.4
-
-script: "bundle exec rake spec"
 
 gemfile:
   - gemfiles/rails_3.2.gemfile
@@ -21,5 +20,12 @@ matrix:
     - gemfile: gemfiles/rails_5.0.gemfile
       rvm: 2.1
 
-sudo: false
-cache: bundler
+services:
+  - docker
+
+before_install:
+  - docker-compose up -d
+  - sleep 5 # wait for postgres to become available
+
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.4.0       2017-03-22
+
+* Infer multi_tenant setting from parent classes [@webandtech](https://github.com/webandtech) [#6](https://github.com/citusdata/activerecord-multi-tenant/pull/6)
+* Remove use of global tenant klass variable [@webandtech](https://github.com/webandtech) [#6](https://github.com/citusdata/activerecord-multi-tenant/pull/6)
+* Support passing ID values to MultiTenant.with directly [@webandtech](https://github.com/webandtech) [#6](https://github.com/citusdata/activerecord-multi-tenant/pull/6)
+  * This effectively deprecates with_id, but we'll keep it around for now
+* Remove unnecessary validation for invalid belongs_to association
+
+
 ## 0.3.4       2017-02-22
 
 * Expand with_lock workaround to cover lock! as well

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 

data/README.md

@@ -69,7 +69,11 @@ end
 
 * **What if I have a table that doesn't relate to my tenant?** (e.g. templates that are the same in every account)
 
-  We recommend not using activerecord-multi-tenant on these tables. In case only some records in a table are not associated to a tenant (i.e. your templates are in the same table as actual objects), we recommend setting the tenant_id to 0, and then using MultiTenant.with_id(0) to access these objects.
+  We recommend not using activerecord-multi-tenant on these tables. In case only some records in a table are not associated to a tenant (i.e. your templates are in the same table as actual objects), we recommend setting the tenant_id to 0, and then using MultiTenant.with(0) to access these objects.
+
+* **What if my tenant model is not defined in my application?**
+
+  The tenant model does not have to be defined. Use the gem as if the model was present. `MultiTenant.with` accepts either a tenant id or model instance.
 
 ## Credits
 

data/gemfiles/rails_3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -45,7 +45,7 @@ GEM
     diff-lcs (1.3)
     erubis (2.7.0)
     hike (1.2.3)
-    i18n (0.8.0)
+    i18n (0.8.1)
     journey (1.0.4)
     json (1.8.6)
     mail (2.5.4)
@@ -53,7 +53,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     multi_json (1.12.1)
-    pg (0.19.0)
+    pg (0.20.0)
     polyglot (0.3.5)
     power_assert (1.0.1)
     rack (1.4.7)

data/gemfiles/rails_4.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -38,11 +38,11 @@ GEM
       thor (>= 0.14.0)
     arel (4.0.2)
     builder (3.1.4)
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     database_cleaner (1.3.0)
     diff-lcs (1.3)
     erubis (2.7.0)
-    i18n (0.8.0)
+    i18n (0.8.1)
     mail (2.6.4)
       mime-types (>= 1.16, < 4)
     mime-types (3.1)
@@ -50,7 +50,7 @@ GEM
     mime-types-data (3.2016.0521)
     minitest (4.7.5)
     multi_json (1.12.1)
-    pg (0.19.0)
+    pg (0.20.0)
     rack (1.5.5)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -98,7 +98,7 @@ GEM
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
     thor (0.19.4)
-    thread_safe (0.3.5)
+    thread_safe (0.3.6)
     tzinfo (0.3.52)
 
 PLATFORMS

data/gemfiles/rails_4.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -40,11 +40,11 @@ GEM
       thor (>= 0.14.0)
     arel (5.0.1.20140414130214)
     builder (3.2.3)
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     database_cleaner (1.3.0)
     diff-lcs (1.3)
     erubis (2.7.0)
-    i18n (0.8.0)
+    i18n (0.8.1)
     json (1.8.6)
     mail (2.6.4)
       mime-types (>= 1.16, < 4)
@@ -52,7 +52,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     minitest (5.10.1)
-    pg (0.19.0)
+    pg (0.20.0)
     rack (1.5.5)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -102,7 +102,7 @@ GEM
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
     thor (0.19.4)
-    thread_safe (0.3.5)
+    thread_safe (0.3.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -48,13 +48,13 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.4)
     builder (3.2.3)
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     database_cleaner (1.3.0)
     diff-lcs (1.3)
     erubis (2.7.0)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
-    i18n (0.8.0)
+    i18n (0.8.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -64,9 +64,9 @@ GEM
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
-    nokogiri (1.7.0.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
-    pg (0.19.0)
+    pg (0.20.0)
     rack (1.6.5)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -125,7 +125,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     thor (0.19.4)
-    thread_safe (0.3.5)
+    thread_safe (0.3.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activerecord-multi-tenant (0.3.4)
+    activerecord-multi-tenant (0.4.0)
       rails (>= 3.1)
       request_store (>= 1.0.5)
 
@@ -51,13 +51,13 @@ GEM
       thor (>= 0.14.0)
     arel (7.1.4)
     builder (3.2.3)
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     database_cleaner (1.3.0)
     diff-lcs (1.3)
     erubis (2.7.0)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
-    i18n (0.8.0)
+    i18n (0.8.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -69,9 +69,9 @@ GEM
     mini_portile2 (2.1.0)
     minitest (5.10.1)
     nio4r (1.2.1)
-    nokogiri (1.7.0.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
-    pg (0.19.0)
+    pg (0.20.0)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -129,7 +129,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     thor (0.19.4)
-    thread_safe (0.3.5)
+    thread_safe (0.3.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     websocket-driver (0.6.5)

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

@@ -1,39 +1,45 @@
 module MultiTenant
   module ModelExtensionsClassMethods
-    def multi_tenant(tenant, options = {})
-      # Workaround for https://github.com/citusdata/citus/issues/687
-      if to_s.underscore.to_sym == tenant
-        before_create -> { self.id ||= self.class.connection.select_value("SELECT nextval('" + [self.class.table_name, self.class.primary_key, 'seq'].join('_') + "'::regclass)") }
-      end
-
-      # Typically we don't need to run on the tenant model itself
-      if to_s.underscore.to_sym != tenant
-        MultiTenant.set_tenant_klass(tenant)
+    DEFAULT_ID_FIELD = 'id'.freeze
 
+    def multi_tenant(tenant_name, options = {})
+      if to_s.underscore.to_sym == tenant_name
+        # This is the tenant model itself. Workaround for https://github.com/citusdata/citus/issues/687
+        before_create -> { self.id ||= self.class.connection.select_value("SELECT nextval('" + [self.class.table_name, self.class.primary_key, 'seq'].join('_') + "'::regclass)") }
+      else
         class << self
           def scoped_by_tenant?
             true
           end
 
+          # Allow partition_key to be set from a superclass if not already set in this class
           def partition_key
-            @partition_key
+            @partition_key ||= ancestors.detect{ |k| k.instance_variable_get(:@partition_key) }
+                                 .try(:instance_variable_get, :@partition_key)
+          end
+
+          # Avoid primary_key errors when using composite primary keys (e.g. id, tenant_id)
+          def primary_key
+            return @primary_key if @primary_key
+            return @primary_key = super || DEFAULT_ID_FIELD if Rails::VERSION::MAJOR < 5
+
+            primary_object_keys = (connection.schema_cache.primary_keys(table_name) || []) - [partition_key]
+            if primary_object_keys.size == 1
+              @primary_key = primary_object_keys.first
+            else
+              @primary_key = DEFAULT_ID_FIELD
+            end
           end
         end
 
-        @partition_key = options[:partition_key] || MultiTenant.partition_key
+        @partition_key = options[:partition_key] || MultiTenant.partition_key(tenant_name)
         partition_key = @partition_key
 
-        # Avoid primary_key erroring out with the typical multi-column primary keys that include the partition key
-        if Rails::VERSION::MAJOR >= 5
-          primary_object_keys = (connection.schema_cache.primary_keys(table_name) || []) - [partition_key]
-          self.primary_key = primary_object_keys.first if primary_object_keys.size == 1
-        else
-          self.primary_key = 'id' if primary_key.nil?
+        # Create an implicit belongs_to association only if tenant class exists
+        if MultiTenant.tenant_klass_defined?(tenant_name)
+          belongs_to tenant_name, options.slice(:class_name, :inverse_of).merge(foreign_key: partition_key)
         end
 
-        # Create the association
-        belongs_to tenant, options.slice(:class_name, :inverse_of).merge(foreign_key: partition_key)
-
         # Ensure all queries include the partition key
         default_scope lambda {
           if MultiTenant.current_tenant_id
@@ -50,43 +56,26 @@ module MultiTenant
           end
         }, on: :create
 
-        # Validate that associations belong to the tenant, currently only for belongs_to
-        polymorphic_foreign_keys = reflect_on_all_associations(:belongs_to).select do |a|
-          a.options[:polymorphic]
-        end.map { |a| a.foreign_key }
-
-        reflect_on_all_associations(:belongs_to).each do |a|
-          unless a == reflect_on_association(tenant) || polymorphic_foreign_keys.include?(a.foreign_key)
-            association_class = a.options[:class_name].nil? ? a.name.to_s.classify.constantize : a.options[:class_name].constantize
-            validates_each a.foreign_key.to_sym do |record, attr, value|
-              primary_key = if association_class.respond_to?(:primary_key)
-                              association_class.primary_key
-                            else
-                              a.primary_key
-                            end.to_sym
-              record.errors.add attr, 'association is invalid [MultiTenant]' unless value.nil? || association_class.where(primary_key => value).any?
-            end
-          end
-        end
-
         to_include = Module.new do
-          define_method "#{partition_key}=" do |integer|
-            write_attribute("#{partition_key}", integer)
+          define_method "#{partition_key}=" do |tenant_id|
+            write_attribute("#{partition_key}", tenant_id)
             raise MultiTenant::TenantIsImmutable if send("#{partition_key}_changed?") && persisted? && !send("#{partition_key}_was").nil?
-            integer
+            tenant_id
           end
 
-          define_method "#{MultiTenant.tenant_klass.to_s}=" do |model|
-            super(model)
-            raise MultiTenant::TenantIsImmutable if send("#{partition_key}_changed?") && persisted? && !send("#{partition_key}_was").nil?
-            model
-          end
+          if MultiTenant.tenant_klass_defined?(tenant_name)
+            define_method "#{tenant_name}=" do |model|
+              super(model)
+              raise MultiTenant::TenantIsImmutable if send("#{partition_key}_changed?") && persisted? && !send("#{partition_key}_was").nil?
+              model
+            end
 
-          define_method "#{MultiTenant.tenant_klass.to_s}" do
-            if !MultiTenant.current_tenant.nil? && !MultiTenant.current_tenant.is_a?(MultiTenant::TenantIdWrapper) && public_send(partition_key) == MultiTenant.current_tenant.id
-              return MultiTenant.current_tenant
-            else
-              super()
+            define_method "#{tenant_name}" do
+              if !MultiTenant.current_tenant_is_id? && MultiTenant.current_tenant_id && public_send(partition_key) == MultiTenant.current_tenant_id
+                return MultiTenant.current_tenant
+              else
+                super()
+              end
             end
           end
         end
@@ -94,7 +83,7 @@ module MultiTenant
 
         around_save -> (record, block) {
           if persisted? && MultiTenant.current_tenant_id.nil?
-            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+            MultiTenant.with(record.public_send(partition_key)) { block.call }
           else
             block.call
           end
@@ -102,7 +91,7 @@ module MultiTenant
 
         around_update -> (record, block) {
           if MultiTenant.current_tenant_id.nil?
-            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+            MultiTenant.with(record.public_send(partition_key)) { block.call }
           else
             block.call
           end
@@ -110,7 +99,7 @@ module MultiTenant
 
         around_destroy -> (record, block) {
           if MultiTenant.current_tenant_id.nil?
-            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+            MultiTenant.with(record.public_send(partition_key)) { block.call }
           else
             block.call
           end

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

@@ -1,18 +1,12 @@
 require 'request_store'
 
 module MultiTenant
-  @@tenant_klass = nil
-
-  def self.set_tenant_klass(klass)
-    @@tenant_klass = klass
-  end
-
-  def self.tenant_klass
-    @@tenant_klass
+  def self.tenant_klass_defined?(tenant_name)
+    !!tenant_name.to_s.classify.safe_constantize
   end
 
-  def self.partition_key
-    "#{@@tenant_klass.to_s}_id"
+  def self.partition_key(tenant_name)
+    "#{tenant_name.to_s}_id"
   end
 
   # Workaroud to make "with_lock" work until https://github.com/citusdata/citus/issues/1236 is fixed
@@ -28,43 +22,28 @@ module MultiTenant
     RequestStore.store[:current_tenant]
   end
 
-  def self.current_tenant_id=(tenant_id)
-    self.current_tenant = TenantIdWrapper.new(id: tenant_id)
+  def self.current_tenant_id
+    current_tenant_is_id? ? current_tenant : current_tenant.try(:id)
   end
 
-  def self.current_tenant_id
-    current_tenant.try(:id)
+  def self.current_tenant_is_id?
+    current_tenant.is_a?(String) || current_tenant.is_a?(Integer)
   end
 
   def self.with(tenant, &block)
+    return block.call if self.current_tenant == tenant
     old_tenant = self.current_tenant
-    self.current_tenant = tenant
-    value = block.call
-    return value
-
-  ensure
-    self.current_tenant = old_tenant
-  end
-
-  def self.with_id(tenant_id, &block)
-    if MultiTenant.current_tenant_id == tenant_id
-      block.call
-    else
-      MultiTenant.with(TenantIdWrapper.new(id: tenant_id), &block)
+    begin
+      self.current_tenant = tenant
+      return block.call
+    ensure
+      self.current_tenant = old_tenant
     end
   end
 
-  class TenantIsImmutable < StandardError
-  end
-
-  class TenantIdWrapper
-    attr_reader :id
+  # Preserve backward compatibility for people using .with_id
+  singleton_class.send(:alias_method, :with_id, :with)
 
-    def initialize(id:)
-      @id = id
-    end
-
-    def new_record?; true; end
-    def touch; nil; end
+  class TenantIsImmutable < StandardError
   end
 end

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

@@ -1,3 +1,3 @@
 module MultiTenant
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

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

@@ -56,6 +56,15 @@ describe MultiTenant do
     it { expect(@custom_partition_key_task.account).to eq(@account) }
   end
 
+  describe 'Tenant model not defined' do
+    before do
+      MultiTenant.current_tenant = 77
+      @partition_key_not_model_task = PartitionKeyNotModelTask.create! name: 'foo'
+    end
+
+    it { expect(@partition_key_not_model_task.non_model_id).to be 77 }
+  end
+
   # Scoping models
   describe 'Project.all should be scoped to the current tenant if set' do
     before do
@@ -77,7 +86,7 @@ describe MultiTenant do
     before do
       @account = Account.create! name: 'foo'
       @project = @account.projects.create! name: 'foobar'
-      MultiTenant.current_tenant= @account1
+      MultiTenant.current_tenant = @account1
     end
 
     it { @project.account }
@@ -137,6 +146,40 @@ describe MultiTenant do
     end
   end
 
+  describe 'Subclass of Multi Tenant Model' do
+    let(:account) { Account.create!(name: 'foo') }
+    let(:project) { Project.create!(name: 'project', account: account) }
+    let(:task) { project.tasks.create!(name: 'task') }
+    let(:sti_task) { StiSubTask.create!(task: task, name: 'sub task') }
+
+    it 'has partition key' do
+      expect(StiSubTask.partition_key).to eq 'account_id'
+      expect(StiSubTask.instance_variable_get(:@partition_key)).to eq 'account_id'
+    end
+
+    it 'has primary key' do
+      expect(StiSubTask.primary_key).to eq 'id'
+    end
+
+    it 'handles belongs_to through' do
+      MultiTenant.with(account) do
+        expect(sti_task.project).to eq project
+      end
+    end
+
+    it 'handles has_many through' do
+      MultiTenant.with(account) do
+        expect(project.sub_tasks).to eq [sti_task]
+      end
+    end
+
+    it 'handles unscoped' do
+      MultiTenant.with(account) do
+        expect(StiSubTask.unscoped.find(sti_task.id)).to eq sti_task
+      end
+    end
+  end
+
   # ::with
   describe "::with" do
     it "should set current_tenant to the specified tenant inside the block" do

data/spec/schema.rb

@@ -28,6 +28,7 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
     t.column :account_id, :integer
     t.column :name, :string
     t.column :task_id, :integer
+    t.column :type, :string
   end
 
   create_table :countries, force: true do |t|
@@ -55,6 +56,11 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
     t.column :commentable_type, :string
   end
 
+  create_table :partition_key_not_model_tasks, force: true, partition_key: :non_model_id do |t|
+    t.column :non_model_id, :integer
+    t.column :name, :string
+  end
+
   create_distributed_table :accounts, :id
   create_distributed_table :projects, :account_id
   create_distributed_table :managers, :account_id
@@ -63,6 +69,7 @@ ARGV.grep(/\w+_spec\.rb/).empty? && ActiveRecord::Schema.define(version: 1) do
   create_distributed_table :aliased_tasks, :account_id
   create_distributed_table :custom_partition_key_tasks, :accountID
   create_distributed_table :comments, :account_id
+  create_distributed_table :partition_key_not_model_tasks, :non_model_id
 end
 
 class Account < ActiveRecord::Base
@@ -104,6 +111,9 @@ class SubTask < ActiveRecord::Base
   has_one :project, through: :task
 end
 
+class StiSubTask < SubTask
+end
+
 class UnscopedModel < ActiveRecord::Base
   validates_uniqueness_of :name
 end
@@ -123,6 +133,10 @@ class CustomPartitionKeyTask < ActiveRecord::Base
   end
 end
 
+class PartitionKeyNotModelTask < ActiveRecord::Base
+  multi_tenant :non_model
+end
+
 class Comment < ActiveRecord::Base
   multi_tenant :account
   belongs_to :commentable, polymorphic: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Citus Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store