distribute_reads 0.3.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a478f3bce157af7ae245b8fd090c48dac8054feca0a5100142bf653aa8e594d3
-  data.tar.gz: 48980648523710bb24cb043883cc4e76851b0f0637e02ca07fbc831777d6a339
+  metadata.gz: 498115398e131f837029f3ad86c21ea646204b399f732a800b32687135bee154
+  data.tar.gz: 40c983fa023cab9fe00b5f0e7b03925d2f1d7c6e3d30056a26e9c147fd92d4b4
 SHA512:
-  metadata.gz: 0a8ce6d4ed8f87fabb9ccb1fe9008b425990aec97fd1ad07a316c7fd80ce5ad09b72ec0acd52c3f7521fbb5e7a30b0b8e40a03c51a4a49653a3f226ef4a96228
-  data.tar.gz: 2c2e1482d173f7c844aa04b33db649161ea4aa62121ad1211949dec4d0cafd63ad8a668ea5bf30328384cbb7b9b010a5abb8dbdb30f20d6f8c802a44eb4e1516
+  metadata.gz: 3a3a60620721ef9b23d1faf8a742386dfd58d3830ee7b110dbc44d100d7fd7670189e8893f1d21eab4d7bced008942f8fe8116756ae1aae6cec0f9427b3018d4
+  data.tar.gz: 56b65735bffb296bcfc8719c847988c0ecc4610c21ecad650115181431ac85b0b7cd686c7a409cede3cfc25c9a54de74e6f053556ea9ca6c28feb242e6ad1709

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.5.0 (2024-06-24)
+
+- Dropped support for Makara 0.4
+- Dropped support for Ruby < 3.1 and Active Record < 6.1
+
+## 0.4.0 (2022-12-28)
+
+- Made `distribute_reads` method private to behave like `Kernel` methods
+- Dropped support for Makara 0.3
+- Dropped support for Ruby < 2.6 and Active Record < 5.2
+
 ## 0.3.5 (2022-01-30)
 
 - Added support for Aurora Postgres 13 replication lag

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2022 Andrew Kane
+Copyright (c) 2017-2024 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,7 +4,7 @@ Scale database reads to replicas in Rails
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://github.com/ankane/distribute_reads/workflows/build/badge.svg?branch=master)](https://github.com/ankane/distribute_reads/actions)
+[![Build Status](https://github.com/ankane/distribute_reads/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/distribute_reads/actions)
 
 ## Installation
 
@@ -16,7 +16,7 @@ gem "distribute_reads"
 
 ## How to Use
 
-[Makara](https://github.com/taskrabbit/makara) does most of the work. First, update `database.yml` to use it:
+[Makara](https://github.com/instacart/makara) does most of the work. First, update `database.yml` to use it:
 
 ```yml
 default: &default
@@ -74,7 +74,7 @@ You can pass any options as well.
 
 ## Lazy Evaluation
 
-ActiveRecord uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-on-rails/lessons/active-record-queries), which can delay the execution of a query to outside of a `distribute_reads` block. In this case, the primary will be used.
+Active Record uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-on-rails/lessons/active-record-queries), which can delay the execution of a query to outside of a `distribute_reads` block. In this case, the primary will be used.
 
 ```ruby
 users = distribute_reads { User.where(orders_count: 1) } # not executed yet
@@ -185,9 +185,9 @@ distribute_reads(replica: true) do
 end
 ```
 
-## Rails 6
+## Rails
 
-Rails 6 has [native support for replicas](https://guides.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
@@ -195,11 +195,11 @@ ActiveRecord::Base.connected_to(role: :reading) do
 end
 ```
 
-However, it’s not able to automatically route queries like Makara just yet.
+However, it’s not able to do automatic statement-based routing like Makara yet.
 
 ## Thanks
 
-Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara, [Sherin Kurian](https://github.com/sherinkurian) for the max lag option, and [Nick Elser](https://github.com/nickelser) for the write-through cache.
+Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara, [Sherin Kurian](https://github.com/sherin) for the max lag option, and [Nick Elser](https://github.com/nickelser) for the write-through cache.
 
 ## History
 

data/lib/distribute_reads/job_methods.rb

@@ -7,11 +7,7 @@ module DistributeReads
     included do
       before_perform do
         if DistributeReads.by_default
-          if DistributeReads.makara3?
-            Makara::Context.set_current(Makara::Context.generate)
-          else
-            Makara::Context.release_all
-          end
+          Makara::Context.release_all
         end
       end
     end

data/lib/distribute_reads/version.rb

@@ -1,3 +1,3 @@
 module DistributeReads
-  VERSION = "0.3.5"
+  VERSION = "0.5.0"
 end

data/lib/distribute_reads.rb

@@ -3,10 +3,9 @@ require "active_support"
 require "makara"
 
 # modules
-require "distribute_reads/appropriate_pool"
-require "distribute_reads/cache_store"
-require "distribute_reads/global_methods"
-require "distribute_reads/version"
+require_relative "distribute_reads/appropriate_pool"
+require_relative "distribute_reads/global_methods"
+require_relative "distribute_reads/version"
 
 module DistributeReads
   class Error < StandardError; end
@@ -126,7 +125,6 @@ module DistributeReads
     end
   end
 
-  # private
   def self.backtrace_cleaner
     @backtrace_cleaner ||= begin
       bc = ActiveSupport::BacktraceCleaner.new
@@ -136,8 +134,8 @@ module DistributeReads
       bc
     end
   end
+  private_class_method :backtrace_cleaner
 
-  # private
   def self.with_replica
     previous_value = Thread.current[:distribute_reads]
     begin
@@ -147,14 +145,7 @@ module DistributeReads
       Thread.current[:distribute_reads] = previous_value
     end
   end
-
-  # private
-  def self.makara3?
-    unless defined?(@makara3)
-      @makara3 = Gem::Version.new(Makara::VERSION.to_s) < Gem::Version.new("0.4.0")
-    end
-    @makara3
-  end
+  private_class_method :with_replica
 
   # legacy
   def self.default_to_primary
@@ -169,10 +160,9 @@ end
 
 Makara::Proxy.prepend DistributeReads::AppropriatePool
 Object.include DistributeReads::GlobalMethods
-# TODO uncomment in 0.4.0
-# Object.send :private, :distribute_reads
+Object.send :private, :distribute_reads
 
 ActiveSupport.on_load(:active_job) do
-  require "distribute_reads/job_methods"
+  require_relative "distribute_reads/job_methods"
   include DistributeReads::JobMethods
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: distribute_reads
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: makara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 description:
 email: andrew@ankane.org
 executables: []
@@ -35,7 +49,6 @@ files:
 - README.md
 - lib/distribute_reads.rb
 - lib/distribute_reads/appropriate_pool.rb
-- lib/distribute_reads/cache_store.rb
 - lib/distribute_reads/global_methods.rb
 - lib/distribute_reads/job_methods.rb
 - lib/distribute_reads/version.rb
@@ -51,14 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Scale database reads with replicas in Rails

data/lib/distribute_reads/cache_store.rb

@@ -1,29 +0,0 @@
-module DistributeReads
-  class CacheStore
-    def read(key)
-      memory_cached = memory_store.read(key)
-      return nil if memory_cached == :nil
-      return memory_cached if memory_cached
-
-      store_cached = store.try(:read, key)
-      memory_store.write(key, store_cached || :nil)
-      store_cached
-    end
-
-    def write(*args)
-      memory_store.write(*args)
-      store.try(:write, *args)
-    end
-
-    private
-
-    # use ActiveSupport::Cache::MemoryStore instead?
-    def memory_store
-      @memory_store ||= Makara::Cache::MemoryStore.new
-    end
-
-    def store
-      @store ||= Rails.cache
-    end
-  end
-end