distribute_reads 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 044c145f24198d69d3f221698f3452ee301e947cefe7f675eb8e7b704effc353
-  data.tar.gz: 1f7c381f92ae63fcd8dc0ced50fa317591d319fbb1473af87dab01ac2e77a855
+  metadata.gz: 9ad9e2810c10045d79634ef7988435c059e99f8585667edf59d831797b258925
+  data.tar.gz: 7e3f7bbb5c96192910dc6a114147ddcf0c1258bcaed74491efdfb6ad20aaf20b
 SHA512:
-  metadata.gz: 88019e465c3f305b16eca8bdf05a6b75fb9eec4b5d8b598167cadd904b86e403af9a460d36865286ece8224218f4e93a7249cb81a26a90a8d63c7a6f65fb5f03
-  data.tar.gz: 1c336a5dbd584864aae1a422300e1468b456521a170754b6f2c138c6f4a10997401db9ae729eb799c3ffad64255b227e3d02cf54ea60f7e39e1ee759128f29bb
+  metadata.gz: 626a85f8a972d3e786ed1f705b2fef2e0da53c20d1a1d02d620d60de61014b493055f373f422050504c2760d86a4e71b0097f7a946c436dcc3ccb7fa80c5c00a
+  data.tar.gz: 76c312011e3c5bd4383ccf768b37a9d81800d022c7dfaeca29ad4384bf68f97c2789708609ea64b94a1a81d3e5c5b62836907d9d786150a3b1251069e9d7c14c

data/CHANGELOG.md

@@ -1,33 +1,38 @@
-## 0.3.1
+## 0.3.2 (2020-01-02)
+
+- Added `eager_load` option
+- Removed warning when relation is loaded
+
+## 0.3.1 (2019-10-28)
 
 - Added source location to logging
 
-## 0.3.0
+## 0.3.0 (2019-06-14)
 
 - Use logger instead of stderr
 - Handle `NULL` replication lag for MySQL
 - Fixed replication lag check running on primary when replicas blacklisted
 
-## 0.2.4
+## 0.2.4 (2018-11-14)
 
 - Added support for Aurora MySQL replication lag
 - Added more logging
 
-## 0.2.3
+## 0.2.3 (2018-05-24)
 
 - Added support for Makara 0.4
 
-## 0.2.2
+## 0.2.2 (2018-03-29)
 
 - Added support for MySQL replication lag
 - Added `replica` option
 
-## 0.2.1
+## 0.2.1 (2017-12-14)
 
 - Fixed lag check for Postgres 10
 - Added `replication_lag` method
 
-## 0.2.0
+## 0.2.0 (2017-10-02)
 
 Breaking
 
@@ -44,16 +49,16 @@ Other
 - Added default options
 - Improved lag query
 
-## 0.1.2
+## 0.1.2 (2017-09-20)
 
 - Raise `ArgumentError` when missing block
 - Improved lag query
 - Warn if returning `ActiveRecord::Relation`
 
-## 0.1.1
+## 0.1.1 (2017-05-14)
 
 - Added method for jobs
 
-## 0.1.0
+## 0.1.0 (2017-03-26)
 
 - First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2019 Andrew Kane
+Copyright (c) 2017-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -80,12 +80,18 @@ ActiveRecord uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-
 users = distribute_reads { User.where(orders_count: 1) } # not executed yet
 ```
 
-Call `to_a` inside the block ensure the query runs on a replica.
+Call `to_a` or `load` inside the block to ensure the query runs on a replica.
 
 ```ruby
 users = distribute_reads { User.where(orders_count: 1).to_a }
 ```
 
+You can automatically load relations returned from `distribute_reads` blocks by creating an initializer with:
+
+```ruby
+DistributeReads.eager_load = true
+```
+
 ## Options
 
 ### Replica Lag
@@ -181,7 +187,7 @@ end
 
 ## Rails 6
 
-Rails 6 has [native support for replicas](https://edgeguides.rubyonrails.org/active_record_multiple_databases.html) :tada:
+Rails 6 has [native support for replicas](https://guides.rubyonrails.org/active_record_multiple_databases.html) :tada:
 
 ```ruby
 ActiveRecord::Base.connected_to(role: :reading) do
@@ -208,13 +214,13 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-To test, run:
+To get started with development and testing:
 
 ```sh
 git clone https://github.com/ankane/distribute_reads.git
 cd distribute_reads
 createdb distribute_reads_test_primary
 createdb distribute_reads_test_replica
-bundle
-bundle exec rake
+bundle install
+bundle exec rake test
 ```

data/lib/distribute_reads.rb

@@ -14,8 +14,7 @@ module DistributeReads
   class NoReplicasAvailable < Error; end
 
   class << self
-    attr_accessor :by_default
-    attr_accessor :default_options
+    attr_accessor :by_default, :default_options, :eager_load
     attr_writer :logger
   end
   self.by_default = false
@@ -23,6 +22,7 @@ module DistributeReads
     failover: true,
     lag_failover: false
   }
+  self.eager_load = false
 
   def self.logger
     unless defined?(@logger)
@@ -98,11 +98,11 @@ module DistributeReads
 
   def self.log(message)
     if logger
-      logger.info("[distribute_reads] #{message}")
+      logger.info { "[distribute_reads] #{message}" }
 
       # show location like Active Record
       source = backtrace_cleaner.clean(caller.lazy).first
-      logger.info("  ↳ #{source}") if source
+      logger.info { "  ↳ #{source}" } if source
     end
   end
 

data/lib/distribute_reads/global_methods.rb

@@ -54,7 +54,13 @@ module DistributeReads
         end
 
         value = yield
-        DistributeReads.log "Call `to_a` inside block to execute query on replica" if value.is_a?(ActiveRecord::Relation) && !previous_value
+        if value.is_a?(ActiveRecord::Relation) && !previous_value && !value.loaded?
+          if DistributeReads.eager_load
+            value = value.load
+          else
+            DistributeReads.log "Call `to_a` inside block to execute query on replica"
+          end
+        end
         value
       ensure
         Thread.current[:distribute_reads] = previous_value

data/lib/distribute_reads/version.rb

@@ -1,3 +1,3 @@
 module DistributeReads
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distribute_reads
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makara
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Scale database reads with replicas in Rails