ar-multidb 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffcc496d5d9335e9f71ad121e3ae6eaa4be56a0fc0d28b95b8ec9316b52f6d99
-  data.tar.gz: ce582565fa33aacb84c073f870034a2fb04d6a629f0c311d0d95d8548a31e817
+  metadata.gz: 43b7a06c5b9e515743e31eabe777ed7f3d56374ac1861b505266636fb30fb2a6
+  data.tar.gz: cfdbffebdbd4c940c08fb0260abfe3f5c25700be5a9cf562f4ad7dc370b93aee
 SHA512:
-  metadata.gz: 1b023104b3d3f4a50c5db4aa1ffb0a68bcef8af7eca53be1e2c05e7d9eb65213cf8cb25f82cec3dbb4ffe11844fd20da09642f32912580906b929a6d505e2f3c
-  data.tar.gz: 75a697a0f62a8c7219a721d5a0b2390d94521f5c7b48676c17ff8bee958632c8d1f3abf96e2950b69c4a489cb8348136a853f6f2f02522f8b358f6a3aaacdec8
+  metadata.gz: cb45e7c3f610828ad5293ec478b5b0cfda8b17952d0f2a7772b3128e7c2515f396546a1f7a3014864ed489fa1a0da1e721c03cf50297c498051e0a7b3060218b
+  data.tar.gz: 68cce9fef6f957b8212c41bddaeca6fe0711a614cd84d8cb38e7419a572929e9e5119344b4602d6efc53deafed42fa0c9acda6122e16149ee68e3e1af4d0823c

data/.github/workflows/prs.yml

@@ -0,0 +1,71 @@
+---
+name: CI PR Builds
+'on':
+  push:
+    branches:
+    - master
+  pull_request:
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    name: CI Build
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+        - '2.5'
+        - '2.7'
+        - '3.0'
+        activerecord:
+        - '5.1'
+        - '5.2'
+        - '6.0'
+        - '6.1'
+        - '7.0'
+        - '7.1'
+        exclude:
+        - ruby: '2.5'
+          activerecord: '7.0'
+        - ruby: '2.5'
+          activerecord: '7.1'
+        - ruby: '3.0'
+          activerecord: '5.1'
+        - ruby: '3.0'
+          activerecord: '5.2'
+    env:
+      BUNDLE_GEMFILE: "${{ github.workspace }}/gemfiles/activerecord-${{ matrix.activerecord }}.gemfile"
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+        bundler-cache: true
+    - name: Run bundle update
+      run: bundle update
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Run rubocop
+      run: bundle exec rubocop
+    - name: Coveralls Parallel
+      if: "${{ !env.ACT }}"
+      uses: coverallsapp/github-action@v2
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"
+        flag-name: run-${{ matrix.ruby }}-${{ matrix.activerecord }}
+        parallel: true
+  finish:
+    name: All CI Tests Passed
+    needs:
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        if: "${{ !env.ACT }}"
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          parallel-finished: true

data/.gitignore

@@ -8,3 +8,4 @@ gemfiles/*.lock
 .ruby-version
 .ruby-gemset
 .rspec
+/coverage

data/.rubocop.yml

@@ -1,64 +1,208 @@
+require:
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   SuggestExtensions: false
   NewCops: disable
   Exclude:
     - '**/vendor/**/*'
 
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
-Layout/SpaceAroundMethodCallOperator:
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
   Enabled: true
 Layout/LineLength:
   Exclude:
-    - 'ar-multidb.gemspec'
+    - ar-multidb.gemspec
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousBlockAssociation:
+  IgnoredMethods:
+    - change
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
 Lint/DuplicateElsifCondition:
   Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
 Lint/MixedRegexpCaptureTypes:
   Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
 Lint/RaiseException:
   Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
 Lint/StructNewOverride:
   Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+
 Naming/FileName:
   Exclude:
-    - 'lib/ar-multidb.rb'
+    - lib/ar-multidb.rb
+    - 'gemfiles/*'
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+
 Metrics:
   Enabled: false
+
+RSpec/ExampleLength:
+  CountAsOne: [array, heredoc]
+  Max: 9
+RSpec/ExpectChange:
+  EnforcedStyle: block
+RSpec/ImplicitSubject:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
+
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+
 Style/AccessorGrouping:
   Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
 Style/ArrayCoercion:
   Enabled: true
 Style/BisectedAttrAccessor:
   Enabled: true
+Style/BlockDelimiters:
+  Enabled: false
 Style/CaseLikeIf:
   Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
 Style/Documentation:
   Enabled: false
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
 Style/ExponentialNotation:
   Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
 Style/HashAsLastArrayItem:
   Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
 Style/HashLikeCase:
   Enabled: true
 Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
 Style/RedundantAssignment:
   Enabled: true
 Style/RedundantFetchBlock:
   Enabled: true
 Style/RedundantFileExtensionInRequire:
   Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
 Style/RedundantRegexpCharacterClass:
   Enabled: true
 Style/RedundantRegexpEscape:
   Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
 Style/SlicingWithRange:
   Enabled: true
-
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true

data/.simplecov

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+SimpleCov.configure do
+  enable_coverage :branch
+  add_filter '/spec/'
+  add_filter 'lib/multidb/version.rb'
+  add_filter 'lib/ar-multidb.rb'
+
+  add_group 'Binaries', '/bin/'
+  add_group 'Libraries', '/lib/'
+
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+end

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [0.7.0]
+### Changed
+- add AR 7.1 support
+
+## [0.6.0]
+### Changed
+- dropped ruby 2.4 support
+- add AR 6.1 and 7.0 support
+
 ## [0.5.1]
 ### Fixed
 - corrected licenses
@@ -23,4 +32,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [0.4.1]
 ### Added
 - Added support for database aliases ( PR #26 )
-

data/Gemfile

@@ -5,8 +5,5 @@ source 'http://rubygems.org'
 # Specify your gem's dependencies in ar-multidb.gemspec
 gemspec
 
-local_gemfile = 'Gemfile.local'
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
-end
+local_gemfile = File.expand_path('Gemfile.local', __dir__)
+eval(File.read(local_gemfile), binding, local_gemfile) if File.exist?(local_gemfile) # rubocop:disable Security/Eval

data/README.markdown

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/atombender/multidb.png?branch=master)](https://travis-ci.org/atombender/multidb)
+[![Build Status](https://github.com/OutOfOrder/multidb/actions/workflows/prs.yml/badge.svg)](https://github.com/OutOfOrder/multidb/actions)
+[![Coverage Status](https://coveralls.io/repos/github/OutOfOrder/multidb/badge.svg?branch=master)](https://coveralls.io/github/OutOfOrder/multidb?branch=master)
 
 # Multidb
 
@@ -14,10 +15,11 @@ Randomized balancing of multiple connections within a group is supported. In the
 
 ## Requirements
 
-* Ruby 2.4 or later.
+* Ruby 2.5 or later.
 * ActiveRecord 5.1 or later.
 
 ## Older releases
+For Ruby 2.4 use version 0.5.1
 For ActiveRecord 4. through 5.0 use version 0.3
 For ActiveRecord older than 4.0 use the gem version 0.1.13
 For ActiveRecord older than 3.0 use 0.1.10

data/ar-multidb.gemspec

@@ -7,23 +7,27 @@ Gem::Specification.new do |s|
   s.name        = 'ar-multidb'
   s.version     = Multidb::VERSION
   s.authors     = ['Alexander Staubo', 'Edward Rudd']
-  s.email       = ['alex@bengler.no', 'urkle@outoforder.cc']
-  s.homepage    = ''
+  s.email       = %w[alex@bengler.no urkle@outoforder.cc]
+  s.homepage    = 'https://github.com/OutOfOrder/multidb'
   s.summary     = s.description = 'Multidb is an ActiveRecord extension for switching between multiple database connections, such as primary/replica setups.'
   s.license     = 'MIT'
+  s.metadata['rubygems_mfa_required'] = 'true'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.5.0'
 
-  s.add_runtime_dependency 'activerecord', '>= 5.1', '< 6.1'
-  s.add_runtime_dependency 'activesupport', '>= 5.1', '< 6.1'
+  s.add_runtime_dependency 'activerecord', '>= 5.1', '< 7.2'
+  s.add_runtime_dependency 'activesupport', '>= 5.1', '< 7.2'
 
-  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.8'
-  s.add_development_dependency 'rubocop', '~> 1.12.1'
+  s.add_development_dependency 'rubocop', '~> 1.28.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.10.0'
+  s.add_development_dependency 'simplecov', '~> 0.21.2'
+  s.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
   s.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/gemfiles/activerecord-6.1.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.1.0'
+
+gemspec path: '..'

data/gemfiles/activerecord-7.0.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.0.0'
+
+gemspec path: '..'

data/gemfiles/activerecord-7.1.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.1.0'
+
+gemspec path: '..'

data/lib/multidb/balancer.rb

@@ -26,7 +26,7 @@ module Multidb
     end
 
     def append(databases)
-      databases.each_pair do |name, config|
+      databases.with_indifferent_access.each_pair do |name, config|
         configs = config.is_a?(Array) ? config : [config]
         configs.each do |cfg|
           if cfg['alias']
@@ -51,7 +51,7 @@ module Multidb
 
       raise ArgumentError, "No such database connection '#{name}'" if candidates.empty?
 
-      candidate = candidates.respond_to?(:sample) ? candidates.sample : candidates[rand(candidates.length)]
+      candidate = candidates.sample
 
       block_given? ? yield(candidate) : candidate
     end

data/lib/multidb/candidate.rb

@@ -2,13 +2,22 @@
 
 module Multidb
   class Candidate
+    USE_RAILS_61 = Gem::Version.new(::ActiveRecord::VERSION::STRING) >= Gem::Version.new('6.1')
+    SPEC_NAME = if USE_RAILS_61
+                  'ActiveRecord::Base'
+                else
+                  'primary'
+                end
+
     def initialize(name, target)
       @name = name
 
       case target
       when Hash
+        target = target.merge(name: 'primary') unless USE_RAILS_61
+
         @connection_handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-        @connection_handler.establish_connection(target.merge(name: 'primary'))
+        @connection_handler.establish_connection(target)
       when ActiveRecord::ConnectionAdapters::ConnectionHandler
         @connection_handler = target
       else
@@ -18,9 +27,9 @@ module Multidb
 
     def connection(&block)
       if block_given?
-        @connection_handler.retrieve_connection_pool('primary').with_connection(&block)
+        @connection_handler.retrieve_connection_pool(SPEC_NAME).with_connection(&block)
       else
-        @connection_handler.retrieve_connection('primary')
+        @connection_handler.retrieve_connection(SPEC_NAME)
       end
     end
 

data/lib/multidb/configuration.rb

@@ -1,28 +1,6 @@
 # frozen_string_literal: true
 
 module Multidb
-  class << self
-    delegate :use, :get, :disconnect!, to: :balancer
-  end
-
-  def self.init(config)
-    activerecord_config = config.dup.with_indifferent_access
-    default_adapter = activerecord_config
-    configuration_hash = activerecord_config.delete(:multidb)
-
-    @balancer = Balancer.new(Configuration.new(default_adapter, configuration_hash || {}))
-  end
-
-  def self.balancer
-    @balancer || raise(NotInitializedError, 'Balancer not initialized. You need to run Multidb.init first')
-  end
-
-  def self.reset!
-    @balancer = nil
-  end
-
-  class NotInitializedError < StandardError; end
-
   class Configuration
     def initialize(default_adapter, configuration_hash)
       @default_handler = ActiveRecord::Base.connection_handler

data/lib/multidb/log_subscriber.rb

@@ -8,11 +8,11 @@ module Multidb
       super
     end
 
-    def debug(msg)
+    def debug(msg = nil)
       name = Multidb.balancer.current_connection_name
       if name
         db = color("[DB: #{name}]", ActiveSupport::LogSubscriber::GREEN, true)
-        super(db + msg)
+        super(db + msg.to_s)
       else
         super
       end

data/lib/multidb/model_extensions.rb

@@ -6,7 +6,13 @@ module Multidb
   module Connection
     def establish_connection(spec = nil)
       super(spec)
-      Multidb.init(connection_pool.spec.config)
+      config = if connection_pool.respond_to?(:db_config)
+                 connection_pool.db_config.configuration_hash
+               else
+                 connection_pool.spec.config
+               end
+
+      Multidb.init(config)
     end
 
     def connection

data/lib/multidb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Multidb
-  VERSION = '0.5.1'
+  VERSION = '0.7.0'
 end

data/lib/multidb.rb

@@ -12,3 +12,29 @@ require_relative 'multidb/log_subscriber'
 require_relative 'multidb/candidate'
 require_relative 'multidb/balancer'
 require_relative 'multidb/version'
+
+module Multidb
+  # Error raised when the configuration has not been initialized
+  class NotInitializedError < StandardError; end
+
+  class << self
+    delegate :use, :get, :disconnect!, to: :balancer
+  end
+
+  def self.init(config)
+    activerecord_config = config.dup.with_indifferent_access
+    default_adapter     = activerecord_config
+    configuration_hash  = activerecord_config.delete(:multidb)
+
+    @balancer = Balancer.new(Configuration.new(default_adapter, configuration_hash || {}))
+  end
+
+  def self.balancer
+    @balancer || raise(NotInitializedError, 'Balancer not initialized. You need to run Multidb.init first')
+  end
+
+  def self.reset!
+    @balancer = nil
+    Thread.current[:multidb] = nil
+  end
+end