ar-multidb 0.5.1 → 0.7.0

data/spec/lib/multidb_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Multidb do
+  let(:balancer) { instance_double('Multidb::Balancer', use: nil, get: nil, disconnect!: nil) }
+
+  describe '.balancer' do
+    subject { described_class.balancer }
+
+    context 'with no configuration' do
+      it 'raises exception' do
+        expect { subject }.to raise_error(Multidb::NotInitializedError)
+      end
+    end
+
+    context 'with configuration' do
+      before do
+        ActiveRecord::Base.establish_connection(configuration_with_replicas)
+      end
+
+      it 'returns balancer' do
+        is_expected.to be_an_instance_of(Multidb::Balancer)
+      end
+    end
+  end
+
+  describe '.init' do
+    subject { described_class.init(config) }
+
+    let(:config) { configuration_with_replicas }
+
+    it 'initializes @balancer' do
+      expect { subject }.to change {
+        described_class.instance_variable_get(:@balancer)
+      }.from(nil).to an_instance_of(Multidb::Balancer)
+    end
+
+    it 'initializes the balancer with a configuration object' do
+      allow(Multidb::Configuration).to receive(:new)
+
+      subject
+
+      expect(Multidb::Configuration).to have_received(:new).with(config.except('multidb'), config['multidb'])
+    end
+  end
+
+  describe '.reset!' do
+    subject { described_class.reset! }
+
+    before do
+      described_class.instance_variable_set(:@balancer, balancer)
+    end
+
+    it 'clears @balancer' do
+      expect { subject }.to change {
+        described_class.instance_variable_get(:@balancer)
+      }.from(balancer).to(nil)
+    end
+
+    it 'clears the multidb thread local' do
+      Thread.current[:multidb] = { some: :value }
+
+      expect { subject }.to change { Thread.current[:multidb] }.to nil
+    end
+  end
+
+  describe 'balancer delegates' do
+    before do
+      described_class.instance_variable_set(:@balancer, balancer)
+    end
+
+    it 'delegates use to the balancer' do
+      described_class.use(:name)
+
+      expect(balancer).to have_received(:use).with(:name)
+    end
+
+    it 'delegates get to the balancer' do
+      described_class.get(:name)
+
+      expect(balancer).to have_received(:get).with(:name)
+    end
+
+    it 'delegates disconnect! to the balancer' do
+      described_class.disconnect!
+
+      expect(balancer).to have_received(:disconnect!)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'simplecov'
+SimpleCov.start
+
 ENV['RACK_ENV'] ||= 'test'
 
 require 'rspec'
@@ -10,16 +13,38 @@ require 'fileutils'
 $LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'multidb'
 
-require_relative 'helpers'
+Dir[File.join(__dir__, 'support', '**', '*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
-  config.include Helpers
-  config.expect_with(:rspec) { |c| c.syntax = :should }
-  config.before :each do
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.filter_run_excluding rails: lambda { |v|
+    rails_version = Gem::Version.new(ActiveRecord::VERSION::STRING)
+    test = Gem::Requirement.new(v)
+    !test.satisfied_by?(rails_version)
+  }
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before do
     ActiveRecord::Base.clear_all_connections!
     Multidb.reset!
   end
-  config.after :each do
+
+  config.after do
+    Multidb.reset!
     Dir.glob(File.expand_path('test*.sqlite', __dir__)).each do |f|
       FileUtils.rm(f)
     end

data/spec/support/have_database_matcher.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_database do |expected|
+  match do |conn|
+    list = conn.execute('pragma database_list')
+    @result = File.basename(list.first&.[]('file'))
+    @result == expected
+  end
+  description do
+    "be connected to #{expected}"
+  end
+  failure_message do |actual|
+    "expected that #{actual} would be connected to #{expected}, found #{@result}"
+  end
+end

data/spec/{helpers.rb → support/helpers.rb}

@@ -16,8 +16,11 @@ module Helpers
             - database: spec/test-replica3-1.sqlite
             - database: spec/test-replica3-2.sqlite
           replica_alias:
-            database: spec/test-replica2.sqlite
             alias: replica2
     YAML
   end
 end
+
+RSpec.configure do |config|
+  config.include Helpers
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar-multidb
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexander Staubo
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,7 +20,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +40,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,21 +50,21 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.28.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.28.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -116,18 +158,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/prs.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".simplecov"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.markdown
 - Rakefile
 - ar-multidb.gemspec
-- gemfiles/activerecord51.gemfile
-- gemfiles/activerecord52.gemfile
-- gemfiles/activerecord60.gemfile
+- gemfiles/activerecord-5.1.gemfile
+- gemfiles/activerecord-5.2.gemfile
+- gemfiles/activerecord-6.0.gemfile
+- gemfiles/activerecord-6.1.gemfile
+- gemfiles/activerecord-7.0.gemfile
+- gemfiles/activerecord-7.1.gemfile
 - lib/ar-multidb.rb
 - lib/multidb.rb
 - lib/multidb/balancer.rb
@@ -136,13 +182,20 @@ files:
 - lib/multidb/log_subscriber.rb
 - lib/multidb/model_extensions.rb
 - lib/multidb/version.rb
-- spec/balancer_spec.rb
-- spec/helpers.rb
+- spec/lib/multidb/balancer_spec.rb
+- spec/lib/multidb/candidate_spec.rb
+- spec/lib/multidb/configuration_spec.rb
+- spec/lib/multidb/log_subscriber_extension_spec.rb
+- spec/lib/multidb/model_extensions_spec.rb
+- spec/lib/multidb_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+- spec/support/have_database_matcher.rb
+- spec/support/helpers.rb
+homepage: https://github.com/OutOfOrder/multidb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -151,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -164,6 +217,12 @@ specification_version: 4
 summary: Multidb is an ActiveRecord extension for switching between multiple database
   connections, such as primary/replica setups.
 test_files:
-- spec/balancer_spec.rb
-- spec/helpers.rb
+- spec/lib/multidb/balancer_spec.rb
+- spec/lib/multidb/candidate_spec.rb
+- spec/lib/multidb/configuration_spec.rb
+- spec/lib/multidb/log_subscriber_extension_spec.rb
+- spec/lib/multidb/model_extensions_spec.rb
+- spec/lib/multidb_spec.rb
 - spec/spec_helper.rb
+- spec/support/have_database_matcher.rb
+- spec/support/helpers.rb

data/.travis.yml

@@ -1,17 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: 2.5
-      gemfile: gemfiles/activerecord51.gemfile
-    - rvm: 2.5
-      gemfile: gemfiles/activerecord52.gemfile
-    - rvm: 2.5
-      gemfile: gemfiles/activerecord60.gemfile

data/spec/balancer_spec.rb

@@ -1,161 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'spec_helper'
-
-describe 'Multidb.balancer' do
-  context 'with no configuration' do
-    it 'raises exception' do
-      -> { Multidb.balancer }.should raise_error(Multidb::NotInitializedError)
-    end
-  end
-
-  context 'with configuration' do
-    before do
-      ActiveRecord::Base.establish_connection(configuration_with_replicas)
-    end
-
-    it 'returns balancer' do
-      Multidb.balancer.should_not eq nil
-    end
-
-    it 'returns main connection by default' do
-      conn = ActiveRecord::Base.connection
-
-      list = conn.execute('pragma database_list')
-      list.length.should eq 1
-      File.basename(list[0]['file']).should eq 'test.sqlite'
-
-      Multidb.balancer.current_connection.should eq conn
-    end
-
-    it 'returns default connection name for default connection' do
-      ActiveRecord::Base.connection
-
-      Multidb.balancer.current_connection_name.should eq :default
-    end
-
-    context 'with additional configurations' do
-      before do
-        additional_configuration = { replica4: { database: 'spec/test-replica4.sqlite' } }
-        Multidb.balancer.append(additional_configuration)
-      end
-
-      it 'makes the new database available' do
-        Multidb.use(:replica4) do
-          conn = ActiveRecord::Base.connection
-          conn.should eq Multidb.balancer.current_connection
-          list = conn.execute('pragma database_list')
-          list.length.should eq 1
-          File.basename(list[0]['file']).should eq 'test-replica4.sqlite'
-        end
-      end
-
-      it 'returns the connection name' do
-        Multidb.use(:replica4) do
-          Multidb.balancer.current_connection_name.should eq :replica4
-        end
-      end
-    end
-  end
-
-  describe '#use' do
-    context 'with configuration' do
-      before do
-        ActiveRecord::Base.establish_connection(configuration_with_replicas)
-      end
-
-      context 'undefined connection' do
-        it 'raises exception' do
-          lambda {
-            Multidb.use(:something) do
-            end
-          }.should raise_error(ArgumentError)
-        end
-      end
-
-      it 'returns default connection on :default' do
-        ActiveRecord::Base.connection
-        Multidb.use(:default) do
-          conn2 = ActiveRecord::Base.connection
-          conn2.should eq Multidb.balancer.current_connection
-
-          list = conn2.execute('pragma database_list')
-          list.length.should eq 1
-          File.basename(list[0]['file']).should eq 'test.sqlite'
-        end
-      end
-
-      it 'returns replica connection' do
-        Multidb.use(:replica1) do
-          conn = ActiveRecord::Base.connection
-          conn.should eq Multidb.balancer.current_connection
-          list = conn.execute('pragma database_list')
-          list.length.should eq 1
-          File.basename(list[0]['file']).should eq 'test-replica1.sqlite'
-        end
-      end
-
-      it 'returns results instead of relation' do
-        foobar_class = Class.new(ActiveRecord::Base) do
-          self.table_name = 'foo_bars'
-        end
-        res = Multidb.use(:replica1) do
-          ActiveRecord::Migration.verbose = false
-          ActiveRecord::Schema.define(version: 1) { create_table :foo_bars }
-          foobar_class.where(id: 42)
-        end
-        res.should eq []
-      end
-
-      it 'returns supports nested replica connection' do
-        Multidb.use(:replica1) do
-          Multidb.use(:replica2) do
-            conn = ActiveRecord::Base.connection
-            conn.should eq Multidb.balancer.current_connection
-            list = conn.execute('pragma database_list')
-            list.length.should eq 1
-            File.basename(list[0]['file']).should eq 'test-replica2.sqlite'
-          end
-        end
-      end
-
-      it 'returns preserves state when nesting' do
-        Multidb.use(:replica1) do
-          Multidb.use(:replica2) do
-            conn = ActiveRecord::Base.connection
-            conn.should eq Multidb.balancer.current_connection
-            list = conn.execute('pragma database_list')
-            list.length.should eq 1
-            File.basename(list[0]['file']).should eq 'test-replica2.sqlite'
-          end
-
-          conn = ActiveRecord::Base.connection
-          conn.should eq Multidb.balancer.current_connection
-          list = conn.execute('pragma database_list')
-          list.length.should eq 1
-          File.basename(list[0]['file']).should eq 'test-replica1.sqlite'
-        end
-      end
-
-      it 'returns the parent connection for aliases' do
-        Multidb.use(:replica1).should_not eq Multidb.use(:replica_alias)
-        Multidb.use(:replica2).should eq Multidb.use(:replica_alias)
-      end
-
-      it 'returns random candidate' do
-        names = []
-        100.times do
-          Multidb.use(:replica3) do
-            list = ActiveRecord::Base.connection.execute('pragma database_list')
-            list.length.should eq 1
-            names.push(File.basename(list[0]['file']))
-          end
-        end
-        names.sort.uniq.should eq [
-          'test-replica3-1.sqlite',
-          'test-replica3-2.sqlite'
-        ]
-      end
-    end
-  end
-end