From 14933b000e34e2c1ca3fd54dc4feaa987c3d2686 Mon Sep 17 00:00:00 2001
From: Michael Grosser <michael@grosser.it>
Date: Sun, 24 Dec 2023 22:08:11 -0600
Subject: [PATCH] unify verbose formatter with other loggers (#927)

* typo

* unify verbose formatter with other loggers
---
 Readme.md                                     | 36 ++++++++++---------
 ...verbose_formatter.rb => verbose_logger.rb} |  2 +-
 ...rmatter_spec.rb => verbose_logger_spec.rb} |  4 +--
 spec/spec_helper.rb                           |  2 +-
 4 files changed, 23 insertions(+), 21 deletions(-)
 rename lib/parallel_tests/rspec/{verbose_formatter.rb => verbose_logger.rb} (93%)
 rename spec/parallel_tests/rspec/{verbose_formatter_spec.rb => verbose_logger_spec.rb} (91%)

diff --git a/Readme.md b/Readme.md
index 90d3d431..b34d1201 100644
--- a/Readme.md
+++ b/Readme.md
@@ -151,7 +151,7 @@ Add the following to your `.rspec_parallel` (or `.rspec`) :
 RSpec: FailuresLogger
 -----------------------
 
-Produce pastable command-line snippets for each failed example. For example:
+Produce pasteable command-line snippets for each failed example. For example:
 
 ```bash
 rspec /path/to/my_spec.rb:123 # should do something
@@ -164,6 +164,24 @@ Add to `.rspec_parallel` or use as CLI flag:
 
 (Not needed to retry failures, for that pass [--only-failures](https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures) to rspec)
 
+
+RSpec: VerboseLogger
+-----------------------
+
+Prints a single line for starting and finishing each example, to see what is currently running in each process.
+
+```
+# PID, parallel process number, spec status, example description
+[14403] [2] [STARTED] Foo foo
+[14402] [1] [STARTED] Bar bar
+[14402] [1] [PASSED] Bar bar
+```
+
+Add to `.rspec_parallel` or use as CLI flag:
+
+      --format ParallelTests::RSpec::VerboseLogger
+
+
 Cucumber: FailuresLogger
 -----------------------
 
@@ -183,22 +201,6 @@ To rerun failures:
 
     cucumber @tmp/cucumber_failures.log
 
-Formatters
-==========
-
-RSpec: VerboseFormatter
-
-Output the RSpec PID, parallel process number, spec status, and the full
-example description. The formatter outputs one line when starting an example
-and then again when finishing. Use like the RSpec documentation but plays
-nicely with parallel processes.
-
-Usage:
-
-```console
-$ parallel_rspec -- --format ParallelTests::RSpec::VerboseFormatter --
-```
-
 Setup for non-rails
 ===================
 
diff --git a/lib/parallel_tests/rspec/verbose_formatter.rb b/lib/parallel_tests/rspec/verbose_logger.rb
similarity index 93%
rename from lib/parallel_tests/rspec/verbose_formatter.rb
rename to lib/parallel_tests/rspec/verbose_logger.rb
index ebd54ded..aa7b8ed2 100644
--- a/lib/parallel_tests/rspec/verbose_formatter.rb
+++ b/lib/parallel_tests/rspec/verbose_logger.rb
@@ -3,7 +3,7 @@
 require 'rspec/core/formatters/base_text_formatter'
 require 'parallel_tests/rspec/runner'
 
-class ParallelTests::RSpec::VerboseFormatter < RSpec::Core::Formatters::BaseTextFormatter
+class ParallelTests::RSpec::VerboseLogger < RSpec::Core::Formatters::BaseTextFormatter
   RSpec::Core::Formatters.register(
     self,
     :example_group_started,
diff --git a/spec/parallel_tests/rspec/verbose_formatter_spec.rb b/spec/parallel_tests/rspec/verbose_logger_spec.rb
similarity index 91%
rename from spec/parallel_tests/rspec/verbose_formatter_spec.rb
rename to spec/parallel_tests/rspec/verbose_logger_spec.rb
index a82da567..3fb23c5a 100644
--- a/spec/parallel_tests/rspec/verbose_formatter_spec.rb
+++ b/spec/parallel_tests/rspec/verbose_logger_spec.rb
@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe ParallelTests::RSpec::VerboseFormatter do
+describe ParallelTests::RSpec::VerboseLogger do
   def run(command)
     result = IO.popen(command, err: [:child, :out], &:read)
     raise "FAILED: #{result}" unless $?.success?
@@ -39,7 +39,7 @@ def run(command)
         "#{repo_root}/bin/parallel_rspec",
         "-n", "2",
         "--",
-        "--format", "ParallelTests::RSpec::VerboseFormatter",
+        "--format", "ParallelTests::RSpec::VerboseLogger",
         "--"
       ]
 
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index c9aa11a6..5e16f939 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -8,7 +8,7 @@
 require 'parallel_tests/test/runtime_logger'
 require 'parallel_tests/rspec/runtime_logger'
 require 'parallel_tests/rspec/summary_logger'
-require 'parallel_tests/rspec/verbose_formatter'
+require 'parallel_tests/rspec/verbose_logger'
 
 String.class_eval do
   def strip_heredoc