activerecord-multi-tenant 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ba6283cdc0a3a6156de1ed6e48674650769dd98a563175e3f0f6ad145e948a1
-  data.tar.gz: 4e60b1920f1b14a6707adf28fbd15135830a46a8085c07912fb5b190d7b677e9
+  metadata.gz: fa2e595cc76e33a877613504121106791680118da0a0c4957ff1190e75e99c3a
+  data.tar.gz: 8a232e3431462d5b8b3972f0825664c210cc51729b2e94d08c5529851365d7f8
 SHA512:
-  metadata.gz: 84f4b35e8525f88193b08c719abce5c75d085bbfca9f517cc090d0a604cd435a23bf565c66e91c1cae30e45c06c92d7407829a0659a88843757baa54e0e6dd49
-  data.tar.gz: 3495d94157cc8dc9528d55405eca44fd7c077fbd06bf841b915cc02e8d2940abff626d652802ff15b23f8a9192d8af76cbd038128be1a2a0369fba2f213458d0
+  metadata.gz: a2df2315ca041de29d2e82786a33904a9ac1dedd3f1ee4a2e470822cff977e9f4548ab0d33bd6eefec8055b9fc74ff8db2fdcf4c93cba4992aaaa681dcd1a695
+  data.tar.gz: 9da5eec93a1bcd33bff29ab1e0035022592802f512d27139608e92988a17365d3fe4cff0a73fc0f83e9513cea9dd2bf6233bb4deac9533320fb0884f7ef8b219

data/.github/workflows/CI.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+        gemfile:
+          - rails_5.2
+          - rails_6.0
+          - rails_6.1
+          - rails_7.0
+          - active_record_5.2
+          - active_record_6.0
+          - active_record_6.1
+          - active_record_7.0
+        prepared_statements: [true, false]
+        exclude:
+          # activesupport-7.0.0 requires ruby version >= 2.7.0
+          - ruby: '2.5'
+            gemfile: 'rails_7.0'
+          - ruby: '2.5'
+            gemfile: 'active_record_7.0'
+          - ruby: '2.6'
+            gemfile: 'rails_7.0'
+          - ruby: '2.6'
+            gemfile: 'active_record_7.0'
+          # ruby >3 and activesupport 5.2 are not compatible
+          - ruby: '3.0'
+            gemfile: 'rails_5.2'
+          - ruby: '3.0'
+            gemfile: 'active_record_5.2'
+          - ruby: '3.1'
+            gemfile: 'rails_5.2'
+          - ruby: '3.1'
+            gemfile: 'active_record_5.2'
+    name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }} ${{ (matrix.prepared_statements && 'w/ prepared statements') || '' }}
+    env:
+       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+       PREPARED_STATEMENTS: ${{ matrix.prepared_statements && '1' }}
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          docker-compose up -d
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: |
+          bundle exec rake spec

data/.gitignore

@@ -2,3 +2,5 @@ spec/debug.log
 pkg/
 *.rb#
 *.*~
+Gemfile.lock
+*.gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--force-color

data/Appraisals

@@ -1,61 +1,25 @@
-appraise 'rails-4.2' do
-  gem 'rails', '~> 4.2.8'
-  gem 'i18n',  '~> 0.9.5'
-  gem 'nokogiri', '~> 1.7.1'
-  gem 'nio4r', '~> 2.3.1'
-  gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
-  gem 'rake', '12.0.0'
-  gem 'redis', '3.3.3'
-  gem 'pg', '~> 0.15'
-end
-
-appraise 'rails-5.0' do
-  gem 'rails', '~> 5.0.1'
-  gem 'i18n',  '~> 0.9.5'
-  gem 'nokogiri', '~> 1.7.1'
-  gem 'nio4r', '~> 2.3.1'
-  gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
-  gem 'rake', '12.0.0'
-  gem 'redis', '3.3.3'
-end
-
-appraise 'rails-5.1' do
-  gem 'rails', '~> 5.1.0'
-  gem 'i18n',  '~> 0.9.5'
-  gem 'nokogiri', '~> 1.7.1'
-  gem 'nio4r', '~> 2.3.1'
-  gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
-  gem 'rake', '12.0.0'
-  gem 'redis', '3.3.3'
-end
-
 appraise 'rails-5.2' do
   gem 'rails', '~> 5.2.0'
   gem 'i18n',  '~> 0.9.5'
   gem 'nokogiri', '~> 1.7.1'
   gem 'nio4r', '~> 2.3.1'
   gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
+  gem 'byebug', '~> 11.0'
   gem 'rake', '12.0.0'
   gem 'redis', '3.3.3'
+  gem 'pry-byebug', '3.9.0'
 end
 
 appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0'
+  gem 'rails', '~> 6.0.3'
 end
 
-appraise 'active-record-5.1' do
-  gem 'activerecord', '~> 5.1.0'
-  gem 'i18n',  '~> 0.9.5'
-  gem 'nokogiri', '~> 1.7.1'
-  gem 'nio4r', '~> 2.3.1'
-  gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
-  gem 'rake', '12.0.0'
-  gem 'redis', '3.3.3'
+appraise 'rails-6.1' do
+  gem 'rails', '~> 6.1.0'
+end
+
+appraise 'rails-7.0' do
+  gem 'rails', '~> 7.0.0'
 end
 
 appraise 'active-record-5.2' do
@@ -64,11 +28,20 @@ appraise 'active-record-5.2' do
   gem 'nokogiri', '~> 1.7.1'
   gem 'nio4r', '~> 2.3.1'
   gem 'sprockets', '~> 3.7.1'
-  gem 'byebug', '~> 9.0.6'
+  gem 'byebug', '~> 11.0'
   gem 'rake', '12.0.0'
   gem 'redis', '3.3.3'
+  gem 'pry-byebug', '3.9.0'
 end
 
 appraise 'active-record-6.0' do
-  gem 'activerecord', '~> 6.0.0'
+  gem 'activerecord', '~> 6.0.3'
+end
+
+appraise 'active-record-6.1' do
+  gem 'activerecord', '~> 6.1.0'
+end
+
+appraise 'active-record-7.0' do
+  gem 'activerecord', '~> 7.0.0'
 end

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 1.2.0      2022-03-29
+
+* Test Rails 7 & Ruby 3
+* Fix regression in 1.1.1 involving deleted tenants [#123](https://github.com/citusdata/activerecord-multi-tenant/pull/123)
+* Fix incorrect SQL generated when joining two models and one has a default scope [#132](https://github.com/citusdata/activerecord-multi-tenant/pull/132)
+* Update for Rails 5+ removal of type_cast_for_database [#135](https://github.com/citusdata/activerecord-multi-tenant/pull/135)
+
+
+## 1.1.1      2021-01-15
+
+* Add support for Rails 6.1 [#108](https://github.com/citusdata/activerecord-multi-tenant/pull/108)
+* Fix statement cache for has_many through relations [#103](https://github.com/citusdata/activerecord-multi-tenant/pull/103)
+
+
+## 1.1.0      2020-08-06
+
+* See commits for changes:
+  https://github.com/citusdata/activerecord-multi-tenant/commits/v1.1.0
+
 
 ## 1.0.4      2019-10-30
 

data/gemfiles/active_record_5.2.gemfile

@@ -3,13 +3,14 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "activerecord", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0", "< 5.2.4" # FIXME
 gem "i18n", "~> 0.9.5"
 gem "nokogiri", "~> 1.7.1"
 gem "nio4r", "~> 2.3.1"
 gem "sprockets", "~> 3.7.1"
-gem "byebug", "~> 9.0.6"
+gem "byebug", "~> 11.0"
 gem "rake", "12.0.0"
 gem "redis", "3.3.3"
+gem "pry-byebug", "3.9.0"
 
 gemspec path: "../"

data/gemfiles/active_record_6.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "activerecord", "~> 6.0.0"
+gem "activerecord", "~> 6.0.3"
 
 gemspec path: "../"

data/gemfiles/active_record_6.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activerecord", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/active_record_7.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activerecord", "~> 7.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -3,13 +3,14 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 5.2.0"
+gem "rails", "~> 5.2.0", "< 5.2.4" # FIXME
 gem "i18n", "~> 0.9.5"
 gem "nokogiri", "~> 1.7.1"
 gem "nio4r", "~> 2.3.1"
 gem "sprockets", "~> 3.7.1"
-gem "byebug", "~> 9.0.6"
+gem "byebug", "~> 11.0"
 gem "rake", "12.0.0"
 gem "redis", "3.3.3"
+gem "pry-byebug", "3.9.0"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 6.0.0"
+gem "rails", "~> 6.0.3"
 
 gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

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

@@ -0,0 +1,200 @@
+module MultiTenant
+  class ArelVisitorsDepthFirst < Arel::Visitors::Visitor
+    def initialize(block = nil)
+      @block = block || Proc.new
+      super()
+    end
+
+    private
+
+      def visit(o, _ = nil)
+        super
+        @block.call o
+      end
+
+      def unary(o)
+        visit o.expr
+      end
+      alias :visit_Arel_Nodes_Else              :unary
+      alias :visit_Arel_Nodes_Group             :unary
+      alias :visit_Arel_Nodes_Cube              :unary
+      alias :visit_Arel_Nodes_RollUp            :unary
+      alias :visit_Arel_Nodes_GroupingSet       :unary
+      alias :visit_Arel_Nodes_GroupingElement   :unary
+      alias :visit_Arel_Nodes_Grouping          :unary
+      alias :visit_Arel_Nodes_Having            :unary
+      alias :visit_Arel_Nodes_Lateral           :unary
+      alias :visit_Arel_Nodes_Limit             :unary
+      alias :visit_Arel_Nodes_Not               :unary
+      alias :visit_Arel_Nodes_Offset            :unary
+      alias :visit_Arel_Nodes_On                :unary
+      alias :visit_Arel_Nodes_Ordering          :unary
+      alias :visit_Arel_Nodes_Ascending         :unary
+      alias :visit_Arel_Nodes_Descending        :unary
+      alias :visit_Arel_Nodes_UnqualifiedColumn :unary
+      alias :visit_Arel_Nodes_OptimizerHints    :unary
+      alias :visit_Arel_Nodes_ValuesList        :unary
+
+      def function(o)
+        visit o.expressions
+        visit o.alias
+        visit o.distinct
+      end
+      alias :visit_Arel_Nodes_Avg    :function
+      alias :visit_Arel_Nodes_Exists :function
+      alias :visit_Arel_Nodes_Max    :function
+      alias :visit_Arel_Nodes_Min    :function
+      alias :visit_Arel_Nodes_Sum    :function
+
+      def visit_Arel_Nodes_NamedFunction(o)
+        visit o.name
+        visit o.expressions
+        visit o.distinct
+        visit o.alias
+      end
+
+      def visit_Arel_Nodes_Count(o)
+        visit o.expressions
+        visit o.alias
+        visit o.distinct
+      end
+
+      def visit_Arel_Nodes_Case(o)
+        visit o.case
+        visit o.conditions
+        visit o.default
+      end
+
+      def nary(o)
+        o.children.each { |child| visit child }
+      end
+      alias :visit_Arel_Nodes_And :nary
+
+      def binary(o)
+        visit o.left
+        visit o.right
+      end
+      alias :visit_Arel_Nodes_As                 :binary
+      alias :visit_Arel_Nodes_Assignment         :binary
+      alias :visit_Arel_Nodes_Between            :binary
+      alias :visit_Arel_Nodes_Concat             :binary
+      alias :visit_Arel_Nodes_DeleteStatement    :binary
+      alias :visit_Arel_Nodes_DoesNotMatch       :binary
+      alias :visit_Arel_Nodes_Equality           :binary
+      alias :visit_Arel_Nodes_FullOuterJoin      :binary
+      alias :visit_Arel_Nodes_GreaterThan        :binary
+      alias :visit_Arel_Nodes_GreaterThanOrEqual :binary
+      alias :visit_Arel_Nodes_In                 :binary
+      alias :visit_Arel_Nodes_InfixOperation     :binary
+      alias :visit_Arel_Nodes_JoinSource         :binary
+      alias :visit_Arel_Nodes_InnerJoin          :binary
+      alias :visit_Arel_Nodes_LessThan           :binary
+      alias :visit_Arel_Nodes_LessThanOrEqual    :binary
+      alias :visit_Arel_Nodes_Matches            :binary
+      alias :visit_Arel_Nodes_NotEqual           :binary
+      alias :visit_Arel_Nodes_NotIn              :binary
+      alias :visit_Arel_Nodes_NotRegexp          :binary
+      alias :visit_Arel_Nodes_IsNotDistinctFrom  :binary
+      alias :visit_Arel_Nodes_IsDistinctFrom     :binary
+      alias :visit_Arel_Nodes_Or                 :binary
+      alias :visit_Arel_Nodes_OuterJoin          :binary
+      alias :visit_Arel_Nodes_Regexp             :binary
+      alias :visit_Arel_Nodes_RightOuterJoin     :binary
+      alias :visit_Arel_Nodes_TableAlias         :binary
+      alias :visit_Arel_Nodes_When               :binary
+
+      def visit_Arel_Nodes_StringJoin(o)
+        visit o.left
+      end
+
+      def visit_Arel_Attribute(o)
+        visit o.relation
+        visit o.name
+      end
+      alias :visit_Arel_Attributes_Integer :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_Float :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_String :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_Time :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_Boolean :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_Attribute :visit_Arel_Attribute
+      alias :visit_Arel_Attributes_Decimal :visit_Arel_Attribute
+
+      def visit_Arel_Table(o)
+        visit o.name
+      end
+
+      def terminal(o)
+      end
+      alias :visit_ActiveSupport_Multibyte_Chars :terminal
+      alias :visit_ActiveSupport_StringInquirer  :terminal
+      alias :visit_Arel_Nodes_Lock               :terminal
+      alias :visit_Arel_Nodes_Node               :terminal
+      alias :visit_Arel_Nodes_SqlLiteral         :terminal
+      alias :visit_Arel_Nodes_BindParam          :terminal
+      alias :visit_Arel_Nodes_Window             :terminal
+      alias :visit_Arel_Nodes_True               :terminal
+      alias :visit_Arel_Nodes_False              :terminal
+      alias :visit_BigDecimal                    :terminal
+      alias :visit_Class                         :terminal
+      alias :visit_Date                          :terminal
+      alias :visit_DateTime                      :terminal
+      alias :visit_FalseClass                    :terminal
+      alias :visit_Float                         :terminal
+      alias :visit_Integer                       :terminal
+      alias :visit_NilClass                      :terminal
+      alias :visit_String                        :terminal
+      alias :visit_Symbol                        :terminal
+      alias :visit_Time                          :terminal
+      alias :visit_TrueClass                     :terminal
+
+      def visit_Arel_Nodes_InsertStatement(o)
+        visit o.relation
+        visit o.columns
+        visit o.values
+      end
+
+      def visit_Arel_Nodes_SelectCore(o)
+        visit o.projections
+        visit o.source
+        visit o.wheres
+        visit o.groups
+        visit o.windows
+        visit o.havings
+      end
+
+      def visit_Arel_Nodes_SelectStatement(o)
+        visit o.cores
+        visit o.orders
+        visit o.limit
+        visit o.lock
+        visit o.offset
+      end
+
+      def visit_Arel_Nodes_UpdateStatement(o)
+        visit o.relation
+        visit o.values
+        visit o.wheres
+        visit o.orders
+        visit o.limit
+      end
+
+      def visit_Arel_Nodes_Comment(o)
+        visit o.values
+      end
+
+      def visit_Array(o)
+        o.each { |i| visit i }
+      end
+      alias :visit_Set :visit_Array
+
+      def visit_Hash(o)
+        o.each { |k, v| visit(k); visit(v) }
+      end
+
+      DISPATCH = dispatch_cache
+
+      def get_dispatch_cache
+        DISPATCH
+      end
+  end
+end

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

@@ -20,10 +20,6 @@ module MultiTenant
   end
 end
 
-if defined?(ActionController::Base)
-  ActionController::Base.extend MultiTenant::ControllerExtensions
-end
-
-if defined?(ActionController::API)
-  ActionController::API.extend MultiTenant::ControllerExtensions
+ActiveSupport.on_load(:action_controller) do |base|
+  base.extend MultiTenant::ControllerExtensions
 end

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

@@ -9,7 +9,7 @@ module MultiTenant
     end
 
     def <<(row)
-      row = row.map.with_index { |val, idx| @column_types[idx].type_cast_for_database(val) }
+      row = row.map.with_index { |val, idx| @column_types[idx].serialize(val) }
       @conn.put_copy_data(row)
       @count += 1
     end
@@ -18,7 +18,7 @@ module MultiTenant
   module CopyFromClient
     def copy_from_client(columns, &block)
       conn         = connection.raw_connection
-      column_types = columns.map { |c| columns_hash[c.to_s] }
+      column_types = columns.map { |c| type_for_attribute(c.to_s) }
       helper = MultiTenant::CopyFromClientHelper.new(conn, column_types)
       conn.copy_data %{COPY #{quoted_table_name}("#{columns.join('","')}") FROM STDIN}, PG::TextEncoder::CopyRow.new do
         block.call helper
@@ -28,6 +28,6 @@ module MultiTenant
   end
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend(MultiTenant::CopyFromClient)
+ActiveSupport.on_load(:active_record) do |base|
+  base.extend(MultiTenant::CopyFromClient)
 end

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

@@ -44,10 +44,10 @@ module ActiveRecord
     module SchemaStatements
       alias :orig_create_table :create_table
       def create_table(table_name, options = {}, &block)
-        ret = orig_create_table(table_name, options.except(:partition_key), &block)
+        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(\"#{options[:partition_key]}\", id)"
         end
         ret
       end

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

@@ -24,11 +24,6 @@ module MultiTenant
           def primary_key
             return @primary_key if @primary_key
 
-            if ::ActiveRecord::VERSION::MAJOR < 5
-              @primary_key = super || DEFAULT_ID_FIELD
-              return @primary_key if connection.schema_cache.columns_hash(table_name).include? @primary_key
-            end
-
             primary_object_keys = Array.wrap(connection.schema_cache.primary_keys(table_name)) - [partition_key]
 
             if primary_object_keys.size == 1
@@ -54,7 +49,7 @@ module MultiTenant
 
         # 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: options[:partition_key])
+          belongs_to tenant_name, **options.slice(:class_name, :inverse_of).merge(foreign_key: options[:partition_key])
         end
 
         # New instances should have the tenant set
@@ -126,15 +121,20 @@ module MultiTenant
   end
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend(MultiTenant::ModelExtensionsClassMethods)
+ActiveSupport.on_load(:active_record) do |base|
+  base.extend MultiTenant::ModelExtensionsClassMethods
 end
 
-
 class ActiveRecord::Associations::Association
   alias skip_statement_cache_orig skip_statement_cache?
   def skip_statement_cache?(*scope)
     return true if klass.respond_to?(:scoped_by_tenant?) && klass.scoped_by_tenant?
+
+    if reflection.through_reflection
+      through_klass = reflection.through_reflection.klass
+      return true if through_klass.respond_to?(:scoped_by_tenant?) && through_klass.scoped_by_tenant?
+    end
+
     skip_statement_cache_orig(*scope)
   end
 end

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

@@ -34,6 +34,7 @@ module MultiTenant
   end
 
   def self.multi_tenant_model_for_arel(arel)
+    return nil unless arel.respond_to?(:ast)
     if arel.ast.relation.is_a? Arel::Nodes::JoinSource
       MultiTenant.multi_tenant_model_for_table(arel.ast.relation.left.table_name)
     else