ar-multidb 0.1.12 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cedb676272cc87f3a21d66c15efd9058e0e13551
-  data.tar.gz: b1dae22e38cfbe06ab71ccaf7abbe6dbfb459c9f
+SHA256:
+  metadata.gz: 3ecd6501582114326efd8452ffe712c79b5667d1ce54a181eff6efeaf40d1897
+  data.tar.gz: 85c3e8b3dc155374ef7d7caed121bf5a140cf64030b760bb6cdcdb3123e8cddc
 SHA512:
-  metadata.gz: 5662d638ad37ebd926c8a7c369ed60de18f8debbc121cad19c760a9f7301e73b68d1914f0d8920aa9b2e2dcb7a2af01e79b89a1bf65041b5a636b6e239417502
-  data.tar.gz: cb9a4f11337c379216d295d579e1938266377c887e7b4608a07fbcb1dcc78d298502459f8ad3cfb97e0acda5209261e9a869560e926654d213747e3946e0b65b
+  metadata.gz: e2eefe25c89d914367afecce5ebc07f4be668985097969f5a1c9acb563a22c448778b4128caf64e5dd6029437e28b13188097d6c66c111f4b5911543858f50b1
+  data.tar.gz: c83c08a921575803b15ebf473e125ad6da3619b321208766e9f8d058bb8226154cd21255d14aa77be260bfd17da29926be8aa3bdeda547fed0c6f46624370283

data/.gitignore

@@ -1,4 +1,7 @@
 /pkg
 *~
 \.DS_Store
-*.sqlite
+*.sqlite
+Gemfile.lock
+Gemfile.local
+.rspec

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - '**/vendor/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/LineLength:
+  Exclude:
+    - 'ar-multidb.gemspec'
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Naming/FileName:
+  Exclude:
+    - 'lib/ar-multidb.rb'
+Metrics:
+  Enabled: false
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+

data/.travis.yml

@@ -1,3 +1,15 @@
-rvm:
-  - 1.9.3
-  - 2.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

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+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.4.2]
+### Changed
+- adjust rails restriction to exclude untested rails 6
+- adjust minimum ruby version to 2.4
+- add rubocop
+
+## [0.4.1]
+### Added
+- Added support for database aliases ( PR #26 )
+

data/Gemfile

@@ -1,9 +1,12 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in ar-multidb.gemspec
 gemspec
 
-group :test do
-  # For travis-ci.org
-  gem "rake"
+local_gemfile = 'Gemfile.local'
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
 end

data/README.markdown

@@ -2,9 +2,9 @@
 
 # Multidb
 
-A simple, no-nonsense ActiveRecord extension which allows the application to switch between multiple database connections, such as in a master/slave environment. For example:
+A simple, no-nonsense ActiveRecord extension which allows the application to switch between multiple database connections, such as in a primary/replica environment. For example:
 
-    Multidb.use(:slave) do
+    Multidb.use(:replica) do
       @posts = Post.all
     end
 
@@ -14,8 +14,13 @@ Randomized balancing of multiple connections within a group is supported. In the
 
 ## Requirements
 
-* Ruby 1.9.3 or later.
-* ActiveRecord 3.0 or later. (Earlier versions can use the gem version 0.1.10.)
+* Ruby 2.4 or later.
+* ActiveRecord 5.1 or later.
+
+## Older releases
+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
 
 ## Comparison to other ActiveRecord extensions
 
@@ -27,10 +32,10 @@ Compared to other, more full-featured extensions such as Octopus and Seamless Da
 
 **Orthogonal**. Unlike Octopus, for example, connections follow context:
 
-    Multidb.use(:master) do
+    Multidb.use(:primary) do
       @post = Post.find(1)
-      Multidb.use(:slave) do
-        @post.authors  # This will use the slave
+      Multidb.use(:replica) do
+        @post.authors  # This will use the replica
       end
     end
 
@@ -55,8 +60,8 @@ All that is needed is to set up your `database.yml` file:
       host: db1
       multidb:
         databases:
-          slave:
-            host: db-slave
+          replica:
+            host: db-replica
 
 Each database entry may be a hash or an array. So this also works:
 
@@ -68,24 +73,41 @@ Each database entry may be a hash or an array. So this also works:
       host: db1
       multidb:
         databases:
-          slave:
-            - host: db-slave1
-            - host: db-slave2
+          replica:
+            - host: db-replica1
+            - host: db-replica2
 
 If multiple elements are specified, Multidb will use the list to pick a random candidate connection.
 
 The database hashes follow the same format as the top-level adapter configuration. In other words, each database connection may override the adapter, database name, username and so on.
 
+You may also add an "alias" record to the configuration to support more than one name for a given database configuration.
+
+    production:
+      adapter: postgresql
+      database: myapp_production
+      username: ohoh
+      password: mymy
+      host: db1
+      multidb:
+        databases:
+          main_db:
+            host: db1-a
+          secondary_db:
+            alias: main_db
+
+With the above, `Multidb.use(:main_db)` and `Multidb.use(:secondary_db)` will work identically. This can be useful to support naming scheme migrations transparently: once your application is updated to use `secondary_db` where necessary, you can swap out the configuration.
+
 To use the connection, modify your code by wrapping database access logic in blocks:
 
-    Multidb.use(:slave) do
+    Multidb.use(:replica) do
       @posts = Post.all
     end
 
 To wrap entire controller requests, for example:
 
     class PostsController < ApplicationController
-      around_filter :run_using_slave, only: [:index]
+      around_filter :run_using_replica, only: [:index]
 
       def index
         @posts = Post.all
@@ -95,22 +117,22 @@ To wrap entire controller requests, for example:
         # Won't be wrapped
       end
 
-      def run_using_slave(&block)
-        Multidb.use(:slave, &block)
+      def run_using_replica(&block)
+        Multidb.use(:replica, &block)
       end
     end
 
 You can also set the current connection for the remainder of the thread's execution:
 
-    Multidb.use(:slave)
+    Multidb.use(:replica)
     # Do work
-    Multidb.use(:master)
+    Multidb.use(:primary)
 
 Note that the symbol `:default` will (unless you override it) refer to the default top-level ActiveRecord configuration.
 
 ## Development mode
 
-In development you will typically want `Multidb.use(:slave)` to still work, but you probably don't want to run multiple databases on your development box. To make `use` silently fall back to using the default connection, Multidb can run in fallback mode.
+In development you will typically want `Multidb.use(:replica)` to still work, but you probably don't want to run multiple databases on your development box. To make `use` silently fall back to using the default connection, Multidb can run in fallback mode.
 
 If you are using Rails, this will be automatically enabled in `development` and `test` environments. Otherwise, simply set `fallback: true` in `database.yml`:
 

data/Rakefile

@@ -1,26 +1,27 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
+task default: :spec
 
 desc 'Bump version'
 task :bump do
-  if `git status -uno -s --porcelain | wc -l`.to_i > 0
-    abort "You have uncommitted changed."
-  end
+  abort 'You have uncommitted changed.' if `git status -uno -s --porcelain | wc -l`.to_i.positive?
+
   text = File.read('lib/multidb/version.rb')
   if text =~ /VERSION = '(.*)'/
-    old_version = $1
+    old_version = Regexp.last_match(1)
     version_parts = old_version.split('.')
     version_parts[-1] = version_parts[-1].to_i + 1
     new_version = version_parts.join('.')
     text.gsub!(/VERSION = '(.*)'/, "VERSION = '#{new_version}'")
     File.open('lib/multidb/version.rb', 'w') { |f| f << text }
-    (system("git add lib/multidb/version.rb") and
-      system("git commit -m 'Bump to #{new_version}.'")) or abort "Failed to commit."
+    (system('git add lib/multidb/version.rb') &&
+      system("git commit -m 'Bump to #{new_version}.'")) || abort('Failed to commit.')
   else
-    abort "Could not find version number"
+    abort 'Could not find version number'
   end
 end

data/ar-multidb.gemspec

@@ -1,25 +1,28 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "multidb/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'multidb/version'
 
 Gem::Specification.new do |s|
-  s.name        = "ar-multidb"
+  s.name        = 'ar-multidb'
   s.version     = Multidb::VERSION
-  s.authors     = ["Alexander Staubo"]
-  s.email       = ["alex@bengler.no"]
-  s.homepage    = ""
-  s.summary     = s.description = %q{Multidb is an ActiveRecord extension for switching between multiple database connections, such as master/slave setups.}
-
-  s.rubyforge_project = "ar-multidb"
+  s.authors     = ['Alexander Staubo', 'Edward Rudd']
+  s.email       = ['alex@bengler.no', 'urkle@outoforder.cc']
+  s.homepage    = ''
+  s.summary     = s.description = 'Multidb is an ActiveRecord extension for switching between multiple database connections, such as primary/replica setups.'
 
   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.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.4.0'
 
-  s.add_runtime_dependency 'activesupport', '>= 3.0'
-  s.add_runtime_dependency 'activerecord', '>= 3.0'
+  s.add_runtime_dependency 'activerecord', '>= 5.1', '< 6.0'
+  s.add_runtime_dependency 'activesupport', '>= 5.1', '< 6.0'
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.8'
+  s.add_development_dependency 'rubocop', '~> 0.88.0'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/gemfiles/activerecord51.gemfile

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

data/gemfiles/activerecord52.gemfile

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

data/lib/ar-multidb.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'multidb'

data/lib/multidb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 require 'active_support/core_ext/module/delegation'
@@ -6,5 +8,7 @@ require 'active_support/core_ext/module/aliasing'
 
 require_relative 'multidb/configuration'
 require_relative 'multidb/model_extensions'
+require_relative 'multidb/log_subscriber'
+require_relative 'multidb/candidate'
 require_relative 'multidb/balancer'
 require_relative 'multidb/version'

data/lib/multidb/balancer.rb

@@ -1,107 +1,107 @@
+# frozen_string_literal: true
+
 module Multidb
+  class Balancer
+    attr_accessor :fallback
 
-  class Candidate
-    def initialize(target)
-      if target.is_a?(Hash)
-        adapter = target[:adapter]
-        begin
-          require "active_record/connection_adapters/#{adapter}_adapter"
-        rescue LoadError
-          raise "Please install the #{adapter} adapter: `gem install activerecord-#{adapter}-adapter` (#{$!})"
-        end
-        if defined?(ActiveRecord::ConnectionAdapters::ConnectionSpecification)
-          spec_class = ActiveRecord::ConnectionAdapters::ConnectionSpecification
-        else
-          spec_class = ActiveRecord::Base::ConnectionSpecification
-        end
-        @connection_pool = ActiveRecord::ConnectionAdapters::ConnectionPool.new(
-          spec_class.new(target, "#{adapter}_connection"))
-      else
-        @connection_pool = target
-      end
-    end
+    def initialize(configuration)
+      @candidates = {}.with_indifferent_access
+      @default_configuration = configuration
 
-    def connection(&block)
-      if block_given?
-        @connection_pool.with_connection(&block)
-      else
-        @connection_pool.connection
-      end
-    end
+      return unless @default_configuration
 
-    attr_reader :connection_pool
-  end
+      append(@default_configuration.raw_configuration[:databases] || {})
 
-  class Balancer
+      @fallback = if @default_configuration.raw_configuration.include?(:fallback)
+                    @default_configuration.raw_configuration[:fallback]
+                  elsif defined?(Rails)
+                    %w[development test].include?(Rails.env)
+                  else
+                    false
+                  end
 
-    def initialize(configuration)
-      @candidates = {}.with_indifferent_access
-      @configuration = configuration
-      if @configuration
-        (@configuration.raw_configuration[:databases] || {}).each_pair do |name, config|
-          configs = config.is_a?(Array) ? config : [config]
-          configs.each do |config|
-            candidate = Candidate.new(@configuration.default_adapter.merge(config))
-            @candidates[name] ||= []
-            @candidates[name].push(candidate)
+      @default_candidate = Candidate.new('default', @default_configuration.default_handler)
+
+      @candidates[:default] = [@default_candidate] unless @candidates.include?(:default)
+    end
+
+    def append(databases)
+      databases.each_pair do |name, config|
+        configs = config.is_a?(Array) ? config : [config]
+        configs.each do |cfg|
+          if cfg['alias']
+            @candidates[name] = @candidates[cfg['alias']]
+            next
           end
-        end
-        if @configuration.raw_configuration.include?(:fallback)
-          @fallback = @configuration.raw_configuration[:fallback]
-        elsif defined?(Rails)
-          @fallback = %w(development test).include?(Rails.env)
-        else
-          @fallback = false
-        end
-        @default_candidate = Candidate.new(@configuration.default_pool)
-        unless @candidates.include?(:default)
-          @candidates[:default] = [@default_candidate]
+
+          candidate = Candidate.new(name, @default_configuration.default_adapter.merge(cfg))
+          @candidates[name] ||= []
+          @candidates[name].push(candidate)
         end
       end
     end
 
     def disconnect!
-      @candidates.values.flatten.each do |candidate|
-        candidate.connection_pool.disconnect!
-      end
+      @candidates.values.flatten.each(&:disconnect!)
     end
 
-    def get(name, &block)
+    def get(name, &_block)
       candidates = @candidates[name]
       candidates ||= @fallback ? @candidates[:default] : []
+
       raise ArgumentError, "No such database connection '#{name}'" if candidates.empty?
-      candidate = candidates.respond_to?(:sample) ?
-        candidates.sample : candidates[rand(candidates.length)]
+
+      candidate = candidates.respond_to?(:sample) ? candidates.sample : candidates[rand(candidates.length)]
+
       block_given? ? yield(candidate) : candidate
     end
 
-    def use(name, &block)
+    def use(name, &_block)
       result = nil
       get(name) do |candidate|
         if block_given?
           candidate.connection do |connection|
-            previous_connection, Thread.current[:multidb_connection] =
-              Thread.current[:multidb_connection], connection
+            previous_configuration = Thread.current[:multidb]
+            Thread.current[:multidb] = {
+              connection: connection,
+              connection_name: name
+            }
             begin
               result = yield
+              result = result.to_a if result.is_a?(ActiveRecord::Relation)
             ensure
-              Thread.current[:multidb_connection] = previous_connection
+              Thread.current[:multidb] = previous_configuration
             end
             result
           end
         else
-          result = Thread.current[:multidb_connection] = candidate.connection
+          Thread.current[:multidb] = {
+            connection: candidate.connection,
+            connection_name: name
+          }
+          result = candidate.connection
         end
       end
       result
     end
 
     def current_connection
-      Thread.current[:multidb_connection] || @default_candidate.connection
+      if Thread.current[:multidb]
+        Thread.current[:multidb][:connection]
+      else
+        @default_candidate.connection
+      end
+    end
+
+    def current_connection_name
+      if Thread.current[:multidb]
+        Thread.current[:multidb][:connection_name]
+      else
+        :default
+      end
     end
 
     class << self
-      delegate :use, :current_connection, :disconnect!, to: :balancer
       def use(name, &block)
         Multidb.balancer.use(name, &block)
       end
@@ -110,11 +110,13 @@ module Multidb
         Multidb.balancer.current_connection
       end
 
+      def current_connection_name
+        Multidb.balancer.current_connection_name
+      end
+
       def disconnect!
         Multidb.balancer.disconnect!
       end
     end
-
   end
-
-end
+end

data/lib/multidb/candidate.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Multidb
+  class Candidate
+    def initialize(name, target)
+      @name = name
+
+      case target
+      when Hash
+        @connection_handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+        @connection_handler.establish_connection(target.merge(name: 'primary'))
+      when ActiveRecord::ConnectionAdapters::ConnectionHandler
+        @connection_handler = target
+      else
+        raise ArgumentError, 'Connection handler not passed to target'
+      end
+    end
+
+    def connection(&block)
+      if block_given?
+        @connection_handler.retrieve_connection_pool('primary').with_connection(&block)
+      else
+        @connection_handler.retrieve_connection('primary')
+      end
+    end
+
+    def disconnect!
+      @connection_handler.clear_all_connections!
+    end
+
+    attr_reader :name
+  end
+end

data/lib/multidb/configuration.rb

@@ -1,54 +1,35 @@
-module Multidb
-
-  mattr_reader :configuration
+# 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 ||= create_balancer
+    @balancer || raise(NotInitializedError, 'Balancer not initialized. You need to run Multidb.init first')
   end
 
   def self.reset!
-    @balancer, @configuration = nil, nil
+    @balancer = nil
   end
 
+  class NotInitializedError < StandardError; end
+
   class Configuration
     def initialize(default_adapter, configuration_hash)
-      @default_pool = ActiveRecord::Base.connection_pool
+      @default_handler = ActiveRecord::Base.connection_handler
       @default_adapter = default_adapter
       @raw_configuration = configuration_hash
     end
 
-    attr_reader :default_pool
-    attr_reader :default_adapter
-    attr_reader :raw_configuration
+    attr_reader :default_handler, :default_adapter, :raw_configuration
   end
-
-  private
-
-    def self.create_balancer
-      unless @configuration
-        begin
-          connection_pool = ActiveRecord::Base.connection_pool
-        rescue ActiveRecord::ConnectionNotEstablished
-          # Ignore
-        else
-          connection = connection_pool.connection
-
-          # FIXME: This is hacky, but apparently the only way to get at
-          #   the internal configuration hash.
-          activerecord_config = connection.instance_variable_get(:@config).dup.with_indifferent_access
-
-          default_adapter, configuration_hash = activerecord_config, activerecord_config.delete(:multidb)
-
-          @configuration = Configuration.new(default_adapter, configuration_hash || {})
-        end
-      end
-      if @configuration
-        Balancer.new(@configuration)
-      end
-    end
-
-end
+end

data/lib/multidb/log_subscriber.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Multidb
+  module LogSubscriberExtension
+    def sql(event)
+      name = Multidb.balancer.current_connection_name
+      event.payload[:db_name] = name if name
+      super
+    end
+
+    def debug(msg)
+      name = Multidb.balancer.current_connection_name
+      if name
+        db = color("[DB: #{name}]", ActiveSupport::LogSubscriber::GREEN, true)
+        super(db + msg)
+      else
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::LogSubscriber.prepend(Multidb::LogSubscriberExtension)

data/lib/multidb/model_extensions.rb

@@ -1,24 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_record/base'
+
 module Multidb
-  module ModelExtensions
+  module Connection
+    def establish_connection(spec = nil)
+      super(spec)
+      Multidb.init(connection_pool.spec.config)
+    end
+
+    def connection
+      Multidb.balancer.current_connection
+    rescue Multidb::NotInitializedError
+      super
+    end
+  end
 
+  module ModelExtensions
     extend ActiveSupport::Concern
 
     included do
       class << self
-        alias_method_chain :connection, :multidb
-      end
-    end
-
-    module ClassMethods
-      def connection_with_multidb
-        if (balancer = Multidb.balancer)
-          balancer.current_connection
-        else
-          connection_without_multidb
-        end
+        prepend Multidb::Connection
       end
     end
-
   end
 end
 

data/lib/multidb/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Multidb
-  VERSION = '0.1.12'
-end
+  VERSION = '0.4.2'
+end

data/spec/balancer_spec.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 require_relative 'spec_helper'
 
 describe 'Multidb.balancer' do
-
   context 'with no configuration' do
-    it 'returns nothing' do
-      Multidb.balancer.should eq nil
+    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_slaves)
+      ActiveRecord::Base.establish_connection(configuration_with_replicas)
     end
 
     it 'returns balancer' do
@@ -26,25 +27,54 @@ describe 'Multidb.balancer' do
 
       Multidb.balancer.current_connection.should eq conn
     end
-  end
 
-  describe '#use' do
-    context 'with no configuration' do
-      it 'raises exception' do
-        -> {
-          Multidb.use(:something) do
-          end
-        }.should raise_error(ArgumentError)
+    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_slaves)
+        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
-        conn = ActiveRecord::Base.connection
+        ActiveRecord::Base.connection
         Multidb.use(:default) do
           conn2 = ActiveRecord::Base.connection
           conn2.should eq Multidb.balancer.current_connection
@@ -55,61 +85,75 @@ describe 'Multidb.balancer' do
         end
       end
 
-      it 'returns slave connection' do
-        Multidb.use(:slave1) do
+      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-slave1.sqlite'
+          File.basename(list[0]['file']).should eq 'test-replica1.sqlite'
+        end
+      end
+
+      it 'returns results instead of relation' do
+        class FooBar < ActiveRecord::Base; end
+        res = Multidb.use(:replica1) do
+          ActiveRecord::Migration.verbose = false
+          ActiveRecord::Schema.define(version: 1) { create_table :foo_bars }
+          FooBar.where(id: 42)
         end
+        res.should eq []
       end
 
-      it 'returns supports nested slave connection' do
-        Multidb.use(:slave1) do
-          Multidb.use(:slave2) do
+      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-slave2.sqlite'
+            File.basename(list[0]['file']).should eq 'test-replica2.sqlite'
           end
         end
       end
 
       it 'returns preserves state when nesting' do
-        Multidb.use(:slave1) do
-          Multidb.use(:slave2) 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-slave2.sqlite'
+            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-slave1.sqlite'
+          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(:slave3) 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-slave3-1.sqlite',
-          'test-slave3-2.sqlite'
+          'test-replica3-1.sqlite',
+          'test-replica3-2.sqlite'
         ]
       end
     end
   end
-
-end
+end

data/spec/helpers.rb

@@ -1,20 +1,23 @@
-module Helpers
+# frozen_string_literal: true
 
-  def configuration_with_slaves
-    return YAML.load(<<-end)
-adapter: sqlite3
-database: spec/test.sqlite
-encoding: utf-8
-multidb:
-  databases:
-    slave1:
-      database: spec/test-slave1.sqlite
-    slave2:
-      database: spec/test-slave2.sqlite
-    slave3:
-      - database: spec/test-slave3-1.sqlite
-      - database: spec/test-slave3-2.sqlite
-end
+module Helpers
+  def configuration_with_replicas
+    YAML.safe_load(<<~YAML)
+      adapter: sqlite3
+      database: spec/test.sqlite
+      encoding: utf-8
+      multidb:
+        databases:
+          replica1:
+            database: spec/test-replica1.sqlite
+          replica2:
+            database: spec/test-replica2.sqlite
+          replica3:
+            - database: spec/test-replica3-1.sqlite
+            - database: spec/test-replica3-2.sqlite
+          replica_alias:
+            database: spec/test-replica2.sqlite
+            alias: replica2
+    YAML
   end
-
-end
+end

data/spec/spec_helper.rb

@@ -1,23 +1,26 @@
-environment = ENV['RACK_ENV'] ||= 'test'
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] ||= 'test'
 
 require 'rspec'
 require 'yaml'
 require 'active_record'
 require 'fileutils'
 
-$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'multidb'
 
 require_relative 'helpers'
 
 RSpec.configure do |config|
   config.include Helpers
+  config.expect_with(:rspec) { |c| c.syntax = :should }
   config.before :each do
     ActiveRecord::Base.clear_all_connections!
     Multidb.reset!
   end
   config.after :each do
-    Dir.glob(File.expand_path('../test*.sqlite', __FILE__)).each do |f|
+    Dir.glob(File.expand_path('test*.sqlite', __dir__)).each do |f|
       FileUtils.rm(f)
     end
   end

metadata

@@ -1,91 +1,138 @@
 --- !ruby/object:Gem::Specification
 name: ar-multidb
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.4.2
 platform: ruby
 authors:
 - Alexander Staubo
-autorequire: 
+- Edward Rudd
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: Multidb is an ActiveRecord extension for switching between multiple database
-  connections, such as master/slave setups.
+  connections, such as primary/replica setups.
 email:
 - alex@bengler.no
+- urkle@outoforder.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.markdown
 - Rakefile
 - ar-multidb.gemspec
+- gemfiles/activerecord51.gemfile
+- gemfiles/activerecord52.gemfile
 - lib/ar-multidb.rb
 - lib/multidb.rb
 - lib/multidb/balancer.rb
+- lib/multidb/candidate.rb
 - lib/multidb/configuration.rb
+- lib/multidb/log_subscriber.rb
 - lib/multidb/model_extensions.rb
 - lib/multidb/version.rb
 - spec/balancer_spec.rb
@@ -94,29 +141,27 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ar-multidb
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Multidb is an ActiveRecord extension for switching between multiple database
-  connections, such as master/slave setups.
+  connections, such as primary/replica setups.
 test_files:
 - spec/balancer_spec.rb
 - spec/helpers.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ar-multidb (0.1.11)
-      activerecord (>= 3.0)
-      activesupport (>= 3.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (4.0.2)
-      activesupport (= 4.0.2)
-      builder (~> 3.1.0)
-    activerecord (4.0.2)
-      activemodel (= 4.0.2)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.2)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    arel (4.0.1)
-    atomic (1.1.14)
-    builder (3.1.4)
-    diff-lcs (1.2.5)
-    i18n (0.6.9)
-    minitest (4.7.5)
-    multi_json (1.8.4)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.5)
-    sqlite3 (1.3.8)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ar-multidb!
-  rake
-  rspec
-  sqlite3