Add spec for InvalidFieldType

Author: johnnyshields

lib/config/locales/en.yml

@@ -186,7 +186,7 @@ en:
         invalid_field_type:
           message: "Invalid field type :%{type} for field :%{field} on model '%{klass}'."
           summary: "Model '%{klass}' defines a field :%{field} with an unknown :type value
-            '%{type}'. This value is neither present in Mongoid's default type mapping,
+            :%{type}. This value is neither present in Mongoid's default type mapping,
             nor defined in a custom field type mapping."
           resolution: "Please provide a valid :type value for the field. If you
             meant to define a custom field type, please do so first as follows:\n\n

lib/mongoid/errors.rb

@@ -15,6 +15,7 @@
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
 require "mongoid/errors/invalid_field_option"
+require "mongoid/errors/invalid_field_type"
 require "mongoid/errors/invalid_find"
 require "mongoid/errors/invalid_includes"
 require "mongoid/errors/invalid_index"

lib/mongoid/field_types.rb

@@ -4,6 +4,7 @@
 require "mongoid/fields/foreign_key"
 require "mongoid/fields/localized"
 require "mongoid/fields/validators"
+require "mongoid/fields/field_types"
 
 module Mongoid
 
@@ -199,7 +200,7 @@ def configure(&block)
       #     type :point, Point
       #   end
       def type(symbol, klass)
-        Mongoid::FieldTypes.define(symbol, klass)
+        Fields::FieldTypes.define(symbol, klass)
       end
 
       # Stores the provided block to be run when the option name specified is
@@ -575,7 +576,7 @@ def field_for(name, options)
       end
 
       def field_type_klass_for(field, type)
-        klass = Mongoid::FieldTypes.get(type)
+        klass = Fields::FieldTypes.get(type)
         return klass if klass
         raise Mongoid::Errors::InvalidFieldType.new(self.name, field, type)
       end

lib/mongoid/fields.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Fields
+
+    # Singleton module which contains a cache for field type definitions.
+    # Custom field types can be configured.
+    module FieldTypes
+      extend self
+
+      # For fields defined with symbols use the correct class.
+      DEFAULT_MAPPING = {
+        array: Array,
+        bigdecimal: BigDecimal,
+        big_decimal: BigDecimal,
+        binary: BSON::Binary,
+        boolean: Mongoid::Boolean,
+        date: Date,
+        datetime: DateTime,
+        date_time: DateTime,
+        decimal128: BSON::Decimal128,
+        double: Float,
+        float: Float,
+        hash: Hash,
+        integer: Integer,
+        object: Object,
+        object_id: BSON::ObjectId,
+        range: Range,
+        regexp: Regexp,
+        set: Set,
+        string: String,
+        stringified_symbol: Mongoid::StringifiedSymbol,
+        symbol: Symbol,
+        time: Time,
+        time_with_zone: ActiveSupport::TimeWithZone
+      }.with_indifferent_access.freeze
+
+      def get(value)
+        mapping[value] || handle_unmapped_type(value)
+      end
+
+      def define(symbol, klass)
+        mapping[symbol] = klass
+      end
+
+      delegate :delete, to: :mapping
+
+      def mapping
+        @mapping ||= DEFAULT_MAPPING.dup
+      end
+
+      def handle_unmapped_type(type)
+        return Object if type.nil?
+
+        if type.is_a?(Module)
+          symbol = type.name.demodulize.underscore
+          Mongoid.logger.warn(
+            "Using a Class (#{type}) as the field :type option is deprecated and will be removed in Mongoid 8.0. " +
+            "Please use a Symbol (:#{symbol}) instead."
+          )
+          return Mongoid::Boolean if type.to_s == 'Boolean'
+          return type
+        end
+
+        nil
+      end
+    end
+  end
+end

lib/mongoid/fields/field_types.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::Errors::InvalidFieldType do
+
+  describe "#message" do
+
+    let(:error) do
+      described_class.new(Person, :first_name, :stringgy)
+    end
+
+    it "contains the problem in the message" do
+      expect(error.message).to include(
+        "Invalid field type :stringgy for field :first_name on model 'Person'."
+      )
+    end
+
+    it "contains the summary in the message" do
+      expect(error.message).to include(
+        "Model 'Person' defines a field :first_name with an unknown :type value :stringgy."
+      )
+    end
+
+    it "contains the resolution in the message" do
+      expect(error.message).to include(
+        'Please provide a valid :type value for the field. If you meant to define'
+      )
+    end
+  end
+end