tty-prompt 0.18.1 → 0.19.0

data/lib/tty/prompt/version.rb

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

data/spec/spec_helper.rb

@@ -4,10 +4,10 @@ if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'
@@ -17,7 +17,23 @@ end
 
 require 'tty-prompt'
 
+class StringIO
+  def wait_readable(*)
+    true
+  end
+end
+
+module Helpers
+  def diff_output(actual_output, expected_output)
+    puts "ACTUAL: #{actual_output.inspect}"
+    puts "--------------------------------\n"
+    puts "EXPECT: #{expected_output.inspect}"
+  end
+end
+
 RSpec.configure do |config|
+  config.include(Helpers)
+
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

data/spec/unit/ask_spec.rb

@@ -14,16 +14,57 @@ RSpec.describe TTY::Prompt, '#ask' do
   end
 
   it 'asks an empty question ' do
-    prompt.ask('')
-    expect(prompt.output.string).to eql('')
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\r"
+    prompt.input.rewind
+
+    answer = prompt.ask
+    expect(answer).to eq(nil)
+
+    expect(prompt.output.string).to eql("\e[2K\e[1G\n\e[1A\e[2K\e[1G\n")
   end
 
-  it 'asks an empty question and returns nil if EOF is sent to stdin' do
+  it "asks an empty question and returns nil if EOF is sent to stdin" do
+    prompt = TTY::TestPrompt.new
     prompt.input << nil
     prompt.input.rewind
+
     answer = prompt.ask('')
+
     expect(answer).to eql(nil)
-    expect(prompt.output.string).to eq('')
+    expect(prompt.output.string).to eq("\e[1A\e[2K\e[1G\n")
+  end
+
+  it "asks an empty question with prepopulated value" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    answer = prompt.ask value: "yes"
+
+    expect(answer).to eq("yes")
+    expect(prompt.output.string).to eq([
+      "yes\e[2K\e[1G",
+      "yes\n\e[1A\e[2K\e[1G",
+      "\e[32myes\e[0m\n"
+    ].join)
+  end
+
+  it "asks question with prepopulated value" do
+    prompt = TTY::TestPrompt.new prefix: "> "
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    answer = prompt.ask("Say?") do |q|
+      q.value "yes"
+    end
+
+    expect(answer).to eq("yes")
+    expect(prompt.output.string).to eq([
+      "> Say? yes\e[2K\e[1G",
+      "> Say? yes\n\e[1A\e[2K\e[1G",
+      "> Say? \e[32myes\e[0m\n"
+    ].join)
   end
 
   it "asks a question with a prefix [?]" do

data/spec/unit/{enum_paginator_spec.rb → block_paginator_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe TTY::Prompt::EnumPaginator, '#paginate' do
+RSpec.describe TTY::Prompt::BlockPaginator, '#paginate' do
   it "ignores per_page when equal items " do
     list = %w(a b c d)
     paginator = described_class.new({per_page: 4})
@@ -44,16 +44,25 @@ RSpec.describe TTY::Prompt::EnumPaginator, '#paginate' do
     expect(paginator.paginate(list, 8).to_a).to eq([['g',6]])
   end
 
-  it "finds maximum index for current selection" do
+  it "finds both start and end index for current selection" do
     list = %w(a b c d e f g)
     paginator = described_class.new({per_page: 3, default: 0})
 
+    paginator.paginate(list, 3)
+    expect(paginator.start_index).to eq(0)
+    expect(paginator.end_index).to eq(2)
+
     paginator.paginate(list, 4)
-    expect(paginator.max_index).to eq(5)
+    expect(paginator.start_index).to eq(3)
+    expect(paginator.end_index).to eq(5)
+
     paginator.paginate(list, 5)
-    expect(paginator.max_index).to eq(5)
+    expect(paginator.start_index).to eq(3)
+    expect(paginator.end_index).to eq(5)
+
     paginator.paginate(list, 7)
-    expect(paginator.max_index).to eq(8)
+    expect(paginator.start_index).to eq(6)
+    expect(paginator.end_index).to eq(6)
   end
 
   it "starts with default selection" do

data/spec/unit/choice/from_spec.rb

@@ -93,4 +93,20 @@ RSpec.describe TTY::Prompt::Choice, '#from' do
     expect(choice.value).to eq(:none)
     expect(choice.disabled?).to eq(true)
   end
+
+  it "creates choice from an arbitrary object that responds to to_s call" do
+    stub_const("Size", Class.new do
+      def to_s
+        'large'
+      end
+    end)
+    size = Size.new
+    expected_choice = described_class.new(size, size)
+    choice = described_class.from(size)
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq(size)
+    expect(choice.value).to eq(size)
+    expect(choice.disabled?).to eq(false)
+  end
 end

data/spec/unit/enum_select_spec.rb

@@ -60,9 +60,10 @@ RSpec.describe TTY::Prompt do
     answer = prompt.enum_select("Select an editor?", choices)
     expect(answer).to eq('/bin/nano')
 
-    expected_output =
-      output_helper("Select an editor?", choices, "/bin/nano") +
+    expected_output = [
+      output_helper("Select an editor?", choices, "/bin/nano"),
       exit_message("Select an editor?", "/bin/nano")
+    ].join
 
     expect(prompt.output.string).to eq(expected_output)
   end
@@ -76,10 +77,11 @@ RSpec.describe TTY::Prompt do
     answer = prompt.enum_select("Select an editor?", choices, default: 2)
     expect(answer).to eq('/usr/bin/vim.tiny')
 
-    expected_output =
-      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", default: 2) +
-      output_helper("Select an editor?", choices, "/usr/bin/vim.tiny", default: 2, input: '3') +
+    expected_output = [
+      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", default: 2),
+      output_helper("Select an editor?", choices, "/usr/bin/vim.tiny", default: 2, input: '3'),
       exit_message("Select an editor?", "/usr/bin/vim.tiny")
+    ].join
 
     expect(prompt.output.string).to eq(expected_output)
   end
@@ -99,10 +101,11 @@ RSpec.describe TTY::Prompt do
     end
     expect(answer).to eq('/bin/nano')
 
-    expected_output =
-      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", default: 2, enum: '.') +
-      output_helper("Select an editor?", choices, "/bin/nano", default: 2, enum: '.', input: 1) +
+    expected_output = [
+      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", default: 2, enum: '.'),
+      output_helper("Select an editor?", choices, "/bin/nano", default: 2, enum: '.', input: 1),
       exit_message("Select an editor?", "/bin/nano")
+    ].join
 
     expect(prompt.output.string).to eq(expected_output)
   end
@@ -123,9 +126,10 @@ RSpec.describe TTY::Prompt do
 
     expect(answer).to eq('/usr/bin/vim')
 
-    expected_output =
-      output_helper("Select an editor?", choices, "vim", default: 2) +
+    expected_output = [
+      output_helper("Select an editor?", choices, "vim", default: 2),
       exit_message("Select an editor?", "vim")
+    ].join
 
     expect(prompt.output.string).to eq(expected_output)
   end
@@ -136,8 +140,12 @@ RSpec.describe TTY::Prompt do
     prompt.input << "\n"
     prompt.input.rewind
     options = {active_color: :red, help_color: :blue, error_color: :green}
-    expect(prompt.enum_select("Select an editor?", choices, options)).to eq('/bin/nano')
-    expect(prompt.output.string).to eq([
+
+    answer = prompt.enum_select("Select an editor?", choices, options)
+
+    expect(answer).to eq('/bin/nano')
+
+    expected_output = [
       "Select an editor? \n",
       "  \e[31m1) /bin/nano\e[0m\n",
       "  2) /usr/bin/vim.basic\n",
@@ -146,7 +154,56 @@ RSpec.describe TTY::Prompt do
       "\e[2K\e[1G\e[1A" * 4,
       "\e[2K\e[1G\e[J",
       "Select an editor? \e[31m/bin/nano\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
+  end
+
+  it "changes global symbols" do
+    prompt = TTY::TestPrompt.new(symbols: {cross: 'x'})
+    choices = ['A', {name: 'B', disabled: '(out)'}, 'C']
+    prompt.input << "\n"
+    prompt.input.rewind
+    answer = prompt.enum_select("What letter?", choices)
+    expect(answer).to eq("A")
+
+    expected_output = [
+      "What letter? \n",
+      "  \e[32m1) A\e[0m\n",
+      "\e[31mx\e[0m 2) B (out)\n",
+      "  3) C\n",
+      "  Choose 1-3 [1]: ",
+      "\e[2K\e[1G\e[1A" * 4,
+      "\e[2K\e[1G\e[J",
+      "What letter? \e[32mA\e[0m\n",
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
+  end
+
+  it "changes global symbols through DSL" do
+    prompt = TTY::TestPrompt.new
+    choices = ['A', {name: 'B', disabled: '(out)'}, 'C']
+    prompt.input << "\n"
+    prompt.input.rewind
+    answer = prompt.enum_select("What letter?", choices) do |menu|
+               menu.symbols cross: 'x'
+               menu.choices choices
+             end
+    expect(answer).to eq("A")
+
+    expected_output = [
+      "What letter? \n",
+      "  \e[32m1) A\e[0m\n",
+      "\e[31mx\e[0m 2) B (out)\n",
+      "  3) C\n",
+      "  Choose 1-3 [1]: ",
+      "\e[2K\e[1G\e[1A" * 4,
+      "\e[2K\e[1G\e[J",
+      "What letter? \e[32mA\e[0m\n",
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "displays error with unrecognized input" do
@@ -158,13 +215,14 @@ RSpec.describe TTY::Prompt do
     answer = prompt.enum_select("Select an editor?", choices)
     expect(answer).to eq('/usr/bin/vim.basic')
 
-    expected_output =
-      output_helper("Select an editor?", choices, "/bin/nano") +
-      output_helper("Select an editor?", choices, "/bin/nano", input: '1') +
-      output_helper("Select an editor?", choices, "/bin/nano", input: '11') +
-      output_helper("Select an editor?", choices, "/bin/nano", error: 'Please enter a valid number', input: '') +
-      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", error: 'Please enter a valid number', input: '2') +
+    expected_output = [
+      output_helper("Select an editor?", choices, "/bin/nano"),
+      output_helper("Select an editor?", choices, "/bin/nano", input: '1'),
+      output_helper("Select an editor?", choices, "/bin/nano", input: '11'),
+      output_helper("Select an editor?", choices, "/bin/nano", error: 'Please enter a valid number', input: ''),
+      output_helper("Select an editor?", choices, "/usr/bin/vim.basic", error: 'Please enter a valid number', input: '2'),
       exit_message("Select an editor?", "/usr/bin/vim.basic")
+    ].join
 
     expect(prompt.output.string).to eq(expected_output)
   end
@@ -354,6 +412,7 @@ RSpec.describe TTY::Prompt do
               menu.choices choices
             end
     expect(value).to eq("A")
+
     expect(prompt.output.string).to eq([
       "What letter? \n",
       "  \e[32m1) A\e[0m\n",
@@ -391,11 +450,22 @@ RSpec.describe TTY::Prompt do
       prompt = TTY::TestPrompt.new
       choices = [{name: 'A', disabled: true}, 'B', 'C', 'D', 'E']
       expect {
-        prompt.enum_select("What letter?", choices)
+        prompt.enum_select("What letter?", choices, default: 1)
       }.to raise_error(TTY::Prompt::ConfigurationError,
         /default index 1 matches disabled choice item/)
     end
 
+    it "finds first non-disabled index" do
+      prompt = TTY::TestPrompt.new
+      choices = [{name: 'A', disabled: true}, {name:'B', disabled: true}, 'C', 'D']
+      prompt = TTY::TestPrompt.new
+      prompt.input << "\n"
+      prompt.input.rewind
+
+      answer = prompt.enum_select("What letter?", choices)
+      expect(answer).to eq('C')
+    end
+
     it "doesn't allow to choose disabled choice and defaults" do
       choices = ['A', {name: 'B', disabled: '(out)'}, 'C', 'D', 'E', 'F']
       prompt = TTY::TestPrompt.new
@@ -405,12 +475,13 @@ RSpec.describe TTY::Prompt do
       answer = prompt.enum_select("What letter?", choices)
       expect(answer).to eq("C")
 
-      expected_output =
-        output_helper("What letter?", choices, 'A') +
-        output_helper("What letter?", choices, 'A', input: '2') +
-        output_helper("What letter?", choices, 'A', input: '', error: 'Please enter a valid number') +
-        output_helper("What letter?", choices, 'C', input: '3', error: 'Please enter a valid number') +
+      expected_output = [
+        output_helper("What letter?", choices, 'A'),
+        output_helper("What letter?", choices, 'A', input: '2'),
+        output_helper("What letter?", choices, 'A', input: '', error: 'Please enter a valid number'),
+        output_helper("What letter?", choices, 'C', input: '3', error: 'Please enter a valid number'),
         exit_message("What letter?", "C")
+      ].join
 
       expect(prompt.output.string).to eq(expected_output)
     end
@@ -431,14 +502,15 @@ RSpec.describe TTY::Prompt do
       answer = prompt.enum_select("What letter?", choices)
       expect(answer).to eq("D")
 
-      expected_output =
-        output_helper("What letter?", choices, 'A') +
-        output_helper("What letter?", choices, 'A', input: '2') +
-        output_helper("What letter?", choices, 'A', input: '') +
-        output_helper("What letter?", choices, 'A', input: '3') +
-        output_helper("What letter?", choices, 'A', input: '') +
-        output_helper("What letter?", choices, 'D', input: '4') +
+      expected_output = [
+        output_helper("What letter?", choices, 'A'),
+        output_helper("What letter?", choices, 'A', input: '2'),
+        output_helper("What letter?", choices, 'A', input: ''),
+        output_helper("What letter?", choices, 'A', input: '3'),
+        output_helper("What letter?", choices, 'A', input: ''),
+        output_helper("What letter?", choices, 'D', input: '4'),
         exit_message("What letter?", "D")
+      ].join
 
       expect(prompt.output.string).to eq(expected_output)
     end

data/spec/unit/expand_spec.rb

@@ -35,11 +35,13 @@ RSpec.describe TTY::Prompt, '#expand' do
     result = prompt.expand('Overwrite Gemfile?', choices)
     expect(result).to eq(:yes)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "changes default option" do
@@ -49,11 +51,13 @@ RSpec.describe TTY::Prompt, '#expand' do
     result = prompt.expand('Overwrite Gemfile?', choices, default: 3)
     expect(result).to eq(:all)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "expands chosen option with extra information" do
@@ -63,7 +67,7 @@ RSpec.describe TTY::Prompt, '#expand' do
     result = prompt.expand('Overwrite Gemfile?', choices)
     expect(result).to eq(:all)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
@@ -75,7 +79,9 @@ RSpec.describe TTY::Prompt, '#expand' do
       "\e[2K\e[1G",
       "\e[A\e[1G",
       "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "expands help option and then defaults" do
@@ -85,7 +91,7 @@ RSpec.describe TTY::Prompt, '#expand' do
     result = prompt.expand('Overwrite Gemfile?', choices)
     expect(result).to eq(:diff)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,d,q,\e[32mh\e[0m] h\n",
@@ -116,7 +122,89 @@ RSpec.describe TTY::Prompt, '#expand' do
       "\e[2K\e[1G\e[1A" * 7,
       "\e[2K\e[1G",
       "Overwrite Gemfile? \e[32mShow diff\e[0m\n",
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
+  end
+
+  it "automatically expands hint" do
+    prompt.input << "d\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices, auto_hint: true)
+    expect(result).to eq(:diff)
+
+    expected_output = [
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\n\e[32m>> \e[0mOverwrite",
+      "\e[A\e[1G\e[54C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,\e[32md\e[0m,q,h] ",
+      "d\n",
+      "\e[32m>> \e[0mShow diff",
+      "\e[A\e[1G\e[55C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? \e[32mShow diff\e[0m\n",
+      "\e[32m>> \e[0mShow diff",
+      "\e[A\e[1G\e[28C\n"
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
+  end
+
+  it "informs about invalid input when automatically expanding hint" do
+    prompt = TTY::TestPrompt.new
+    prompt.on(:keypress) { |e| prompt.trigger(:keybackspace) if e.value == "w" }
+    prompt.input << "y" << "y" << "\u007F" << "\r"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices, defualt: 1, auto_hint: true)
+    expect(result).to eq(:yes)
+
+    expected_output = [
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\n\e[32m>> \e[0mOverwrite",
+      "\e[A\e[1G\e[54C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "y\n",
+      "\e[32m>> \e[0mOverwrite",
+      "\e[A\e[1G\e[55C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,d,q,h] ",
+      "yy\n",
+      "\e[32m>> \e[0minvalid option",
+      "\e[A\e[1G\e[56C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "y\n",
+      "\e[32m>> \e[0mOverwrite",
+      "\e[A\e[1G\e[55C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? \e[32mOverwrite\e[0m\n",
+      "\e[32m>> \e[0mOverwrite",
+      "\e[A\e[1G\e[28C\n"
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "specifies options through DSL" do
@@ -135,11 +223,13 @@ RSpec.describe TTY::Prompt, '#expand' do
 
     expect(result).to eq(:diff)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,\e[32md\e[0m,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? \e[32mShow diff\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "specifies options through DSL and executes value" do
@@ -156,11 +246,13 @@ RSpec.describe TTY::Prompt, '#expand' do
 
     expect(result).to eq(:ok)
 
-    expect(prompt.output.string).to eq([
+    expected_output = [
       "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
       "\e[2K\e[1G",
       "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
-    ].join)
+    ].join
+
+    expect(prompt.output.string).to eq(expected_output)
   end
 
   it "fails to expand due to lack of key attribute" do