mongoid 2.0.2 → 2.1.0

data/lib/mongoid/fields/mappings.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Fields #:nodoc:
+
+    # This module maps classes used in field type definitions to the custom
+    # definable field in Mongoid.
+    module Mappings
+      extend self
+
+      MODULE = "Mongoid::Fields::Serializable"
+
+      # Get the custom field type for the provided class used in the field
+      # definition.
+      #
+      # @example Get the mapping for the class.
+      #   Mappings.for(BSON::ObjectId)
+      #
+      # @param [ Class ] klass The class to get the field type for.
+      #
+      # @return [ Class ] The class of the custom field.
+      #
+      # @since 2.1.0
+      def for(klass, foreign_key = false)
+        return Serializable::Object unless klass
+        if foreign_key
+          return "#{MODULE}::ForeignKeys::#{klass.to_s.demodulize}".constantize
+        end
+        begin
+          "#{MODULE}::#{klass.to_s.demodulize}".constantize
+        rescue NameError
+          klass
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+
+    # Defines the behaviour for defined fields in the document.
+    #
+    # For people who want to have custom field types in their
+    # applications and want control over the serialization process
+    # to and from the domain model and MongoDB you will need to include
+    # this module in your custom type class. You will also need to define
+    # either a #serialize and #deserialize instance method, where previously
+    # these were a .set and .get class method respectively.
+    #
+    #   class MyCustomType
+    #     include Mongoid::Fields::Serializable
+    #
+    #     def deserialize(object)
+    #       # Do something to convert it from Mongo to my type.
+    #     end
+    #
+    #     def serialize(object)
+    #       # Do something to convert from my type to MongoDB friendly.
+    #     end
+    #   end
+    module Serializable
+
+      # Set readers for the instance variables.
+      attr_reader :default_value, :label, :name, :options
+
+      # 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, false ] If the field should be cast.
+      #
+      # @since 2.1.0
+      def cast_on_read?
+        return @cast_on_read if defined?(@cast_on_read)
+        @cast_on_read =
+          self.class.public_instance_methods(false).map do |m|
+            m.to_sym
+          end.include?(:deserialize)
+      end
+
+      # Get the default value for the field.
+      #
+      # @example Get the default.
+      #   field.default
+      #
+      # @return [ Object ] The default value.
+      #
+      # @since 2.1.0
+      def default
+        if default_value.respond_to?(:call)
+          serialize(default_value.call)
+        else
+          serialize(default_value)
+        end
+      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 [ Object ] The converted object.
+      #
+      # @since 2.1.0
+      def deserialize(object); object; end
+
+      # Create the new field with a name and optional additional options.
+      #
+      # @example Create the new field.
+      #   Field.new(:name, :type => String)
+      #
+      # @param [ Hash ] options The field options.
+      #
+      # @option options [ Class ] :type The class of the field.
+      # @option options [ Object ] :default The default value for the field.
+      # @option options [ String ] :label The field's label.
+      #
+      # @since 2.1.0
+      def initialize(name, options = {})
+        @name, @options = name, options
+        @default_value, @label = options[:default], options[:label]
+      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 [ Object ] The converted object.
+      #
+      # @since 2.1.0
+      def serialize(object); object; end
+
+      # Get the type of this field - inferred from the class name.
+      #
+      # @example Get the type.
+      #   field.type
+      #
+      # @return [ Class ] The name of the class.
+      #
+      # @since 2.1.0
+      def type
+        @type ||= options[:type] || Object
+      end
+
+      # Is this field included in versioned attributes?
+      #
+      # @example Is the field versioned?
+      #   field.versioned?
+      #
+      # @return [ true, false ] If the field is included in versioning.
+      #
+      # @since 2.1.0
+      def versioned?
+        @versioned ||= (options[:versioned].nil? ? true : options[:versioned])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #: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.
+        #
+        # @since 2.1.0
+        def default
+          return nil unless default_value
+          default_value.respond_to?(:call) ? default_value.call : 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)
+          raise_or_return(object)
+        end
+        alias :set :serialize
+
+        protected
+
+        # If the value is not an array or nil we will raise an error,
+        # otherwise return the value.
+        #
+        # @example Raise or return the value.
+        #   field.raise_or_return([])
+        #
+        # @param [ Object ] value The value to check.a
+        #
+        # @raise [ InvalidType ] If not passed an array.
+        #
+        # @return [ Array ] The array.
+        #
+        # @since 2.1.0
+        def raise_or_return(value)
+          unless value.nil? || value.is_a?(::Array)
+            raise Mongoid::Errors::InvalidType.new(::Array, value)
+          end
+          value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for big decimal fields.
+      class BigDecimal
+        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 [ BigDecimal ] The converted big decimal.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+          object ? ::BigDecimal.new(object) : 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 [ String ] The converted string.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object ? object.to_s : object
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for bignum fields.
+      class Bignum < Integer
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for boolean fields.
+      class Boolean
+        include Serializable
+
+        MAPPINGS = {
+          true => true,
+          "true" => true,
+          "TRUE" => true,
+          "1" => true,
+          1 => true,
+          1.0 => true,
+          false => false,
+          "false" => false,
+          "FALSE" => false,
+          "0" => false,
+          0 => false,
+          0.0 => false
+        }
+
+        # 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 [ true, false ] The converted boolean.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          object = MAPPINGS[object]
+          object.nil? ? nil : object
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for date fields.
+      class Date
+        include Serializable
+        include Timekeeping
+
+        # 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 [ Date ] The converted date.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+         return nil if object.blank?
+          if Mongoid::Config.use_utc?
+            object.to_date
+          else
+            ::Date.new(object.year, object.month, object.day)
+          end
+        end
+
+        protected
+
+        # Converts the date to a time to persist.
+        #
+        # @example Convert the date to a time.
+        #   Date.convert_to_time(date)
+        #
+        # @param [ Date ] value The date to convert.
+        #
+        # @return [ Time ] The date converted.
+        #
+        # @since 2.1.0
+        def convert_to_time(value)
+          value = ::Date.parse(value) if value.is_a?(::String)
+          value = ::Date.civil(*value) if value.is_a?(::Array)
+          ::Time.utc(value.year, value.month, value.day)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for date time fields.
+      class DateTime
+        include Serializable
+        include Timekeeping
+
+        # 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 [ DateTime ] The converted date time.
+        #
+        # @since 2.1.0
+        def deserialize(object)
+          object.try(:to_datetime)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+      # Defines the behaviour for fixnum fields.
+      class Fixnum < Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for float fields.
+      class Float
+        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 [ Float ] The converted float.
+        #
+        # @since 2.1.0
+        def serialize(object)
+          return nil if object.blank?
+          begin
+            Float(object)
+          rescue ArgumentError => e
+            object
+          end
+        end
+        alias :set :serialize
+      end
+    end
+  end
+end