RubyGems - tty-prompt - Versions diffs - 0.18.0 → 0.18.1 - Mend

tty-prompt 0.18.0 → 0.18.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +9 -0
data/README.md +1 -1
data/examples/enum_select.rb +1 -1
data/examples/select.rb +5 -1
data/lib/tty/prompt/choices.rb +2 -1
data/lib/tty/prompt/enum_list.rb +1 -1
data/lib/tty/prompt/list.rb +21 -15
data/lib/tty/prompt/multi_list.rb +10 -10
data/lib/tty/prompt/version.rb +1 -1
data/spec/unit/enum_select_spec.rb +4 -4
data/spec/unit/multi_select_spec.rb +21 -5
data/spec/unit/select_spec.rb +24 -7
metadata +2 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b5dc469236b43c2439a9d62d9356d540c3aa0c3e359916b97fabc2ffe53a1f
-  data.tar.gz: '0229e21607f28ce8407e109d58b26b4d2d782a4f883e5a5580f5db022caa8e0d'
+  metadata.gz: 4993a3639c2dec47c658cddd6a8c3d98b4efb7bec6cc3d1b90dfd184d9b6f889
+  data.tar.gz: d069f2c94118978bbfa04e54c967a0d8ce185adc6d7eb74446988350bca21d06
 SHA512:
-  metadata.gz: a0965a8ec33d8b6a00860e7f15fb6ebb731de62213b4322f732dc8a6c5b41c2da3030082fd3bca1a29e46f141d4233b9db4cbc7ddf9cd5b67632b184d34ca69f
-  data.tar.gz: 8c663d1388d1ec3adfa348e344d74bde55b5d2b61c33db30c877ea363a9e4a78f9723c9e36721912a6987395f93b1d25d4f5222abf0999795bb23bd5b97911f1
+  metadata.gz: c1dd9287d14e3aa2eb8357d9ff759cdec52182535bc9697f97d4da7ab7c111f27ec61bfc176cc16cc7c8f4f2ca1dcd3af4784df1c82e95b0382f4cb2dc7cc782
+  data.tar.gz: 62ed0bc598c3a6b6b65ed7a5f14a7bacd769a5d46dfa041afb67d4d7a4de407e4cb5334fc25942351551414c0c29d68a9fc51aa238e198931677639c3ad4d382

data/CHANGELOG.md CHANGED

@@ -1,5 +1,13 @@
 # Change log
+## [v0.18.1] - 2018-12-29
+### Changed
+* Change #multi_select & #select to auto select first non-disabled active choice
+### Fixed
+* Fix #select, #multi_select & #enum_select to allow for symbols as choice names
 ## [v0.18.0] - 2018-11-24
 ### Changed
@@ -296,6 +304,7 @@
 * Initial implementation and release
+[v0.18.1]: http://github.com/piotrmurach/tty-prompt/compare/v0.18.0...v0.18.1
 [v0.18.0]: http://github.com/piotrmurach/tty-prompt/compare/v0.17.2...v0.18.0
 [v0.17.2]: http://github.com/piotrmurach/tty-prompt/compare/v0.17.1...v0.17.2
 [v0.17.1]: http://github.com/piotrmurach/tty-prompt/compare/v0.17.0...v0.17.1

data/README.md CHANGED

@@ -1344,7 +1344,7 @@ Please [see pastel](http://github.com/piotrmurach/pastel#3-supported-colors) fo
 If you wish to disable coloring for a prompt simply pass `:enable_color` option
-```
+```ruby
 prompt = TTY::Prompt.new(enable_color: true)
 ```

data/examples/enum_select.rb CHANGED

@@ -3,5 +3,5 @@
 require_relative "../lib/tty-prompt"
 prompt = TTY::Prompt.new
-choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+choices = %i(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
 prompt.enum_select('Select an editor', choices, default: 2)

data/examples/select.rb CHANGED

@@ -4,7 +4,7 @@ require_relative "../lib/tty-prompt"
 prompt = TTY::Prompt.new
-warriors = %w(Scorpion Kano Jax Kitana Raiden)
+warriors = %i(Scorpion Kano Jax Kitana Raiden)
 prompt.on(:keypress) do |event|
   if event.value == 'j'
@@ -15,6 +15,10 @@ prompt.on(:keypress) do |event|
   end
 end
+prompt.on(:keyescape) do |event|
+  exit(1)
+end
 answer = prompt.select('Choose your destiny?', warriors)
 puts answer.inspect

data/lib/tty/prompt/choices.rb CHANGED

@@ -20,7 +20,8 @@ module TTY
       # @api public
       attr_reader :choices
-      def_delegators :choices, :length, :size, :to_ary, :empty?, :values_at
+      def_delegators :choices, :length, :size, :to_ary, :empty?,
+                               :values_at, :index
       # Convenience for creating choices
       #

data/lib/tty/prompt/enum_list.rb CHANGED

@@ -359,7 +359,7 @@ module TTY
         @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
           num = (index + 1).to_s + @enum + ' '
-          selected = num + choice.name
+          selected = num.to_s + choice.name.to_s
           output << if index + 1 == @active && !choice.disabled?
                       (' ' * 2) + @prompt.decorate(selected, @active_color)
                     elsif choice.disabled?

data/lib/tty/prompt/list.rb CHANGED

@@ -15,12 +15,12 @@ module TTY
     class List
       include Symbols
-      HELP = '(Use arrow%s keys, press Enter to select%s)'.freeze
+      HELP = '(Use arrow%s keys, press Enter to select%s)'
-      PAGE_HELP = '(Move up or down to reveal more choices)'.freeze
+      PAGE_HELP = '(Move up or down to reveal more choices)'
       # Allowed keys for filter, along with backspace and canc.
-      FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/
+      FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/.freeze
       # Create instance of TTY::Prompt::List menu.
       #
@@ -42,8 +42,7 @@ module TTY
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @enum         = options.fetch(:enum) { nil }
-        @default      = Array[options.fetch(:default) { 1 }]
-        @active       = @default.first
+        @default      = Array(options[:default])
         @choices      = Choices.new
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
@@ -122,7 +121,7 @@ module TTY
         tokens = if enumerate?
                    [" or number (1-#{choices.size})", '']
                  elsif filterable?
-                   ['', ", and letter keys to filter"]
+                   ['', ', and letter keys to filter']
                  else
                    ['', '']
                  end
@@ -160,9 +159,9 @@ module TTY
           if !filterable? || @filter.empty?
             @choices
           else
-            @choices.select do |_choice|
-              !_choice.disabled? &&
-                _choice.name.downcase.include?(@filter.join.downcase)
+            @choices.select do |choice|
+              !choice.disabled? &&
+                choice.name.downcase.include?(@filter.join.downcase)
             end
           end
         else
@@ -195,6 +194,7 @@ module TTY
       def keynum(event)
         return unless enumerate?
         value = event.value.to_i
         return unless (1..choices.count).cover?(value)
         return if choices[value - 1].disabled?
@@ -218,7 +218,7 @@ module TTY
         if prev_active
           @active = prev_active
         elsif @cycle
-          searchable  = (choices.length).downto(1).to_a
+          searchable  = choices.length.downto(1).to_a
           prev_active = search_choice_in(searchable)
           @active = prev_active if prev_active
@@ -277,7 +277,12 @@ module TTY
       # @api private
       def setup_defaults
         validate_defaults
-        @active = @default.first
+        if !@default.empty?
+          @active = @default.first
+        else
+          @active = @choices.index { |choice| !choice.disabled? } + 1
+        end
       end
       # Validate default indexes to be within range
@@ -398,7 +403,7 @@ module TTY
       def render_header
         if @done
           selected_item = choices[@active - 1].name
-          @prompt.decorate(selected_item, @active_color)
+          @prompt.decorate(selected_item.to_s, @active_color)
         elsif @first_render
           @prompt.decorate(help, @help_color)
         elsif filterable? && @filter.any?
@@ -417,13 +422,13 @@ module TTY
         @paginator.paginate(choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
           message = if index + 1 == @active && !choice.disabled?
-                      selected = @marker + ' ' + num + choice.name
+                      selected = "#{@marker} #{num}#{choice.name}"
                       @prompt.decorate(selected.to_s, @active_color)
                     elsif choice.disabled?
                       @prompt.decorate(symbols[:cross], :red) +
-                        ' ' + num + choice.name + ' ' + choice.disabled.to_s
+                        " #{num}#{choice.name} #{choice.disabled}"
                     else
-                      ' ' * 2 + num + choice.name
+                      "  #{num}#{choice.name}"
                     end
           max_index = paginated? ? @paginator.max_index : choices.size - 1
           newline = (index == max_index) ? '' : "\n"
@@ -440,6 +445,7 @@ module TTY
       # @api private
       def render_footer
         return '' unless paginated?
         colored_footer = @prompt.decorate(@page_help, @help_color)
         "\n" + colored_footer
       end

data/lib/tty/prompt/multi_list.rb CHANGED

@@ -9,7 +9,7 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'.freeze
+      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'
       # Create instance of TTY::Prompt::MultiList menu.
       #
@@ -20,8 +20,7 @@ module TTY
       def initialize(prompt, options)
         super
         @selected = []
-        @help    = options[:help]
-        @default = Array(options[:default])
+        @help = options[:help]
         @echo = options.fetch(:echo, true)
       end
@@ -46,10 +45,11 @@ module TTY
         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?
-        if choices[@active - 1] && choices[@active - 1].disabled?
-          raise ConfigurationError,
-                "active choice '#{choices[@active - 1]}' matches disabled item"
+        if !@default.empty?
+          @active = @default.last
+        else
+          @active = @choices.index { |choice| !choice.disabled? } + 1
         end
       end
@@ -102,12 +102,12 @@ module TTY
           indicator += ' '
           message = if @selected.include?(choice) && !choice.disabled?
                       selected = @prompt.decorate(symbols[:radio_on], @active_color)
-                      selected + ' ' + num + choice.name
+                      "#{selected} #{num}#{choice.name}"
                     elsif choice.disabled?
                       @prompt.decorate(symbols[:cross], :red) +
-                        ' ' + num + choice.name + ' ' + choice.disabled.to_s
+                        " #{num}#{choice.name} #{choice.disabled}"
                     else
-                      symbols[:radio_off] + ' ' + num + choice.name
+                      "#{symbols[:radio_off]} #{num}#{choice.name}"
                     end
           max_index = paginated? ? @paginator.max_index : choices.size - 1
           newline = (index == max_index) ? '' : "\n"

data/lib/tty/prompt/version.rb CHANGED

@@ -2,6 +2,6 @@
 module TTY
   class Prompt
-    VERSION = '0.18.0'
+    VERSION = '0.18.1'
   end # Prompt
 end # TTY

data/spec/unit/enum_select_spec.rb CHANGED

@@ -193,17 +193,17 @@ RSpec.describe TTY::Prompt do
   end
   it "doesn't paginate short selections" do
-    choices = %w(A B C D)
+    choices = %i(A B C D)
     prompt = TTY::TestPrompt.new
     prompt.input << "\r"
     prompt.input.rewind
     answer = prompt.enum_select("What letter?", choices, per_page: 4, default: 1)
-    expect(answer).to eq('A')
+    expect(answer).to eq(:A)
     expected_output =
-      output_helper("What letter?", choices, "A") +
-      exit_message("What letter?", "A")
+      output_helper("What letter?", choices, :A) +
+      exit_message("What letter?", :A)
     expect(prompt.output.string).to eq(expected_output)
   end

data/spec/unit/multi_select_spec.rb CHANGED

@@ -45,7 +45,7 @@ RSpec.describe TTY::Prompt do
   it "selects nothing when return pressed immediately" do
     prompt = TTY::TestPrompt.new
-    choices = %w(vodka beer wine whisky bourbon)
+    choices = %i(vodka beer wine whisky bourbon)
     prompt.input << "\r"
     prompt.input.rewind
     expect(prompt.multi_select("Select drinks?", choices)). to eq([])
@@ -425,13 +425,29 @@ RSpec.describe TTY::Prompt do
   end
   context "with :disabled" do
-    it "fails when active item is also disabled" do
+    it "fails when default item is also disabled" do
       prompt = TTY::TestPrompt.new
-      choices = [{name: 'vodka', disabled: true}, 'beer', 'wine', 'whisky', 'bourbon']
+      choices = [
+        {name: 'vodka', disabled: true},
+        'beer', 'wine', 'whisky', 'bourbon'
+      ]
       expect {
-        prompt.multi_select("Select drinks?", choices)
+        prompt.multi_select("Select drinks?", choices, default: 1)
       }.to raise_error(TTY::Prompt::ConfigurationError,
-        /active choice 'vodka' matches disabled item/)
+        /default index `1` matches disabled choice item/)
+    end
+    it "adjusts active index to match first non-disabled choice" do
+      choices = [
+        {name: 'vodka', disabled: true},
+        'beer', 'wine', 'whisky', 'bourbon'
+      ]
+      prompt = TTY::TestPrompt.new
+      prompt.input << " " << "\r"
+      prompt.input.rewind
+      answer = prompt.multi_select("Select drinks?", choices)
+      expect(answer).to eq(['beer'])
     end
     it "omits disabled choice when nagivating menu" do

data/spec/unit/select_spec.rb CHANGED

@@ -43,11 +43,12 @@ RSpec.describe TTY::Prompt, '#select' do
   before { allow(TTY::Screen).to receive(:width).and_return(200) }
   it "selects by default first option" do
-    choices = %w(Large Medium Small)
+    choices = %i(Large Medium Small)
     prompt.input << "\r"
     prompt.input.rewind
-    expect(prompt.select('What size?', choices)).to eq('Large')
-    expect(prompt.output.string).to eq([
+    expect(prompt.select('What size?', choices)).to eq(:Large)
+    expected_output = [
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
       "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
@@ -55,7 +56,9 @@ RSpec.describe TTY::Prompt, '#select' do
       "\e[2K\e[1G\e[1A" * 3,
       "\e[2K\e[1G",
       "What size? \e[32mLarge\e[0m\n\e[?25h"
-    ].join)
+    ].join
+    expect(prompt.output.string).to eq(expected_output)
   end
   it "allows navigation using events without errors" do
@@ -629,14 +632,28 @@ RSpec.describe TTY::Prompt, '#select' do
       expect(prompt.output.string).to eq(expected_output)
     end
-    it "sets default correct when disabled choice" do
-      choices = [ {name: 'Small', disabled: '(out of stock)'}, 'Medium', 'Large', 'Huge' ]
+    it "sets active to be first non-disabled choice" do
+      choices = [
+        {name: 'Small', disabled: '(out of stock)'}, 'Medium', 'Large', 'Huge'
+      ]
+      prompt = TTY::TestPrompt.new
+      prompt.input << "\r"
+      prompt.input.rewind
+      answer = prompt.select("What size?", choices)
+      expect(answer).to eq('Medium')
+    end
+    it "prevents setting default to disabled choice" do
+      choices = [
+        {name: 'Small', disabled: '(out of stock)'}, 'Medium', 'Large', 'Huge'
+      ]
       prompt = TTY::TestPrompt.new
       prompt.input << "\r"
       prompt.input.rewind
       expect {
-        prompt.select("What size?", choices)
+        prompt.select("What size?", choices, default: 1)
       }.to raise_error(TTY::Prompt::ConfigurationError, /default index `1` matches disabled choice item/)
     end
   end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2018-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer