Apply safe autocorrections (#101)

* Enable new RuboCop and suppress in the existing lines at this moment

* Fix Style/Lambda

* Fix Style/StringLiterals

* Fix Style/QuotedSymbols

* Fix Style/NonNilCheck

* Fix Style/IfUnlessModifier

* Fix Style/RedundantConstantBase

* Fix Style/GuardClause

* Fix Style/FrozenStringLiteralComment

* Fix Style/FetchEnvVar

* Fix Style/ConditionalAssignment

* Fix Style/ColonMethodCall

* Fix Style/ExpandPathArguments

* Fix Style/UnpackFirst

* Fix Lint/SymbolConversion

* Fix Layout/LineLength

Author: exoego

.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.5
   Exclude:
     - 'spec/rails/**/*'

.rubocop_todo.yml

@@ -1,69 +1,70 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-14 14:36:06 +0900 using RuboCop version 0.82.0.
+# on 2023-04-13 07:32:16 UTC using RuboCop version 1.49.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'rspec-openapi.gemspec'
+
 # Offense count: 10
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 68
+  Max: 41
 
-# Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
   Max: 72
 
-# Offense count: 3
-# Configuration parameters: IgnoredMethods.
+# Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 14
+  Max: 12
 
-# Offense count: 14
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 13
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 53
+  Max: 38
 
 # Offense count: 2
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 12
 
 # Offense count: 1
 # Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Exclude:
     - 'lib/rspec/openapi/result_recorder.rb'
 
 # Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle.
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Security/IoMethods:
+  Exclude:
+    - 'spec/integration_tests/rails_test.rb'
+    - 'spec/requests/rails_spec.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/rspec/openapi.rb'
     - 'lib/rspec/openapi/schema_file.rb'
 
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/ColonMethodCall:
-  Exclude:
-    - 'lib/rspec/openapi/components_updater.rb'
-    - 'lib/rspec/openapi/schema_cleaner.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
-# SupportedStyles: assign_to_condition, assign_inside_condition
-Style/ConditionalAssignment:
-  Exclude:
-    - 'lib/rspec/openapi/schema_builder.rb'
-
 # Offense count: 5
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -74,92 +75,7 @@ Style/Documentation:
     - 'lib/rspec/openapi/schema_file.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'rspec-openapi.gemspec'
-
-# Offense count: 63
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/rspec/openapi/record_builder.rb'
-    - 'spec/rails/app/controllers/tables_controller.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/rspec/openapi/schema_cleaner.rb'
-    - 'lib/rspec/openapi/schema_file.rb'
-    - 'lib/rspec/openapi/schema_merger.rb'
-    - 'spec/rails/app/controllers/tables_controller.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: line_count_dependent, lambda, literal
-Style/Lambda:
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SelectByRegexp:
   Exclude:
     - 'spec/requests/roda_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IncludeSemanticChanges.
-Style/NonNilCheck:
-  Exclude:
-    - 'lib/rspec/openapi/hash_helper.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/StderrPuts:
-  Exclude:
-    - 'spec/rails/bin/yarn'
-
-# Offense count: 31
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'lib/rspec/openapi/record_builder.rb'
-    - 'lib/rspec/openapi/schema_merger.rb'
-    - 'spec/rails/bin/yarn'
-    - 'spec/rails/config/application.rb'
-    - 'spec/rails/config/environments/production.rb'
-    - 'spec/rails/config/puma.rb'
-    - 'spec/rails/config/spring.rb'
-    - 'spec/requests/rails_spec.rb'
-    - 'spec/rspec/rails_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: .
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: percent
-  MinSize: 6
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnpackFirst:
-  Exclude:
-    - 'spec/rails/app/controllers/images_controller.rb'
-    - 'spec/requests/rails_spec.rb'
-
-# Offense count: 103
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 213

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-openapi.gemspec
@@ -12,6 +14,6 @@ group :test do
 end
 
 group :development do
-  gem "code-scanning-rubocop"
+  gem 'code-scanning-rubocop'
   gem 'pry'
 end

Rakefile

@@ -1,5 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/rspec/openapi/**/*_spec.rb'

bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rspec/openapi"
+require 'bundler/setup'
+require 'rspec/openapi'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rspec/openapi"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

lib/rspec/openapi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/openapi/version'
 require 'rspec/openapi/components_updater'
 require 'rspec/openapi/default_schema'

lib/rspec/openapi/components_updater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'hash_helper'
 
 class << RSpec::OpenAPI::ComponentsUpdater = Object.new
@@ -52,8 +54,8 @@ def dig_schema(obj, paths)
   end
 
   def paths_to_top_level_refs(base)
-    request_bodies = RSpec::OpenAPI::HashHelper::matched_paths(base, 'paths.*.*.requestBody.content.application/json')
-    responses = RSpec::OpenAPI::HashHelper::matched_paths(base, 'paths.*.*.responses.*.content.application/json')
+    request_bodies = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.requestBody.content.application/json')
+    responses = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.responses.*.content.application/json')
     (request_bodies + responses).select do |paths|
       dig_schema(base, paths)&.dig('$ref')&.start_with?('#/components/schemas/')
     end

lib/rspec/openapi/default_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::DefaultSchema = Object.new
   def build(title)
     spec = {

lib/rspec/openapi/hash_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::HashHelper = Object.new
   def paths_to_all_fields(obj)
     case obj
@@ -15,7 +17,7 @@ def matched_paths(obj, selector)
     selector_parts = selector.split('.').map(&:to_s)
     paths_to_all_fields(obj).select do |key_parts|
       key_parts.size == selector_parts.size && key_parts.zip(selector_parts).all? do |kp, sp|
-        kp == sp || (sp == '*' && kp != nil)
+        kp == sp || (sp == '*' && !kp.nil?)
       end
     end
   end

lib/rspec/openapi/minitest_hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest'
 
 module RSpec

lib/rspec/openapi/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec::OpenAPI::Record = Struct.new(
   :http_method,           # @param [String]  - "GET"
   :path,                  # @param [String]  - "/v1/status/:id"

lib/rspec/openapi/record_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_dispatch'
 require 'rspec/openapi/record'
 
@@ -48,7 +50,7 @@ def build(context, example:)
       response_body: response_body,
       response_headers: response_headers,
       response_content_type: response.media_type,
-      response_content_disposition: response.header["Content-Disposition"],
+      response_content_disposition: response.header['Content-Disposition'],
     ).freeze
   end
 
@@ -103,11 +105,9 @@ def find_rails_route(request, app: Rails.application, fix_path: true)
 
     app.routes.router.recognize(request) do |route|
       if route.app.matches?(request)
-        if route.app.engine?
-          return find_rails_route(request, app: route.app.app, fix_path: false)
-        else
-          return route
-        end
+        return find_rails_route(request, app: route.app.app, fix_path: false) if route.app.engine?
+
+        return route
       end
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"

lib/rspec/openapi/result_recorder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module OpenAPI
     class ResultRecorder

lib/rspec/openapi/rspec_hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core'
 
 RSpec.configuration.after(:each) do |example|
@@ -13,7 +15,7 @@
   result_recorder.record_results!
   if result_recorder.errors?
     error_message = result_recorder.error_message
-    colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+    colorizer = RSpec::Core::Formatters::ConsoleCodes
     RSpec.configuration.reporter.message colorizer.wrap(error_message, :failure)
   end
 end

lib/rspec/openapi/schema_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class << RSpec::OpenAPI::SchemaBuilder = Object.new
   # @param [RSpec::OpenAPI::Record] record
   # @return [Hash]
@@ -132,11 +134,11 @@ def build_property(value, disposition: nil)
 
     case value
     when Array
-      if value.empty?
-        property[:items] = {} # unknown
-      else
-        property[:items] = build_property(value.first)
-      end
+      property[:items] = if value.empty?
+                           {} # unknown
+                         else
+                           build_property(value.first)
+                         end
     when Hash
       property[:properties] = {}.tap do |properties|
         value.each do |key, v|