tty-prompt 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c73bc3ac5978ca2ec1610fee367e6e04e66c0ec
-  data.tar.gz: 3350a73010eb30efd4494799ff5a6e8437115a42
+  metadata.gz: 9160061443d7a4ab50c00c9684f6db737d60edaf
+  data.tar.gz: f83459eb7604c90e7ba32694338204bc0b0ada16
 SHA512:
-  metadata.gz: cd4716769f48d957e8ef5f4167a231d042126ab565267697b3541cd150629c669079275c1cdf66b7d3bba60b02d0b800458d3b84d1f0d0fa26c3c7cce202b709
-  data.tar.gz: 003c09c9afe7d9f3e3b6014bc5352150f49a1609827c637342605f34fcbbac59f0a913b6d20f68cad8b698387b720c00f3025ab3a1fa30984b226adaada07f1f
+  metadata.gz: 5c858da34bb58566bf958d685f7431eefdb3f369736412798cdc1d3c7048908e7b49e00b0ad47164e77a6f8729c78ce3b804eb9b563fbc25ffa920577fc7cedd
+  data.tar.gz: 6457ad7692bd6c47bfce3e4e25bc2b8a14ff664f9c60a4b5e4e34e24b39c65a7b43edc95dde183e70f2e2d54494bc5c2df6efff2df272d2f841b5ea20f8f3ac6

data/.travis.yml

@@ -10,16 +10,14 @@ rvm:
   - 2.1.10
   - 2.2.6
   - 2.3.3
-  - 2.4.0
+  - 2.4.1
   - ruby-head
   - jruby-9000
   - jruby-head
-  - rbx-3
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-3
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.13.0] - 2017-08-11
+
+### Changed
+* Change Timeout to use clock time instead of sleep to measure interval
+* Upgrade tty-cursor to fix save & restore
+
+### Fixed
+* Fix keypress with timeout option to cleanly stop timeout thread
+* Fix Reader on Windows to stop blocking when waiting for key press
+
 ## [v0.12.0] - 2017-03-19
 
 ### Added
@@ -191,6 +201,8 @@
 
 * Initial implementation and release
 
+[v0.13.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.12.0...v0.13.0
+[v0.12.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.11.0...v0.12.0
 [v0.11.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.10.1...v0.11.0
 [v0.10.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.10.0...v0.10.1
 [v0.10.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.9.0...v0.10.0

data/README.md

@@ -268,7 +268,7 @@ You can change these and configure to your liking either by inling them with the
 
 ```ruby
 prompt.ask('What is your email?') do |q|
-  question.validate(/\A\w+@\w+\.\w+\Z/, 'Invalid email address')
+  q.validate(/\A\w+@\w+\.\w+\Z/, 'Invalid email address')
 end
 ```
 
@@ -276,8 +276,8 @@ or change the `messages` key entry out of `:required?`, `:valid?`, `:range?`:
 
 ```ruby
 prompt.ask('What is your email?') do |q|
-  question.validate(/\A\w+@\w+\.\w+\Z/)
-  question.messages[:valid?] = 'Invalid email address'
+  q.validate(/\A\w+@\w+\.\w+\Z/)
+  q.messages[:valid?] = 'Invalid email address'
 end
 ```
 

data/appveyor.yml

@@ -18,6 +18,8 @@ environment:
     - ruby_version: "22-x64"
     - ruby_version: "23"
     - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
 matrix:
   allow_failures:
     - ruby_version: "193"

data/lib/tty/prompt/keypress.rb

@@ -18,7 +18,9 @@ module TTY
         @echo    = options.fetch(:echo) { false }
         @keys    = options.fetch(:keys) { UndefinedSetting }
         @timeout = options.fetch(:timeout) { UndefinedSetting }
-        @interval = options.fetch(:interval) { 1 }
+        @interval = options.fetch(:interval) {
+          (@timeout != UndefinedSetting && @timeout < 1) ? @timeout : 1
+        }
         @pause   = true
         @countdown = @timeout
         @interval_handler = proc { |time|
@@ -67,6 +69,7 @@ module TTY
           while @pause
             @input = @prompt.read_keypress
           end
+          @pause
         end
         @evaluator.(@input)
       end
@@ -77,10 +80,10 @@ module TTY
 
       def time(&block)
         if timeout?
-          secs = Integer(@timeout)
-          interval = Integer(@interval)
+          time = Float(@timeout)
+          interval = Float(@interval)
           scheduler = Timeout.new(interval_handler: @interval_handler)
-          scheduler.timeout(secs, interval, &block)
+          scheduler.timeout(time, interval, &block)
         else
           block.()
         end

data/lib/tty/prompt/reader.rb

@@ -345,7 +345,7 @@ module TTY
       #
       # @api public
       def windows?
-        ::File::ALT_SEPARATOR == "\\"
+        ::File::ALT_SEPARATOR == '\\'
       end
     end # Reader
   end # Prompt

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

@@ -23,6 +23,20 @@ module TTY
           @@getche.call
         end
         module_function :getche
+
+        # Check the console for recent keystroke. If the function
+        # returns a nonzero value, a keystroke is waiting in the buffer.
+        #
+        # @return [Integer]
+        #   return a nonzero value if a key has been pressed. Otherwirse,
+        #   it returns 0.
+        #
+        # @api public
+        def kbhit
+          @@kbhit ||= Fiddle::Function.new(CRT_HANDLE["_kbhit"], [], TYPE_INT)
+          @@kbhit.call
+        end
+        module_function :kbhit
       end # WinAPI
     end # Reader
   end # Prompt

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

@@ -42,11 +42,18 @@ module TTY
         # @api private
         def get_char(options)
           if options[:raw]
-            WinAPI.getch.chr
+            get_char_non_blocking
           else
-            options[:echo] ? @input.getc : WinAPI.getch.chr
+            options[:echo] ? @input.getc : get_char_non_blocking
           end
         end
+
+        # Get the char for last key pressed, or if no keypress return nil
+        #
+        # @api private
+        def get_char_non_blocking
+          WinAPI.kbhit.zero? ? nil : WinAPI.getch.chr
+        end
       end # Console
     end # Reader
   end # Prompt

data/lib/tty/prompt/timeout.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'timers'
+
 module TTY
   class Prompt
     class Timeout
@@ -9,38 +11,57 @@ module TTY
 
       def initialize(options = {})
         @timeout_handler  = options.fetch(:timeout_handler) { TIMEOUT_HANDLER }
-        @interval_handler = options.fetch(:interval_handler) { proc { } }
-        @lock = Mutex.new
+        @interval_handler = options.fetch(:interval_handler) { proc {} }
+        @lock    = Mutex.new
+        @running = true
+        @timers  = Timers::Group.new
       end
 
-      def self.timeout(secs, interval, &block)
-        (@scheduler ||= new).timeout(secs, interval, &block)
+      def self.timeout(time, interval, &block)
+        (@scheduler ||= new).timeout(time, interval, &block)
       end
 
-      def timeout(secs, interval, &block)
-        return block.() if secs.nil? || secs.to_i.zero?
-        @lock.synchronize do
-          @runner = Thread.new {
-            run_in(secs, interval)
-          }
-        end
-        block.()
+      # Evalute block and time it
+      #
+      # @param [Float] time
+      #   the time by which to stop
+      # @param [Float] interval
+      #   the interval time for each tick
+      #
+      # @api public
+      def timeout(time, interval, &block)
+        @runner = async_run(time, interval)
+        @running = block.()
+        @runner.join
       end
 
-      def run_in(secs, interval)
-        Thread.current.abort_on_exception = true
-        start = Time.now
+      def async_run(time, interval)
+        Thread.new do
+          Thread.current.abort_on_exception = true
+          start = Time.now
 
-        loop do
-          sleep(interval)
-          runtime = Time.now - start
-          delta = secs - runtime
-          @interval_handler.(delta.round)
+          interval_timer = @timers.every(interval) do
+            runtime = Time.now - start
+            delta = time - runtime
+            if delta.round >= 0
+              @interval_handler.(delta.round)
+            end
+          end
 
-          if delta < 0.0
-            @timeout_handler.(Thread.current)
-            break
+          while @running
+            @lock.synchronize {
+              @timers.wait
+              runtime = Time.now - start
+              delta = time - runtime
+
+              if delta <= 0.0
+                @timeout_handler.(Thread.current)
+                break
+              end
+            }
           end
+
+          interval_timer.cancel
         end
       end
     end # Scheduler

data/lib/tty/prompt/version.rb

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

data/tty-prompt.gemspec

@@ -13,15 +13,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|spec|features)/})
+                        end
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'necromancer',  '~> 0.4.0'
   spec.add_dependency 'pastel',       '~> 0.7.0'
-  spec.add_dependency 'tty-cursor',   '~> 0.4.0'
-  spec.add_dependency 'wisper',       '~> 1.6.1'
+  spec.add_dependency 'tty-cursor',   '~> 0.5.0'
+  spec.add_dependency 'wisper',       '~> 2.0.0'
+  spec.add_dependency 'timers',       '~> 4.1.2'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -44,28 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -196,68 +210,6 @@ files:
 - lib/tty/prompt/utils.rb
 - lib/tty/prompt/version.rb
 - lib/tty/test_prompt.rb
-- spec/spec_helper.rb
-- spec/unit/ask_spec.rb
-- spec/unit/choice/eql_spec.rb
-- spec/unit/choice/from_spec.rb
-- spec/unit/choices/add_spec.rb
-- spec/unit/choices/each_spec.rb
-- spec/unit/choices/find_by_spec.rb
-- spec/unit/choices/new_spec.rb
-- spec/unit/choices/pluck_spec.rb
-- spec/unit/collect_spec.rb
-- spec/unit/converters/convert_bool_spec.rb
-- spec/unit/converters/convert_char_spec.rb
-- spec/unit/converters/convert_custom_spec.rb
-- spec/unit/converters/convert_date_spec.rb
-- spec/unit/converters/convert_file_spec.rb
-- spec/unit/converters/convert_number_spec.rb
-- spec/unit/converters/convert_path_spec.rb
-- spec/unit/converters/convert_range_spec.rb
-- spec/unit/converters/convert_regex_spec.rb
-- spec/unit/converters/convert_string_spec.rb
-- spec/unit/converters/on_error_spec.rb
-- spec/unit/distance/distance_spec.rb
-- spec/unit/enum_paginator_spec.rb
-- spec/unit/enum_select_spec.rb
-- spec/unit/error_spec.rb
-- spec/unit/evaluator_spec.rb
-- spec/unit/expand_spec.rb
-- spec/unit/keypress_spec.rb
-- spec/unit/mask_spec.rb
-- spec/unit/multi_select_spec.rb
-- spec/unit/multiline_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/ok_spec.rb
-- spec/unit/paginator_spec.rb
-- spec/unit/question/checks_spec.rb
-- spec/unit/question/default_spec.rb
-- spec/unit/question/echo_spec.rb
-- spec/unit/question/in_spec.rb
-- spec/unit/question/initialize_spec.rb
-- spec/unit/question/modifier/apply_to_spec.rb
-- spec/unit/question/modifier/letter_case_spec.rb
-- spec/unit/question/modifier/whitespace_spec.rb
-- spec/unit/question/modify_spec.rb
-- spec/unit/question/required_spec.rb
-- spec/unit/question/validate_spec.rb
-- spec/unit/question/validation/call_spec.rb
-- spec/unit/question/validation/coerce_spec.rb
-- spec/unit/reader/history_spec.rb
-- spec/unit/reader/key_event_spec.rb
-- spec/unit/reader/line_spec.rb
-- spec/unit/reader/publish_keypress_event_spec.rb
-- spec/unit/reader/read_keypress_spec.rb
-- spec/unit/reader/read_line_spec.rb
-- spec/unit/reader/read_multiline_spec.rb
-- spec/unit/result_spec.rb
-- spec/unit/say_spec.rb
-- spec/unit/select_spec.rb
-- spec/unit/slider_spec.rb
-- spec/unit/statement/initialize_spec.rb
-- spec/unit/suggest_spec.rb
-- spec/unit/warn_spec.rb
-- spec/unit/yes_no_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -286,67 +238,5 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A beautiful and powerful interactive command line prompt.
-test_files:
-- spec/spec_helper.rb
-- spec/unit/ask_spec.rb
-- spec/unit/choice/eql_spec.rb
-- spec/unit/choice/from_spec.rb
-- spec/unit/choices/add_spec.rb
-- spec/unit/choices/each_spec.rb
-- spec/unit/choices/find_by_spec.rb
-- spec/unit/choices/new_spec.rb
-- spec/unit/choices/pluck_spec.rb
-- spec/unit/collect_spec.rb
-- spec/unit/converters/convert_bool_spec.rb
-- spec/unit/converters/convert_char_spec.rb
-- spec/unit/converters/convert_custom_spec.rb
-- spec/unit/converters/convert_date_spec.rb
-- spec/unit/converters/convert_file_spec.rb
-- spec/unit/converters/convert_number_spec.rb
-- spec/unit/converters/convert_path_spec.rb
-- spec/unit/converters/convert_range_spec.rb
-- spec/unit/converters/convert_regex_spec.rb
-- spec/unit/converters/convert_string_spec.rb
-- spec/unit/converters/on_error_spec.rb
-- spec/unit/distance/distance_spec.rb
-- spec/unit/enum_paginator_spec.rb
-- spec/unit/enum_select_spec.rb
-- spec/unit/error_spec.rb
-- spec/unit/evaluator_spec.rb
-- spec/unit/expand_spec.rb
-- spec/unit/keypress_spec.rb
-- spec/unit/mask_spec.rb
-- spec/unit/multi_select_spec.rb
-- spec/unit/multiline_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/ok_spec.rb
-- spec/unit/paginator_spec.rb
-- spec/unit/question/checks_spec.rb
-- spec/unit/question/default_spec.rb
-- spec/unit/question/echo_spec.rb
-- spec/unit/question/in_spec.rb
-- spec/unit/question/initialize_spec.rb
-- spec/unit/question/modifier/apply_to_spec.rb
-- spec/unit/question/modifier/letter_case_spec.rb
-- spec/unit/question/modifier/whitespace_spec.rb
-- spec/unit/question/modify_spec.rb
-- spec/unit/question/required_spec.rb
-- spec/unit/question/validate_spec.rb
-- spec/unit/question/validation/call_spec.rb
-- spec/unit/question/validation/coerce_spec.rb
-- spec/unit/reader/history_spec.rb
-- spec/unit/reader/key_event_spec.rb
-- spec/unit/reader/line_spec.rb
-- spec/unit/reader/publish_keypress_event_spec.rb
-- spec/unit/reader/read_keypress_spec.rb
-- spec/unit/reader/read_line_spec.rb
-- spec/unit/reader/read_multiline_spec.rb
-- spec/unit/result_spec.rb
-- spec/unit/say_spec.rb
-- spec/unit/select_spec.rb
-- spec/unit/slider_spec.rb
-- spec/unit/statement/initialize_spec.rb
-- spec/unit/suggest_spec.rb
-- spec/unit/warn_spec.rb
-- spec/unit/yes_no_spec.rb
+test_files: []
 has_rdoc: