counter_culture 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfcc2ed5c7a746c8e7bc6c737ba4cf352f026924
-  data.tar.gz: 06fc27fd9c7c0799f71387717cf087606897df18
+  metadata.gz: 31d3e78549aeff7e69173ac1c5723b00be56ef8f
+  data.tar.gz: 997a2d03fb2b208894c80c1282ef7094241b12a2
 SHA512:
-  metadata.gz: 8f152caccc5b4cfaa49aef5a33a94234555384e1dc1ca7f8bfbe7169c15505bfd44d713015cdb32da10a1840685789782f2b8c286792da6e4e7756d7b1238039
-  data.tar.gz: ad3d4bfa9a158cafaeab6381b973f987f2380f23c965562345e6ba48d49648167e06177db0f81f28531d62079e57c29a4bf19a89a8b85aac748cf926feb493cb
+  metadata.gz: 3bac32314498b675600b72742d7cb5c317666de5d6bec07b377f8ed63b295f20ff919639136373527f725882ed03b369efb37639e0a55dce30c728614c33cd0b
+  data.tar.gz: 556109999f9a2f28dc04250e15e89e11420d3194f0b45bf580fe46fed2fbd9fe7e174a1e7705f27ad3dd9b678e07632bf0b003690794584a11cbf8e86210c179

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.1 (June 15, 2016)
+
+Improvements:
+  - Add [`:delta_magnitude` option](https://github.com/magnusvk/counter_culture#dynamic-delta-magnitude)
+
 ## 0.2.0 (April 22, 2016)
 
 Improvments:

data/README.md

@@ -101,7 +101,7 @@ Now, the ```Category``` model will keep an up-to-date counter-cache in the ```pr
 ```ruby
 class Product < ActiveRecord::Base
   belongs_to :category
-  counter_culture :category, :column_name => Proc.new {|model| "#{model.product_type}_count" }
+  counter_culture :category, :column_name => proc {|model| "#{model.product_type}_count" }
   # attribute product_type may be one of ['awesome', 'sucky']
 end
 
@@ -110,14 +110,41 @@ class Category < ActiveRecord::Base
 end
 ```
 
-Now, the ```Category``` model will keep two up-to-date counter-caches in the ```awesome_count``` and ```sucky_count``` columns of the ```categories``` table. Products with type ```'awesome'``` will affect only the ```awesome_count```, while products with type ```'sucky'``` will affect only the ```sucky_count```. This will also work with multi-level counter caches.
+### Delta Magnitude
+
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :category
+  counter_culture :category, column_name: :weight, delta_magnitude: proc { model.product_type == 'awesome' ? 2 : 1 }
+end
+
+class Category < ActiveRecord::Base
+  has_many :products
+end
+```
+
+Now the `Category` model will keep the `weight` column up to date: `awesome` products will affect it by a magnitude of 2, others by a magnitude of 1.
+
+You can also use a static multiplier as the `delta_magnitude`:
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :category
+  counter_culture :category, column_name: :weight, delta_magnitude: 3
+end
+
+class Category < ActiveRecord::Base
+  has_many :products
+end
+```
+
+Now adding a `Product` will increase the `weight` column in its `Category` by 3; deleting it will decrease it by 3.
 
 ### Conditional counter cache
 
 ```ruby
 class Product < ActiveRecord::Base
   belongs_to :category
-  counter_culture :category, :column_name => Proc.new {|model| model.special? ? 'special_count' : nil }
+  counter_culture :category, :column_name => proc {|model| model.special? ? 'special_count' : nil }
 end
 
 class Category < ActiveRecord::Base
@@ -157,7 +184,7 @@ The ```:delta_column``` option supports all numeric column types, not just ```:i
 class Product < ActiveRecord::Base
   belongs_to :category
   counter_culture :category, :foreign_key_values => 
-      Proc.new {|category_id| [category_id, Category.find_by_id(category_id).try(:parent_category).try(:id)] }
+      proc {|category_id| [category_id, Category.find_by_id(category_id).try(:parent_category).try(:id)] }
 end
 
 class Category < ActiveRecord::Base
@@ -233,7 +260,7 @@ Manually populating counter caches with dynamic column names requires additional
 class Product < ActiveRecord::Base
   belongs_to :category
   counter_culture :category, 
-      :column_name => Proc.new {|model| "#{model.product_type}_count" },
+      :column_name => proc {|model| "#{model.product_type}_count" },
       :column_names => {
           ["products.product_type = ?", 'awesome'] => 'awesome_count',
           ["products.product_type = ?", 'sucky'] => 'sucky_count'

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/counter_culture.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: counter_culture 0.2.0 ruby lib
+# stub: counter_culture 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "counter_culture"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Magnus von Koeller"]
-  s.date = "2016-04-22"
+  s.date = "2016-06-15"
   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/counter.rb

@@ -1,6 +1,6 @@
 module CounterCulture
   class Counter
-    CONFIG_OPTIONS = [ :column_names, :counter_cache_name, :delta_column, :foreign_key_values, :touch ]
+    CONFIG_OPTIONS = [ :column_names, :counter_cache_name, :delta_column, :foreign_key_values, :touch, :delta_magnitude ]
 
     attr_reader :model, :relation, *CONFIG_OPTIONS
 
@@ -13,6 +13,7 @@ module CounterCulture
       @delta_column = options[:delta_column]
       @foreign_key_values = options[:foreign_key_values]
       @touch = options.fetch(:touch, false)
+      @delta_magnitude = options[:delta_magnitude] || 1
     end
 
     # increments or decrements a counter cache
@@ -38,7 +39,7 @@ module CounterCulture
                             delta_attr_name = options[:was] ? "#{delta_column}_was" : delta_column
                             obj.send(delta_attr_name) || 0
                           else
-                            1
+                            counter_delta_magnitude_for(obj)
                           end
         obj.execute_after_commit do
           # increment or decrement?
@@ -64,6 +65,17 @@ module CounterCulture
       end
     end
 
+    # Gets the delta magnitude of the counter cache for a specific object
+    #
+    # obj: object to calculate the counter cache name for
+    def counter_delta_magnitude_for(obj)
+      if delta_magnitude.is_a?(Proc)
+        delta_magnitude.call(obj)
+      else
+        delta_magnitude
+      end
+    end
+
     # Gets the name of the counter cache for a specific object
     #
     # obj: object to calculate the counter cache name for
@@ -172,4 +184,4 @@ module CounterCulture
       prev
     end
   end
-end
+end

data/lib/counter_culture/reconciler.rb

@@ -16,10 +16,11 @@ module CounterCulture
       return false if @reconciled
 
       if options[:skip_unsupported]
-        return false if (foreign_key_values || (counter_cache_name.is_a?(Proc) && !column_names))
+        return false if (foreign_key_values || (counter_cache_name.is_a?(Proc) && !column_names) || delta_magnitude.is_a?(Proc))
       else
         raise "Fixing counter caches is not supported when using :foreign_key_values; you may skip this relation with :skip_unsupported => true" if foreign_key_values
         raise "Must provide :column_names option for relation #{relation.inspect} when :column_name is a Proc; you may skip this relation with :skip_unsupported => true" if counter_cache_name.is_a?(Proc) && !column_names
+        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
 
       # if we're provided a custom set of column names with conditions, use them; just use the
@@ -42,7 +43,7 @@ module CounterCulture
         # conditions must also be applied to the join on which we are counting
         join_clauses.each_with_index do |join,index|
           if index == join_clauses.size - 1 && where
-            join += " AND (#{model.send(:sanitize_sql_for_conditions, where)})" 
+            join += " AND (#{model.send(:sanitize_sql_for_conditions, where)})"
           end
           counts_query = counts_query.joins(join)
         end
@@ -83,7 +84,12 @@ module CounterCulture
 
     def count_select
       # if a delta column is provided use SUM, otherwise use COUNT
-      @count_select ||= delta_column ? "SUM(COALESCE(#{self_table_name}.#{delta_column},0))" : "COUNT(#{self_table_name}.#{model.primary_key})"
+      return @count_select if @count_select
+      if delta_column
+        @count_select = "SUM(COALESCE(#{self_table_name}.#{delta_column},0))"
+      else
+        @count_select = "COUNT(#{self_table_name}.#{model.primary_key})*#{delta_magnitude}"
+      end
     end
 
     def relation_class
@@ -122,4 +128,4 @@ module CounterCulture
     end
 
   end
-end
+end

data/spec/counter_culture_spec.rb

@@ -663,6 +663,66 @@ describe "CounterCulture" do
     industry2.rexiews_count.should == 1
   end
 
+  it "correctly handles dynamic delta magnitude" do
+    user = User.create
+    product = Product.create
+
+    review_heavy = Review.create(
+      :user_id => user.id,
+      :review_type => 'using',
+      :product_id => product.id,
+      :heavy => true,
+    )
+    user.reload
+    user.dynamic_delta_count.should == 2
+
+    review_light = Review.create(
+      :user_id => user.id,
+      :product_id => product.id,
+      :review_type => 'using',
+      :heavy => false,
+    )
+    user.reload
+    user.dynamic_delta_count.should == 3
+
+    review_heavy.destroy
+    user.reload
+    user.dynamic_delta_count.should == 1
+
+    review_light.destroy
+    user.reload
+    user.dynamic_delta_count.should == 0
+  end
+
+  it "correctly handles non-dynamic custom delta magnitude" do
+    user = User.create
+    product = Product.create
+
+    review1 = Review.create(
+      :user_id => user.id,
+      :review_type => 'using',
+      :product_id => product.id
+    )
+    user.reload
+    user.custom_delta_count.should == 3
+
+    review2 = Review.create(
+      :user_id => user.id,
+      :review_type => 'using',
+      :product_id => product.id
+    )
+    user.reload
+    user.custom_delta_count.should == 6
+
+    review1.destroy
+    user.reload
+    user.custom_delta_count.should == 3
+
+    review2.destroy
+    user.reload
+    user.custom_delta_count.should == 0
+  end
+
   it "increments dynamic counter cache on create" do
     user = User.create
     product = Product.create
@@ -1101,6 +1161,27 @@ describe "CounterCulture" do
     string_id.users_count.should == 2
   end
 
+  it "should fix a static delta magnitude column correctly" do
+    user = User.create
+    product = Product.create
+
+    Review.create(
+      :user_id => user.id,
+      :review_type => 'using',
+      :product_id => product.id
+    )
+
+    user.reload
+    user.custom_delta_count.should == 3
+
+    user.update_attributes(:custom_delta_count => 5)
+
+    Review.counter_culture_fix_counts(:skip_unsupported => true)
+
+    user.reload
+    user.custom_delta_count.should == 3
+  end
+
   it "should work correctly for relationships with custom names" do
     company = Company.create
     user1 = User.create :manages_company_id => company.id

data/spec/models/conditional_dependent.rb

@@ -2,6 +2,6 @@ class ConditionalDependent < ActiveRecord::Base
   belongs_to :conditional_main
 
   counter_culture :conditional_main,
-    column_name: Proc.new {|m| m.condition? ? 'conditional_dependents_count' : nil },
+    column_name: proc {|m| m.condition? ? 'conditional_dependents_count' : nil },
     column_names: { ['conditional_dependents.condition = ?', true] => 'conditional_dependents_count' }
 end

data/spec/models/product.rb

@@ -1,5 +1,6 @@
 class Product < ActiveRecord::Base
   belongs_to :category
 
-  counter_culture :category, :foreign_key_values => Proc.new {|foreign_key_value| Category.pluck(:id) }
+  counter_culture :category, :foreign_key_values => proc {|foreign_key_value| Category.pluck(:id) }
+
 end

data/spec/models/review.rb

@@ -5,14 +5,16 @@ class Review < ActiveRecord::Base
   counter_culture :product, :touch => true
   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 => proc { |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, :column_name => 'review_value_sum', :delta_column => 'value'
+  counter_culture :user, :column_name => 'dynamic_delta_count', delta_magnitude: proc {|model| model.weight }
+  counter_culture :user, :column_name => 'custom_delta_count', delta_magnitude: 3
   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 => proc { |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
@@ -20,4 +22,12 @@ class Review < ActiveRecord::Base
   def update_some_text
     update_attribute(:some_text, rand(36**12).to_s(36))
   end
+
+  def weight
+    if heavy?
+      2
+    else
+      1
+    end
+  end
 end

data/spec/models/twitter_review.rb

@@ -1,4 +1,6 @@
 class TwitterReview < Review
   counter_culture :product, column_name: 'twitter_reviews_count'
+
   counter_culture [:user, :manages_company]
+
 end

data/spec/schema.rb

@@ -57,6 +57,7 @@ ActiveRecord::Schema.define(:version => 20120522160158) do
     t.integer  "product_id"
     t.integer  "approvals"
     t.float    "value"
+    t.boolean  "heavy",               :default => false, :null => false
     t.string   "type"
     t.datetime "created_at"
     t.datetime "updated_at"
@@ -69,6 +70,8 @@ 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  "dynamic_delta_count",         :default => 0, :null => false
+    t.integer  "custom_delta_count",         :default => 0, :null => false
     t.integer  "review_approvals_count",      :default => 0, :null => false
     t.string   "has_string_id_id"
     t.float    "review_value_sum",    :default => 0.0, :null => false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: counter_culture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Magnus von Koeller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: after_commit_action