Refactor/autofix cops (#70)

* AF: Layout/DotPosition

* AF: If/Else/End alignments

* Fix other alignments in exception class

* AF Layout Space cops

* AF: Lint/AmbiguousRegexpLiteral

* AF: Lint/UnusedArg

* AF: RSpec/DescribedClass

* AF: RSpec/HookArgument

* AF: Style/Alias

* AF: Style/EmptyMethod

* AF: Style/GuardClause and IfUnlessModifier

* AF: Style/FrozenStringLiteral

* AF: Style/NumericLiterals

* AF: Style/PercentDelims

* AF: All redundant style cops

* AF: Symbol/Word Arrays

* Regen the TODO file after 50%+ fixes

* Update changelog

Author: luke-hill

.rubocop_todo.yml

@@ -1,50 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-11-15 15:51:35 UTC using RuboCop version 1.44.1.
+# on 2023-12-21 16:12:21 UTC using RuboCop version 1.44.1.
 # 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.
 
 # TODO: Nov '23 -> 25 files inspected, 132 offenses detected, 102 offenses autocorrectable
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'cucumber-wire.gemspec'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/DotPosition:
-  Exclude:
-    - 'lib/cucumber/wire/add_hooks_filter.rb'
-    - 'lib/cucumber/wire/request_handler.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/ElseAlignment:
-  Exclude:
-    - 'lib/cucumber/wire/exception.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith, Severity.
-# SupportedStylesAlignWith: keyword, variable, start_of_line
-Layout/EndAlignment:
-  Exclude:
-    - 'lib/cucumber/wire/exception.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns, IgnoredPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/cucumber/wire/exception.rb'
+# TODO: Nov '23 -> 25 files inspected, 53 offenses detected, 28 offenses autocorrectable
 
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
@@ -54,27 +17,6 @@ Layout/MultilineMethodCallIndentation:
   Exclude:
     - 'lib/cucumber/wire/request_handler.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Layout/SpaceAfterComma:
-  Exclude:
-    - 'lib/cucumber/wire/request_handler.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBrackets.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBrackets: space, no_space
-Layout/SpaceInsideArrayLiteralBrackets:
-  Exclude:
-    - 'features/support/fake_wire_server.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-Lint/AmbiguousRegexpLiteral:
-  Exclude:
-    - 'features/step_definitions/wire_steps.rb'
-
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowSafeAssignment.
@@ -101,13 +43,6 @@ Lint/ToJSON:
   Exclude:
     - 'lib/cucumber/wire/data_packet.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/cucumber/wire/snippet.rb'
-
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
@@ -141,16 +76,6 @@ Performance/RegexpMatch:
   Exclude:
     - 'lib/cucumber/wire/configuration.rb'
 
-# Offense count: 8
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SkipBlocks, EnforcedStyle.
-# SupportedStyles: described_class, explicit
-RSpec/DescribedClass:
-  Exclude:
-    - 'spec/cucumber/wire/configuration_spec.rb'
-    - 'spec/cucumber/wire/connections_spec.rb'
-    - 'spec/cucumber/wire/data_packet_spec.rb'
-
 # Offense count: 3
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
@@ -190,14 +115,6 @@ Security/YAMLLoad:
   Exclude:
     - 'lib/cucumber/wire/configuration.rb'
 
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: prefer_alias, prefer_alias_method
-Style/Alias:
-  Exclude:
-    - 'lib/cucumber/wire/protocol/requests.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
@@ -222,34 +139,6 @@ Style/ConditionalAssignment:
   Exclude:
     - 'lib/cucumber/wire/connection.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: compact, expanded
-Style/EmptyMethod:
-  Exclude:
-    - 'lib/cucumber/wire/request_handler.rb'
-
-# Offense count: 24
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
-Style/GuardClause:
-  Exclude:
-    - 'lib/cucumber/wire/exception.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
@@ -266,12 +155,6 @@ Style/MutableConstant:
   Exclude:
     - 'lib/cucumber/wire/configuration.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Strict, AllowedNumbers, AllowedPatterns.
-Style/NumericLiterals:
-  MinDigits: 6
-
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 Style/ParallelAssignment:
@@ -280,34 +163,6 @@ Style/ParallelAssignment:
     - 'lib/cucumber/wire/data_packet.rb'
     - 'lib/cucumber/wire/step_argument.rb'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'spec/cucumber/wire/configuration_spec.rb'
-    - 'spec/cucumber/wire/connection_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantBegin:
-  Exclude:
-    - 'features/support/fake_wire_server.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantPercentQ:
-  Exclude:
-    - 'spec/cucumber/wire/configuration_spec.rb'
-    - 'spec/cucumber/wire/connection_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'lib/cucumber/wire/configuration.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/RescueModifier:
@@ -335,18 +190,3 @@ Style/Semicolon:
 Style/StringConcatenation:
   Exclude:
     - 'features/support/fake_wire_server.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MinSize.
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: percent
-  MinSize: 4

CHANGELOG.md

@@ -10,7 +10,7 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [Unreleased]
 ### Added
-- Added some basic rubocop compliance to suite (More fixes to come) ([#69](https://github.com/cucumber/cucumber-ruby-wire/pull/69))
+- Added some basic rubocop compliance to suite (More fixes to come) ([#69](https://github.com/cucumber/cucumber-ruby-wire/pull/69) [#70](https://github.com/cucumber/cucumber-ruby-wire/pull/70))
 
 ### Changed
 

Gemfile

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-if ENV['CUCUMBER_RUBY_CORE']
-  gem 'cucumber-core', path: ENV['CUCUMBER_RUBY_CORE']
-end
+gem 'cucumber-core', path: ENV['CUCUMBER_RUBY_CORE'] if ENV['CUCUMBER_RUBY_CORE']
 
-if ENV['CUCUMBER_RUBY']
-  gem 'cucumber', path: ENV['CUCUMBER_RUBY']
-end
+gem 'cucumber', path: ENV['CUCUMBER_RUBY'] if ENV['CUCUMBER_RUBY']

Rakefile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-task default: [:unit_tests, :acceptance_tests]
+task default: %i[unit_tests acceptance_tests]
 
 task :unit_tests do
   sh 'bundle exec rspec'

cucumber-wire.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|

features/step_definitions/aruba_steps.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'aruba/cucumber'

features/step_definitions/wire_steps.rb

@@ -1,4 +1,6 @@
-Given /^there is a wire server (running |)on port (\d+) which understands the following protocol:$/ do |running, port, table|
+# frozen_string_literal: true
+
+Given(/^there is a wire server (running |)on port (\d+) which understands the following protocol:$/) do |running, port, table|
   protocol = table.hashes.map do |table_hash|
     table_hash['response'] = table_hash['response'].gsub(/\n/, '\n')
     table_hash
@@ -8,12 +10,12 @@
   start_wire_server if running.strip == 'running'
 end
 
-Given /^the wire server takes (.*) seconds to respond to the invoke message$/ do |timeout|
+Given(/^the wire server takes (.*) seconds to respond to the invoke message$/) do |timeout|
   @server.delay_response(:invoke, timeout.to_f)
   start_wire_server
 end
 
-Given /^I have environment variable (\w+) set to "([^"]*)"$/ do |variable, value|
+Given(/^I have environment variable (\w+) set to "([^"]*)"$/) do |variable, value|
   set_environment_variable(variable, value)
 end
 

features/support/fake_wire_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'socket'
 
@@ -23,14 +25,12 @@ def handle_connections(io)
   end
 
   def open_session_on(socket, io)
-    begin
-      on_message = lambda { |message| io.puts message }
-      SocketSession.new(socket, @protocol_table, @delays, on_message).start
-    rescue Exception => e
-      raise e
-    ensure
-      socket.close
-    end
+    on_message = lambda { |message| io.puts message }
+    SocketSession.new(socket, @protocol_table, @delays, on_message).start
+  rescue Exception => e
+    raise e
+  ensure
+    socket.close
   end
 
   class SocketSession
@@ -56,10 +56,10 @@ def handle(data)
         send_response(protocol_entry['response'])
       else
         serialized_exception = { message: "Not understood: #{data}", backtrace: [] }
-        send_response(['fail', serialized_exception ].to_json)
+        send_response(['fail', serialized_exception].to_json)
       end
     rescue => e
-      send_response(['fail', { message: e.message, backtrace: e.backtrace, exception: e.class } ].to_json)
+      send_response(['fail', { message: e.message, backtrace: e.backtrace, exception: e.class }].to_json)
     end
 
     def response_to(data)

lib/cucumber/wire.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/wire/plugin'
 
 return unless respond_to?(:InstallPlugin)

lib/cucumber/wire/add_hooks_filter.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Wire
     class AddHooksFilter < Core::Filter.new(:connections)
       def test_case(test_case)
-        test_case.
-          with_steps([before_hook(test_case)] + test_case.test_steps + [after_hook(test_case)]).
-          describe_to receiver
+        test_case
+          .with_steps([before_hook(test_case)] + test_case.test_steps + [after_hook(test_case)])
+          .describe_to receiver
       end
 
       def before_hook(test_case)

lib/cucumber/wire/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'erb'
 
@@ -19,7 +21,7 @@ def initialize(args)
       end
 
       def timeout(message = nil)
-        return @timeouts[message.to_s] || 3
+        @timeouts[message.to_s] || 3
       end
 
       def to_s

lib/cucumber/wire/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'timeout'
 require 'cucumber/wire/protocol'
 require 'cucumber/wire/exception'

lib/cucumber/wire/connections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'socket'
 require 'cucumber/wire/connection'

lib/cucumber/wire/data_packet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Cucumber