mongoid 2.0.0.beta.20 → 2.0.0.rc.1

data/lib/mongoid/extensions/array/parentization.rb

@@ -4,8 +4,8 @@ module Mongoid #:nodoc:
     module Array #:nodoc:
       module Parentization #:nodoc:
         # Adds the parent document to each element in the array.
-        def parentize(parent, association_name)
-          each { |obj| obj.parentize(parent, association_name) }
+        def parentize(parent)
+          each { |obj| obj.parentize(parent) }
         end
       end
     end

data/lib/mongoid/extensions/date/conversions.rb

@@ -5,7 +5,7 @@ module Mongoid #:nodoc:
       module Conversions #:nodoc:
         def get(value)
           return nil if value.blank?
-          if Mongoid::Config.instance.use_utc?
+          if Mongoid::Config.use_utc?
             value.to_date
           else
             ::Date.new(value.year, value.month, value.day)

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

@@ -5,29 +5,6 @@ module Mongoid #:nodoc:
       module Conversions #:nodoc:
         extend ActiveSupport::Concern
 
-        # Get the difference between 2 hashes. This will give back a new hash
-        # with the keys and pairs of [ old, new ] values.
-        #
-        # Example:
-        #
-        #   first = { :field => "value" }
-        #   second = { :field => "new" }
-        #   first.difference(second) # => { :field => [ "value", "new" ] }
-        #
-        # Returns:
-        #
-        # A +Hash+ of modifications.
-        def difference(other)
-          changes = {}
-          each_pair do |key, value|
-            if other.has_key?(key)
-              new_value = other[key]
-              changes[key] = [ value, new_value ] if new_value != value
-            end
-          end
-          changes
-        end
-
         module ClassMethods #:nodoc:
           def get(value)
             value

data/lib/mongoid/extensions/nil/collectionization.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Nil #:nodoc:
+      module Collectionization #:nodoc:
+        def collectionize
+          to_s.collectionize
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/reflections.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+      module Reflections #:nodoc:
+        extend ActiveSupport::Concern
+
+        def ivar(name)
+          if instance_variable_defined?("@#{name}")
+            return instance_variable_get("@#{name}")
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/yoda.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+
+      # This module behaves like the master jedi.
+      module Yoda #:nodoc:
+
+        # Do or do not, there is no try. -- Yoda.
+        #
+        # @example Do or do not.
+        #   object.do_or_do_not(:use, "The Force")
+        #
+        # @param [ String, Symbol ] name The method name.
+        # @param [ Array ] *args The arguments.
+        #
+        # @return [ Object, nil ] The result of the method call or nil if the
+        #   method does not exist.
+        #
+        # @since 2.0.0.rc.1
+        def do_or_do_not(name, *args)
+          respond_to?(name) ? send(name, *args) : nil
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/string/conversions.rb

@@ -3,11 +3,30 @@ module Mongoid #:nodoc:
   module Extensions #:nodoc:
     module String #:nodoc:
       module Conversions #:nodoc:
-        def set(value)
-          value.to_s unless value.nil?
+        extend ActiveSupport::Concern
+
+        # Convert the string to an array with the string in it.
+        #
+        # Example:
+        #
+        # <tt>"Testing".to_a</tt>
+        #
+        # Returns:
+        #
+        # An array with only the string in it.
+        def to_a
+          [ self ]
         end
-        def get(value)
-          value
+
+        module ClassMethods #:nodoc:
+
+          def get(value)
+            value
+          end
+
+          def set(value)
+            value.to_s unless value.nil?
+          end
         end
       end
     end

data/lib/mongoid/extensions/time_conversions.rb

@@ -9,9 +9,9 @@ module Mongoid #:nodoc:
 
       def get(value)
         return nil if value.blank?
-        value = value.getlocal unless Mongoid::Config.instance.use_utc?
-        if Mongoid::Config.instance.use_activesupport_time_zone?
-          time_zone = Mongoid::Config.instance.use_utc? ? 'UTC' : Time.zone
+        value = value.getlocal unless Mongoid::Config.use_utc?
+        if Mongoid::Config.use_activesupport_time_zone?
+          time_zone = Mongoid::Config.use_utc? ? 'UTC' : Time.zone
           value = value.in_time_zone(time_zone)
         end
         value
@@ -24,7 +24,7 @@ module Mongoid #:nodoc:
       end
 
       def convert_to_time(value)
-        time = Mongoid::Config.instance.use_activesupport_time_zone? ? ::Time.zone : ::Time
+        time = Mongoid::Config.use_activesupport_time_zone? ? ::Time.zone : ::Time
         case value
           when ::String then time.parse(value)
           when ::DateTime then time.local(value.year, value.month, value.day, value.hour, value.min, value.sec)

data/lib/mongoid/field.rb

@@ -1,16 +1,7 @@
 # encoding: utf-8
 module Mongoid #:nodoc:
   class Field
-    attr_reader :klass, :name, :type
-
-    # Get the declared options for this field
-    #
-    # Returns:
-    #
-    # a hash of options
-    def options
-      @options
-    end
+    attr_reader :copyable, :klass, :name, :options, :type
 
     # Get the default value for the field.
     #
@@ -34,25 +25,45 @@ module Mongoid #:nodoc:
     # <tt>Field.new(:score, :default => 0)</tt>
     def initialize(name, options = {})
       check_name!(name)
-      @type = options[:type] || String
+      @type = options[:type] || Object
       @name, @default = name, options[:default]
       @copyable = (@default.is_a?(Array) || @default.is_a?(Hash))
       @options = options
       check_default!
     end
 
-    # Used for setting an object in the attributes hash. If nil is provided the
-    # default will get returned if it exists.
+    # Used for setting an object in the attributes hash.
+    #
+    # If nil is provided the default will get returned if it exists.
+    #
+    # If the field is an identity field, ie an id, it performs the necessary
+    # cast.
+    #
+    # Example:
+    #
+    # <tt>field.set("New Value")</tt>
+    #
+    # Returns:
+    #
+    # The new value.
     def set(object)
-      unless @options[:identity]
+      unless options[:identity]
         type.set(object)
       else
-        inverse = @options[:inverse_class_name].constantize
-        object.blank? ? type.set(object) : BSON::ObjectId.cast!(inverse, object)
+        metadata = options[:metadata]
+        object.blank? ? type.set(object) : BSON::ObjectId.cast!(metadata.inverse_klass, object)
       end
     end
 
     # Used for retrieving the object out of the attributes hash.
+    #
+    # Example:
+    #
+    # <tt>field.get("Value")</tt>
+    #
+    # Returns:
+    #
+    # The converted value.
     def get(object)
       type.get(object)
     end
@@ -60,7 +71,7 @@ module Mongoid #:nodoc:
     protected
     # Slightly faster default check.
     def copy
-      @copyable ? @default.dup : @default
+      copyable ? @default.dup : @default
     end
 
     # Check if the name is valid.
@@ -72,8 +83,8 @@ module Mongoid #:nodoc:
 
     def check_default!
       return if @default.is_a?(Proc)
-      if !@default.nil? && !@default.is_a?(@type)
-        raise Mongoid::Errors::InvalidType.new(@type, @default)
+      if !@default.nil? && !@default.is_a?(type)
+        raise Mongoid::Errors::InvalidType.new(type, @default)
       end
     end
   end

data/lib/mongoid/fields.rb

@@ -50,11 +50,21 @@ module Mongoid #:nodoc
 
       # Create the field accessors.
       def create_accessors(name, meth, options = {})
-        define_method(meth) { read_attribute(name) }
-        define_method("#{meth}=") { |value| write_attribute(name, value) }
-        define_method("#{meth}?") do
-          attr = read_attribute(name)
-          (options[:type] == Boolean) ? attr == true : attr.present?
+        generated_field_methods.module_eval do
+          define_method(meth) { read_attribute(name) }
+          define_method("#{meth}=") { |value| write_attribute(name, value) }
+          define_method("#{meth}?") do
+            attr = read_attribute(name)
+            (options[:type] == Boolean) ? attr == true : attr.present?
+          end
+        end
+      end
+
+      def generated_field_methods
+        @generated_field_methods ||= begin
+          mod = Module.new
+          include mod
+          mod
         end
       end
     end

data/lib/mongoid/finders.rb

@@ -28,7 +28,7 @@ module Mongoid #:nodoc:
     #
     # <tt>Person.count(:conditions => { :attribute => "value" })</tt>
     def count(*args)
-      Criteria.translate(self, *args).count
+      Criteria.translate(self, false, *args).count
     end
 
     # Returns true if there are on document in database based on the
@@ -36,7 +36,7 @@ module Mongoid #:nodoc:
     #
     # <tt>Person.exists?(:conditions => { :attribute => "value" })</tt>
     def exists?(*args)
-      Criteria.translate(self, *args).limit(1).count == 1
+      Criteria.translate(self, false, *args).limit(1).count == 1
     end
 
     # Helper to initialize a new +Criteria+ object for this class, or return
@@ -45,8 +45,8 @@ module Mongoid #:nodoc:
     # Example:
     #
     # <tt>Person.criteria</tt>
-    def criteria
-      scope_stack.last || Criteria.new(self)
+    def criteria(embedded = false)
+      scope_stack.last || Criteria.new(self, embedded)
     end
 
     # Find a +Document+ in several different ways.
@@ -57,15 +57,24 @@ module Mongoid #:nodoc:
     # 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>
+    # Example:
     #
+    # <tt>Person.find(:first, :conditions => { :attribute => "value" })</tt>
     # <tt>Person.find(:all, :conditions => { :attribute => "value" })</tt>
+    # <tt>Person.find(BSON::ObjectId)</tt>
+    #
+    # Options:
+    #
+    # args: An assortment of finder options.
     #
-    # <tt>Person.find(Mongo::ObjectID.new.to_s)</tt>
+    # Returns:
+    #
+    # A document or criteria.
     def find(*args)
-      raise Errors::InvalidOptions.new(:calling_document_find_with_nil_is_invalid, {}) if args[0].nil?
-      type = args.delete_at(0) if args[0].is_a?(Symbol)
-      criteria = Criteria.translate(self, *args)
+      raise Errors::InvalidOptions.new(
+        :calling_document_find_with_nil_is_invalid, {}
+      ) if args[0].nil?
+      type, criteria = Criteria.parse!(self, false, *args)
       case type
       when :first then return criteria.one
       when :last then return criteria.last
@@ -134,7 +143,7 @@ module Mongoid #:nodoc:
     #
     # Returns paginated array of docs.
     def paginate(params = {})
-      Criteria.translate(self, params).paginate
+      Criteria.translate(self, false, params).paginate
     end
 
     protected
@@ -154,7 +163,6 @@ module Mongoid #:nodoc:
     def with_scope(criteria)
       scope_stack = self.scope_stack
       scope_stack << criteria
-
       begin
         yield criteria
       ensure

data/lib/mongoid/hierarchy.rb

@@ -7,8 +7,13 @@ module Mongoid #:nodoc
     end
 
     module ClassMethods #:nodoc:
-      # Returns <tt>true</tt> if the document inherits from another
-      # Mongoid::Document.
+
+      # Determines if the document is a subclass of another document.
+      #
+      # @example Check if the document is a subclass.
+      #   Square.hereditary?
+      #
+      # @return [ true, false ] True if hereditary, false if not.
       def hereditary?
         Mongoid::Document > superclass
       end
@@ -23,30 +28,29 @@ module Mongoid #:nodoc
       # always be preferred, since they are optimized calls... This operation
       # can get expensive in domains with large hierarchies.
       #
-      # Example:
-      #
-      # <tt>person._children</tt>
+      # @example Get all the document's children.
+      #   person._children
       #
-      # Returns:
-      #
-      # All child +Documents+ to this +Document+ in the entire hierarchy.
+      # @return [ Array<Document> ] All child documents in the hierarchy.
       def _children
-        associations.inject([]) do |children, (name, metadata)|
-          if metadata.embedded? && name != "versions"
-            child = send(name)
-            child.to_a.each do |doc|
-              children.push(doc).concat(doc._children)
-            end unless child.blank?
+        relations.inject([]) do |children, (name, metadata)|
+          children.tap do |kids|
+            if metadata.embedded? && name != "versions"
+              child = send(name)
+              child.to_a.each do |doc|
+                kids.push(doc).concat(doc._children)
+              end unless child.blank?
+            end
           end
-          children
         end
       end
 
-      # Is inheritance in play here?
+      # Determines if the document is a subclass of another document.
       #
-      # Returns:
+      # @example Check if the document is a subclass
+      #   Square.new.hereditary?
       #
-      # <tt>true</tt> if inheritance used, <tt>false</tt> if not.
+      # @return [ true, false ] True if hereditary, false if not.
       def hereditary?
         self.class.hereditary?
       end
@@ -54,21 +58,23 @@ module Mongoid #:nodoc
       # Sets up a child/parent association. This is used for newly created
       # objects so they can be properly added to the graph.
       #
-      # Options:
-      #
-      # abject: The parent object that needs to be set for the child.
-      # association_name: The name of the association for the child.
+      # @example Set the parent document.
+      #   document.parentize(parent)
       #
-      # Example:
+      # @param [ Document ] document The parent document.
       #
-      # <tt>address.parentize(person, :addresses)</tt>
-      def parentize(object, association_name)
-        self._parent = object
-        self.association_name = association_name.to_s
+      # @return [ Document ] The parent document.
+      def parentize(document)
+        self._parent = document
       end
 
-      # Return the root +Document+ in the object graph. If the current +Document+
+      # Return the root document in the object graph. If the current document
       # is the root object in the graph it will return self.
+      #
+      # @example Get the root document in the hierarchy.
+      #   document._root
+      #
+      # @return [ Document ] The root document in the hierarchy.
       def _root
         object = self
         while (object._parent) do object = object._parent; end