counter_culture 3.0.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e21168dbc07960cbb457996e275fe225426b9e96cd4b78a7dcd65ac13a0e006
-  data.tar.gz: 655b861dbd102fd40c0be44fc9f12c5a3a8b21682a8951597c7b4d2bcde3ea5e
+  metadata.gz: 8d06abb7c02b9c0bd0e9536c04d7ba1f753c944c018fe6f14bc156567567c46c
+  data.tar.gz: dbda06f156910a7f7a807ecee156cfb36b0ec88a97ecd35cd120be564df571bd
 SHA512:
-  metadata.gz: 42ae36d35f8ad486b25477a89e87477a40909fb08ffd627c6441c2c4ce17ef038c5f92f3514bd2cc993fd01996f3e49ab2470481f2ab778dc620c2aa7f65d59c
-  data.tar.gz: 48ad4871eb41b4a97e5f53f41a671e4fef455fa2c70d475002de69bda1db8b1e8cc4af91b0c251d6ac1a4fba961ba5ab3eb2e821f9e9c8735a577728f7270338
+  metadata.gz: 2b95de040d7c944ba43bf103157144bb5cca3bc1ca309f1082189e5015b46f1fd01615296794f3cc8a27f5e0f1b499fe0744ac41e0438f21986926a4b8c38e69
+  data.tar.gz: 9889708057fbfa61c14291124e4c71bb8f0c8f67cb9bdf24f57865cff8fc27fae5f98576ff5f99d0ada07961a4781b9e943ef0679ce30f55d7e567a1d025f2eb

data/.circleci/config.yml

@@ -0,0 +1,66 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@1.4
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+      rails-version:
+        type: string
+      database:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+      - image: cimg/postgres:14.1
+      - image: cimg/mysql:8.0
+    steps:
+      - checkout
+      - run:
+          name: bundle update
+          command: BUNDLE_GEMFILE=gemfiles/rails_<< parameters.rails-version >>.gemfile bundle update
+      - run:
+          name: install dockerize
+          command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+          environment:
+            DOCKERIZE_VERSION: v0.3.0
+      - run:
+          name: Wait for Postgres
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+      - run:
+          name: Wait for MySQL
+          command: dockerize -wait tcp://localhost:3306 -timeout 1m
+      - run:
+          name: rspec
+          command: DB=<< parameters.database >> rspec spec
+
+workflows:
+  test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["2.6", "2.7", "3.0"]
+              rails-version: ["5.2", "6.0", "6.1", "7.0"]
+              database: ["postgresql", "sqlite3", "mysql2"]
+            exclude:
+              - ruby-version: "3.0"
+                rails-version: "5.2"
+                database: "postgresql"
+              - ruby-version: "3.0"
+                rails-version: "5.2"
+                database: "sqlite3"
+              - ruby-version: "3.0"
+                rails-version: "5.2"
+                database: "mysql2"
+              - ruby-version: "2.6"
+                rails-version: "7.0"
+                database: "postgresql"
+              - ruby-version: "2.6"
+                rails-version: "7.0"
+                database: "sqlite3"
+              - ruby-version: "2.6"
+                rails-version: "7.0"
+                database: "mysql2"

data/Appraisals

@@ -2,30 +2,9 @@
   5.2
   6.0
   6.1
+  7.0
 ].each do |rails_version|
-  gem_rails_version = Gem::Version.new(rails_version)
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5.0') &&
-      gem_rails_version >= Gem::Version.new('6.0.0.beta')
-
-    # Rails 6 requires Ruby >= 2.5
-    next
-  end
   appraise "rails-#{rails_version}" do
     gem 'rails', "~> #{rails_version}.0"
-
-    if gem_rails_version < Gem::Version.new('5.0')
-      gem 'pg',  '~> 0.15'
-    else
-      gem 'pg'
-    end
-    gem 'mysql2'
-    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 @@
+## 3.2.1 (February 24, 2022)
+
+Bugfixes:
+  - Fix `counter_culture_fix_counts` when passing it symbols for column names (#341)
+
+## 3.2.0 (January 24, 2022)
+
+Improvements:
+  - Allow specifiying `polymorphic_classes` to avoid a potentially expensive
+    `DISTINCT` query when calling `counter_culture_fix_counts` (#336)
+
+Bugfixes:
+  - Fix primary key name for enumerable relations (#337)
+
+## 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:

data/README.md

@@ -1,4 +1,4 @@
-# counter_culture [![Build Status](https://app.travis-ci.com/magnusvk/counter_culture.svg?branch=master)](https://app.travis-ci.com/magnusvk/counter_culture)
+# counter_culture [![Build Status](https://circleci.com/gh/magnusvk/counter_culture/tree/master.svg?style=svg)](https://circleci.com/gh/magnusvk/counter_culture/tree/master)
 
 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.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.
+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.
 
 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.
 ```
@@ -376,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
@@ -386,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
 ```
 
@@ -456,6 +459,17 @@ end
 
 counter_culture now supports polymorphic associations of one level only.
 
+To discover which models need to be updated via `counter_culture_fix_counts`,
+counter_culture performs a `DISTINCT` query on the polymorphic relationship.
+This query can be expensive so we therefore offer the option
+(`polymorphic_classes`) to specify the models' counts that should be corrected:
+
+```ruby
+Image.counter_culture_fix_counts(polymorphic_classes: Product)
+# or
+Image.counter_culture_fix_counts(polymorphic_classes: [Product, Employee])
+```
+
 ## Contributing to counter_culture
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/counter_culture.gemspec

@@ -38,9 +38,12 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rdoc', ">= 6.3.1"
   spec.add_development_dependency 'rspec', '~> 3.0'
   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,6 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3"
 gem "rails", "~> 5.2.0"
-gem "pg"
-gem "mysql2"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

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

data/gemfiles/rails_6.1.gemfile

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

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/lib/counter_culture/counter.rb

@@ -163,8 +163,9 @@ module CounterCulture
     #   pass true to get the past value, false or nothing to get the
     #   current value
     def foreign_key_value(obj, relation, was = false)
+      original_relation = relation
       relation = relation.is_a?(Enumerable) ? relation.dup : [relation]
-      first_relation = relation.first
+      
       if was
         first = relation.shift
         foreign_key_value = attribute_was(obj, relation_foreign_key(first))
@@ -180,7 +181,8 @@ module CounterCulture
       while !value.nil? && relation.size > 0
         value = value.send(relation.shift)
       end
-      return value.try(relation_primary_key(first_relation, source: obj, was: was).try(:to_sym))
+
+      return value.try(relation_primary_key(original_relation, source: obj, was: was).try(:to_sym))
     end
 
     # gets the reflect object on the given relation

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
@@ -60,7 +71,8 @@ module CounterCulture
       # options:
       #   { :exclude => list of relations to skip when fixing counts,
       #     :only => only these relations will have their counts fixed,
-      #     :column_name => only this column will have its count fixed }
+      #     :column_name => only this column will have its count fixed
+      #     :polymorphic_classes => specify the class(es) to update in polymorphic associations }
       # 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,
@@ -80,7 +92,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 column_name finish skip_unsupported start touch verbose where)
+          reconciler_options = %i(batch_size column_name finish skip_unsupported start touch verbose where polymorphic_classes)
 
           reconciler = CounterCulture::Reconciler.new(counter, options.slice(*reconciler_options))
           reconciler.reconcile!

data/lib/counter_culture/reconciler.rb

@@ -28,7 +28,7 @@ module CounterCulture
         raise "Fixing counter caches is not supported when :delta_magnitude is a Proc; you may skip this relation with :skip_unsupported => true" if delta_magnitude.is_a?(Proc)
       end
 
-      associated_model_classes.each do |associated_model_class|
+      Array(associated_model_classes).each do |associated_model_class|
         Reconciliation.new(counter, changes, options, associated_model_class).perform
       end
 
@@ -39,7 +39,7 @@ module CounterCulture
 
     def associated_model_classes
       if polymorphic?
-        polymorphic_associated_model_classes
+        options[:polymorphic_classes].presence || polymorphic_associated_model_classes
       else
         [associated_model_class]
       end
@@ -74,10 +74,20 @@ 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 }
+          counter_column_names = counter_column_names.select do |_, v|
+            options[:column_name].to_s == v.to_s
+          end
         end
 
         # iterate over all the possible counter cache column names

data/lib/counter_culture/version.rb

@@ -1,3 +1,3 @@
 module CounterCulture
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -182,16 +182,16 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -248,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
@@ -260,10 +302,10 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".circleci/config.yml"
 - ".document"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -275,6 +317,7 @@ files:
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/counter_culture.rb
 - lib/counter_culture/counter.rb
 - lib/counter_culture/extensions.rb

data/.travis.yml

@@ -1,50 +0,0 @@
-dist: focal
-language: ruby
-cache:
-  directories:
-     - ~/.rvm/gems
-services:
-  - postgresql
-  - mysql
-branches:
-  only:
-  - master
-addons:
-  postgresql: '12'
-  apt:
-    packages:
-      - postgresql-12
-      - postgresql-client-12
-rvm:
-  - "2.6.8"
-  - "2.7.4"
-  - "3.0.2"
-gemfile:
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_6.1.gemfile
-matrix:
-  exclude:
-    - 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:
-  - 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:
-  - 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;'
-script: TRAVIS=true bundle exec rake spec