counter_culture 0.1.13 → 0.1.14

data/README.md

@@ -6,6 +6,7 @@ Turbo-charged counter caches for your Rails app. Huge improvements over the Rail
 * Supports counter caches through multiple levels of relations
 * Supports dynamic column names, making it possible to split up the counter cache for different types of objects
 * Executes counter updates after the commit, avoiding [deadlocks](http://mina.naguib.ca/blog/2010/11/22/postgresql-foreign-key-deadlocks.html)
+* Can keep a running count, or a running total
 
 ## Installation
 
@@ -120,6 +121,28 @@ 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.
 
+### Totaling instead of counting
+
+Instead of keeping a running count, you may want to automatically track a running total.
+In that case, the target counter will change by the value in the totaled field instead of changing by exactly 1 each time.
+Use the ```:delta_column``` option to specify that the counter should change by the value of a specific field in the counted object.
+For example, suppose the Product model table has a field named ```weight_ounces```, and you want to keep a running
+total of the weight for all the products in the Category model's ```product_weight_ounces``` field:
+
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :category
+  counter_culture :category, :column_name => 'product_weight_ounces', :delta_column => 'weight_ounces'
+end
+
+class Category < ActiveRecord::Base
+  has_many :products
+end
+```
+
+Now, the ```Category``` model will keep the counter cache in ```product_weight_ounces``` up-to-date.
+The value in the counter cache will be the sum of the ```weight_ounces``` values in each of the associated Product records.
+
 ### Dynamically over-writing affected foreign keys
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.1.13
+0.1.14

data/counter_culture.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "counter_culture"
-  s.version = "0.1.13"
+  s.version = "0.1.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Magnus von Koeller"]
-  s.date = "2013-07-22"
+  s.date = "2013-08-13"
   s.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."
   s.email = "magnus@vonkoeller.de"
   s.extra_rdoc_files = [

data/lib/counter_culture.rb

@@ -30,6 +30,7 @@ module CounterCulture
           :relation => relation.is_a?(Enumerable) ? relation : [relation],
           :counter_cache_name => (options[:column_name] || "#{name.tableize}_count"),
           :column_names => options[:column_names],
+          :delta_column => options[:delta_column],
           :foreign_key_values => options[:foreign_key_values]
         }
       end
@@ -74,7 +75,9 @@ module CounterCulture
           klass = relation_klass(hash[:relation])
 
           # we are only interested in the id and the count of related objects (that's this class itself)
-          query = klass.select("#{klass.table_name}.id, COUNT(#{self.table_name}.id) AS count")
+          query = hash[:delta_column] \
+            ? klass.select("#{klass.table_name}.id, SUM(COALESCE(#{self.table_name}.#{hash[:delta_column]},0)) AS count") \
+            : klass.select("#{klass.table_name}.id, COUNT(#{self.table_name}.id                              ) AS count")
           query = query.group("#{klass.table_name}.id")
           # respect the deleted_at column if it exists
           query = query.where("#{self.table_name}.deleted_at IS NULL") if self.column_names.include?('deleted_at')
@@ -217,7 +220,10 @@ module CounterCulture
           counter_cache_name_was = counter_cache_name_for(previous_model, hash[:counter_cache_name])
           counter_cache_name = counter_cache_name_for(self, hash[:counter_cache_name])
 
-          if send("#{first_level_relation_foreign_key(hash[:relation])}_changed?") || counter_cache_name != counter_cache_name_was
+          if send("#{first_level_relation_foreign_key(hash[:relation])}_changed?") ||
+            (hash[:delta_column] && send("#{hash[:delta_column]}_changed?")) ||
+            counter_cache_name != counter_cache_name_was
+
             # increment the counter cache of the new value
             change_counter_cache(hash.merge(:increment => true, :counter_column => counter_cache_name))
             # decrement the counter cache of the old value
@@ -234,6 +240,7 @@ module CounterCulture
     #   :relation => which relation to increment the count on, 
     #   :counter_cache_name => the column name of the counter cache
     #   :counter_column => overrides :counter_cache_name
+    #   :delta_column => override the default count delta (1) with the value of this column in the counted record
     #   :was => whether to get the current value or the old value of the
     #      first part of the relation
     def change_counter_cache(options)
@@ -245,12 +252,18 @@ module CounterCulture
       id_to_change = options[:foreign_key_values].call(id_to_change) if options[:foreign_key_values]
 
       if id_to_change && options[:counter_column]
+        delta_magnitude = if options[:delta_column]
+                            delta_attr_name = options[:was] ? "#{options[:delta_column]}_was" : options[:delta_column]
+                            self.send(delta_attr_name).to_i
+                          else
+                            1
+                          end
         execute_after_commit do
           # increment or decrement?
-          method = options[:increment] ? :increment_counter : :decrement_counter
+          delta = options[:increment] ? delta_magnitude : -delta_magnitude
 
           # do it!
-          relation_klass(options[:relation]).send(method, options[:counter_column], id_to_change)
+          relation_klass(options[:relation]).update_counters(id_to_change, options[:counter_column] => delta)
         end
       end
     end

data/spec/counter_culture_spec.rb

@@ -15,13 +15,15 @@ describe "CounterCulture" do
 
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    user.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    user.reviews.create :user_id => user.id, :product_id => product.id, :approvals => 13
     
     user.reload
     product.reload
 
     user.reviews_count.should == 1
+    user.review_approvals_count.should == 13
     product.reviews_count.should == 1
   end
 
@@ -31,14 +33,16 @@ describe "CounterCulture" do
 
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    user.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 69
     
     user.reload
     product.reload
 
     user.reviews_count.should == 1
     product.reviews_count.should == 1
+    user.review_approvals_count.should == 69
 
     review.destroy
 
@@ -46,6 +50,7 @@ describe "CounterCulture" do
     product.reload
 
     user.reviews_count.should == 0
+    user.review_approvals_count.should == 0
     product.reviews_count.should == 0
   end
 
@@ -57,8 +62,10 @@ describe "CounterCulture" do
     user1.reviews_count.should == 0
     user2.reviews_count.should == 0
     product.reviews_count.should == 0
+    user1.review_approvals_count.should == 0
+    user2.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user1.id, :product_id => product.id
+    review = Review.create :user_id => user1.id, :product_id => product.id, :approvals => 42
     
     user1.reload
     user2.reload
@@ -67,6 +74,8 @@ describe "CounterCulture" do
     user1.reviews_count.should == 1
     user2.reviews_count.should == 0
     product.reviews_count.should == 1
+    user1.review_approvals_count.should == 42
+    user2.review_approvals_count.should == 0
 
     review.user = user2
     review.save!
@@ -78,6 +87,29 @@ describe "CounterCulture" do
     user1.reviews_count.should == 0
     user2.reviews_count.should == 1
     product.reviews_count.should == 1
+    user1.review_approvals_count.should == 0
+    user2.review_approvals_count.should == 42
+
+    review.update_attribute(:approvals, 69)
+    user2.reload.review_approvals_count.should == 69
+  end
+
+  it "treats null delta column values as 0" do
+    user = User.create
+    product = Product.create
+
+    user.reviews_count.should == 0
+    product.reviews_count.should == 0
+    user.review_approvals_count.should == 0
+
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => nil
+
+    user.reload
+    product.reload
+
+    user.reviews_count.should == 1
+    user.review_approvals_count.should == 0
+    product.reviews_count.should == 1
   end
 
   it "increments second-level counter cache on create" do
@@ -88,14 +120,16 @@ describe "CounterCulture" do
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    company.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 314
     
     company.reload
     user.reload
     product.reload
 
     company.reviews_count.should == 1
+    company.review_approvals_count.should == 314
     user.reviews_count.should == 1
     product.reviews_count.should == 1
   end
@@ -108,8 +142,9 @@ describe "CounterCulture" do
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    company.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 314
     
     user.reload
     product.reload
@@ -118,6 +153,7 @@ describe "CounterCulture" do
     user.reviews_count.should == 1
     product.reviews_count.should == 1
     company.reviews_count.should == 1
+    company.review_approvals_count.should == 314
 
     review.destroy
 
@@ -128,6 +164,7 @@ describe "CounterCulture" do
     user.reviews_count.should == 0
     product.reviews_count.should == 0
     company.reviews_count.should == 0
+    company.review_approvals_count.should == 0
   end
 
   it "updates second-level counter cache on update" do
@@ -142,8 +179,10 @@ describe "CounterCulture" do
     company1.reviews_count.should == 0
     company2.reviews_count.should == 0
     product.reviews_count.should == 0
+    company1.review_approvals_count.should == 0
+    company2.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user1.id, :product_id => product.id
+    review = Review.create :user_id => user1.id, :product_id => product.id, :approvals => 69
     
     user1.reload
     user2.reload
@@ -156,6 +195,8 @@ describe "CounterCulture" do
     company1.reviews_count.should == 1
     company2.reviews_count.should == 0
     product.reviews_count.should == 1
+    company1.review_approvals_count.should == 69
+    company2.review_approvals_count.should == 0
 
     review.user = user2
     review.save!
@@ -171,6 +212,11 @@ describe "CounterCulture" do
     company1.reviews_count.should == 0
     company2.reviews_count.should == 1
     product.reviews_count.should == 1
+    company1.review_approvals_count.should == 0
+    company2.review_approvals_count.should == 69
+
+    review.update_attribute(:approvals, 42)
+    company2.reload.review_approvals_count.should == 42
   end
 
   it "increments custom counter cache column on create" do
@@ -369,11 +415,12 @@ describe "CounterCulture" do
     product = Product.create
 
     industry.reviews_count.should == 0
+    industry.review_approvals_count.should == 0
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 42
     
     industry.reload
     company.reload
@@ -381,6 +428,7 @@ describe "CounterCulture" do
     product.reload
 
     industry.reviews_count.should == 1
+    industry.review_approvals_count.should == 42
     company.reviews_count.should == 1
     user.reviews_count.should == 1
     product.reviews_count.should == 1
@@ -393,11 +441,12 @@ describe "CounterCulture" do
     product = Product.create
 
     industry.reviews_count.should == 0
+    industry.review_approvals_count.should == 0
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 42
     
     industry.reload
     company.reload
@@ -405,6 +454,7 @@ describe "CounterCulture" do
     product.reload
 
     industry.reviews_count.should == 1
+    industry.review_approvals_count.should == 42
     company.reviews_count.should == 1
     user.reviews_count.should == 1
     product.reviews_count.should == 1
@@ -417,6 +467,7 @@ describe "CounterCulture" do
     product.reload
 
     industry.reviews_count.should == 0
+    industry.review_approvals_count.should == 0
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
@@ -437,8 +488,10 @@ describe "CounterCulture" do
     company2.reviews_count.should == 0
     user1.reviews_count.should == 0
     user2.reviews_count.should == 0
+    industry1.review_approvals_count.should == 0
+    industry2.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user1.id, :product_id => product.id
+    review = Review.create :user_id => user1.id, :product_id => product.id, :approvals => 42
     
     industry1.reload
     industry2.reload
@@ -453,6 +506,8 @@ describe "CounterCulture" do
     company2.reviews_count.should == 0
     user1.reviews_count.should == 1
     user2.reviews_count.should == 0
+    industry1.review_approvals_count.should == 42
+    industry2.review_approvals_count.should == 0
 
     review.user = user2
     review.save!
@@ -470,6 +525,11 @@ describe "CounterCulture" do
     company2.reviews_count.should == 1
     user1.reviews_count.should == 0
     user2.reviews_count.should == 1
+    industry1.review_approvals_count.should == 0
+    industry2.review_approvals_count.should == 42
+
+    review.update_attribute(:approvals, 69)
+    industry2.reload.review_approvals_count.should == 69
   end
 
   it "increments third-level custom counter cache on create" do
@@ -749,28 +809,32 @@ describe "CounterCulture" do
 
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    user.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 69
     
     user.reload
     product.reload
 
     user.reviews_count.should == 1
     product.reviews_count.should == 1
+    user.review_approvals_count.should == 69
 
     user.reviews_count = 0
     product.reviews_count = 2
+    user.review_approvals_count = 7
     user.save!
     product.save!
 
     fixed = Review.counter_culture_fix_counts :skip_unsupported => true
-    fixed.length.should == 2
+    fixed.length.should == 3
 
     user.reload
     product.reload
 
     user.reviews_count.should == 1
     product.reviews_count.should == 1
+    user.review_approvals_count.should == 69
   end
 
   it "should fix where the count should go back to zero correctly" do
@@ -799,8 +863,9 @@ describe "CounterCulture" do
     company.reviews_count.should == 0
     user.reviews_count.should == 0
     product.reviews_count.should == 0
+    company.review_approvals_count.should == 0
 
-    review = Review.create :user_id => user.id, :product_id => product.id
+    review = Review.create :user_id => user.id, :product_id => product.id, :approvals => 42
     
     company.reload
     user.reload
@@ -809,8 +874,10 @@ describe "CounterCulture" do
     company.reviews_count.should == 1
     user.reviews_count.should == 1
     product.reviews_count.should == 1
+    company.review_approvals_count.should == 42
 
     company.reviews_count = 2
+    company.review_approvals_count = 7
     user.reviews_count = 3
     product.reviews_count = 4
     company.save!
@@ -825,6 +892,7 @@ describe "CounterCulture" do
     company.reviews_count.should == 1
     user.reviews_count.should == 1
     product.reviews_count.should == 1
+    company.review_approvals_count.should == 42
   end
 
   it "should fix a custom counter cache correctly" do

data/spec/models/review.rb

@@ -6,10 +6,13 @@ class Review < ActiveRecord::Base
   counter_culture :product, :column_name => 'rexiews_count'
   counter_culture :user
   counter_culture :user, :column_name => Proc.new { |model| model.review_type ? "#{model.review_type}_count" : nil }, :column_names => {"reviews.review_type = 'using'" => 'using_count', "reviews.review_type = 'tried'" => 'tried_count'}
+  counter_culture :user, :column_name => 'review_approvals_count', :delta_column => 'approvals'
   counter_culture [:user, :manages_company]
+  counter_culture [:user, :manages_company], :column_name => 'review_approvals_count', :delta_column => 'approvals'
   counter_culture [:user, :manages_company, :industry]
   counter_culture [:user, :manages_company, :industry], :column_name => 'rexiews_count'
   counter_culture [:user, :manages_company, :industry], :column_name => Proc.new { |model| model.review_type ? "#{model.review_type}_count" : nil }
+  counter_culture [:user, :manages_company, :industry], :column_name => 'review_approvals_count', :delta_column => 'approvals'
 
   after_create :update_some_text
 

data/spec/models/user.rb

@@ -5,4 +5,6 @@ class User < ActiveRecord::Base
   counter_culture :manages_company, :column_name => "managers_count"
   belongs_to :has_string_id
   counter_culture :has_string_id
+
+  has_many :reviews
 end

data/spec/schema.rb

@@ -20,6 +20,7 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer  "using_count",         :default => 0, :null => false
     t.integer  "tried_count",         :default => 0, :null => false
     t.integer  "managers_count",      :default => 0, :null => false
+    t.integer  "review_approvals_count",      :default => 0, :null => false
   end
 
   create_table "industries", :force => true do |t|
@@ -28,6 +29,7 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer  "rexiews_count",       :default => 0, :null => false
     t.integer  "using_count",         :default => 0, :null => false
     t.integer  "tried_count",         :default => 0, :null => false
+    t.integer  "review_approvals_count",      :default => 0, :null => false
   end
 
   create_table "products", :force => true do |t|
@@ -42,6 +44,7 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.string   "some_text"
     t.integer  "user_id"
     t.integer  "product_id"
+    t.integer  "approvals"
   end
 
   create_table "users", :force => true do |t|
@@ -51,6 +54,7 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer  "reviews_count",       :default => 0, :null => false
     t.integer  "using_count",         :default => 0, :null => false
     t.integer  "tried_count",         :default => 0, :null => false
+    t.integer  "review_approvals_count",      :default => 0, :null => false
     t.string   "has_string_id_id"
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -219,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3562941340638569663
+      hash: -1126156113488497245
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: