Merge pull request #2251 from dblock/upgrade-rubocop

dblock · web-flow · commit 07fa61adca36 · 2022-02-28T08:35:20.000-07:00
Upgraded RuboCop to 1.25.1.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,21 +2,22 @@
 
 #### Features
 
-* [#2233](https://github.com/ruby-grape/grape/pull/2233): A setting for disabling documentation to internal APIs - [@dnesteryuk](https://github.com/dnesteryuk).
-* [#2235](https://github.com/ruby-grape/grape/pull/2235): Add Ruby 3.1 to CI - [@petergoldstein](https://github.com/petergoldstein).
+* [#2233](https://github.com/ruby-grape/grape/pull/2233): Added `do_not_document!` for disabling documentation to internal APIs - [@dnesteryuk](https://github.com/dnesteryuk).
+* [#2235](https://github.com/ruby-grape/grape/pull/2235): Add support for Ruby 3.1 - [@petergoldstein](https://github.com/petergoldstein).
 * [#2248](https://github.com/ruby-grape/grape/pull/2248): Upgraded to rspec 3.11.0 - [@dblock](https://github.com/dblock).
-* [#2249](https://github.com/ruby-grape/grape/pull/2249): Split ci matrix, extract edge - [@dblock](https://github.com/dblock).
+* [#2249](https://github.com/ruby-grape/grape/pull/2249): Split CI matrix, extract edge - [@dblock](https://github.com/dblock).
+* [#2249](https://github.com/ruby-grape/grape/pull/2251): Upgraded to RuboCop 1.25.1 - [@dblock](https://github.com/dblock).
 * Your contribution here.
 
 #### Fixes
 
 * [#2222](https://github.com/ruby-grape/grape/pull/2222): Autoload types and validators - [@ericproulx](https://github.com/ericproulx).
 * [#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).
+* [#2234](https://github.com/ruby-grape/grape/pull/2234): Remove non-UTF8 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).
 * [#2244](https://github.com/ruby-grape/grape/pull/2244): Fix a breaking change in `Grape::Validations` provided in 1.6.1 - [@dm1try](https://github.com/dm1try).
-* [#2250](https://github.com/ruby-grape/grape/pull/2250): Add deprecation warning for unsupportedgrouptypeerror and missinggrouptypeerror - [@ericproulx](https://github.com/ericproulx).
+* [#2250](https://github.com/ruby-grape/grape/pull/2250): Add deprecation warning for `UnsupportedGroupTypeError` and `MissingGroupTypeError` - [@ericproulx](https://github.com/ericproulx).
 * Your contribution here.
 
 ### 1.6.2 (2021/12/30)
diff --git a/Gemfile b/Gemfile
@@ -10,8 +10,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/multi_json.gemfile b/gemfiles/multi_json.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/multi_xml.gemfile b/gemfiles/multi_xml.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rack1.gemfile b/gemfiles/rack1.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rack2.gemfile b/gemfiles/rack2.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rack2_2.gemfile b/gemfiles/rack2_2.gemfile
@@ -10,8 +10,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rack_edge.gemfile b/gemfiles/rack_edge.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rails_5.gemfile b/gemfiles/rails_5.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rails_6.gemfile b/gemfiles/rails_6.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rails_6_1.gemfile b/gemfiles/rails_6_1.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rails_7.gemfile b/gemfiles/rails_7.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/gemfiles/rails_edge.gemfile b/gemfiles/rails_edge.gemfile
@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'
@@ -10,8 +8,8 @@ group :development, :test do
   gem 'bundler'
   gem 'hashie'
   gem 'rake'
-  gem 'rubocop', '~> 1.23.0'
-  gem 'rubocop-ast', '~> 1.14.0'
+  gem 'rubocop', '1.25.1'
+  gem 'rubocop-ast'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rspec', require: false
 end
diff --git a/lib/grape/api/instance.rb b/lib/grape/api/instance.rb
@@ -101,7 +101,7 @@ def prepare_routes
         # block passed in. Allows for simple 'before' setups
         # of settings stack pushes.
         def nest(*blocks, &block)
-          blocks.reject!(&:nil?)
+          blocks.compact!
           if blocks.any?
             evaluate_as_instance_with_configuration(block) if block
             blocks.each { |b| evaluate_as_instance_with_configuration(b) }
diff --git a/spec/grape/api_spec.rb b/spec/grape/api_spec.rb
@@ -1216,7 +1216,7 @@ class DummyFormatClass
 
     it 'does not set Cache-Control' do
       get '/foo'
-      expect(last_response.headers['Cache-Control']).to eq(nil)
+      expect(last_response.headers['Cache-Control']).to be_nil
     end
 
     it 'sets content type for xml' do
@@ -1241,7 +1241,7 @@ class DummyFormatClass
 
     it 'returns raw data when content type binary' do
       image_filename = 'grape.png'
-      file = File.open(image_filename, 'rb', &:read)
+      file = File.binread(image_filename)
       subject.format :binary
       subject.get('/binary_file') { File.binread(image_filename) }
       get '/binary_file'
@@ -1273,7 +1273,7 @@ class DummyFormatClass
       get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1', 'SERVER_PROTOCOL' => 'HTTP/1.1'
 
       expect(last_response.headers['Content-Type']).to eq('text/plain')
-      expect(last_response.headers['Content-Length']).to eq(nil)
+      expect(last_response.headers['Content-Length']).to be_nil
       expect(last_response.headers['Cache-Control']).to eq('no-cache')
       expect(last_response.headers['Transfer-Encoding']).to eq('chunked')
 
diff --git a/spec/grape/dsl/headers_spec.rb b/spec/grape/dsl/headers_spec.rb
@@ -52,8 +52,8 @@ class Dummy
       context 'when no headers are set' do
         describe '#header' do
           it 'returns nil' do
-            expect(subject.header['First Key']).to be nil
-            expect(subject.header('First Key')).to be nil
+            expect(subject.header['First Key']).to be_nil
+            expect(subject.header('First Key')).to be_nil
           end
         end
       end
diff --git a/spec/grape/dsl/inside_route_spec.rb b/spec/grape/dsl/inside_route_spec.rb
@@ -23,7 +23,7 @@ def initialize
 
   describe '#version' do
     it 'defaults to nil' do
-      expect(subject.version).to be nil
+      expect(subject.version).to be_nil
     end
 
     it 'returns env[api.version]' do
@@ -165,7 +165,7 @@ def initialize
     end
 
     it 'returns default' do
-      expect(subject.content_type).to be nil
+      expect(subject.content_type).to be_nil
     end
   end
 
@@ -198,7 +198,7 @@ def initialize
     end
 
     it 'returns default' do
-      expect(subject.body).to be nil
+      expect(subject.body).to be_nil
     end
   end
 
@@ -313,7 +313,7 @@ def initialize
     end
 
     it 'returns default' do
-      expect(subject.sendfile).to be nil
+      expect(subject.sendfile).to be_nil
     end
   end
 
@@ -360,13 +360,13 @@ def initialize
         it 'sets Content-Length header to nil' do
           subject.stream file_path
 
-          expect(subject.header['Content-Length']).to eq nil
+          expect(subject.header['Content-Length']).to be_nil
         end
 
         it 'sets Transfer-Encoding header to nil' do
           subject.stream file_path
 
-          expect(subject.header['Transfer-Encoding']).to eq nil
+          expect(subject.header['Transfer-Encoding']).to be_nil
         end
       end
 
@@ -404,13 +404,13 @@ def initialize
         it 'sets Content-Length header to nil' do
           subject.stream stream_object
 
-          expect(subject.header['Content-Length']).to eq nil
+          expect(subject.header['Content-Length']).to be_nil
         end
 
         it 'sets Transfer-Encoding header to nil' do
           subject.stream stream_object
 
-          expect(subject.header['Transfer-Encoding']).to eq nil
+          expect(subject.header['Transfer-Encoding']).to be_nil
         end
       end
 
@@ -424,8 +424,8 @@ def initialize
     end
 
     it 'returns default' do
-      expect(subject.stream).to be nil
-      expect(subject.header['Cache-Control']).to eq nil
+      expect(subject.stream).to be_nil
+      expect(subject.header['Cache-Control']).to be_nil
     end
   end
 
diff --git a/spec/grape/endpoint/declared_spec.rb b/spec/grape/endpoint/declared_spec.rb
@@ -247,7 +247,7 @@ def app
       end
       get '/declared?first=one&other=two'
       expect(last_response.status).to eq(200)
-      expect(JSON.parse(last_response.body).key?(:other)).to eq false
+      expect(JSON.parse(last_response.body).key?(:other)).to be false
     end
 
     it 'stringifies if that option is passed' do
@@ -520,7 +520,7 @@ def app
       json = JSON.parse(last_response.body, symbolize_names: true)
 
       expect(json[:declared_params][:id]).to eq 123
-      expect(json[:declared_params_no_parent][:id]).to eq nil
+      expect(json[:declared_params_no_parent][:id]).to be_nil
     end
   end
 
diff --git a/spec/grape/exceptions/validation_spec.rb b/spec/grape/exceptions/validation_spec.rb
@@ -13,7 +13,7 @@
 
   context 'when message is a String' do
     it 'does not store the message_key' do
-      expect(described_class.new(params: ['id'], message: 'presence').message_key).to eq(nil)
+      expect(described_class.new(params: ['id'], message: 'presence').message_key).to be_nil
     end
   end
 end
diff --git a/spec/grape/middleware/versioner/header_spec.rb b/spec/grape/middleware/versioner/header_spec.rb
@@ -46,7 +46,7 @@
 
     it 'is nil if not provided' do
       status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor')
-      expect(env['api.format']).to be nil
+      expect(env['api.format']).to be_nil
       expect(status).to eq(200)
     end
 
@@ -64,7 +64,7 @@
 
         it 'is nil if not provided' do
           status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
-          expect(env['api.format']).to be nil
+          expect(env['api.format']).to be_nil
           expect(status).to eq(200)
         end
       end
diff --git a/spec/grape/validations/attributes_doc_spec.rb b/spec/grape/validations/attributes_doc_spec.rb
diff --git a/spec/grape/validations/types/primitive_coercer_spec.rb b/spec/grape/validations/types/primitive_coercer_spec.rb
