ar-multidb 0.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea08a6b114f52250b4d917e901839dd063dab40b
-  data.tar.gz: 6cdde3b0f316fdbb1b68379944fb0eadb91afa25
+SHA256:
+  metadata.gz: e055c742a6029415524f28349e3241360013adc1184666609ed854273b0bd0af
+  data.tar.gz: dad603f9c611e867dfba0a83f2253cedbcfa5b20b75459d645105d9ed57c8faf
 SHA512:
-  metadata.gz: 547ad2beb0fd69f417e0670e404623a8d08a09e66e65bf954a34a34374e51c1db529420d35c686b8fd740afb0cdb2f10724a4538f5f3205b1c3b5af86418afdb
-  data.tar.gz: 4e1869077ee855daf7d1fdc95e374d0944e731ca962d97cc8a1546b771f2f20bd065b6b8bfb7904985b1a452fe5e8f94deb0079c4ad0e2b229a90a80fdd63a93
+  metadata.gz: 80653278f75c95b67e5813c0307b26ff63e5796dd9371228911200ed532711370d7e48e6ec7d841ca59ba820e14843d15a7603099d5f20a451d3f03e3a4c54a9
+  data.tar.gz: 11feb31f0e7aed8f9059a91a1da11393df366da7c7d3960a68704ae078dca92e520524a4f23eec7754210a09fac407bb5b449dca1b9dcf449d3b447590f6eb40

data/.travis.yml

@@ -4,9 +4,7 @@ language: ruby
 matrix:
   fast_finish: true
   include:
-    - rvm: 2.2
-      gemfile: gemfiles/activerecord40.gemfile
-    - rvm: 2.4.3
-      gemfile: gemfiles/activerecord42.gemfile
     - rvm: 2.5.0
-      gemfile: Gemfile
+      gemfile: gemfiles/activerecord51.gemfile
+    - rvm: 2.5.0
+      gemfile: gemfiles/activerecord52.gemfile

data/README.markdown

@@ -15,7 +15,12 @@ Randomized balancing of multiple connections within a group is supported. In the
 ## Requirements
 
 * Ruby 2.2 or later.
-* ActiveRecord 4.0 or later. (Earlier versions can use the gem version 0.1.13 for Rails 3.2 and 0.1.10 for older version)
+* 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
 

data/ar-multidb.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'activesupport', '>= 4.0', '<= 6.0'
-  s.add_runtime_dependency 'activerecord', '>= 4.0', '<= 6.0'
+  s.add_runtime_dependency 'activesupport', '>= 5.1', '<= 6.0'
+  s.add_runtime_dependency 'activerecord', '>= 5.1', '<= 6.0'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'sqlite3'

data/gemfiles/{activerecord40.gemfile → activerecord51.gemfile}

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.0.0'
+gem 'activerecord', '~> 5.1.0'
 
 gemspec path: '..'

data/gemfiles/{activerecord42.gemfile → activerecord52.gemfile}

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.2'
+gem 'activerecord', '~> 5.2.0'
 
 gemspec path: '..'

data/lib/multidb.rb

@@ -6,5 +6,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,48 +1,6 @@
 module Multidb
-
-  class Candidate
-    def initialize(name, target)
-      @name = name
-
-      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
-
-        spec =
-          if ActiveRecord::VERSION::MAJOR >= 5
-            # ActiveRecord 5.0.1 introduced `name` to initialize
-            spec_class.new(name, target, "#{adapter}_connection")
-          else
-            spec_class.new(target, "#{adapter}_connection")
-          end
-
-          @connection_pool = ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
-      else
-        @connection_pool = target
-      end
-    end
-
-    def connection(&block)
-      if block_given?
-        @connection_pool.with_connection(&block)
-      else
-        @connection_pool.connection
-      end
-    end
-
-    attr_reader :connection_pool, :name
-  end
-
   class Balancer
+    attr_accessor :fallback
 
     def initialize(configuration)
       @candidates = {}.with_indifferent_access
@@ -59,13 +17,13 @@ module Multidb
         else
           @fallback = false
         end
-        @default_candidate = Candidate.new('default', @default_configuration.default_pool)
+        @default_candidate = Candidate.new('default', @default_configuration.default_handler)
         unless @candidates.include?(:default)
           @candidates[:default] = [@default_candidate]
         end
       end
     end
-    
+
     def append(databases)
       databases.each_pair do |name, config|
         configs = config.is_a?(Array) ? config : [config]
@@ -78,9 +36,7 @@ module Multidb
     end
 
     def disconnect!
-      @candidates.values.flatten.each do |candidate|
-        candidate.connection_pool.disconnect!
-      end
+      @candidates.values.flatten.each(&:disconnect!)
     end
 
     def get(name, &block)
@@ -97,30 +53,47 @@ module Multidb
       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
 
-    class << self
-      delegate :use, :current_connection, :disconnect!, to: :balancer
+    def current_connection_name
+      if Thread.current[:multidb]
+        Thread.current[:multidb][:connection_name]
+      else
+        :default
+      end
+    end
 
+    class << self
       def use(name, &block)
         Multidb.balancer.use(name, &block)
       end
@@ -129,6 +102,10 @@ module Multidb
         Multidb.balancer.current_connection
       end
 
+      def current_connection_name
+        Multidb.balancer.current_connection_name
+      end
+
       def disconnect!
         Multidb.balancer.disconnect!
       end

data/lib/multidb/candidate.rb

@@ -0,0 +1,31 @@
+module Multidb
+  class Candidate
+    def initialize(name, target)
+      @name = name
+
+      if target.is_a?(Hash)
+        @connection_handler = ActiveRecord::ConnectionAdapters::ConnectionHandler.new
+        @connection_handler.establish_connection(target.merge(name: 'primary'))
+      elsif target.is_a?(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

@@ -14,7 +14,7 @@ module Multidb
     if @balancer
       @balancer
     else
-      raise NotInitializedError, "Balancer not initialized. You need to run Multidb.setup first"
+      raise NotInitializedError, "Balancer not initialized. You need to run Multidb.init first"
     end
   end
 
@@ -22,16 +22,16 @@ module Multidb
     @balancer = nil
   end
 
-  class NotInitializedError < StandardError; 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_handler
     attr_reader :default_adapter
     attr_reader :raw_configuration
   end

data/lib/multidb/log_subscriber.rb

@@ -0,0 +1,21 @@
+module Multidb
+  module LogSubscriberExtension
+    def sql(event)
+      if name = Multidb.balancer.current_connection_name
+        event.payload[:db_name] = name
+      end
+      super
+    end
+
+    def debug(msg)
+      if name = Multidb.balancer.current_connection_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/version.rb

@@ -1,3 +1,3 @@
 module Multidb
-  VERSION = '0.3'
+  VERSION = '0.4.0'
 end

data/spec/balancer_spec.rb

@@ -26,6 +26,12 @@ describe 'Multidb.balancer' do
 
       Multidb.balancer.current_connection.should eq conn
     end
+
+    it 'returns default connection name for default connection' do
+      conn = ActiveRecord::Base.connection
+
+      Multidb.balancer.current_connection_name.should eq :default
+    end
   
     context 'with additional configurations' do
       before do
@@ -42,6 +48,12 @@ describe 'Multidb.balancer' do
           File.basename(list[0]['file']).should eq 'test-slave4.sqlite'
         end
       end
+
+      it 'returns the connection name' do
+        Multidb.use(:slave4) do
+          Multidb.balancer.current_connection_name.should eq :slave4
+        end
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-multidb
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexander Staubo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.0'
@@ -107,12 +107,14 @@ files:
 - README.markdown
 - Rakefile
 - ar-multidb.gemspec
-- gemfiles/activerecord40.gemfile
-- gemfiles/activerecord42.gemfile
+- 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
@@ -137,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ar-multidb
-rubygems_version: 2.5.2
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Multidb is an ActiveRecord extension for switching between multiple database