counter_culture 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ab4a286fa35aeed4f39a89653ed55be5da8c2ea6255a84f8f5c60c3002a4e75
-  data.tar.gz: 910213339a5c0815679736c77e72b8964a678fb58495fdfd9882157b3fdaaf5b
+  metadata.gz: 749d2a26a921731dd342cddd6d9e479776b26eb3ccd836fb703e47bca4c05b22
+  data.tar.gz: f59ff08373a8831c2f96605bf75063b5d50d6f1adecfa0486a53d41a3c9a8b9b
 SHA512:
-  metadata.gz: d42e4460ea4ad61e3ee12bdc430d9cb833772a32d02bdfe9c2fd8b78f7f06d157f06e9f50dec1efb5df6bf6c917b624f4c9c626ac43ea541a9faef3422fbc5b8
-  data.tar.gz: 50166340b9db761bcdf4a198d21d8c1580b26d09cf4928082885175441ef260758d909e321d30c7204e2f782730833e8153db8a3d28c879dd55d8de3d2ceb453
+  metadata.gz: 3a57f1f22ce98c08ccf76552a040445bbcf37f53966bf3abde13f2be2fcb9c4abbf3ea13f8e911ffd536122f161e04cb0a6b62b0a1330435c2568bd8d06c39ac
+  data.tar.gz: f29b2abad46f30de69df23e0e02fa0bcb75447fd2dd854cc42dc979efbe9955316984285ae68bfd3033e4e0d8a2d31bc06699a667b2c375306e654ac2eaff8f7

data/.circleci/config.yml

@@ -48,7 +48,7 @@ workflows:
       - test:
           matrix:
             parameters:
-              ruby-version: ["2.6", "2.7", "3.0", "3.1"]
+              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:
@@ -67,6 +67,15 @@ workflows:
               - 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"

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.4.0 (July 12, 2023)
+
+Improvements:
+  - Ability to skip counter culture updates in a block (#371)
+
+## 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:

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
 ```
@@ -189,6 +190,18 @@ Now, the ```Category``` model will keep the counter cache in ```special_count```
 
 If you would like to use this with `counter_culture_fix_counts`, make sure to also provide [the `column_names` configuration](#handling-dynamic-column-names).
 
+### Temporarily skipping counter cache updates
+
+If you would like to temporarily pause counter_culture, for example in a backfill script, you can do so as follows:
+
+```ruby
+Review.skip_counter_culture_updates do
+  user.reviews.create!
+end
+
+user.reviews_count # => unchanged
+```
+
 ### Totaling instead of counting
 
 Instead of keeping a running count, you may want to automatically track a running total.

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

@@ -91,6 +91,16 @@ module CounterCulture
           reconciler.changes
         end.compact
       end
+
+      def skip_counter_culture_updates
+        return unless block_given?
+
+        counter_culture_updates_was = Thread.current[:skip_counter_culture_updates]
+        Thread.current[:skip_counter_culture_updates] = Array(counter_culture_updates_was) + [self]
+        yield
+      ensure
+        Thread.current[:skip_counter_culture_updates] = counter_culture_updates_was
+      end
     end
 
     private

data/lib/counter_culture/skip_updates.rb

@@ -0,0 +1,26 @@
+module CounterCulture
+  module SkipUpdates
+    private
+
+    # called by after_create callback
+    def _update_counts_after_create
+      unless Array(Thread.current[:skip_counter_culture_updates]).include?(self.class)
+        super
+      end
+    end
+
+    # called by after_destroy callback
+    def _update_counts_after_destroy
+      unless Array(Thread.current[:skip_counter_culture_updates]).include?(self.class)
+        super
+      end
+    end
+
+    # called by after_update callback
+    def _update_counts_after_update
+      unless Array(Thread.current[:skip_counter_culture_updates]).include?(self.class)
+        super
+      end
+    end
+  end
+end

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '3.3.0'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/lib/counter_culture.rb

@@ -5,6 +5,7 @@ require 'counter_culture/version'
 require 'counter_culture/extensions'
 require 'counter_culture/counter'
 require 'counter_culture/reconciler'
+require 'counter_culture/skip_updates'
 
 module CounterCulture
   mattr_accessor :batch_size
@@ -19,4 +20,5 @@ end
 # extend ActiveRecord with our own code here
 ActiveSupport.on_load(:active_record) do
   include CounterCulture::Extensions
+  include CounterCulture::SkipUpdates
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2023-07-13 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
@@ -322,6 +321,7 @@ files:
 - lib/counter_culture/counter.rb
 - lib/counter_culture/extensions.rb
 - lib/counter_culture/reconciler.rb
+- lib/counter_culture/skip_updates.rb
 - lib/counter_culture/version.rb
 - lib/generators/counter_culture_generator.rb
 - lib/generators/templates/counter_culture_migration.rb.erb
@@ -337,14 +337,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.3.7
+rubygems_version: 3.4.10
 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