counter_culture 2.7.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74fff95505913ba522b3ec93bc9101c375c7de5678744145a0e4959f2c267361
-  data.tar.gz: bc284f87da6f949e7d875b7f30c43accbe23ce5716601af9fc4143eb6346954d
+  metadata.gz: 461f74df5dfedb6986e9ad3504c20d6a8c173b284011279b853cec7a58fdf57b
+  data.tar.gz: ce60aa02f06c3719f2a34020ca065bf6fe07847d7b4e5d238ef263345634e491
 SHA512:
-  metadata.gz: e63708745c4ffbb727a1b4da61a0d027de76d7256ee5d9669fa0f18dfcc2b183f26ddc109f45d6af6fb68a79c040e73872f647e8453c7b801e390036601878eb
-  data.tar.gz: c58c36d4aaf450450d913ad93487c7012de5de0ba8bb4f99c83a3994b64e8aed19f04a0d62c0df21ceda862312b9c010af042857709d891f746e20403ef893f2
+  metadata.gz: b706ac60f8dcd3f68e8b7da3a8987caaddfd9d5e0c67cb94923af7188910614c0c991047734e8a4c28d68801e41ab1f77ac975e659615facd6ecdaf96ce58faa
+  data.tar.gz: e9b2a3910632ee00a5e6489f339e79f7e3b07be8aee5ef7eddf0e60f82e7af848aedcc63861cf281c833edb9703407ae215fd7b4ea57b792fe74b776ae5a45ca

data/.travis.yml

@@ -1,31 +1,49 @@
+dist: focal
 language: ruby
+cache:
+  directories:
+     - ~/.rvm/gems
 services:
   - postgresql
   - mysql
+branches:
+  only:
+  - master
 addons:
-  postgresql: "9.6"
+  postgresql: '12'
+  apt:
+    packages:
+      - postgresql-12
+      - postgresql-client-12
 rvm:
-  - "2.5.7"
-  - "2.6.5"
-  - "2.7.0"
+  - "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"
-      gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: "3.0.2"
+      gemfile: gemfiles/rails_5.2.gemfile
 env:
+  global:
+  - PGUSER=postgres
+  - PGPORT=5432
+  - PGHOST=localhost
+  jobs:
   - DB=postgresql
   - DB=sqlite3
   - DB=mysql2
 before_install:
-  - gem install bundler -v '1.17.3'
+  - sudo sed -i -e '/local.*peer/s/postgres/all/' -e 's/peer\|md5/trust/g' /etc/postgresql/*/main/pg_hba.conf
+  - sudo service postgresql restart
+  - sleep 1
+  - postgres --version
+  - 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

@@ -1,9 +1,7 @@
 %w[
-  4.2
-  5.0
-  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 +13,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,32 @@
+## 3.1.0 (November 29, 2021)
+
+Improvements:
+  - Allow specifiying a `Proc` to `column_names` to avoid loading a scope on
+    startup (#335)
+
+## 3.0.0 (October 26, 2021)
+
+Breaking changes:
+  - Dropped support for Ruby < 2.6
+  - Dropped support for Rails < 5.2
+
+Note that there are no specific breaking changes that would cause older
+versions of Ruby or Rails to stop working, we have simply stopped testing
+against them.
+
+Improvements:
+  - Support PostgreSql's `money` type for use with a delta column (#333)
+
+## 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:

data/Gemfile

@@ -4,6 +4,3 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify the gem's dependencies in counter_culture.gemspec
 gemspec
-
-# Ensure we have the default DB adapter for testing
-gem 'sqlite3'

data/README.md

@@ -1,4 +1,4 @@
-# counter_culture [![Build Status](https://travis-ci.com/magnusvk/counter_culture.svg)](https://travis-ci.com/magnusvk/counter_culture)
+# counter_culture [![Build Status](https://app.travis-ci.com/magnusvk/counter_culture.svg?branch=master)](https://app.travis-ci.com/magnusvk/counter_culture)
 
 Turbo-charged counter caches for your Rails app. Huge improvements over the Rails standard counter caches:
 
@@ -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.
 ```
@@ -250,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.
@@ -354,7 +376,10 @@ class Product < ActiveRecord::Base
 end
 ```
 
-You can specify a scope instead of a where condition string for `column_names`:
+You can specify a scope instead of a where condition string for `column_names`. We recommend
+providing a Proc that returns a hash instead of directly providing a hash: If you were to directly
+provide a scope this would load your schema cache on startup which will break things like 
+`rake db:migrate`.
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -364,10 +389,10 @@ class Product < ActiveRecord::Base
 
   counter_culture :category,
       column_name: proc {|model| "#{model.product_type}_count" },
-      column_names: {
+      column_names: -> { {
           Product.awesomes => :awesome_count,
           Product.suckys => :sucky_count
-      }
+      } }
 end
 ```
 
@@ -446,4 +471,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

@@ -30,11 +30,12 @@ Gem::Specification.new do |spec|
 
   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'
@@ -42,4 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-extra-formatters'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'pg'
 end

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_5.0.gemfile → rails_6.1.gemfile}

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.3.0"
-gem "rails", "~> 5.0.0"
-gem "pg", "~> 1.0"
+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
@@ -61,10 +69,16 @@ module CounterCulture
                           "#{model.connection.quote_column_name(change_counter_column)}"
                         end
 
+        column_type = klass.type_for_attribute(change_counter_column).type
+
         # we don't use Rails' update_counters because we support changing the timestamp
         updates = []
         # this updates the actual counter
-        updates << "#{quoted_column} = COALESCE(#{quoted_column}, 0) #{operator} #{delta_magnitude}"
+        if column_type == :money
+          updates << "#{quoted_column} = COALESCE(CAST(#{quoted_column} as NUMERIC), 0) #{operator} #{delta_magnitude}"
+        else
+          updates << "#{quoted_column} = COALESCE(#{quoted_column}, 0) #{operator} #{delta_magnitude}"
+        end
         # and here we update the timestamp, if so desired
         if touch
           current_time = obj.send(:current_time_from_proper_timezone)
@@ -93,14 +107,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 +316,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

@@ -45,8 +45,19 @@ module CounterCulture
           @after_commit_counter_cache = []
         end
 
-        if options[:column_names] && !options[:column_names].is_a?(Hash)
-          raise ":column_names must be a Hash of conditions and column names"
+        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
+          raise ArgumentError.new(
+            ":column_names must be a Hash of conditions and column names, " \
+            "or a Proc that when called returns such a Hash"
+          )
         end
 
         # add the counter to our collection

data/lib/counter_culture/reconciler.rb

@@ -74,7 +74,15 @@ module CounterCulture
 
         scope = relation_class
 
-        counter_column_names = column_names || {nil => counter_cache_name}
+        counter_column_names =
+          case column_names
+          when Proc
+            column_names.call
+          when Hash
+            column_names
+          else
+            { nil => counter_cache_name }
+          end
 
         if options[:column_name]
           counter_column_names = counter_column_names.select{ |_, v| options[:column_name].to_s == v }
@@ -187,7 +195,12 @@ module CounterCulture
         # if a delta column is provided use SUM, otherwise use COUNT
         return @count_select if @count_select
         if delta_column
-          @count_select = "SUM(COALESCE(#{self_table_name}.#{delta_column},0))"
+          # cast the column as NUMERIC if it is a PG money type
+          if model.type_for_attribute(delta_column).type == :money
+            @count_select = "SUM(COALESCE(CAST(#{self_table_name}.#{delta_column} as NUMERIC),0))"
+          else
+            @count_select = "SUM(COALESCE(#{self_table_name}.#{delta_column}, 0))"
+          end
         else
           @count_select = "COUNT(#{self_table_name}.#{model.primary_key})*#{delta_magnitude}"
         end

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '2.7.0'.freeze
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -70,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
@@ -136,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
@@ -234,6 +248,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: mysql2
+  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: pg
+  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'
 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
@@ -258,11 +314,9 @@ files:
 - Rakefile
 - circle.yml
 - counter_culture.gemspec
-- 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
 - lib/counter_culture.rb
 - lib/counter_culture/counter.rb
 - lib/counter_culture/extensions.rb
@@ -270,7 +324,6 @@ 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: https://github.com/magnusvk/counter_culture
 licenses:
 - MIT

data/gemfiles/rails_4.2.gemfile

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

data/gemfiles/rails_5.1.gemfile

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

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