mongoid_magic_counter_cache 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8def97e3ca48082329bb91512ecb6165d46eb34
-  data.tar.gz: 557caba7f0327b1425724486bf80741d937567ef
+  metadata.gz: 25296ae82c14af47df70fe8096ad2244fa467048
+  data.tar.gz: 78bd144a9aa04db9793d77c00dca4d921278d7f6
 SHA512:
-  metadata.gz: 7fce252e2c54419f01a9abd3273b460b2e99fe08263c3881f77ebf2d54ea84f49d75c96aa443ebb66fa2b8d84c1a07d1a8db59588c0f0aa082bf246b5a228675
-  data.tar.gz: 983912dd336634be68f01544502628f985555d2a6f760d9731156beff01d56f1f3cf87787a7b2677de94f86675e11d3d69a6b9fd116dbc722e713cb5def3d758
+  metadata.gz: 08eb70d110aee1c08194d6edeab68721b313c2589213bce32b1cf6c2cdbb2832a1ceafa1a9b95d36647e737130cc5ffde187569ef04cb063c4f5cc6ff123be34
+  data.tar.gz: 527f217433cc05a4e1a6bfe1797c02f06336526613243f98f9dd90db47fe7f194bf9265cc52b8d4735451853ea8ed9311a33b7ec308090a057a7c1d49cb29369

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - 2.1.0
 services: mongodb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.1.1
+
+* Add :if_update option in order to allow counter to be conditionally increment/decrement counter when an update is made to a referenced/embedded object.
+
 ## v1.0.0
 
 * Remove version dependency to work with rails 4. Breaks compatibility with ruby 1.9.2 and older

data/README.md

@@ -61,13 +61,64 @@ If you do not wish to use the `model_count` naming convention, you can override
 counter_cache :library, :field => "total_amount_of_books"
 ````
 
-## TODO
 
-  1. Add additional options parameters
-  2. Simplify syntax (I.E. including MagicCounterCache will add counts for all `belongs_to` associations on a document
+### Conditional Counter
+
+If you want to maintain counter based on certain condition, then you can specify it using `:if`
+
+````rb
+class Post 
+  include Mongoid::Document
+
+  field :article
+  field :comment_count
+
+  has_many :comments
+
+end
+````
+Then in the referrenced/Embedded document, add condition for counter using `:if`
+
+````rb
+class Comment
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  belongs_to :post
+
+  field :remark
+  field :is_published, type: Boolean, default: false
+
+  counter_cache :post, :if => Proc.new { |act| (act.is_published)  }
+end
+````
+
+comment_count will get incremented / decremented only when `:if` condition returns `true`
+
+### Conditional Counter After Update
+
+In conjunction with the conditional counter, if you want to maintain counter after an update to an object, then you can specify it using `:if_update`
+
+Using same example as above, in the referrenced/Embedded document, add an additional condition for counter using `:if_update`
+
+````rb
+class Comment
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  belongs_to :post
+
+  field :remark
+  field :is_published, type: Boolean, default: false
+
+  counter_cache :post, :if => Proc.new { |act| (act.is_published)  }, :if_update => Proc.new { |act| act.changes['is_published'] }
+end
+````
+
+When a comment is saved, comment_count will get incremented / decremented if the is_published field is dirty.
 
 
 
 ## CONTRIBUTE
 
-If you'd like to contribute, feel free to fork and merge until your heart is content
+    If you'd like to contribute, feel free to fork and merge until your heart is content

data/lib/mongoid/magic-counter-cache/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module MagicCounterCache
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

data/lib/mongoid/magic_counter_cache.rb

@@ -69,10 +69,9 @@ module Mongoid #:nodoc:
         name          = options[:class] || args.first.to_s
         counter_name  = get_counter_name(options)
         condition     = options[:if]
+        update_condition = options[:if_update]
 
-        callback_proc = ->(doc, inc) do
-          result = condition_result(condition, doc)
-          return unless result
+        increment_proc = ->(doc, inc) do
           if doc.embedded?
             parent = doc._parent
             if parent.respond_to?(counter_name)
@@ -86,8 +85,22 @@ module Mongoid #:nodoc:
           end
         end
 
+        callback_proc = ->(doc, inc) do
+          result = condition_result(condition, doc)
+          return unless result
+          increment_proc.call(doc, inc)
+        end
+
+        update_callback_proc = ->(doc) do
+          return if condition.nil? || update_condition.nil? # Don't execute if there is no update condition.
+          return unless update_condition.call(doc) # Determine whether to execute update increment/decrements.
+          inc = condition.call(doc) ? 1 : -1
+          increment_proc.call(doc, inc)
+        end
+
         after_create( ->(doc) { callback_proc.call(doc,  1) })
         after_destroy(->(doc) { callback_proc.call(doc, -1) })
+        after_update( ->(doc) { update_callback_proc.call(doc) })
 
       end
 

data/lib/mongoid_magic_counter_cache/version.rb

@@ -1,3 +1,3 @@
 module MongoidMagicCounterCache
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/models/article.rb

@@ -2,8 +2,10 @@ class Article
   include Mongoid::Document
 
   embeds_many :reviews
+  embeds_many :update_reviews
 
   field :title
   field :review_count, type: Integer, default: 0
+  field :update_review_count, type: Integer, default: 0
 
 end

data/spec/models/post.rb

@@ -6,4 +6,6 @@ class Post
 
   has_many :comments
 
+  field :update_comment_count, :type => Integer, :default => 0
+  has_many :update_comments
 end

data/spec/models/update_comment.rb

@@ -0,0 +1,11 @@
+class UpdateComment
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  belongs_to :post
+
+  field :remark
+  field :is_published, type: Boolean, default: false
+
+  counter_cache :post, :if => Proc.new { |act| (act.is_published)  }, :if_update => Proc.new { |act| act.changes['is_published'] }
+end

data/spec/models/update_review.rb

@@ -0,0 +1,10 @@
+class UpdateReview
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  embedded_in   :article
+  counter_cache :article, :if => Proc.new { |act| (act.is_published)  }, :if_update => Proc.new { |act| act.changes['is_published'] }
+
+  field :comment
+  field :is_published, type: Boolean, default: false
+end

data/spec/mongoid/magic_counter_cache_spec.rb

@@ -6,7 +6,7 @@ module Mongoid
 
     describe ".counter_cache" do
 
-      context "when the document is associatedi without condition" do
+      context "when the document is associated without condition" do
 
         before do
           Library.delete_all
@@ -279,6 +279,44 @@ module Mongoid
           Comment.where(:remark == "2nd comment").first.destroy
           post.comment_count.should == 2
         end
+
+        context "if update condition" do
+          it "should not increase counter when old unpublished comment is published" do
+            new_comment = Comment.new
+            post.comments << new_comment
+            post.comments.size.should == post.comment_count + 1
+
+            new_comment.is_published.should == false
+            new_comment.is_published = true
+            new_comment.save!
+
+            post.comments.size.should == post.comment_count + 1
+          end
+
+          it "should not decrease counter when old published comment is unpublished" do
+            new_comment = Comment.new(:is_published => true)
+            post.comments << new_comment
+            post.comments.size.should == post.comment_count
+
+            new_comment.is_published.should == true
+            new_comment.is_published = false
+            new_comment.save!
+
+            post.comments.size.should == post.comment_count
+          end
+
+          it "should not modify counter when publish field is not dirty" do
+            new_comment = Comment.new
+            post.comments << new_comment
+            post.comments.size.should == post.comment_count + 1
+
+            new_comment.is_published.should == false
+            new_comment.remark = 'New Remark'
+            new_comment.save!
+
+            post.comments.size.should == post.comment_count + 1
+          end
+        end
       end
 
       context "when the document is embedded and has condition for counter" do
@@ -335,6 +373,264 @@ module Mongoid
           article.reviews.length.should == 6 
           article.review_count.should == 1
         end
+
+        context "if update condition" do
+          it "should not increase counter when old unpublished review is published" do
+            new_review = Review.new
+            article.reviews << new_review
+            article.reviews.size.should == article.review_count + 1
+
+            new_review.is_published.should == false
+            new_review.is_published = true
+            new_review.save!
+
+            article.reviews.size.should == article.review_count + 1
+          end
+
+          it "should not decrease counter when old published review is unpublished" do
+            new_review = Review.new(:is_published => true)
+            article.reviews << new_review
+            article.reviews.size.should == article.review_count
+
+            new_review.is_published.should == true
+            new_review.is_published = false
+            new_review.save!
+
+            article.reviews.size.should == article.review_count
+          end
+
+          it "should not modify counter when published field is not dirty" do
+            new_review = Review.new
+            article.reviews << new_review
+            article.reviews.size.should == article.review_count + 1
+
+            new_review.is_published.should == false
+            new_review.comment = 'New Comment'
+            new_review.save!
+
+            article.reviews.size.should == article.review_count + 1
+          end
+        end
+      end
+    end
+
+    describe ".counter_cache with if_update" do
+
+      context "when the document is associated with condition" do
+
+        before do
+          Post.delete_all
+        end
+
+        let(:post) do
+          Post.new
+        end
+
+        let(:comment) do
+          UpdateComment.new(:is_published => true)
+        end
+
+        before do
+          post.save
+          post.update_comments.create(:remark => "I agree with you", :is_published => true)
+        end
+
+        it "sets the target of the relation" do
+          post.update_comments.first.remark.should == "I agree with you"
+        end
+
+        it "should have 1 comment for post" do
+          post.update_comments.size.should == 1
+        end
+
+        it "should have 1 in comment counter" do
+          post.update_comment_count.should == 1
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            post.update_comments << UpdateComment.new(:is_published => true)
+            post.update_comment_count.should == post.update_comments.size
+          end
+        end
+
+        it "should increase counter when new books are added" do
+          post.update_comments.push( comment )
+          post.update_comments.size.should == 2
+        end
+
+        it "should increase counter when new books are added" do
+          post.update_comments.push( comment )
+          post.update_comments.size.should == post.update_comment_count
+        end
+
+        it "should decrease counter when published comment is deleted" do
+          post.update_comments.push( comment )
+          comment.destroy
+          post.update_comments.size.should == 1
+        end
+
+        it "should increase counter when new books are added" do
+          post.update_comments.push( comment )
+          comment.destroy
+          post.update_comments.size.should == post.update_comment_count
+        end
+
+        it "shouldnot increase counter when unpublished comment is added" do
+          post.update_comments << UpdateComment.new
+          post.update_comments.size.should == post.update_comment_count + 1
+        end
+
+        it "shouldnot decrease counter when unpublished comment is deleted" do
+          post.update_comments << UpdateComment.new(:remark => "2nd comment")
+          post.update_comments << UpdateComment.new(:remark => "3rd comment", :is_published => true)
+          UpdateComment.where(:remark == "2nd comment").first.destroy
+          post.update_comment_count.should == 2
+        end
+
+        context "if update condition" do
+          it "should increase counter when old unpublished comment is published" do
+            new_comment = UpdateComment.new
+            post.update_comments << new_comment
+            post.update_comments.size.should == post.update_comment_count + 1
+
+            new_comment.is_published.should == false
+            new_comment.is_published = true
+            new_comment.save!
+
+            post.update_comments.size.should == post.update_comment_count
+
+            new_comment.save! # Should not increment since is_published is not dirty.
+            post.update_comments.size.should == post.update_comment_count
+          end
+
+          it "should decrease counter when old published comment is unpublished" do
+            new_comment = UpdateComment.new(:is_published => true)
+            post.update_comments << new_comment
+            post.update_comments.size.should == post.update_comment_count
+
+            new_comment.is_published.should == true
+            new_comment.is_published = false
+            new_comment.save!
+
+            post.update_comments.size.should == post.update_comment_count + 1
+
+            new_comment.save! # Should not increment since is_published is not dirty.
+            post.update_comments.size.should == post.update_comment_count + 1
+          end
+
+          it "should not modify counter when publish field is not dirty" do
+            new_comment = UpdateComment.new
+            post.update_comments << new_comment
+            post.update_comments.size.should == post.update_comment_count + 1
+
+            new_comment.is_published.should == false
+            new_comment.remark = 'New Remark'
+            new_comment.save!
+
+            post.update_comments.size.should == post.update_comment_count + 1
+          end
+        end
+      end
+
+      context "when the document is embedded and has condition for counter" do
+
+        before do
+          Article.delete_all
+        end
+
+        let(:article) do
+          Article.new
+        end
+
+        let(:review) do
+          UpdateReview.new(:comment => "This is nice article")
+        end
+
+        before do
+          article.save
+          article.update_reviews.create(:comment => "This is very good article", :is_published => true)
+        end
+
+        it "should have 1 review in reviews" do
+          article.update_reviews.length.should == 1
+        end
+
+        it "should have correct comment" do
+          article.update_reviews.first.comment.should == "This is very good article"
+        end
+
+        it "should have 1 review in counter" do
+          article.update_review_count.should == 1
+        end
+
+        it "sets the counter cache equal to the relation count" do
+          article.update_reviews.length.should == article.update_review_count
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            article.update_reviews << UpdateReview.new(:is_published => true)
+            article.update_reviews.length.should == article.update_review_count
+          end
+        end
+
+        it "decreases the counter cache when records are deleted" do
+          article.update_reviews.all.destroy
+          article.update_reviews.length.should == article.update_review_count
+        end
+
+        it "counter should not get incremented if condition is not meet" do
+          5.times do |n|
+            article.update_reviews << UpdateReview.new
+          end
+          article.update_reviews.length.should == 6
+          article.update_review_count.should == 1
+        end
+
+        context "if update condition" do
+          it "should increase counter when old unpublished review is published" do
+            new_review = UpdateReview.new
+            article.update_reviews << new_review
+            article.update_reviews.size.should == article.update_review_count + 1
+
+            new_review.is_published.should == false
+            new_review.is_published = true
+            new_review.save!
+
+            article.update_reviews.size.should == article.update_review_count
+
+            new_review.save! # Should not increment since is_published is not dirty.
+            article.update_reviews.size.should == article.update_review_count
+          end
+
+          it "should decrease counter when old published review is unpublished" do
+            new_review = UpdateReview.new(:is_published => true)
+            article.update_reviews << new_review
+            article.update_reviews.size.should == article.update_review_count
+
+            new_review.is_published.should == true
+            new_review.is_published = false
+            new_review.save!
+
+            article.update_reviews.size.should == article.update_review_count + 1
+
+            new_review.save! # Should not decrement since is_published is not dirty.
+            article.update_reviews.size.should == article.update_review_count + 1
+          end
+
+          it "should not modify counter when published field is not dirty" do
+            new_review = UpdateReview.new
+            article.update_reviews << new_review
+            article.update_reviews.size.should == article.update_review_count + 1
+
+            new_review.is_published.should == false
+            new_review.comment = 'New Comment'
+            new_review.save!
+
+            article.update_reviews.size.should == article.update_review_count + 1
+          end
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_magic_counter_cache
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Justin Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -85,6 +85,8 @@ files:
 - spec/models/post.rb
 - spec/models/review.rb
 - spec/models/song.rb
+- spec/models/update_comment.rb
+- spec/models/update_review.rb
 - spec/mongoid/magic_counter_cache_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jah2488/mongoid-magic-counter-cache
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid_magic_counter_cache
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Setup Counter Caches in Mongoid Documents
@@ -124,5 +126,7 @@ test_files:
 - spec/models/post.rb
 - spec/models/review.rb
 - spec/models/song.rb
+- spec/models/update_comment.rb
+- spec/models/update_review.rb
 - spec/mongoid/magic_counter_cache_spec.rb
 - spec/spec_helper.rb