tty-prompt 0.10.1 → 0.11.0

data/spec/unit/reader/read_keypress_spec.rb

@@ -3,9 +3,10 @@
 RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
   let(:input)  { StringIO.new }
   let(:out)    { StringIO.new }
+  let(:env)    { { "TTY_TEST" => true } }
 
   it "reads single key press" do
-    reader = described_class.new(input, out)
+    reader = described_class.new(input, out, env: env)
     input << "\e[Aaaaaaa\n"
     input.rewind
 
@@ -15,7 +16,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
   end
 
   it 'reads multibyte key press' do
-    reader = described_class.new(input, out)
+    reader = described_class.new(input, out, env: env)
     input << "ㄱ"
     input.rewind
 
@@ -26,7 +27,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
 
   context 'when Ctrl+C pressed' do
     it "defaults to raising InputInterrupt" do
-      reader = described_class.new(input, out)
+      reader = described_class.new(input, out, env: env)
       input << "\x03"
       input.rewind
 
@@ -36,7 +37,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
     end
 
     it "sends interrupt signal when :signal option is chosen" do
-      reader = described_class.new(input, out, interrupt: :signal)
+      reader = described_class.new(input, out, interrupt: :signal, env: env)
       input << "\x03"
       input.rewind
 
@@ -48,7 +49,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
     end
 
     it "exits with 130 code when :exit option is chosen" do
-      reader = described_class.new(input, out, interrupt: :exit)
+      reader = described_class.new(input, out, interrupt: :exit, env: env)
       input << "\x03"
       input.rewind
 
@@ -59,7 +60,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
 
     it "evaluates custom handler when proc object is provided" do
       handler = proc { raise ArgumentError }
-      reader = described_class.new(input, out, interrupt: handler)
+      reader = described_class.new(input, out, interrupt: handler, env: env)
       input << "\x03"
       input.rewind
 
@@ -69,7 +70,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_keypress' do
     end
 
     it "skips handler when handler is nil" do
-      reader = described_class.new(input, out, interrupt: :noop)
+      reader = described_class.new(input, out, interrupt: :noop, env: env)
       input << "\x03"
       input.rewind
 

data/spec/unit/reader/read_line_spec.rb

@@ -3,30 +3,30 @@
 RSpec.describe TTY::Prompt::Reader, '#read_line' do
   let(:input)  { StringIO.new }
   let(:output) { StringIO.new }
+  let(:env)    { { "TTY_TEST" => true } }
 
-  subject(:reader) { described_class.new(input, output) }
+  subject(:reader) { described_class.new(input, output, env: env) }
 
   it 'masks characters' do
-    mask = '*'
-    input << "password"
+    input << "password\n"
     input.rewind
-    answer = reader.read_line(mask)
-    expect(answer).to eq("password")
+    answer = reader.read_line(echo: false)
+    expect(answer).to eq("password\n")
   end
 
   it "echoes characters back" do
-    input << "password"
+    input << "password\n"
     input.rewind
     answer = reader.read_line
-    expect(answer).to eq("password")
+    expect(answer).to eq("password\n")
     expect(output.string).to eq("")
   end
 
   it 'deletes characters when backspace pressed' do
-    input << "aa\ba\bcc"
+    input << "aa\ba\bcc\n"
     input.rewind
     answer = reader.read_line
-    expect(answer).to eq('acc')
+    expect(answer).to eq("acc\n")
   end
 
   it 'reads multibyte line' do

data/spec/unit/reader/read_multiline_spec.rb

@@ -3,8 +3,9 @@
 RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
   let(:input)  { StringIO.new }
   let(:output) { StringIO.new }
+  let(:env)    { { "TTY_TEST" => true } }
 
-  subject(:reader) { described_class.new(input, output) }
+  subject(:reader) { described_class.new(input, output, env: env) }
 
   it 'reads no lines' do
     input << ''
@@ -14,17 +15,17 @@ RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
   end
 
   it "reads a line" do
-    input << "Single line"
+    input << "Single line\n"
     input.rewind
     answer = reader.read_multiline
-    expect(answer).to eq(['Single line'])
+    expect(answer).to eq(["Single line\n"])
   end
 
   it 'reads few lines' do
-    input << "First line\nSecond line\nThird line"
+    input << "First line\nSecond line\nThird line\n"
     input.rewind
     answer = reader.read_multiline
-    expect(answer).to eq(['First line', 'Second line', 'Third line'])
+    expect(answer).to eq(["First line\n", "Second line\n", "Third line\n"])
   end
 
   it 'reads and yiels every line' do
@@ -32,7 +33,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
     input.rewind
     lines = []
     reader.read_multiline { |line| lines << line }
-    expect(lines).to eq(['First line', 'Second line', 'Third line'])
+    expect(lines).to eq(["First line\n", "Second line\n", "Third line"])
   end
 
   it 'reads multibyte lines' do
@@ -40,6 +41,6 @@ RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
     input.rewind
     lines = []
     reader.read_multiline { |line| lines << line }
-    expect(lines).to eq(["국경의 긴 터널을 빠져나오자", '설국이었다.'])
+    expect(lines).to eq(["국경의 긴 터널을 빠져나오자\n", '설국이었다.'])
   end
 end

data/spec/unit/select_spec.rb

@@ -4,6 +4,8 @@ RSpec.describe TTY::Prompt, '#select' do
 
   subject(:prompt) { TTY::TestPrompt.new }
 
+  let(:symbols) { TTY::Prompt::Symbols.symbols }
+
   it "selects by default first option" do
     choices = %w(Large Medium Small)
     prompt.input << "\r"
@@ -11,14 +13,40 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.select('What size?', choices)).to eq('Large')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ Large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mLarge\e[0m\n\e[?25h"
     ].join)
   end
 
+  it "allows navigation using events without errors" do
+    choices = %w(Large Medium Small)
+    prompt.input << "j" << "\r"
+    prompt.input.rewind
+    prompt.on(:keypress) do |event|
+      prompt.trigger(:keydown) if event.value == "j"
+    end
+    expect { prompt.select('What size?', choices) }.not_to output.to_stderr
+    expect(prompt.output.string).to eq([
+      "\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",
+      "  Small",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
+      "What size? \n",
+      "  Large\n",
+      "\e[32m#{symbols[:pointer]} Medium\e[0m\n",
+      "  Small",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
+      "What size? \e[32mMedium\e[0m\n\e[?25h"
+    ].join)
+  end
+
   it "sets choice name and value" do
     choices = {large: 1, medium: 2, small: 3}
     prompt.input << " "
@@ -26,10 +54,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.select('What size?', choices)).to eq(1)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} large\e[0m\n",
       "  medium\n",
       "  small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mlarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -45,10 +74,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq('Large')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ Large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mLarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -64,10 +94,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq(1)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} large\e[0m\n",
       "  medium\n",
       "  small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mlarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -82,10 +113,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq('Large')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ Large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mLarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -105,9 +137,10 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow or number (1-3) keys, press Enter to select)\e[0m\n",
       "  1. large\n",
-      "\e[32m‣ 2. medium\e[0m\n",
+      "\e[32m#{symbols[:pointer]} 2. medium\e[0m\n",
       "  3. small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mmedium\e[0m\n\e[?25h"
     ].join)
   end
@@ -124,9 +157,10 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow or number (1-3) keys, press Enter to select)\e[0m\n",
       "  1) large\n",
-      "\e[32m‣ 2) medium\e[0m\n",
+      "\e[32m#{symbols[:pointer]} 2) medium\e[0m\n",
       "  3) small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mmedium\e[0m\n\e[?25h"
     ].join)
   end
@@ -139,9 +173,10 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow or number (1-3) keys, press Enter to select)\e[0m\n",
       "  1. Large\n",
-      "\e[32m‣ 2. Medium\e[0m\n",
+      "\e[32m#{symbols[:pointer]} 2. Medium\e[0m\n",
       "  3. Small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mMedium\e[0m\n\e[?25h"
     ].join)
   end
@@ -158,7 +193,8 @@ RSpec.describe TTY::Prompt, '#select' do
       "\e[34m> Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[34mLarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -171,10 +207,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq('Large')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Bash keyboard)\e[0m\n",
-      "\e[32m‣ Large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A" * 3 + "\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "What size? \e[32mLarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -187,10 +224,11 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(prompt.select('What size?', choices)).to eq('Large')
     expect(prompt.output.string).to eq([
       "\e[?25l[?] What size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ Large\e[0m\n",
+      "\e[32m#{symbols[:pointer]} Large\e[0m\n",
       "  Medium\n",
       "  Small",
-      "\e[1000D\e[K\e[1A" * 3 + "\e[1000D\e[K",
+      "\e[2K\e[1G\e[1A" * 3,
+      "\e[2K\e[1G",
       "[?] What size? \e[32mLarge\e[0m\n\e[?25h"
     ].join)
   end
@@ -203,11 +241,12 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq('D')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat letter? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ D\e[0m\n",
+      "\e[32m#{symbols[:pointer]} D\e[0m\n",
       "  E\n",
       "  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
@@ -227,11 +266,12 @@ RSpec.describe TTY::Prompt, '#select' do
     expect(value).to eq('D')
     expect(prompt.output.string).to eq([
       "\e[?25lWhat letter? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "\e[32m‣ D\e[0m\n",
+      "\e[32m#{symbols[:pointer]} D\e[0m\n",
       "  E\n",
       "  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
@@ -247,6 +287,26 @@ RSpec.describe TTY::Prompt, '#select' do
     }.to raise_error(TTY::Prompt::ConfigurationError, /in range \(1 - 3\)/)
   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.select("What letter?", choices, per_page: 4, default: 1)
+    expect(value).to eq('A')
+
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat letter? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "\e[32m#{symbols[:pointer]} A\e[0m\n",
+      "  B\n",
+      "  C\n",
+      "  D",
+      "\e[2K\e[1G\e[1A" * 4,
+      "\e[2K\e[1G",
+      "What letter? \e[32mA\e[0m\n\e[?25h",
+    ].join)
+  end
+
   it "verifies default index range" do
     prompt = TTY::TestPrompt.new
     choices = %w(Large Medium Small)

data/spec/unit/slider_spec.rb

@@ -4,16 +4,18 @@ RSpec.describe TTY::Prompt, '#slider' do
 
   subject(:prompt) { TTY::TestPrompt.new }
 
+  let(:symbols) { TTY::Prompt::Symbols.symbols }
+
   it "specifies ranges & step" do
     prompt.input << "\r"
     prompt.input.rewind
     expect(prompt.slider('What size?', min: 32, max: 54, step: 2)).to eq(44)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "|------",
-      "\e[32mO\e[0m",
-      "-----| 44",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      symbols[:pipe] + symbols[:line] * 6,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 5 + symbols[:pipe]} 44",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
       "What size? \e[32m44\e[0m\n\e[?25h"
     ].join)
   end
@@ -24,10 +26,10 @@ RSpec.describe TTY::Prompt, '#slider' do
     expect(prompt.slider('What size?', min: 32, max: 54, step: 2, default: 38)).to eq(38)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "|---",
-      "\e[32mO\e[0m",
-      "--------| 38",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      symbols[:pipe] + symbols[:line] * 3,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 8 + symbols[:pipe]} 38",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
       "What size? \e[32m38\e[0m\n\e[?25h"
     ].join)
   end
@@ -44,10 +46,10 @@ RSpec.describe TTY::Prompt, '#slider' do
     expect(value).to eq(6)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
-      "|---",
-      "\e[32mO\e[0m",
-      "-------| 6",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      symbols[:pipe] + symbols[:line] * 3,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 7 + symbols[:pipe]} 6",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
       "What size? \e[32m6\e[0m\n\e[?25h"
     ].join)
   end
@@ -59,11 +61,36 @@ RSpec.describe TTY::Prompt, '#slider' do
     expect(prompt.slider('What size?', options)).to eq(5)
     expect(prompt.output.string).to eq([
       "\e[?25lWhat size? \e[36m(Use arrow keys, press Enter to select)\e[0m\n",
-      "|-----",
-      "\e[31mO\e[0m",
-      "-----| 5",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K",
+      symbols[:pipe] + symbols[:line] * 5,
+      "\e[31m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 5 + symbols[:pipe]} 5",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
       "What size? \e[31m5\e[0m\n\e[?25h"
     ].join)
   end
+
+  it "doesn't allow values outside of range" do
+    prompt.input << "l\r"
+    prompt.input.rewind
+    prompt.on(:keypress) do |event|
+      if event.value = 'l'
+        prompt.trigger(:keyright)
+      end
+    end
+    res = prompt.slider('What size?', min: 0, max: 10, step: 1, default: 10)
+    expect(res).to eq(10)
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      symbols[:pipe] + symbols[:line] * 10,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:pipe]} 10",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? \n",
+      symbols[:pipe] + symbols[:line] * 10,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:pipe]} 10",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? \e[32m10\e[0m\n\e[?25h"
+    ].join)
+  end
 end