Rename MissingGroupType and UnsupportedGroupType (#2227)

* Rename MissingGroupType and UnsupportedGroupType

* Add CHANGELOG.md AND UPGRADING.md entries

* Quote classes

* Add for more information

* Add alias for MissingGroupType and UnsupportedGroupeType

* Add Final newline missing.

Author: ericproulx

CHANGELOG.md

@@ -12,6 +12,7 @@
 * [#2232](https://github.com/ruby-grape/grape/pull/2232): Fix kwargs support in shared params definition - [@dm1try](https://github.com/dm1try).
 * [#2229](https://github.com/ruby-grape/grape/pull/2229): Do not collect params in route settings - [@dnesteryuk](https://github.com/dnesteryuk).
 * [#2234](https://github.com/ruby-grape/grape/pull/2234): Remove non-utf-8 characters from format before generating JSON error - [@bschmeck](https://github.com/bschmeck).
+* [#2227](https://github.com/ruby-grape/grape/pull/2222): Rename "MissingGroupType" and "UnsupportedGroupType" exceptions - [@ericproulx](https://github.com/ericproulx).
 * Your contribution here.
 
 ### 1.6.2 (2021/12/30)

UPGRADING.md

@@ -1,6 +1,17 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 1.6.3
+
+#### Exceptions renaming
+
+The following exceptions has been renamed for consistency through exceptions naming :
+
+* `MissingGroupTypeError` => `MissingGroupType`
+* `UnsupportedGroupTypeError` => `UnsupportedGroupType`
+
+See [#2227](https://github.com/ruby-grape/grape/pull/2227) for more information.
+
 ### Upgrading to >= 1.6.0
 
 #### Parameter renaming with :as

lib/grape.rb

@@ -73,8 +73,8 @@ module Exceptions
       autoload :UnknownParameter
       autoload :InvalidWithOptionForRepresent
       autoload :IncompatibleOptionValues
-      autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
-      autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
+      autoload :MissingGroupType
+      autoload :UnsupportedGroupType
       autoload :InvalidMessageBody
       autoload :InvalidAcceptHeader
       autoload :InvalidVersionHeader

lib/grape/dsl/parameters.rb

@@ -148,8 +148,8 @@ def optional(*attrs, &block)
 
         # check type for optional parameter group
         if attrs && block
-          raise Grape::Exceptions::MissingGroupTypeError.new if type.nil?
-          raise Grape::Exceptions::UnsupportedGroupTypeError.new unless Grape::Validations::Types.group?(type)
+          raise Grape::Exceptions::MissingGroupType if type.nil?
+          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)
         end
 
         if opts[:using]

lib/grape/exceptions/missing_group_type.rb

@@ -2,10 +2,12 @@
 
 module Grape
   module Exceptions
-    class MissingGroupTypeError < Base
+    class MissingGroupType < Base
       def initialize
         super(message: compose_message(:missing_group_type))
       end
     end
   end
 end
+
+Grape::Exceptions::MissingGroupTypeError = Grape::Exceptions::MissingGroupType

lib/grape/exceptions/unsupported_group_type.rb

@@ -2,10 +2,12 @@
 
 module Grape
   module Exceptions
-    class UnsupportedGroupTypeError < Base
+    class UnsupportedGroupType < Base
       def initialize
         super(message: compose_message(:unsupported_group_type))
       end
     end
   end
 end
+
+Grape::Exceptions::UnsupportedGroupTypeError = Grape::Exceptions::UnsupportedGroupType

lib/grape/validations/params_scope.rb

@@ -208,8 +208,8 @@ def new_scope(attrs, optional = false, &block)
         # if required params are grouped and no type or unsupported type is provided, raise an error
         type = attrs[1] ? attrs[1][:type] : nil
         if attrs.first && !optional
-          raise Grape::Exceptions::MissingGroupTypeError.new if type.nil?
-          raise Grape::Exceptions::UnsupportedGroupTypeError.new unless Grape::Validations::Types.group?(type)
+          raise Grape::Exceptions::MissingGroupType if type.nil?
+          raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)
         end
 
         self.class.new(

spec/grape/exceptions/missing_group_type_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Exceptions::MissingGroupType do
+  describe '#message' do
+    subject { described_class.new.message }
+
+    it { is_expected.to include 'group type is required' }
+  end
+
+  describe '#alias' do
+    subject { described_class }
+
+    it { is_expected.to eq(Grape::Exceptions::MissingGroupTypeError) }
+  end
+end

spec/grape/exceptions/unsupported_group_type_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Exceptions::UnsupportedGroupType do
+  subject { described_class.new }
+
+  describe '#message' do
+    subject { described_class.new.message }
+
+    it { is_expected.to include 'group type must be Array, Hash, JSON or Array[JSON]' }
+  end
+
+  describe '#alias' do
+    subject { described_class }
+
+    it { is_expected.to eq(Grape::Exceptions::UnsupportedGroupTypeError) }
+  end
+end

spec/grape/validations/params_scope_spec.rb

@@ -256,15 +256,15 @@ def initialize(value)
             requires :b
           end
         end
-      end.to raise_error Grape::Exceptions::MissingGroupTypeError
+      end.to raise_error Grape::Exceptions::MissingGroupType
 
       expect do
         subject.params do
           optional :a do
             requires :b
           end
         end
-      end.to raise_error Grape::Exceptions::MissingGroupTypeError
+      end.to raise_error Grape::Exceptions::MissingGroupType
     end
 
     it 'allows Hash as type' do
@@ -324,15 +324,15 @@ def initialize(value)
             requires :b
           end
         end
-      end.to raise_error Grape::Exceptions::UnsupportedGroupTypeError
+      end.to raise_error Grape::Exceptions::UnsupportedGroupType
 
       expect do
         subject.params do
           optional :a, type: Set do
             requires :b
           end
         end
-      end.to raise_error Grape::Exceptions::UnsupportedGroupTypeError
+      end.to raise_error Grape::Exceptions::UnsupportedGroupType
     end
   end