mongoid 2.4.10 → 3.0.0

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

@@ -1,42 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #:nodoc:
-
-      # Defines the behaviour for string fields.
-      class String
-        include Serializable
-
-        # Special case to serialize the object.
-        #
-        # @example Convert to a selection.
-        #   field.selection(object)
-        #
-        # @param [ Object ] The object to convert.
-        #
-        # @return [ Object ] The converted object.
-        #
-        # @since 2.4.0
-        def selection(object)
-          return object if object.is_a?(::Hash)
-          serialize(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.try(:to_s)
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #:nodoc:
-
-      # Defines the behaviour for symbol fields.
-      class Symbol
-        include Serializable
-
-        # Special case to serialize the object.
-        #
-        # @example Convert to a selection.
-        #   field.selection(object)
-        #
-        # @param [ Object ] The object to convert.
-        #
-        # @return [ Object ] The converted object.
-        #
-        # @since 2.4.0
-        def selection(object)
-          return object if object.is_a?(::Hash)
-          serialize(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 [ Symbol ] The converted symbol.
-        #
-        # @since 2.1.0
-        def serialize(object)
-          object.blank? ? nil : object.to_sym
-        end
-        alias :deserialize :serialize
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #:nodoc:
-      # Defines the behaviour for date fields.
-      class Time
-        include Serializable
-        include 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
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #:nodoc:
-      # Defines the behaviour for time with zone fields.
-      class TimeWithZone
-        include Serializable
-        include 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
-      end
-    end
-  end
-end

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

@@ -1,122 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #: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
-
-        # Special case to serialize the object.
-        #
-        # @example Convert to a selection.
-        #   field.selection(object)
-        #
-        # @param [ Object ] The object to convert.
-        #
-        # @return [ Object ] The converted object.
-        #
-        # @since 2.4.0
-        def selection(object)
-          return object if object.is_a?(::Hash)
-          serialize(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?
-          begin
-            time = convert_to_time(object)
-            strip_milliseconds(time).utc
-          rescue ArgumentError
-            raise Errors::InvalidTime.new(object)
-          end
-        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
-              return value if value.utc? && Mongoid.use_utc?
-              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

data/lib/mongoid/fields/internal/true_class.rb

@@ -1,10 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
-    module Internal #:nodoc:
-      # Defines the behaviour for true values.
-      class TrueClass < Boolean
-      end
-    end
-  end
-end

data/lib/mongoid/fields/mappings.rb

@@ -1,42 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc
-  module Fields #:nodoc:
-
-    module Internal #:nodoc:
-    end
-
-    # This module maps classes used in field type definitions to the custom
-    # definable field in Mongoid.
-    module Mappings
-      extend self
-
-      # 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)
-        if klass.nil?
-          Internal::Object
-        elsif foreign_key
-          Internal::ForeignKeys.const_get(klass.to_s)
-        else
-          modules = "BSON::|ActiveSupport::"
-          match = klass.to_s.match(Regexp.new("^(#{ modules })?(\\w+)$"))
-          if match and Internal.const_defined?(match[2])
-            Internal.const_get(match[2])
-          else
-            klass
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/mongoid/fields/serializable.rb

@@ -1,270 +0,0 @@
-# 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 fields = Threaded.selection
-          evaluated_default(doc) if included?(fields)
-        else
-          evaluated_default(doc)
-        end
-      end
-
-      # Is this field a foreign key?
-      #
-      # @example Is the field a foreign key?
-      #   field.foreign_key?
-      #
-      # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
-      def foreign_key?
-        !!options[:identity]
-      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
-
-      # Can the field vary in size, similar to arrays.
-      #
-      # @example Is the field varying in size?
-      #   field.resizable?
-      #
-      # @return [ false ] false by default.
-      #
-      # @since 2.4.0
-      def resizable?; false; 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
-
-      # Convert the provided object to a Mongoid criteria friendly value.
-      #
-      # @example Convert the field.
-      #   field.selection(object)
-      #
-      # @param [ Object ] The object to convert.
-      #
-      # @return [ Object ] The converted object.
-      #
-      # @since 2.4.0
-      def selection(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
-
-      private
-
-      # Is the field included in the fields that were returned from the
-      # database? We can apply the default if:
-      #   1. The field is included in an only limitation (field: 1)
-      #   2. The field is not excluded in a without limitation (field: 0)
-      #
-      # @example Is the field included?
-      #   field.included?(fields)
-      #
-      # @param [ Hash ] fields The field limitations.
-      #
-      # @return [ true, false ] If the field was included.
-      #
-      # @since 2.4.4
-      def included?(fields)
-        (fields.values.first == 1 && fields[name.to_sym] == 1) ||
-          (fields.values.first == 0 && !fields.has_key?(name.to_sym))
-      end
-
-      # Get the evaluated default.
-      #
-      # @example Get the evaluated default.
-      #   field.evaluated_default.
-      #
-      # @param [ Document ] doc The doc being applied to.
-      #
-      # @return [ Object ] The default value.
-      #
-      # @since 2.4.4
-      def evaluated_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
-
-      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]
-          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/identity.rb

@@ -1,92 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  class Identity #:nodoc:
-
-    attr_reader :document
-
-    # Create the identity for the document. The id will be set in either in
-    # the form of a Mongo object id or a composite key set up by defining
-    # a key on the document. The _type will be set to the document's class
-    # name.
-    #
-    # @example Create the id and set the type.
-    #   identity.create
-    def create
-      identify.tap { type }
-    end
-
-    # Create the new identity generator - this will be expanded in the future
-    # to support pk generators.
-    #
-    # @example
-    #   Identity.new(document)
-    #
-    # @param [ Document ] document The document to generate an id for.
-    #
-    # @return [ Identity ] The new identity object.
-    def initialize(document)
-      @document = document
-    end
-
-    private
-
-    # Return the proper id for the document. Will be an object id or its string
-    # representation depending on the configuration.
-    #
-    # @example Generate the id.
-    #   identity.generate_id
-    #
-    # @return [ Object ] The bson object id or its string equivalent.
-    def generate_id
-      id = BSON::ObjectId.new
-      document.using_object_ids? ? id : id.to_s
-    end
-
-    # Sets the id on the document. Will either set a newly generated id or
-    # build the composite key.
-    #
-    # @example Set the id.
-    #   identity.identify
-    def identify
-      document.id = compose.join(" ").identify if document.primary_key
-      document.id = generate_id if document.id.blank?
-      document.id
-    end
-
-    # Set the _type field on the document if the document is hereditary or in a
-    # polymorphic relation.
-    #
-    # @example Set the type.
-    #   identity.type
-    def type
-      document._type = document.class.name if typed?
-    end
-
-    # Generates the array of keys to build the id.
-    #
-    # @example Build the array for the keys.
-    #   identity.compose.
-    #
-    # @return [ Array<Object> ] The array of keys.
-    def compose
-      kf = document.key_formatter
-      document.primary_key.collect do |key|
-        val = document.attributes[key.to_s]
-        val && kf ? kf.call(val) : val
-      end.compact
-    end
-
-    # Determines if the document stores the type information. This is if it is
-    # in a hierarchy, has subclasses, or is in a polymorphic relation.
-    #
-    # @example Check if the document is typed.
-    #   identity.typed?
-    #
-    # @return [ true, false ] True if typed, false if not.
-    def typed?
-      document.hereditary? ||
-        document.class.descendants.any? ||
-        document.polymorphic?
-    end
-  end
-end