mongoid 2.0.2 → 2.1.0

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

@@ -7,38 +7,6 @@ module Mongoid #:nodoc:
       # and Hashes.
       module Conversions
 
-        # Set the BSON::ObjectId value.
-        #
-        # @example Set the value.
-        #   BSON::ObjectId.set("4c52c439931a90ab29000003")
-        #
-        # @param [ String, BSON::ObjectId ] value The value to set.
-        #
-        # @return [ BSON::ObjectId ] The set value.
-        #
-        # @since 1.0
-        def set(value)
-          if value.is_a?(::String)
-            BSON::ObjectId.from_string(value) unless value.blank?
-          else
-            value
-          end
-        end
-
-        # Get the BSON::ObjectId value.
-        #
-        # @example Get the value.
-        #   BSON::ObjectId.set(BSON::ObjectId.new)
-        #
-        # @param [ BSON::ObjectId ] value The value to get.
-        #
-        # @return [ BSON::ObjectId ] The value.
-        #
-        # @since 1.0
-        def get(value)
-          value
-        end
-
         # Convert the supplied arguments to object ids based on the class
         # settings.
         #
@@ -73,10 +41,8 @@ module Mongoid #:nodoc:
               BSON::ObjectId.from_string(args)
             end
           when ::Array
-            args = args.reject(&:blank?) if reject_blank
-            args.map do |arg|
-              convert(klass, arg, reject_blank)
-            end
+            args.delete_if { |arg| arg.blank? } if reject_blank
+            args.replace(args.map { |arg| convert(klass, arg, reject_blank) })
           when ::Hash
             args.tap do |hash|
               hash.each_pair do |key, value|

data/lib/mongoid/extensions/proc/scoping.rb

@@ -2,7 +2,20 @@
 module Mongoid #:nodoc:
   module Extensions #:nodoc:
     module Proc #:nodoc:
-      module Scoping #:nodoc:
+
+      # Adds functionality for criteria scoping/merging.
+      module Scoping
+
+        # Get the proc scoped for criteria merges.
+        #
+        # @example Get the hash.
+        #   proc.scoped
+        #
+        # @param [ Array ] args The arguments to delegate to the proc.
+        #
+        # @return [ Object ] The result of the proc call.
+        #
+        # @since 1.0.0
         def scoped(*args)
           call(*args).scoped
         end

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

@@ -7,27 +7,15 @@ module Mongoid #:nodoc:
 
         # Convert the string to an array with the string in it.
         #
-        # Example:
+        # @example Convert the string to an array.
+        #   "Testing".to_a
         #
-        # <tt>"Testing".to_a</tt>
+        # @return [ Array ] An array with only the string in it.
         #
-        # Returns:
-        #
-        # An array with only the string in it.
+        # @since 1.0.0
         def to_a
           [ self ]
         end
-
-        module ClassMethods #:nodoc:
-
-          def get(value)
-            value
-          end
-
-          def set(value)
-            value.to_s unless value.nil?
-          end
-        end
       end
     end
   end

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

@@ -2,7 +2,10 @@
 module Mongoid #:nodoc:
   module Extensions #:nodoc:
     module String #:nodoc:
-      module Inflections #:nodoc:
+
+      # This module contains convenience methods for string inflection and
+      # conversion.
+      module Inflections
 
         ActiveSupport::Inflector.inflections do |inflect|
           inflect.singular("address", "address")
@@ -26,7 +29,7 @@ module Mongoid #:nodoc:
           "*" => "-astx-",
           "+" => "-plus-",
           "," => "-comma-",
-          "-" => "-dash-",
+          "-" => "-",
           "." => "-period-",
           "/" => "-fwdslsh-",
           ":" => "-colon-",
@@ -55,10 +58,22 @@ module Mongoid #:nodoc:
           "descending" => "ascending"
         }
 
+        # Convert the string to a collection friendly name.
+        #
+        # @example Collectionize the string.
+        #   "namespace/model".collectionize
+        #
+        # @return [ String ] The string in collection friendly form.
         def collectionize
           tableize.gsub("/", "_")
         end
 
+        # Convert this string to a key friendly string.
+        #
+        # @example Convert to key.
+        #   "testing".identify
+        #
+        # @return [ String ] The key friendly string.
         def identify
           if Mongoid.parameterize_keys
             key = ""
@@ -68,26 +83,32 @@ module Mongoid #:nodoc:
           end
         end
 
-        def labelize
-          underscore.humanize
-        end
-
+        # Get the inverted sorting option.
+        #
+        # @example Get the inverted option.
+        #   "asc".invert
+        #
+        # @return [ String ] The string inverted.
         def invert
           REVERSALS[self]
         end
 
-        def singular?
-          singularize == self
-        end
-
-        def plural?
-          pluralize == self
-        end
-
+        # Get the string as a getter string.
+        #
+        # @example Get the reader/getter
+        #   "model=".reader
+        #
+        # @return [ String ] The string stripped of "=".
         def reader
           writer? ? gsub("=", "") : self
         end
 
+        # Is this string a writer?
+        #
+        # @example Is the string a setter method?
+        #   "model=".writer?
+        #
+        # @return [ true, false ] If the string contains "=".
         def writer?
           include?("=")
         end

data/lib/mongoid/extensions/symbol/inflections.rb

@@ -2,7 +2,10 @@
 module Mongoid #:nodoc:
   module Extensions #:nodoc:
     module Symbol #:nodoc:
-      module Inflections #:nodoc:
+
+      # This module contains convenience methods for symbol inflection and
+      # conversion.
+      module Inflections
 
         REVERSALS = {
           :asc => :desc,
@@ -11,21 +14,44 @@ module Mongoid #:nodoc:
           :descending => :ascending
         }
 
+        # Get the inverted sorting option.
+        #
+        # @example Get the inverted option.
+        #   :asc.invert
+        #
+        # @return [ String ] The string inverted.
         def invert
           REVERSALS[self]
         end
 
-        def singular?
-          to_s.singular?
-        end
-
-        def plural?
-          to_s.plural?
-        end
-
-        [ "asc", "ascending", "desc", "descending", "gt", "lt", "gte",
-          "lte", "ne", "near", "in", "nin", "mod", "all", "size", "exists",
-          "within", ["matches","elemMatch"] ].each do |oper|
+        # Define all the necessary methods on symbol to support Mongoid's
+        # complex criterion.
+        #
+        # @example A greater than criterion.
+        #   :field.gt => 5
+        #
+        # @return [ Criterion::Complex ] The criterion.
+        #
+        # @since 1.0.0
+        [
+          "all",
+          "asc",
+          "ascending",
+          "desc",
+          "descending",
+          "exists",
+          "gt",
+          "gte",
+          "in",
+          "lt",
+          "lte",
+          "mod",
+          "ne",
+          "near",
+          "nin",
+          "size",
+          "within",
+          ["matches","elemMatch"] ].each do |oper|
           m, oper = oper
           oper = m unless oper
           class_eval <<-OPERATORS

data/lib/mongoid/extensions/true_class/equality.rb

@@ -2,7 +2,20 @@
 module Mongoid #:nodoc:
   module Extensions #:nodoc:
     module TrueClass #:nodoc:
-      module Equality #:nodoc:
+
+      # Adds equality hooks for true values.
+      module Equality
+
+        # Is the passed value a boolean?
+        #
+        # @example Is the value a boolean type?
+        #   true.is_a?(Boolean)
+        #
+        # @param [ Class ] other The class to check.
+        #
+        # @return [ true, false ] If the other is a boolean.
+        #
+        # @since 1.0.0
         def is_a?(other)
           return true if other.name == "Boolean"
           super(other)

data/lib/mongoid/extras.rb

@@ -1,23 +1,25 @@
 # encoding: utf-8
 module Mongoid #:nodoc:
-  module Extras #:nodoc:
+
+  # Adds support for caching queries at the class level.
+  module Extras
     extend ActiveSupport::Concern
+
     included do
-      class_attribute :cached, :enslaved
+      class_attribute :cached
       self.cached = false
-      self.enslaved = false
-      delegate :cached?, :enslaved?, :to => "self.class"
+      delegate :cached?, :to => "self.class"
     end
 
     module ClassMethods #:nodoc
+
       # Sets caching on for this class. This class level configuration will
       # default all queries to cache the results of the first iteration over
       # the cursor into an internal array. This should only be used for queries
       # that return a small number of results or have small documents, as after
       # the first iteration the entire results will be stored in memory.
       #
-      # Example:
-      #
+      # @example Cache all reads for the class.
       #   class Person
       #     include Mongoid::Document
       #     cache
@@ -28,34 +30,13 @@ module Mongoid #:nodoc:
 
       # Determines if the class is cached or not.
       #
-      # Returns:
+      # @example Are class reads cached?
+      #   Document.cached?
       #
-      # True if cached, false if not.
+      # @return [ true, false ] If the reads are cached.
       def cached?
         !!self.cached
       end
-
-      # Set whether or not this documents read operations should delegate to
-      # the slave database by default.
-      #
-      # Example:
-      #
-      #   class Person
-      #     include Mongoid::Document
-      #     enslave
-      #   end
-      def enslave
-        self.enslaved = true
-      end
-
-      # Determines if the class is enslaved or not.
-      #
-      # Returns:
-      #
-      # True if enslaved, false if not.
-      def enslaved?
-        !!self.enslaved
-      end
     end
   end
 end

data/lib/mongoid/factory.rb

@@ -16,7 +16,7 @@ module Mongoid #:nodoc:
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = {})
       type = (attributes || {})["_type"]
-      type.blank? ? klass.new(attributes) : type.constantize.new(attributes)
+      (type && klass._types.include?(type)) ? type.constantize.new(attributes) : klass.new(attributes)
     end
 
     # Builds a new +Document+ from the supplied attributes loaded from the

data/lib/mongoid/fields.rb

@@ -1,4 +1,29 @@
 # encoding: utf-8
+require "mongoid/fields/mappings"
+require "mongoid/fields/serializable"
+require "mongoid/fields/serializable/timekeeping"
+require "mongoid/fields/serializable/array"
+require "mongoid/fields/serializable/big_decimal"
+require "mongoid/fields/serializable/binary"
+require "mongoid/fields/serializable/boolean"
+require "mongoid/fields/serializable/date"
+require "mongoid/fields/serializable/date_time"
+require "mongoid/fields/serializable/float"
+require "mongoid/fields/serializable/hash"
+require "mongoid/fields/serializable/integer"
+require "mongoid/fields/serializable/bignum"
+require "mongoid/fields/serializable/fixnum"
+require "mongoid/fields/serializable/object"
+require "mongoid/fields/serializable/object_id"
+require "mongoid/fields/serializable/range"
+require "mongoid/fields/serializable/set"
+require "mongoid/fields/serializable/string"
+require "mongoid/fields/serializable/symbol"
+require "mongoid/fields/serializable/time"
+require "mongoid/fields/serializable/time_with_zone"
+require "mongoid/fields/serializable/foreign_keys/array"
+require "mongoid/fields/serializable/foreign_keys/object"
+
 module Mongoid #:nodoc
 
   # This module defines behaviour for fields.
@@ -17,8 +42,61 @@ module Mongoid #:nodoc
       alias :id= :_id=
     end
 
+    class << self
+
+      # Stores the provided block to be run when the option name specified is
+      # defined on a field.
+      #
+      # No assumptions are made about what sort of work the handler might
+      # perform, so it will always be called if the `option_name` key is
+      # provided in the field definition -- even if it is false or nil.
+      #
+      # @example
+      #   Mongoid::Fields.option :required do |model, field, value|
+      #     model.validates_presence_of field if value
+      #   end
+      #
+      # @param [ Symbol ] option_name the option name to match against
+      # @param [ Proc ] block the handler to execute when the option is
+      #   provided.
+      #
+      # @since 2.1.0
+      def option(option_name, &block)
+        options[option_name] = block
+      end
+
+      # Return a map of custom option names to their handlers.
+      #
+      # @example
+      #   Mongoid::Fields.options
+      #   # => { :required => #<Proc:0x00000100976b38> }
+      #
+      # @return [ Hash ] the option map
+      #
+      # @since 2.1.0
+      def options
+        @options ||= {}
+      end
+    end
+
     module ClassMethods #:nodoc
 
+      # Returns the default values for the fields on the document.
+      #
+      # @example Get the defaults.
+      #   Person.defaults
+      #
+      # @return [ Hash ] The field defaults.
+      def defaults
+        @defaults ||= {}.tap do |defs|
+          fields.each_pair do |field_name, field|
+            unless (default = field.default).nil?
+              defs[field_name.to_s] = default
+            end
+          end
+        end
+      end
+
       # Defines all the fields that are accessible on the Document
       # For each field that is defined, a getter and setter will be
       # added as an instance method to the Document.
@@ -35,8 +113,7 @@ module Mongoid #:nodoc
       #
       # @return [ Field ] The generated field
       def field(name, options = {})
-        access = name.to_s
-        set_field(access, options)
+        add_field(name.to_s, options)
       end
 
       # Return the fields for this class.
@@ -63,20 +140,6 @@ module Mongoid #:nodoc
         @fields = fields
       end
 
-      # Returns the default values for the fields on the document.
-      #
-      # @example Get the defaults.
-      #   Person.defaults
-      #
-      # @return [ Hash ] The field defaults.
-      def defaults
-        fields.inject({}) do |defs, (field_name,field)|
-          next(defs) if field.default.nil?
-          defs[field_name.to_s] = field.default
-          defs
-        end
-      end
-
       # When inheriting, we want to copy the fields from the parent class and
       # set the on the child to start, mimicking the behaviour of the old
       # class_inheritable_accessor that was deprecated in Rails edge.
@@ -92,44 +155,69 @@ module Mongoid #:nodoc
         subclass.fields = fields.dup
       end
 
+      # Replace a field with a new type.
+      #
+      # @example Replace the field.
+      #   Model.replace_field("_id", String)
+      #
+      # @param [ String ] name The name of the field.
+      # @param [ Class ] type The new type of field.
+      #
+      # @return [ Serializable ] The new field.
+      #
+      # @since 2.1.0
+      def replace_field(name, type)
+        add_field(name, fields[name].options.merge(:type => type))
+      end
+
       protected
 
       # Define a field attribute for the +Document+.
       #
       # @example Set the field.
-      #   Person.set_field(:name, :default => "Test")
+      #   Person.add_field(:name, :default => "Test")
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The hash of options.
-      def set_field(name, options = {})
+      def add_field(name, options = {})
+        @defaults = nil if @defaults
+
         meth = options.delete(:as) || name
-        Field.new(name, options).tap do |field|
+        Mappings.for(
+          options[:type], options[:identity]
+        ).new(name, options).tap do |field|
           fields[name] = field
           create_accessors(name, meth, options)
-          add_dirty_methods(name)
           process_options(field)
+
+          # @todo Durran: Refactor this once we can depend on at least
+          #   ActiveModel greater than 3.0.9. They finally have the ability then
+          #   to add attribute methods one at a time. This code will make class
+          #   load times extremely slow.
+          undefine_attribute_methods
+          define_attribute_methods(fields.keys)
         end
       end
 
-      # Run through all custom options stored in Mongoid::Field.options and
+      # Run through all custom options stored in Mongoid::Fields.options and
       # execute the handler if the option is provided.
       #
       # @example
-      #   Mongoid::Field.option :custom do
+      #   Mongoid::Fields.option :custom do
       #     puts "called"
       #   end
       #
-      #   field = Mongoid::Field.new(:test, :custom => true)
+      #   field = Mongoid::Fields.new(:test, :custom => true)
       #   Person.process_options(field)
       #   # => "called"
       #
       # @param [ Field ] field the field to process
       def process_options(field)
-        options = field.options
+        field_options = field.options
 
-        Field.options.each do |option_name, handler|
-          if options.has_key?(option_name)
-            handler.call(self, field, options[option_name])
+        Fields.options.each_pair do |option_name, handler|
+          if field_options.has_key?(option_name)
+            handler.call(self, field, field_options[option_name])
           end
         end
       end
@@ -150,11 +238,15 @@ module Mongoid #:nodoc
         generated_field_methods.module_eval do
           if field.cast_on_read?
             define_method(meth) do
-              field.get(read_attribute(name))
+              field.deserialize(read_attribute(name))
             end
           else
             define_method(meth) do
-              read_attribute(name)
+              value = read_attribute(name)
+              if value.is_a?(Array) || value.is_a?(Hash)
+                changed_attributes[name] = value.clone unless attribute_changed?(name)
+              end
+              value
             end
           end
           define_method("#{meth}=") do |value|