octoball 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260d7c95bac1ba724636272cfa7ecf444124b868b2c7a3cea4d6966e0ac947a9
-  data.tar.gz: 5036fc1b1f6f5f0d7b24c734951ad6cbff0fd48eabc529a3f5390e55f2ad50d2
+  metadata.gz: 825cfa3ec263110a928737f918d0576459a50aa67b1f1553ab194248e0c0d41c
+  data.tar.gz: c20b43133b0afd7c324b4cd57a54204d7c716f85acb7aa55a950be80e2bcec02
 SHA512:
-  metadata.gz: 1d954e47f0a2603425d29e82669b9388d4f49abf7def04e268548554ee5ab52181a2b192a5ccfd34b288a67b34fd6cf8cac4d75b8304c918970f7523f3177285
-  data.tar.gz: 7b294deea783c80324d5694afd87984017411677f593d042fa9b78a35e5dba5d12584209bb36d45190c3e63d748e1a4f5096e6a6e992ef9ebfa71e7968a41c4d
+  metadata.gz: 0002bc390d5982cb4a968ecdd91d12234a4d495553e906c0765efc09c29111b72fd136b15bd8fbd8a3b30b8b0f6d25fb9e6b41c5138ee777e791773a5117fcc6
+  data.tar.gz: 37efcbe5015be915ae7263a03f6da3443f03b6de711389ec59c76ada5fb0ea3a786c072c358a9f27573df1741ae978ef723930bb8ea4503fa80563669b13880e

data/.github/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../'

data/.github/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../../'
+
+gem 'activerecord', '~> 7.2.0'
+gem 'activesupport', '~> 7.2.0'

data/.github/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../../'
+
+gem 'activerecord', '~> 8.0.0'
+gem 'activesupport', '~> 8.0.0'

data/.github/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '../../'
+
+gem 'activerecord', '~> 8.1.0'
+gem 'activesupport', '~> 8.1.0'

data/.github/workflows/rspec.yml

@@ -0,0 +1,39 @@
+name: rspec
+on: push
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5
+        ports:
+          - 3306:3306
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 5s
+          --health-timeout 3s
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: ["3.2", "3.3", "3.4"]
+        rails: ["7.2", "8.0", "8.1"]
+    env:
+      BUNDLE_GEMFILE: .github/gemfiles/rails_${{ matrix.rails }}.gemfile
+      MYSQL_HOST: 127.0.0.1
+      RAILS_ENV: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install rake
+        run: gem install rake
+      - name: Setup database
+        run: bundle exec rake db:prepare
+      - name: run rspec
+        run: bundle exec rspec

data/README.md

@@ -11,12 +11,16 @@ Currently, its implementation is focusing on horizontal database sharding. Howev
 ## Scope of this gem
 
 ### What is included in Octoball
+
 - Octopus-like shard swithcing by `using` class method, e.g.:
+
   ```ruby
   Octoball.using(:shard1) { User.find_by_name("Alice") }
   User.using(:shard1).first
   ```
+
 - Each model instance knows which shard it came from so shard will be switched automatically:
+
   ```ruby
   user1 = User.using(:shard1).find_by_name("Bob")
   user2 = User.using(:shard2).find_by_name("Charlie")
@@ -25,15 +29,18 @@ Currently, its implementation is focusing on horizontal database sharding. Howev
   user1.save!  #  Save the user1 in the correct shard `:shard1`
   user2.save!  #  Save the user2 in the correct shard `:shard2`
   ```
+
 - Relations such as `has_many` are also resolved from the model instance's shard:
+
   ```ruby
   user = User.using(:shard1).find_by_name("Alice")
   user.blogs.where(title: "blog")  # user's blogs are fetched from `:shard1`
   ```
 
 ### What is NOT included in Octoball
+
 - Connection handling and configuration -- managed by the native `ActiveRecord::Base.connects_to` methods introduced in ActiveRecord 6.1.
-  - You need to migrate from Octopus' `config/shards.yml` to [Rails native multiple DB configuration using `config/database.yml`](https://edgeguides.rubyonrails.org/active_record_multiple_databases.html). Please refer the [Setup](#Setup) section for more details.
+  - You need to migrate from Octopus' `config/shards.yml` to [Rails native multiple DB configuration using `config/database.yml`](https://edgeguides.rubyonrails.org/active_record_multiple_databases.html). Please refer the [Setup](#setup) section for more details.
 - Migration -- done by ActiveRecord 6.1+ natively.
   - Instead of `using` method in Octopus, you can specify the `migrations_paths` parameter in the `config/database.yml` file.
 - Replication handling -- done by ActiveRecord's `role`
@@ -46,12 +53,13 @@ gem "octoball"
 ```
 
 Define the database connections in `config/database.yml`, e.g.:
+
 ```
 default: &default
-  adapter: mysql2
+  adapter: trilogy
   pool: 5
   username: root
-  host: localhost
+  host: 127.0.0.1
   timeout: 5000
   connnect_timeout: 5000
 
@@ -63,7 +71,9 @@ development:
     <<: *default
     database: db_shard1
 ```
+
 And define shards and corresponding connections in abstract ActiveRecord model class, e.g.:
+
 ```ruby
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
@@ -80,21 +90,24 @@ end
 ```
 
 Optionally, to use the `:master` shard as a default connection like Octopus, add the following script to `config/initializers/default_shard.rb`:
+
 ```
 ActiveRecord::Base.default_shard = :master
 ```
 
-
 ## Development of Octoball
+
 Octoball has rspec tests delived from subsets of Octopus' rspec.
 
 To run the rspec tests, follow these steps:
+
 ```
 RAILS_ENV=test bundle exec rake db:prepare
 RAILS_ENV=test bundle exec rake spec
 ```
 
 ## License
+
 Octoball is released under the MIT license.
 
 Original Octopus' copyright: Copyright (c) Thiago Pradi

data/Rakefile

@@ -9,9 +9,10 @@ RuboCop::RakeTask.new
 
 namespace :db do
   mysql_spec = {
-    adapter:  'mysql2',
-    host:     (ENV['MYSQL_HOST'] || 'localhost'),
+    adapter:  'trilogy',
+    host:     (ENV['MYSQL_HOST'] || '127.0.0.1'),
     username: (ENV['MYSQL_USER'] || 'root'),
+    port:     (ENV['MYSQL_PORT'] || 3306),
     encoding: 'utf8mb4',
   }
 
@@ -31,6 +32,8 @@ namespace :db do
 
   desc 'Create tables on tests databases'
   task :create_tables do
+    require 'active_record'
+
     ActiveRecord::Base.configurations = {
       "test" => {
         shard1: mysql_spec.merge(database: 'octoball_shard_1'),
@@ -43,7 +46,7 @@ namespace :db do
     require './spec/models/application_record'
     ActiveRecord::Base.configurations.configs_for(env_name: "test").each do |config|
       ActiveRecord::Base.establish_connection(config)
-      schema_migration = ActiveRecord::Base.connection.schema_migration
+      schema_migration = ActiveRecord::Base.connection.pool.schema_migration
       ActiveRecord::MigrationContext.new("spec/migration", schema_migration)
         .migrate(config.database == 'octoball_shard_5' ? 2 : 1)
     end

data/lib/octoball/connection_adapters.rb

@@ -13,6 +13,38 @@ class Octoball
     attr_accessor :current_shard
   end
 
+  module ConnectionPoolSetCurrentShard
+    def with_connection(prevent_permanent_checkout: false)
+      lease = connection_lease
+      if lease.connection
+        lease.connection.current_shard = lease.connection.shard
+      end
+
+      super
+    end
+
+    def active_connection?
+      conn = connection_lease.connection
+      conn.current_shard = conn.shard if conn
+      conn
+    end
+
+    def active_connection
+      conn = connection_lease.connection
+      conn.current_shard = conn.shard if conn
+      conn
+    end
+
+    def lease_connection
+      lease = connection_lease
+      lease.sticky = true
+      lease.connection ||= checkout
+      lease.connection.current_shard = lease.connection.shard
+      lease.connection
+    end
+  end
+
+  ::ActiveRecord::ConnectionAdapters::ConnectionPool.prepend(ConnectionPoolSetCurrentShard)
   ::ActiveRecord::ConnectionAdapters::ConnectionHandler.prepend(ConnectionHandlerSetCurrentShard)
   ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(ConnectionHasCurrentShard)
 end

data/lib/octoball/log_subscriber.rb

@@ -12,7 +12,7 @@ class Octoball
     private
 
     def debug(progname = nil, &block)
-      conn = current_shard ? color("[Shard: #{current_shard}]", ActiveSupport::LogSubscriber::GREEN, true) : ''
+      conn = current_shard ? color("[Shard: #{current_shard}]", ActiveSupport::LogSubscriber::GREEN, bold: true) : ''
       super(conn + progname.to_s, &block)
     end
   end

data/lib/octoball/using_shard.rb

@@ -0,0 +1,17 @@
+class Octoball
+  def self.using(shard, &block)
+    ActiveRecord::Base.connected_to(role: current_role, shard: shard&.to_sym, &block)
+  end
+
+  def self.current_role
+    ActiveRecord::Base.current_role || ActiveRecord::Base.writing_role
+  end
+
+  module UsingShard
+    def using(shard)
+      Octoball::RelationProxy.new(all, shard&.to_sym)
+    end
+  end
+
+  ::ActiveRecord::Base.singleton_class.prepend(UsingShard)
+end

data/lib/octoball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Octoball
-  VERSION = '0.1.4'
+  VERSION = '0.1.8'
 end

data/lib/octoball.rb

@@ -2,29 +2,14 @@
 
 require 'active_record'
 require 'octoball/version'
-require 'octoball/relation_proxy'
-require 'octoball/connection_adapters'
-require 'octoball/connection_handling'
-require 'octoball/current_shard_tracker'
-require 'octoball/association'
-require 'octoball/association_shard_check'
-require 'octoball/persistence'
-require 'octoball/log_subscriber'
 
-class Octoball
-  def self.using(shard, &block)
-    ActiveRecord::Base.connected_to(role: current_role, shard: shard&.to_sym, &block)
-  end
-
-  def self.current_role
-    ActiveRecord::Base.current_role || ActiveRecord::Base.writing_role
-  end
-
-  module UsingShard
-    def using(shard)
-      Octoball::RelationProxy.new(all, shard&.to_sym)
-    end
-  end
-
-  ::ActiveRecord::Base.singleton_class.prepend(UsingShard)
+ActiveSupport.on_load(:active_record) do
+  require 'octoball/relation_proxy'
+  require 'octoball/connection_adapters'
+  require 'octoball/current_shard_tracker'
+  require 'octoball/association_shard_check'
+  require 'octoball/persistence'
+  require 'octoball/association'
+  require 'octoball/log_subscriber'
+  require 'octoball/using_shard'
 end

data/octoball.gemspec

@@ -15,14 +15,14 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/aktsk/octoball'
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.7.0'
+  s.required_ruby_version = '>= 3.2.0'
 
-  s.add_dependency 'activerecord', '>= 6.1'
-  s.add_dependency 'activesupport', '>= 6.1'
+  s.add_dependency 'activerecord', '>= 7.2'
+  s.add_dependency 'activesupport', '>= 7.2'
 
-  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'trilogy'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '>= 3'
   s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'debug'
 end

data/spec/octoball/model_spec.rb

@@ -123,7 +123,7 @@ describe Octoball do
 
     it 'should clean #current_shard from proxy when using execute' do
       User.using(:canada).connection.execute('select * from users limit 1;')
-      expect(User.connection.current_shard).to eq(:default)
+      expect(User.connection.current_shard).to eq(:master)
     end
 
     it 'should allow scoping dynamically' do
@@ -264,7 +264,7 @@ describe Octoball do
 
   describe 'AR basic methods' do
     it 'connects_to' do
-      expect(CustomConnection.connection.current_database).to eq('octoball_shard_2')
+      expect(CustomConnection.connection.current_database).to eq('octoball_shard_3')
     end
 
     it 'reuses parent model connection' do
@@ -590,7 +590,7 @@ describe Octoball do
   describe 'custom connection' do
     context 'by default' do
       it 'with plain call should use custom connection' do
-        expect(CustomConnection.connection.current_database).to eq('octoball_shard_2')
+        expect(CustomConnection.connection.current_database).to eq('octoball_shard_3')
       end
 
       it 'should use model-specific shard' do
@@ -618,7 +618,7 @@ describe Octoball do
         CustomConnection.create(:value => 'custom value')
 
         # This is what Rails, Sidekiq etc call--this normally handles all connection pools in the app
-        expect { ActiveRecord::Base.clear_active_connections! }
+        expect { ActiveRecord::Base.connection_handler.clear_active_connections! }
           .to change { CustomConnection.connection_pool.active_connection? }
 
         expect(CustomConnection.connection_pool.active_connection?).to be_falsey

data/spec/octoball/scope_proxy_spec.rb

@@ -39,19 +39,19 @@ describe Octoball do
     end
 
     it 'allows multiple selection by string' do
-      expect(@evan.select('id, name').first.id).to be_a(Fixnum)
+      expect(@evan.select('id, name').first.id).to be_a(Integer)
     end
 
     it 'allows multiple selection by array' do
-      expect(@evan.select(%w(id name)).first.id).to be_a(Fixnum)
+      expect(@evan.select(%w(id name)).first.id).to be_a(Integer)
     end
 
     it 'allows multiple selection by symbol' do
-      expect(@evan.select(:id, :name).first.id).to be_a(Fixnum)
+      expect(@evan.select(:id, :name).first.id).to be_a(Integer)
     end
 
     it 'allows multiple selection by string and symbol' do
-      expect(@evan.select(:id, 'name').first.id).to be_a(Fixnum)
+      expect(@evan.select(:id, 'name').first.id).to be_a(Integer)
     end
   end
 

data/spec/spec_helper.rb

@@ -10,9 +10,10 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 RSpec.configure do |config|
   mysql_spec = {
-    adapter:  'mysql2',
-    host:     (ENV['MYSQL_HOST'] || 'localhost'),
+    adapter:  'trilogy',
+    host:     (ENV['MYSQL_HOST'] || '127.0.0.1'),
     username: (ENV['MYSQL_USER'] || 'root'),
+    port:     (ENV['MYSQL_PORT'] || 3306),
     encoding: 'utf8mb4',
   }
   ActiveRecord::Base.configurations = {

data/spec/support/database_connection.rb

@@ -3,9 +3,10 @@ require 'logger'
 ActiveRecord::Base.logger = Logger.new(File.open('database.log', 'a'))
 
 mysql_spec = {
-  adapter:  'mysql2',
-  host:     (ENV['MYSQL_HOST'] || 'localhost'),
+  adapter:  'trilogy',
+  host:     (ENV['MYSQL_HOST'] || '127.0.0.1'),
   username: (ENV['MYSQL_USER'] || 'root'),
+  port:     (ENV['MYSQL_PORT'] || 3306),
   encoding: 'utf8mb4',
 }
 

data/spec/support/database_models.rb

@@ -20,7 +20,7 @@ end
 # This class sets its own connection
 class CustomConnectionBase < ActiveRecord::Base
   self.abstract_class = true
-  establish_connection(:adapter => 'mysql2', :host => (ENV['MYSQL_HOST'] || 'localhost'), :database => 'octoball_shard_2', :username => "#{ENV['MYSQL_USER'] || 'root'}", :password => '')
+  establish_connection(:adapter => 'trilogy', :host => (ENV['MYSQL_HOST'] || '127.0.0.1'), :database => 'octoball_shard_2', :username => "#{ENV['MYSQL_USER'] || 'root'}", :password => '', :port => (ENV['MYSQL_PORT'] || 3306))
   connects_to shards: {
     custom_shard: { writing: :shard3 }
   }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: octoball
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Tomoki Sekiyama
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,30 +15,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: trilogy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,8 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/Gemfile"
-- ".circleci/config.yml"
+- ".github/Gemfile"
+- ".github/gemfiles/rails_7.2.gemfile"
+- ".github/gemfiles/rails_8.0.gemfile"
+- ".github/gemfiles/rails_8.1.gemfile"
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - Gemfile
 - README.md
@@ -126,11 +128,11 @@ files:
 - lib/octoball/association.rb
 - lib/octoball/association_shard_check.rb
 - lib/octoball/connection_adapters.rb
-- lib/octoball/connection_handling.rb
 - lib/octoball/current_shard_tracker.rb
 - lib/octoball/log_subscriber.rb
 - lib/octoball/persistence.rb
 - lib/octoball/relation_proxy.rb
+- lib/octoball/using_shard.rb
 - lib/octoball/version.rb
 - octoball.gemspec
 - spec/migration/1_test_tables.rb
@@ -153,7 +155,6 @@ homepage: https://github.com/aktsk/octoball
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,15 +162,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Octopus-like Database Sharding Helper for ActiveRecord 6.1+
 test_files: []

data/.circleci/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-if RUBY_VERSION < '3.0'
-  gem 'activerecord', '~> 6.1.0'
-  gem 'activesupport', '~> 6.1.0'
-end
-
-gemspec :path => '../'

data/.circleci/config.yml

@@ -1,48 +0,0 @@
-version: 2.1
-
-executors:
-  ruby:
-    parameters:
-      version:
-        type: string
-    docker:
-    - image: circleci/ruby:<< parameters.version >>
-    - image: circleci/mysql:5
-    environment:
-    - RAILS_ENV: test
-    - MYSQL_HOST: 127.0.0.1
-
-jobs:
-  rspec:
-    parameters:
-      version:
-        type: string
-    executor:
-      name: ruby
-      version: << parameters.version >>
-    steps:
-    - checkout
-    - run:
-        name: bundle install
-        command: |
-          gem update bundler
-          bundle config --local path ../vendor/bundle
-          bundle install --gemfile .circleci/Gemfile --jobs=4 --retry=3
-          bundle config --local path vendor/bundle
-    - run:
-        name: Setup databases
-        command: bundle exec rake db:prepare
-    - run:
-        name: Run tests
-        command: bundle exec rspec
-
-workflows:
-  version: 2
-  rspecs:
-    jobs:
-    - rspec:
-        matrix:
-          parameters:
-            version:
-            - "2.7"
-            - "3.0"

data/lib/octoball/connection_handling.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-class Octoball
-  module ConnectionHandlingAvoidAutoLoadProxy
-    private
-
-    def swap_connection_handler(handler, &blk)
-      old_handler, ActiveRecord::Base.connection_handler = ActiveRecord::Base.connection_handler, handler
-      return_value = yield
-      return_value.load if !return_value.respond_to?(:ar_relation) && return_value.is_a?(ActiveRecord::Relation)
-      return_value
-    ensure
-      ActiveRecord::Base.connection_handler = old_handler
-    end
-  end
-
-  ::ActiveRecord::Base.extend(ConnectionHandlingAvoidAutoLoadProxy)
-end