distribute_reads 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b58c208898bdc32763b35155e78946bd6a2cec3f
-  data.tar.gz: 758dbc1bd72a7d2541435f4e1bcca5d795ad230d
+  metadata.gz: 96dec398d9905bde755d83b504ec450047b11128
+  data.tar.gz: 63dc0b236f1829b9fb2df0400299a35713717766
 SHA512:
-  metadata.gz: 3c46fd083ba3256c568e89f27c77d22a042fcbae6f56ae7a0b58f0f7f81217cff7f2ca1f189b4052a302238a7e96672bce6ff04ac3964db515be6f46c9fc9b7f
-  data.tar.gz: 0ba5b6f61fca1d3f9825147cdcead1eb8f267df86a05c61022b7f1e4f41b6c75d6c66510ce35cd91ccccfd12a3793688788f46818d69fc7b292b70f1af607cbf
+  metadata.gz: c96152f662c6fca7f75a51d2db9ab75e236ccc15f0aa3543ff73084fb509a34642422b53727f856fc11992a1ab643ca5fbda4251e1d794a634633000111cb871
+  data.tar.gz: 3f5ac5f959d935953795fab5877e01f666fde7c6b77d0cce6b0e9e237afacf3cf57c5a56456cde598e0322a06c3c296fbb80c1d1810ab5c17115a5da070513e7

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm: 2.4.1
+script: bundle exec rake test
+before_script:
+  - psql -c 'create database distribute_reads_test_primary;' -U postgres
+  - psql -c 'create database distribute_reads_test_replica;' -U postgres
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1
+
+- Added method for jobs
+
 ## 0.1.0
 
 - First release

data/README.md

@@ -4,6 +4,8 @@ Scale database reads to replicas in Rails
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://travis-ci.org/ankane/distribute_reads.svg?branch=master)](https://travis-ci.org/ankane/distribute_reads)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -18,13 +20,13 @@ gem 'distribute_reads'
 
 ```yml
 default: &default
-  adapter: postgresql_makara
+  url: postgresql-makara:///
   makara:
     sticky: true
     connections:
       - role: master
         name: primary
-        url: <%= ENV["PRIMARY_DATABASE_URL"] %>
+        url: <%= ENV["DATABASE_URL"] %>
       - name: replica
         url: <%= ENV["REPLICA_DATABASE_URL"] %>
 
@@ -54,6 +56,20 @@ distribute_reads do
 end
 ```
 
+## Jobs
+
+Distribute all reads in a job with:
+
+```ruby
+class TestJob < ApplicationJob
+  distribute_reads
+
+  def perform
+    # ...
+  end
+end
+```
+
 ## Options
 
 Raise an error when replica lag is too high - *PostgreSQL only*

data/distribute_reads.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "activejob"
 end

data/lib/distribute_reads.rb

@@ -23,3 +23,8 @@ end
 
 Makara::Proxy.send :prepend, DistributeReads::AppropriatePool
 Object.send :include, DistributeReads::GlobalMethods
+
+ActiveSupport.on_load(:active_job) do
+  require "distribute_reads/job_methods"
+  extend DistributeReads::JobMethods
+end

data/lib/distribute_reads/appropriate_pool.rb

@@ -2,7 +2,10 @@ module DistributeReads
   module AppropriatePool
     def _appropriate_pool(*args)
       if Thread.current[:distribute_reads]
-        if needs_master?(*args) || @slave_pool.completely_blacklisted? || in_transaction?
+        if needs_master?(*args) || @slave_pool.completely_blacklisted?
+          stick_to_master(*args) unless DistributeReads.default_to_primary
+          @master_pool
+        elsif in_transaction?
           @master_pool
         else
           @slave_pool

data/lib/distribute_reads/global_methods.rb

@@ -1,11 +1,12 @@
 module DistributeReads
   module GlobalMethods
     def distribute_reads(max_lag: nil)
+      if max_lag && DistributeReads.lag > max_lag
+        raise DistributeReads::TooMuchLag, "Replica lag over #{max_lag} seconds"
+      end
+
       previous_value = Thread.current[:distribute_reads]
       begin
-        if max_lag && DistributeReads.lag > max_lag
-          raise DistributeReads::TooMuchLag, "Replica lag over #{max_lag} seconds"
-        end
         Thread.current[:distribute_reads] = true
         yield
       ensure

data/lib/distribute_reads/job_methods.rb

@@ -0,0 +1,9 @@
+module DistributeReads
+  module JobMethods
+    def distribute_reads
+      around_perform do |job, block|
+        distribute_reads { block.call }
+      end
+    end
+  end
+end

data/lib/distribute_reads/version.rb

@@ -1,3 +1,3 @@
 module DistributeReads
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distribute_reads
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makara
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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'
 description: 
 email:
 - andrew@chartkick.com
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -96,6 +111,7 @@ files:
 - lib/distribute_reads.rb
 - lib/distribute_reads/appropriate_pool.rb
 - lib/distribute_reads/global_methods.rb
+- lib/distribute_reads/job_methods.rb
 - lib/distribute_reads/version.rb
 homepage: https://github.com/ankane/distribute_reads
 licenses: []
@@ -116,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Scale database reads with replicas in Rails