mongoid_countercache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 570f444cf6b28f85bf016728681ef70052a65d28
+  data.tar.gz: 4f5e4dd1bcdb176df1caa02b6b36b3df6870b162
+SHA512:
+  metadata.gz: 96acfd0997a317342409365038709ac04e4d0973eb5a53ccec44eb9b42ffde6cd4a520dc0d7f7edfdf10b18bcfb84bc16dbf3ea7ae7aff2d0118067e6579b3f2
+  data.tar.gz: e647b87ec1ab59ec7450e2d6a1129e432a77a09647ee634dec7c8ee65cf4058ddd9d29595ee3e80b2f439f7a739f078471e18a78d7e5deb472f80cabc2d26406

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.gems/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_counter_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Intrepidd
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# MongoidCounterCache
+
+This gem is used to maintain a cached counter of an object's children, this avoids N + 1 queries issues when doing a ``count`` in a loop.
+
+This is basically an implementation of ActiveRecord counter cache for Mongoid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_countercache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_countercache
+
+## Usage
+
+Include ``Mongoid::CounterCache`` into your embedded or referenced model :
+
+    class Comment
+      include Mongoid::Document
+      include Mongoid::CounterCache
+
+      belongs_to :post
+
+      counter_cache :post
+    end
+
+Heads up ! Be sure to declare the field in the parent model, due to dependency restrictions, it can't be added programatically without having the children model to be required first
+
+    class Post
+      has_many :comments
+
+      field :comment_count, :type => Integer, :default => 0
+    end
+
+Use the count method in the parent model :
+
+    Post.first.comment_count
+
+You can rename the field used for storing the counter
+
+    counter_cache :post, :field_name => 'comment_counter'
+
+Then :
+
+    Post.first.comment_counter
+
+## Variants
+
+Sometimes you want to keep a count but only for a subset of your document.
+
+Fortunately, mongoid_counter_cache allows to keep alternative counters :
+
+Don't forget to add in the Post class :
+
+    field :comment_count_positive, :type => Integer, :type => 0
+    field :comment_count_negative, :type => Integer, :type => 0
+
+    class Comment
+      include Mongoid::Document
+      include Mongoid::CounterCache
+
+      field :mark, :type => Integer
+
+      belongs_to :post
+
+      counter_cache :post, :variants => {
+        :positive => lambda { mark >= 8 },
+        :negative => lambda { mark <= 2 }
+      }
+    end
+
+You just have to suffix the count method to get the number of positive comments here :
+
+    Post.first.comment_count_positive
+    Post.first.comment_count_negative
+
+It's even magic ! If you update the comment so it doesn't belongs to the same counter, the counters will be updated accordingly.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mongoid_countercache.rb

@@ -0,0 +1,2 @@
+require "mongoid_countercache/version"
+require "mongoid_countercache/counter_cache"

data/lib/mongoid_countercache/counter_cache.rb

@@ -0,0 +1,48 @@
+module Mongoid
+  module CounterCache
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      # Defines a counter cache on the given relation
+      #
+      # @param [Class] relation_name The name of the parent relation on which to create the cache
+      # @param [Hash] options The options hash
+      # @option options [String, Symbol] :field_name The name of the field in the parent document
+      # @option options [Hash] :variants A hash with a variant name in key and a lambda / proc in value
+      def counter_cache(relation_name, options = {})
+        field_name = (options[:field_name] || "#{self.to_s.demodulize.underscore}_count").to_s
+
+        options[:variants].to_a.each do |key,proc|
+          variant_name = "#{field_name}_#{key.to_s.strip}"
+
+          after_create { update_parent_counter(self.send(relation_name), variant_name, 1, proc) }
+          after_destroy { update_parent_counter(self.send(relation_name), variant_name, -1, proc) }
+          after_update { update_parent_counter(self.send(relation_name), variant_name, 1, proc) }
+
+          before_update do
+            attributes = self.attributes.dup
+            self.changes.each do |change, vals|
+              self.attributes[change] = vals.first
+            end
+            update_parent_counter(self.send(relation_name), variant_name, -1, proc)
+            self.attributes = attributes
+          end
+        end
+        after_create { update_parent_counter(self.send(relation_name), field_name, 1) }
+        after_destroy { update_parent_counter(self.send(relation_name), field_name, -1) }
+      end
+    end
+
+    private
+
+    def update_parent_counter(parent, field, inc, proc = nil)
+      return unless parent && parent[field]
+      parent[field] += inc if proc.nil? || proc.bind(self).call
+      parent.save
+    end
+
+  end
+end

data/lib/mongoid_countercache/version.rb

@@ -0,0 +1,3 @@
+module MongoidCounterCache
+  VERSION = "0.0.1"
+end

data/mongoid_countercache.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_countercache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_countercache"
+  spec.version       = MongoidCounterCache::VERSION
+  spec.authors       = ["Adrien Siami"]
+  spec.email         = ["adrien@siami.fr"]
+  spec.description   = "A simple counter cache implemented for mongoid, with neat additions such as lambda evaluation"
+  spec.summary       = "A simple counter cache implemented for mongoid, with neat additions such as lambda evaluation"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mongoid', '>= 3.0.0',  '<= 4.0.0'
+  spec.add_dependency("rake")
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/models/comment.rb

@@ -0,0 +1,18 @@
+require 'mongoid'
+require 'mongoid_countercache'
+
+class Comment
+  include Mongoid::Document
+  include Mongoid::CounterCache
+
+  belongs_to :post
+
+  field :mark, :type => Integer, :default => 5
+
+  counter_cache :post, :variants => {
+    :positive => lambda { mark > 8},
+    :negative => lambda { mark < 3}
+  }
+
+  counter_cache :post, :field_name => 'custom_field_name'
+end

data/spec/models/counter_cache_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'models/post'
+require 'models/comment'
+require 'models/like'
+
+describe 'CounterCache' do
+
+  before(:each) do
+    @post = Post.new
+    @post.save
+  end
+
+  after(:each) do
+    Post.destroy_all
+    Comment.destroy_all
+  end
+
+  context 'No variants' do
+    it 'Updates the counter' do
+      @post.comments.create
+      @post.comment_count.should == 1
+      @post.custom_field_name.should == 1
+
+      @post.comments.create
+      @post.comment_count.should == 2
+      @post.custom_field_name.should == 2
+
+      @post.comments.last.destroy
+      @post.comment_count.should == 1
+      @post.custom_field_name.should == 1
+
+      @post.comments.last.destroy
+      @post.comment_count.should == 0
+      @post.custom_field_name.should == 0
+
+      @post.likes.create
+      @post.likes.create
+      @post.like_count.should == 2
+      @post.likes.last.destroy
+      @post.like_count.should == 1
+    end
+  end
+
+  context 'Variants' do
+    it 'Updates the counter' do
+      @post.comments.create(:mark => 8)
+      @post.comment_count.should == 1
+      @post.comment_count_positive == 1
+      @post.comment_count_negative == 0
+
+      @post.comments.create(:mark => 9)
+      @post.comment_count.should == 2
+      @post.comment_count_positive == 2
+      @post.comment_count_negative == 0
+
+      @post.comments.create(:mark => 1)
+      @post.comment_count.should == 3
+      @post.comment_count_positive == 2
+      @post.comment_count_negative == 1
+
+      @post.comments.last.destroy
+      @post.comment_count.should == 2
+      @post.comment_count_positive == 2
+      @post.comment_count_negative == 0
+    end
+  end
+
+  context 'Updates and variants' do
+    it 'Updates the cache after an edit' do
+      comment = @post.comments.create(:mark => 9)
+      @post.comment_count_positive.should == 1
+      @post.comment_count.should == 1
+      comment.mark = 2
+      comment.save
+      @post.reload
+      @post.comment_count_positive.should == 0
+      @post.comment_count_negative.should == 1
+      @post.comment_count.should == 1
+    end
+  end
+end

data/spec/models/like.rb

@@ -0,0 +1,10 @@
+require 'mongoid'
+
+class Like
+  include Mongoid::Document
+  include Mongoid::CounterCache
+
+  embedded_in :post
+
+  counter_cache :post
+end

data/spec/models/post.rb

@@ -0,0 +1,15 @@
+require 'mongoid'
+
+class Post
+  include Mongoid::Document
+
+  field :comment_count, :type => Integer, :default => 0
+  field :comment_count_positive, :type => Integer, :default => 0
+  field :comment_count_negative, :type => Integer, :default => 0
+  field :like_count, :type => Integer, :default => 0
+  field :custom_field_name, :type => Integer, :default => 0
+
+
+  has_many :comments
+  embeds_many :likes
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'bundler/setup'
+require 'mongoid'
+
+
+Mongoid.configure do |config|
+  config.connect_to("mongoid_counter_cache")
+end
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+
+  c.after(:all) do
+    Mongoid.purge!
+  end
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_countercache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrien Siami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: A simple counter cache implemented for mongoid, with neat additions such
+  as lambda evaluation
+email:
+- adrien@siami.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_countercache.rb
+- lib/mongoid_countercache/counter_cache.rb
+- lib/mongoid_countercache/version.rb
+- mongoid_countercache.gemspec
+- spec/models/comment.rb
+- spec/models/counter_cache_spec.rb
+- spec/models/like.rb
+- spec/models/post.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A simple counter cache implemented for mongoid, with neat additions such
+  as lambda evaluation
+test_files:
+- spec/models/comment.rb
+- spec/models/counter_cache_spec.rb
+- spec/models/like.rb
+- spec/models/post.rb
+- spec/spec_helper.rb