mongoid 0.4.4 → 0.4.5

data/README.textile

@@ -98,7 +98,7 @@ Old School:
 New School:
 
 <pre>
-  Criteria.new.select(:title => "Sir").only(:first_name, :last_name).skip(10).limit(10).execute
+  Person.select(:first_name, :last_name).where(:title => "Sir").skip(10).limit(10).execute
   Criteria.translate(:conditions => { :title => "Sir" }).execute
 </pre>
 

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.4.5

data/lib/mongoid.rb

@@ -43,10 +43,6 @@ module Mongoid
   # Raised when the database connection has not been set up.
   class NoConnectionError < RuntimeError; end
 
-  # Raised when :document_class is not provided in the attributes
-  # hash when creating a new Document
-  class ClassNotProvidedError < RuntimeError; end
-
   # Raised when an association is defined on the class, but the
   # attribute in the hash is not an Array or Hash.
   class TypeMismatchError < RuntimeError; end

data/lib/mongoid/criteria.rb

@@ -150,25 +150,6 @@ module Mongoid #:nodoc:
       @options[:limit] = value; self
     end
 
-    # Adds a criterion to the +Criteria+ that specifies values that must
-    # be matched in order to return results. This is similar to a SQL "WHERE"
-    # clause. This is the actual selector that will be provided to MongoDB, 
-    # similar to the Javascript object that is used when performing a find()
-    # in the MongoDB console.
-    #
-    # Options:
-    #
-    # selectior: A +Hash+ that must match the attributes of the +Document+.
-    #
-    # Example:
-    #
-    # <tt>criteria.select(:field1 => "value1", :field2 => 15)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def select(selector = {})
-      @selector = selector; self
-    end
-
     # Adds a criterion to the +Criteria+ that specifies values where none
     # should match in order to return results. This is similar to an SQL "NOT IN"
     # clause. The MongoDB conditional operator that will be used is "$nin".
@@ -211,14 +192,14 @@ module Mongoid #:nodoc:
     #
     # Options:
     #
-    # params: A list of field names to retrict the returned fields to.
+    # args: A list of field names to retrict the returned fields to.
     #
     # Example:
     #
-    # <tt>criteria.only(:field1, :field2, :field3)</tt>
+    # <tt>criteria.select(:field1, :field2, :field3)</tt>
     #
     # Returns: <tt>self</tt>
-    def only(*args)
+    def select(*args)
       @options[:fields] = args.flatten; self
     end
 
@@ -262,7 +243,26 @@ module Mongoid #:nodoc:
     def self.translate(*args)
       type, params = args[0], args[1] || {}
       return new(:first).id(type.to_s) if type.is_a?(String)
-      return new(type).select(params.delete(:conditions)).extras(params)
+      return new(type).where(params.delete(:conditions)).extras(params)
+    end
+
+    # Adds a criterion to the +Criteria+ that specifies values that must
+    # be matched in order to return results. This is similar to a SQL "WHERE"
+    # clause. This is the actual selector that will be provided to MongoDB, 
+    # similar to the Javascript object that is used when performing a find()
+    # in the MongoDB console.
+    #
+    # Options:
+    #
+    # selectior: A +Hash+ that must match the attributes of the +Document+.
+    #
+    # Example:
+    #
+    # <tt>criteria.where(:field1 => "value1", :field2 => 15)</tt>
+    #
+    # Returns: <tt>self</tt>
+    def where(selector = {})
+      @selector = selector; self
     end
 
   end

data/lib/mongoid/document.rb

@@ -26,7 +26,24 @@ module Mongoid #:nodoc:
         collection.group(fields, selector, { :count => 0 }, AGGREGATE_REDUCE)
       end
 
-      # Adds the association back to the parent document.
+      # Adds the association back to the parent document. This macro is
+      # necessary to set the references from the child back to the parent
+      # document. If a child does not define this association calling
+      # persistence methods on the child object will cause a save to fail.
+      #
+      # Options:
+      #
+      # association_name: A +Symbol+ that matches the name of the parent class.
+      #
+      # Example:
+      #
+      #   class Person < Mongoid::Document
+      #     has_many :addresses
+      #   end
+      #
+      #   class Address < Mongoid::Document
+      #     belongs_to :person
+      #   end
       def belongs_to(association_name)
         @embedded = true
         add_association(:belongs_to, association_name.to_s.classify, association_name)
@@ -42,6 +59,15 @@ module Mongoid #:nodoc:
       # Defines all the fields that are accessable on the Document
       # For each field that is defined, a getter and setter will be
       # added as an instance method to the Document.
+      #
+      # Options:
+      #
+      # name: The name of the field, as a +Symbol+.
+      # options: A +Hash+ of options to supply to the +Field+.
+      #
+      # Example:
+      #
+      # <tt>field :score, :default => 0</tt>
       def field(name, options = {})
         @fields ||= {}
         @fields[name] = Field.new(name, options)
@@ -54,9 +80,19 @@ module Mongoid #:nodoc:
         @fields
       end
 
-      # Find all Documents in several ways.
-      # Model.find(:first, :attribute => "value")
-      # Model.find(:all, :attribute => "value")
+      # Find a +Document+ in several different ways.
+      #
+      # If a +String+ is provided, it will be assumed that it is a
+      # representation of a Mongo::ObjectID and will attempt to find a single
+      # +Document+ based on that id. If a +Symbol+ and +Hash+ is provided then
+      # it will attempt to find either a single +Document+ or multiples based
+      # on the conditions provided and the first parameter.
+      #
+      # <tt>Person.find(:first, :conditions => { :attribute => "value" })</tt>
+      #
+      # <tt>Person.find(:all, :conditions => { :attribute => "value" })</tt>
+      #
+      # <tt>Person.find(Mongo::ObjectID.new.to_s)</tt>
       def find(*args)
         Criteria.translate(*args).execute(self)
       end
@@ -82,7 +118,23 @@ module Mongoid #:nodoc:
         end
       end
 
-      # Create a one-to-many association between Documents.
+      # Adds the association from a parent document to its children. The name
+      # of the association needs to be a pluralized form of the child class
+      # name.
+      #
+      # Options:
+      #
+      # association_name: A +Symbol+ that is the plural child class name.
+      #
+      # Example:
+      #
+      #   class Person < Mongoid::Document
+      #     has_many :addresses
+      #   end
+      #
+      #   class Address < Mongoid::Document
+      #     belongs_to :person
+      #   end
       def has_many(association_name)
         add_association(:has_many, association_name.to_s.classify, association_name)
       end
@@ -127,6 +179,23 @@ module Mongoid #:nodoc:
         end
       end
 
+      # Entry point for creating a new criteria from a Document. This will
+      # instantiate a new +Criteria+ object with the supplied select criterion
+      # already added to it.
+      #
+      # Options:
+      #
+      # args: A list of field names to retrict the returned fields to.
+      #
+      # Example:
+      #
+      # <tt>Person.select(:field1, :field2, :field3)</tt>
+      #
+      # Returns: <tt>Criteria</tt>
+      def select(*args)
+        Criteria.new(:all).select(*args)
+      end
+
     end
 
     # Get the Mongo::Collection associated with this Document.
@@ -200,7 +269,8 @@ module Mongoid #:nodoc:
 
     # Write to the attributes hash.
     def write_attribute(name, value)
-      @attributes[name.to_sym] = value
+      symbol = name.to_sym
+      @attributes[name.to_sym] = fields[symbol].value(value)
     end
 
   end

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.4.4"
+  s.version = "0.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2009-10-17}
+  s.date = %q{2009-10-18}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"

data/spec/integration/mongoid/document_spec.rb

@@ -28,7 +28,7 @@ describe Mongoid::Document do
   describe "#find" do
 
     before do
-      @person = Person.create(:title => "Test", :document_class => "Person")
+      @person = Person.create(:title => "Test")
     end
 
     context "finding all documents" do
@@ -64,7 +64,7 @@ describe Mongoid::Document do
 
     before do
       30.times do |num|
-        Person.create(:title => "Sir", :age => num, :document_class => "Person")
+        Person.create(:title => "Sir", :age => num)
       end
     end
 
@@ -82,7 +82,7 @@ describe Mongoid::Document do
 
     before do
       30.times do |num|
-        Person.create(:title => "Test-#{num}", :document_class => "Person")
+        Person.create(:title => "Test-#{num}")
       end
     end
 

data/spec/unit/mongoid/associations/has_many_association_spec.rb

@@ -6,8 +6,8 @@ describe Mongoid::Associations::HasManyAssociation do
     @first_id = Mongo::ObjectID.new
     @second_id = Mongo::ObjectID.new
     @attributes = { :addresses => [
-      { :_id => @first_id, :street => "Street 1", :document_class => "Address" },
-      { :_id => @second_id, :street => "Street 2", :document_class => "Address" } ] }
+      { :_id => @first_id, :street => "Street 1" },
+      { :_id => @second_id, :street => "Street 2" } ] }
     @document = stub(:attributes => @attributes)
   end
 
@@ -88,14 +88,14 @@ describe Mongoid::Associations::HasManyAssociation do
     end
 
     it "adds a new document to the array with the suppied parameters" do
-      @association.build({ :street => "Street 1", :document_class => "Address" })
+      @association.build({ :street => "Street 1" })
       @association.length.should == 3
       @association[2].should be_a_kind_of(Address)
       @association[2].street.should == "Street 1"
     end
 
     it "returns the newly built object in the association" do
-      address = @association.build({ :street => "Yet Another", :document_class => "Address" })
+      address = @association.build({ :street => "Yet Another" })
       address.should be_a_kind_of(Address)
       address.street.should == "Yet Another"
     end

data/spec/unit/mongoid/criteria_spec.rb

@@ -127,19 +127,6 @@ describe Mongoid::Criteria do
 
   end
 
-  describe "#select" do
-
-    it "adds the clause to the selector" do
-      @criteria.select(:title => "Title", :text => "Text")
-      @criteria.selector.should == { :title => "Title", :text => "Text" }
-    end
-
-    it "returns self" do
-      @criteria.select.should == @criteria
-    end
-
-  end
-
   describe "#not_in" do
 
     it "adds the exclusion to the selector" do
@@ -170,15 +157,15 @@ describe Mongoid::Criteria do
 
   end
 
-  describe "#only" do
+  describe "#select" do
 
     it "adds the options for limiting by fields" do
-      @criteria.only(:title, :text)
+      @criteria.select(:title, :text)
       @criteria.options.should == { :fields => [ :title, :text ] }
     end
 
     it "returns self" do
-      @criteria.only.should == @criteria
+      @criteria.select.should == @criteria
     end
 
   end
@@ -288,4 +275,17 @@ describe Mongoid::Criteria do
 
   end
 
+  describe "#where" do
+
+    it "adds the clause to the selector" do
+      @criteria.where(:title => "Title", :text => "Text")
+      @criteria.selector.should == { :title => "Title", :text => "Text" }
+    end
+
+    it "returns self" do
+      @criteria.where.should == @criteria
+    end
+
+  end
+
 end

data/spec/unit/mongoid/document_spec.rb

@@ -136,7 +136,7 @@ describe Mongoid::Document do
   describe "#find" do
 
     before do
-      @attributes = { :document_class => "Person" }
+      @attributes = {}
       @criteria = mock
     end
 
@@ -198,7 +198,7 @@ describe Mongoid::Document do
   describe "#first" do
 
     before do
-      @attributes = { :document_class => "Person" }
+      @attributes = {}
     end
 
     context "when a selector is provided" do
@@ -259,13 +259,13 @@ describe Mongoid::Document do
       before do
         @attributes = { :title => "Sir",
           :addresses => [
-            { :street => "Street 1", :document_class => "Address" },
-            { :street => "Street 2", :document_class => "Address" } ] }
+            { :street => "Street 1" },
+            { :street => "Street 2" } ] }
         @person = Person.new(@attributes)
       end
 
       it "sets the attributes for the association" do
-        address = Address.new(:street => "New Street", :document_class => "Address")
+        address = Address.new(:street => "New Street")
         @person.addresses = [address]
         @person.addresses.first.street.should == "New Street"
       end
@@ -300,7 +300,7 @@ describe Mongoid::Document do
       end
 
       it "sets the attributes for the association" do
-        name = Name.new(:first_name => "New Name", :document_class => "Name")
+        name = Name.new(:first_name => "New Name")
         @person.name = name
         @person.name.first_name.should == "New Name"
       end
@@ -439,8 +439,8 @@ describe Mongoid::Document do
     before do
       @attributes = { :title => "Sir",
         :addresses => [
-          { :street => "Street 1", :document_class => "Address" },
-          { :street => "Street 2", :document_class => "Address" } ] }
+          { :street => "Street 1" },
+          { :street => "Street 2" } ] }
       @person = Person.new(@attributes)
     end
 
@@ -479,6 +479,15 @@ describe Mongoid::Document do
 
   end
 
+  describe "#select" do
+
+    it "returns a new criteria with select conditions added" do
+      criteria = Person.select(:title, :age)
+      criteria.options.should == { :fields => [ :title, :age ] }
+    end
+
+  end
+
   describe "#to_param" do
 
     it "returns the id" do
@@ -488,6 +497,24 @@ describe Mongoid::Document do
 
   end
 
+  describe "#write_attribute" do
+
+    context "when attribute does not exist" do
+
+      before do
+        Person.field :weight, :default => 100
+        @person = Person.new
+      end
+
+      it "returns the default value" do
+        @person.weight = nil
+        @person.weight.should == 100
+      end
+
+    end
+
+  end
+
   context "validations" do
 
     context "when defining using macros" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-17 00:00:00 -04:00
+date: 2009-10-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency