tty-prompt 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9160061443d7a4ab50c00c9684f6db737d60edaf
-  data.tar.gz: f83459eb7604c90e7ba32694338204bc0b0ada16
+  metadata.gz: 6826fe5bd7ea9efb4e7e901d1bf2aaa34671bd0d
+  data.tar.gz: 440b8acadbc509ffe2260562c1cf9d8e2b192ce0
 SHA512:
-  metadata.gz: 5c858da34bb58566bf958d685f7431eefdb3f369736412798cdc1d3c7048908e7b49e00b0ad47164e77a6f8729c78ce3b804eb9b563fbc25ffa920577fc7cedd
-  data.tar.gz: 6457ad7692bd6c47bfce3e4e25bc2b8a14ff664f9c60a4b5e4e34e24b39c65a7b43edc95dde183e70f2e2d54494bc5c2df6efff2df272d2f841b5ea20f8f3ac6
+  metadata.gz: b4ba64116ae4982a55d032e60a6cee47d28a165e4ab1286c294e3e3109e602f4e6c174febfbe81507d0676eadbd0771565e73fc65c79bda5b914e1fd02405e67
+  data.tar.gz: 3213c42f59d3c3df70a826ed6d2e69f8328725a7483a9ce57437b1464f1c4ae8a2c99a70cd1c43451c8b55d14bcb3ee02e1b98421145397ee08f9892424669bf

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## [v0.13.1] - 2017-08-16
+
+### Added
+* Add ability to manually cancel the time scheduler
+
+### Changed
+* Change #keypress to use new scheduler cancelling
+* Change Reader to inline interrupt to allow for early exit
+
+### Fix
+* Fix keypress reading on Windows to distinguish between blocking & non-blocking IO
+
 ## [v0.13.0] - 2017-08-11
 
 ### Changed

data/examples/keypress.rb

@@ -6,4 +6,4 @@ prompt = TTY::Prompt::new
 
 answer = prompt.keypress("Press any key to continue")
 
-puts "Answer: #{answer}"
+puts "Answer: #{answer.inspect}"

data/examples/pause.rb

@@ -4,4 +4,6 @@ require 'tty-prompt'
 
 prompt = TTY::Prompt::new
 
-prompt.keypress("Press space or enter to continue, continuing automatically in :countdown ...", keys: [:space, :return], timeout: 3)
+answer = prompt.keypress("Press space or enter to continue, continuing automatically in :countdown ...", keys: [:space, :return], timeout: 3)
+
+puts "Answer: #{answer.inspect}"

data/lib/tty/prompt/keypress.rb

@@ -21,14 +21,16 @@ module TTY
         @interval = options.fetch(:interval) {
           (@timeout != UndefinedSetting && @timeout < 1) ? @timeout : 1
         }
-        @pause   = true
         @countdown = @timeout
         @interval_handler = proc { |time|
-          question = render_question
-          @prompt.print(refresh(question.lines.count))
-          countdown(time)
-          @prompt.print(render_question)
+          unless @done
+            question = render_question
+            @prompt.print(refresh(question.lines.count))
+            countdown(time)
+            @prompt.print(render_question)
+          end
         }
+        @scheduler = Timeout.new(interval_handler: @interval_handler)
 
         @prompt.subscribe(self)
       end
@@ -50,11 +52,13 @@ module TTY
 
       def keypress(event)
         if any_key?
-          @pause = false
+          @done = true
+          @scheduler.cancel
         elsif @keys.is_a?(Array) && @keys.include?(event.key.name)
-          @pause = false
+          @done = true
+          @scheduler.cancel
         else
-          @pause = true
+          @done = false
         end
       end
 
@@ -66,10 +70,9 @@ module TTY
 
       def process_input(question)
         time do
-          while @pause
-            @input = @prompt.read_keypress
+          until @done
+            @input = @prompt.read_keypress(nonblock: true)
           end
-          @pause
         end
         @evaluator.(@input)
       end
@@ -78,14 +81,16 @@ module TTY
         @prompt.clear_lines(lines)
       end
 
-      def time(&block)
+      # Wait for keypress or timeout
+      #
+      # @api private
+      def time(&job)
         if timeout?
           time = Float(@timeout)
           interval = Float(@interval)
-          scheduler = Timeout.new(interval_handler: @interval_handler)
-          scheduler.timeout(time, interval, &block)
+          @scheduler.timeout(time, interval, &job)
         else
-          block.()
+          job.()
         end
       rescue Timeout::Error
       end

data/lib/tty/prompt/reader/win_api.rb

@@ -12,12 +12,24 @@ module TTY
 
         CRT_HANDLE = Handle.new("msvcrt") rescue Handle.new("crtdll")
 
+        # Get a character from the console without echo.
+        #
+        # @return [String]
+        #   return the character read
+        #
+        # @api public
         def getch
           @@getch ||= Fiddle::Function.new(CRT_HANDLE["_getch"], [], TYPE_INT)
           @@getch.call
         end
         module_function :getch
 
+        # Gets a character from the console with echo.
+        #
+        # @return [String]
+        #   return the character read
+        #
+        # @api public
         def getche
           @@getche ||= Fiddle::Function.new(CRT_HANDLE["_getche"], [], TYPE_INT)
           @@getche.call

data/lib/tty/prompt/reader/win_console.rb

@@ -31,20 +31,30 @@ module TTY
           @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]
         end
 
-        # Get a character from console with echo
+        # Get a character from console blocking for input
         #
         # @param [Hash[Symbol]] options
         # @option options [Symbol] :echo
-        #   the echo toggle
+        #   the echo mode toggle
+        # @option options [Symbol] :raw
+        #   the raw mode toggle
         #
         # @return [String]
         #
         # @api private
         def get_char(options)
-          if options[:raw]
-            get_char_non_blocking
+          if options[:raw] && options[:echo]
+            if options[:nonblock]
+              get_char_echo_non_blocking
+            else
+              get_char_echo_blocking
+            end
+          elsif options[:raw] && !options[:echo]
+            options[:nonblock] ? get_char_non_blocking : get_char_blocking
+          elsif !options[:raw] && !options[:echo]
+            options[:nonblock] ? get_char_non_blocking : get_char_blocking
           else
-            options[:echo] ? @input.getc : get_char_non_blocking
+            @input.getc
           end
         end
 
@@ -52,7 +62,28 @@ module TTY
         #
         # @api private
         def get_char_non_blocking
-          WinAPI.kbhit.zero? ? nil : WinAPI.getch.chr
+          input_ready? ? get_char_blocking : nil
+        end
+
+        def get_char_echo_non_blocking
+          input_ready? ? get_char_echo_blocking : nil
+        end
+
+        def get_char_blocking
+          WinAPI.getch.chr
+        end
+
+        def get_char_echo_blocking
+          WinAPI.getche.chr
+        end
+
+        # Check if IO has user input
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        def input_ready?
+          !WinAPI.kbhit.zero?
         end
       end # Console
     end # Reader

data/lib/tty/prompt/reader.rb

@@ -119,7 +119,6 @@ module TTY
         char  = codes ? codes.pack('U*') : nil
 
         trigger_key_event(char) if char
-        handle_interrupt if char == console.keys[:ctrl_c]
         char
       end
       alias read_char read_keypress
@@ -135,6 +134,7 @@ module TTY
       def get_codes(options = {}, codes = [])
         opts = { echo: true, raw: false }.merge(options)
         char = console.get_char(opts)
+        handle_interrupt if char == console.keys[:ctrl_c]
         return if char.nil?
         codes << char.ord
 
@@ -184,8 +184,6 @@ module TTY
           elsif [console.keys[:ctrl_d],
                  console.keys[:ctrl_z]].include?(char)
             break
-          elsif console.keys[:ctrl_c] == char
-            handle_interrupt
           elsif ctrls.include?(console.keys.key(char))
             # skip
           elsif console.keys[:up] == char

data/lib/tty/prompt/timeout.rb

@@ -29,12 +29,17 @@ module TTY
       #   the interval time for each tick
       #
       # @api public
-      def timeout(time, interval, &block)
+      def timeout(time, interval, &job)
         @runner = async_run(time, interval)
-        @running = block.()
+        job.()
         @runner.join
       end
 
+      def cancel
+        return unless @running
+        @running = false
+      end
+
       def async_run(time, interval)
         Thread.new do
           Thread.current.abort_on_exception = true

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.13.0"
+    VERSION = "0.13.1"
   end # Prompt
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer