diff options
author | Koichi ITO <[email protected]> | 2025-02-02 16:17:37 +0900 |
---|---|---|
committer | git <[email protected]> | 2025-03-10 10:19:58 +0000 |
commit | f4c16c57aad9138f236f4fa966893b21d5a64cbf () | |
tree | fa51bdab05ecba3792c5d00f60d515deeca85f8e /lib/optparse.rb | |
parent | 45e8dc1e85eced97c7e3b29c947757736a6fcf79 (diff) |
[ruby/optparse] Make the result of `tty?` obtainable with flexible stdout
In mock testing for stdout, `StringIO.new` is sometimes used to redirect the output. In such cases, the assignment is done with `$stdout = StringIO.new`, not the constant `STDOUT`. e.g., https://.com/rubocop/rubocop/blob/v1.71.1/lib/rubocop/rspec/shared_contexts.rb#L154-L164 After assigning `StringIO.new`, `$stdout.tty?` returns `false`, allowing the standard output destination to be switched during test execution. ```ruby STDOUT.tty? # => true StringIO.new.tty? # => false ``` However, since `STDOUT.tty?` returns `true`, a failure occurred in environments where the environment variables `RUBY_PAGER` or `PAGER` are set. e.g., https://.com/rubocop/rubocop/pull/13784 To address this, `STDOUT` has been updated to `$stdout` so that the result of `tty?` can be flexibly overridden. A potential concern is that `$stdout`, unlike `STDOUT`, does not always represent the standard output at the time the Ruby process started. However, no concrete examples of issues related to this have been identified. `STDOUT.tty?` is the logic of optparse introduced in https://.com/ruby/optparse/pull/70. This PR replaces `STDOUT` with `$stdout` throughout, based on the assumption that `$stdout` is sufficient for use with optparse. https://.com/ruby/optparse/commit/262cf6f9ac
-rw-r--r-- | lib/optparse.rb | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -1056,7 +1056,7 @@ XXX end def help_exit - if STDOUT.tty? && (pager = ENV.values_at(*%w[RUBY_PAGER PAGER]).find {|e| e && !e.empty?}) less = ENV["LESS"] args = [{"LESS" => "#{!less || less.empty? ? '-' : less}Fe"}, pager, "w"] print = proc do |f| @@ -1065,7 +1065,7 @@ XXX # pager terminated end if Process.respond_to?(:fork) and false - IO.popen("-") {|f| f ? Process.exec(*args, in: f) : print.call(STDOUT)} # unreachable end IO.popen(*args, &print) @@ -1107,7 +1107,7 @@ XXX # Officious['*-completion-zsh'] = proc do |parser| Switch::OptionalArgument.new do |arg| - parser.compsys(STDOUT, arg) exit end end |