tty-prompt 0.17.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c688ca710d4099ceda4afec8d6e7dcbd2b20db56a94162348366dbfa15a33e
-  data.tar.gz: 58d8588967168ce881cd0b4da632d1bff7d67e735ad5debf906bf415d6c00ec6
+  metadata.gz: add9caacfddf9bf791d06ebc7a1c71bfe8b93bf9223a99ae7b44cd7e7db6bbc7
+  data.tar.gz: f438dccea904d0bcb7e8eda4aa5c4c3c9e1002dc26ab2e1afd75a8a8c9cad315
 SHA512:
-  metadata.gz: e7037f42befaf3ebec087e72a17f1aeaf208e459952c6682a4f05cfc7ac753a081fc15e1524b8c286a2819872f8d75f3d669907a0244c49ccd520982b7c4e5fb
-  data.tar.gz: 39a6c809245322fd7a7d083343d2c6109ca9a28f8cdfc82ed0844eceb110704add7eccc0f1d5b4fd93f990f1c6a4a3b045ba0101f6bd71a8f967afe7c3d96f2a
+  metadata.gz: 3f3a0b45e1c57b370de325375698920ee07ea1e57cbfe8ac830cd38da5d1b8755e5ba4c844cfdea5a9fafe7c6744c5aaa199c13ff32e1f59bef41135bf23f7cd
+  data.tar.gz: 2fd7510bb85454bad9b089a6d2684418eb710ecbe49d3c423ffa118a8980e9fa9dd54e3f6ea5185334939d1fce3ff03abc489b3b1dad47d4304b3fcc4304cac3

data/CHANGELOG.md

@@ -0,0 +1,305 @@
+# Change log
+
+## [v0.17.1] - 2018-10-03
+
+### Change
+* Change #select, #multi_select to allow alphanumeric, punctuation and space characters in filters
+
+### Fixed
+* Fix #select by making filter an array to avoid frozen string issues by Chris Hoffman(@yarmiganosca)
+
+## [v0.17.0] - 2018-08-05
+
+### Changed
+* Change to update tty-reader & tty-cursor dependencies
+* Change to directly requrie files in gemspec
+
+## [v0.16.1] - 2018-04-29
+
+### Fixed
+* Fix key events subscription to only listen for the current prompt events
+
+## [v0.16.0] - 2018-03-11
+
+### Added
+* Add :disabled key to Choice
+* Add ability to disable choices in #select, #multi_selct & #enum_select prompts
+* Add #frozen_string_literal to all files
+
+### Changed
+* Change Choice#from to allow parsing different data strucutures
+* Change all classes to prevent strings mutations
+* Change Timeout to cleanly terminate keypress input without raising errors
+
+### Fixed
+* Fix #select, #enum_select & #multi_select navigation to work correctly with items longer than terminal screen width
+* Fix timeout on Ruby 2.5 and stop raising Timeout::Error
+
+## [v0.15.0] - 2018-02-08
+
+### Added
+* Add ability to filter list items in #select, #multi_select & #enum_selct prompts by Saverio Miroddi(@saveriomiroddi)
+* Add support for array of values for an answer collector key by Danny Hadley(@dadleyy)
+
+### Changed
+* Relax dependency on timers by Andy Brody(@brodygov)
+
+## [v0.14.0] - 2018-01-01
+
+### Added
+* Add :cycle option to #select, #multi_select & #enum_select prompts to allow toggling between infinite and bounded list by Jonas Müller(@muellerj)
+
+### Changed
+* Change #multi_selct, #select & #enum_select to stop cycling options by default by Jona Müller(@muellerj)
+* Change gemspec to require ruby >= 2.0.0
+* Change #slider prompt to display slider next to query and help underneath
+* Change to use tty-reader v0.2.0 with new line editing features for processing long inputs
+
+### Fixed
+* Fix Paginator & EnumPaginator to allow only positive integer values by Andy Brody(@ab)
+* Fix EnumSelect to report on default option out of range and raise correctly
+* Fix #ask :file & :path converters to correctly locate the files
+* Fix #ask, #multiline to correctly handle long strings that wrap around screen
+* Fix #slider prompt to correctly scale sliding
+
+## [v0.13.2] - 2017-08-30
+
+### Changed
+* Change to extract TTY::Prompt::Reader to its own dependency
+
+## [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
+* 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
+* Add Multiline question type
+* Add Keypress question type
+* Add Reader::History for storing buffered lines
+* Add Reader::Line for line abstraction
+
+### Changed
+* Remove :read option from Question
+* Chnage Reader#read_line to handle raw mode for processing special
+  characters such as Ctrl+x, navigate through history buffer
+  using up/down arrows, allow editing current line by moving left/right
+  with arrow keys and inserting content
+* Change Reader#read_multiline to gather multi line input correctly,
+  skip empty lines and terminate when Ctrl+d and Ctrl+z are pressed
+* Change Reader::Mode to check if tty is available by Matt Martyn (@MMartyn)
+* Change #keypress prompt to correctly refresh line and accept :keys & :timeout options
+
+### Fixed
+* Fix issue with #select, #multi_selct, #enum_select when choices are
+  provided as hash object together with prompt options.
+* Fix issue with default parameter for yes?/no? prompt by Carlos Fonseca (@carlosefonseca)
+* Fix List#help to allow setting help text through DSL
+
+## [v0.11.0] - 2017-02-26
+
+### Added
+* Add Console for reading input characters on Unix systems
+* Add WinConsole for reading input characters on Windows systems
+* Add WindowsApi to allow for calls to external Windows api
+* Add echo support to multilist by Keith Keith T. Garner(@ktgeek)
+
+### Changed
+* Change Reader to use Console for input reading
+* Change Codes to use codepoints instead of strings
+* Change Reader#read_line to match #gets behaviour
+* Change Symbols to provide Unicode support on windows
+* Change Slider to display Unicode when possible
+* Change ConverterRegistry to be immutable
+* Change Reader to expose #trigger in place of #publish for events firing
+
+### Fixed
+* Fix `modify` throwing exception, when user enters empty input by Igor Rzegocki(@ajgon)
+* Fix #clear_line behaviour by using tty-cursor 0.4.0 to work in all terminals
+* Fix paging issue for lists shorter than :per_page value repeating title
+* Fix #mask prompt to correctly match input on Windows
+* Fix @mask to use default error messages
+* Fix #select & #multi_select prompts to allow changing options with arrow keys on Windows
+* Fix #echo to work correctly in zsh shell by štef(@d4be4st)
+* Fix Slider#keyright event accepting max value outside of range
+* Fix 2.4.0 conversion errors by using necromancer 0.4.0
+* Fix #enum_select preventing selection of first item
+
+## [v0.10.1] - 2017-02-06
+
+### Fixed
+* Fix File namespacing
+
+## [v0.10.0] - 2017-01-01
+
+### Added
+* Add :enable_color option for toggling colors support
+
+### Changed
+* Update pastel dependency version
+
+## [v0.9.0] - 2016-12-20
+
+### Added
+* Add ability to paginate choices list for #select, #multi_select & #enum_select
+  with :per_page, :page_info and :default options
+* Add ability to switch through options in #select & #multi_select using the tab key
+
+### Fixed
+* Fix readers to accept multibyte characters reported by Jaehyun Shin(@keepcosmos)
+
+## [v0.8.0] - 2016-11-29
+
+### Added
+* Add ability to publish custom key events for VIM keybindings customisations etc...
+
+### Fixed
+* Fix Reader#read_char to use Ruby internal buffers instead of direct system call by @kke(Kimmo Lehto)
+* Fix issue with #ask required & validate checks to take into account required when validating values
+* Fix bug with #read_keypress to handle function keys and meta navigation keys
+* Fix issue with default messages not displaying for `range`, `required` and `validate`
+
+## [v0.7.1] - 2016-08-07
+
+### Fixed
+* Fix Reader::Mode to include standard io library
+
+## [v0.7.0] - 2016-07-17
+
+### Added
+* Add :interrupt_handler option to customise keyboard interrupt behaviour
+
+### Changed
+* Remove tty-platform dependency
+
+### Fixed
+* Fix Reader#read_keypress issue when handling interrupt signal by Ondrej Moravcik(@ondra-m)
+* Fix raw & echo modes to use standard library support by Kim Burgestrand(@Burgestrand)
+
+## [v0.6.0] - 2016-05-21
+
+### Changed
+* Upgrade tty-cursor dependency
+
+### Fixed
+* Fix issue with reader trapping signals by @kylekyle
+* Fix expand to use new prev_line implementation
+
+## [v0.5.0] - 2016-03-28
+
+### Added
+* Add ConfirmQuestion for #yes? & #no? calls
+* Add ability to collect more than one answer through #collect call
+* Add Choices#find_by for selecting choice based on attribute
+* Add Prompt#expand for expanding key options
+* Add :active_color, :help_color, :prefix options for customizing prompts display
+
+### Changed
+* Change Choice#from to allow for coersion of complex objects with keys
+* Change Choices#pluck to search through object attributes
+* Change #select :enum option help text to display actual numbers range
+
+### Fixed
+* Fix #no? to correctly ask negative question by @ondra-m
+* Fix #ask :default option to handle nil or empty string
+* Fix #multi_select :default option and color changing
+
+## [v0.4.0] - 2016-02-08
+
+### Added
+* Add :enum option for #select & #multi_select to allow for numerical selection by @rtoshiro
+* Add new key event types to KeyEvent
+* Add #slider for picking values from range of numbers
+* Add #enum_select for selecting option from enumerated list
+* Add ability to configure error messages for #ask call
+* Add new ConversionError type
+
+### Changed
+* Move #blank? to Utils
+* Update pastel dependency
+
+## [v0.3.0] - 2015-12-28
+
+### Added
+* Add prefix option to prompt to customize #ask, #select, #multi_select
+* Add default printing to #ask
+* Add #yes?/#no? boolean queries
+* Add Evaluator and Result for validation checking to Question
+* Add ability for #ask to display error messages on failed validation
+* Add ability to specify in-built names for validation e.i. :email
+* Add KeyEvent for keyboard events publishing to Reader
+* Add #read_multiline to Reader
+* Add :convert option for ask configuration
+* Add ability to specify custom proc converters
+* Add #ask_keypress to gather character input
+* Add #ask_multiline to gather multiline input
+* Add MaskedQuestion & #mask method for masking input stream characters
+
+### Changed
+* Change Reader#read_keypress to be robust and read correctly byte sequences
+* Change Reader#getc to #read_line and extend arguments with echo option
+* Extract cursor movement to dependency tty-cursor
+* Change List & MultiList to subscribe to keyboard events
+* Change to move mode inside reader namespace
+* Remove Response & Error objects
+* Remove :char option from #ask
+* Change :read option to specify mode of reading out of :line, :multiline, :keypress
+* Rename #confirm to #ok
+
+## [v0.2.0] - 2015-11-23
+
+### Added
+* Add ability to select choice form list #select
+* Add ability to select multiple options #multi_select
+* Add :read option to #ask for reading specific type input
+
+### Changed
+* Change #ask api to be similar to #select and #multi_select behaviour
+* Change #ask :argument option to be :required
+* Remove :valid option from #ask as #select is a better solution
+
+## [v0.1.0] - 2015-11-01
+
+* Initial implementation and release
+
+[v0.17.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.0...v0.17.1
+[v0.17.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.16.1...v0.17.0
+[v0.16.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.16.0...v0.16.1
+[v0.16.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.15.0...v0.16.0
+[v0.15.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.14.0...v0.15.0
+[v0.14.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.2...v0.14.0
+[v0.13.2]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.1...v0.13.2
+[v0.13.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.0...v0.13.1
+[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
+[v0.9.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.8.0...v0.9.0
+[v0.8.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.7.1...v0.8.0
+[v0.7.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.6.0...v0.7.0
+[v0.6.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.1.0

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::Prompt [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-prompt.svg)][gem]

data/lib/tty/prompt/list.rb

@@ -21,7 +21,7 @@ module TTY
       PAGE_HELP = '(Move up or down to reveal more choices)'.freeze
 
       # Allowed keys for filter, along with backspace and canc.
-      FILTER_KEYS_MATCHER = /\A\w\Z/
+      FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/
 
       # Create instance of TTY::Prompt::List menu.
       #
@@ -50,7 +50,8 @@ module TTY
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @marker       = options.fetch(:marker) { symbols[:pointer] }
         @cycle        = options.fetch(:cycle) { false }
-        @filter       = options.fetch(:filter) { false } ? '' : nil
+        @filterable   = options.fetch(:filter) { false }
+        @filter       = []
         @help         = options[:help]
         @first_render = true
         @done         = false
@@ -121,7 +122,7 @@ module TTY
         # Note that enumeration and filter are mutually exclusive
         tokens = if enumerate?
                    [" or number (1-#{choices.size})", '']
-                 elsif @filter
+                 elsif filterable?
                    ['', ", and letter keys to filter"]
                  else
                    ['', '']
@@ -157,12 +158,12 @@ module TTY
       # @api public
       def choices(values = (not_set = true))
         if not_set
-          if @filter.to_s.empty?
+          if !filterable? || @filter.empty?
             @choices
           else
             @choices.select do |_choice|
               !_choice.disabled? &&
-                _choice.name.downcase.include?(@filter.downcase)
+                _choice.name.downcase.include?(@filter.join.downcase)
             end
           end
         else
@@ -241,25 +242,25 @@ module TTY
       alias keytab keydown
 
       def keypress(event)
-        return unless @filter
+        return unless filterable?
 
         if event.value =~ FILTER_KEYS_MATCHER
-          @filter += event.value
+          @filter << event.value
           @active = 1
         end
       end
 
       def keydelete(*)
-        return unless @filter
+        return unless filterable?
 
-        @filter = ''
+        @filter.clear
         @active = 1
       end
 
       def keybackspace(*)
-        return unless @filter
+        return unless filterable?
 
-        @filter.slice!(-1)
+        @filter.pop
         @active = 1
       end
 
@@ -372,13 +373,22 @@ module TTY
         header.join
       end
 
+      # Is filtering enabled?
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def filterable?
+        @filterable
+      end
+
       # Header part showing the current filter
       #
       # @return String
       #
       # @api private
       def filter_help
-        "(Filter: #{@filter.inspect})"
+        "(Filter: #{@filter.join.inspect})"
       end
 
       # Render initial help and selected choice
@@ -392,7 +402,7 @@ module TTY
           @prompt.decorate(selected_item, @active_color)
         elsif @first_render
           @prompt.decorate(help, @help_color)
-        elsif @filter.to_s != ''
+        elsif filterable? && @filter.any?
           @prompt.decorate(filter_help, @help_color)
         end
       end

data/lib/tty/prompt/multi_list.rb

@@ -71,11 +71,11 @@ module TTY
         if @done && @echo
           @prompt.decorate(selected_names, @active_color)
         elsif @selected.size.nonzero? && @echo
-          help_suffix = @filter.to_s != "" ? " #{filter_help}" : ""
+          help_suffix = filterable? && @filter.any? ? " #{filter_help}" : ""
           selected_names + (@first_render ? " #{instructions}" : help_suffix)
         elsif @first_render
           instructions
-        elsif @filter.to_s != ""
+        elsif filterable? && @filter.any?
           filter_help
         end
       end

data/lib/tty/prompt/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module TTY
   class Prompt
-    VERSION = '0.17.0'.freeze
+    VERSION = '0.17.1'
   end # Prompt
 end # TTY

data/spec/unit/select_spec.rb

@@ -500,6 +500,25 @@ RSpec.describe TTY::Prompt, '#select' do
       expect(actual_prompt_output).to eql(expected_prompt_output)
     end
 
+    it "filters based on alphanumeric and punctuation characters" do
+      prompt = TTY::TestPrompt.new
+      prompt.input << "p" << "*" << "2" << "\r"
+      prompt.input.rewind
+
+      answer = prompt.select("What email?", %w(p*1@mail.com p*2@mail.com p*3@mail.com), filter: true)
+      expect(answer).to eql("p*2@mail.com")
+
+      actual_prompt_output = prompt.output.string
+      expected_prompt_output =
+        output_helper("What email?", %w(p*1@mail.com p*2@mail.com p*3@mail.com), "p*1@mail.com", init: true, hint: "Use arrow keys, press Enter to select, and letter keys to filter") +
+        output_helper("What email?", %w(p*1@mail.com p*2@mail.com p*3@mail.com), "p*1@mail.com", hint: 'Filter: "p"') +
+        output_helper("What email?", %w(p*1@mail.com p*2@mail.com p*3@mail.com), "p*1@mail.com", hint: 'Filter: "p*"') +
+        output_helper("What email?", %w(p*2@mail.com), "p*2@mail.com", hint: 'Filter: "p*2"') +
+        exit_message("What email?", "p*2@mail.com")
+
+      expect(actual_prompt_output).to eql(expected_prompt_output)
+    end
+
     # This test can't be done in an exact way, at least, with the current framework
     it "doesn't exit when there are no matching entries" do
       prompt = TTY::TestPrompt.new

data/tty-prompt.gemspec

@@ -13,7 +13,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
-  spec.files         = Dir["README.md", "LICENSE.txt", "Rakefile", "lib/**/*.rb", "examples/**/*.rb", "tasks/**", "tty-prompt.gemspec"]
+  spec.files         = Dir['{lib,spec,examples}/**/*.rb']
+  spec.files        += Dir['tasks/*', 'tty-prompt.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = Dir["spec/**/*.rb"]
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-05 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -136,6 +136,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile