mongoid-multi-db 3.0.0

data/lib/mongoid/fields/mappings.rb

@@ -0,0 +1,41 @@
+# 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
+          modules = "#{ MODULE }::|BSON::|ActiveSupport::"
+          if match = klass.to_s.match(Regexp.new("^(#{ modules })?(\\w+)$"))
+            "#{MODULE}::#{ match[2] }".constantize
+          else
+            klass.to_s.constantize
+          end
+        rescue NameError
+          klass
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/fields/serializable.rb

@@ -0,0 +1,201 @@
+# 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
+      extend ActiveSupport::Concern
+
+      included do
+        # @todo: Durran: Pull out in 3.0.0
+        unless method_defined?(:default)
+          alias :default :default_val
+        end
+
+        class_attribute :cast_on_read
+      end
+
+      # Set readers for the instance variables.
+      attr_accessor :default_val, :label, :localize, :name, :options
+
+      # 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 ||= metadata.constraint
+      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
+
+      # Evaluate the default value and return it. Will handle the
+      # serialization, proc calls, and duplication if necessary.
+      #
+      # @example Evaluate the default value.
+      #   field.eval_default(document)
+      #
+      # @param [ Document ] doc The document the field belongs to.
+      #
+      # @return [ Object ] The serialized default value.
+      #
+      # @since 2.1.8
+      def eval_default(doc)
+        if default_val.respond_to?(:call)
+          serialize(doc.instance_exec(&default_val))
+        else
+          serialize(default_val.duplicable? ? default_val.dup : default_val)
+        end
+      end
+
+      # Is the field localized or not?
+      #
+      # @example Is the field localized?
+      #   field.localized?
+      #
+      # @return [ true, false ] If the field is localized.
+      #
+      # @since 2.3.0
+      def localized?
+        !!@localize
+      end
+
+      # Get the metadata for the field if its a foreign key.
+      #
+      # @example Get the metadata.
+      #   field.metadata
+      #
+      # @return [ Metadata ] The relation metadata.
+      #
+      # @since 2.2.0
+      def metadata
+        @metadata ||= options[:metadata]
+      end
+
+      # Is the field a BSON::ObjectId?
+      #
+      # @example Is the field a BSON::ObjectId?
+      #   field.object_id_field?
+      #
+      # @return [ true, false ] If the field is a BSON::ObjectId.
+      #
+      # @since 2.2.0
+      def object_id_field?
+        @object_id_field ||= (type == BSON::ObjectId)
+      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
+
+      module ClassMethods #:nodoc:
+
+        # 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 instantiate(name, options = {})
+          allocate.tap do |field|
+            field.name = name
+            field.options = options
+            field.label = options[:label]
+            field.localize = options[:localize]
+            field.default_val = options[:default]
+            unless field.default_val
+              field.default_val = {} if field.localized?
+            end
+          end
+        end
+
+        private
+
+        # If we define a method called deserialize then we need to cast on
+        # read.
+        #
+        # @example Hook into method added.
+        #   method_added(:deserialize)
+        #
+        # @param [ Symbol ] method The method name.
+        #
+        # @since 2.3.4
+        def method_added(method)
+          self.cast_on_read = true if method == :deserialize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Serializable #:nodoc:
+
+      # Defines the behaviour for array fields.
+      class Array
+        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)
+          raise_or_return(object)
+        end
+
+        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,43 @@
+# 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
+      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