activerecord_autoreplica 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4842ab6d5f5cbf12c929f25b2933aca4eb6c034e
-  data.tar.gz: 94caf1b3480ea4ca6170571dc2d264e1d85f1e2d
+  metadata.gz: 8ed3fdce7e191b78e8bc24c13cc926cb9b625052
+  data.tar.gz: 02bdd2ae70931f1a7376a9264bf6a5ac6442275e
 SHA512:
-  metadata.gz: e199dcaaa96886e1aeb7d10f022b840280abea1fd00f0ce4d114c6db332e12a81c19e71e43cf1af5cd7327c81df44d626f7fe4e99925653a0e51f98f98e89375
-  data.tar.gz: 475170a5a2e715a729d9da07c5a022866234df582e1caaa0930c318ea9b2c7b31e3ceb722d352b9eaec4735acdfe7eeb561175ad7c7e6b5579f18ce88cdca61b
+  metadata.gz: fa680e51be925cbe09927aa323e44be88fd26cf82b799474761bbae59a135a2123e1f459e9e350f9949eb58462338e7dc433558aaa9156463d8881fe141f82cf
+  data.tar.gz: 7db0c18d68ed48fdbf428d56bff0f49a1ec5137ef8f5c10e695eef9d41ec3e860a52ffff11256eb2525f98c7b004ecf1b4e465d8fa711e1d1dde932252250f5f

data/.travis.yml

@@ -0,0 +1,17 @@
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.1.x
+  - gemfiles/Gemfile.rails-5.0.x
+rvm:
+  - 2.0.0
+  - 2.1.1
+  - 2.2.5
+  - 2.3.0
+matrix:
+  exclude:
+  - rvm: 2.0.0
+    gemfile: gemfiles/Gemfile.rails-5.0.x
+  - rvm: 2.1.1
+    gemfile: gemfiles/Gemfile.rails-5.0.x
+cache: bundler
+sudo: false

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -11,6 +11,8 @@ gem 'activerecord', "> 3.0"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'rake', '~> 10.0'
+  gem 'yard'
   gem 'sqlite3'
   gem "rspec", "~> 2.4"
   gem "rdoc", "~> 3.12"

data/README.md

@@ -1,5 +1,7 @@
 # activerecord_autoreplica
 
+[![Build Status](https://travis-ci.org/WeTransfer/activerecord_autoreplica.svg)](https://travis-ci.org/WeTransfer/activerecord_autoreplica)
+
 An automatic ActiveRecord connection multiplexer, and is a reimplementation of / greatly inspired by
 the [makara gem](https://github.com/taskrabbit/makara)
 
@@ -64,10 +66,12 @@ files are going to be erased on test completion.
 
 There are Gemfiles for testing against various versions of ActiveRecord. To run those, use:
 
+    $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.0.x bundle exec rake
     $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle exec rake
     $ BUNDLE_GEMFILE=gemfiles/Gemfile.rails-3.2.x bundle exec rake
 
-The library contains a couple of switches that allow it to function in both Rails versions.
+The library contains a couple of switches that allow it to function in all these Rails versions.
+Rails 3.x support is likely to be dropped in the next major version.
 
 ### Versioning
 
@@ -85,6 +89,6 @@ The gem version is specified in the Rakefile.
 
 ### Copyright
 
-Copyright (c) 2014 Julik Tarkhanov for WeTransfer. See LICENSE.txt for
+Copyright (c) 2014 WeTransfer. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -13,7 +13,7 @@ require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  gem.version = '1.1.0'
+  gem.version = '1.2.0'
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "activerecord_autoreplica"
   gem.homepage = "http://github.com/WeTransfer/activerecord_autoreplica"

data/activerecord_autoreplica.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: activerecord_autoreplica 1.1.0 ruby lib
+# stub: activerecord_autoreplica 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "activerecord_autoreplica"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2015-10-19"
+  s.date = "2016-10-23"
   s.description = " Redirect all SELECT queries to a separate connection within a block "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
-    ".gitlab-ci.yml",
+    ".travis.yml",
+    ".yardopts",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
@@ -28,13 +29,14 @@ Gem::Specification.new do |s|
     "activerecord_autoreplica.gemspec",
     "gemfiles/Gemfile.rails-3.2.x",
     "gemfiles/Gemfile.rails-4.1.x",
+    "gemfiles/Gemfile.rails-5.0.x",
     "lib/activerecord_autoreplica.rb",
     "spec/activerecord_autoreplica_spec.rb",
     "spec/helper.rb"
   ]
   s.homepage = "http://github.com/WeTransfer/activerecord_autoreplica"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.5.1"
   s.summary = "Palatable-size read replica adapter for ActiveRecord"
 
   if s.respond_to? :specification_version then
@@ -42,6 +44,8 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activerecord>, ["> 3.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.4"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
@@ -49,6 +53,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
       s.add_dependency(%q<activerecord>, ["> 3.0"])
+      s.add_dependency(%q<rake>, ["~> 10.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.4"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -57,6 +63,8 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<activerecord>, ["> 3.0"])
+    s.add_dependency(%q<rake>, ["~> 10.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.4"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/gemfiles/Gemfile.rails-3.2.x

@@ -4,6 +4,7 @@ gem 'activerecord', "~> 3"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'rake', '~> 10.0'
   gem 'sqlite3'
   gem "rspec", "~> 2.4"
   gem "rdoc", "~> 3.12"

data/gemfiles/Gemfile.rails-4.1.x

@@ -4,6 +4,7 @@ gem 'activerecord', "~> 4"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'rake', '~> 10.0'
   gem 'sqlite3'
   gem "rspec", "~> 2.4"
   gem "rdoc", "~> 3.12"

data/gemfiles/Gemfile.rails-5.0.x

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+gem 'activerecord', "~> 5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rake', '~> 10.0'
+  gem 'sqlite3'
+  gem "rspec", "~> 2.4"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "1.8.4" # The last without Nokogiri
+end

data/lib/activerecord_autoreplica.rb

@@ -32,8 +32,22 @@
 # Once the block exits, the original connection handler is reassigned to the AR connection_pool.
 module AutoReplica
   # The first one is used in ActiveRecord 3+, the second one in 4+
-  ConnectionSpecification = ActiveRecord::Base::ConnectionSpecification rescue ActiveRecord::ConnectionAdapters::ConnectionSpecification
-        
+  ConnectionSpecification = begin
+    ActiveRecord::Base::ConnectionSpecification
+  rescue
+    ActiveRecord::ConnectionAdapters::ConnectionSpecification
+  end
+
+  # Runs a given block with all SELECT statements being executed against the read slave
+  # database.
+  #
+  #     AutoReplica.using_read_replica_at(:adapter => 'mysql2', :datbase => 'read_replica', ...) do
+  #       customer = Customer.find(3) # Will SELECT from the replica database at the connection spec passed to the block
+  #       customer.register_complaint! # Will UPDATE to the master database connection
+  #     end
+  #
+  # @param replica_connection_spec_hash_or_url[String, Hash] an ActiveRecord connection specification or a DSN URL
+  # @return [void]
   def self.using_read_replica_at(replica_connection_spec_hash_or_url)
     return yield if @in_replica_context # This method should not be reentrant
     
@@ -60,8 +74,12 @@ module AutoReplica
     end
   end
   
-  # Resolve an ActiveRecord connection URL
+  # Resolve an ActiveRecord connection URL, from a string to a Hash.
+  #
+  # @param url_string[String] the connection URL (like `sqlite3://...`)
+  # @return [Hash] a symbol-keyed ActiveRecord connection specification
   def self.resolve_connection_url(url_string)
+    # TODO: privatize this method.
     if defined?(ActiveRecord::Base::ConnectionSpecification::Resolver) # AR3
       resolver = ActiveRecord::Base::ConnectionSpecification::Resolver.new(url_string, {})
       resolver.send(:connection_url_to_hash, url_string) # Because making this public was so hard
@@ -80,7 +98,11 @@ module AutoReplica
       # We need to maintain our own pool for read replica connections,
       # aside from the one managed by Rails proper.
       adapter_method = "%s_connection" % connection_specification_hash[:adapter]
-      connection_specification = ConnectionSpecification.new(connection_specification_hash, adapter_method)
+      connection_specification = begin
+        ConnectionSpecification.new('autoreplica', connection_specification_hash, adapter_method)
+      rescue ArgumentError # AR 4 and lower wants 2 arguments
+        ConnectionSpecification.new(connection_specification_hash, adapter_method)
+      end
       @read_pool = ActiveRecord::ConnectionAdapters::ConnectionPool.new(connection_specification)
     end
     
@@ -147,4 +169,11 @@ module AutoReplica
       @master_connection.public_send(method_name, *args, &blk)
     end
   end
+  
+#  if respond_to?(:private_constant)
+#    private_constant :ConnectionSpecification 
+#    private_constant :ConnectionHandler
+#    private_constant :Adapter
+#  end
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_autoreplica
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,34 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +131,8 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
-- ".gitlab-ci.yml"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,6 +140,7 @@ files:
 - activerecord_autoreplica.gemspec
 - gemfiles/Gemfile.rails-3.2.x
 - gemfiles/Gemfile.rails-4.1.x
+- gemfiles/Gemfile.rails-5.0.x
 - lib/activerecord_autoreplica.rb
 - spec/activerecord_autoreplica_spec.rb
 - spec/helper.rb
@@ -134,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Palatable-size read replica adapter for ActiveRecord

data/.gitlab-ci.yml

@@ -1,28 +0,0 @@
-# This file is generated by GitLab CI
-rake-ar4:
-  script:
-  - "apt-get update && apt-get install -y libsqlite3-dev"
-  - git submodule update --init
-  - ls -la
-  - gem install bundler
-  - apt-get install libsqlite3-dev -y
-  - bundle config --global jobs 4
-  - bundle config --global path /cache/gems
-  - bundle config build.nokogiri "--use-system-libraries --with-xml2-include=/usr/include/libxml2"
-  - BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle install
-  - BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.1.x bundle exec rake
-  tags:
-  - ruby
-rake-ar3:
-  script:
-  - "apt-get update && apt-get install -y libsqlite3-dev"
-  - git submodule update --init
-  - ls -la
-  - gem install bundler
-  - bundle config --global jobs 4
-  - bundle config --global path /cache/gems
-  - bundle config build.nokogiri "--use-system-libraries --with-xml2-include=/usr/include/libxml2"
-  - BUNDLE_GEMFILE=gemfiles/Gemfile.rails-3.2.x bundle install
-  - BUNDLE_GEMFILE=gemfiles/Gemfile.rails-3.2.x bundle exec rake
-  tags:
-  - ruby