constable-rails 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b589fed13c38522dab7443ab1bb967bedeaec7abb34beaecd5c4f2c9a4298a
-  data.tar.gz: b646c7160830f81bc2c6c5af9fe60728a8c7e1f40236e594fb64a51eed04080f
+  metadata.gz: c9f421fcc02a9f1c30aae54819a543cf548bdd997f8e638899ac6e448d093907
+  data.tar.gz: 506be0d669595b7e3f965f81f6449b4c074f4ade3a98c15d9283d78eca1cd584
 SHA512:
-  metadata.gz: ee0579e80cb81345601ce2c40090db63b87b1498698a77fbc8c34d0df478d36f3210295b3909bd8290835a1f245f2522952f491caca6776d7ac28981dcae7b74
-  data.tar.gz: aea8a0a67d5bdc8868706db9820af271ded921871da905c9e09fe83ac74a359c8c5e9ef8649d737367075f8faa9fabc32fff13156a8f2a9f6e9f69516464441a
+  metadata.gz: bf1762345ec78b7e7133e724fc9e525d2b037013eb940d49c1fdb6de2940a56284fa67c476e93c229840410e344a92e342bd344f9d21ba7c18c3a6217c3e7a2c
+  data.tar.gz: 74b67cd3a65966adc81147e272d08a3b5f092e8602dc3b543c6b2aa878f1bbead4eaabf555d072cc66b97c2137d4bf9593658478235730f3229f15cac0ef1096

data/CHANGELOG.md

@@ -5,6 +5,32 @@ All notable changes to this project are documented here. This project adheres to
 
 ## [Unreleased]
 
+## [1.3.2]
+
+### stdout is results only — the app's stdout too, not just Constable's
+
+`log/test.log` has taken Rails' loggers since 1.0.0. It did not take anything a gem writes
+directly to `$stdout` or `$stderr`, and a warning fired once per file lands in the middle
+of the live stream:
+
+```
+Address    ✓✓✓✓✓✓✓✓✓✓✓To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
+```
+
+Both streams are now pointed at the log for the duration of a run, and the reporter keeps
+the terminal it captured beforehand. `--verbose` tees them back, which is what that flag
+is for.
+
+Two ordering bugs came with it, both caught before release. The console has to be taken
+**before** the Rails check, because `route!` runs before the app boots and most of the
+noise is emitted *by* booting it. And colour detection was asking `$stdout.tty?` — which
+by then is a file, and a file is never a tty, so colour would have silently switched off
+for everybody.
+
+Not intercepted: a write straight to file descriptor 2. Capturing that would also swallow
+a real crash and break `binding.pry`, so `2>/dev/null` stays the user's decision.
+
+
 ## [1.3.1]
 
 ### Cold cases now read `.rspec`
@@ -528,7 +554,8 @@ Initial release.
 - Diff-based coverage gate — only lines changed in the current diff are held to the
   threshold. `constable beat` for the full picture, `--html` for a browsable report.
 
-[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.3.1...HEAD
+[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.3.2...HEAD
+[1.3.2]: https://github.com/Ray-Hughes/constable/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/Ray-Hughes/constable/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/Ray-Hughes/constable/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/Ray-Hughes/constable/compare/v1.1.0...v1.2.0

data/README.md

@@ -422,8 +422,16 @@ and says why — slow is a trade-off, wrong is not.
 
 ### Output
 
-stdout is reserved for results. `Rails.logger`, SQL and request/response logging go to
-`log/test.log`; `--verbose` streams it back for active debugging.
+stdout is reserved for results — not just Constable's own output, but the app's. Rails
+loggers, SQL, request/response logging, and anything a gem prints to `$stdout` or
+`$stderr` mid-run all go to `log/test.log`; `--verbose` streams it back for active
+debugging.
+
+That matters more than it sounds. A gem warning fired once per file lands in the middle of
+the live stream, and you get `Address ✓✓✓✓✓✓To use retry middleware with Faraday...`
+instead of a readable run. The one thing Constable deliberately does not intercept is a
+write straight to file descriptor 2 — capturing that would also swallow a real crash and
+break `binding.pry`, so `2>/dev/null` stays yours to decide on.
 
 **While it runs**, the live stream has two modes. `concise` is the default: one glyph per
 test, grouped into a run per case, so a thousand-test suite stays inside one screen and a

data/lib/constable/cli.rb

@@ -501,14 +501,19 @@ module Constable
 
       def color?
         return false if options[:"no-color"]
-        return false unless $stdout.tty?
+        # The console, not $stdout -- which by now is log/test.log, and a file is never a
+        # tty. Asking the wrong one silently turns colour off for everybody.
+        return false unless LogRouter.console.tty?
         return false unless ENV["NO_COLOR"].to_s.empty?
 
         true
       end
 
+      # LogRouter.console, not $stdout: by this point route! has pointed $stdout at
+      # log/test.log so a stray gem warning cannot land in the middle of the live stream.
+      # The reporter is the one thing that still writes to the terminal.
       def reporter(config)
-        Reporter.new(io: $stdout, config: config, color: color?, mode: output_mode)
+        Reporter.new(io: LogRouter.console, config: config, color: color?, mode: output_mode)
       end
 
       # nil means "the config file decides". The explicit --output wins over the two

data/lib/constable/log_router.rb

@@ -55,6 +55,14 @@ module Constable
       def sync         = true
       def tty?         = false
 
+      # Something that has been handed $stdout may ask it for a file descriptor. Answer
+      # with the first target that has one rather than raising NoMethodError from inside
+      # somebody else's gem.
+      def fileno
+        @targets.each { |t| return t.fileno if t.respond_to?(:fileno) }
+        nil
+      end
+
       def sync=(value)
         @targets.each { |target| target.sync = value if target.respond_to?(:sync=) }
       end
@@ -89,12 +97,18 @@ module Constable
       def route!(verbose: false, path: nil, io: $stdout, root: nil)
         target = path ? File.expand_path(path.to_s, root || Constable.root) : default_path(root)
 
+        # Taking the console does not depend on Rails, and the ordering matters: route! runs
+        # before the app boots, so anything that waited for Rails would miss every warning
+        # emitted *by* booting it -- which is most of them. A suite with no Rails at all
+        # still wants its stdout kept for results.
+        file = open_log(target)
+        capture_console!(file, verbose ? io : nil)
+
         unless rails_loaded?
-          reason = "Rails is not loaded — nothing to route, stdout is already results only"
+          reason = "Rails is not loaded — no loggers to route, but stdout is held for results"
           return @current = Routing.new(routed: false, path: target, verbose: verbose, reason: reason)
         end
 
-        file   = open_log(target)
         logger = build_logger(verbose ? Tee.new(file, io) : file)
 
         remember_previous!
@@ -103,9 +117,40 @@ module Constable
         @current = Routing.new(routed: true, path: target, verbose: verbose, reason: nil)
       end
 
+      # The terminal, as it was before route! took it. The reporter writes here; everything
+      # else writes to the log.
+      def console = @console_out || $stdout
+
+      # Rails loggers are not the only thing that writes to a terminal. A gem warning --
+      # Faraday's "install the faraday-retry gem", say -- goes straight to $stderr, once
+      # per file that triggers it, and lands in the middle of the live stream:
+      #
+      #   Address    ✓✓✓✓✓✓✓✓✓✓✓To use retry middleware with Faraday v2.0+...
+      #
+      # stdout is supposed to be results only. So the app's stdout and stderr are pointed
+      # at log/test.log for the duration of the run, and the reporter keeps the real
+      # terminal it captured beforehand. `--verbose` tees both back, which is the whole
+      # point of that flag.
+      def capture_console!(file, tee_to)
+        @console_out = $stdout
+        @console_err = $stderr
+
+        replacement = tee_to ? Tee.new(file, tee_to) : file
+        $stdout = replacement
+        $stderr = replacement
+      end
+
+      def restore_console!
+        $stdout = @console_out if @console_out
+        $stderr = @console_err if @console_err
+        @console_out = nil
+        @console_err = nil
+      end
+
       # Puts back whatever the app had before route!. Only useful in-process (our own
       # suite, or a REPL); a real run never wants its logs back on stdout.
       def restore!
+        restore_console!
         (@previous || {}).each do |constant_name, (setter, logger)|
           constant = resolve(constant_name)
           constant&.public_send(setter, logger)

data/lib/constable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Constable
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constable-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Ray Hughes