activerecord-multi-tenant 1.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa2e595cc76e33a877613504121106791680118da0a0c4957ff1190e75e99c3a
-  data.tar.gz: 8a232e3431462d5b8b3972f0825664c210cc51729b2e94d08c5529851365d7f8
+  metadata.gz: f277cdbd6175c03dcbbca13e06220f5612fdf40cefb539a3619b4afa0077d369
+  data.tar.gz: bae03db825cc60a9833a2287245b7ff5f62ede9aa67497594e867832a75eaedf
 SHA512:
-  metadata.gz: a2df2315ca041de29d2e82786a33904a9ac1dedd3f1ee4a2e470822cff977e9f4548ab0d33bd6eefec8055b9fc74ff8db2fdcf4c93cba4992aaaa681dcd1a695
-  data.tar.gz: 9da5eec93a1bcd33bff29ab1e0035022592802f512d27139608e92988a17365d3fe4cff0a73fc0f83e9513cea9dd2bf6233bb4deac9533320fb0884f7ef8b219
+  metadata.gz: fad6c663f7f588e1359ea4f831b1c66d24de31fa9895aee3ac42d59851597b3ceabf2576c4e2eb49f55baef6eaeb787fee946085b43909450580d4b6a66817cb
+  data.tar.gz: c58700fda6a8e99b928435f2bd5abfdc62eb6ccb249ab21350d12f25d9b6ff29860d12451e5e8a77aa2666302d8a9dbfa9bc062dab450ecfdfce2226452c0d43

data/.github/workflows/active-record-multi-tenant-tests.yml

@@ -0,0 +1,83 @@
+name: Active Record Multi-Tenant Tests
+
+env:
+  CI: true
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+
+jobs:
+
+  static-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - uses: actions/checkout@v3
+      - name: Rubocop static code analysis
+        run: |
+          gem install rubocop
+          rubocop
+  doc_checks:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - uses: actions/checkout@v3
+    - name: Install python dependencies
+      run: |
+        pip install -r docs/requirements.txt
+    - name: Documentation Checks
+      run: |
+        cd docs
+        sphinx-build -W -b html source builds
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+        appraisal:
+          - rails-6.0
+          - rails-6.1
+          - rails-7.0
+          - rails-7.1
+          - active-record-6.0
+          - active-record-6.1
+          - active-record-7.0
+          - active-record-7.1
+        citus_version:
+          - '10'
+          - '11'
+          - '12'
+
+    name: Ruby ${{ matrix.ruby }}/${{ matrix.gemfile }} / Citus ${{ matrix.citus_version }}
+    env:
+       APPRAISAL: ${{ matrix.appraisal }}
+       CITUS_VERSION: ${{ matrix.citus_version }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Start Citus Database environment
+        run: docker-compose up -d
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Execute tests
+        run: bundle exec rake spec
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3

data/.gitignore

@@ -4,3 +4,9 @@ pkg/
 *.*~
 Gemfile.lock
 *.gemfile.lock
+.idea/
+.vagrant/
+Vagrantfile
+coverage/
+docs/build/
+.yardoc/

data/.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+  install:
+    - requirements: docs/requirements.txt

data/.rubocop.yml

@@ -0,0 +1,51 @@
+# This is an example RuboCop configuration file with some commonly used options.
+
+# Run RuboCop on all Ruby files, except those in `vendor` and `node_modules` directories
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'Vagrantfile'
+  TargetRubyVersion: 3.0
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - '**/*.rb'
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 650
+
+Metrics/MethodLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/activerecord-multi-tenant.rb'

data/Appraisals

@@ -1,15 +1,3 @@
-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', '~> 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.3'
 end
@@ -22,16 +10,8 @@ appraise 'rails-7.0' do
   gem 'rails', '~> 7.0.0'
 end
 
-appraise 'active-record-5.2' do
-  gem 'activerecord', '~> 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', '~> 11.0'
-  gem 'rake', '12.0.0'
-  gem 'redis', '3.3.3'
-  gem 'pry-byebug', '3.9.0'
+appraise 'rails-7.1' do
+  gem 'rails', '~> 7.1.0.beta1'
 end
 
 appraise 'active-record-6.0' do
@@ -45,3 +25,7 @@ end
 appraise 'active-record-7.0' do
   gem 'activerecord', '~> 7.0.0'
 end
+
+appraise 'active-record-7.1' do
+  gem 'activerecord', '~> 7.1.0.beta1'
+end

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## 2.4.0      2023-06-05
+* Adds citus 12 to test matrix (#210)
+* Adds Support for rails 7.1 (#208)
+* Fix missing scope in habtm.rb (#207)
+* Update logic inside the tenant_klass_defined? method (#202)
+
+## 2.3.0      2023-06-05
+* Adds has_and_belongs_to_many feature with tenant (#193)
+* Removes eol ruby versions 
+* Adds documentation in ReadTheDocs platform (#196)
+* Organizes badges in documentation and README.md (#197) 
+* Wrap ActiveRecord::Base with ActiveSupport.on_load (#199)
+
+## 2.2.0      2022-12-06
+* Handle changing tenant from `nil` to a value [#173](https://github.com/citusdata/activerecord-multi-tenant/pull/173)
+* Allow Partitioned tables to be created without a primary key [#172](https://github.com/citusdata/activerecord-multi-tenant/pull/172)
+* Only attempt to reload with MultiTenant when parition_key is present [#175](https://github.com/citusdata/activerecord-multi-tenant/pull/175)
+* Remove support for Ruby 2.5 & ActiveRecord 5.2
+
+## 2.1.6      2022-11-23
+* Fix undefined wrap_methods error & wrap_methods version check [#170](https://github.com/citusdata/activerecord-multi-tenant/pull/170)
+
+## 2.1.5      2022-11-20
+* Fix `MultiTenant.without` codegen bug in Rails 6.1+ [#168](https://github.com/citusdata/activerecord-multi-tenant/pull/168)
+
+## 2.1.4      2022-11-03
+* Fixes #166 where db:schema:dump is broken when using this gem with MySQL [#167](https://github.com/citusdata/activerecord-multi-tenant/pull/167)
+
+## 2.1.3      2022-10-27
+* Error when calling a method that takes keyword arguments with MultiTenant.wrap_methods [#164](https://github.com/citusdata/activerecord-multi-tenant/pull/164)
+
+## 2.1.2      2022-10-26
+* Fixes issue when wraping methods that require a block [#162](https://github.com/citusdata/activerecord-multi-tenant/pull/162)
+
+## 2.1.1      2022-10-20
+* Fix query building for models with mismatched partition_keys [#150](https://github.com/citusdata/activerecord-multi-tenant/pull/150)
+* Identify tenant even if class name is nonstandard [#152](https://github.com/citusdata/activerecord-multi-tenant/pull/152)
+* Add current_tenant_id to WHERE clauses when calling methods on activerecord instance or its associations [#154](https://github.com/citusdata/activerecord-multi-tenant/pull/154)
+* Make create_distributed_table, create_reference_table reversible & add ruby wrapper for rebalance_table_shards [#155](https://github.com/citusdata/activerecord-multi-tenant/pull/155)
+* Support create_distributed_table, create_reference_table in schema.rb [#156](https://github.com/citusdata/activerecord-multi-tenant/pull/156)
+* Add client and server sidekiq middleware to sidekiq middleware chain [#158](https://github.com/citusdata/activerecord-multi-tenant/pull/158)
+
+## 2.0.0      2022-05-19
+
+* Replace RequestStore with CurrentAttributes [#139](https://github.com/citusdata/activerecord-multi-tenant/pull/139)
+* Support changing table_name after calling multi_tenant [#128](https://github.com/citusdata/activerecord-multi-tenant/pull/128)
+* Allow to use uuid as primary key on partition table [#112](https://github.com/citusdata/activerecord-multi-tenant/pull/112)
+* Support latest Rails 5.2 [#145](https://github.com/citusdata/activerecord-multi-tenant/pull/145)
+* Support optional: true for belongs_to [#147](https://github.com/citusdata/activerecord-multi-tenant/pull/147)
+
+
 ## 1.2.0      2022-03-29
 
 * Test Rails 7 & Ruby 3

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
-
 gem 'appraisal'
+gem 'rubocop', require: false, group: 'test'
+gem 'simplecov'
+gem 'simplecov-cobertura'

data/README.md

@@ -1,4 +1,5 @@
-# activerecord-multi-tenant [ ![](https://img.shields.io/gem/v/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant) [ ![](https://img.shields.io/gem/dt/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant)
+# activerecord-multi-tenant 
+[![Build Status](https://github.com/citusdata/activerecord-multi-tenant/actions/workflows/active-record-multi-tenant-tests.yml/badge.svg)](https://github.com/citusdata/activerecord-multi-tenant/actions/workflows/active-record-multi-tenant-tests.yml) [![codecov](https://codecov.io/gh/citusdata/activerecord-multi-tenant/branch/master/graph/badge.svg?token=rw0TsEk4Ld)](https://codecov.io/gh/citusdata/activerecord-multi-tenant) [ ![Gems Version](https://img.shields.io/gem/v/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant)[ ![Gem Download Count](https://img.shields.io/gem/dt/activerecord-multi-tenant.svg)](https://rubygems.org/gems/activerecord-multi-tenant) [![Documentation Status](https://readthedocs.org/projects/activerecord-multi-tenant/badge/?version=latest)](https://activerecord-multi-tenant.readthedocs.io/en/latest/?badge=latest) 
 
 Introduction Post: https://www.citusdata.com/blog/2017/01/05/easily-scale-out-multi-tenant-apps/
 
@@ -16,7 +17,7 @@ gem 'activerecord-multi-tenant'
 
 ## Supported Rails versions
 
-All Ruby on Rails versions starting with 4.2 or newer (up to 6.0) are supported.
+All Ruby on Rails versions starting with 6.0 or newer (up to 7.0) are supported.
 
 This gem only supports ActiveRecord (the Rails default ORM), and not alternative ORMs like Sequel.
 

data/Rakefile

@@ -4,4 +4,4 @@ require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/activerecord-multi-tenant.gemspec

@@ -1,29 +1,34 @@
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'activerecord-multi-tenant/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'activerecord-multi-tenant'
-  s.version     = MultiTenant::VERSION
-  s.summary     = 'ActiveRecord/Rails integration for multi-tenant databases, in particular the Citus extension for PostgreSQL'
-  s.description = ''
-  s.authors     = ['Citus Data']
-  s.email       = 'engage@citusdata.com'
+Gem::Specification.new do |spec|
+  spec.name = 'activerecord-multi-tenant'
+  spec.version = MultiTenant::VERSION
+  spec.summary = 'ActiveRecord/Rails integration for multi-tenant databases, '\
+            'in particular the Citus extension for PostgreSQL'
+  spec.description = ''
+  spec.authors = ['Citus Data']
+  spec.email = 'engage@citusdata.com'
+  spec.required_ruby_version = '>= 3.0.0'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.require_paths = ['lib']
-  s.homepage      = 'https://github.com/citusdata/activerecord-multi-tenant'
-  s.license       = 'MIT'
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ['lib']
+  spec.homepage = 'https://github.com/citusdata/activerecord-multi-tenant'
+  spec.license = 'MIT'
 
-  s.add_runtime_dependency('request_store', '>= 1.0.5')
-  s.add_dependency('rails','>= 4.2')
+  spec.add_dependency 'rails', '>= 6'
 
-  s.add_development_dependency 'rspec', '>= 3.0'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'pg'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'sidekiq'
-  s.add_development_dependency 'thor'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'anbt-sql-formatter'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sidekiq'
+
+  spec.add_development_dependency 'thor'
 end

data/docker-compose.yml

@@ -2,25 +2,31 @@ version: '2.1'
 
 services:
   master:
-    image: 'citusdata/citus:7.5.1'
-    ports: ['5600:5432']
-    labels: ['com.citusdata.role=Master']
-    volumes: ['/var/run/postgresql']
-  manager:
-    container_name: "${COMPOSE_PROJECT_NAME:-citus}_manager"
-    image: 'citusdata/membership-manager:0.1.0'
-    volumes: ['/var/run/docker.sock:/var/run/docker.sock']
-    depends_on: { master: { condition: service_healthy } }
+    container_name: "${COMPOSE_PROJECT_NAME:-citus}_master"
+    image: 'citusdata/citus:${CITUS_VERSION:-11.2}'
+    ports: [ '5600:5432' ]
+    labels: [ 'com.citusdata.role=Master' ]
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+    command: -c fsync=off -c full_page_writes=off
   worker1:
-    image: 'citusdata/citus:7.5.1'
-    labels: ['com.citusdata.role=Worker']
+    image: 'citusdata/citus:${CITUS_VERSION:-11.2}'
+    ports: [ '5601:5432' ]
+    labels: [ 'com.citusdata.role=Worker' ]
     depends_on: { manager: { condition: service_healthy } }
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+    command: -c fsync=off -c full_page_writes=off
   worker2:
-    image: 'citusdata/citus:7.5.1'
-    labels: ['com.citusdata.role=Worker']
+    image: 'citusdata/citus:${CITUS_VERSION:-11.2}'
+    ports: [ '5602:5432' ]
+    labels: [ 'com.citusdata.role=Worker' ]
     depends_on: { manager: { condition: service_healthy } }
-  healthcheck:
-    image: busybox
-    depends_on:
-      worker1: { condition: service_healthy }
-      worker2: { condition: service_healthy }
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+    command: -c fsync=off -c full_page_writes=off
+  manager:
+    container_name: "${COMPOSE_PROJECT_NAME:-citus}_manager"
+    image: 'citusdata/membership-manager:0.2.0'
+    volumes: [ '/var/run/docker.sock:/var/run/docker.sock' ]
+    depends_on: { master: { condition: service_healthy } }

data/docs/.gitignore

@@ -0,0 +1,3 @@
+# Ignore everything in this directory
+.yardoc/*
+

data/docs/Makefile

@@ -0,0 +1,28 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# New target that executes the bash script before calling the original target
+build-docs: pre-build   # Change 'html' to the target you want to execute
+
+pre-build:
+	# Execute your bash script here
+	bash api-reference.sh
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+html:
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

data/docs/api-reference.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# This script is used to generate the API reference documentation for the
+# project. It is intended to be run from the root of the project directory.
+# It requires the following tools to be installed:
+# - yard (gem install yard)
+echo "Generating API reference documentation..."
+echo "Pwd: $(pwd)"
+cd ..
+yard doc --output-dir docs/source/_static/api-reference

data/docs/requirements.in

@@ -0,0 +1,4 @@
+sphinxnotes-strike
+sphinx
+sphinx_rtd_theme
+readthedocs-sphinx-search

data/docs/requirements.txt

@@ -0,0 +1,62 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.12.1
+    # via sphinx
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.1.0
+    # via requests
+docutils==0.18.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.4
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via sphinx
+markupsafe==2.1.2
+    # via jinja2
+packaging==23.1
+    # via sphinx
+pygments==2.15.1
+    # via sphinx
+readthedocs-sphinx-search==0.3.1
+    # via -r requirements.in
+requests==2.31.0
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==6.2.1
+    # via
+    #   -r requirements.in
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+    #   sphinxnotes-strike
+sphinx-rtd-theme==1.2.1
+    # via -r requirements.in
+sphinxcontrib-applehelp==1.0.4
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.1
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+sphinxnotes-strike==1.2
+    # via -r requirements.in
+urllib3==2.0.2
+    # via requests