Merge pull request #1222 from cucumber/AsciiComments

Fix Style/AsciiComments

.rubocop_todo.yml

@@ -108,23 +108,6 @@ Style/Alias:
   Exclude:
     - 'lib/cucumber/formatter/ansicolor.rb'
 
-# Offense count: 23
-Style/AsciiComments:
-  Exclude:
-    - 'lib/cucumber/encoding.rb'
-    - 'lib/cucumber/events/gherkin_source_read.rb'
-    - 'lib/cucumber/events/step_activated.rb'
-    - 'lib/cucumber/events/step_definition_registered.rb'
-    - 'lib/cucumber/events/test_run_finished.rb'
-    - 'lib/cucumber/events/test_run_started.rb'
-    - 'lib/cucumber/events/test_step_started.rb'
-    - 'lib/cucumber/filters/randomizer.rb'
-    - 'lib/cucumber/formatter/html.rb'
-    - 'lib/cucumber/glue/step_definition.rb'
-    - 'lib/cucumber/running_test_case.rb'
-    - 'lib/cucumber/runtime.rb'
-    - 'spec/cucumber/step_match_search_spec.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/Attr:

CHANGELOG.md

@@ -34,10 +34,11 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ### Improved
 
-* Fix Lint/HandleExceptions ([#1226](https://github.com/cucumber/cucumber-ruby/pull/1226) [@jaysonesmith](https://github.com/jaysonesmith))
-* Fix Style/AlignParameters ([#1221](https://github.com/cucumber/cucumber-ruby/pull/1221) [@jaysonesmith](https://github.com/jaysonesmith))
 * Fix Performance/RedundantBlockCall ([#1220](https://github.com/cucumber/cucumber-ruby/pull/1220) [@jaysonesmith](https://github.com/jaysonesmith))
+* Fix Style/AlignParameters ([#1221](https://github.com/cucumber/cucumber-ruby/pull/1221) [@jaysonesmith](https://github.com/jaysonesmith))
+* Fix Style/AsciiComments ([#1222](https://github.com/cucumber/cucumber-ruby/pull/1222) [@jaysonesmith](https://github.com/jaysonesmith))
 * Exclude Style/AsciiIdentifiers ([#1223](https://github.com/cucumber/cucumber-ruby/pull/1223) [@jaysonesmith](https://github.com/jaysonesmith))
+* Fix Lint/HandleExceptions ([#1226](https://github.com/cucumber/cucumber-ruby/pull/1226) [@jaysonesmith](https://github.com/jaysonesmith))
 
 ## [3.1.0](https://github.com/cucumber/cucumber-ruby/compare/v3.0.2...3.1.0) (2017-11-28)
 

lib/cucumber/encoding.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# See https://github.com/cucumber/cucumber/issues/693
+# See https://github.com/cucumber/cucumber/issues/693
 if defined? Encoding
   Encoding.default_external = 'utf-8'
   Encoding.default_internal = 'utf-8'

lib/cucumber/events/gherkin_source_read.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
 
-    # Fired after we've read in the contents of a feature file
+    # Fired after we've read in the contents of a feature file
     class GherkinSourceRead < Core::Event.new(:path, :body)
 
       # The path to the file

lib/cucumber/events/step_activated.rb

@@ -7,17 +7,17 @@ module Events
     # Event fired when a step is activated
     class StepActivated < Core::Event.new(:test_step, :step_match)
 
-      # The test step that was matched.
+      # The test step that was matched.
       #
       # @return [Cucumber::Core::Test::Step]
       attr_reader :test_step
 
-      # Information about the matching definition.
+      # Information about the matching definition.
       #
       # @return [Cucumber::StepMatch]
       attr_reader :step_match
 
-      # @private
+      # @private
       def initialize(test_step, step_match)
         @test_step, @step_match = test_step, step_match
       end

lib/cucumber/events/step_definition_registered.rb

@@ -4,11 +4,11 @@
 module Cucumber
   module Events
 
-    # Event fired after each step definition has been registered
+    # Event fired after each step definition has been registered
     class StepDefinitionRegistered < Core::Event.new(:step_definition)
 
 
-      #_The step definition that was just registered.
+      # The step definition that was just registered.
       #
       # @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition

lib/cucumber/events/test_run_finished.rb

@@ -4,7 +4,7 @@
 module Cucumber
   module Events
 
-    # Event fired after all test cases have finished executing
+    # Event fired after all test cases have finished executing
     class TestRunFinished < Core::Event.new
     end
 

lib/cucumber/events/test_run_started.rb

@@ -4,7 +4,7 @@
 module Cucumber
   module Events
 
-    # Event fired once all test cases have been filtered before
+    # Event fired once all test cases have been filtered before
     # the first one is executed.
     class TestRunStarted < Core::Event.new(:test_cases)
 

lib/cucumber/events/test_step_started.rb

@@ -3,7 +3,7 @@
 module Cucumber
   module Events
 
-    # Signals that a {Cucumber::Core::Test::Step} is about to be executed
+    # Signals that a {Cucumber::Core::Test::Step} is about to be executed
     class TestStepStarted < Core::Events::TestStepStarted
 
       # @return [Cucumber::Core::Test::Step] the test step to be executed

lib/cucumber/filters/randomizer.rb

@@ -4,7 +4,7 @@
 module Cucumber
   module Filters
 
-    # Batches up all test cases, randomizes them, and then sends them on
+    # Batches up all test cases, randomizes them, and then sends them on
     class Randomizer
       def initialize(seed, receiver=nil)
         @receiver = receiver

lib/cucumber/formatter/html.rb

@@ -9,7 +9,7 @@ module Cucumber
   module Formatter
     class Html
 
-      # TODO: remove coupling to types
+      # TODO: remove coupling to types
       AST_CLASSES = {
         Cucumber::Core::Ast::Scenario        => 'scenario',
         Cucumber::Core::Ast::ScenarioOutline => 'scenario outline'

lib/cucumber/glue/step_definition.rb

@@ -71,7 +71,7 @@ def initialize(registry, expression, proc)
         # @registry.available_step_definition(regexp_source, location)
       end
 
-      # @api private
+      # @api private
       def to_hash
         type = expression.is_a?(CucumberExpressions::RegularExpression) ? 'regular expression' : 'cucumber expression'
         regexp = expression.regexp
@@ -91,19 +91,19 @@ def to_hash
         }
       end
 
-      # @api private
+      # @api private
       def ==(step_definition)
         expression.source == step_definition.expression.source
       end
 
-      # @api private
+      # @api private
       def arguments_from(step_name)
         args = @expression.match(step_name)
         # @registry.invoked_step_definition(regexp_source, location) if args
         args
       end
 
-      # @api private
+      # @api private
       # TODO: inline this and step definition just be a value object
       def invoke(args)
         begin
@@ -114,12 +114,12 @@ def invoke(args)
         end
       end
 
-      # @api private
+      # @api private
       def backtrace_line
         "#{location}:in `#{@expression}'"
       end
 
-      # @api private
+      # @api private
       def file_colon_line
         case @proc
         when Proc
@@ -129,12 +129,12 @@ def file_colon_line
         end
       end
 
-      # The source location where the step defintion can be found
+      # The source location where the step definition can be found
       def location
         @location ||= Cucumber::Core::Ast::Location.from_source_location(*@proc.source_location)
       end
 
-      # @api private
+      # @api private
       def file
         @file ||= location.file
       end

lib/cucumber/running_test_case.rb

@@ -2,7 +2,7 @@
 require 'delegate'
 
 module Cucumber
-  # Represents the current status of a running test case.
+  # Represents the current status of a running test case.
   #
   # This wraps a `Cucumber::Core::Test::Case` and delegates
   # many methods to that object.

lib/cucumber/runtime.rb

@@ -245,7 +245,7 @@ def filters
         filters << Cucumber::Core::Test::NameFilter.new(name_regexps)
         filters << Cucumber::Core::Test::LocationsFilter.new(filespecs.locations)
         filters << Filters::Randomizer.new(@configuration.seed) if @configuration.randomize?
-        # TODO: can we just use Glue::RegistryAndMore's step definitions directly?
+        # TODO: can we just use Glue::RegistryAndMore's step definitions directly?
         step_match_search = StepMatchSearch.new(@support_code.registry.method(:step_matches), @configuration)
         filters << Filters::ActivateSteps.new(step_match_search, @configuration)
         @configuration.filters.each do |filter|

spec/cucumber/step_match_search_spec.rb

@@ -10,13 +10,13 @@ module Cucumber
     let(:search) { StepMatchSearch.new(registry.method(:step_matches), configuration) }
     let(:registry) { Glue::RegistryAndMore.new(runtime, configuration) }
     let(:runtime) do
-      # TODO: break out step definitions collection from Glue::RegistryAndMore so we don't need this
+      # TODO: break out step definitions collection from Glue::RegistryAndMore so we don't need this
       :unused
     end
     let(:configuration) { Configuration.new(options) }
     let(:options) { {} }
     let(:dsl) do
-      # TODO: stop relying on implicit global state
+      # TODO: stop relying on implicit global state
       registry
       Object.new.extend(Glue::Dsl)
     end
@@ -102,7 +102,7 @@ module Cucumber
         end
       end
 
-      # TODO: remove this - it's ... redundant
+      # TODO: remove this - it's ... redundant
       # http://railsforum.com/viewtopic.php?pid=93881
       it "does not raise Redundant unless it's really redundant" do
         dsl.Given(/^(.*) (.*) user named '(.*)'$/) {|a,b,c|}