octoshark 0.1.2 → 0.3.0

data/Rakefile

@@ -10,16 +10,16 @@ task :default => :spec
 
 namespace :db do
   task :establish_connection do
-    configs    = YAML.load_file('spec/support/config.yml').with_indifferent_access
-    config     = configs[:db1].except(:database)
-    @databases = configs.map { |_, config| config[:database] }
+    configs    = YAML.load_file('spec/support/config.yml')
+    config     = configs['db1'].reject { |k, v| k == 'database' }
+    @databases = configs.map { |_, config| config['database'] }
     ActiveRecord::Base.establish_connection(config)
   end
 
   task :create => :establish_connection do
     @databases.each do |database|
       begin
-        ActiveRecord::Base.connection.create_database(database)
+        ActiveRecord::Base.connection.create_database(database, charset: 'utf8')
         puts "#{database} created."
       rescue ActiveRecord::StatementInvalid => e
         if e.message.match /database exists/

data/gemfiles/rails3.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0.0"
+gem "mysql2", "< 0.3"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails3.1.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 3.1.0"
+gem "mysql2", "~> 0.3.10"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails3.2.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 3.2.0"
+gem "mysql2", "~> 0.3.10"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/{rails4.gemfile → rails4.0.gemfile}

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.0.0"
+gem "mysql2", "~> 0.3.10"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails4.1.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.1.0"
+gem "mysql2", "~> 0.3.13"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails4.2.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.0"
+gem "mysql2", "~> 0.3.13"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails5.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+gem "mysql2", "~> 0.5.2"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails5.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+gem "mysql2", "~> 0.5.2"
+gem "sqlite3", "~> 1.4.1"
+
+gemspec path: "../"

data/gemfiles/rails5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "mysql2", "~> 0.5.2"
+gem "sqlite3", "~> 1.4.1"
+
+gemspec path: "../"

data/gemfiles/rails6.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "mysql2", "~> 0.5.2"
+gem "sqlite3", "~> 1.4.1"
+
+gemspec path: "../"

data/gemfiles/rails6.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.0"
+gem "mysql2", "~> 0.5.2"
+gem "sqlite3", "~> 1.4.1"
+
+gemspec path: "../"

data/lib/octoshark.rb

@@ -3,23 +3,8 @@ require 'active_record'
 require 'octoshark/active_record_extensions'
 
 module Octoshark
-  autoload :ConnectionManager, 'octoshark/connection_manager'
-  autoload :Error,             'octoshark/error'
-
-  # Octoshark needs to keep track of all connection managers in order to
-  # automatically reconnect on connection establish.
-  @@connection_managers = []
-
-  def self.connection_managers
-    @@connection_managers
-  end
-
-  def self.reset_connection_managers!
-    connection_managers.map(&:reset!)
-  end
-
-  def self.disconnect!
-    connection_managers.map(&:disconnect!)
-    @@connection_managers = []
-  end
+  autoload :CurrentConnection,      'octoshark/current_connection'
+  autoload :ConnectionManager,      'octoshark/connection_manager'
+  autoload :ConnectionPoolsManager, 'octoshark/connection_pools_manager'
+  autoload :Error,                  'octoshark/error'
 end

data/lib/octoshark/active_record_extensions.rb

@@ -1,47 +1,31 @@
 module Octoshark
-  module ActiveRecordBase
-    extend ActiveSupport::Concern
-
-    included do
-      class << self
-        alias_method_chain :establish_connection, :octoshark
-      end
-    end
-
-    module ClassMethods
-      # When a connection is established in an ancestor process that must have
-      # subsequently forked, ActiveRecord establishes a new connection because
-      # it can't reuse the existing one. When that happens, we need to reconnect
-      # Octoshark connection managers.
-      def establish_connection_with_octoshark(*args)
-        establish_connection_without_octoshark(*args)
-        Octoshark.reset_connection_managers!
-      end
+  module ConnectionHandler
+    def establish_connection(*args)
+      Octoshark::ConnectionPoolsManager.reset_connection_managers!
+      super(*args)
     end
   end
 
   module ActiveRecordAbstractAdapter
-    extend ActiveSupport::Concern
-
     attr_accessor :connection_name, :database_name
 
-    included do
-      alias_method_chain :log, :octoshark
-    end
-
-    def log_with_octoshark(sql, name = "SQL", *other_args, &block)
-      if connection_name
-        if database_name
-          name = "[Octoshark: #{connection_name} #{database_name}] #{name}"
-        else
-          name = "[Octoshark: #{connection_name}] #{name}"
-        end
+    def log(sql, name = "SQL", *other_args, &block)
+      if connection_name || database_name
+        name = "[Octoshark: #{[connection_name, database_name].compact.join(' ')}] #{name}"
       end
 
-      log_without_octoshark(sql, name, *other_args, &block)
+      super(sql, name, *other_args, &block)
     end
   end
 end
 
-ActiveRecord::Base.send(:include, Octoshark::ActiveRecordBase)
-ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, Octoshark::ActiveRecordAbstractAdapter)
+if defined?(ActiveRecord::ConnectionAdapters::ConnectionHandler)
+  # Rails 3.2, 4.0, 4.1, 4.2, 5.0
+  ActiveRecord::ConnectionAdapters::ConnectionHandler.send(:prepend, Octoshark::ConnectionHandler)
+else
+  # Rails 3.0 and 3.1 does not lazy load
+  require 'active_record/connection_adapters/abstract_adapter'
+  ActiveRecord::ConnectionAdapters::ConnectionHandler.send(:prepend, Octoshark::ConnectionHandler)
+end
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:prepend, Octoshark::ActiveRecordAbstractAdapter)

data/lib/octoshark/connection_manager.rb

@@ -1,118 +1,20 @@
 module Octoshark
   class ConnectionManager
+    include CurrentConnection
 
-    attr_reader :connection_pools
+    def with_connection(config, connection_name: nil, &block)
+      connection_method = "#{config[:adapter]}_connection"
 
-    def initialize(configs = {})
-      @configs = configs.with_indifferent_access
-      setup_connection_pools
-
-      Octoshark.connection_managers << self
-    end
-
-    def reset!
-      disconnect!
-      setup_connection_pools
-    end
-
-    def current_connection
-      Thread.current[identifier] || raise(Octoshark::Error::NoCurrentConnection, "No current connection")
-    end
-
-    def current_connection?
-      !Thread.current[identifier].nil?
-    end
-
-    def current_or_default_connection
-      Thread.current[identifier] || ActiveRecord::Base.connection_pool.connection
-    end
-
-    def with_connection(name, &block)
-      connection_pool = find_connection_pool(name)
-      with_connection_pool(name, connection_pool, &block)
-    end
-
-    def with_new_connection(name, config, reusable: false, &block)
-      if reusable
-        connection_pool = @connection_pools[name] ||= create_connection_pool(config)
-        with_connection_pool(name, connection_pool, &block)
-      else
-        connection_pool = create_connection_pool(config)
-        with_connection_pool(name, connection_pool, &block).tap do
-          connection_pool.disconnect!
-        end
-      end
-    end
-
-    def use_database(name, database_name, &block)
-      connection_pool = find_connection_pool(name)
-      with_connection_pool(name, connection_pool, database_name, &block)
-    end
-
-    def without_connection(&block)
-      change_connection_reference(nil) do
-        yield
-      end
-    end
-
-    def find_connection_pool(name)
-      @connection_pools[name] || raise(Octoshark::Error::NoConnection, "No such database connection '#{name}'")
-    end
-
-    def disconnect!
-      @connection_pools.values.each do |connection_pool|
-        connection_pool.disconnect!
-      end
-    end
-
-    def identifier
-      @identifier ||= "octoshark_#{object_id}"
-    end
-
-    private
-    def spec_class
-      if defined?(ActiveRecord::ConnectionAdapters::ConnectionSpecification)
-        spec_class = ActiveRecord::ConnectionAdapters::ConnectionSpecification
-      else
-        spec_class = ActiveRecord::Base::ConnectionSpecification
-      end
-    end
-
-    def change_connection_reference(connection, &block)
-      previous_connection = Thread.current[identifier]
-      Thread.current[identifier] = connection
+      connection = ActiveRecord::Base.send(connection_method, config)
+      connection.connection_name = connection_name
+      connection.database_name = config[:database] if config[:database]
 
       begin
-        yield
-      ensure
-        Thread.current[identifier] = previous_connection
-      end
-    end
-
-    def setup_connection_pools
-      @connection_pools = HashWithIndifferentAccess.new
-
-      @configs.each_pair do |name, config|
-        @connection_pools[name] = create_connection_pool(config)
-      end
-    end
-
-    def create_connection_pool(config)
-      spec = spec_class.new(config, "#{config[:adapter]}_connection")
-      ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
-    end
-
-    def with_connection_pool(name, connection_pool, database_name = nil, &block)
-      connection_pool.with_connection do |connection|
-        connection.connection_name = name
-        if database_name
-          connection.database_name = database_name
-          connection.execute("use #{database_name}")
-        end
-
         change_connection_reference(connection) do
           yield(connection)
         end
+      ensure
+        connection.disconnect!
       end
     end
   end

data/lib/octoshark/connection_pools_manager.rb

@@ -0,0 +1,97 @@
+module Octoshark
+  class ConnectionPoolsManager
+    include CurrentConnection
+
+    # Octoshark needs to keep track of all persistent connection managers
+    # in order to automatically reconnect on connection establish.
+    @@connection_managers = []
+
+    def self.connection_managers
+      @@connection_managers
+    end
+
+    def self.reset_connection_managers!
+      connection_managers.each(&:reset!)
+    end
+
+    def self.disconnect!
+      connection_managers.map(&:disconnect!)
+      @@connection_managers = []
+    end
+
+    attr_reader :connection_pools
+
+    def initialize(configs = {})
+      @configs = configs.with_indifferent_access
+      setup_connection_pools
+
+      self.class.connection_managers << self
+    end
+
+    def reset!
+      disconnect!
+      setup_connection_pools
+    end
+
+    def with_connection(name, database_name = nil, &block)
+      connection_pool = find_connection_pool(name)
+
+      connection_pool.with_connection do |connection|
+        connection.connection_name = name
+
+        if database_name
+          connection.database_name = database_name
+          connection.execute("use #{database_name}")
+        end
+
+        change_connection_reference(connection) do
+          yield(connection)
+        end
+      end
+    end
+
+    def find_connection_pool(name)
+      @connection_pools[name] || raise(Octoshark::Error::NoConnection, "No such database connection '#{name}'")
+    end
+
+    def disconnect!
+      @connection_pools.values.each do |connection_pool|
+        connection_pool.disconnect!
+      end
+    end
+
+    private
+
+    def setup_connection_pools
+      @connection_pools = HashWithIndifferentAccess.new
+
+      @configs.each_pair do |name, config|
+        @connection_pools[name] = create_connection_pool(name, config)
+      end
+    end
+
+    def create_connection_pool(name, config)
+      spec =
+        if defined?(ActiveRecord::ConnectionAdapters::PoolConfig)
+          env_name = defined?(Rails) ? Rails.env : nil
+          db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new(env_name, name, config)
+          ActiveRecord::ConnectionAdapters::PoolConfig.new(owner_name = ActiveRecord::Base, db_config)
+        else
+          adapter_method = "#{config[:adapter]}_connection"
+          if defined?(ActiveRecord::ConnectionAdapters::ConnectionSpecification)
+            spec_class = ActiveRecord::ConnectionAdapters::ConnectionSpecification
+
+            if spec_class.instance_method(:initialize).arity == 3
+              spec_class.new(name, config, adapter_method)
+            else
+              spec_class.new(config, adapter_method)
+            end
+          else
+            ActiveRecord::Base::ConnectionSpecification.new(config, adapter_method)
+          end
+        end
+
+      ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
+    end
+  end
+end