tty-prompt 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 914b91c8d5090e18ffa6da38c4e4ba7f26a7f50a
-  data.tar.gz: 0dea47a0af899dc93a532fc4371710807e8ef472
+  metadata.gz: 90f71ba30290379f0e69eb5ff8affb0276d15507
+  data.tar.gz: c16aecac4d1203614dacf82287c2ec7f6f4e8ffd
 SHA512:
-  metadata.gz: 9476326073c28e1c92c8b1a48fe66ce4769589ad44a15758ac376512a20f77065a5f78dc51a4b2c897f7825cf9d325d0c285700961c4a7f942c7a2bd8351bde8
-  data.tar.gz: 7206776eb52eb9451641be93db1de554bbbf94cdab014d8f5f21a4f46aa52acbd4cb50745806b6eb078f88eb863b97645483833d2df441cbb995245a64901912
+  metadata.gz: bfc62f62785695cf6efa2987acce5bbba00dcfcfe05c33a7641517178017f5a12ec1b600a20e650cf133babea6f6cfe2de8e926f5f9c55d7213b8fb0b0e87d05
+  data.tar.gz: c1e1333370fb6bed3d61fc684788be691698598399358ea5d7354954d9e05604a62871affa17c202e94d6d51d2afe2923f698661d2fb1496b1b06ab966c9f916

data/.gitignore

@@ -1,4 +1,6 @@
 /.bundle/
+/.ruby-version
+/.ruby-gemset
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [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
@@ -236,6 +245,8 @@
 
 * Initial implementation and release
 
+[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

data/README.md

@@ -76,6 +76,7 @@ Or install it yourself as:
     * [2.6.1 select](#261-select)
     * [2.6.2 multi_select](#262-multi_select)
     * [2.6.2.1 echo](#2621-echo)
+    * [2.6.2.2 filter](#2622-filter)
     * [2.6.3 enum_select](#263-enum_select)
   * [2.7 expand](#27-expand)
   * [2.8 collect](#28-collect)
@@ -778,6 +779,36 @@ prompt.multi_select("Select drinks?", choices, echo: false)
 # ‣ ⬢ 5) bourbon
 ```
 
+### 2.6.2.2 filter
+
+To activate dynamic list filtering on letter/number typing, use the :filter option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, filter: true)
+# =>
+# Select drinks? (Use arrow keys, press Space to select and Enter to finish, and letter keys to filter)
+# ‣ ⬡ vodka
+#   ⬡ beer
+#   ⬡ wine
+#   ⬡ whisky
+#   ⬡ bourbon
+```
+
+After the user presses "w":
+
+```
+# Select drinks? (Filter: "w")
+# ‣ ⬡ wine
+#   ⬡ whisky
+```
+
+Filter characters can be deleted partially or entirely via, respectively, Backspace and Canc.
+
+If the user changes or deletes a filter, the choices previously selected remain selected.
+
+The `filter` option is not compatible with `enum`.
+
 ### 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:
@@ -938,6 +969,33 @@ end
 # {:name => "Piotr", :age => 30, :address => {:street => "Street", :city => "City", :zip => "123"}}
 ```
 
+In order to collect _mutliple values_ for a given key in a loop, chain `values` onto the `key` desired:
+
+```rb
+result = prompt.collect do
+  key(:name).ask('Name?')
+
+  key(:age).ask('Age?', convert: :int)
+
+  while prompt.yes?("continue?")
+    key(:addresses).values do
+      key(:street).ask('Street?', required: true)
+      key(:city).ask('City?')
+      key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+    end
+  end
+end
+# =>
+# {
+#   :name => "Piotr",
+#   :age => 30,
+#   :addresses => [
+#     {:street => "Street", :city => "City", :zip => "123"},
+#     {:street => "Street", :city => "City", :zip => "234"}
+#   ]
+# }
+```
+
 ### 2.9 suggest
 
 To suggest possible matches for the user input use `suggest` method like so:

data/examples/select_filtered.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new
+
+warriors = %w(Scorpion Kano Jax Kitana Raiden)
+
+prompt.select('Choose your destiny?', warriors, filter: true)

data/lib/tty/prompt/answers_collector.rb

@@ -31,7 +31,22 @@ module TTY
       def key(name, &block)
         @name = name
         if block
-          answer = create_collector.(&block)
+          answer = create_collector.call(&block)
+          add_answer(answer)
+        end
+        self
+      end
+
+      # Change to collect all values for a key
+      #
+      # @example
+      #   key(:colors).values.ask('Color?')
+      #
+      # @api public
+      def values(&block)
+        @answers[@name] = Array(@answers[@name])
+        if block
+          answer = create_collector.call(&block)
           add_answer(answer)
         end
         self
@@ -44,7 +59,11 @@ module TTY
 
       # @api public
       def add_answer(answer)
-        @answers[@name] = answer
+        if @answers[@name].is_a?(Array)
+          @answers[@name] << answer
+        else
+          @answers[@name] = answer
+        end
       end
 
       private

data/lib/tty/prompt/list.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require "English"
+
 require_relative 'choices'
 require_relative 'paginator'
 require_relative 'symbols'
@@ -13,10 +15,13 @@ module TTY
     class List
       include Symbols
 
-      HELP = '(Use arrow%s keys, press Enter to select)'
+      HELP = '(Use arrow%s keys, press Enter to select%s)'
 
       PAGE_HELP = '(Move up or down to reveal more choices)'
 
+      # Allowed keys for filter, along with backspace and canc.
+      FILTER_KEYS_MATCHER = /\A\w\Z/
+
       # Create instance of TTY::Prompt::List menu.
       #
       # @param Hash options
@@ -32,6 +37,8 @@ module TTY
       #
       # @api public
       def initialize(prompt, options = {})
+        check_options_consistency(options)
+
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @enum         = options.fetch(:enum) { nil }
@@ -42,6 +49,7 @@ 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
         @help         = options[:help]
         @first_render = true
         @done         = false
@@ -83,7 +91,7 @@ module TTY
       #
       # @api private
       def paginated?
-        @choices.size > page_size
+        choices.size > page_size
       end
 
       # @param [String] text
@@ -111,7 +119,16 @@ module TTY
       #
       # @api public
       def default_help
-        self.class::HELP % [enumerate? ? " or number (1-#{@choices.size})" : '']
+        # Note that enumeration and filter are mutually exclusive
+        tokens = if enumerate?
+                   [" or number (1-#{choices.size})", ""]
+                 elsif @filter
+                   ["", ", and letter keys to filter"]
+                 else
+                   ["", ""]
+                 end
+
+        format(self.class::HELP, *tokens)
       end
 
       # Set selecting active index using number pad
@@ -132,14 +149,25 @@ module TTY
         end
       end
 
-      # Add multiple choices
+      # Add multiple choices, or return them.
       #
       # @param [Array[Object]] values
-      #   the values to add as choices
+      #   the values to add as choices; if not passed, the current
+      #   choices are displayed.
       #
       # @api public
-      def choices(values)
-        Array(values).each { |val| choice(*val) }
+      def choices(values = (not_set = true))
+        if not_set
+          if @filter.to_s.empty?
+            @choices
+          else
+            @choices.select do |_choice|
+              _choice.name.downcase.include?(@filter.downcase)
+            end
+          end
+        else
+          Array(values).each { |val| choice(*val) }
+        end
       end
 
       # Call the list menu by passing question and choices
@@ -166,26 +194,26 @@ module TTY
       def keynum(event)
         return unless enumerate?
         value = event.value.to_i
-        return unless (1..@choices.count).cover?(value)
+        return unless (1..choices.count).cover?(value)
         @active = value
       end
 
       def keyenter(*)
-        @done = true
+        @done = true unless choices.empty?
       end
       alias keyreturn keyenter
       alias keyspace keyenter
 
       def keyup(*)
         if @active == 1
-          @active = @choices.length if @cycle
+          @active = choices.length if @cycle
         else
           @active -= 1
         end
       end
 
       def keydown(*)
-        if @active == @choices.length
+        if @active == choices.length
           @active = 1 if @cycle
         else
           @active += 1
@@ -193,8 +221,38 @@ module TTY
       end
       alias keytab keydown
 
+      def keypress(event)
+        return unless @filter
+
+        if event.value =~ FILTER_KEYS_MATCHER
+          @filter += event.value
+          @active = 1
+        end
+      end
+
+      def keydelete(*)
+        return unless @filter
+
+        @filter = ""
+        @active = 1
+      end
+
+      def keybackspace(*)
+        return unless @filter
+
+        @filter.slice!(-1)
+        @active = 1
+      end
+
       private
 
+      def check_options_consistency(options)
+        if options.key?(:enum) && options.key?(:filter)
+          raise ConfigurationError,
+                "Enumeration can't be used with filter"
+        end
+      end
+
       # Setup default option and active selection
       #
       # @api private
@@ -210,11 +268,11 @@ module TTY
         @default.each do |d|
           if d.nil? || d.to_s.empty?
             raise ConfigurationError,
-                 "default index must be an integer in range (1 - #{@choices.size})"
+                 "default index must be an integer in range (1 - #{choices.size})"
           end
-          if d < 1 || d > @choices.size
+          if d < 1 || d > choices.size
             raise ConfigurationError,
-                 "default index `#{d}` out of range (1 - #{@choices.size})"
+                 "default index `#{d}` out of range (1 - #{choices.size})"
           end
         end
       end
@@ -233,7 +291,12 @@ module TTY
           question = render_question
           @prompt.print(question)
           @prompt.read_keypress
-          @prompt.print(refresh(question.lines.count))
+
+          # Split manually; if the second line is blank (when there are no
+          # matching lines), it won't be included by using String#lines.
+          question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
+
+          @prompt.print(refresh(question_lines.count))
         end
         @prompt.print(render_question)
         answer
@@ -247,7 +310,7 @@ module TTY
       #
       # @api private
       def answer
-        @choices[@active - 1].value
+        choices[@active - 1].value
       end
 
       # Clear screen lines
@@ -273,6 +336,15 @@ module TTY
         header
       end
 
+      # Header part showing the current filter
+      #
+      # @return String
+      #
+      # @api private
+      def filter_help
+        "(Filter: #{@filter.inspect})"
+      end
+
       # Render initial help and selected choice
       #
       # @return [String]
@@ -280,10 +352,12 @@ module TTY
       # @api private
       def render_header
         if @done
-          selected_item = "#{@choices[@active - 1].name}"
+          selected_item = "#{choices[@active - 1].name}"
           @prompt.decorate(selected_item, @active_color)
         elsif @first_render
           @prompt.decorate(help, @help_color)
+        elsif @filter.to_s != ""
+          @prompt.decorate(filter_help, @help_color)
         end
       end
 
@@ -294,7 +368,8 @@ module TTY
       # @api private
       def render_menu
         output = ''
-        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
+
+        @paginator.paginate(choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
           message = if index + 1 == @active
                       selected = @marker + ' ' + num + choice.name
@@ -302,10 +377,11 @@ module TTY
                     else
                       ' ' * 2 + num + choice.name
                     end
-          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          max_index = paginated? ? @paginator.max_index : choices.size - 1
           newline = (index == max_index) ? '' : "\n"
           output << (message + newline)
         end
+
         output
       end
 

data/lib/tty/prompt/multi_list.rb

@@ -9,7 +9,7 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use arrow%s keys, press Space to select and Enter to finish)'.freeze
+      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'.freeze
 
       # Create instance of TTY::Prompt::MultiList menu.
       #
@@ -29,7 +29,7 @@ module TTY
       #
       # @api private
       def keyspace(*)
-        active_choice = @choices[@active - 1]
+        active_choice = choices[@active - 1]
         if @selected.include?(active_choice)
           @selected.delete(active_choice)
         else
@@ -44,6 +44,7 @@ module TTY
       # @api private
       def setup_defaults
         validate_defaults
+        # At this stage, @choices matches all the visible choices.
         @selected = @choices.values_at(*@default.map { |d| d - 1 })
         @active = @default.last unless @selected.empty?
       end
@@ -65,9 +66,12 @@ module TTY
         if @done && @echo
           @prompt.decorate(selected_names, @active_color)
         elsif @selected.size.nonzero? && @echo
-          selected_names + (@first_render ? " #{instructions}" : '')
+          help_suffix = @filter.to_s != "" ? " #{filter_help}" : ""
+          selected_names + (@first_render ? " #{instructions}" : help_suffix)
         elsif @first_render
           instructions
+        elsif @filter.to_s != ""
+          filter_help
         end
       end
 
@@ -87,7 +91,7 @@ module TTY
       # @api private
       def render_menu
         output = ''
-        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
+        @paginator.paginate(choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
           indicator = (index + 1 == @active) ?  @marker : ' '
           indicator += ' '
@@ -97,7 +101,7 @@ module TTY
                     else
                       symbols[:radio_off] + ' ' + num + choice.name
                     end
-          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          max_index = paginated? ? @paginator.max_index : choices.size - 1
           newline = (index == max_index) ? '' : "\n"
           output << indicator + message + newline
         end

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = '0.14.0'.freeze
+    VERSION = '0.15.0'.freeze
   end # Prompt
 end # TTY

data/tty-prompt.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'necromancer',  '~> 0.4.0'
   spec.add_dependency 'pastel',       '~> 0.7.0'
-  spec.add_dependency 'timers',       '~> 4.1.2'
+  spec.add_dependency 'timers',       '~> 4.0'
   spec.add_dependency 'tty-cursor',   '~> 0.5.0'
   spec.add_dependency 'tty-reader',   '~> 0.2.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,7 @@ files:
 - examples/multiline.rb
 - examples/pause.rb
 - examples/select.rb
+- examples/select_filtered.rb
 - examples/select_paginated.rb
 - examples/slider.rb
 - examples/validation.rb