mongoid 2.4.10 → 3.0.0

data/lib/mongoid/extensions/set.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Set
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   set.mongoize
+      #
+      # @return [ Hash ] The object mongoized.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::Set.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Set.demongoize({ "min" => 1, "max" => 5 })
+        #
+        # @param [ Hash ] object The object to demongoize.
+        #
+        # @return [ Set ] The set.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          ::Set.new(object)
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Set.mongoize(1..3)
+        #
+        # @param [ Set ] object The object to mongoize.
+        #
+        # @return [ Hash ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          object.to_a
+        end
+      end
+    end
+  end
+end
+
+::Set.__send__(:include, Mongoid::Extensions::Set)
+::Set.__send__(:extend, Mongoid::Extensions::Set::ClassMethods)

data/lib/mongoid/extensions/string.rb

@@ -0,0 +1,181 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module String
+
+      # @attribute [rw] unconvertable_to_bson If the document is unconvetable.
+      attr_accessor :unconvertable_to_bson
+
+      # Evolve the string into an object id if possible.
+      #
+      # @example Evolve the string.
+      #   "test".__evolve_object_id__
+      #
+      # @return [ String, Moped::BSON::ObjectId ] The evolved string.
+      #
+      # @since 3.0.0
+      def __evolve_object_id__
+        convert_to_object_id
+      end
+
+      # Mongoize the string into an object id if possible.
+      #
+      # @example Evolve the string.
+      #   "test".__mongoize_object_id__
+      #
+      # @return [ String, Moped::BSON::ObjectId, nil ] The mongoized string.
+      #
+      # @since 3.0.0
+      def __mongoize_object_id__
+        convert_to_object_id unless blank?
+      end
+
+      # Mongoize the string for storage.
+      #
+      # @example Mongoize the string.
+      #   "2012-01-01".__mongoize_time__
+      #
+      # @return [ Time ] The time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        ::Time.configured.parse(self)
+      end
+
+      # Convert the string to a collection friendly name.
+      #
+      # @example Collectionize the string.
+      #   "namespace/model".collectionize
+      #
+      # @return [ String ] The string in collection friendly form.
+      #
+      # @since 1.0.0
+      def collectionize
+        tableize.gsub("/", "_")
+      end
+
+      # Is the string a valid value for a Mongoid id?
+      #
+      # @example Is the string an id value?
+      #   "_id".mongoid_id?
+      #
+      # @return [ true, false ] If the string is id or _id.
+      #
+      # @since 2.3.1
+      def mongoid_id?
+        self =~ /\A(|_)id$/
+      end
+
+      # Is the string a number?
+      #
+      # @example Is the string a number.
+      #   "1234.23".numeric?
+      #
+      # @return [ true, false ] If the string is a number.
+      #
+      # @since 3.0.0
+      def numeric?
+        true if Float(self) rescue false
+      end
+
+      # Get the string as a getter string.
+      #
+      # @example Get the reader/getter
+      #   "model=".reader
+      #
+      # @return [ String ] The string stripped of "=".
+      #
+      # @since 1.0.0
+      def reader
+        delete("=")
+      end
+
+      # Convert the string to an array with the string in it.
+      #
+      # @example Convert the string to an array.
+      #   "Testing".to_a
+      #
+      # @return [ Array ] An array with only the string in it.
+      #
+      # @since 1.0.0
+      def to_a
+        [ self ]
+      end
+
+      # Is this string a writer?
+      #
+      # @example Is the string a setter method?
+      #   "model=".writer?
+      #
+      # @return [ true, false ] If the string contains "=".
+      #
+      # @since 1.0.0
+      def writer?
+        include?("=")
+      end
+
+      # Is the object not to be converted to bson on criteria creation?
+      #
+      # @example Is the object unconvertable?
+      #   object.unconvertable_to_bson?
+      #
+      # @return [ true, false ] If the object is unconvertable.
+      #
+      # @since 2.2.1
+      def unconvertable_to_bson?
+        @unconvertable_to_bson ||= false
+      end
+
+      private
+
+      # If the string is a legal object id, convert it.
+      #
+      # @api private
+      #
+      # @example Convert to the object id.
+      #   string.convert_to_object_id
+      #
+      # @return [ String, Moped::BSON::ObjectId ] The string or the id.
+      #
+      # @since 3.0.0
+      def convert_to_object_id
+        Moped::BSON::ObjectId.legal?(self) ? Moped::BSON::ObjectId.from_string(self) : self
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   String.demongoize(object)
+        #
+        # @param [ Object ] object The object to demongoize.
+        #
+        # @return [ String ] The object.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          object.try(:to_s)
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   String.mongoize("123.11")
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ String ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          demongoize(object)
+        end
+      end
+    end
+  end
+end
+
+::String.__send__(:include, Mongoid::Extensions::String)
+::String.__send__(:extend, Mongoid::Extensions::String::ClassMethods)

data/lib/mongoid/extensions/symbol.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Symbol
+
+      # Is the symbol a valid value for a Mongoid id?
+      #
+      # @example Is the string an id value?
+      #   :_id.mongoid_id?
+      #
+      # @return [ true, false ] If the symbol is :id or :_id.
+      #
+      # @since 2.3.1
+      def mongoid_id?
+        to_s.mongoid_id?
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Symbol.demongoize(object)
+        #
+        # @param [ Object ] object The object to demongoize.
+        #
+        # @return [ Symbol ] The object.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          object.try(:to_sym)
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Symbol.mongoize("123.11")
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ Symbol ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          demongoize(object)
+        end
+      end
+    end
+  end
+end
+
+::Symbol.__send__(:include, Mongoid::Extensions::Symbol)
+::Symbol.__send__(:extend, Mongoid::Extensions::Symbol::ClassMethods)

data/lib/mongoid/extensions/time.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Time
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   time.mongoize
+      #
+      # @return [ Time ] The object mongoized.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::Time.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Get the configured time to use when converting - either the time zone
+        # or the time.
+        #
+        # @example Get the configured time.
+        #   ::Time.configured
+        #
+        # @retun [ Time ] The configured time.
+        #
+        # @since 3.0.0
+        def configured
+          Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
+        end
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Time.demongoize(object)
+        #
+        # @param [ Time ] object The time from Mongo.
+        #
+        # @return [ Time ] The object as a date.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          return nil if object.blank?
+          object = object.getlocal unless Mongoid::Config.use_utc?
+          if Mongoid::Config.use_activesupport_time_zone?
+            object = object.in_time_zone(Mongoid.time_zone)
+          end
+          object
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Time.mongoize("2012-1-1")
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ Time ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          return nil if object.blank?
+          begin
+            ::Time.at(object.__mongoize_time__.to_f).utc
+          rescue ArgumentError
+            raise Errors::InvalidTime.new(object)
+          end
+        end
+      end
+    end
+  end
+end
+
+::Time.__send__(:include, Mongoid::Extensions::Time)
+::Time.__send__(:extend, Mongoid::Extensions::Time::ClassMethods)

data/lib/mongoid/extensions/time_with_zone.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module TimeWithZone
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   date_time.mongoize
+      #
+      # @return [ Time ] The object mongoized.
+      #
+      # @since 3.0.0
+      def mongoize
+        ::ActiveSupport::TimeWithZone.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   TimeWithZone.demongoize(object)
+        #
+        # @param [ Time ] object The time from Mongo.
+        #
+        # @return [ TimeWithZone ] The object as a date.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          ::Time.demongoize(object).in_time_zone
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   TimeWithZone.mongoize("2012-1-1")
+        #
+        # @param [ Object ] object The object to convert.
+        #
+        # @return [ Time ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          ::Time.mongoize(object)
+        end
+      end
+    end
+  end
+end
+
+::ActiveSupport::TimeWithZone.__send__(:include, Mongoid::Extensions::TimeWithZone)
+::ActiveSupport::TimeWithZone.__send__(:extend, Mongoid::Extensions::TimeWithZone::ClassMethods)

data/lib/mongoid/extensions/true_class.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module TrueClass
+
+      # Get the value of the object as a mongo friendy sort value.
+      #
+      # @example Get the object as sort criteria.
+      #   object.__sortable__
+      #
+      # @return [ Integer ] 1.
+      #
+      # @since 3.0.0
+      def __sortable__
+        1
+      end
+
+      # 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)
+        if other == ::Boolean || other.class == ::Boolean
+          return true
+        end
+        super(other)
+      end
+    end
+  end
+end
+
+::TrueClass.__send__(:include, Mongoid::Extensions::TrueClass)

data/lib/mongoid/extensions.rb

@@ -1,84 +1,10 @@
 # encoding: utf-8
-require "mongoid/extensions/array/deep_copy"
-require "mongoid/extensions/array/deletion"
-require "mongoid/extensions/false_class/equality"
-require "mongoid/extensions/hash/deep_copy"
-require "mongoid/extensions/hash/criteria_helpers"
-require "mongoid/extensions/hash/scoping"
-require "mongoid/extensions/integer/checks"
-require "mongoid/extensions/nil/collectionization"
-require "mongoid/extensions/object/checks"
-require "mongoid/extensions/object/deep_copy"
-require "mongoid/extensions/object/reflections"
-require "mongoid/extensions/object/substitutable"
-require "mongoid/extensions/object/yoda"
-require "mongoid/extensions/proc/scoping"
-require "mongoid/extensions/string/checks"
-require "mongoid/extensions/string/conversions"
-require "mongoid/extensions/string/inflections"
-require "mongoid/extensions/symbol/checks"
-require "mongoid/extensions/symbol/inflections"
-require "mongoid/extensions/true_class/equality"
-require "mongoid/extensions/object_id/conversions"
-
-class Array #:nodoc
-  include Mongoid::Extensions::Array::DeepCopy
-  include Mongoid::Extensions::Array::Deletion
-end
-
-class Binary; end #:nodoc:
 unless defined?(Boolean)
   class Boolean; end
 end
 
-class FalseClass #:nodoc
-  include Mongoid::Extensions::FalseClass::Equality
-end
-
-class Hash #:nodoc
-  include Mongoid::Extensions::Hash::DeepCopy
-  include Mongoid::Extensions::Hash::CriteriaHelpers
-  include Mongoid::Extensions::Hash::Scoping
-end
-
-class Integer #:nodoc
-  include Mongoid::Extensions::Integer::Checks
-end
-
-class NilClass #:nodoc
-  include Mongoid::Extensions::Nil::Collectionization
-end
-
-class Object #:nodoc:
-  include Mongoid::Extensions::Object::Checks
-  include Mongoid::Extensions::Object::DeepCopy
-  include Mongoid::Extensions::Object::Reflections
-  include Mongoid::Extensions::Object::Substitutable
-  include Mongoid::Extensions::Object::Yoda
-end
-
-class Proc #:nodoc:
-  include Mongoid::Extensions::Proc::Scoping
-end
-
-class String #:nodoc
-  include Mongoid::Extensions::String::Checks
-  include Mongoid::Extensions::String::Conversions
-  include Mongoid::Extensions::String::Inflections
-end
-
-class Symbol #:nodoc
-  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
-  include Mongoid::Extensions::Symbol::Checks
-  include Mongoid::Extensions::Symbol::Inflections
-end
-
-class TrueClass #:nodoc
-  include Mongoid::Extensions::TrueClass::Equality
-end
-
-class BSON::ObjectId #:nodoc
-  extend Mongoid::Extensions::ObjectId::Conversions
+class Moped::BSON::ObjectId
+  undef :as_json
   def as_json(options = nil)
     to_s
   end
@@ -86,3 +12,29 @@ class BSON::ObjectId #:nodoc
     ActiveSupport::XmlMini.to_tag(options[:root], self.to_s, options)
   end
 end
+
+class Symbol
+  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
+end
+
+require "mongoid/extensions/array"
+require "mongoid/extensions/big_decimal"
+require "mongoid/extensions/boolean"
+require "mongoid/extensions/date"
+require "mongoid/extensions/date_time"
+require "mongoid/extensions/false_class"
+require "mongoid/extensions/float"
+require "mongoid/extensions/hash"
+require "mongoid/extensions/integer"
+require "mongoid/extensions/module"
+require "mongoid/extensions/nil_class"
+require "mongoid/extensions/object"
+require "mongoid/extensions/object_id"
+require "mongoid/extensions/range"
+require "mongoid/extensions/regexp"
+require "mongoid/extensions/set"
+require "mongoid/extensions/string"
+require "mongoid/extensions/symbol"
+require "mongoid/extensions/time"
+require "mongoid/extensions/time_with_zone"
+require "mongoid/extensions/true_class"

data/lib/mongoid/factory.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
 
   # Instantiates documents that came from the database.
   module Factory