counter_culture 3.8.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4355ba12c0a0ecf776641647648a3422d5aafc76c48a5db418d381f51f0890de
-  data.tar.gz: 8b1dd8e1de14b7b5377deaa9143c0ffbc8e6f4418524931dcd494417de49d1ca
+  metadata.gz: f93d3d3e415f5d92e3870caf67067cdb75a6a76f68542b82c9ec2411987a0e4d
+  data.tar.gz: 89cf5171b549aab368a1dd87117afd429bf557d93f198e220fbe3b2a24e81f20
 SHA512:
-  metadata.gz: d3c7ec219454d12a50d79815da7fa920cd1644ca268fceea089d9eac28438b7a28df3949f969bc9c63ee60a56c0d6d4e8f56e42f0e2218cb9e42e9a157ca1420
-  data.tar.gz: 63c4cd5958f0a3a2fa9eb6b6018cc0891ced1f2ad2708d02ea49f9cce8416ffc42a62ae01eb7b2cf2dad5334e16061eac517c7f8be40b35068694b63a238c748
+  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,9 +5,10 @@
   7.0
   7.1
   7.2
+  8.0
 ].each do |rails_version|
   appraise "rails-#{rails_version}" do
-    gem 'rails', "~> #{rails_version}.0"
+    gem 'activerecord', "~> #{rails_version}.0"
     if Gem::Version.new(rails_version) < Gem::Version.new("7.2")
       gem 'sqlite3', "~> 1.4"
     end

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 3.9.0 (March 20, 2025)
+
+New features:
+  - Add global configuration for using a read replica (#405)
+
+## 3.8.2 (October 21, 2024)
+
+Bugfixes:
+  - Use ActiveRecord version, not Rails version, to make it possible to use `counter_culture_fix_counts` without Rails
+  - Tests no longer require Rails, making sure we do not introduce this regression again
+
 ## 3.8.1 (October 18, 2024)
 
 Bugfixes:
@@ -268,7 +279,7 @@ Bugfixes:
 ## 1.8.1 (September 5, 2017)
 
 Improvements:
-  - Use ActiveRecord version, not Rails version, in `Reconciler`, makeing it possible to use `counter_culture_fix_counts` without Rails
+  - Use ActiveRecord version, not Rails version, in `Reconciler`, making it possible to use `counter_culture_fix_counts` without Rails
 
 ## 1.8.0 (August 30, 2017)
 

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/counter_culture.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'paper_trail'
   spec.add_development_dependency 'paranoia'
   spec.add_development_dependency 'after_commit_action'
-  spec.add_development_dependency 'rails', '>= 4.2'
+  spec.add_development_dependency 'activerecord', '>= 4.2'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rdoc', ">= 6.3.1"
   spec.add_development_dependency 'rspec', '~> 3.0'

data/gemfiles/rails_5.2.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.0.0"
+gem "activerecord", "~> 6.0.0"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.1.0"
+gem "activerecord", "~> 6.1.0"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.0.0"
+gem "activerecord", "~> 7.0.0"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.1.0"
+gem "activerecord", "~> 7.1.0"
 gem "sqlite3", "~> 1.4"
 
 gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.2.0"
+gem "activerecord", "~> 7.2.0"
 
 gemspec path: "../"

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
@@ -181,17 +182,17 @@ module CounterCulture
       def log(message)
         return unless log?
 
-        Rails.logger.info(message)
+        ActiveRecord::Base.logger.info(message)
       end
 
       def log_without_newline(message)
         return unless log?
 
-        Rails.logger << message if Rails.logger.info?
+        ActiveRecord::Base.logger << message if ActiveRecord::Base.logger.info?
       end
 
       def log?
-        options[:verbose] && Rails.logger
+        options[:verbose] && ActiveRecord::Base.logger
       end
 
       # keep track of what we fixed, e.g. for a notification email
@@ -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.1'.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?(Gem::Version.new(Rails.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?(Gem::Version.new(Rails.version))
+      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'

data/lib/generators/counter_culture_generator.rb

@@ -27,8 +27,8 @@ class CounterCultureGenerator < ActiveRecord::Generators::Base
   end
 
   def migration_version
-    if Gem::Version.new(Rails.version) >= Gem::Version.new('5.0.0')
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    if ActiveRecord.version >= Gem::Version.new('5.0.0')
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -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