Add InvalidFieldTypeDefinition error + various cleanups

Author: johnnyshields

lib/config/locales/en.yml

@@ -175,6 +175,14 @@ en:
             \_\_end\n\n
             Refer to:
             https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-options"
+        invalid_field_type_definition:
+          message: "The field type definition of %{type_inspection} to %{klass_inspection} is invalid."
+          summary: "In the field type definition, either field_type %{type_inspection} is not
+            a Symbol or String, and/or klass %{klass_inspection} is not a Class or Module."
+          resolution: "Please ensure you are specifying field_type as either a Symbol or String,
+            and klass as a Class or Module.\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

lib/mongoid/errors.rb

@@ -14,7 +14,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_field_type_definition"
 require "mongoid/errors/invalid_find"
 require "mongoid/errors/invalid_includes"
 require "mongoid/errors/invalid_index"
@@ -55,6 +55,7 @@
 require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
 require "mongoid/errors/unknown_attribute"
+require "mongoid/errors/unknown_field_type"
 require "mongoid/errors/unknown_model"
 require "mongoid/errors/unsaved_document"
 require "mongoid/errors/unsupported_javascript"

lib/mongoid/errors/invalid_field_type_definition.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to define a field type mapping with
+    # invalid argument types.
+    class InvalidFieldTypeDefinition < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidFieldTypeDefinition.new('number', 123)
+      #
+      # @param [ Object ] field_type The object which is expected to a be Symbol or String.
+      # @param [ Object ] klass The object which is expected to be a Class or Module.
+      def initialize(field_type, klass)
+        super(
+          compose_message('invalid_field_type_definition',
+            type_inspection: field_type.inspect, klass_inspection: klass.inspect)
+        )
+      end
+    end
+  end
+end

lib/mongoid/fields.rb

@@ -16,7 +16,7 @@ module Fields
     Boolean = Mongoid::Boolean
 
     # @deprecated
-    TYPE_MAPPINGS = ::Mongoid::Fields::FieldTypes::DEFAULT_ALIASES
+    TYPE_MAPPINGS = ::Mongoid::Fields::FieldTypes::DEFAULT_MAPPING
 
     # Constant for all names of the _id field in a document.
     #
@@ -244,11 +244,13 @@ def configure(&block)
       #     define_type :point, Point
       #   end
       #
-      # @param [ Symbol ] symbol the symbol identifier of the defined type
-      # @param [ Class ] klass the class of the defined type, which must
-      #   include mongoize and related methods.
-      def define_type(symbol, klass)
-        Fields::FieldTypes.define(symbol, klass)
+      # @param [ Symbol | String ] field_type the identifier of the
+      #   defined type. This identifier will be accessible as either a
+      #   string or a symbol regardless of the type passed to this method.
+      # @param [ Module ] klass the class of the defined type, which must
+      #   include mongoize, demongoize, and evolve methods.
+      def define_type(field_type, klass)
+        Fields::FieldTypes.define_type(field_type, klass)
       end
 
       # Stores the provided block to be run when the option name specified is

lib/mongoid/fields/field_types.rb

@@ -9,10 +9,10 @@ module Fields
     # @api private
     module FieldTypes
 
-      # The default mapping of field type symbol/string aliases to classes.
+      # The default mapping of field type symbol/string identifiers to classes.
       #
       # @api private
-      DEFAULT_ALIASES = {
+      DEFAULT_MAPPING = {
         array: Array,
         big_decimal: BigDecimal,
         binary: BSON::Binary,
@@ -42,15 +42,15 @@ class << self
         # @example
         #   Mongoid::FieldTypes.get(:point)
         #
-        # @param [ Class | Symbol | String | Class ] field_type The field
-        #   type class or its string or symbol alias.
+        # @param [ Module | Symbol | String ] field_type The field
+        #   type class or its string or symbol identifier.
         #
-        # @return [ Class | nil ] The underlying field type class, or nil if
+        # @return [ Module | nil ] The underlying field type class, or nil if
         #   string or symbol was passed and it is not mapped to any class.
         def get(field_type)
           case field_type
-          when Class
-            type
+          when Module
+            field_type
           when Symbol, String
             mapping[field_type]
           else
@@ -61,21 +61,18 @@ def get(field_type)
         # Defines a field type mapping, for later use in field :type option.
         #
         # @example
-        #   Mongoid::FieldTypes.define(:point, Point)
+        #   Mongoid::FieldTypes.define_type(:point, Point)
         #
-        # @param [ Symbol | String ] field_type_alias the string or symbol
-        #   alias of the defined type. The alias will be accessible as a string
-        #   or a symbol regardless of the type passed to this method.
+        # @param [ Symbol | String ] field_type the identifier of the
+        #   defined type. This identifier will be accessible as either a
+        #   string or a symbol regardless of the type passed to this method.
         # @param [ Class ] klass the class of the defined type, which must
         #   include mongoize, demongoize, and evolve methods.
-        def define_alias(field_type_alias, klass)
-          unless field_type_alias.is_a?(String) || field_type_alias.is_a?(Symbol)
-            raise Mongoid::Errors::InvalidFieldTypeAliasName.new(field_type_alias)
+        def define_type(field_type, klass)
+          unless (field_type.is_a?(String) || field_type.is_a?(Symbol)) && klass.is_a?(Module)
+            raise Mongoid::Errors::InvalidFieldTypeDefinition.new(field_type, klass)
           end
-          unless klass.is_a?(Class)
-            raise Mongoid::Errors::InvalidFieldTypeAliasValue.new(field_type_alias, klass)
-          end
-          mapping[field_type_alias] = klass
+          mapping[field_type] = klass
         end
 
         delegate :delete, to: :mapping
@@ -84,7 +81,7 @@ def define_alias(field_type_alias, klass)
         #
         # @return [ ActiveSupport::HashWithIndifferentAccess<Symbol, Class> ] The memoized field mapping.
         def mapping
-          @mapping ||= DEFAULT_ALIASES.dup
+          @mapping ||= DEFAULT_MAPPING.dup
         end
       end
     end

spec/mongoid/errors/invalid_field_type_definition_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::Errors::InvalidFieldTypeDefinition do
+
+  describe "#message" do
+
+    context 'when field_type is the wrong type' do
+      let(:error) do
+        described_class.new(123, Integer)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "The field type definition of 123 to Integer is invalid."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "In the field type definition, either field_type 123 is not a Symbol"
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          'Please ensure you are specifying field_type as either a Symbol'
+        )
+      end
+    end
+
+    context 'when klass is the wrong type' do
+      let(:error) do
+        described_class.new('number', 123)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          'The field type definition of "number" to 123 is invalid.'
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          'In the field type definition, either field_type "number" is not a Symbol'
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          'Please ensure you are specifying field_type as either a Symbol'
+        )
+      end
+    end
+  end
+end

spec/mongoid/errors/unknown_field_type_spec.rb

@@ -26,6 +26,12 @@
           "Model 'Person' declares 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 known type value for the field.'
+        )
+      end
     end
 
     context 'when type is a string' do