activerecord-multi-tenant 1.2.0 → 2.4.0

data/spec/spec_helper.rb

@@ -1,17 +1,57 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+# Codecov is enabled when CI is set to true
+if ENV['CI'] == 'true'
+  puts 'Enabling Simplecov to upload code coverage results to codecov.io'
+  require 'simplecov'
+  SimpleCov.start 'rails' do
+    add_filter '/test/' # Exclude test directory from coverage
+    add_filter '/spec/' # Exclude spec directory from coverage
+    add_filter '/config/' # Exclude config directory from coverage
+
+    # Add any additional filters or exclusions if needed
+    # add_filter '/other_directory/'
+
+    add_group 'Lib', '/lib' # Include the lib directory for coverage
+    puts "Tracked files: #{SimpleCov.tracked_files}"
+  end
+  SimpleCov.minimum_coverage 80
+
+  require 'simplecov-cobertura'
+  SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+end
+
 require 'active_record/railtie'
 require 'action_controller/railtie'
 require 'rspec/rails'
 
-require 'activerecord-multi-tenant'
+module MultiTenantTest
+  class Application < Rails::Application; end
+end
+
+# Specifies columns which shouldn't be exposed while calling #inspect.
+ActiveSupport.on_load(:active_record) do
+  self.filter_attributes += MultiTenantTest::Application.config.filter_parameters
+end
+
+require 'activerecord_multi_tenant'
+
+# It's necessary for testing the filtering of senstive column values in ActiveRecord.
+# Refer to "describe 'inspect method filters senstive column values'"
+#
+# To verify that ActiveSupport.on_load(:active_record) is not being unnecessarily invoked,
+# this line should be placed after "require 'activerecord_multi_tenant'" and before ActiveRecord::Base is called.
+MultiTenantTest::Application.config.filter_parameters = [:password]
 
 require 'bundler'
 Bundler.require(:default, :development)
+require_relative './support/format_sql'
 
-dbconfig = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
-ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+dbconfig = YAML.safe_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|
@@ -25,9 +65,6 @@ RSpec.configure do |config|
 
   config.before(:suite) do
     MultiTenant::FastTruncate.run
-
-    # Keep this here until https://github.com/citusdata/citus/issues/1236 is fixed
-    MultiTenant.enable_with_lock_workaround
   end
 
   config.after(:each) do
@@ -35,15 +72,14 @@ RSpec.configure do |config|
   end
 end
 
-module MultiTenantTest
-  class Application < Rails::Application; end
-end
-
-MultiTenantTest::Application.config.secret_token = 'x' * 40
-MultiTenantTest::Application.config.secret_key_base = 'y' * 40
-
-def uses_prepared_statements?
-  ActiveRecord::Base.connection.prepared_statements
+# rubocop:disable Lint/UnusedMethodArgument
+# changing the name of the parameter breaks tests
+def with_belongs_to_required_by_default(&block)
+  default_value = ActiveRecord::Base.belongs_to_required_by_default
+  ActiveRecord::Base.belongs_to_required_by_default = true
+  yield
+ensure
+  ActiveRecord::Base.belongs_to_required_by_default = default_value
 end
-
+# rubocop:enable Lint/UnusedMethodArgument
 require 'schema'

data/spec/support/format_sql.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'anbt-sql-formatter/formatter'
+
+module SQLFormatter
+  def format_sql(sql)
+    rule = AnbtSql::Rule.new
+    rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
+    %w[count sum substr date].each do |func_name|
+      rule.function_names << func_name.upcase
+    end
+    rule.indent_string = '    '
+    formatter = AnbtSql::Formatter.new(rule)
+    formatter.format(sql.dup)
+  end
+end
+
+RSpec.configure do |config|
+  config.include SQLFormatter
+end

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multi-tenant
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Citus Data
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: anbt-sql-formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -156,9 +184,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/CI.yml"
+- ".github/workflows/active-record-multi-tenant-tests.yml"
 - ".gitignore"
+- ".readthedocs.yaml"
 - ".rspec"
+- ".rubocop.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -167,29 +197,89 @@ files:
 - Rakefile
 - activerecord-multi-tenant.gemspec
 - docker-compose.yml
-- gemfiles/.bundle/config
-- gemfiles/active_record_5.2.gemfile
-- gemfiles/active_record_6.0.gemfile
-- gemfiles/active_record_6.1.gemfile
-- gemfiles/active_record_7.0.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_7.0.gemfile
+- docs/.gitignore
+- docs/Makefile
+- docs/api-reference.sh
+- docs/requirements.in
+- docs/requirements.txt
+- docs/source/_static/api-reference/ActiveRecord.html
+- docs/source/_static/api-reference/ActiveRecord/Associations.html
+- docs/source/_static/api-reference/ActiveRecord/Associations/Association.html
+- docs/source/_static/api-reference/ActiveRecord/Associations/ClassMethods.html
+- docs/source/_static/api-reference/ActiveRecord/ConnectionAdapters.html
+- docs/source/_static/api-reference/ActiveRecord/ConnectionAdapters/SchemaStatements.html
+- docs/source/_static/api-reference/ActiveRecord/QueryMethods.html
+- docs/source/_static/api-reference/ActiveRecord/SchemaDumper.html
+- docs/source/_static/api-reference/MultiTenant.html
+- docs/source/_static/api-reference/MultiTenant/ArelTenantVisitor.html
+- docs/source/_static/api-reference/MultiTenant/ArelVisitorsDepthFirst.html
+- docs/source/_static/api-reference/MultiTenant/BaseTenantEnforcementClause.html
+- docs/source/_static/api-reference/MultiTenant/Context.html
+- docs/source/_static/api-reference/MultiTenant/ControllerExtensions.html
+- docs/source/_static/api-reference/MultiTenant/CopyFromClient.html
+- docs/source/_static/api-reference/MultiTenant/CopyFromClientHelper.html
+- docs/source/_static/api-reference/MultiTenant/Current.html
+- docs/source/_static/api-reference/MultiTenant/DatabaseStatements.html
+- docs/source/_static/api-reference/MultiTenant/FastTruncate.html
+- docs/source/_static/api-reference/MultiTenant/MigrationExtensions.html
+- docs/source/_static/api-reference/MultiTenant/MissingTenantError.html
+- docs/source/_static/api-reference/MultiTenant/ModelExtensionsClassMethods.html
+- docs/source/_static/api-reference/MultiTenant/QueryMonitor.html
+- docs/source/_static/api-reference/MultiTenant/Table.html
+- docs/source/_static/api-reference/MultiTenant/TenantEnforcementClause.html
+- docs/source/_static/api-reference/MultiTenant/TenantIsImmutable.html
+- docs/source/_static/api-reference/MultiTenant/TenantJoinEnforcementClause.html
+- docs/source/_static/api-reference/MultiTenant/TenantValueVisitor.html
+- docs/source/_static/api-reference/MultiTenantFindBy.html
+- docs/source/_static/api-reference/Sidekiq.html
+- docs/source/_static/api-reference/Sidekiq/Client.html
+- docs/source/_static/api-reference/Sidekiq/Middleware/MultiTenant.html
+- docs/source/_static/api-reference/Sidekiq/Middleware/MultiTenant/Client.html
+- docs/source/_static/api-reference/Sidekiq/Middleware/MultiTenant/Server.html
+- docs/source/_static/api-reference/_index.html
+- docs/source/_static/api-reference/class_list.html
+- docs/source/_static/api-reference/css/common.css
+- docs/source/_static/api-reference/css/full_list.css
+- docs/source/_static/api-reference/css/style.css
+- docs/source/_static/api-reference/file.README.html
+- docs/source/_static/api-reference/file_list.html
+- docs/source/_static/api-reference/frames.html
+- docs/source/_static/api-reference/index.html
+- docs/source/_static/api-reference/js/app.js
+- docs/source/_static/api-reference/js/full_list.js
+- docs/source/_static/api-reference/js/jquery.js
+- docs/source/_static/api-reference/method_list.html
+- docs/source/_static/api-reference/top-level-namespace.html
+- docs/source/_templates/.gitignore
+- docs/source/api-reference.rst
+- docs/source/appendix.rst
+- docs/source/changelog.rst
+- docs/source/community-and-support.rst
+- docs/source/conf.py
+- docs/source/contributing.rst
+- docs/source/getting-started.rst
+- docs/source/guides-and-tutorials.rst
+- docs/source/index.rst
+- docs/source/introduction.rst
+- docs/source/license.rst
+- docs/source/troubleshooting.rst
+- docs/source/usage-guide.rst
 - lib/activerecord-multi-tenant.rb
 - lib/activerecord-multi-tenant/arel_visitors_depth_first.rb
 - lib/activerecord-multi-tenant/controller_extensions.rb
 - lib/activerecord-multi-tenant/copy_from_client.rb
 - lib/activerecord-multi-tenant/fast_truncate.rb
+- lib/activerecord-multi-tenant/habtm.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/persistence_extension.rb
 - lib/activerecord-multi-tenant/query_monitor.rb
 - lib/activerecord-multi-tenant/query_rewriter.rb
 - lib/activerecord-multi-tenant/sidekiq.rb
+- lib/activerecord-multi-tenant/table_node.rb
 - lib/activerecord-multi-tenant/version.rb
-- lib/activerecord-multi-tenant/with_lock.rb
+- lib/activerecord_multi_tenant.rb
+- spec/activerecord-multi-tenant/associations_spec.rb
 - spec/activerecord-multi-tenant/controller_extensions_spec.rb
 - spec/activerecord-multi-tenant/fast_truncate_spec.rb
 - spec/activerecord-multi-tenant/model_extensions_spec.rb
@@ -198,16 +288,16 @@ files:
 - 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/activerecord-multi-tenant/schema_dumper_tester.rb
 - spec/activerecord-multi-tenant/sidekiq_spec.rb
 - spec/database.yml
 - spec/schema.rb
 - spec/spec_helper.rb
+- spec/support/format_sql.rb
 homepage: https://github.com/citusdata/activerecord-multi-tenant
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -215,15 +305,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.4.13
+signing_key: 
 specification_version: 4
 summary: ActiveRecord/Rails integration for multi-tenant databases, in particular
   the Citus extension for PostgreSQL

data/.github/workflows/CI.yml

@@ -1,63 +0,0 @@
-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/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/gemfiles/active_record_5.2.gemfile

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-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", "~> 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

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

data/gemfiles/active_record_6.1.gemfile

@@ -1,8 +0,0 @@
-# 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

@@ -1,8 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-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", "~> 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

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

data/gemfiles/rails_6.1.gemfile

@@ -1,8 +0,0 @@
-# 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

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

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

@@ -1,13 +0,0 @@
-module ActiveRecord
-  module Persistence
-    alias :delete_orig :delete
-
-    def delete
-      if MultiTenant.multi_tenant_model_for_table(self.class.table_name).present? && persisted? && MultiTenant.current_tenant_id.nil?
-        MultiTenant.with(self.public_send(self.class.partition_key)) { delete_orig }
-      else
-        delete_orig
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# Workaround for https://github.com/citusdata/citus/issues/1236
-# "SELECT ... FOR UPDATE is not supported for router-plannable queries"
-
-class ActiveRecord::Base
-  alias :lock_orig :lock!
-  def lock!(lock = true)
-    if lock && persisted? && self.class.respond_to?(:scoped_by_tenant?) && MultiTenant.current_tenant_id && MultiTenant.with_lock_workaround_enabled?
-      self.class.unscoped.where(id: id).update_all(id: id) # No-op UPDATE that locks the row
-      reload # This is just to act similar to the default ActiveRecord approach, in case someone relies on the reload
-      self
-    else
-      lock_orig(lock)
-    end
-  end
-end