mongoid_magic_counter_cache 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8def97e3ca48082329bb91512ecb6165d46eb34
+  data.tar.gz: 557caba7f0327b1425724486bf80741d937567ef
+SHA512:
+  metadata.gz: 7fce252e2c54419f01a9abd3273b460b2e99fe08263c3881f77ebf2d54ea84f49d75c96aa443ebb66fa2b8d84c1a07d1a8db59588c0f0aa082bf246b5a228675
+  data.tar.gz: 983912dd336634be68f01544502628f985555d2a6f760d9731156beff01d56f1f3cf87787a7b2677de94f86675e11d3d69a6b9fd116dbc722e713cb5def3d758

data/.travis.yml

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

data/Gemfile

@@ -2,3 +2,6 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in mongoid_magic_counter_cache.gemspec
 gemspec
+#gem 'mongoid', '>= 4.0.0.alpha2'
+#gem 'mongoid', '2.4.6'
+#gem 'mongoid', '3.1.4'

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

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

data/lib/mongoid/magic_counter_cache.rb

@@ -1,6 +1,6 @@
 require 'mongoid'
+require 'mongoid/version'
 module Mongoid #:nodoc:
-
   # The Counter Cache will yada yada
   #
   #    class Person
@@ -41,45 +41,68 @@ module Mongoid #:nodoc:
   module MagicCounterCache
     extend ActiveSupport::Concern
 
+    module LegacyCache
+      def actual_model_name
+        model_name
+      end
+
+      def increment_association(association, counter_name, inc)
+        association.inc(counter_name, inc)
+      end
+    end
+
+    module ModernCache
+      def actual_model_name
+        model_name.name
+      end
+
+      def increment_association(association, counter_name, inc)
+        association.inc(counter_name => inc)
+      end
+    end
+
     module ClassMethods
+      include (Mongoid::VERSION.to_i >= 4) ? ModernCache : LegacyCache
 
       def counter_cache(*args, &block)
-        options = args.extract_options!
-        name    = options[:class] || args.first.to_s
+        options       = args.extract_options!
+        name          = options[:class] || args.first.to_s
+        counter_name  = get_counter_name(options)
+        condition     = options[:if]
 
-        if options[:field]
-          counter_name = "#{options[:field].to_s}"
-        else
-          counter_name = "#{model_name.demodulize.underscore}_count"
-        end
-        after_create  do |doc|
+        callback_proc = ->(doc, inc) do
+          result = condition_result(condition, doc)
+          return unless result
           if doc.embedded?
             parent = doc._parent
-            parent.inc(counter_name.to_sym, 1) if parent.respond_to? counter_name
-          else
-            relation = doc.send(name)
-            if relation && relation.class.fields.keys.include?(counter_name)
-              relation.inc(counter_name.to_sym,  1)
+            if parent.respond_to?(counter_name)
+              increment_association(parent, counter_name.to_sym, inc)
             end
-          end
-        end
-
-        after_destroy do |doc|
-          if doc.embedded?
-            parent = doc._parent
-            parent.inc(counter_name.to_sym, -1) if parent.respond_to? counter_name
           else
             relation = doc.send(name)
             if relation && relation.class.fields.keys.include?(counter_name)
-              relation.inc(counter_name.to_sym, -1)
+              increment_association(relation, counter_name.to_sym, inc)
             end
           end
         end
 
+        after_create( ->(doc) { callback_proc.call(doc,  1) })
+        after_destroy(->(doc) { callback_proc.call(doc, -1) })
+
       end
 
       alias :magic_counter_cache :counter_cache
-    end
 
+      private
+
+      def get_counter_name(options)
+        options.fetch(:field, "#{actual_model_name.demodulize.underscore}_count").to_s
+      end
+
+      def condition_result(condition, doc)
+        return true if condition.nil?
+        condition.call(doc)
+      end
+    end
   end
 end

data/lib/mongoid_magic_counter_cache/version.rb

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

data/mongoid_magic_counter_cache.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |s|
   s.email       = ["justin@justinherrick.com"]
   s.homepage    = "https://github.com/jah2488/mongoid-magic-counter-cache"
   s.summary     = %q{Setup Counter Caches in Mongoid Documents}
-  s.description = %q{A quick and easy way to add counter cache functionality to model/document associations in Mongoid}
-
+  s.description = %q{A quick and easy way to add counter cache functionality to model - document associations in Mongoid}
+  s.license     = 'MIT'
+  
   s.rubyforge_project = "mongoid_magic_counter_cache"
 
   s.files         = `git ls-files`.split("\n")

data/spec/models/article.rb

@@ -0,0 +1,9 @@
+class Article 
+  include Mongoid::Document
+
+  embeds_many :reviews
+
+  field :title
+  field :review_count, type: Integer, default: 0
+
+end

data/spec/models/comment.rb

@@ -0,0 +1,11 @@
+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

data/spec/models/post.rb

@@ -0,0 +1,9 @@
+class Post 
+  include Mongoid::Document
+
+  field :article
+  field :comment_count, :type => Integer, :default => 0
+
+  has_many :comments
+
+end

data/spec/models/review.rb

@@ -0,0 +1,10 @@
+class Review
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  embedded_in   :article
+  counter_cache :article, :if => Proc.new { |act| (act.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 associated" do
+      context "when the document is associatedi without condition" do
 
         before do
           Library.delete_all
@@ -81,6 +81,7 @@ module Mongoid
           book.foreign_publication_count.should == 1
         end
 
+
         context "when the referenced document has an embedded document" do
 
           let(:page) do
@@ -119,6 +120,7 @@ module Mongoid
         end
 
       end
+
       context "when the document is embedded" do
 
         before do
@@ -205,6 +207,135 @@ module Mongoid
           person.all_my_feels.should == person.feelings.size
         end
       end
+
+      context "when the document is associated with condition" do
+
+        before do
+          Post.delete_all
+        end
+
+        let(:post) do
+          Post.new
+        end
+
+        let(:comment) do
+          Comment.new(:is_published => true)
+        end
+
+        before do
+          post.save
+          post.comments.create(:remark => "I agree with you", :is_published => true)
+        end
+
+        it "sets the target of the relation" do
+          post.comments.first.remark.should == "I agree with you"
+        end
+
+        it "should have 1 comment for post" do
+          post.comments.size.should == 1
+        end
+
+        it "should have 1 in comment counter" do
+          post.comment_count.should == 1
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            post.comments << Comment.new(:is_published => true)
+            post.comment_count.should == post.comments.size 
+          end
+        end
+
+        it "should increase counter when new books are added" do
+          post.comments.push( comment )
+          post.comments.size.should == 2
+        end
+
+        it "should increase counter when new books are added" do
+          post.comments.push( comment )
+          post.comments.size.should == post.comment_count
+        end
+
+        it "should decrease counter when published comment is deleted" do
+          post.comments.push( comment )
+          comment.destroy
+          post.comments.size.should == 1
+        end
+
+        it "should increase counter when new books are added" do
+          post.comments.push( comment )
+          comment.destroy
+          post.comments.size.should == post.comment_count
+        end
+
+        it "shouldnot increase counter when unpublished comment is added" do
+          post.comments << Comment.new
+          post.comments.size.should == post.comment_count + 1
+        end
+
+        it "shouldnot decrease counter when unpublished comment is deleted" do
+          post.comments << Comment.new(:remark => "2nd comment")
+          post.comments << Comment.new(:remark => "3rd comment", :is_published => true)
+          Comment.where(:remark == "2nd comment").first.destroy
+          post.comment_count.should == 2
+        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
+          Review.new(:comment => "This is nice article")
+        end
+
+        before do
+          article.save
+          article.reviews.create(:comment => "This is very good article", :is_published => true)
+        end
+
+        it "should have 1 review in reviews" do
+          article.reviews.length.should == 1
+        end
+
+        it "should have correct comment" do
+          article.reviews.first.comment.should == "This is very good article"
+        end
+
+        it "should have 1 review in counter" do
+          article.review_count.should == 1
+        end
+
+        it "sets the counter cache equal to the relation count" do
+          article.reviews.length.should == article.review_count
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            article.reviews << Review.new(:is_published => true)
+            article.reviews.length.should == article.review_count
+          end
+        end
+
+        it "decreases the counter cache when records are deleted" do
+          article.reviews.all.destroy
+          article.reviews.length.should == article.review_count
+        end
+
+        it "counter should not get incremented if condition is not meet" do
+          5.times do |n|
+            article.reviews << Review.new
+          end
+          article.reviews.length.should == 6 
+          article.review_count.should == 1
+        end
+      end
     end
 
   end

metadata

@@ -1,65 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_magic_counter_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A quick and easy way to add counter cache functionality to model/document
+description: A quick and easy way to add counter cache functionality to model - document
   associations in Mongoid
 email:
 - justin@justinherrick.com
@@ -67,9 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -81,53 +74,55 @@ files:
 - lib/mongoid_magic_counter_cache/version.rb
 - mongoid_magic_counter_cache.gemspec
 - spec/models/album.rb
+- spec/models/article.rb
 - spec/models/book.rb
 - spec/models/book/foreign_publication.rb
+- spec/models/comment.rb
 - spec/models/feeling.rb
 - spec/models/library.rb
 - spec/models/page.rb
 - spec/models/person.rb
+- spec/models/post.rb
+- spec/models/review.rb
 - spec/models/song.rb
 - spec/mongoid/magic_counter_cache_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jah2488/mongoid-magic-counter-cache
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2439585169310591993
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2439585169310591993
 requirements: []
 rubyforge_project: mongoid_magic_counter_cache
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Setup Counter Caches in Mongoid Documents
 test_files:
 - spec/models/album.rb
+- spec/models/article.rb
 - spec/models/book.rb
 - spec/models/book/foreign_publication.rb
+- spec/models/comment.rb
 - spec/models/feeling.rb
 - spec/models/library.rb
 - spec/models/page.rb
 - spec/models/person.rb
+- spec/models/post.rb
+- spec/models/review.rb
 - spec/models/song.rb
 - spec/mongoid/magic_counter_cache_spec.rb
 - spec/spec_helper.rb