counter_culture 3.2.1 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d06abb7c02b9c0bd0e9536c04d7ba1f753c944c018fe6f14bc156567567c46c
-  data.tar.gz: dbda06f156910a7f7a807ecee156cfb36b0ec88a97ecd35cd120be564df571bd
+  metadata.gz: ce78ea0f9a3ad552e5cb8b0e230dbc70fc3fcb51f9f0c21676c3ecca7601569a
+  data.tar.gz: 840001761832861fbbef2e3d921d553d0ea39c685a8ab16b4096444722bb5d03
 SHA512:
-  metadata.gz: 2b95de040d7c944ba43bf103157144bb5cca3bc1ca309f1082189e5015b46f1fd01615296794f3cc8a27f5e0f1b499fe0744ac41e0438f21986926a4b8c38e69
-  data.tar.gz: 9889708057fbfa61c14291124e4c71bb8f0c8f67cb9bdf24f57865cff8fc27fae5f98576ff5f99d0ada07961a4781b9e943ef0679ce30f55d7e567a1d025f2eb
+  metadata.gz: 41e59967d03892c1d0ce48d1c804862bcd0ffb575df9675869fc94fcba13440f8eaf07f4a06b6b5b88a168c79efd06af4a4b88634f8bdc9d8ca0b5c990b0c81f
+  data.tar.gz: 1e90fa445eb4972dea2c7ce851719e8fa0a095aa2526b177fd1d2ec5ae9de8d85f4bf9d1b3cc1a112a1186f76add7b7d564efab9bb146085fdf1c1011cda5ebf

data/.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  ruby: circleci/ruby@1.4
+  ruby: circleci/ruby@1.8
 
 jobs:
   test:
@@ -19,7 +19,13 @@ jobs:
     steps:
       - checkout
       - run:
-          name: bundle update
+          name: gem update --system --no-ri --no-rdoc
+          # bundles sporadically fail with a weird Psych error if I don't do
+          # this. It's annoying since it's slow but it's better than
+          # non-deterministic build failures.
+          command: sudo gem update --system
+      - run:
+          name: bundle update --no-ri --no-rdoc
           command: BUNDLE_GEMFILE=gemfiles/rails_<< parameters.rails-version >>.gemfile bundle update
       - run:
           name: install dockerize
@@ -42,7 +48,7 @@ workflows:
       - test:
           matrix:
             parameters:
-              ruby-version: ["2.6", "2.7", "3.0"]
+              ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
               rails-version: ["5.2", "6.0", "6.1", "7.0"]
               database: ["postgresql", "sqlite3", "mysql2"]
             exclude:
@@ -55,6 +61,24 @@ workflows:
               - ruby-version: "3.0"
                 rails-version: "5.2"
                 database: "mysql2"
+              - ruby-version: "3.1"
+                rails-version: "5.2"
+                database: "postgresql"
+              - ruby-version: "3.1"
+                rails-version: "5.2"
+                database: "sqlite3"
+              - ruby-version: "3.2"
+                rails-version: "5.2"
+                database: "mysql2"
+              - ruby-version: "3.2"
+                rails-version: "5.2"
+                database: "postgresql"
+              - ruby-version: "3.2"
+                rails-version: "5.2"
+                database: "sqlite3"
+              - ruby-version: "3.1"
+                rails-version: "5.2"
+                database: "mysql2"
               - ruby-version: "2.6"
                 rails-version: "7.0"
                 database: "postgresql"

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.3.1 (June 26, 2023)
+
+Bugfixes:
+  - Read primary key on polymorphic associations if it's explicitly set (#370)
+
+## 3.3.0 (October 11, 2022)
+
+Improvements:
+  - Allow reading from replica in `counter_culture_fix_counts` (#330)
+  - Test against Ruby 3.1 (#357)
+
+Bugfixes:
+  - Don't decrement counter cache when calling `.destroy` on an already-destroyed model (#351)
+  - Don't immediately call `Proc` passed to `column_names` to avoid startup issue (#352)
+
 ## 3.2.1 (February 24, 2022)
 
 Bugfixes:

data/README.md

@@ -7,10 +7,11 @@ 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 and 3.0, and against the latest patch releases of Rails 5.2, 6.0, 6.1 and 7.0.
+Tested against Ruby 2.6, 2.7, 3.0, 3.1 and 3.2, and against the latest patch releases of Rails 5.2, 6.0, 6.1 and 7.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.
-```
+
+```ruby
 product.categories.size  # => will lead to a SELECT COUNT(*) query
 product.categories_count # => will use counter cache without query
 ```
@@ -20,7 +21,7 @@ product.categories_count # => will use counter cache without query
 Add counter_culture to your Gemfile:
 
 ```ruby
-gem 'counter_culture', '~> 2.0'
+gem 'counter_culture', '~> 3.2'
 ```
 
 Then run `bundle install`
@@ -359,6 +360,20 @@ Product.counter_culture_fix_counts start: 2001, finish: 3000
 # In worker 2, lets process from 2001 to 3000
 ```
 
+#### Fix counter cache using a replica database
+
+When fixing counter caches the number of reads usually vastly exceeds the number of writes. It can make sense to offload the road load to a replica database in this case. Rails 6 introduced [native handling of multiple database connections](https://guides.rubyonrails.org/v6.0/active_record_multiple_databases.html). You can use this to send read traffic to a read-only repliace using the option `db_connection_builder`:
+
+```ruby
+Product.counter_culture_fix_counts db_connection_builder: proc{|reading, block|
+  if reading # Count calls will request a reading connection
+    Product.connected_to(role: :reading, &block)
+  else # Update all calls will request a non-reading connection
+    Product.connected_to(role: :writing, &block)
+  end
+}
+```
+
 #### Handling dynamic column names
 
 Manually populating counter caches with dynamic column names requires additional configuration:

data/counter_culture.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/magnusvk/counter_culture'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = '>= 2.6'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/counter_culture/counter.rb

@@ -284,6 +284,8 @@ module CounterCulture
       if reflect.options.key?(:polymorphic)
         raise "can't handle multiple keys with polymorphic associations" unless (relation.is_a?(Symbol) || relation.length == 1)
         raise "must specify source for polymorphic associations..." unless source
+
+        return reflect.options[:primary_key] if reflect.options.key?(:primary_key)
         return relation_klass(relation, source: source, was: was).try(:primary_key)
       end
       reflect.association_primary_key(klass)

data/lib/counter_culture/extensions.rb

@@ -45,15 +45,7 @@ module CounterCulture
           @after_commit_counter_cache = []
         end
 
-        column_names_valid = (
-          !options[:column_names] ||
-          options[:column_names].is_a?(Hash) ||
-          (
-            options[:column_names].is_a?(Proc) &&
-            options[:column_names].call.is_a?(Hash)
-          )
-        )
-        unless column_names_valid
+        if options[:column_names] && !(options[:column_names].is_a?(Hash) || options[:column_names].is_a?(Proc))
           raise ArgumentError.new(
             ":column_names must be a Hash of conditions and column names, " \
             "or a Proc that when called returns such a Hash"
@@ -92,7 +84,7 @@ module CounterCulture
           next if options[:exclude] && options[:exclude].include?(counter.relation)
           next if options[:only] && !options[:only].include?(counter.relation)
 
-          reconciler_options = %i(batch_size column_name finish skip_unsupported start touch verbose where polymorphic_classes)
+          reconciler_options = %i(batch_size column_name db_connection_builder finish skip_unsupported start touch verbose where polymorphic_classes)
 
           reconciler = CounterCulture::Reconciler.new(counter, options.slice(*reconciler_options))
           reconciler.reconcile!
@@ -113,8 +105,10 @@ module CounterCulture
     # called by after_destroy callback
     def _update_counts_after_destroy
       self.class.after_commit_counter_cache.each do |counter|
-        # decrement counter cache
-        counter.change_counter_cache(self, :increment => false)
+        unless destroyed?
+          # decrement counter cache
+          counter.change_counter_cache(self, :increment => false)
+        end
       end
     end
 

data/lib/counter_culture/reconciler.rb

@@ -84,6 +84,8 @@ module CounterCulture
             { nil => counter_cache_name }
           end
 
+        raise ArgumentError, ":column_names must be a Hash of conditions and column names" unless counter_column_names.is_a?(Hash)
+
         if options[:column_name]
           counter_column_names = counter_column_names.select do |_, v|
             options[:column_name].to_s == v.to_s
@@ -123,11 +125,13 @@ module CounterCulture
           find_in_batches_args[:start] = options[:start] if options[:start].present?
           find_in_batches_args[:finish] = options[:finish] if options[:finish].present?
 
-          counts_query.find_in_batches(**find_in_batches_args).with_index(1) do |records, index|
-            log "Processing batch ##{index}."
-            # now iterate over all the models and see whether their counts are right
-            update_count_for_batch(column_name, records)
-            log "Finished batch ##{index}."
+          with_reading_db_connection do
+            counts_query.find_in_batches(**find_in_batches_args).with_index(1) do |records, index|
+              log "Processing batch ##{index}."
+              # now iterate over all the models and see whether their counts are right
+              update_count_for_batch(column_name, records)
+              log "Finished batch ##{index}."
+            end
           end
         end
         log_without_newline "\n"
@@ -161,7 +165,9 @@ module CounterCulture
               end
             end
 
-            relation_class.where(relation_class.primary_key => record.send(relation_class.primary_key)).update_all(updates.join(', '))
+            with_writing_db_connection do
+              relation_class.where(relation_class.primary_key => record.send(relation_class.primary_key)).update_all(updates.join(', '))
+            end
           end
         end
       end
@@ -312,6 +318,22 @@ module CounterCulture
           string.parameterize(separator: '_')
         end
       end
+
+      def with_reading_db_connection(&block)
+        if builder = options[:db_connection_builder]
+          builder.call(true, block)
+        else
+          yield
+        end
+      end
+
+      def with_writing_db_connection(&block)
+        if builder = options[:db_connection_builder]
+          builder.call(false, block)
+        else
+          yield
+        end
+      end
     end
   end
 end

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '3.2.1'.freeze
+  VERSION = '3.3.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.1
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -312,7 +312,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - counter_culture.gemspec
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
@@ -337,14 +336,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.2
 signing_key:
 specification_version: 4
 summary: Turbo-charged counter caches for your Rails app.

data/circle.yml

@@ -1,12 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.1
-database:
-  override:
-    - echo "No database setup required..."
-dependencies:
-  post:
-    - cd spec/rails_app && bundle install
-test:
-  override:
-    - bundle exec rspec spec