mongoid 1.1.3 → 1.1.4

data/lib/mongoid/associations/has_one.rb

@@ -4,7 +4,10 @@ module Mongoid #:nodoc:
     class HasOne #:nodoc:
       include Proxy
 
-      attr_reader :association_name, :document, :parent, :options
+      # Build a new object for the association.
+      def build(attrs = {}, type = nil)
+        @target = attrs.assimilate(@parent, @options, type); self
+      end
 
       # Creates the new association by finding the attributes in
       # the parent document with its name, and instantiating a
@@ -16,43 +19,32 @@ module Mongoid #:nodoc:
       # Options:
       #
       # document: The parent +Document+
-      # attributes: The attributes of the decorated object.
+      # attributes: The attributes of the target object.
       # options: The association options.
-      def initialize(document, attributes, options)
-        @parent, @options, @association_name = document, options, options.name
-        attrs = attributes.stringify_keys
-        klass = attrs["_type"] ? attrs["_type"].constantize : nil
-        @document = attrs.assimilate(@parent, @options, klass)
-      end
-
-      # Delegate all missing methods over to the +Document+.
-      def method_missing(name, *args, &block)
-        @document.send(name, *args, &block)
+      #
+      # Returns:
+      #
+      # A new +HashOne+ association proxy.
+      def initialize(document, attrs, options)
+        @parent, @options  = document, options
+        @target = attrs.assimilate(@parent, @options, attrs.klass)
+        extends(options)
       end
 
       # Used for setting the association via a nested attributes setter on the
-      # parent +Document+.
+      # parent +Document+. Called when using accepts_nested_attributes_for.
+      #
+      # Options:
+      #
+      # attributes: The attributes for the new association
+      #
+      # Returns:
+      #
+      # A new target document.
       def nested_build(attributes)
         build(attributes)
       end
 
-      # This will get deprecated
-      def to_a
-        [@document]
-      end
-
-      # Need to override here for when the underlying document is nil.
-      def valid?
-        @document.valid?
-      end
-
-      protected
-      # Build a new object for the association.
-      def build(attrs = {}, type = nil)
-        @document = attrs.assimilate(@parent, @options, type)
-        self
-      end
-
       class << self
         # Preferred method of instantiating a new +HasOne+, since nil values
         # will be handled properly.
@@ -61,6 +53,10 @@ module Mongoid #:nodoc:
         #
         # document: The parent +Document+
         # options: The association options.
+        #
+        # Returns:
+        #
+        # A new +HasOne+ association proxy.
         def instantiate(document, options)
           attributes = document.raw_attributes[options.name]
           return nil if attributes.blank?
@@ -84,8 +80,13 @@ module Mongoid #:nodoc:
         # Example:
         #
         # <tt>HasOne.update({:first_name => "Hank"}, person, options)</tt>
+        #
+        # Returns:
+        #
+        # A new +HasOne+ association proxy.
         def update(child, parent, options)
           child.assimilate(parent, options)
+          instantiate(parent, options)
         end
       end
 

data/lib/mongoid/associations/has_one_related.rb

@@ -4,17 +4,16 @@ module Mongoid #:nodoc:
     class HasOneRelated #:nodoc:
       include Proxy
 
-      delegate :==, :nil?, :to => :document
-      attr_reader :klass, :document
+      delegate :nil?, :to => :target
 
       # Builds a new Document and sets it as the association.
       #
       # Returns the newly created object.
       def build(attributes = {})
-        @document = @klass.instantiate(attributes)
+        @target = @klass.instantiate(attributes)
         name = @parent.class.to_s.underscore
-        @document.send("#{name}=", @parent)
-        @document
+        @target.send("#{name}=", @parent)
+        @target
       end
 
       # Builds a new Document and sets it as the association, then saves the
@@ -22,7 +21,7 @@ module Mongoid #:nodoc:
       #
       # Returns the newly created object.
       def create(attributes)
-        build(attributes); @document.save; @document
+        build(attributes); @target.save; @target
       end
 
       # Initializing a related association only requires looking up the objects
@@ -32,15 +31,11 @@ module Mongoid #:nodoc:
       #
       # document: The +Document+ that contains the relationship.
       # options: The association +Options+.
-      def initialize(document, options)
+      def initialize(document, options, target = nil)
         @parent, @klass = document, options.klass
         @foreign_key = document.class.to_s.foreign_key
-        @document = @klass.first(:conditions => { @foreign_key => @parent.id })
-      end
-
-      # Delegate all missing methods over to the +Document+.
-      def method_missing(name, *args)
-        @document.send(name, *args)
+        @target = target || @klass.first(:conditions => { @foreign_key => @parent.id })
+        extends(options)
       end
 
       class << self
@@ -50,8 +45,8 @@ module Mongoid #:nodoc:
         #
         # document: The +Document+ that contains the relationship.
         # options: The association +Options+.
-        def instantiate(document, options)
-          new(document, options)
+        def instantiate(document, options, target = nil)
+          new(document, options, target)
         end
 
         # Returns the macro used to create the association.
@@ -70,11 +65,14 @@ module Mongoid #:nodoc:
         #
         # Example:
         #
-        # <tt>HasManyToRelated.update(game, person, options)</tt>
-        def update(related, document, options)
-          name = document.class.to_s.underscore
-          related.send("#{name}=", document)
-          related
+        # <tt>HasOneToRelated.update(game, person, options)</tt>
+        def update(target, document, options)
+          if target
+            name = document.class.to_s.underscore
+            target.send("#{name}=", document)
+            return instantiate(document, options, target)
+          end
+          target
         end
       end
 

data/lib/mongoid/associations/options.rb

@@ -9,6 +9,16 @@ module Mongoid #:nodoc:
         @attributes = attributes
       end
 
+      # Returns the extension if it exists, nil if not.
+      def extension
+        @attributes[:extend]
+      end
+
+      # Returns true is the options have extensions.
+      def extension?
+        !extension.nil?
+      end
+
       # Return the foreign key based off the association name.
       def foreign_key
         name.to_s.foreign_key

data/lib/mongoid/associations/proxy.rb

@@ -5,8 +5,25 @@ module Mongoid #:nodoc
       def self.included(base)
         base.class_eval do
           instance_methods.each do |method|
-            undef_method(method) unless method =~ /(^__|^nil\?$|^send$|^object_id$)/
+            undef_method(method) unless method =~ /(^__|^nil\?$|^send$|^object_id$|^extend$)/
           end
+          include InstanceMethods
+        end
+      end
+      module InstanceMethods #:nodoc:
+        attr_reader \
+          :options,
+          :target
+
+        # Default behavior of method missing should be to delegate all calls
+        # to the target of the proxy. This can be overridden in special cases.
+        def method_missing(name, *args, &block)
+          @target.send(name, *args, &block)
+        end
+
+        # If anonymous extensions are added this will take care of them.
+        def extends(options)
+          extend Module.new(&options.extension) if options.extension?
         end
       end
     end

data/lib/mongoid/criteria.rb

@@ -1,4 +1,9 @@
 # encoding: utf-8
+require "mongoid/criterion/complex"
+require "mongoid/criterion/exclusion"
+require "mongoid/criterion/inclusion"
+require "mongoid/criterion/optional"
+
 module Mongoid #:nodoc:
   # The +Criteria+ class is the core object needed in Mongoid to retrieve
   # objects from the database. It is a DSL that essentially sets up the
@@ -15,6 +20,9 @@ module Mongoid #:nodoc:
   #
   # <tt>criteria.execute</tt>
   class Criteria
+    include Criterion::Exclusion
+    include Criterion::Inclusion
+    include Criterion::Optional
     include Enumerable
 
     attr_accessor :documents
@@ -67,46 +75,6 @@ module Mongoid #:nodoc:
       end
     end
 
-    # Adds a criterion to the +Criteria+ that specifies values that must all
-    # be matched in order to return results. Similar to an "in" clause but the
-    # underlying conditional logic is an "AND" and not an "OR". The MongoDB
-    # conditional operator that will be used is "$all".
-    #
-    # Options:
-    #
-    # attributes: A +Hash+ where the key is the field name and the value is an
-    # +Array+ of values that must all match.
-    #
-    # Example:
-    #
-    # <tt>criteria.all(:field => ["value1", "value2"])</tt>
-    #
-    # <tt>criteria.all(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
-    #
-    # Returns: <tt>self</tt>
-    def all(attributes = {})
-      update_selector(attributes, "$all")
-    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.and(:field1 => "value1", :field2 => 15)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def and(selector = nil)
-      where(selector)
-    end
-
     # Return or create the context in which this criteria should be executed.
     #
     # This will return an Enumerable context if the class is embedded,
@@ -143,78 +111,6 @@ module Mongoid #:nodoc:
       block_given? ? @collection.each { |doc| yield doc } : self
     end
 
-    # Adds a criterion to the +Criteria+ that specifies values that are not allowed
-    # to match any document in the database. The MongoDB conditional operator that
-    # will be used is "$ne".
-    #
-    # Options:
-    #
-    # attributes: A +Hash+ where the key is the field name and the value is a
-    # value that must not be equal to the corresponding field value in the database.
-    #
-    # Example:
-    #
-    # <tt>criteria.excludes(:field => "value1")</tt>
-    #
-    # <tt>criteria.excludes(:field1 => "value1", :field2 => "value1")</tt>
-    #
-    # Returns: <tt>self</tt>
-    def excludes(attributes = {})
-      update_selector(attributes, "$ne")
-    end
-
-    # Adds a criterion to the +Criteria+ that specifies additional options
-    # to be passed to the Ruby driver, in the exact format for the driver.
-    #
-    # Options:
-    #
-    # extras: A +Hash+ that gets set to the driver options.
-    #
-    # Example:
-    #
-    # <tt>criteria.extras(:limit => 20, :skip => 40)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def extras(extras)
-      @options = extras; filter_options; self
-    end
-
-    # Adds a criterion to the +Criteria+ that specifies values where any can
-    # be matched in order to return results. This is similar to an SQL "IN"
-    # clause. The MongoDB conditional operator that will be used is "$in".
-    #
-    # Options:
-    #
-    # attributes: A +Hash+ where the key is the field name and the value is an
-    # +Array+ of values that any can match.
-    #
-    # Example:
-    #
-    # <tt>criteria.in(:field => ["value1", "value2"])</tt>
-    #
-    # <tt>criteria.in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
-    #
-    # Returns: <tt>self</tt>
-    def in(attributes = {})
-      update_selector(attributes, "$in")
-    end
-
-    # Adds a criterion to the +Criteria+ that specifies an id that must be matched.
-    #
-    # Options:
-    #
-    # object_id: A +String+ representation of a <tt>Mongo::ObjectID</tt>
-    #
-    # Example:
-    #
-    # <tt>criteria.id("4ab2bc4b8ad548971900005c")</tt>
-    #
-    # Returns: <tt>self</tt>
-    def id(*args)
-      (args.flatten.size > 1) ? self.in(:_id => args.flatten) : (@selector[:_id] = *args)
-      self
-    end
-
     # Create the new +Criteria+ object. This will initialize the selector
     # and options hashes, as well as the type of criteria.
     #
@@ -230,23 +126,6 @@ module Mongoid #:nodoc:
       end
     end
 
-    # Adds a criterion to the +Criteria+ that specifies the maximum number of
-    # results to return. This is mostly used in conjunction with <tt>skip()</tt>
-    # to handle paginated results.
-    #
-    # Options:
-    #
-    # value: An +Integer+ specifying the max number of results. Defaults to 20.
-    #
-    # Example:
-    #
-    # <tt>criteria.limit(100)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def limit(value = 20)
-      @options[:limit] = value; self
-    end
-
     # Merges another object into this +Criteria+. The other object may be a
     # +Criteria+ or a +Hash+. This is used to combine multiple scopes together,
     # where a chained scope situation may be desired.
@@ -303,65 +182,7 @@ module Mongoid #:nodoc:
       end
     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".
-    #
-    # Options:
-    #
-    # exclusions: A +Hash+ where the key is the field name and the value is an
-    # +Array+ of values that none can match.
-    #
-    # Example:
-    #
-    # <tt>criteria.not_in(:field => ["value1", "value2"])</tt>
-    #
-    # <tt>criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
-    #
-    # Returns: <tt>self</tt>
-    def not_in(exclusions)
-      exclusions.each { |key, value| @selector[key] = { "$nin" => value } }; self
-    end
-
-    # Returns the offset option. If a per_page option is in the list then it
-    # will replace it with a skip parameter and return the same value. Defaults
-    # to 20 if nothing was provided.
-    def offset
-      @options[:skip]
-    end
-
-    # Adds a criterion to the +Criteria+ that specifies the fields that will
-    # get returned from the Document. Used mainly for list views that do not
-    # require all fields to be present. This is similar to SQL "SELECT" values.
-    #
-    # Options:
-    #
-    # args: A list of field names to retrict the returned fields to.
-    #
-    # Example:
-    #
-    # <tt>criteria.only(:field1, :field2, :field3)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def only(*args)
-      @options[:fields] = args.flatten if args.any?; self
-    end
-
-    # Adds a criterion to the +Criteria+ that specifies the sort order of
-    # the returned documents in the database. Similar to a SQL "ORDER BY".
-    #
-    # Options:
-    #
-    # params: An +Array+ of [field, direction] sorting pairs.
-    #
-    # Example:
-    #
-    # <tt>criteria.order_by([[:field1, :asc], [:field2, :desc]])</tt>
-    #
-    # Returns: <tt>self</tt>
-    def order_by(params = [])
-      @options[:sort] = params; self
-    end
+    alias :to_ary :to_a
 
     # Returns the selector and options as a +Hash+ that would be passed to a
     # scope for use with named scopes.
@@ -369,26 +190,6 @@ module Mongoid #:nodoc:
       { :where => @selector }.merge(@options)
     end
 
-    # Adds a criterion to the +Criteria+ that specifies how many results to skip
-    # when returning Documents. This is mostly used in conjunction with
-    # <tt>limit()</tt> to handle paginated results, and is similar to the
-    # traditional "offset" parameter.
-    #
-    # Options:
-    #
-    # value: An +Integer+ specifying the number of results to skip. Defaults to 0.
-    #
-    # Example:
-    #
-    # <tt>criteria.skip(20)</tt>
-    #
-    # Returns: <tt>self</tt>
-    def skip(value = 0)
-      @options[:skip] = value; self
-    end
-
-    alias :to_ary :to_a
-
     # Translate the supplied arguments into a +Criteria+ object.
     #
     # If the passed in args is a single +String+, then it will
@@ -417,31 +218,6 @@ module Mongoid #:nodoc:
       return new(klass).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 = nil)
-      case selector
-      when String
-        @selector.update("$where" => selector)
-      else
-        @selector.update(selector ? selector.expand_complex_criteria : {})
-      end
-      self
-    end
-
     protected
     # Determines the context to be used for this criteria.
     def determine_context