tty-prompt 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0dae59e66025830ef0a5c219e863d20a3fb9819
-  data.tar.gz: 4577e97283604bc010de09be994612d123a0581a
+  metadata.gz: 4ff94c2773632a84c5e652c8c725cdc576718ae6
+  data.tar.gz: 382b630ad1f975325744210cb7a308bfc09175e2
 SHA512:
-  metadata.gz: 679adea2e8b4fbd15f7612081fd5f6a2d0253f92aefb162b9d69b7d9be626cfadd67855363b54db68dde55a2cbecbb481e7e5bf30acb7cf1d78d3a7e8ca99af8
-  data.tar.gz: 5bec8d5cae28cb7099f21d0a979bdf441a7440f52b5f0eea9b6430610d902bb7aa5b380fb994119c45cdf3492c1e0bad24c3d557d2a210029845b585d2213760
+  metadata.gz: ed722a06def652f9cb1e02fa627fe28ebfdfa0a8bdfa7a36e426b8976d4c0eab287f1e50f2800f2b7c87a185d1b4325d7628409991f6ba9061029976909c2805
+  data.tar.gz: 5bad4344ba8e132eaf35409329ab8583aa52f2a94a296b5b23eb13cb11c3436e71601c7bd9351ecf17d70b1851d910b2600e4ea8cfea81e08d3de507edbfa43f

data/.travis.yml

@@ -17,7 +17,6 @@ rvm:
   - rbx-3
 matrix:
   allow_failures:
-    - rvm: 2.4.0
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-3

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Change log
 
+## [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
@@ -137,6 +166,7 @@
 
 * Initial implementation and release
 
+[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

data/README.md

@@ -62,6 +62,7 @@ Or install it yourself as:
   * [2.6 menu](#26-menu)
     * [2.6.1 select](#261-select)
     * [2.6.2 multi_select](#262-multi_select)
+    * [2.6.2.1 echo](#2621-echo)
     * [2.6.3 enum_select](#263-enum_select)
   * [2.7 expand](#27-expand)
   * [2.8 collect](#28-collect)
@@ -142,10 +143,10 @@ prompt.enum_select("Select an editor?", choices)
 # =>
 #
 # Select an editor?
-#   1) /bin/nano
-#   2) /usr/bin/vim.basic
-#   3) /usr/bin/vim.tiny
-#   Choose 1-3 [2]:
+#   1) emacs
+#   2) nano
+#   3) vim
+#   Choose 1-3 [1]:
 ```
 
 However, if you have a lot of options to choose from you may want to use `expand`:
@@ -561,7 +562,7 @@ letters = ('A'..'Z').to_a
 prompt.select("Choose your letter?") do |menu|
   menu.per_page 4
   menu.page_help '(Wiggle thy finger up or down to see more)'
-  menu.choices letters, per_page: 4)
+  menu.choices letters
 end
 ```
 
@@ -680,6 +681,23 @@ prompt.multi_select("Choose your letter?", letters, per_page: 4)
 # (Move up or down to reveal more choices)
 ```
 
+### 2.6.2.1 echo
+
+To control whether the selected items are shown on the question
+header use the :echo option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, echo: false)
+# =>
+# Select drinks?
+#   ⬡ vodka
+#   ⬢ 2) beer
+#   ⬡ 3) wine
+#   ⬡ 4) whisky
+# ‣ ⬢ 5) bourbon
+```
+
 ### 2.6.3 enum_select
 
 In order to ask for standard selection from indexed list you can use `enum_select` and pass question together with possible choices:
@@ -944,12 +962,12 @@ For example, to add vim like key navigation to `select` prompt one would do the
 
 ```ruby
 prompt.on(:keypress) do |event|
-  if event.key.name == 'j'
-    prompt.publish(:keydown)
+  if event.value == 'j'
+    prompt.trigger(:keydown)
   end
 
-  if event.key.name == 'k'
-    prompt.publish(:keyup)
+  if event.value == 'k'
+    prompt.trigger(:keyup)
   end
 end
 ```
@@ -983,6 +1001,12 @@ The available events are:
 
 All prompt types support `:active_color` option. In case of `select`, `multi_select`, `enum_select` or `expand` this color is used to highlight the currently selected choice. All the resulted inputs provided by user that are read in by the prompt as answer are highlighted with this color. This option can be applied either globablly for all prompts or individually.
 
+```ruby
+prompt = TTY::Prompt.new(active_color: :cyan)
+```
+
+or per individual input do:
+
 ```ruby
 prompt.select('What size?', %w(Large Medium Small), active_color: :cyan)
 ```
@@ -1001,6 +1025,12 @@ prompt = TTY::Prompt.new(enable_color: true)
 
 Prompts such as `select`, `multi_select`, `expand` support `:help_color` which is used to customize the help text. This option can be applied either globablly for all prompts or individually.
 
+```ruby
+prompt = TTY::Prompt.new(help_color: :cyan)
+```
+
+or per individual input do:
+
 ```ruby
 prompt.select('What size?', %w(Large Medium Small), help_color: :cyan)
 ```

data/examples/echo.rb

@@ -4,4 +4,8 @@ require 'tty-prompt'
 
 prompt = TTY::Prompt.new
 
-puts prompt.ask('Password?', echo: false)
+answer = prompt.ask('Password?', echo: false) do |q|
+  q.validate(/^[^\.]+\.[^\.]+/)
+end
+
+#puts answer

data/examples/inputs.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.ask('What is your name?', default: ENV['USER'])
+prompt.yes?('Do you like Ruby?')
+prompt.mask("What is your secret?")
+prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))

data/examples/mask.rb

@@ -1,9 +1,13 @@
 # encoding: utf-8
 
 require 'tty-prompt'
+require 'pastel'
 
 prompt = TTY::Prompt.new
+heart = prompt.decorate('❤ ', :magenta)
 
-prompt.mask('What is your secret?') do |q|
-  q.validate /[a-z]{5,8}/
+res = prompt.mask('What is your secret?', mask: heart) do |q|
+  q.validate(/[a-z\ ]{5,15}/)
 end
+
+puts "Secret: \"#{res}\""

data/examples/multi_select.rb

@@ -5,4 +5,4 @@ require 'tty-prompt'
 prompt = TTY::Prompt.new
 
 drinks = %w(vodka beer wine whisky bourbon)
-prompt.multi_select('Choose your favourite drink?', drinks)
+prompt.multi_select('Choose your favourite drink?', drinks, help: '(Use arrow keys and Enter to finish)')

data/examples/multi_select_paged.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+alfabet = ('A'..'Z').to_a
+
+prompt.multi_select('Which letter?', alfabet, per_page: 5)

data/examples/select.rb

@@ -4,14 +4,14 @@ require 'tty-prompt'
 
 prompt = TTY::Prompt.new
 
-warriors = %w(Scorpion Kano Jax)
+warriors = %w(Scorpion Kano Jax Kitana Raiden)
 
 prompt.on(:keypress) do |event|
-  if event.key.name == 'j'
-    prompt.publish(:keydown)
+  if event.value == 'j'
+    prompt.trigger(:keydown)
   end
-  if event.key.name == 'k'
-    prompt.publish(:keyup)
+  if event.value == 'k'
+    prompt.trigger(:keyup)
   end
 end
 

data/examples/slider.rb

@@ -3,4 +3,4 @@
 require 'tty-prompt'
 
 prompt = TTY::Prompt.new
-prompt.slider("What size?", min: 32, max: 54, step: 2)
+prompt.slider("What size?", min: 0, max: 40, step: 1)

data/lib/tty-prompt.rb

@@ -1,38 +1,4 @@
 # encoding: utf-8
 
-require 'necromancer'
-require 'pastel'
-require 'tty-cursor'
-
-require 'tty/prompt'
-require 'tty/prompt/choice'
-require 'tty/prompt/choices'
-require 'tty/prompt/enum_list'
-require 'tty/prompt/expander'
-require 'tty/prompt/evaluator'
-require 'tty/prompt/list'
-require 'tty/prompt/multi_list'
-require 'tty/prompt/question'
-require 'tty/prompt/mask_question'
-require 'tty/prompt/confirm_question'
-require 'tty/prompt/reader'
-require 'tty/prompt/slider'
-require 'tty/prompt/statement'
-require 'tty/prompt/suggestion'
-require 'tty/prompt/answers_collector'
-require 'tty/prompt/paginator'
-require 'tty/prompt/enum_paginator'
-require 'tty/prompt/symbols'
-require 'tty/prompt/test'
-require 'tty/prompt/utils'
-require 'tty/prompt/version'
-
-# A collection of small libraries for building CLI apps,
-# each following unix philosophy of focused task
-module TTY
-  class Prompt
-    ConfigurationError = Class.new(StandardError)
-
-    ConversionError = Class.new(StandardError)
-  end
-end # TTY
+require_relative 'tty/prompt'
+require_relative 'tty/test_prompt'

data/lib/tty/prompt.rb

@@ -1,23 +1,46 @@
 # encoding: utf-8
 
 require 'forwardable'
+require 'pastel'
+require 'tty-cursor'
+
+require_relative 'prompt/answers_collector'
+require_relative 'prompt/confirm_question'
+require_relative 'prompt/expander'
+require_relative 'prompt/enum_list'
+require_relative 'prompt/list'
+require_relative 'prompt/multi_list'
+require_relative 'prompt/mask_question'
+require_relative 'prompt/question'
+require_relative 'prompt/reader'
+require_relative 'prompt/slider'
+require_relative 'prompt/statement'
+require_relative 'prompt/suggestion'
+require_relative 'prompt/utils'
+require_relative 'prompt/version'
 
 module TTY
   # A main entry for asking prompt questions.
   class Prompt
     extend Forwardable
 
+    # Raised when wrong parameter is used to configure prompt
+    ConfigurationError = Class.new(StandardError)
+
+    # Raised when type conversion cannot be performed
+    ConversionError = Class.new(StandardError)
+
     # Raised when the passed in validation argument is of wrong type
-    class ValidationCoercion < TypeError; end
+    ValidationCoercion = Class.new(TypeError)
 
     # Raised when the required argument is not supplied
-    class ArgumentRequired < ArgumentError; end
+    ArgumentRequired = Class.new(ArgumentError)
 
     # Raised when the argument validation fails
-    class ArgumentValidation < ArgumentError; end
+    ArgumentValidation = Class.new(ArgumentError)
 
     # Raised when the argument is not expected
-    class InvalidArgument < ArgumentError; end
+    InvalidArgument = Class.new(ArgumentError)
 
     # @api private
     attr_reader :input
@@ -42,7 +65,7 @@ module TTY
     # Theme colors
     #
     # @api private
-    attr_reader :active_color, :help_color, :error_color
+    attr_reader :active_color, :help_color, :error_color, :enabled_color
 
     def_delegators :@pastel, :decorate, :strip
 
@@ -50,7 +73,7 @@ module TTY
                    :show, :hide
 
     def_delegators :@reader, :read_char, :read_line, :read_keypress,
-                   :read_multiline, :on, :subscribe, :publish
+                   :read_multiline, :on, :subscribe, :trigger
 
     def_delegators :@output, :print, :puts, :flush
 
@@ -69,6 +92,7 @@ module TTY
       options = Utils.extract_options!(args)
       @input  = options.fetch(:input) { $stdin }
       @output = options.fetch(:output) { $stdout }
+      @env    = options.fetch(:env) { ENV }
       @prefix = options.fetch(:prefix) { '' }
       @enabled_color = options[:enable_color]
       @active_color  = options.fetch(:active_color) { :green }
@@ -77,7 +101,7 @@ module TTY
 
       @cursor = TTY::Cursor
       @pastel = Pastel.new(@enabled_color.nil? ? {} : { enabled: @enabled_color })
-      @reader = Reader.new(@input, @output, interrupt: options[:interrupt])
+      @reader = Reader.new(@input, @output, interrupt: options[:interrupt], env: @env)
     end
 
     # Ask a question.
@@ -139,7 +163,7 @@ module TTY
     # @api public
     def mask(message, *args, &block)
       options = Utils.extract_options!(args)
-
+      options.merge!({messages: self.class.messages})
       question = MaskQuestion.new(self, options)
       question.call(message, &block)
     end
@@ -452,5 +476,22 @@ module TTY
     def stderr
       $stderr
     end
+
+    # Inspect class name and public attributes
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      attributes = {
+        input: input,
+        output: output,
+        prefix: prefix,
+        active_color: active_color,
+        error_color: error_color,
+        enabled_color: enabled_color,
+        help_color: help_color
+      }
+      "#<#{self.class}: #{attributes.each { |name, val| "@#{name}=#{val}" } }"
+    end
   end # Prompt
 end # TTY

data/lib/tty/prompt/choices.rb

@@ -2,6 +2,8 @@
 
 require 'forwardable'
 
+require_relative 'choice'
+
 module TTY
   class Prompt
     # A class responsible for storing a collection of choices

data/lib/tty/prompt/confirm_question.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+require_relative 'question'
+require_relative 'utils'
+
 module TTY
   class Prompt
     class ConfirmQuestion < Question
@@ -75,7 +78,9 @@ module TTY
           header += @prompt.decorate(label, @active_color)
         end
         @prompt.print(header)
-        @prompt.print("\n") if @done
+        @prompt.puts if @done
+
+        header.lines.count + (@done ? 1 : 0)
       end
 
       protected

data/lib/tty/prompt/converter_dsl.rb

@@ -1,18 +1,21 @@
 # encoding: utf-8
 
-require 'tty/prompt/converter_registry'
+require_relative 'converter_registry'
 
 module TTY
   class Prompt
     module ConverterDSL
-      def self.extended(base)
-        attr_reader :converter_registry
-
-        base.instance_variable_set(:@converter_registry, ConverterRegistry.new)
+      def converter_registry
+        @converter_registry ||= ConverterRegistry.new
       end
 
       def converter(name, &block)
-        converter_registry.register(name, &block)
+        @converter_registry = converter_registry.register(name, &block)
+        self
+      end
+
+      def convert(name, data)
+        @converter_registry[name, data]
       end
     end # ConverterDSL
   end # Prompt