mongoid 0.2.5 → 0.2.6

data/.gitignore

@@ -2,4 +2,5 @@
 coverage/*
 pkg/*
 scratch_directory/*
-tmp/*
+tmp/*
+*.gem

data/History.txt

@@ -1,2 +1,7 @@
+0.2.6:
+- Adding destroy_all to document
+- Adding before and after create callbacks
+- Document#paginate now only takes a single hash as an argument
+
 0.2.5:
 - Switching pagination over to will_paginate

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/lib/mongoid.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2009 Durran Jordan
-# 
+#
 # 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
@@ -7,10 +7,10 @@
 # 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
@@ -38,8 +38,8 @@ require "mongoid/associations/has_one_association"
 require "mongoid/extensions/array/conversions"
 require "mongoid/extensions/object/conversions"
 require "mongoid/extensions"
+require "mongoid/finders"
 require "mongoid/document"
-require "mongoid/paginator"
 
 module Mongoid
 

data/lib/mongoid/document.rb

@@ -2,9 +2,7 @@ module Mongoid #:nodoc:
   class Document #:nodoc:
     include ActiveSupport::Callbacks
     include Validatable
-
-    AGGREGATE_REDUCE = "function(obj, prev) { prev.count++; }"
-    GROUP_BY_REDUCE = "function(obj, prev) { prev.group.push(obj); }"
+    extend Finders
 
     attr_reader :attributes, :parent
 
@@ -16,12 +14,6 @@ module Mongoid #:nodoc:
 
     class << self
 
-      # Get an aggregate count for the supplied group of fields and the
-      # selector that is provided.
-      def aggregate(fields, selector)
-        collection.group(fields, selector, { :count => 0 }, AGGREGATE_REDUCE)
-      end
-
       # Create an association to a parent Document.
       def belongs_to(association_name)
         add_association(:belongs_to, association_name.to_s.classify, association_name)
@@ -35,7 +27,13 @@ module Mongoid #:nodoc:
 
       # Create a new Document with the supplied attribtues, and insert it into the database.
       def create(attributes = {})
-        new(attributes).save
+        new(attributes).save(true)
+      end
+
+      # Deletes all records from the collection. Will actually call drop on the
+      # Mongo::Collection for efficiency.
+      def destroy_all
+        collection.drop
       end
 
       # Defines all the fields that are accessable on the Document
@@ -50,38 +48,6 @@ module Mongoid #:nodoc:
         end
       end
 
-      # Find all Documents in several ways.
-      # Model.find(:first, :attribute => "value")
-      # Model.find(:all, :attribute => "value")
-      def find(*args)
-        type, selector = args[0], args[1]
-        case type
-        when :all then find_all(selector[:conditions])
-        when :first then find_first(selector[:conditions])
-        else find_first(Mongo::ObjectID.from_string(type.to_s))
-        end
-      end
-
-      # Find a single Document given the passed selector, which is a Hash of attributes that
-      # must match the Document in the database exactly.
-      def find_first(selector = nil)
-        new(collection.find_one(selector))
-      end
-
-      # Find all Documents given the passed selector, which is a Hash of attributes that
-      # must match the Document in the database exactly.
-      def find_all(selector = nil)
-        collection.find(selector).collect { |doc| new(doc) }
-      end
-
-      # Find all Documents given the supplied criteria, grouped by the fields
-      # provided.
-      def group_by(fields, selector)
-        collection.group(fields, selector, { :group => [] }, GROUP_BY_REDUCE).collect do |docs|
-          group!(docs)
-        end
-      end
-
       # Create a one-to-many association between Documents.
       def has_many(association_name)
         add_association(:has_many, association_name.to_s.classify, association_name)
@@ -98,19 +64,6 @@ module Mongoid #:nodoc:
         collection.create_index(name, options)
       end
 
-      # Find all documents in paginated fashion given the supplied arguments.
-      # If no parameters are passed just default to offset 0 and limit 20.
-      def paginate(selector = {}, params = {})
-        WillPaginate::Collection.create(
-          params[:page] || 1,
-          params[:per_page] || 20,
-          0) do |pager|
-            results = collection.find(selector[:conditions], { :limit => pager.per_page, :offset => pager.offset })
-            pager.total_entries = results.count
-            pager.replace(results.collect { |doc| new(doc) })
-        end
-      end
-
     end
 
     # Get the Mongo::Collection associated with this Document.
@@ -150,12 +103,14 @@ module Mongoid #:nodoc:
     # in the object graph, it will save itself, and return self. If the
     # document is embedded within another document, or is multiple levels down
     # the tree, the root object will get saved, and return itself.
-    def save
+    def save(creating = false)
       if @parent
         @parent.save
       else
+        run_callbacks(:before_create) if creating
         run_callbacks(:before_save)
         collection.save(@attributes)
+        run_callbacks(:after_create) if creating
         run_callbacks(:after_save)
         return self
       end
@@ -186,12 +141,6 @@ module Mongoid #:nodoc:
         end
       end
 
-      # Takes the supplied raw grouping of documents and alters it to a
-      # grouping of actual document objects.
-      def group!(docs)
-        docs["group"] = docs["group"].collect { |attrs| new(attrs) }; docs
-      end
-
     end
 
     # Read from the attributes hash.

data/lib/mongoid/finders.rb

@@ -0,0 +1,60 @@
+module Mongoid #:nodoc:
+  module Finders #:nodoc:
+
+    AGGREGATE_REDUCE = "function(obj, prev) { prev.count++; }"
+    GROUP_BY_REDUCE = "function(obj, prev) { prev.group.push(obj); }"
+
+    # Get an aggregate count for the supplied group of fields and the
+    # selector that is provided.
+    def aggregate(fields, selector)
+      collection.group(fields, selector, { :count => 0 }, AGGREGATE_REDUCE)
+    end
+
+    # Find all Documents in several ways.
+    # Model.find(:first, :attribute => "value")
+    # Model.find(:all, :attribute => "value")
+    def find(*args)
+      type, selector = args[0], args[1]
+      conditions = selector[:conditions] if selector
+      case type
+      when :all then find_all(conditions)
+      when :first then find_first(conditions)
+      else find_first(Mongo::ObjectID.from_string(type.to_s))
+      end
+    end
+
+    # Find a single Document given the passed selector, which is a Hash of attributes that
+    # must match the Document in the database exactly.
+    def find_first(selector = nil)
+      new(collection.find_one(selector))
+    end
+
+    # Find all Documents given the passed selector, which is a Hash of attributes that
+    # must match the Document in the database exactly.
+    def find_all(selector = nil)
+      collection.find(selector).collect { |doc| new(doc) }
+    end
+
+    # Find all Documents given the supplied criteria, grouped by the fields
+    # provided.
+    def group_by(fields, selector)
+      collection.group(fields, selector, { :group => [] }, GROUP_BY_REDUCE).collect do |docs|
+        docs["group"] = docs["group"].collect { |attrs| new(attrs) }; docs
+      end
+    end
+
+    # Find all documents in paginated fashion given the supplied arguments.
+    # If no parameters are passed just default to offset 0 and limit 20.
+    def paginate(params = {})
+      WillPaginate::Collection.create(
+        params[:page] || 1,
+        params[:per_page] || 20,
+        0) do |pager|
+          results = collection.find(params[:conditions], { :limit => pager.per_page, :offset => pager.offset })
+          pager.total_entries = results.count
+          pager.replace(results.collect { |doc| new(doc) })
+      end
+    end
+
+  end
+end

data/mongoid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/extensions.rb",
      "lib/mongoid/extensions/array/conversions.rb",
      "lib/mongoid/extensions/object/conversions.rb",
-     "lib/mongoid/paginator.rb",
+     "lib/mongoid/finders.rb",
      "mongoid.gemspec",
      "spec/integration/mongoid/document_spec.rb",
      "spec/spec.opts",
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/object/conversions_spec.rb",
-     "spec/unit/mongoid/paginator_spec.rb"
+     "spec/unit/mongoid/finders_spec.rb"
   ]
   s.homepage = %q{http://github.com/durran/mongoid}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -59,7 +59,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/object/conversions_spec.rb",
-     "spec/unit/mongoid/paginator_spec.rb"
+     "spec/unit/mongoid/finders_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/integration/mongoid/document_spec.rb

@@ -87,7 +87,7 @@ describe Mongoid::Document do
     end
 
     it "returns paginated documents" do
-      Person.paginate({}, { :per_page => 20, :page => 2 }).length.should == 10
+      Person.paginate(:per_page => 20, :page => 2).length.should == 10
     end
 
   end

data/spec/unit/mongoid/document_spec.rb

@@ -79,6 +79,15 @@ describe Mongoid::Document do
 
   end
 
+  describe "#destroy_all" do
+
+    it "deletes all documents from the collection" do
+      @collection.expects(:drop)
+      Person.destroy_all
+    end
+
+  end
+
   describe "#fields" do
 
     before do
@@ -98,122 +107,6 @@ describe Mongoid::Document do
 
   end
 
-  describe "#find" do
-
-    before do
-      @attributes = { :document_class => "Person" }
-    end
-
-    context "when an id is passed in" do
-
-      before do
-        @id = Mongo::ObjectID.new
-      end
-
-      it "delegates to find_first" do
-        @collection.expects(:find_one).with(Mongo::ObjectID.from_string(@id.to_s)).returns(@attributes)
-        Person.find(@id.to_s)
-      end
-
-    end
-
-    context "when finding first" do
-
-      it "delegates to find_first" do
-        @collection.expects(:find_one).with(:test => "Test" ).returns(@attributes)
-        Person.find(:first, :conditions => { :test => "Test" })
-      end
-
-    end
-
-    context "when finding all" do
-
-      before do
-        @cursor = mock
-        @people = []
-      end
-
-      it "delegates to find_all" do
-        @collection.expects(:find).with(:test => "Test").returns(@cursor)
-        @cursor.expects(:collect).returns(@people)
-        Person.find(:all, :conditions => { :test => "Test" })
-      end
-
-    end
-
-  end
-
-  describe "#find_first" do
-
-    before do
-      @attributes = { :document_class => "Person" }
-    end
-
-    context "when a selector is provided" do
-
-      it "finds the first document from the collection and instantiates it" do
-        @collection.expects(:find_one).with(:test => "Test").returns(@attributes)
-        Person.find_first(:test => "Test").attributes.should == @attributes
-      end
-
-    end
-
-    context "when a selector is not provided" do
-
-      it "finds the first document from the collection and instantiates it" do
-        @collection.expects(:find_one).with(nil).returns(@attributes)
-        Person.find_first.attributes.should == @attributes
-      end
-
-    end
-
-  end
-
-  describe "#find_all" do
-
-    before do
-      @cursor = mock
-      @people = []
-    end
-
-    context "when a selector is provided" do
-
-      it "finds from the collection and instantiate objects for each returned" do
-        @collection.expects(:find).with(:test => "Test").returns(@cursor)
-        @cursor.expects(:collect).returns(@people)
-        Person.find_all(:test => "Test")
-      end
-
-    end
-
-    context "when a selector is not provided" do
-
-      it "finds from the collection and instantiate objects for each returned" do
-        @collection.expects(:find).with(nil).returns(@cursor)
-        @cursor.expects(:collect).returns(@people)
-        Person.find_all
-      end
-
-    end
-
-  end
-
-  describe "#group_by" do
-
-    before do
-      @reduce = "function(obj, prev) { prev.group.push(obj); }"
-    end
-
-    it "returns documents grouped by the supplied fields" do
-      results = [{ "title" => "Sir", "group" => [{ "title" => "Sir", "age" => 30 }] }]
-      @collection.expects(:group).with([:title], {}, { :group => [] }, @reduce).returns(results)
-      grouped = Person.group_by([:title], {})
-      people = grouped.first["group"]
-      people.first.should be_a_kind_of(Person)
-    end
-
-  end
-
   describe "#has_many" do
 
     it "adds a new Association to the collection" do
@@ -362,32 +255,6 @@ describe Mongoid::Document do
 
   end
 
-  describe "#paginate" do
-
-    before do
-      @cursor = stub(:count => 100, :collect => [])
-    end
-
-    context "when pagination parameters are passed" do
-
-      it "delegates to will paginate with the results" do
-        @collection.expects(:find).with({ :test => "Test" }, {:limit => 20, :offset => 20}).returns(@cursor)
-        Person.paginate({ :conditions => { :test => "Test" } }, { :page => 2, :per_page => 20 })
-      end
-
-    end
-
-    context "when pagination parameters are not passed" do
-
-      it "delegates to will paginate with default values" do
-        @collection.expects(:find).with({ :test => "Test" }, {:limit => 20, :offset => 0}).returns(@cursor)
-        Person.paginate(:conditions => { :test => "Test" })
-      end
-
-    end
-
-  end
-
   describe "#parent" do
 
     before do
@@ -676,5 +543,4 @@ describe Mongoid::Document do
 
   end
 
-
 end

data/spec/unit/mongoid/finders_spec.rb

@@ -0,0 +1,157 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
+
+describe Mongoid::Finders do
+
+  before do
+    @collection = mock
+    @database = stub(:collection => @collection)
+    Mongoid.stubs(:database).returns(@database)
+  end
+
+  after do
+    Person.instance_variable_set(:@collection, nil)
+  end
+
+  describe "#find" do
+
+    before do
+      @attributes = { :document_class => "Person" }
+    end
+
+    context "when an id is passed in" do
+
+      before do
+        @id = Mongo::ObjectID.new
+      end
+
+      it "delegates to find_first" do
+        @collection.expects(:find_one).with(Mongo::ObjectID.from_string(@id.to_s)).returns(@attributes)
+        Person.find(@id.to_s)
+      end
+
+    end
+
+    context "when finding first" do
+
+      it "delegates to find_first" do
+        @collection.expects(:find_one).with(:test => "Test" ).returns(@attributes)
+        Person.find(:first, :conditions => { :test => "Test" })
+      end
+
+    end
+
+    context "when finding all" do
+
+      before do
+        @cursor = mock
+        @people = []
+      end
+
+      it "delegates to find_all" do
+        @collection.expects(:find).with(:test => "Test").returns(@cursor)
+        @cursor.expects(:collect).returns(@people)
+        Person.find(:all, :conditions => { :test => "Test" })
+      end
+
+    end
+
+  end
+
+  describe "#find_first" do
+
+    before do
+      @attributes = { :document_class => "Person" }
+    end
+
+    context "when a selector is provided" do
+
+      it "finds the first document from the collection and instantiates it" do
+        @collection.expects(:find_one).with(:test => "Test").returns(@attributes)
+        Person.find_first(:test => "Test").attributes.should == @attributes
+      end
+
+    end
+
+    context "when a selector is not provided" do
+
+      it "finds the first document from the collection and instantiates it" do
+        @collection.expects(:find_one).with(nil).returns(@attributes)
+        Person.find_first.attributes.should == @attributes
+      end
+
+    end
+
+  end
+
+  describe "#find_all" do
+
+    before do
+      @cursor = mock
+      @people = []
+    end
+
+    context "when a selector is provided" do
+
+      it "finds from the collection and instantiate objects for each returned" do
+        @collection.expects(:find).with(:test => "Test").returns(@cursor)
+        @cursor.expects(:collect).returns(@people)
+        Person.find_all(:test => "Test")
+      end
+
+    end
+
+    context "when a selector is not provided" do
+
+      it "finds from the collection and instantiate objects for each returned" do
+        @collection.expects(:find).with(nil).returns(@cursor)
+        @cursor.expects(:collect).returns(@people)
+        Person.find_all
+      end
+
+    end
+
+  end
+
+  describe "#group_by" do
+
+    before do
+      @reduce = "function(obj, prev) { prev.group.push(obj); }"
+    end
+
+    it "returns documents grouped by the supplied fields" do
+      results = [{ "title" => "Sir", "group" => [{ "title" => "Sir", "age" => 30 }] }]
+      @collection.expects(:group).with([:title], {}, { :group => [] }, @reduce).returns(results)
+      grouped = Person.group_by([:title], {})
+      people = grouped.first["group"]
+      people.first.should be_a_kind_of(Person)
+    end
+
+  end
+
+  describe "#paginate" do
+
+    before do
+      @cursor = stub(:count => 100, :collect => [])
+    end
+
+    context "when pagination parameters are passed" do
+
+      it "delegates to will paginate with the results" do
+        @collection.expects(:find).with({ :test => "Test" }, {:limit => 20, :offset => 20}).returns(@cursor)
+        Person.paginate(:conditions => { :test => "Test" }, :page => 2, :per_page => 20)
+      end
+
+    end
+
+    context "when pagination parameters are not passed" do
+
+      it "delegates to will paginate with default values" do
+        @collection.expects(:find).with({ :test => "Test" }, {:limit => 20, :offset => 0}).returns(@cursor)
+        Person.paginate(:conditions => { :test => "Test" })
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Durran Jordan
@@ -56,7 +56,7 @@ files:
 - lib/mongoid/extensions.rb
 - lib/mongoid/extensions/array/conversions.rb
 - lib/mongoid/extensions/object/conversions.rb
-- lib/mongoid/paginator.rb
+- lib/mongoid/finders.rb
 - mongoid.gemspec
 - spec/integration/mongoid/document_spec.rb
 - spec/spec.opts
@@ -68,7 +68,7 @@ files:
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/object/conversions_spec.rb
-- spec/unit/mongoid/paginator_spec.rb
+- spec/unit/mongoid/finders_spec.rb
 has_rdoc: true
 homepage: http://github.com/durran/mongoid
 licenses: []
@@ -107,4 +107,4 @@ test_files:
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/object/conversions_spec.rb
-- spec/unit/mongoid/paginator_spec.rb
+- spec/unit/mongoid/finders_spec.rb

data/lib/mongoid/paginator.rb

@@ -1,22 +0,0 @@
-module Mongoid #:nodoc:
-  class Paginator #:nodoc:
-
-    attr_reader :limit, :offset
-
-    # Create the new Paginator with the supplied options. 
-    # * Will default to offset 0 if no page defined in the options.
-    # * Will default to limit 20 if no per_page defined in the options.
-    def initialize(options = {})
-      page = options[:page]
-      @limit = options[:per_page] || 20
-      @offset = page ? (page - 1) * @limit : 0
-    end
-
-    # Generate the options needed for returning the correct
-    # results given the supplied parameters
-    def options
-      { :limit => @limit, :offset => @offset }
-    end
-
-  end
-end

data/spec/unit/mongoid/paginator_spec.rb

@@ -1,74 +0,0 @@
-require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
-
-describe Mongoid::Paginator do
-
-  describe "#limit" do
-
-    context "when per_page is defined" do
-
-      before do
-        @options = { :per_page => 50 }
-        @paginator = Mongoid::Paginator.new(@options)
-      end
-
-      it "returns the per_page value" do
-        @paginator.limit.should == 50
-      end
-
-    end
-
-    context "when per_page is not defined" do
-
-      before do
-        @options = {}
-        @paginator = Mongoid::Paginator.new(@options)
-      end
-
-      it "returns the default of 20" do
-        @paginator.limit.should == 20
-      end
-
-    end
-
-  end
-
-  describe "#offset" do
-
-    context "when page is defined" do
-
-      before do
-        @options = { :page => 11 }
-        @paginator = Mongoid::Paginator.new(@options)
-      end
-
-      it "returns the page value - 1 * limit" do
-        @paginator.offset.should == 200
-      end
-
-    end
-
-    context "when page is not defined" do
-
-      before do
-        @options = {}
-        @paginator = Mongoid::Paginator.new(@options)
-      end
-
-      it "returns the default of 0" do
-        @paginator.offset.should == 0
-      end
-
-    end
-
-  end
-
-  describe "#options" do
-
-    it "returns a hash of the limit and offset" do
-      @paginator = Mongoid::Paginator.new
-      @paginator.options.should == { :limit => 20, :offset => 0 }
-    end
-
-  end
-
-end