counter_culture 3.8.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f043a04b7cca0b364e7692c19425b049b45b4e965ed5caac0dbac2f91622c1
-  data.tar.gz: 50dfedf030e3c3823829aedc5e3b2a08fe65b63b50fc439d229afb5ab3fa5d5d
+  metadata.gz: f93d3d3e415f5d92e3870caf67067cdb75a6a76f68542b82c9ec2411987a0e4d
+  data.tar.gz: 89cf5171b549aab368a1dd87117afd429bf557d93f198e220fbe3b2a24e81f20
 SHA512:
-  metadata.gz: 604bd858a6660d3e83b74b339a2675366b5d7908c87c37241ed9eb9a2b245ddb4d02b19d6782d3c30df793cd895be45e22455e34f9aca88e5fee462f472c2a48
-  data.tar.gz: a5828bb5f0bd66b6717401b47f8494687a371546c6f3df89c93dd9a524a055e074aeffc3fa6c02e0b2e2cd25c3e706e76c2ef654e22a0b3f48cfb3d0c0c401b7
+  metadata.gz: 17b50c40207f615d0018c142062e536c3da69bebab209d4facb63ee03273363d97f83675d173f3096f98c68393f374e39aae0dba0db6364de9bc3c83d38af160
+  data.tar.gz: d7bef1c4214a30fa9888843c35fe2f074ea89e78b9341b5ed458471934576dea9ef8bf12fac72bd549a532fc50d34b9e327c4f2b943e7965720f3b12bef503b6

data/.circleci/config.yml

@@ -49,7 +49,7 @@ workflows:
           matrix:
             parameters:
               ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
-              rails-version: ["5.2", "6.0", "6.1", "7.0", "7.1", "7.2"]
+              rails-version: ["5.2", "6.0", "6.1", "7.0", "7.1", "7.2", "8.0"]
               database: ["postgresql", "sqlite3", "mysql2"]
             exclude:
               - ruby-version: "3.0"
@@ -133,3 +133,39 @@ workflows:
               - ruby-version: "3.0"
                 rails-version: "7.2"
                 database: "mysql2"
+              - ruby-version: "2.6"
+                rails-version: "8.0"
+                database: "postgresql"
+              - ruby-version: "2.6"
+                rails-version: "8.0"
+                database: "sqlite3"
+              - ruby-version: "2.6"
+                rails-version: "8.0"
+                database: "mysql2"
+              - ruby-version: "2.7"
+                rails-version: "8.0"
+                database: "postgresql"
+              - ruby-version: "2.7"
+                rails-version: "8.0"
+                database: "sqlite3"
+              - ruby-version: "2.7"
+                rails-version: "8.0"
+                database: "mysql2"
+              - ruby-version: "3.0"
+                rails-version: "8.0"
+                database: "postgresql"
+              - ruby-version: "3.0"
+                rails-version: "8.0"
+                database: "sqlite3"
+              - ruby-version: "3.0"
+                rails-version: "8.0"
+                database: "mysql2"
+              - ruby-version: "3.1"
+                rails-version: "8.0"
+                database: "postgresql"
+              - ruby-version: "3.1"
+                rails-version: "8.0"
+                database: "sqlite3"
+              - ruby-version: "3.1"
+                rails-version: "8.0"
+                database: "mysql2"

data/Appraisals

@@ -5,6 +5,7 @@
   7.0
   7.1
   7.2
+  8.0
 ].each do |rails_version|
   appraise "rails-#{rails_version}" do
     gem 'activerecord', "~> #{rails_version}.0"

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.9.0 (March 20, 2025)
+
+New features:
+  - Add global configuration for using a read replica (#405)
+
 ## 3.8.2 (October 21, 2024)
 
 Bugfixes:

data/README.md

@@ -7,7 +7,7 @@ Turbo-charged counter caches for your Rails app. Huge improvements over the Rail
 * Supports dynamic column names, making it possible to split up the counter cache for different types of objects
 * Can keep a running count, or a running total
 
-Tested against Ruby 2.6, 2.7, 3.0, 3.1, 3.2 and 3.3 and against the latest patch releases of Rails 5.2, 6.0, 6.1, 7.0 and 7.1.
+Tested against Ruby 2.6, 2.7, 3.0, 3.1, 3.2 and 3.3 and against the latest patch releases of Rails 5.2, 6.0, 6.1, 7.0, 7.1, 7.2 and 8.0.
 
 Please note that -- unlike Rails' built-in counter-caches -- counter_culture does not currently change the behavior of the `.size` method on ActiveRecord associations. If you want to avoid a database query and read the cached value, please use the attribute name containing the counter cache directly.
 
@@ -618,6 +618,39 @@ Image.counter_culture_fix_counts(polymorphic_classes: Product)
 Image.counter_culture_fix_counts(polymorphic_classes: [Product, Employee])
 ```
 
+## Using Read Replicas
+
+When using `counter_culture_fix_counts`, you can configure counter_culture to use read replicas for counting operations, which can help reduce load on your primary database. Write operations will still use the primary database.
+
+### Global Configuration
+
+You can enable read replica support globally:
+
+```ruby
+# config/initializers/counter_culture.rb
+CounterCulture.configure do |config|
+  config.use_read_replica = true
+end
+```
+
+### Per-Call Configuration
+
+You can also specify read replica usage per call (this takes precedence over global configuration):
+
+```ruby
+Model.counter_culture_fix_counts(
+  db_connection_builder: proc { |reading, block|
+    if reading
+      ApplicationRecord.connected_to(role: :reading, &block)
+    else
+      ApplicationRecord.connected_to(role: :writing, &block)
+    end
+  }
+)
+```
+
+Note: This feature requires Rails 7.1 or higher for full read replica support. On older versions, it will fall back to using the primary database.
+
 ## Contributing to counter_culture
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 8.0.0"
+
+gemspec path: "../"

data/lib/counter_culture/configuration.rb

@@ -0,0 +1,34 @@
+module CounterCulture
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_reader :use_read_replica
+
+    def initialize
+      @use_read_replica = false
+    end
+
+    def use_read_replica=(value)
+      if value && !rails_supports_read_replica?
+        raise "Counter Culture's read replica support requires Rails 7.1 or higher"
+      end
+      @use_read_replica = value
+    end
+
+    private
+
+    def rails_supports_read_replica?
+      Gem::Requirement.new('>= 7.1.0').satisfied_by?(ActiveRecord.version)
+    end
+  end
+end

data/lib/counter_culture/reconciler.rb

@@ -66,6 +66,7 @@ module CounterCulture
         @counter, @options, = counter, options
         @relation_class = relation_class
         @changes_holder = changes_holder
+        @connection_handler = WithConnection.new(relation_class)
       end
 
       def perform
@@ -314,7 +315,7 @@ module CounterCulture
       # using Postgres with schema-namespaced tables. But then it's required,
       # and otherwise it's just a no-op, so why not do it?
       def quote_table_name(table_name)
-        WithConnection.new(relation_class).call do |connection|
+        @connection_handler.call do |connection|
           connection.quote_table_name(table_name)
         end
       end
@@ -331,7 +332,9 @@ module CounterCulture
         if builder = options[:db_connection_builder]
           builder.call(true, block)
         else
-          yield
+          @connection_handler.call(reading: true) do |_conn|
+            yield
+          end
         end
       end
 
@@ -339,7 +342,9 @@ module CounterCulture
         if builder = options[:db_connection_builder]
           builder.call(false, block)
         else
-          yield
+          @connection_handler.call(reading: false) do |_conn|
+            yield
+          end
         end
       end
     end

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '3.8.2'.freeze
+  VERSION = '3.9.0'.freeze
 end

data/lib/counter_culture/with_connection.rb

@@ -6,28 +6,42 @@ module CounterCulture
 
     attr_reader :recipient
 
-    def call
-      if rails_7_2_or_greater?
-        recipient.with_connection do |connection|
-          yield connection
-        end
-      elsif rails_7_1?
-        recipient.connection_pool.with_connection do |connection|
-          yield connection
+    def call(reading: false)
+      if rails_7_1_or_greater?
+        use_read_replica = CounterCulture.configuration.use_read_replica && reading
+        role = use_read_replica ? :reading : :writing
+
+        ActiveRecord::Base.connected_to(role: role) do
+          yield_with_connection { |conn| yield conn }
         end
       else
-        yield recipient.connection
+        # For older Rails versions, just use normal connection
+        yield_with_connection { |conn| yield conn }
       end
     end
 
     private
 
-    def rails_7_1?
-      Gem::Requirement.new('~> 7.1.0').satisfied_by?(ActiveRecord.version)
+    def yield_with_connection
+      if rails_7_2_or_greater?
+        recipient.with_connection { |conn| yield conn }
+      elsif rails_7_1?
+        recipient.connection_pool.with_connection { |conn| yield conn }
+      else
+        yield recipient.connection
+      end
+    end
+
+    def rails_7_1_or_greater?
+      Gem::Requirement.new('>= 7.1.0').satisfied_by?(ActiveRecord.version)
     end
 
     def rails_7_2_or_greater?
       Gem::Requirement.new('>= 7.2.0').satisfied_by?(ActiveRecord.version)
     end
+
+    def rails_7_1?
+      Gem::Requirement.new('~> 7.1.0').satisfied_by?(ActiveRecord.version)
+    end
   end
 end

data/lib/counter_culture.rb

@@ -3,6 +3,7 @@ require 'active_support/lazy_load_hooks'
 
 require 'counter_culture/version'
 require 'counter_culture/extensions'
+require 'counter_culture/configuration'
 require 'counter_culture/counter'
 require 'counter_culture/reconciler'
 require 'counter_culture/skip_updates'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.9.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -319,7 +319,9 @@ files:
 - gemfiles/rails_7.0.gemfile
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - lib/counter_culture.rb
+- lib/counter_culture/configuration.rb
 - lib/counter_culture/counter.rb
 - lib/counter_culture/extensions.rb
 - lib/counter_culture/reconciler.rb