ar_shard 0.2.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0adad6bd48adb13519adcff13cc216ca2ab3b33071b69c25fd4ed17502f9749
-  data.tar.gz: 2c9208b7cdd2ca38750c44b2a3d13459c2163646cc96118cbd80ed0940529a12
+  metadata.gz: 35217aa1fbce62005178fe61b41c70a03cdbaf943f1700bebe92d608d8c521f2
+  data.tar.gz: b78dc7bb4e4a7ab7717343eecaac7293e152ed904953c7cb9ebb13bfbd178c92
 SHA512:
-  metadata.gz: 745633132fe72a932a5f75228cc177e5605cf2fba707f533d2616ee2a1b88cbdf32906aeba2268f8db699593c2d88b3a1239c838cce0080bc9ac7a786b7d86a9
-  data.tar.gz: 541d7e52fce0366c74d851b9b4be982858e01b86450d656955ab57361a97e82fa486f656404ed408de94693c99d68952305278f8ed6c787d889a8233005eb08b
+  metadata.gz: a0e7dc6cb5fe450771bbb2447bb447cb138f52706f0ddc4c64db7d8b89abfe57522ff9af63bc9e3b69167cf2e96144a1bcf37a7ff73bf87e1e203ccfced50824
+  data.tar.gz: 469810a9ac12ccd94ddfb522680230a6f0cbf4e3ebb4fe1c6b877d587fa6ad6e5d12040dfba6070658bb561aa0a54bdf48ae08218115ea10936d1942e3efc572

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile:
+          - gemfiles/rails_5.gemfile
+          - gemfiles/rails_6.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.5.3'
+          bundler-cache: true
+      - run: bundle exec rake test

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'rails-5' do
+  gem 'activerecord', '~> 5.0'
+end
+
+appraise 'rails-6' do
+  gem 'activerecord', '~> 6.0'
+end

data/CHANGELOG.md

@@ -1,7 +1,18 @@
+## 1.1.0
+
+- Constrained activerecord to `>= 5.2, < 6.1` to match tested versions
+- Documented tested Ruby/ActiveRecord compatibility in README
+
+## 1.0.0
+
+- Added Rails5 support
+
 ## 0.2.3
+
 - Removed pry require in runtime
 
 ## 0.2.2
+
 - Fixed missing connection if loaded from YAML
 - Added tests for multiple connection switches with another block
 

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ar_shard (0.2.2)
-      activerecord (>= 6)
+    ar_shard (1.0.0)
+      activerecord (>= 5.2, < 7)
 
 GEM
   remote: https://rubygems.org/
@@ -18,17 +18,17 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    coderay (1.1.3)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     concurrent-ruby (1.1.7)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.11.3)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (12.3.2)
+    minitest (5.14.1)
+    rake (12.3.3)
     sqlite3 (1.4.2)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
@@ -38,9 +38,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal (~> 2.3)
   ar_shard!
   minitest (~> 5.0)
-  pry
   rake (~> 12.0)
   sqlite3 (~> 1.4)
 

data/README.md

@@ -1,20 +1,39 @@
 # AR Shard
 
-AR Shard is non-intrusive extenstion for ActiveRecord to add threadsafe Model based sharding or just multidatabase connection. As this gem uses connection_handlers it can work only with ActiveRecord 6 and above.
+[![Gem Version](https://badge.fury.io/rb/ar_shard.svg)](https://badge.fury.io/rb/ar_shard)
+[![CI](https://github.com/noma4i/ar_shard/actions/workflows/ci.yml/badge.svg)](https://github.com/noma4i/ar_shard/actions/workflows/ci.yml)
+
+AR Shard is non-intrusive extenstion for ActiveRecord to add threadsafe Model based sharding or just multidatabase connection. As this gem uses connection_handlers it can work only with ActiveRecord version 5 and above.
+
+## Compatibility
+
+This gem was tested against:
+
+- Ruby 2.5.3
+- ActiveRecord 5.2.4.3 and 6.0.3.2 (see `Appraisals` and `gemfiles/`)
+
+Rails 6.1 reworked `connection_handlers` into its own sharding framework, the same API this gem patches, so versions 6.1 and above were never tested and are not supported. The gemspec enforces `activerecord >= 5.2, < 6.1`.
 
 ## Features
+
+- Multiple Databases support for Rails5
+- Define config as a Proc
 - Shard only part of you ActiveRecord w/o sharing connection
 - Work with you Sharded Model and AR model at the same time
 - Threadsafe. Battle-tested with Sidekiq and 4 mixed Databases
-- Define config as a Proc. `Due to nature of connection_handlers all DB connections are established at boot time`
 
+## Limitations
+
+- Doesn't care about migrations
+- Due to nature of connection_handlers all DB connections are established at boot time
+- if data structure is different between databases you should use `ModelName.reset_column_information`
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'ar_shard', '~> 0.2'
+gem 'ar_shard', '~> 1.0'
 ```
 
 ## Usage
@@ -43,6 +62,27 @@ class ShardRecord < ActiveRecord::Base
 end
 ```
 
+Where `shards.yml` is like:
+
+```yaml
+- shard_1:
+    adapter: mysql2
+    host: blabla
+    username: blabla
+    password: secret
+    database: remote_database_name
+    port: 3306
+    pool: 10
+- shard_2:
+    adapter: postgresql
+    host: blabla
+    username: blabla
+    password: secret
+    database: shard_name
+    port: 5432
+    pool: 10
+```
+
 given we have models like:
 
 ```ruby
@@ -81,7 +121,7 @@ To get started with development:
 git clone https://github.com/noma4i/ar_shard.git
 cd ar_shard
 bundle install
-bundle exec rake test
+bundle exec appraisal rake test
 ```
 
 ## License

data/ar_shard.gemspec

@@ -7,25 +7,24 @@ Gem::Specification.new do |spec|
   spec.email         = ['noma4i@gmail.com']
 
   spec.summary       = 'Isolated Multibase Support for ActiveRecord Models with dynamic config'
-  spec.description   = 'Isolated Multibase Support for ActiveRecord Models with dynamic config'
+  spec.description   = 'DB Rails Sharding. Isolated Multibase Support for ActiveRecord Models with dynamic config'
   spec.homepage      = 'https://github.com/noma4i/ar_shard'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/noma4i/ar_shard'
+  spec.metadata['source_code_uri'] = spec.homepage
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 6'
+  spec.add_dependency 'activerecord', ['>= 5.2', '< 6.1']
 
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.4'
+  spec.add_development_dependency 'appraisal', '~> 2.3'
 end

data/gemfiles/.bundle/config

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

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "activerecord", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: ..
+  specs:
+    ar_shard (1.1.0)
+      activerecord (>= 5.2, < 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      arel (>= 9.0)
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+    sqlite3 (1.4.4)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0)
+  appraisal (~> 2.3)
+  ar_shard!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sqlite3 (~> 1.4.4)
+
+BUNDLED WITH
+   1.17.3

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "activerecord", "~> 6.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: ..
+  specs:
+    ar_shard (1.1.0)
+      activerecord (>= 5.2, < 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+    sqlite3 (1.4.4)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0)
+  appraisal (~> 2.3)
+  ar_shard!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sqlite3 (~> 1.4.4)
+
+BUNDLED WITH
+   1.17.3

data/lib/ar_shard/active_record.rb

@@ -14,6 +14,8 @@ module ActiveRecord
   end
 
   module ConnectionHandling
+    mattr_accessor :connection_handlers, instance_accessor: false, default: {}
+
     def connected_shards(shards: nil)
       @connected_shards ||= begin
         config_data = parse_config(shards)
@@ -45,14 +47,21 @@ module ActiveRecord
     end
 
     def lookup_connect(handler_key)
-      connection_handlers[handler_key] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+      if defined?(connection_handlers)
+        connection_handlers[handler_key] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+      else
+        @@connection_handlers[handler_key] ||= ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+      end
     end
 
     def with_shard(handler_key, &blk)
       shard_model.isolated_connection = connected_shards[handler_key].connection
-      yield
+      return_value = yield
+      return_value.load if return_value.is_a? ActiveRecord::Relation
+      return_value
     ensure
       shard_model.isolated_connection = nil
     end
   end
 end
+

data/lib/ar_shard/version.rb

@@ -1,3 +1,3 @@
 module ARShard
-  VERSION = "0.2.3"
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_shard
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Tsirel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2026-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,51 +16,59 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-description: Isolated Multibase Support for ActiveRecord Models with dynamic config
+        version: '2.3'
+description: DB Rails Sharding. Isolated Multibase Support for ActiveRecord Models
+  with dynamic config
 email:
 - noma4i@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -70,6 +78,11 @@ files:
 - ar_shard.gemspec
 - bin/console
 - bin/setup
+- gemfiles/.bundle/config
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_5.gemfile.lock
+- gemfiles/rails_6.gemfile
+- gemfiles/rails_6.gemfile.lock
 - lib/ar_shard.rb
 - lib/ar_shard/active_record.rb
 - lib/ar_shard/version.rb
@@ -94,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Isolated Multibase Support for ActiveRecord Models with dynamic config

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 2.1.4