counter_culture 2.6.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5f74128800b0a21f52ee32279a4ea9eb89cfb707705101958753c065077e30
-  data.tar.gz: 89c64173bb719cafe1594918779e3bef02b93b567bf9f098593d1b99f0888c38
+  metadata.gz: 99af13953d00540dac3d0b149483d190f03f4c0f77063cdd440b2b18c1ef6031
+  data.tar.gz: fedce32d590b66c8ff0bf291d612ef1f1fd08356afb81a56ae310caa6a9eeac9
 SHA512:
-  metadata.gz: e2383f82c2c46bab51d9bfe7b4ada1f579768463f38d8ab93d1e0e33c0b878b6c1f38bbd0793c43ee38d3fca6c2a13a27b2453b20daeb69f96c4242a192e56e6
-  data.tar.gz: ee3d106b3abb6b4c362d0c6b4861ef2e04ed3cfccd5dd5611b96db50435fc573d3d23a16c3558e0a5d8eafc4c48aa4650fc8edf4f2301d93d9a30fb408de69f9
+  metadata.gz: 510c27a1188f8cbe9073487f2f0f7579ffad46a1b140c44bdfcea07308ddb0975587140dd96a60087475d8c6ad94d1b415cb40f57a1ba59e7d19673bd426bf93
+  data.tar.gz: 5c2acebf87a92a8ca02e7bd38d4d683cde4fa77c46f611ae29f6007509450baeeb72a69df6107c38606b9243d1e61e5a38302ec51bbd60bdb1fbd8bd53b1289f

data/.travis.yml

@@ -1,31 +1,45 @@
 language: ruby
+cache:
+  directories:
+     - ~/.rvm/gems
 services:
   - postgresql
   - mysql
+branches:
+  only:
+  - master
 addons:
   postgresql: "9.6"
 rvm:
-  - "2.5.7"
-  - "2.6.5"
-  - "2.7.0"
+  - "2.5.9"
+  - "2.6.8"
+  - "2.7.4"
+  - "3.0.2"
 gemfile:
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.2.gemfile
   - gemfiles/rails_6.0.gemfile
+  - gemfiles/rails_6.1.gemfile
 matrix:
   exclude:
-    - rvm: "2.7.0"
+    - rvm: "3.0.1"
       gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: "3.0.1"
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: "3.0.1"
+      gemfile: gemfiles/rails_5.1.gemfile
+    - rvm: "3.0.1"
+      gemfile: gemfiles/rails_5.2.gemfile
 env:
   - DB=postgresql
   - DB=sqlite3
   - DB=mysql2
 before_install:
-  - gem install bundler -v '1.17.3'
+  - if [ "$BUNDLE_GEMFILE" = "$PWD/gemfiles/rails_4.2.gemfile" ]; then gem install bundler -v '1.17.3'; else gem install bundler -v '> 2'; fi
 install:
-  - bundle _1.17.3_ update
+  - if [ "$BUNDLE_GEMFILE" = "$PWD/gemfiles/rails_4.2.gemfile" ]; then bundle _1.17.3_ update; else bundle update; fi
 before_script:
   - psql -c 'create database counter_culture_test;' -U postgres
   - mysql -e 'CREATE DATABASE counter_culture_test;'

data/Appraisals

@@ -4,6 +4,7 @@
   5.1
   5.2
   6.0
+  6.1
 ].each do |rails_version|
   gem_rails_version = Gem::Version.new(rails_version)
   if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5.0') &&
@@ -15,8 +16,19 @@
   appraise "rails-#{rails_version}" do
     gem 'rails', "~> #{rails_version}.0"
 
-    gem 'pg', gem_rails_version < Gem::Version.new('5.0') ? '~> 0.15' : '~> 1.0'
+    if gem_rails_version < Gem::Version.new('5.0')
+      gem 'pg',  '~> 0.15'
+    else
+      gem 'pg'
+    end
     gem 'mysql2'
-    gem 'sqlite3', gem_rails_version < Gem::Version.new(5.2) ? '~> 1.3.0' : '~> 1.4'
+    if gem_rails_version < Gem::Version.new('5.2')
+      gem 'sqlite3', '~> 1.3.0'
+    else
+      gem 'sqlite3'
+    end
+    if gem_rails_version < Gem::Version.new('5.0')
+      gem 'bigdecimal', '~> 1.3.5'
+    end
   end
 end

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 2.9.0 (August 27, 2021)
+
+Improvements:
+  - Allow `execute_after_commit` to be a `Proc` for dynamic control (#326)
+
+## 2.8.0 (March 16, 2021)
+
+Improvements:
+  - New `execute_after_commit` option (#309)
+
+## 2.7.0 (November 16, 2020)
+
+Improvements:
+  - New `column_name` option for `counter_culture_fix_counts` (#300)
+
+## 2.6.2 (October 21, 2020)
+
+Improvements:
+  - Remove superfluous dependency to after_commit_action gem (#297)
+
 ## 2.6.1 (September 8, 2020)
 
 Bugfixes:

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.3.8, 2.4.7, 2.5.6 and 2.6.4 and against the latest patch releases of Rails 4.2, 5.0, 5.1, 5.2 and 6.0.
+Tested against Ruby 2.5.8, 2.6.6, 2.7.2 and 3.0.0, and against the latest patch releases of Rails 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1.
 
 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.
 ```
@@ -187,6 +187,8 @@ end
 
 Now, the ```Category``` model will keep the counter cache in ```special_count``` up-to-date. Only products where ```special?``` returns true will affect the 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).
+
 ### Totaling instead of counting
 
 Instead of keeping a running count, you may want to automatically track a running total.
@@ -248,6 +250,28 @@ You may also specify a custom timestamp column that gets updated only when a par
 
 With this option, any time the `category_counter_cache` changes both the `category_count_changed` and `updated_at` columns will get updated.
 
+### Avoiding deadlocks / executing counter cache updates after commit
+
+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:
+
+```ruby
+  counter_culture :category, execute_after_commit: true
+```
+[NOTE] You need to manually specify the `after_commit_action` as dependency in the Gemfile to use this feature
+```ruby
+...
+gem "after_commit_action"
+...
+```
+
+You can also pass a `Proc` for dynamic control. This is useful for temporarily moving the counter cache update inside of the transaction:
+
+```ruby
+  counter_culture :category, execute_after_commit: proc { !Thread.current[:update_counter_cache_in_transaction] }
+```
+
 ### Manually populating counter cache values
 
 You will sometimes want to populate counter-cache values from primary data. This is required when adding counter-caches to existing data. It is also recommended to run this regularly (at BestVendor, we run it once a week) to catch any incorrect values in the counter caches.
@@ -268,6 +292,10 @@ Product.counter_culture_fix_counts only: :category
 Product.counter_culture_fix_counts only: [[:subcategory, :category]]
 # will automatically fix counts only on the two-level [:subcategory, :category] relation on Product
 
+Product.counter_culture_fix_counts column_name: :reviews_count
+# will automatically fix counts only on the :reviews_count column on Product
+# This allows us to skip the columns that have already been processed. This is useful after running big DB changes that affect only one counter cache column.
+
 # :except and :only also accept arrays
 
 Product.counter_culture_fix_counts verbose: true
@@ -440,4 +468,4 @@ counter_culture now supports polymorphic associations of one level only.
 
 ## Copyright
 
-Copyright (c) 2012-2013 BestVendor, Magnus von Koeller. See LICENSE.txt for further details.
+Copyright (c) 2012-2021 BestVendor, Magnus von Koeller. See LICENSE.txt for further details.

data/counter_culture.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Turbo-charged counter caches for your Rails app.'
   spec.description   = 'counter_culture provides turbo-charged counter caches that are kept up-to-date not just on create and destroy, that support multiple levels of indirection through relationships, allow dynamic column names and that avoid deadlocks by updating in the after_commit callback.'
-  spec.homepage      = 'http://github.com/magnusvk/counter_culture'
+  spec.homepage      = 'https://github.com/magnusvk/counter_culture'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -25,17 +25,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'after_commit_action', '~> 1.0'
   spec.add_dependency 'activerecord', '>= 4.2'
   spec.add_dependency 'activesupport', '>= 4.2'
 
   spec.add_development_dependency 'appraisal', '> 2.0.0'
   spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'database_cleaner', '>= 1.1.1'
   spec.add_development_dependency 'discard'
   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 'rake', '>= 10.0'
   spec.add_development_dependency 'rdoc', '~> 5.0.0'

data/gemfiles/rails_4.2.gemfile

@@ -6,5 +6,6 @@ gem "sqlite3", "~> 1.3.0"
 gem "rails", "~> 4.2.0"
 gem "pg", "~> 0.15"
 gem "mysql2"
+gem "bigdecimal", "~> 1.3.5"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.0"
 gem "rails", "~> 5.0.0"
-gem "pg", "~> 1.0"
+gem "pg"
 gem "mysql2"
 
 gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.0"
 gem "rails", "~> 5.1.0"
-gem "pg", "~> 1.0"
+gem "pg"
 gem "mysql2"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.4"
+gem "sqlite3"
 gem "rails", "~> 5.2.0"
-gem "pg", "~> 1.0"
+gem "pg"
 gem "mysql2"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.4"
+gem "sqlite3"
 gem "rails", "~> 6.0.0"
-gem "pg", "~> 1.0"
+gem "pg"
 gem "mysql2"
 
 gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3"
+gem "rails", "~> 6.1.0"
+gem "pg"
+gem "mysql2"
+
+gemspec path: "../"

data/lib/counter_culture/counter.rb

@@ -1,6 +1,6 @@
 module CounterCulture
   class Counter
-    CONFIG_OPTIONS = [ :column_names, :counter_cache_name, :delta_column, :foreign_key_values, :touch, :delta_magnitude]
+    CONFIG_OPTIONS = [ :column_names, :counter_cache_name, :delta_column, :foreign_key_values, :touch, :delta_magnitude, :execute_after_commit ]
     ACTIVE_RECORD_VERSION = Gem.loaded_specs["activerecord"].version
 
     attr_reader :model, :relation, *CONFIG_OPTIONS
@@ -9,10 +9,6 @@ module CounterCulture
       @model = model
       @relation = relation.is_a?(Enumerable) ? relation : [relation]
 
-      if options.fetch(:execute_after_commit, false)
-        fail("execute_after_commit was removed; updates now run within the transaction")
-      end
-
       @counter_cache_name = options.fetch(:column_name, "#{model.name.demodulize.tableize}_count")
       @column_names = options[:column_names]
       @delta_column = options[:delta_column]
@@ -20,6 +16,18 @@ module CounterCulture
       @touch = options.fetch(:touch, false)
       @delta_magnitude = options[:delta_magnitude] || 1
       @with_papertrail = options.fetch(:with_papertrail, false)
+      @execute_after_commit = options.fetch(:execute_after_commit, false)
+
+      if @execute_after_commit
+        begin
+          require 'after_commit_action'
+        rescue LoadError
+          fail(LoadError.new(
+            "You need to include the `after_commit_action` gem in your "\
+            "gem dependencies to use the execute_after_commit option"))
+        end
+        model.include(AfterCommitAction)
+      end
     end
 
     # increments or decrements a counter cache
@@ -93,14 +101,20 @@ module CounterCulture
                 instance.send("#{timestamp_column}=", current_time)
               end
 
-              instance.paper_trail.save_with_version(validate: false)
+              execute_now_or_after_commit(obj) do
+                instance.paper_trail.save_with_version(validate: false)
+              end
             else
-              instance.paper_trail.touch_with_version
+              execute_now_or_after_commit(obj) do
+                instance.paper_trail.touch_with_version
+              end
             end
           end
         end
 
-        klass.where(primary_key => id_to_change).update_all updates.join(', ')
+        execute_now_or_after_commit(obj) do
+          klass.where(primary_key => id_to_change).update_all updates.join(', ')
+        end
       end
     end
 
@@ -296,6 +310,16 @@ module CounterCulture
       prev
     end
 
+    def execute_now_or_after_commit(obj, &block)
+      execute_after_commit = @execute_after_commit.is_a?(Proc) ? @execute_after_commit.call : @execute_after_commit
+
+      if execute_after_commit
+        obj.execute_after_commit(&block)
+      else
+        block.call
+      end
+    end
+
     private
     def attribute_was(obj, attr)
       changes_method =

data/lib/counter_culture/extensions.rb

@@ -15,8 +15,6 @@ module CounterCulture
       # called to configure counter caches
       def counter_culture(relation, options = {})
         unless @after_commit_counter_cache
-          include AfterCommitAction unless include?(AfterCommitAction)
-
           # initialize callbacks only once
           after_create :_update_counts_after_create
 
@@ -61,7 +59,8 @@ module CounterCulture
       #
       # options:
       #   { :exclude => list of relations to skip when fixing counts,
-      #     :only => only these relations will have their counts fixed }
+      #     :only => only these relations will have their counts fixed,
+      #     :column_name => only this column will have its count fixed }
       # returns: a list of fixed record as an array of hashes of the form:
       #   { :entity => which model the count was fixed on,
       #     :id => the id of the model that had the incorrect count,
@@ -81,7 +80,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 finish skip_unsupported start touch verbose where)
+          reconciler_options = %i(batch_size column_name finish skip_unsupported start touch verbose where)
 
           reconciler = CounterCulture::Reconciler.new(counter, options.slice(*reconciler_options))
           reconciler.reconcile!

data/lib/counter_culture/reconciler.rb

@@ -76,6 +76,10 @@ module CounterCulture
 
         counter_column_names = column_names || {nil => counter_cache_name}
 
+        if options[:column_name]
+          counter_column_names = counter_column_names.select{ |_, v| options[:column_name].to_s == v }
+        end
+
         # iterate over all the possible counter cache column names
         counter_column_names.each do |where, column_name|
           # if the column name is nil, that means those records don't affect

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '2.6.1'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/lib/counter_culture.rb

@@ -1,4 +1,3 @@
-require 'after_commit_action'
 require 'active_support/concern'
 require 'active_support/lazy_load_hooks'
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Magnus von Koeller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: after_commit_action
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: after_commit_action
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +277,7 @@ files:
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - lib/counter_culture.rb
 - lib/counter_culture/counter.rb
 - lib/counter_culture/extensions.rb
@@ -284,12 +285,11 @@ files:
 - lib/counter_culture/version.rb
 - lib/generators/counter_culture_generator.rb
 - lib/generators/templates/counter_culture_migration.rb.erb
-- run_tests_locally.sh
-homepage: http://github.com/magnusvk/counter_culture
+homepage: https://github.com/magnusvk/counter_culture
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -304,8 +304,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Turbo-charged counter caches for your Rails app.
 test_files: []

data/run_tests_locally.sh

@@ -1,20 +0,0 @@
-#! /bin/bash
-
-set -e
-source /usr/local/share/chruby/chruby.sh
-
-for RUBY_VERSION in 2.5.7 2.6.5 2.7.0; do
-  chruby $RUBY_VERSION
-  ruby --version
-
-  gem install bundler -v '1.17.3'
-
-  (bundle _1.17.3_ check > /dev/null || bundle _1.17.3_ install)
-  gem install appraisal
-  bundle exec appraisal install
-
-  for DB in mysql2 postgresql sqlite3; do
-    echo "RUBY $RUBY_VERSION; DB $DB"
-    DB=$DB bundle exec appraisal rspec spec/counter_culture_spec.rb
-  done
-done