counter_culture 3.3.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce78ea0f9a3ad552e5cb8b0e230dbc70fc3fcb51f9f0c21676c3ecca7601569a
-  data.tar.gz: 840001761832861fbbef2e3d921d553d0ea39c685a8ab16b4096444722bb5d03
+  metadata.gz: acebc4b3981511ea35497a3f276372253cb709314002ab2c6c498fb9b60a0166
+  data.tar.gz: b659b8956b8e6911c58563e4f921487f49a3ddf8ada5fbee7b79b0de16f8796d
 SHA512:
-  metadata.gz: 41e59967d03892c1d0ce48d1c804862bcd0ffb575df9675869fc94fcba13440f8eaf07f4a06b6b5b88a168c79efd06af4a4b88634f8bdc9d8ca0b5c990b0c81f
-  data.tar.gz: 1e90fa445eb4972dea2c7ce851719e8fa0a095aa2526b177fd1d2ec5ae9de8d85f4bf9d1b3cc1a112a1186f76add7b7d564efab9bb146085fdf1c1011cda5ebf
+  metadata.gz: 9ef804972ebbd99b5945b22d87c85d93dcd3af1ea78f04683a0799b67d25d42cb8c4ca52e08b9267fbd17f11e6fcd07a334e5990cccd5e4fd3ea27991da67fb4
+  data.tar.gz: 81fa1adc6e283a1fed1a661e08cc7bd4a5280062cb8567ef730ce59342b0cf49032d09a9fc05bcbff713fbbd37d9a7157f2de35bc25df696d48f5de5bed9281c

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.5.0 (August 25, 2023)
+
+Improvements:
+  - Allow passing context to `counter_culture_fix_counts` (#375)
+
+## 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.
@@ -255,7 +267,7 @@ With this option, any time the `category_counter_cache` changes both the `catego
 
 Some applications run into issues with deadlocks involving counter cache updates when using this gem. See [#263](https://github.com/magnusvk/counter_culture/issues/263#issuecomment-772284439) for information and helpful links on how to avoid this issue.
 
-Another option is to simply defer the update of counter caches to outside of the transaction. This gives up transacrtional guarantees for your counter cache updates but should resolve any deadlocks you experience. This behavior is disabled by default, enable it on each affected counter cache as follows:
+Another option is to simply defer the update of counter caches to outside of the transaction. This gives up transactional guarantees for your counter cache updates but should resolve any deadlocks you experience. This behavior is disabled by default, enable it on each affected counter cache as follows:
 
 ```ruby
   counter_culture :category, execute_after_commit: true
@@ -419,6 +431,23 @@ dynamic, you can pass `skip_unsupported`:
 Product.counter_culture_fix_counts skip_unsupported: true
 ```
 
+You can also use context within the block that was provided with the `column_names` method:
+
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :category
+  scope :awesomes, -> (ids) { where(ids: ids, product_type: 'awesome') }
+
+  counter_culture :category,
+      column_name: 'awesome_count'
+      column_names: -> (context) {
+        { Product.awesomes(context[:ids]) => :awesome_count }
+      }
+end
+
+Product.counter_culture_fix_counts(context: { ids: [1, 2] })
+```
+
 #### Handling over-written, dynamic foreign keys
 
 Manually populating counter caches with dynamically over-written foreign keys (```:foreign_key_values``` option) is not supported. You will have to write code to handle this case yourself.

data/lib/counter_culture/extensions.rb

@@ -84,13 +84,23 @@ 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 db_connection_builder finish skip_unsupported start touch verbose where polymorphic_classes)
+          reconciler_options = %i(context 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!
           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/reconciler.rb

@@ -77,7 +77,11 @@ module CounterCulture
         counter_column_names =
           case column_names
           when Proc
-            column_names.call
+            if column_names.lambda? && column_names.arity == 0
+              column_names.call
+            else
+              column_names.call(options.fetch(:context, {}))
+            end
           when Hash
             column_names
           else

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.5.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.5.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-26 00:00:00.000000000 Z
+date: 2023-08-25 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.19
 signing_key:
 specification_version: 4
 summary: Turbo-charged counter caches for your Rails app.