mongoid_heroku_stable 4.0.0

data/lib/mongoid/extensions/range.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Range
+
+      # Get the range as arguments for a find.
+      #
+      # @example Get the range as find args.
+      #   range.__find_args__
+      #
+      # @return [ Array ] The range as an array.
+      #
+      # @since 3.0.0
+      def __find_args__
+        to_a
+      end
+
+      # 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
+
+      # Is this a resizable object.
+      #
+      # @example Is this resizable?
+      #   range.resizable?
+      #
+      # @return [ true ] True.
+      #
+      # @since 3.0.0
+      def resizable?
+        true
+      end
+
+      module ClassMethods
+
+        # Convert the object from its 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"], object["exclude_end"])
+        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)
+          return nil if object.nil?
+          return object if object.is_a?(::Hash)
+          hash = { "min" => object.first, "max" => object.last }
+          if object.respond_to?(:exclude_end?) && object.exclude_end?
+            hash.merge!("exclude_end" => true)
+          end
+          hash
+        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 its 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,199 @@
+# 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__
+      #
+      # @note The extra parse from Time is because ActiveSupport::TimeZone
+      #   either returns nil or Time.now if the string is empty or invalid,
+      #   which is a regression from pre-3.0 and also does not agree with
+      #   the core Time API.
+      #
+      # @return [ Time ] The time.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        ::Time.parse(self)
+        ::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 (self == "NaN")
+      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("=").sub(/\_before\_type\_cast$/, '')
+      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 this string a valid_method_name?
+      #
+      # @example Is the string a valid Ruby idenfier for use as a method name
+      #   "model=".valid_method_name?
+      #
+      # @return [ true, false ] If the string contains a valid Ruby identifier.
+      #
+      # @since 3.0.15
+      def valid_method_name?
+        /[@$"]/ !~ self
+      end
+
+      # Does the string end with _before_type_cast?
+      #
+      # @example Is the string a setter method?
+      #   "price_before_type_cast".before_type_cast?
+      #
+      # @return [ true, false ] If the string ends with "_before_type_cast"
+      #
+      # @since 3.1.0
+      def before_type_cast?
+        ends_with?("_before_type_cast")
+      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 its 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 its 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,88 @@
+# encoding: utf-8
+module Mongoid
+  module Extensions
+    module Time
+
+      # Constant for epoch - used when passing invalid times.
+      EPOCH = ::Time.utc(1970, 1, 1, 0, 0, 0)
+
+      # 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 its 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 = object.__mongoize_time__
+            if object.respond_to?(:sec_fraction)
+              ::Time.at(time.to_i, object.sec_fraction * 10**6).utc
+            elsif time.respond_to?(:subsec)
+              ::Time.at(time.to_i, time.subsec * 10**6).utc
+            else
+              ::Time.at(time.to_i, time.usec).utc
+            end
+          rescue ArgumentError
+            EPOCH
+          end
+        end
+      end
+    end
+  end
+end
+
+::Time.__send__(:include, Mongoid::Extensions::Time)
+::Time.__send__(:extend, Mongoid::Extensions::Time::ClassMethods)