toys-core 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a85fbb6170bb1609f304cc0b1a62d4743437802b64c796372d569856bdd1e256
-  data.tar.gz: 8291edf5cd82f0bbbcafb83878351415a28f8d0a21e058332184534c08e29751
+  metadata.gz: 5f312d702768f03fa72f49fb33b81b49736aa3095a863878a2eddb70750d27d8
+  data.tar.gz: a3ed6d02218c3e94559178021320603b5ef6d89f0e2d263fa183a583b68caf05
 SHA512:
-  metadata.gz: 701ff10d98b0ae6f2b8c9d758c8dcb1769622a59dc3e86b85fedfae327811403c3ae514b05060eb91b701948cd275d94c86fa20973724864fc9c2b4aae355f90
-  data.tar.gz: b042cb80c9fb0f9d0d0132b546384179efc69873e4d060c20b7e2bc1b7c6e36721d27655e4efa4b77960cc899e726bbc47e92cbdbfd5cf2c18289dcde0b8e3cb
+  metadata.gz: 94ee591039f0191572b66274033dbb3245bdb210e1e93441910c6a7d1e6d5732f1afdd71ba09103a357c52dc8c59fe13b1538ddd53319e03aaea4502e266e452
+  data.tar.gz: 6cc7dfd5d6dc7a87c6e5cee9521d6374b1ec7b462119e7ce2700147d6a384df6d7e7d92a6498139f53dcc5f114cd47588d53e4fb2108757b2d575f46b26f3a4f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 0.4.4 / 2018-07-21
+
+* FIXED: Utils::Exec wasn't closing streams after copying.
+* IMPROVED: Utils::Exec::Controller can capture or redirect the remainder of a controlled stream.
+* ADDED: Terminal#ask
+
 ### 0.4.3 / 2018-07-13
 
 * IMPROVED: Utils::Exec methods can now spawn subprocesses in the background

data/lib/toys/core_version.rb

@@ -34,5 +34,5 @@ module Toys
   # Current version of Toys core
   # @return [String]
   #
-  CORE_VERSION = "0.4.3"
+  CORE_VERSION = "0.4.4"
 end

data/lib/toys/standard_mixins/terminal.rb

@@ -91,11 +91,18 @@ module Toys
         terminal.write(str, *styles)
       end
 
+      ##
+      # @see Toys::Utils::Terminal#ask
+      #
+      def ask(prompt, *styles, default: nil, trailing_text: :default)
+        terminal.ask(prompt, *styles, default: default, trailing_text: trailing_text)
+      end
+
       ##
       # @see Toys::Utils::Terminal#confirm
       #
-      def confirm(prompt = "Proceed?", default: nil)
-        terminal.confirm(prompt, default: default)
+      def confirm(prompt = "Proceed?", *styles, default: nil)
+        terminal.confirm(prompt, *styles, default: default)
       end
 
       ##

data/lib/toys/utils/exec.rb

@@ -437,15 +437,139 @@ module Toys
         #
         attr_reader :pid
 
+        ##
+        # Captures the remaining data in the given stream.
+        # After calling this, do not read directly from the stream.
+        #
+        # @param [:out,:err] which Which stream to capture
+        #
+        def capture(which)
+          stream = stream_for(which)
+          @join_threads << ::Thread.new do
+            begin
+              @captures[which] = stream.read
+            ensure
+              stream.close
+            end
+          end
+          self
+        end
+
+        ##
+        # Captures the remaining data in the stdandard output stream.
+        # After calling this, do not read directly from the stream.
+        #
+        def capture_out
+          capture(:out)
+        end
+
+        ##
+        # Captures the remaining data in the stdandard error stream.
+        # After calling this, do not read directly from the stream.
+        #
+        def capture_err
+          capture(:err)
+        end
+
+        ##
+        # Redirects the remainder of the given stream.
+        #
+        # You may specify the stream as an IO or IO-like object, or as a file
+        # specified by its path. If specifying a file, you may optionally
+        # provide the mode and permissions for the call to `File#open`. You can
+        # also specify the value `:null` to indicate the null file.
+        #
+        # After calling this, do not interact directly with the stream.
+        #
+        # @param [:in,:out,:err] which Which stream to redirect
+        # @param [IO,StringIO,String,:null] io Where to redirect the stream
+        # @param [Object...] io_args The mode and permissions for opening the
+        #     file, if redirecting to/from a file.
+        #
+        def redirect(which, io, *io_args)
+          io = ::File::NULL if io == :null
+          if io.is_a?(::String)
+            io_args = which == :in ? ["r"] : ["w"] if io_args.empty?
+            io = ::File.open(io, *io_args)
+          end
+          stream = stream_for(which, allow_in: true)
+          @join_threads << ::Thread.new do
+            begin
+              if which == :in
+                ::IO.copy_stream(io, stream)
+              else
+                ::IO.copy_stream(stream, io)
+              end
+            ensure
+              stream.close
+              io.close
+            end
+          end
+        end
+
+        ##
+        # Redirects the remainder of the standard input stream.
+        #
+        # You may specify the stream as an IO or IO-like object, or as a file
+        # specified by its path. If specifying a file, you may optionally
+        # provide the mode and permissions for the call to `File#open`. You can
+        # also specify the value `:null` to indicate the null file.
+        #
+        # After calling this, do not interact directly with the stream.
+        #
+        # @param [IO,StringIO,String,:null] io Where to redirect the stream
+        # @param [Object...] io_args The mode and permissions for opening the
+        #     file, if redirecting from a file.
+        #
+        def redirect_in(io, *io_args)
+          redirect(:in, io, *io_args)
+        end
+
+        ##
+        # Redirects the remainder of the standard output stream.
+        #
+        # You may specify the stream as an IO or IO-like object, or as a file
+        # specified by its path. If specifying a file, you may optionally
+        # provide the mode and permissions for the call to `File#open`. You can
+        # also specify the value `:null` to indicate the null file.
+        #
+        # After calling this, do not interact directly with the stream.
+        #
+        # @param [IO,StringIO,String,:null] io Where to redirect the stream
+        # @param [Object...] io_args The mode and permissions for opening the
+        #     file, if redirecting to a file.
+        #
+        def redirect_out(io, *io_args)
+          redirect(:out, io, *io_args)
+        end
+
+        ##
+        # Redirects the remainder of the standard error stream.
+        #
+        # You may specify the stream as an IO or IO-like object, or as a file
+        # specified by its path. If specifying a file, you may optionally
+        # provide the mode and permissions for the call to `File#open`.
+        #
+        # After calling this, do not interact directly with the stream.
+        #
+        # @param [IO,StringIO,String] io Where to redirect the stream
+        # @param [Object...] io_args The mode and permissions for opening the
+        #     file, if redirecting to a file.
+        #
+        def redirect_err(io, *io_args)
+          redirect(:err, io, *io_args)
+        end
+
         ##
         # Send the given signal to the process. The signal may be specified
         # by name or number.
         #
-        # @param [Integer,String] signal The signal to send.
+        # @param [Integer,String] sig The signal to send.
         #
-        def kill(signal)
-          ::Process.kill(signal, pid)
+        def kill(sig)
+          ::Process.kill(sig, pid)
         end
+        alias signal kill
 
         ##
         # Determine whether the subcommand is still executing
@@ -487,6 +611,29 @@ module Toys
           @err.close if @err && !@err.closed?
           self
         end
+
+        private
+
+        def stream_for(which, allow_in: false)
+          stream = nil
+          case which
+          when :out
+            stream = @out
+            @out = nil
+          when :err
+            stream = @err
+            @err = nil
+          when :in
+            if allow_in
+              stream = @in
+              @in = nil
+            end
+          else
+            raise ::ArgumentError, "Unknown stream #{which}"
+          end
+          raise ::ArgumentError, "Stream #{which} not available" unless stream
+          stream
+        end
       end
 
       ##
@@ -639,24 +786,12 @@ module Toys
 
         def setup_streams_within_fork
           @parent_streams.each(&:close)
-          setup_in_stream_within_fork(@spawn_opts[:in])
-          out_stream = interpret_out_stream_within_fork(@spawn_opts[:out])
-          err_stream = interpret_out_stream_within_fork(@spawn_opts[:err])
-          if out_stream == :close
-            $stdout.close
-          elsif out_stream
-            $stdout.reopen(out_stream)
-            $stdout.sync = true
-          end
-          if err_stream == :close
-            $stderr.close
-          elsif err_stream
-            $stderr.reopen(err_stream)
-            $stderr.sync = true
-          end
+          setup_in_stream_within_fork(@spawn_opts[:in], $stdin)
+          setup_out_stream_within_fork(@spawn_opts[:out], $stdout)
+          setup_out_stream_within_fork(@spawn_opts[:err], $stderr)
         end
 
-        def setup_in_stream_within_fork(stream)
+        def setup_in_stream_within_fork(stream, stdstream)
           in_stream =
             case stream
             when ::Integer
@@ -671,32 +806,43 @@ module Toys
               stream if stream.respond_to?(:write)
             end
           if in_stream == :close
-            $stdin.close
+            stdstream.close
           elsif in_stream
-            $stdin.reopen(in_stream)
+            stdstream.reopen(in_stream)
           end
         end
 
-        def interpret_out_stream_within_fork(stream)
-          case stream
-          when ::Integer
-            ::IO.open(stream)
-          when ::Array
-            if stream.first == :child
-              if stream[1] == :err
-                $stderr
-              elsif stream[1] == :out
-                $stdout
-              end
+        def setup_out_stream_within_fork(stream, stdstream)
+          out_stream =
+            case stream
+            when ::Integer
+              ::IO.open(stream)
+            when ::Array
+              interpret_out_array_within_fork(stream)
+            when ::String
+              ::File.open(stream, "w")
+            when :close
+              :close
             else
-              ::File.open(*stream)
+              stream if stream.respond_to?(:write)
+            end
+          if out_stream == :close
+            stdstream.close
+          elsif out_stream
+            stdstream.reopen(out_stream)
+            stdstream.sync = true
+          end
+        end
+
+        def interpret_out_array_within_fork(stream)
+          if stream.first == :child
+            if stream[1] == :err
+              $stderr
+            elsif stream[1] == :out
+              $stdout
             end
-          when ::String
-            ::File.open(stream, "w")
-          when :close
-            :close
           else
-            stream if stream.respond_to?(:write)
+            ::File.open(*stream)
           end
         end
 
@@ -870,26 +1016,26 @@ module Toys
           end
         end
 
-        def copy_to_in_thread(io, close: false)
+        def copy_to_in_thread(io)
           stream = make_in_pipe
           @join_threads << ::Thread.new do
             begin
               ::IO.copy_stream(io, stream)
             ensure
               stream.close
-              io.close if close
+              io.close
             end
           end
         end
 
-        def copy_from_out_thread(key, io, close: false)
+        def copy_from_out_thread(key, io)
           stream = make_out_pipe(key)
           @join_threads << ::Thread.new do
             begin
               ::IO.copy_stream(stream, io)
             ensure
               stream.close
-              io.close if close
+              io.close
             end
           end
         end

data/lib/toys/utils/terminal.rb

@@ -35,7 +35,7 @@ require "monitor"
 begin
   require "io/console"
 rescue ::LoadError # rubocop:disable Lint/HandleExceptions
-  # TODO: use stty to get terminal size
+  # TODO: alternate methods of getting terminal size
 end
 
 module Toys
@@ -210,33 +210,61 @@ module Toys
         puts
       end
 
+      ##
+      # Ask a question and get a response.
+      #
+      # @param [String] prompt Required prompt string.
+      # @param [Symbol,String,Array<Integer>...] styles Styles to apply to the
+      #     prompt.
+      # @param [String,nil] default Default value, or `nil` for no default.
+      #     Uses `nil` if not specified.
+      # @param [:default,String,nil] trailing_text Trailing text appended to
+      #     the prompt, `nil` for none, or `:default` to show the default.
+      # @return [String]
+      #
+      def ask(prompt, *styles, default: nil, trailing_text: :default)
+        if trailing_text == :default
+          trailing_text = default.nil? ? nil : "[#{default}]"
+        end
+        if trailing_text
+          ptext, pspaces, = prompt.partition(/\s+$/)
+          prompt = "#{ptext} #{trailing_text}#{pspaces}"
+        end
+        write(prompt, *styles)
+        resp = input.gets.to_s.chomp
+        resp.empty? ? default.to_s : resp
+      end
+
       ##
       # Confirm with the user.
       #
       # @param [String] prompt Prompt string. Defaults to `"Proceed?"`.
+      # @param [Symbol,String,Array<Integer>...] styles Styles to apply to the
+      #     prompt.
       # @param [Boolean,nil] default Default value, or `nil` for no default.
       #     Uses `nil` if not specified.
       # @return [Boolean]
       #
-      def confirm(prompt = "Proceed?", default: nil)
-        y = default == true ? "Y" : "y"
-        n = default == false ? "N" : "n"
-        write("#{prompt} (#{y}/#{n}) ")
-        resp = input.gets
-        case resp
-        when /^y/i
-          true
-        when /^n/i
-          false
-        when nil
-          raise TerminalError, "Cannot confirm because the input stream is at eof." if default.nil?
-          default
-        else
-          if !resp.strip.empty? || default.nil?
-            confirm("Please answer \"y\" or \"n\"")
+      def confirm(prompt = "Proceed? ", *styles, default: nil)
+        default_val, trailing_text =
+          case default
+          when true
+            ["y", "(Y/n)"]
+          when false
+            ["n", "(y/N)"]
           else
-            default
+            [nil, "(y/n)"]
           end
+        resp = ask(prompt, *styles, default: default_val, trailing_text: trailing_text)
+        return true if resp =~ /^y/i
+        return false if resp =~ /^n/i
+        if resp.nil? && default.nil?
+          raise TerminalError, "Cannot confirm because the input stream is at eof."
+        end
+        if !resp.strip.empty? || default.nil?
+          confirm('Please answer "y" or "n"', default: default)
+        else
+          default
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline