tty-prompt 0.10.1 → 0.11.0

data/spec/unit/mask_spec.rb

@@ -4,6 +4,8 @@ RSpec.describe TTY::Prompt, '#mask' do
 
   subject(:prompt) { TTY::TestPrompt.new }
 
+  let(:symbols) { TTY::Prompt::Symbols.symbols }
+
   it "masks output by default" do
     prompt.input << "pass\r"
     prompt.input.rewind
@@ -11,18 +13,18 @@ RSpec.describe TTY::Prompt, '#mask' do
     expect(answer).to eql("pass")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K",
-      "What is your password? •",
-      "\e[1000D\e[K",
-      "What is your password? ••",
-      "\e[1000D\e[K",
-      "What is your password? •••",
-      "\e[1000D\e[K",
-      "What is your password? ••••",
-      "\e[1000D\e[K",
-      "What is your password? \e[32m••••\e[0m\n",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
-      "What is your password? \e[32m••••\e[0m\n"
+      "\e[2K\e[1G",
+      "What is your password? #{symbols[:dot]}",
+      "\e[2K\e[1G",
+      "What is your password? #{symbols[:dot] * 2}",
+      "\e[2K\e[1G",
+      "What is your password? #{symbols[:dot] * 3}",
+      "\e[2K\e[1G",
+      "What is your password? #{symbols[:dot] * 4}",
+      "\e[2K\e[1G",
+      "What is your password? \e[32m#{symbols[:dot] * 4}\e[0m\n",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[32m#{symbols[:dot] * 4}\e[0m\n"
     ].join)
   end
 
@@ -33,17 +35,17 @@ RSpec.describe TTY::Prompt, '#mask' do
     expect(answer).to eql("pass")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? *",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? **",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ***",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ****",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? \e[32m****\e[0m\n",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your password? \e[32m****\e[0m\n",
     ].join)
   end
@@ -55,15 +57,15 @@ RSpec.describe TTY::Prompt, '#mask' do
     expect(answer).to eql("lov")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ♥",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ♥♥",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ♥♥♥",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? \e[32m♥♥♥\e[0m\n",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your password? \e[32m♥♥♥\e[0m\n",
     ].join)
   end
@@ -78,18 +80,53 @@ RSpec.describe TTY::Prompt, '#mask' do
     expect(answer).to eql("pass")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? \n",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? \n",
     ].join)
   end
+
+  it "validates input" do
+    prompt.input << "no\nyes\n"
+    prompt.input.rewind
+    answer = prompt.mask('What is your password?') do |q|
+      q.echo true
+      q.mask '*'
+      q.validate(/[a-z]{3,4}/)
+      q.messages[:valid?] = 'Not valid'
+    end
+    expect(answer).to eq('yes')
+    expect(prompt.output.string).to eq([
+      "What is your password? ",
+      "\e[2K\e[1G",
+      "What is your password? *",
+      "\e[2K\e[1G",
+      "What is your password? **",
+      "\e[2K\e[1G",
+      "What is your password? \e[32m**\e[0m\n",
+      "\e[31m>>\e[0m Not valid",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[31m**\e[0m",
+      "\e[2K\e[1G",
+      "What is your password? *",
+      "\e[2K\e[1G",
+      "What is your password? **",
+      "\e[2K\e[1G",
+      "What is your password? ***",
+      "\e[2K\e[1G",
+      "What is your password? \e[32m***\e[0m\n",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[32m***\e[0m\n"
+    ].join)
+  end
 end

data/spec/unit/multi_select_spec.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt do
+  let(:symbols) { TTY::Prompt::Symbols.symbols }
+
   it "selects nothing when return pressed immediately" do
     prompt = TTY::TestPrompt.new
     choices = %w(vodka beer wine whisky bourbon)
@@ -9,12 +11,12 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices)). to eq([])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ ⬡ vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \n\e[?25h"
     ].join)
   end
@@ -27,23 +29,48 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices)). to eq(['vodka'])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ ⬡ vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? vodka\n",
-      "‣ \e[32m⬢\e[0m vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
     ].join)
   end
 
+  it "selects item when space pressed but doesn't echo item if echo: false" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(vodka beer wine whisky bourbon)
+    prompt.input << " \r"
+    prompt.input.rewind
+    expect(prompt.multi_select("Select drinks?", choices, echo: false)). to eq(['vodka'])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
+      "Select drinks? \n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
+      "Select drinks? \n\e[?25h"
+    ].join)
+  end
+
   it "sets choice custom values" do
     prompt = TTY::TestPrompt.new
     choices = {vodka: 1, beer: 2, wine: 3, whisky: 4, bourbon: 5}
@@ -52,19 +79,19 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices)).to eq([1])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ ⬡ vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? vodka\n",
-      "‣ \e[32m⬢\e[0m vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
     ].join)
   end
@@ -84,19 +111,19 @@ RSpec.describe TTY::Prompt do
     expect(value).to eq([{score: 1}])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? \e[90m(Use arrow or number (1-5) keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ ⬡ 1) vodka\n",
-      "  ⬡ 2) beer\n",
-      "  ⬡ 3) wine\n",
-      "  ⬡ 4) whisky\n",
-      "  ⬡ 5) bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} 1) vodka\n",
+      "  #{symbols[:radio_off]} 2) beer\n",
+      "  #{symbols[:radio_off]} 3) wine\n",
+      "  #{symbols[:radio_off]} 4) whisky\n",
+      "  #{symbols[:radio_off]} 5) bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? vodka\n",
-      "‣ \e[32m⬢\e[0m 1) vodka\n",
-      "  ⬡ 2) beer\n",
-      "  ⬡ 3) wine\n",
-      "  ⬡ 4) whisky\n",
-      "  ⬡ 5) bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m 1) vodka\n",
+      "  #{symbols[:radio_off]} 2) beer\n",
+      "  #{symbols[:radio_off]} 3) wine\n",
+      "  #{symbols[:radio_off]} 4) whisky\n",
+      "  #{symbols[:radio_off]} 5) bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
     ].join)
   end
@@ -117,12 +144,12 @@ RSpec.describe TTY::Prompt do
     expect(value).to match_array([{score: 20}, {score: 50}])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? beer, bourbon \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "  ⬡ vodka\n",
-      "  \e[32m⬢\e[0m beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "‣ \e[32m⬢\e[0m bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "  #{symbols[:radio_off]} vodka\n",
+      "  \e[32m#{symbols[:radio_on]}\e[0m beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \e[32mbeer, bourbon\e[0m\n\e[?25h",
     ].join)
   end
@@ -165,12 +192,12 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices)). to eq([])
     expect(prompt.output.string).to eq([
       "\e[?25l[?] Select drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ ⬡ vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "[?] Select drinks? \n\e[?25h"
     ].join)
   end
@@ -184,12 +211,12 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices, options)). to eq(['vodka'])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? vodka \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "> \e[34m⬢\e[0m vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "> \e[34m#{symbols[:radio_on]}\e[0m vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \e[34mvodka\e[0m\n\e[?25h"
     ].join)
   end
@@ -202,12 +229,12 @@ RSpec.describe TTY::Prompt do
     expect(prompt.multi_select("Select drinks?", choices, help: '(Bash keyboard)')). to eq([])
     expect(prompt.output.string).to eq([
       "\e[?25lSelect drinks? \e[90m(Bash keyboard)\e[0m\n",
-      "‣ ⬡ vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
-      "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
+      "#{symbols[:pointer]} #{symbols[:radio_off]} vodka\n",
+      "  #{symbols[:radio_off]} beer\n",
+      "  #{symbols[:radio_off]} wine\n",
+      "  #{symbols[:radio_off]} whisky\n",
+      "  #{symbols[:radio_off]} bourbon",
+      "\e[2K\e[1G\e[1A" * 5, "\e[2K\e[1G",
       "Select drinks? \n\e[?25h"
     ].join)
   end
@@ -221,11 +248,11 @@ RSpec.describe TTY::Prompt do
     expect(value).to eq(['D'])
     expect(prompt.output.string).to eq([
       "\e[?25lWhat letter? D \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ \e[32m⬢\e[0m D\n",
-      "  ⬡ E\n",
-      "  ⬡ F\n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m D\n",
+      "  #{symbols[:radio_off]} E\n",
+      "  #{symbols[:radio_off]} F\n",
       "\e[90m(Move up or down to reveal more choices)\e[0m",
-      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 4, "\e[2K\e[1G",
       "What letter? \e[32mD\e[0m\n\e[?25h",
     ].join)
   end
@@ -244,12 +271,31 @@ RSpec.describe TTY::Prompt do
     expect(value).to eq(['D'])
     expect(prompt.output.string).to eq([
       "\e[?25lWhat letter? D \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
-      "‣ \e[32m⬢\e[0m D\n",
-      "  ⬡ E\n",
-      "  ⬡ F\n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m D\n",
+      "  #{symbols[:radio_off]} E\n",
+      "  #{symbols[:radio_off]} F\n",
       "\e[90m(Wiggle thy finger up or down to see more)\e[0m",
-      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 4, "\e[2K\e[1G",
       "What letter? \e[32mD\e[0m\n\e[?25h",
     ].join)
   end
+
+  it "doesn't paginate short selections" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(A B C D)
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.multi_select("What letter?", choices, per_page: 4, default: 1)
+    expect(value).to eq(['A'])
+
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat letter? A \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m A\n",
+      "  #{symbols[:radio_off]} B\n",
+      "  #{symbols[:radio_off]} C\n",
+      "  #{symbols[:radio_off]} D",
+      "\e[2K\e[1G\e[1A" * 4, "\e[2K\e[1G",
+      "What letter? \e[32mA\e[0m\n\e[?25h",
+    ].join)
+  end
 end

data/spec/unit/new_spec.rb

@@ -1,18 +1,20 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt, '#new' do
+  let(:env)    { { "TTY_TEST" => true } }
+
   it "sets prefix" do
-    prompt = described_class.new(prefix: "[?]")
+    prompt = described_class.new(prefix: "[?]", env: env)
     expect(prompt.prefix).to eq("[?]")
   end
 
   it "sets input stream" do
-    prompt = described_class.new(input: :stream1)
+    prompt = described_class.new(input: :stream1, env: env)
     expect(prompt.input).to eq(:stream1)
   end
 
   it "sets output stream" do
-    prompt = described_class.new(output: :stream2)
+    prompt = described_class.new(output: :stream2, env: env)
     expect(prompt.output).to eq(:stream2)
   end
 end

data/spec/unit/paginator_spec.rb

@@ -1,6 +1,22 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Paginator, '#paginate' do
+  it "ignores per_page when equal items " do
+    list = %w(a b c d)
+    paginator = described_class.new({per_page: 4})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([
+      ['a',0],['b',1],['c',2],['d',3]])
+  end
+
+  it "ignores per_page when less items " do
+    list = %w(a b c d)
+    paginator = described_class.new({per_page: 5})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([
+      ['a',0],['b',1],['c',2],['d',3]])
+  end
+
   it "paginates items matching per_page count" do
     list = %w(a b c d e f)
     paginator = described_class.new({per_page: 3})