rspec-conductor 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53a28166d7b4df7bb4cfa3433a706ba3a5f892f4011535bb801718bc7886a638
-  data.tar.gz: 360ea91cb2e087b0f561616af2d37442bdbdb572b54520658a638feb2d7ebba4
+  metadata.gz: 6cb890370ce6bc38b652f6c998ca34fa8974c73677bb53794d5adddeda060db2
+  data.tar.gz: 3b2124f2014a5ae4c7f5e7c3b5aebeb8b6c1b624cab65d29b31d0219d23ac358
 SHA512:
-  metadata.gz: db723da5eb4be4e544bb4890427a83f96944b6c2fb293845fa5a892cb356d030d407ea246f46331d52f231a7158565e3ce18d4c0127adefe8a38fe515e0d738a
-  data.tar.gz: 3ceb9915c3da36f68c499cbe5d65787b9f88f46ed049e51c619b0b479d7e101fc963a2b90e62da0afba174e9960c07426d71b10cf13e8324edebf11df33a61ac
+  metadata.gz: a68df5d5e08d98b6c1b24a9e843432fa78e54c594dc0ff360bb49294de55d6f6eb730788c8d4386e2aa57e0856fdd18536560289f4dd2a22a228a67c1e9f5a8f
+  data.tar.gz: a88156e67f821bbeb2ef00bce93e2b6b327d5000fe2876a34c422a324294879417d63a30d260990775f6cd405c74811f03f62747ea782fc4757bcbcb75241062

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.0.7] - 2026-02-16
+
+- Move all output code into the formatter base class (lay some groundwork to address some minor issues with the fancy formatter)
+- Disable rspec's --require command line parameter. Use --prefork-require and --postfork-require in the rspec-conductor cli instead (reported by @cb341)
+
 ## [1.0.6] - 2026-02-14
 
 - Better RSpec arguments handling, for example, --pattern and --exclude-pattern should be supported better (reported by @cb341)

data/README.md

@@ -95,6 +95,8 @@ I will also try my best to keep supporting as many rubies / rspec versions as I
     * This is a common issue with ruby code, compiled libraries and forking. Set `OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES` environment variable to work around this
 * Something gets loaded that shouldn't get loaded, or in a different order
     * There are two simple ways to hook into preloads, exposed as CLI flags, `--prefork-require` (defaults to `config/application.rb`) and `--postfork-require` (defaults to either `rails_helper.rb` or `spec_helper.rb`, whichever is present on your machine). You can set any of those to whatever you need and control the load order
+* `--require` options are ignored in command-line arguments or my `.rspec`
+    * rspec-conductor uses the full rspec configuration machinery to parse all the params. That includes `.rspec`, which, by default, includes `--require spec_helper` or `--require rails_helper` in most setups. If you need tighter control over what you load, use either `--prefork-require` or `--postfork-require`, these are actual ruby files, you can put any code or any `require` you need there.
 
 ## FAQ
 

data/lib/rspec/conductor/formatters/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Conductor
+    class Base
+      include Util::ANSI
+
+      def initialize(**_kwargs)
+      end
+
+      def handle_worker_message(_worker_process, _message, _results)
+      end
+
+      def print_startup_banner(worker_count:, seed:, spec_files_count:)
+        puts "RSpec Conductor starting with #{worker_count} workers (seed: #{seed})"
+        puts "Running #{spec_files_count} spec files\n\n"
+      end
+
+      def print_summary(results, seed:)
+        puts "\n\n"
+        puts "Randomized with seed #{seed}"
+        puts "#{colorize("#{results.passed} passed", :green)}, #{colorize("#{results.failed} failed", :red)}, #{colorize("#{results.pending} pending", :yellow)}"
+        puts colorize("Worker crashes: #{results.worker_crashes}", :red) if results.worker_crashes.positive?
+
+        if results.errors.any?
+          puts "\nFailures:\n\n"
+          results.errors.each_with_index do |error, i|
+            puts "  #{i + 1}) #{error[:description]}"
+            puts colorize("     #{error[:message]}", :red) if error[:message]
+            puts colorize("     #{error[:location]}", :cyan)
+            if error[:backtrace]&.any?
+              puts "     Backtrace:"
+              error[:backtrace].each { |line| puts "       #{line}" }
+            end
+            puts
+          end
+        end
+
+        puts "Specs took: #{results.specs_runtime.round(2)}s"
+        puts "Total runtime: #{results.total_runtime.round(2)}s"
+        puts "Suite: #{results.success? ? colorize("PASSED", :green) : colorize("FAILED", :red)}"
+      end
+
+      def print_debug(string)
+        $stderr.puts string
+      end
+
+      def print_retry_message(message)
+        puts <<~EOM
+          \nRetried: #{message[:description]}
+            #{message[:location]}
+            #{message[:exception_class]}: #{message[:message]}
+            Backtrace:
+          #{message[:backtrace].map { "    #{_1}" }.join("\n")}
+        EOM
+      end
+
+      def print_shut_down_banner
+        puts "Shutting down..."
+      end
+
+      def colorize(string, colors, **kwargs)
+        $stdout.tty? ? super(string, colors, **kwargs) : string
+      end
+    end
+  end
+end

data/lib/rspec/conductor/formatters/ci.rb

@@ -3,15 +3,15 @@
 module RSpec
   module Conductor
     module Formatters
-      class CI
-        include Util::ANSI
-
+      class CI < Base
         DEFAULT_PRINTOUT_INTERVAL = 10
 
         # @option printout_interval how often a printout happens, in seconds
-        def initialize(printout_interval: DEFAULT_PRINTOUT_INTERVAL)
+        def initialize(printout_interval: DEFAULT_PRINTOUT_INTERVAL, **kwargs)
           @printout_interval = printout_interval
           @last_printout = Time.now
+
+          super(**kwargs)
         end
 
         def handle_worker_message(_worker_process, message, results)

data/lib/rspec/conductor/formatters/fancy.rb

@@ -5,14 +5,12 @@ require "pathname"
 module RSpec
   module Conductor
     module Formatters
-      class Fancy
-        include Util::ANSI
-
+      class Fancy < Base
         def self.recommended?
           $stdout.tty? && $stdout.winsize[0] >= 30 && $stdout.winsize[1] >= 80
         end
 
-        def initialize(worker_count:)
+        def initialize(worker_count:, **kwargs)
           @worker_processes = {}
           @terminal = Util::Terminal.new
           @last_rendered_lines = []
@@ -27,6 +25,8 @@ module RSpec
           @dots_line = @terminal.line(truncate: false)
           @terminal.puts
           @last_error_line = @terminal.line(truncate: false)
+
+          super(**kwargs)
         end
 
         def handle_worker_message(worker_process, message, results)
@@ -68,7 +68,7 @@ module RSpec
 
         def update_worker_status_line(worker_process)
           status = colorize("Worker #{worker_process.number}: ", :cyan)
-          status << if worker_process.status == :shut_down
+          status += if worker_process.status == :shut_down
                       "(finished)"
                     elsif worker_process.status == :terminated
                       colorize("(terminated)", :red)

data/lib/rspec/conductor/formatters/plain.rb

@@ -1,9 +1,7 @@
 module RSpec
   module Conductor
     module Formatters
-      class Plain
-        include Util::ANSI
-
+      class Plain < Base
         def handle_worker_message(_worker_process, message, _results)
           public_send(message[:type], message) if respond_to?(message[:type])
         end
@@ -27,11 +25,7 @@ module RSpec
         private
 
         def print(string, color)
-          if $stdout.tty?
-            $stdout.print(colorize(string, color))
-          else
-            $stdout.print(string)
-          end
+          $stdout.print(colorize(string, color))
         end
       end
     end

data/lib/rspec/conductor/server.rb

@@ -35,19 +35,21 @@ module RSpec
         @rspec_args = rspec_args
         @worker_processes = {}
         @spec_queue = []
-        @formatter = case opts[:formatter]
-                     when "ci"
-                       Formatters::CI.new
-                     when "fancy"
-                       Formatters::Fancy.new(worker_count: worker_count)
-                     when "plain"
-                       Formatters::Plain.new
-                     else
-                       (!@verbose && Formatters::Fancy.recommended?) ? Formatters::Fancy.new(worker_count: worker_count) : Formatters::Plain.new
-                     end
+        @formatter_class = case opts[:formatter]
+                           when "ci"
+                             Formatters::CI
+                           when "fancy"
+                             Formatters::Fancy
+                           when "plain"
+                             Formatters::Plain
+                           else
+                             (!@verbose && Formatters::Fancy.recommended?) ? Formatters::Fancy : Formatters::Plain
+                           end
+        @formatter = @formatter_class.new(worker_count: @worker_count)
         @results = Results.new
 
         Dir.chdir(Conductor.root)
+        ENV['PARALLEL_TEST_GROUPS'] = worker_count.to_s # parallel_tests backward-compatibility
       end
 
       def run
@@ -56,14 +58,13 @@ module RSpec
         preload_application
 
         $stdout.sync = true
-        puts "RSpec Conductor starting with #{@worker_count} workers (seed: #{@seed})"
-        puts "Running #{@spec_queue.size} spec files\n\n"
+        @formatter.print_startup_banner(worker_count: @worker_count, seed: @seed, spec_files_count: @spec_queue.size)
 
         start_workers
         run_event_loop
         @results.suite_complete
 
-        print_summary
+        @formatter.print_summary(@results, seed: @seed)
         exit_with_status
       end
 
@@ -99,12 +100,15 @@ module RSpec
         return if @results.shutting_down?
 
         @results.shut_down
-        puts "Shutting down..."
+        @formatter.print_shut_down_banner
         @worker_processes.each_value { |w| w.socket&.send_message({ type: :shutdown }) }
       end
 
       def build_spec_queue
         config_options = RSpec::Core::ConfigurationOptions.new(@rspec_args)
+        # a bit of a hack, but if they want to require something explicitly, they should use either --prefork-require or --postfork-require,
+        # as it is now, it messes with the preloads
+        config_options.options.delete(:requires)
         if config_options.options[:files_or_directories_to_run].empty?
           config_options.options[:files_or_directories_to_run] = ["spec"]
         end
@@ -187,9 +191,7 @@ module RSpec
         when :example_pending
           @results.example_pending
         when :example_retried
-          if @display_retry_backtraces
-            puts "\nExample #{message[:description]} retried:\n  #{message[:location]}\n  #{message[:exception_class]}: #{message[:message]}\n#{message[:backtrace].map { "    #{_1}" }.join("\n")}\n"
-          end
+          @formatter.print_retry_message(message) if @display_retry_backtraces
         when :spec_complete
           @results.spec_file_complete
           worker_process.current_spec = nil
@@ -248,35 +250,6 @@ module RSpec
         nil
       end
 
-      def print_summary
-        puts "\n\n"
-        puts "Randomized with seed #{@seed}"
-        puts "#{colorize("#{@results.passed} passed", :green)}, #{colorize("#{@results.failed} failed", :red)}, #{colorize("#{@results.pending} pending", :yellow)}"
-        puts colorize("Worker crashes: #{@results.worker_crashes}", :red) if @results.worker_crashes.positive?
-
-        if @results.errors.any?
-          puts "\nFailures:\n\n"
-          @results.errors.each_with_index do |error, i|
-            puts "  #{i + 1}) #{error[:description]}"
-            puts "     #{error[:location]}"
-            puts "     #{error[:message]}" if error[:message]
-            if error[:backtrace]&.any?
-              puts "     Backtrace:"
-              error[:backtrace].each { |line| puts "       #{line}" }
-            end
-            puts
-          end
-        end
-
-        puts "Specs took: #{@results.specs_runtime.round(2)}s"
-        puts "Total runtime: #{@results.total_runtime.round(2)}s"
-        puts "Suite: #{@results.success? ? colorize("PASSED", :green) : colorize("FAILED", :red)}"
-      end
-
-      def colorize(string, color)
-        $stdout.tty? ? Util::ANSI.colorize(string, color) : string
-      end
-
       def exit_with_status
         Kernel.exit(@results.success? ? 0 : 1)
       end
@@ -284,7 +257,7 @@ module RSpec
       def debug(message)
         return unless @verbose
 
-        $stderr.puts "[conductor] #{message}"
+        @formatter.print_debug("[conductor] #{message}")
       end
     end
   end

data/lib/rspec/conductor/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Conductor
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

data/lib/rspec/conductor/worker.rb

@@ -62,11 +62,17 @@ module RSpec
         @default_path = RSpec.configuration.default_path || "spec"
         @default_full_path = File.expand_path(@default_path)
 
-        if Dir.exist?(@default_full_path) && !$LOAD_PATH.include?(@default_full_path)
-          $LOAD_PATH.unshift(@default_full_path)
-        end
+        add_load_path(File.expand_path("lib"))
+        add_load_path(@default_full_path)
+
+        debug "Load path: #{$LOAD_PATH.inspect}"
+      end
+
+      def add_load_path(path)
+        return unless File.directory?(path)
+        return if $LOAD_PATH.include?(path)
 
-        debug "Load path (spec dirs): #{$LOAD_PATH.inspect}"
+        $LOAD_PATH.unshift(path)
       end
 
       def suppress_output
@@ -162,7 +168,7 @@ module RSpec
       end
 
       def parsed_options
-        @parsed_options ||= RSpec::Core::ConfigurationOptions.new(@rspec_args)
+        @parsed_options ||= RSpec::Core::ConfigurationOptions.new(@rspec_args).tap { |co| co.options.delete(:requires) }
       end
 
       def debug(message)

data/lib/rspec/conductor.rb

@@ -37,6 +37,7 @@ require_relative "conductor/results"
 require_relative "conductor/worker_process"
 require_relative "conductor/cli"
 require_relative "conductor/rspec_subscriber"
+require_relative "conductor/formatters/base"
 require_relative "conductor/formatters/plain"
 require_relative "conductor/formatters/ci"
 require_relative "conductor/formatters/fancy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Mark Abramov
@@ -42,6 +42,7 @@ files:
 - lib/rspec/conductor.rb
 - lib/rspec/conductor/cli.rb
 - lib/rspec/conductor/ext/rspec.rb
+- lib/rspec/conductor/formatters/base.rb
 - lib/rspec/conductor/formatters/ci.rb
 - lib/rspec/conductor/formatters/fancy.rb
 - lib/rspec/conductor/formatters/plain.rb