mongoid_magic_counter_cache 0.0.1.beta

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial Release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Justin Herrick
+
+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,66 @@
+Mongoid Magic Counter Cache
+=======
+
+## DESCRIPTION
+
+Mongoid Counter Cache is a simple mongoid extension to add basic counter cache functionality to Embedded and Referenced Mongoid Documents.
+
+
+## INSTALLATION
+
+### RubyGems
+
+    $ [sudo] gem install mongoid_magic_counter_cache
+
+### GemFile
+
+    gem 'mongoid_magic_counter_cache'
+
+## USAGE
+
+First add a field to the document where you will be accessing the counter cache from.
+
+    class Library
+      include Mongoid::Document
+
+      field :name
+      field :city
+      field :book_count
+      has_many :books
+
+    end
+
+Then in the referrenced/Embedded document. Include `Mongoid::MagicCounterCache`
+
+    class Book
+      include Mongoid::Document
+      include Mongoid::MagicCounterCache
+
+      field :first
+      field :last
+
+      belongs_to    :library
+      magic_counter_cache :library
+    end
+
+
+    => @library.book_count
+    => 990
+
+### Alternative Syntax
+
+If you do not wish to use the `model_count` naming convention, you can override the defaults by specifying the `:field` parameter.
+
+    magic_counter_cache :library, :field => "total_amount_of_books"
+
+## TODO
+
+  1. Thoroughly Test embedded associations
+  2. Add additional options parameters
+  3. Simplify syntax (I.E. including MagicCounterCache will add counts for all `belongs_to` associations on a document 
+
+
+
+## CONTRIBUTE
+
+If you'd like to contribute, feel free to fork and merge until your heart is content

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/magic-counter-cache/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module MagicCounterCache
+    VERSION = "0.0.1.beta"
+  end
+end

data/lib/mongoid/magic_counter_cache.rb

@@ -0,0 +1,84 @@
+require 'mongoid'
+require 'pry'
+module Mongoid #:nodoc:
+
+  # The Counter Cache will yada yada
+  #
+  #    class Person
+  #      include Mongoid::Document
+  #
+  #      field :name
+  #      field :feeling_count
+  #      has_many :feelings
+  #    end
+  #
+  #    class Feeling
+  #      include Mongoid::Document
+  #      include Mongoid::MagicCounterCache
+  #
+  #      field :name
+  #      belongs_to    :person
+  #      counter_cache :person
+  #    end
+  #
+  # Alternative Syntax
+  #
+  #    class Person
+  #      include Mongoid::Document
+  #
+  #      field :name
+  #      field :all_my_feels
+  #      has_many :feelings
+  #    end
+  #
+  #    class Feeling
+  #      include Mongoid::Document
+  #      include Mongoid::MagicCounterCache
+  #
+  #      field :name
+  #      belongs_to    :person
+  #      counter_cache :person, :field => "all_my_feels"
+  #    end
+  module MagicCounterCache
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def counter_cache(*args, &block)
+        options = args.extract_options!
+        name    = options[:class] || args.first.to_s
+
+        if options[:field]
+          counter_name = "#{options[:field].to_s}"
+        else
+          counter_name = "#{model_name.downcase}_count"
+        end
+        after_create  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)
+            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)
+            end
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/mongoid_magic_counter_cache.rb

@@ -0,0 +1 @@
+require "mongoid/magic_counter_cache"

data/lib/mongoid_magic_counter_cache/version.rb

@@ -0,0 +1,3 @@
+module MongoidMagicCounterCache
+  VERSION = "0.0.1.beta"
+end

data/mongoid_magic_counter_cache.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid/magic-counter-cache/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_magic_counter_cache"
+  s.version     = Mongoid::MagicCounterCache::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Justin Herrick"]
+  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.rubyforge_project = "mongoid_magic_counter_cache"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("mongoid", "2.2.6") 
+  s.add_dependency("rake")
+  s.add_dependency("bson_ext","~> 1.5")
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/spec/models/album.rb

@@ -0,0 +1,10 @@
+class Album
+  include Mongoid::Document
+
+  embeds_many :songs
+
+  field :title
+  field :genre
+  field :song_count, type: Integer, default: 0
+
+end

data/spec/models/book.rb

@@ -0,0 +1,12 @@
+class Book
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  belongs_to :library
+  embeds_many :pages
+
+  field :title
+  field :page_count, :type => Integer, :default => 0
+
+  counter_cache :library
+end

data/spec/models/feeling.rb

@@ -0,0 +1,7 @@
+class Feeling
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  belongs_to :person
+  counter_cache :person, :field => "all_my_feels"
+end

data/spec/models/library.rb

@@ -0,0 +1,9 @@
+class Library
+  include Mongoid::Document
+
+  field :title
+  field :book_count, :type => Integer, :default => 0
+
+  has_many :books
+
+end

data/spec/models/page.rb

@@ -0,0 +1,9 @@
+class Page
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+
+  embedded_in :book
+  counter_cache :book, :type => Integer, :default => 0
+
+  field :title
+end

data/spec/models/person.rb

@@ -0,0 +1,7 @@
+class Person
+  include Mongoid::Document
+  has_many :feelings
+
+  field :name
+  field :all_my_feels
+end

data/spec/models/song.rb

@@ -0,0 +1,8 @@
+class Song
+  include Mongoid::Document
+  include Mongoid::MagicCounterCache
+  embedded_in   :album
+  counter_cache :album
+  field :title
+  field :track_length
+end

data/spec/mongoid/magic_counter_cache_spec.rb

@@ -0,0 +1,202 @@
+#encoding: utf-8
+require "spec_helper"
+
+module Mongoid
+  describe MagicCounterCache do
+
+    describe ".counter_cache" do
+
+      context "when the document is associated" do
+
+        before do
+          Library.delete_all
+        end
+
+        let(:library) do
+          Library.new
+        end
+
+        let(:book) do
+          Book.new
+        end
+
+        before do
+          library.save
+          library.books.create(:title => "War and Peace")
+        end
+
+        it "sets the target of the relation" do
+          library.books.first.title.should == "War and Peace"
+        end
+
+        it "should have 1 book in books" do
+          library.books.size.should == 1
+        end
+
+        it "should have 1 song in counter" do
+          library.book_count.should == 1
+        end
+
+        it "should have book_count and relation count equal" do
+          library.book_count.should == library.books.size
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            library.books << Book.new
+            library.book_count.should == library.books.size
+          end
+        end
+
+        it "should increase counter when new books are added" do
+          library.books.push( book )
+          library.books.size.should == 2
+        end
+
+        it "should increase counter when new books are added" do
+          library.books.push( book )
+          library.books.size.should == library.book_count
+        end
+
+        it "should increase counter when new books are added" do
+          library.books.push( book )
+          book.destroy
+          library.books.size.should == 1
+        end
+
+        it "should increase counter when new books are added" do
+          library.books.push( book )
+          book.destroy
+          library.books.size.should == library.book_count
+        end
+
+        it "decreases the counter cache when records are deleted" do
+          library.book_count.should == library.books.entries.size
+        end
+
+        context "when the referenced document has an embedded document" do
+
+          let(:page) do
+            Page.new
+          end
+
+          before do
+            book.pages.create(:title => "it was a long and stormy night")
+            library.books << book
+          end
+
+          it "should have 1 page in pages" do
+            book.pages.size.should == 1
+          end 
+
+          it "should be accessible through parent" do
+            library.books.last.pages.size.should == 1
+          end
+
+          it "should have 1 page in counter" do
+            book.pages.length.should == book.page_count
+          end
+
+          it "should increase with additional pages" do
+            20.times do |n|
+              book.pages.create()
+              book.pages.length.should == book.page_count
+            end
+          end
+
+          it "should decrease the counter when records are deleted" do
+            book.pages.all.destroy
+            book.pages.length.should == book.page_count
+          end
+        end
+
+      end
+      context "when the document is embedded" do
+
+        before do
+          Album.delete_all
+        end
+
+        let(:album) do
+          Album.new
+        end
+
+        let(:song) do
+          Song.new(:title => "love song")
+        end
+
+        before do
+          album.songs.create(:title => "create you a song")
+        end
+
+        it "should have 1 song in songs" do
+          album.songs.length.should == 1
+        end
+
+        it "should have correct title" do
+          album.songs.first.title.should == "create you a song"
+        end
+
+        it "should have 1 song in counter" do
+          album.song_count.should == 1
+        end
+
+        it "sets the counter cache equal to the relation count" do
+          album.songs.length.should == album.song_count
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            album.songs << Song.new
+            album.songs.length.should == album.song_count
+          end
+        end
+        it "decreases the counter cache when records are deleted" do
+          album.songs.all.destroy
+          album.songs.length.should == album.song_count
+        end
+      end
+
+      context "when the field is specified directly in an associated context" do
+
+        before do
+          Person.delete_all
+        end
+
+        let(:person) do
+          Person.new
+        end
+
+        let(:feeling) do
+          Feeling.new
+        end
+
+        before do
+          person.save
+          person.feelings.create
+        end
+
+        it "should have 1 feeling in feelings" do
+          person.feelings.size.should == 1
+        end
+
+        it "should have 1 feeling in counter" do
+         person.all_my_feels.should == person.feelings.size
+        end
+
+        it "sets the counter cache equal to the relation count on addition" do
+          5.times do |n|
+            person.feelings.create
+            person.feelings.size.should == person.all_my_feels
+          end
+        end
+        it "decreases the counter cache when records are deleted" do
+          person.feelings.push( feeling )
+          feeling.destroy
+          person.all_my_feels.should == person.feelings.size
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "rubygems"
+require "mongoid"
+require "bundler/setup"
+require "rspec"
+require "pry"
+require File.expand_path("../../lib/mongoid_magic_counter_cache", __FILE__)
+
+Mongoid.configure do |config|
+    name = "mongoid_magic_counter_cache_test"
+    config.master = Mongo::Connection.new.db(name)
+end
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+RSpec.configure do |c|
+    c.mock_with :rspec
+    c.before(:each) do
+          Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+    end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_magic_counter_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta
+  prerelease: 6
+platform: ruby
+authors:
+- Justin Herrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70241193037560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70241193037560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70241193035840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70241193035840
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70241193033260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70241193033260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70241193031820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70241193031820
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70241193029900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70241193029900
+description: A quick and easy way to add counter cache functionality to model/document
+  associations in Mongoid
+email:
+- justin@justinherrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid/.DS_Store
+- lib/mongoid/magic-counter-cache/version.rb
+- lib/mongoid/magic_counter_cache.rb
+- lib/mongoid_magic_counter_cache.rb
+- lib/mongoid_magic_counter_cache/version.rb
+- mongoid_magic_counter_cache.gemspec
+- spec/models/album.rb
+- spec/models/book.rb
+- spec/models/feeling.rb
+- spec/models/library.rb
+- spec/models/page.rb
+- spec/models/person.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: []
+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: 3833120303120061916
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: mongoid_magic_counter_cache
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Setup Counter Caches in Mongoid Documents
+test_files:
+- spec/models/album.rb
+- spec/models/book.rb
+- spec/models/feeling.rb
+- spec/models/library.rb
+- spec/models/page.rb
+- spec/models/person.rb
+- spec/models/song.rb
+- spec/mongoid/magic_counter_cache_spec.rb
+- spec/spec_helper.rb