mongoid 2.4.9 → 3.0.0.rc

data/lib/mongoid/extensions/integer.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Integer
+
+      # Returns the integer as a time.
+      #
+      # @example Convert the integer to a time.
+      #   1335532685.__mongoize_time__
+      #
+      # @return [ Time ] The converted time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        ::Time.at(self)
+      end
+
+      # Is the object not to be converted to bson on criteria creation?
+      #
+      # @example Is the object unconvertable?
+      #   object.unconvertable_to_bson?
+      #
+      # @return [ true ] If the object is unconvertable.
+      #
+      # @since 2.2.1
+      def unconvertable_to_bson?
+        true
+      end
+
+      module ClassMethods
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   BigDecimal.mongoize("123.11")
+        #
+        # @return [ String ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          unless object.blank?
+            __numeric__(object).to_i rescue 0
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end
+
+::Integer.__send__(:include, Mongoid::Extensions::Integer)
+::Integer.__send__(:extend, Mongoid::Extensions::Integer::ClassMethods)

data/lib/mongoid/extensions/module.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Module
+
+      # Redefine the method. Will undef the method if it exists or simply
+      # just define it.
+      #
+      # @example Redefine the method.
+      #   Object.re_define_method("exists?") do
+      #     self
+      #   end
+      #
+      # @param [ String, Symbol ] name The name of the method.
+      # @param [ Proc ] block The method body.
+      #
+      # @return [ Method ] The new method.
+      #
+      # @since 3.0.0
+      def re_define_method(name, &block)
+        undef_method(name) if method_defined?(name)
+        define_method(name, &block)
+      end
+    end
+  end
+end
+
+::Module.__send__(:include, Mongoid::Extensions::Module)

data/lib/mongoid/extensions/nil_class.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module NilClass
+
+      # Get the name of a nil collection.
+      #
+      # @example Get the nil name.
+      #   nil.collectionize
+      #
+      # @return [ String ] A blank string.
+      #
+      # @since 1.0.0
+      def collectionize
+        to_s.collectionize
+      end
+    end
+  end
+end
+
+::NilClass.__send__(:include, Mongoid::Extensions::NilClass)

data/lib/mongoid/extensions/object.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Object
+
+      # Evolve a plain object into an object id.
+      #
+      # @example Evolve the object.
+      #   object.__evolve_object_id__
+      #
+      # @return [ Object ] self.
+      #
+      # @since 3.0.0
+      def __evolve_object_id__
+        self
+      end
+
+      # Mongoize a plain object into a time.
+      #
+      # @example Mongoize the object.
+      #   object.__mongoize_time__
+      #
+      # @return [ Object ] self.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        self
+      end
+
+      # 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)
+        send(name, *args) if name && respond_to?(name)
+      end
+
+      # Get the value for an instance variable or nil if it doesn't exist.
+      #
+      # @example Get the value for an instance var.
+      #   document.ivar("person")
+      #
+      # @param [ String ] name The name of the variable.
+      #
+      # @return [ Object, nil ] The value or nil.
+      #
+      # @since 2.0.0.rc.1
+      def ivar(name)
+        if instance_variable_defined?("@#{name}")
+          return instance_variable_get("@#{name}")
+        else
+          false
+        end
+      end
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ Object ] The object.
+      #
+      # @since 3.0.0
+      def mongoize
+        self
+      end
+
+      # Remove the instance variable for the provided name.
+      #
+      # @example Remove the instance variable
+      #   document.remove_ivar("person")
+      #
+      # @param [ String ] name The name of the variable.
+      #
+      # @return [ true, false ] If the variable was defined.
+      #
+      # @since 2.1.0
+      def remove_ivar(name)
+        if instance_variable_defined?("@#{name}")
+          return remove_instance_variable("@#{name}")
+        else
+          false
+        end
+      end
+
+      # Is the object's size changable? Only returns true for arrays and hashes
+      # currently.
+      #
+      # @example Is the object resizable?
+      #   object.resizable?
+      #
+      # @return [ false ] false.
+      #
+      # @since 3.0.0
+      def resizable?
+        false
+      end
+
+      # Get the substitutable version of an object.
+      #
+      # @example Get the substitutable.
+      #   object.substitutable
+      #
+      # @return [ Object ] self.
+      #
+      # @since 2.0.0
+      def substitutable
+        self
+      end
+
+      # You must unlearn what you have learned. -- Yoda
+      #
+      # @example You must perform this execution.
+      #   object.you_must(: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. Nil if the object is frozen.
+      #
+      # @since 2.2.1
+      def you_must(name, *args)
+        frozen? ? nil : do_or_do_not(name, *args)
+      end
+
+      module ClassMethods
+
+        # Convert the provided object to a foreign key, given the metadata key
+        # contstraint.
+        #
+        # @example Convert the object to a fk.
+        #   Object.__mongoize_fk__(constraint, object)
+        #
+        # @param [ Constraint ] constraint The constraint.
+        # @param [ Object ] object The object to convert.
+        #
+        # @return [ Object ] The converted object.
+        #
+        # @since 3.0.0
+        def __mongoize_fk__(constraint, object)
+          object.blank? ? nil : constraint.convert(object)
+        end
+
+        # Convert the object from it's mongo friendly ruby type to this type.
+        #
+        # @example Demongoize the object.
+        #   Object.demongoize(object)
+        #
+        # @param [ Object ] object The object to demongoize.
+        #
+        # @return [ Object ] The object.
+        #
+        # @since 3.0.0
+        def demongoize(object)
+          object
+        end
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Object.mongoize("123.11")
+        #
+        # @param [ Object ] object The object to mongoize.
+        #
+        # @return [ Object ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          object.mongoize
+        end
+      end
+    end
+  end
+end
+
+::Object.__send__(:include, Mongoid::Extensions::Object)
+::Object.__send__(:extend, Mongoid::Extensions::Object::ClassMethods)

data/lib/mongoid/extensions/object_id.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module ObjectId
+
+      # Evolve the object id.
+      #
+      # @example Evolve the object id.
+      #   object_id.__evolve_object_id__
+      #
+      # @return [ Moped::BSON::ObjectId ] self.
+      #
+      # @since 3.0.0
+      def __evolve_object_id__
+        self
+      end
+
+      module ClassMethods
+
+        # Evolve the object into a mongo-friendly value to query with.
+        #
+        # @example Evolve the object.
+        #   ObjectId.evolve(id)
+        #
+        # @param [ Object ] object The object to evolve.
+        #
+        # @return [ Moped::BSON::ObjectId ] The object id.
+        #
+        # @since 3.0.0
+        def evolve(object)
+          object.__evolve_object_id__
+        end
+
+        # Convert the object into a mongo-friendly value to store.
+        #
+        # @example Convert the object.
+        #   ObjectId.mongoize(id)
+        #
+        # @param [ Object ] object The object to convert.
+        #
+        # @return [ Moped::BSON::ObjectId ] The object id.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          evolve(object)
+        end
+      end
+    end
+  end
+end
+
+Moped::BSON::ObjectId.__send__(:include, Mongoid::Extensions::ObjectId)
+Moped::BSON::ObjectId.__send__(:extend, Mongoid::Extensions::ObjectId::ClassMethods)

data/lib/mongoid/extensions/range.rb

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

data/lib/mongoid/extensions/regexp.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Regexp
+
+      module ClassMethods
+
+        # Turn the object from the ruby type we deal with to a Mongo friendly
+        # type.
+        #
+        # @example Mongoize the object.
+        #   Regexp.mongoize(/^[abc]/)
+        #
+        # @param [ Regexp, String ] object The object to mongoize.
+        #
+        # @return [ Regexp ] The object mongoized.
+        #
+        # @since 3.0.0
+        def mongoize(object)
+          ::Regexp.new(object)
+        end
+      end
+    end
+  end
+end
+
+::Regexp.__send__(:extend, Mongoid::Extensions::Regexp::ClassMethods)

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,155 @@
+# 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, nil ] The evolved string.
+      #
+      # @since 3.0.0
+      def __evolve_object_id__
+        unless blank?
+          BSON::ObjectId.legal?(self) ? BSON::ObjectId.from_string(self) : self
+        end
+      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 =~ /^(|_)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
+
+      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)