activerecord-multi-tenant 2.1.6 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f4082afb70ab964006573b094d2dd61a6aa0e015276504488d911578406f83
-  data.tar.gz: 509ebd9c590c472b84bba4d17ed9880f80d88e7fade20ec35350148634732cf6
+  metadata.gz: ba7796208980393ca21739d24fa0ac384f0c63ab814041cf46e0216d22eef539
+  data.tar.gz: 107cea123278629ce9492b15eb6e168549eac4c155fe9a906e57e1695414faf7
 SHA512:
-  metadata.gz: b359e5a9a001d1a20ad676fcf855eabe0dee36763245f779607942fe71ba937c8441fb944759790b3a07fb0dacb4cbff8bb329a17fac79de3468c7f1982c5b4b
-  data.tar.gz: cae89438df5db59a4e7cc9b804cfc73745c0ad1879dfcf0c21b2aee804e3657304cc8c36ebc301a5da371ad29d7e616adecd4440c36d55c5a6413b858e13abda
+  metadata.gz: c184c2db6316a82d4b092dfdaff1cb69cde80319837302822b7fe8ae387bf627fa6e8670f828d980636e448761e51629c38c53d42dbb505d094f1a2b5eba4b54
+  data.tar.gz: c021571f18b6072a98bbe0793607077b785a3a989e3365cd45cd7c0d94fb89f5ed30f3129b35199d88aeab653d6c656d20028a84a5ce74bedbaf2a3c6d36c5b6

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

@@ -0,0 +1,80 @@
+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
+          - active-record-6.0
+          - active-record-6.1
+          - active-record-7.0
+        citus_version:
+          - '10'
+          - '11'
+        
+    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,18 +10,6 @@ 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'
-end
-
 appraise 'active-record-6.0' do
   gem 'activerecord', '~> 6.0.3'
 end

data/CHANGELOG.md

@@ -1,4 +1,16 @@
 # Changelog
+## 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)

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 5.2 or newer (up to 7.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,28 +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_dependency 'rails', '>= 5.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.5.7
+    # 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