Rename InvalidFieldType --> UnknownFieldType

Author: johnnyshields

docs/release-notes/mongoid-8.0.txt

@@ -288,7 +288,7 @@ Mongoid 8 behavior:
     include Mongoid::Document
 
     field :name, type: :bogus
-    # => raises Mongoid::Errors::InvalidFieldType
+    # => raises Mongoid::Errors::UnknownFieldType
   end
 
 Mongoid 7 behavior:

lib/config/locales/en.yml

@@ -175,22 +175,6 @@ en:
             \_\_end\n\n
             Refer to:
             https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-options"
-        invalid_field_type:
-          message: "Invalid field type %{type_inspection} for field '%{field}' on model '%{klass}'."
-          summary: "Model '%{klass}' declares a field '%{field}' with an unknown type value
-            %{type_inspection}. 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
-            \_\_Mongoid::Fields.configure do\n
-            \_\_\_\_define_type %{type_inspection}, YourTypeClass
-            \_\_end\n
-            \_\_class %{klass}\n
-            \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_field :%{field}, type: %{type_inspection}\n
-            \_\_end\n\n
-            Refer to:
-            https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-types"
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments
@@ -572,6 +556,22 @@ en:
           resolution: "Define the field '%{name}' in %{klass}, or include
             Mongoid::Attributes::Dynamic in %{klass} if you intend to
             store values in fields that are not explicitly defined."
+        unknown_field_type:
+          message: "Unknown field type %{type_inspection} for field '%{field}' on model '%{klass}'."
+          summary: "Model '%{klass}' declares a field '%{field}' with an unknown type value
+            %{type_inspection}. This value is neither present in Mongoid's default type mapping,
+            nor defined in a custom field type mapping."
+          resolution: "Please provide a known type value for the field. If you
+            meant to define a custom field type, please do so first as follows:\n\n
+            \_\_Mongoid::Fields.configure do\n
+            \_\_\_\_define_type %{type_inspection}, YourTypeClass
+            \_\_end\n
+            \_\_class %{klass}\n
+            \_\_\_\_include Mongoid::Document\n
+            \_\_\_\_field :%{field}, type: %{type_inspection}\n
+            \_\_end\n\n
+            Refer to:
+            https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-types"
         unknown_model:
           message: "Attempted to instantiate an object of the unknown model '%{klass}'."
           summary: "A document with the value '%{value}' at the key '_type' was used to

lib/mongoid/errors/invalid_field_type.rb renamed to lib/mongoid/errors/unknown_field_type.rb

@@ -5,19 +5,19 @@ module Errors
 
     # This error is raised when trying to define a field using a :type option value
     # that is not present in the field type mapping.
-    class InvalidFieldType < MongoidError
+    class UnknownFieldType < MongoidError
 
       # Create the new error.
       #
       # @example Instantiate the error.
-      #   InvalidFieldType.new('Person', 'first_name', 'stringgy')
+      #   UnknownFieldType.new('Person', 'first_name', 'stringgy')
       #
       # @param [ String ] klass The model class.
       # @param [ String ] field The field on which the invalid type is used.
       # @param [ Symbol | String ] type The value of the field :type option.
       def initialize(klass, field, type)
         super(
-          compose_message('invalid_field_type',
+          compose_message('unknown_field_type',
             klass: klass, field: field, type_inspection: type.inspect)
         )
       end

lib/mongoid/fields.rb

@@ -742,7 +742,7 @@ def field_for(name, options)
         if type = options[:type]
           type = Fields::FieldTypes.get(type)
           unless type
-            raise Mongoid::Errors::InvalidFieldType.new(self.name, field, type)
+            raise Mongoid::Errors::UnknownFieldType.new(self.name, field, type)
           end
           opts[:type] = type
         end

lib/mongoid/fields/field_types.rb

@@ -54,7 +54,7 @@ def get(field_type)
           when Symbol, String
             mapping[field_type]
           else
-            raise Mongoid::Errors::InvalidFieldType.new(self.name, field, field_type)
+            raise Mongoid::Errors::UnknownFieldType.new(self.name, field, field_type)
           end
         end
 

spec/mongoid/errors/invalid_field_type_spec.rb renamed to spec/mongoid/errors/unknown_field_type_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-describe Mongoid::Errors::InvalidFieldType do
+describe Mongoid::Errors::UnknownFieldType do
 
   describe "#message" do
 
@@ -17,7 +17,7 @@
 
       it "contains the problem in the message" do
         expect(error.message).to include(
-          "Invalid field type :stringgy for field 'first_name' on model 'Person'."
+          "Unknown field type :stringgy for field 'first_name' on model 'Person'."
         )
       end
 
@@ -35,7 +35,7 @@
 
       it "contains the problem in the message" do
         expect(error.message).to include(
-          %q,Invalid field type "stringgy" for field 'first_name' on model 'Person'.,
+          %q,Unknown field type "stringgy" for field 'first_name' on model 'Person'.,
         )
       end
 
@@ -48,7 +48,7 @@
 
     it "contains the resolution in the message" do
       expect(error.message).to include(
-        'Please provide a valid type value for the field.'
+        'Please provide a known type value for the field.'
       )
     end
   end

spec/mongoid/fields_spec.rb

@@ -363,18 +363,18 @@
       end
 
       context 'when using an unknown symbol' do
-        it 'raises InvalidFieldType' do
+        it 'raises UnknownFieldType' do
           lambda do
             klass.field(:test, type: :bogus)
-          end.should raise_error(Mongoid::Errors::InvalidFieldType, /declares a field 'test' with an unknown type value :bogus/)
+          end.should raise_error(Mongoid::Errors::UnknownFieldType, /declares a field 'test' with an unknown type value :bogus/)
         end
       end
 
       context 'when using an unknown string' do
-        it 'raises InvalidFieldType' do
+        it 'raises UnknownFieldType' do
           lambda do
             klass.field(:test, type: 'bogus')
-          end.should raise_error(Mongoid::Errors::InvalidFieldType, /declares a field 'test' with an unknown type value "bogus"/)
+          end.should raise_error(Mongoid::Errors::UnknownFieldType, /declares a field 'test' with an unknown type value "bogus"/)
         end
       end
     end