counter_culture 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce78ea0f9a3ad552e5cb8b0e230dbc70fc3fcb51f9f0c21676c3ecca7601569a
-  data.tar.gz: 840001761832861fbbef2e3d921d553d0ea39c685a8ab16b4096444722bb5d03
+  metadata.gz: 749d2a26a921731dd342cddd6d9e479776b26eb3ccd836fb703e47bca4c05b22
+  data.tar.gz: f59ff08373a8831c2f96605bf75063b5d50d6f1adecfa0486a53d41a3c9a8b9b
 SHA512:
-  metadata.gz: 41e59967d03892c1d0ce48d1c804862bcd0ffb575df9675869fc94fcba13440f8eaf07f4a06b6b5b88a168c79efd06af4a4b88634f8bdc9d8ca0b5c990b0c81f
-  data.tar.gz: 1e90fa445eb4972dea2c7ce851719e8fa0a095aa2526b177fd1d2ec5ae9de8d85f4bf9d1b3cc1a112a1186f76add7b7d564efab9bb146085fdf1c1011cda5ebf
+  metadata.gz: 3a57f1f22ce98c08ccf76552a040445bbcf37f53966bf3abde13f2be2fcb9c4abbf3ea13f8e911ffd536122f161e04cb0a6b62b0a1330435c2568bd8d06c39ac
+  data.tar.gz: f29b2abad46f30de69df23e0e02fa0bcb75447fd2dd854cc42dc979efbe9955316984285ae68bfd3033e4e0d8a2d31bc06699a667b2c375306e654ac2eaff8f7

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.4.0 (July 12, 2023)
+
+Improvements:
+  - Ability to skip counter culture updates in a block (#371)
+
 ## 3.3.1 (June 26, 2023)
 
 Bugfixes:

data/README.md

@@ -190,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/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.1'.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.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-26 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -321,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
@@ -343,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Turbo-charged counter caches for your Rails app.