mongoid 2.0.2 → 2.1.0

data/lib/mongoid/fields/serializable/foreign_keys/array.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      module ForeignKeys #:nodoc:
+
+        # Defines the behaviour for array fields.
+        class Array
+          include Serializable
+
+          # Get the default value for the field. If the default is a proc call
+          # it, otherwise clone the array.
+          #
+          # @example Get the default.
+          #   field.default
+          #
+          # @return [ Object ] The default value cloned.
+          #
+          # @since 2.1.0
+          def default
+            default_value.dup
+          end
+
+          # Serialize the object from the type defined in the model to a MongoDB
+          # compatible object to store.
+          #
+          # @example Serialize the field.
+          #   field.serialize(object)
+          #
+          # @param [ Object ] object The object to cast.
+          #
+          # @return [ Array ] The converted object.
+          #
+          # @since 2.1.0
+          def serialize(object)
+            object.blank? ? [] : constraint.convert(object)
+          end
+
+          protected
+
+          # Get the constraint from the metadata once.
+          #
+          # @example Get the constraint.
+          #   field.constraint
+          #
+          # @return [ Constraint ] The relation's contraint.
+          #
+          # @since 2.1.0
+          def constraint
+            @constraint ||= options[:metadata].constraint
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/foreign_keys/object.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      module ForeignKeys #:nodoc:
+
+        # Defines the behaviour for integer foreign key fields.
+        class Object
+          include Serializable
+
+          # Serialize the object from the type defined in the model to a MongoDB
+          # compatible object to store.
+          #
+          # @example Serialize the field.
+          #   field.serialize(object)
+          #
+          # @param [ Object ] object The object to cast.
+          #
+          # @return [ Array ] The converted object.
+          #
+          # @since 2.1.0
+          def serialize(object)
+            object.blank? ? nil : constraint.convert(object)
+          end
+
+          protected
+
+          # Get the constraint from the metadata once.
+          #
+          # @example Get the constraint.
+          #   field.constraint
+          #
+          # @return [ Constraint ] The relation's contraint.
+          #
+          # @since 2.1.0
+          def constraint
+            @constraint ||= options[:metadata].constraint
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/hash.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for hash fields.
+      class Hash
+        include Serializable
+
+        # Get the default value for the field. If the default is a proc call
+        # it, otherwise clone the array.
+        #
+        # @example Get the default.
+        #   field.default
+        #
+        # @return [ Object ] The default value.
+        #
+        # @since 2.1.0
+        def default
+          return nil unless default_value
+          default_value.respond_to?(:call) ? default_value.call : default_value.dup
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/integer.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for integer fields.
+      class Integer
+        include Serializable
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Integer ] The converted integer.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          return nil if object.blank?
+          begin
+            object.to_s =~ /\./ ? Float(object) : Integer(object)
+          rescue
+            object
+          end
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/object.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for object fields.
+      class Object
+        include Serializable
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/object_id.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for BSON::ObjectId fields.
+      class ObjectId
+        include Serializable
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ BSON::ObjectId ] The converted object id.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          if object.is_a?(::String)
+            BSON::ObjectId.from_string(object) unless object.blank?
+          else
+            object
+          end
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/range.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for range fields.
+      class Range
+        include Serializable
+
+        # Deserialize this field from the type stored in MongoDB to the type
+        # defined on the model.
+        #
+        # @example Deserialize the field.
+        #   field.deserialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Range ] The converted range.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+          object.nil? ? nil : ::Range.new(object["min"], object["max"])
+        end
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Hash ] The converted hash.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object.nil? ? nil : { "min" => object.min, "max" => object.max }
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/set.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for set fields.
+      class Set
+        include Serializable
+
+        # Deserialize this field from the type stored in MongoDB to the type
+        # defined on the model.
+        #
+        # @example Deserialize the field.
+        #   field.deserialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Set ] The converted set.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+          ::Set.new(object)
+        end
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Array ] The converted array.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object.to_a
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/string.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for string fields.
+      class String
+        include Serializable
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ String ] The converted string.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object.try(:to_s)
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/symbol.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for symbol fields.
+      class Symbol
+        include Serializable
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Symbol ] The converted symbol.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object.blank? ? nil : object.to_sym
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/time.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for date fields.
+      class Time
+        include Serializable
+        include Timekeeping
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/time_with_zone.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for time with zone fields.
+      class TimeWithZone
+        include Serializable
+        include Timekeeping
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable/timekeeping.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # This module contains shared behaviour for date conversions.
+      module Timekeeping
+
+        # When reading the field do we need to cast the value? This holds true when
+        # times are stored or for big decimals which are stored as strings.
+        #
+        # @example Typecast on a read?
+        #   field.cast_on_read?
+        #
+        # @return [ true ] Date fields cast on read.
+        #
+        # @since 2.1.0
+        def cast_on_read?; true; end
+
+        # Deserialize this field from the type stored in MongoDB to the type
+        # defined on the model.
+        #
+        # @example Deserialize the field.
+        #   field.deserialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Time ] The converted time.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+          return nil if object.blank?
+          object = object.getlocal unless Mongoid::Config.use_utc?
+          if Mongoid::Config.use_activesupport_time_zone?
+            time_zone = Mongoid::Config.use_utc? ? 'UTC' : ::Time.zone
+            object = object.in_time_zone(time_zone)
+          end
+          object
+        end
+
+        # Serialize the object from the type defined in the model to a MongoDB
+        # compatible object to store.
+        #
+        # @example Serialize the field.
+        #   field.serialize(object)
+        #
+        # @param [ Object ] object The object to cast.
+        #
+        # @return [ Time ] The converted UTC time.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          return nil if object.blank?
+          time = convert_to_time(object)
+          strip_milliseconds(time).utc
+        end
+
+        # Convert the provided object to a UTC time to store in the database.
+        #
+        # @example Set the time.
+        #   Time.convert_to_time(Date.today)
+        #
+        # @param [ String, Date, DateTime, Array ] value The object to cast.
+        #
+        # @return [ Time ] The object as a UTC time.
+        #
+        # @since 1.0.0
+        def convert_to_time(value)
+          time = Mongoid::Config.use_activesupport_time_zone? ? ::Time.zone : ::Time
+          case value
+            when ::String
+              time.parse(value)
+            when ::DateTime
+              time.local(value.year, value.month, value.day, value.hour, value.min, value.sec)
+            when ::Date
+              time.local(value.year, value.month, value.day)
+            when ::Array
+              time.local(*value)
+            else
+              value
+          end
+        end
+
+        # Strip the milliseconds off the time.
+        #
+        # @todo Durran: Why is this here? Still need time refactoring.
+        #
+        # @example Strip.
+        #   Time.strip_millseconds(Time.now)
+        #
+        # @param [ Time ] time The time to strip.
+        #
+        # @return [ Time ] The time without millis.
+        #
+        # @since 2.1.0
+        def strip_milliseconds(time)
+          ::Time.at(time.to_i)
+        end
+      end
+    end
+  end
+end