activerecord-multi-tenant 0.2.1 → 0.3.0

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,6 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "4.2.7.1"

data/gemfiles/rails_4.2.gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    builder (3.2.2)
+    concurrent-ruby (1.0.4)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nokogiri (1.7.0)
+      mini_portile2 (~> 2.1.0)
+    rack (1.6.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  rails (= 4.2.7.1)
+
+BUNDLED WITH
+   1.11.2

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,6 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "5.0.1"

data/gemfiles/rails_5.0.gemfile.lock

@@ -0,0 +1,115 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.1)
+      actionpack (= 5.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    builder (3.2.2)
+    concurrent-ruby (1.0.4)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (1.2.1)
+    nokogiri (1.7.0)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.1)
+      actioncable (= 5.0.1)
+      actionmailer (= 5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      activemodel (= 5.0.1)
+      activerecord (= 5.0.1)
+      activesupport (= 5.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  rails (= 5.0.1)
+
+BUNDLED WITH
+   1.11.2

data/lib/activerecord-multi-tenant.rb

@@ -1,6 +1,8 @@
+require 'activerecord-multi-tenant/controller_extensions'
 require 'activerecord-multi-tenant/copy_from_client'
 require 'activerecord-multi-tenant/default_scope'
 require 'activerecord-multi-tenant/migrations'
+require 'activerecord-multi-tenant/model_extensions'
 require 'activerecord-multi-tenant/multi_tenant'
 require 'activerecord-multi-tenant/referential_integrity'
 require 'activerecord-multi-tenant/version'

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

@@ -0,0 +1,22 @@
+module MultiTenant
+  module ControllerExtensions
+    def set_current_tenant_through_filter
+      self.class_eval do
+        helper_method :current_tenant
+
+        private
+          def set_current_tenant(current_tenant_object)
+            MultiTenant.current_tenant = current_tenant_object
+          end
+
+          def current_tenant
+            MultiTenant.current_tenant
+          end
+      end
+    end
+  end
+end
+
+if defined?(ActionController::Base)
+  ActionController::Base.extend MultiTenant::ControllerExtensions
+end

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

@@ -3,7 +3,7 @@ class ActiveRecord::Base
     alias :unscoped_orig :unscoped
     def unscoped
       if respond_to?(:scoped_by_tenant?) && MultiTenant.current_tenant_id
-        unscoped_orig.where(arel_table[MultiTenant.partition_key].eq(MultiTenant.current_tenant_id))
+        unscoped_orig.where(arel_table[self.partition_key].eq(MultiTenant.current_tenant_id))
       else
         unscoped_orig
       end

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

@@ -27,7 +27,7 @@ module ActiveRecord
         ret = orig_create_table(table_name, options.except(:partition_key), &block)
         if options[:partition_key] && options[:partition_key].to_s != 'id'
           execute "ALTER TABLE #{table_name} DROP CONSTRAINT #{table_name}_pkey"
-          execute "ALTER TABLE #{table_name} ADD PRIMARY KEY(id, #{options[:partition_key]})"
+          execute "ALTER TABLE #{table_name} ADD PRIMARY KEY(id, \"#{options[:partition_key]}\")"
         end
         ret
       end

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

@@ -0,0 +1,120 @@
+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
+        # Provide fallback primary key setting to ease integration with the typical Rails app
+        self.primary_key = 'id' if primary_key.nil?
+
+        MultiTenant.set_tenant_klass(tenant)
+
+        class << self
+          def scoped_by_tenant?
+            true
+          end
+
+          def partition_key
+            @partition_key
+          end
+        end
+
+        @partition_key = options[:partition_key] || MultiTenant.partition_key
+        partition_key = @partition_key
+
+        # 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
+            where(partition_key.to_sym => MultiTenant.current_tenant_id)
+          else
+            Rails::VERSION::MAJOR < 4 ? scoped : all
+          end
+        }
+
+        # New instances should have the tenant set
+        before_validation Proc.new { |record|
+          if MultiTenant.current_tenant_id && record.public_send(partition_key.to_sym).nil?
+            record.public_send("#{partition_key}=".to_sym, MultiTenant.current_tenant_id)
+          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)
+            raise MultiTenant::TenantIsImmutable if send("#{partition_key}_changed?") && persisted? && !send("#{partition_key}_was").nil?
+            integer
+          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
+
+          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()
+            end
+          end
+        end
+        include to_include
+
+        around_save -> (record, block) {
+          if persisted? && MultiTenant.current_tenant_id.nil?
+            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+          else
+            block.call
+          end
+        }
+
+        around_update -> (record, block) {
+          if MultiTenant.current_tenant_id.nil?
+            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+          else
+            block.call
+          end
+        }
+
+        around_destroy -> (record, block) {
+          if MultiTenant.current_tenant_id.nil?
+            MultiTenant.with_id(record.public_send(partition_key)) { block.call }
+          else
+            block.call
+          end
+        }
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend(MultiTenant::ModelExtensionsClassMethods)
+end

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

@@ -1,30 +1,51 @@
-# Note that the actual details here are subject to change, and you should avoid
-# calling acts_as_tenant methods directly as a user of this library
-require 'acts_as_tenant'
+require 'request_store'
 
 module MultiTenant
-  def self.current_tenant
-    ActsAsTenant.current_tenant
+  @@tenant_klass = nil
+
+  def self.set_tenant_klass(klass)
+    @@tenant_klass = klass
+  end
+
+  def self.tenant_klass
+    @@tenant_klass
+  end
+
+  def self.partition_key
+    "#{@@tenant_klass.to_s}_id"
   end
 
   def self.current_tenant=(tenant)
-    ActsAsTenant.current_tenant = tenant
+    RequestStore.store[:current_tenant] = tenant
+  end
+
+  def self.current_tenant
+    RequestStore.store[:current_tenant]
   end
 
   def self.current_tenant_id
-    ActsAsTenant.current_tenant.try(:id)
+    current_tenant.try(:id)
   end
 
   def self.with(tenant, &block)
-    ActsAsTenant.with_tenant(tenant, &block)
-  end
+    old_tenant = self.current_tenant
+    self.current_tenant = tenant
+    value = block.call
+    return value
 
-  def self.partition_key
-    ActsAsTenant.fkey
+  ensure
+    self.current_tenant = old_tenant
   end
 
   def self.with_id(tenant_id, &block)
-    MultiTenant.with(TenantIdWrapper.new(id: tenant_id), &block)
+    if MultiTenant.current_tenant_id == tenant_id
+      block.call
+    else
+      MultiTenant.with(TenantIdWrapper.new(id: tenant_id), &block)
+    end
+  end
+
+  class TenantIsImmutable < StandardError
   end
 
   class TenantIdWrapper
@@ -37,36 +58,4 @@ module MultiTenant
     def new_record?; true; end
     def touch; nil; end
   end
-
-  module ModelExtensions
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def multi_tenant(tenant, options = {})
-        # Provide fallback primary key setting to ease integration with the typical Rails app
-        self.primary_key = 'id' if primary_key.nil?
-
-        # Typically we don't need to run on the tenant model itself
-        if to_s.underscore.to_sym != tenant
-          belongs_to(tenant)
-          acts_as_tenant(tenant, options)
-
-          around_save -> (record, block) { persisted? ? MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } : block.call }
-          around_update -> (record, block) { MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } }
-          around_destroy -> (record, block) { MultiTenant.with_id(record.public_send(tenant.to_s + '_id')) { block.call } }
-        end
-
-        # 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
-      end
-    end
-  end
-end
-
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.send(:include, MultiTenant::ModelExtensions)
 end