mongoid 0.8.9 → 0.8.10

data/VERSION

@@ -1 +1 @@
-0.8.9
+0.8.10

data/lib/mongoid.rb

@@ -40,6 +40,7 @@ require "mongoid/associations/options"
 require "mongoid/attributes"
 require "mongoid/commands"
 require "mongoid/criteria"
+require "mongoid/dynamic_finder"
 require "mongoid/extensions"
 require "mongoid/field"
 require "mongoid/finders"

data/lib/mongoid/associations/has_one.rb

@@ -5,13 +5,11 @@ module Mongoid #:nodoc:
 
       delegate :valid?, :to => :document
 
-      attr_accessor :klass, :parent, :association_name
+      attr_accessor :parent, :options
 
       # Build a new object for the association.
       def build(attributes)
-        @document = @klass.instantiate(attributes)
-        @document.parentize(@parent, @association_name)
-        @document.notify
+        @document = attributes.assimilate(@parent, @options)
         decorate!
         self
       end
@@ -30,10 +28,9 @@ module Mongoid #:nodoc:
       # All method calls on this object will then be delegated
       # to the internal document itself.
       def initialize(document, options)
-        @klass, @parent, @association_name = options.klass, document, options.name
-        attributes = document.attributes[options.name]
-        @document = klass.instantiate(attributes || {})
-        @document.parentize(document, options.name)
+        @parent, @options = document, options
+        attributes = @parent.attributes[options.name]
+        @document = (attributes || {}).assimilate(@parent, @options)
         decorate!
       end
 

data/lib/mongoid/criteria.rb

@@ -101,10 +101,7 @@ module Mongoid #:nodoc:
     # objects of the type of class provided.
     def execute(klass = nil)
       @klass = klass if klass
-      if type == :first
-        attributes = klass.collection.find_one(@selector, @options.dup)
-        return attributes ? @klass.instantiate(attributes) : nil
-      else
+      if type == :all
         attributes = @klass.collection.find(@selector, @options.dup)
         if attributes
           @count = attributes.count
@@ -112,6 +109,9 @@ module Mongoid #:nodoc:
         else
           return []
         end
+      else
+        attributes = @klass.collection.find_one(@selector, @options.dup)
+        return attributes ? @klass.instantiate(attributes) : nil
       end
     end
 

data/lib/mongoid/document.rb

@@ -101,11 +101,6 @@ module Mongoid #:nodoc:
         before_save :generate_key
       end
 
-      # Find the last +Document+ in the collection by reverse id
-      def last
-        find(:first, :conditions => {}, :sort => [[:_id, :asc]])
-      end
-
       # Returns the primary key field of the +Document+
       def primary_key
         @primary_key

data/lib/mongoid/dynamic_finder.rb

@@ -0,0 +1,64 @@
+module Mongoid #:nodoc:
+  class DynamicFinder
+    # Regex for standard dynamic finder methods.
+    FINDER = /^find_(all_by|last_by|by)_([_a-zA-Z]\w*)$/
+    # Regex for finder methods that create objects if nothing found.
+    CREATOR = /^find_or_(initialize|create)_by_([_a-zA-Z]\w*)$/
+
+    attr_reader :conditions, :finder
+
+    # Creates a new DynamicFinder given the supplied method name. This parses
+    # the name and sets up the appropriate finder type and attribute names in
+    # order to perform the search.
+    #
+    # Options:
+    #
+    # method: The name of the dynamic finder method.
+    #
+    # Example:
+    #
+    # <tt>DynamicFinder.new(:find_by_title_and_age)</tt>
+    def initialize(method, *args)
+      @finder, @args = :first, args
+      case method.to_s
+      when FINDER
+        @finder = :all if $1 == "all_by"
+        @finder = :last if $1 == "last_by"
+        names = $2
+      when CREATOR then
+        @creator = ($1 == "initialize") ? :instantiate : :create
+        names = $2
+      else
+        @finder = nil
+      end
+      @attributes = names && names.split("_and_")
+      generate_conditions
+    end
+
+    # Will create a new +Document+ based on the type of creator keyword in the
+    # method, given the supplied class.
+    #
+    # Options:
+    #
+    # klass: The +Document+ class to be instantiated.
+    #
+    # Example:
+    #
+    # <tt>finder.create(Person)</tt>
+    def create(klass)
+      klass.send(@creator, @conditions) if @creator
+    end
+
+    protected
+    def generate_conditions
+      if @attributes
+        @conditions = {}.with_indifferent_access
+        @attributes.each_with_index do |attr, index|
+          attr = "_id" if attr == "id"
+          @conditions[attr] = @args[index]
+        end
+      end
+    end
+
+  end
+end

data/lib/mongoid/extensions/hash/assimilation.rb

@@ -18,7 +18,7 @@ module Mongoid #:nodoc:
         # Returns: The child +Document+.
         def assimilate(parent, options)
           klass = options.klass
-          child = klass.new(self)
+          child = klass.instantiate(self)
           child.assimilate(parent, options)
         end
       end

data/lib/mongoid/finders.rb

@@ -36,11 +36,6 @@ module Mongoid #:nodoc:
       Criteria.translate(*args).execute(self)
     end
 
-    # Find a +Document+ by its id.
-    def find_by_id(id)
-      find(id)
-    end
-
     # Find the first +Document+ given the conditions.
     #
     # Options:
@@ -52,6 +47,36 @@ module Mongoid #:nodoc:
       find(:first, *args)
     end
 
+    # Find the last +Document+ given the conditions.
+    #
+    # Options:
+    #
+    # args: A +Hash+ with a conditions key and other options
+    #
+    # <tt>Person.last(:conditions => { :attribute => "value" })</tt>
+    def last(*args)
+      return find(:last, :conditions => {}, :sort => [[:_id, :desc]]) if args.empty?
+      return find(:last, *args) unless args.empty?
+    end
+
+    # Will execute a +Criteria+ based on the +DynamicFinder+ that gets
+    # generated.
+    #
+    # Options:
+    #
+    # name: The finder method name
+    # args: The arguments to pass to the method.
+    #
+    # Example:
+    #
+    # <tt>Person.find_all_by_title_and_age("Sir", 30)</tt>
+    def method_missing(name, *args)
+      dyna = DynamicFinder.new(name, *args)
+      finder, conditions = dyna.finder, dyna.conditions
+      results = Criteria.translate(finder, :conditions => conditions).execute(self)
+      results ? results : dyna.create(self)
+    end
+
     # Find all documents in paginated fashion given the supplied arguments.
     # If no parameters are passed just default to offset 0 and limit 20.
     #

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.8.9"
+  s.version = "0.8.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2009-11-26}
+  s.date = %q{2009-11-27}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/commands/validate.rb",
      "lib/mongoid/criteria.rb",
      "lib/mongoid/document.rb",
+     "lib/mongoid/dynamic_finder.rb",
      "lib/mongoid/extensions.rb",
      "lib/mongoid/extensions/array/assimilation.rb",
      "lib/mongoid/extensions/array/conversions.rb",
@@ -85,6 +86,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/commands_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
+     "spec/unit/mongoid/dynamic_finder_spec.rb",
      "spec/unit/mongoid/extensions/array/assimilation_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/array/parentization_spec.rb",
@@ -132,6 +134,7 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/commands_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
+     "spec/unit/mongoid/dynamic_finder_spec.rb",
      "spec/unit/mongoid/extensions/array/assimilation_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
      "spec/unit/mongoid/extensions/array/parentization_spec.rb",

data/spec/integration/mongoid/document_spec.rb

@@ -64,6 +64,45 @@ describe Mongoid::Document do
     end
   end
 
+  context "using dynamic finders" do
+
+    before do
+      @person = Person.create(:title => "Mr", :age => 25)
+    end
+
+    context "finding by a single attribute" do
+
+      it "returns found documents" do
+        Person.find_by_title("Mr").should == @person
+      end
+
+    end
+
+    context "finding by multiple attributes" do
+
+      it "returns found documents" do
+        Person.find_by_title_and_age("Mr", 25).should == @person
+      end
+
+    end
+
+    context "finding all by a single attribute" do
+
+      it "returns found documents" do
+        Person.find_all_by_title("Mr").should == [@person]
+      end
+
+    end
+
+    context "finding all by multiple attributes" do
+
+      it "returns found documents" do
+        Person.find_all_by_title_and_age("Mr", 25).should == [@person]
+      end
+
+    end
+  end
+
   describe "#find" do
 
     before do

data/spec/unit/mongoid/dynamic_finder_spec.rb

@@ -0,0 +1,145 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../../spec_helper.rb"))
+
+describe Mongoid::DynamicFinder do
+
+  describe "#conditions" do
+
+    before do
+      @finder = Mongoid::DynamicFinder.new(:find_by_title_and_age, "Sir", 30)
+      @conditions = { "title" => "Sir", "age" => 30 }
+    end
+
+    it "returns the conditions hash for the criteria" do
+      @finder.conditions.should == @conditions
+    end
+
+    context "when id is an attribute" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_by_id, "5")
+        @conditions = { "_id" => "5" }
+      end
+
+      it "converts to _id" do
+        @finder.conditions.should == @conditions
+      end
+
+    end
+
+  end
+
+  describe "#create" do
+
+    context "when initializing" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_or_initialize_by_title_and_age, "Sir", 30)
+      end
+
+      it "instantiates a new document" do
+        person = @finder.create(Person)
+        person.title.should == "Sir"
+        person.age.should == 30
+      end
+
+    end
+
+    context "when creating" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_or_create_by_title_and_age, "Sir", 30)
+        @person = stub
+      end
+
+      it "creates a new document" do
+        Person.expects(:create).with(@finder.conditions).returns(@person)
+        person = @finder.create(Person)
+        person.should == @person
+      end
+
+    end
+
+  end
+
+  describe ".initialize" do
+
+    context "when find_by*" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_by_title_and_age, "Sir", 30)
+      end
+
+      it "sets a first finder and attributes" do
+        @finder.finder.should == :first
+        @finder.conditions.should == { "title" => "Sir", "age" => 30 }
+      end
+
+    end
+
+    context "when find_all_by*" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_all_by_title_and_age, "Sir", 30)
+      end
+
+      it "sets an all finder and attributes" do
+        @finder.finder.should == :all
+        @finder.conditions.should == { "title" => "Sir", "age" => 30 }
+      end
+
+    end
+
+    context "when find_last_by*" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_last_by_title_and_age, "Sir", 30)
+      end
+
+      it "sets a last finder and attributes" do
+        @finder.finder.should == :last
+        @finder.conditions.should == { "title" => "Sir", "age" => 30 }
+      end
+
+    end
+
+    context "when find_or_initialize_by*" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_or_initialize_by_title_and_age, "Sir", 30)
+      end
+
+      it "sets a first finder with attributes or a new" do
+        @finder.finder.should == :first
+        @finder.conditions.should == { "title" => "Sir", "age" => 30 }
+      end
+
+    end
+
+    context "when find_or_create_by*" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:find_or_create_by_title_and_age, "Sir", 30)
+      end
+
+      it "sets a first finder with attributes or a create" do
+        @finder.finder.should == :first
+        @finder.conditions.should == { "title" => "Sir", "age" => 30 }
+      end
+
+    end
+
+    context "when invalid finder name" do
+
+      before do
+        @finder = Mongoid::DynamicFinder.new(:bleh)
+      end
+
+      it "sets a nil finder" do
+        @finder.finder.should be_nil
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/mongoid/finders_spec.rb

@@ -137,13 +137,13 @@ describe Mongoid::Finders do
     end
 
     it "delegates to find with an id parameter" do
-      Mongoid::Criteria.expects(:translate).with("1").returns(@criteria)
+      Mongoid::Criteria.expects(:translate).with(:first, :conditions => { "_id" => "1" }).returns(@criteria)
       Person.find_by_id("1")
     end
 
   end
 
-  describe "#first" do
+  describe ".first" do
 
     before do
       @attributes = { "age" => 100 }
@@ -173,7 +173,7 @@ describe Mongoid::Finders do
 
     before do
       @attributes = { :_id => 1, :title => "Sir" }
-      @collection.expects(:find_one).with({}, :sort => [[:_id, :asc]]).returns(@attributes)
+      @collection.expects(:find_one).with({}, :sort => [[:_id, :desc]]).returns(@attributes)
     end
 
     it "finds the last document by the id" do
@@ -182,6 +182,59 @@ describe Mongoid::Finders do
 
   end
 
+  describe ".method_missing" do
+
+    context "with a finder method name" do
+
+      before do
+        @criteria = stub
+        @document = stub
+        @conditions = { "title" => "Sir", "age" => 30 }
+      end
+
+      it "executes the finder" do
+        Mongoid::Criteria.expects(:translate).with(:first, :conditions => @conditions).returns(@criteria)
+        @criteria.expects(:execute).with(Person).returns(@document)
+        Person.find_by_title_and_age("Sir", 30)
+      end
+
+    end
+
+    context "with a finder or creation method name" do
+
+      before do
+        @criteria = stub
+        @document = stub
+        @conditions = { "title" => "Sir", "age" => 30 }
+      end
+
+      context "when document is found" do
+
+        it "returns the document" do
+          Mongoid::Criteria.expects(:translate).with(:first, :conditions => @conditions).returns(@criteria)
+          @criteria.expects(:execute).with(Person).returns(@document)
+          Person.find_or_initialize_by_title_and_age("Sir", 30).should == @document
+        end
+
+      end
+
+      context "when document is not found" do
+
+        it "instantiates a new document" do
+          Mongoid::Criteria.expects(:translate).with(:first, :conditions => @conditions).returns(@criteria)
+          @criteria.expects(:execute).with(Person).returns(nil)
+          new_doc = Person.find_or_initialize_by_title_and_age("Sir", 30)
+          new_doc.new_record?.should be_true
+          new_doc.title.should == "Sir"
+          new_doc.age.should == 30
+        end
+
+      end
+
+    end
+
+  end
+
   describe ".paginate" do
 
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.8.9
+  version: 0.8.10
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-26 00:00:00 -05:00
+date: 2009-11-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,7 @@ files:
 - lib/mongoid/commands/validate.rb
 - lib/mongoid/criteria.rb
 - lib/mongoid/document.rb
+- lib/mongoid/dynamic_finder.rb
 - lib/mongoid/extensions.rb
 - lib/mongoid/extensions/array/assimilation.rb
 - lib/mongoid/extensions/array/conversions.rb
@@ -141,6 +142,7 @@ files:
 - spec/unit/mongoid/commands_spec.rb
 - spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
+- spec/unit/mongoid/dynamic_finder_spec.rb
 - spec/unit/mongoid/extensions/array/assimilation_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/array/parentization_spec.rb
@@ -210,6 +212,7 @@ test_files:
 - spec/unit/mongoid/commands_spec.rb
 - spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
+- spec/unit/mongoid/dynamic_finder_spec.rb
 - spec/unit/mongoid/extensions/array/assimilation_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
 - spec/unit/mongoid/extensions/array/parentization_spec.rb