tty-prompt 0.11.0 → 0.12.0

data/spec/unit/reader/history_spec.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Reader::History do
+  it "has no lines" do
+    history = described_class.new
+    expect(history.size).to eq(0)
+  end
+
+  it "doesn't navigate through empty buffer" do
+    history = described_class.new
+    expect(history.next?).to eq(false)
+    expect(history.previous?).to eq(false)
+  end
+
+  it "allows to cycle through non-empty buffer" do
+    history = described_class.new(3, {cycle: true})
+    history << "line"
+    expect(history.next?).to eq(true)
+    expect(history.previous?).to eq(true)
+  end
+
+  it "defaults maximum size" do
+    history = described_class.new
+    expect(history.max_size).to eq(512)
+  end
+
+  it "presents string representation" do
+    history = described_class.new
+    expect(history.to_s).to eq("[]")
+  end
+
+  it "adds items to history without overflowing" do
+    history = described_class.new(3)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+    history << "line #4"
+
+    expect(history.to_a).to eq(["line #2", "line #3", "line #4"])
+    expect(history.index).to eq(2)
+  end
+
+  it "excludes items" do
+    exclude = proc { |line| /line #[23]/.match(line) }
+    history = described_class.new(3, exclude: exclude)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.to_a).to eq(["line #1"])
+    expect(history.index).to eq(0)
+  end
+
+  it "allows duplicates" do
+    history = described_class.new(3)
+    history << "line #1"
+    history << "line #1"
+    history << "line #1"
+
+    expect(history.to_a).to eq(["line #1", "line #1", "line #1"])
+  end
+
+  it "prevents duplicates" do
+    history = described_class.new(3, duplicates: false)
+    history << "line #1"
+    history << "line #1"
+    history << "line #1"
+
+    expect(history.to_a).to eq(["line #1"])
+  end
+
+  it "navigates through history buffer without cycling" do
+    history = described_class.new(3)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.index).to eq(2)
+    history.previous
+    history.previous
+    expect(history.index).to eq(0)
+    history.previous
+    expect(history.index).to eq(0)
+    history.next
+    history.next
+    expect(history.index).to eq(2)
+    history.next
+    expect(history.next?).to eq(false)
+    expect(history.index).to eq(2)
+  end
+
+  it "navigates through history buffer with cycling" do
+    history = described_class.new(3, cycle: true)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.index).to eq(2)
+    history.previous
+    history.previous
+    expect(history.index).to eq(0)
+    history.previous
+    expect(history.index).to eq(2)
+    expect(history.next?).to eq(true)
+    history.next
+    history.next
+    expect(history.index).to eq(1)
+    history.next
+    expect(history.index).to eq(2)
+  end
+
+  it "checks if navigation is possible" do
+    history = described_class.new(3)
+    expect(history.previous?).to eq(false)
+    expect(history.next?).to eq(false)
+
+    history << "line #1"
+    history << "line #2"
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(false)
+
+    history.previous
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(true)
+
+    history.previous
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(true)
+  end
+
+  it "gets line based on index" do
+    history = described_class.new(3, cycle: true)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history[-1]).to eq('line #3')
+    expect(history[1]).to eq('line #2')
+    expect {
+      history[11]
+    }.to raise_error(IndexError, 'invalid index')
+  end
+
+  it "retrieves current line" do
+    history = described_class.new(3, cycle: true)
+    expect(history.get).to eq(nil)
+
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.get).to eq("line #3")
+    history.previous
+    history.previous
+    expect(history.get).to eq("line #1")
+    history.next
+    expect(history.get).to eq("line #2")
+  end
+
+  it "clears all lines" do
+    history = described_class.new(3)
+
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.size).to eq(3)
+    history.clear
+    expect(history.size).to eq(0)
+    expect(history.index).to eq(0)
+  end
+end

data/spec/unit/reader/key_event_spec.rb

@@ -59,15 +59,19 @@ RSpec.describe TTY::Prompt::Reader::KeyEvent, '#from' do
     end
   end
 
-  # arrow keys & page navigation
+  # arrow keys & text editing
   {
-    up:    ["\e[A"],
-    down:  ["\e[B"],
-    right: ["\e[C"],
-    left:  ["\e[D"],
-    clear: ["\e[E"],
-    end:   ["\e[F"],
-    home:  ["\e[H"]
+    up:     ["\e[A"],
+    down:   ["\e[B"],
+    right:  ["\e[C"],
+    left:   ["\e[D"],
+    clear:  ["\e[E"],
+    home:   ["\e[1~"],
+    insert: ["\e[2~"],
+    delete: ["\e[3~"],
+    end:    ["\e[4~"],
+    page_up:   ["\e[5~"],
+    page_down: ["\e[6~"]
   }.each do |name, codes|
     codes.each do |code|
       it "parses #{Shellwords.escape(code)} as #{name} key" do

data/spec/unit/reader/line_spec.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Reader::Line do
+  it "inserts characters in line" do
+    line = described_class.new('aaaaa')
+    line[0] = 'test'
+    expect(line.text).to eq('testaaaaa')
+    line[4..6] = ''
+    expect(line.text).to eq('testaa')
+  end
+
+  it "moves cursor left and right" do
+    line = described_class.new('aaaaa')
+    5.times { line.left }
+    expect(line.cursor).to eq(0)
+    expect(line.start?).to eq(true)
+    line.left(5)
+    expect(line.cursor).to eq(0)
+    line.right(20)
+    expect(line.cursor).to eq(5)
+    expect(line.end?).to eq(true)
+  end
+
+  it "inserts char at start of the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+    line[0] = 'b'
+    expect(line.cursor).to eq(1)
+    expect(line.text).to eq('baaaaa')
+    line.insert('b')
+    expect(line.text).to eq('bbaaaaa')
+  end
+
+  it "inserts char at end of the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+    line[4] = 'b'
+    expect(line.cursor).to eq(5)
+    expect(line.text).to eq('aaaaab')
+  end
+
+  it "inserts char inside the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+    line[2] = 'b'
+    expect(line.cursor).to eq(3)
+    expect(line.text).to eq('aabaaa')
+  end
+
+  it "inserts char outside of the line size" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+    line[10] = 'b'
+    expect(line.cursor).to eq(11)
+    expect(line.text).to eq('aaaaa     b')
+  end
+
+  it "inserts chars on empty string" do
+    line = described_class.new('')
+    expect(line.cursor).to eq(0)
+    line.insert('a')
+    expect(line.cursor).to eq(1)
+    line.insert('b')
+    expect(line.cursor).to eq(2)
+    expect(line.to_s).to eq('ab')
+    line.insert('cc')
+    expect(line.cursor).to eq(4)
+    expect(line.to_s).to eq('abcc')
+  end
+
+  it "inserts characters with #insert call" do
+    line = described_class.new('aaaaa')
+    line.left(2)
+    expect(line.cursor).to eq(3)
+    line.insert(' test ')
+    expect(line.text).to eq('aaa test aa')
+    expect(line.cursor).to eq(9)
+    line.right
+    expect(line.cursor).to eq(10)
+  end
+
+  it "removes char before current cursor position" do
+    line = described_class.new('abcdef')
+    expect(line.cursor).to eq(6)
+    line.remove
+    line.remove
+    expect(line.text).to eq('abcd')
+    expect(line.cursor).to eq(4)
+    line.left
+    line.left
+    line.remove
+    expect(line.text).to eq('acd')
+    expect(line.cursor).to eq(1)
+    line.insert('x')
+    expect(line.text).to eq('axcd')
+  end
+
+  it "deletes char under current cursor position" do
+    line = described_class.new('abcdef')
+    line.left(3)
+    line.delete
+    expect(line.text).to eq('abcef')
+    line.right
+    line.delete
+    expect(line.text).to eq('abce')
+    line.left(4)
+    line.delete
+    expect(line.text).to eq('bce')
+  end
+end

data/spec/unit/reader/publish_keypress_event_spec.rb

@@ -80,4 +80,15 @@ RSpec.describe TTY::Prompt::Reader, '#publish_keypress_event' do
     expect(keys).to eq(["keyenter", "keypress"])
     expect(answer).to eq("\n")
   end
+
+  it "subscribes to ctrl+X type of event event" do
+    input << ?\C-z
+    input.rewind
+    keys = []
+    reader.on(:keyctrl_z) { |event| keys << "ctrl_z" }
+
+    answer = reader.read_keypress
+    expect(keys).to eq(['ctrl_z'])
+    expect(answer).to eq(?\C-z)
+  end
 end

data/spec/unit/reader/read_line_spec.rb

@@ -19,10 +19,40 @@ RSpec.describe TTY::Prompt::Reader, '#read_line' do
     input.rewind
     answer = reader.read_line
     expect(answer).to eq("password\n")
-    expect(output.string).to eq("")
+    expect(output.string).to eq([
+      "\e[2K\e[1Gp",
+      "\e[2K\e[1Gpa",
+      "\e[2K\e[1Gpas",
+      "\e[2K\e[1Gpass",
+      "\e[2K\e[1Gpassw",
+      "\e[2K\e[1Gpasswo",
+      "\e[2K\e[1Gpasswor",
+      "\e[2K\e[1Gpassword",
+      "\e[2K\e[1Gpassword\n"
+    ].join)
   end
 
-  it 'deletes characters when backspace pressed' do
+  it "doesn't echo characters back" do
+    input << "password\n"
+    input.rewind
+    answer = reader.read_line(echo: false)
+    expect(answer).to eq("password\n")
+    expect(output.string).to eq('')
+  end
+
+  it "displays a prompt before input" do
+    input << "aa\n"
+    input.rewind
+    answer = reader.read_line('>> ')
+    expect(answer).to eq("aa\n")
+    expect(output.string).to eq([
+      "\e[2K\e[1G>> a",
+      "\e[2K\e[1G>> aa",
+      "\e[2K\e[1G>> aa\n"
+    ].join)
+  end
+
+  xit 'deletes characters when backspace pressed' do
     input << "aa\ba\bcc\n"
     input.rewind
     answer = reader.read_line

data/spec/unit/reader/read_multiline_spec.rb

@@ -8,28 +8,42 @@ RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
   subject(:reader) { described_class.new(input, output, env: env) }
 
   it 'reads no lines' do
-    input << ''
+    input << "\C-d"
     input.rewind
     answer = reader.read_multiline
     expect(answer).to eq([])
   end
 
-  it "reads a line" do
-    input << "Single line\n"
+  it "reads a line and terminates on Ctrl+d" do
+    input << "Single line\C-d"
     input.rewind
     answer = reader.read_multiline
-    expect(answer).to eq(["Single line\n"])
+    expect(answer).to eq(["Single line"])
+  end
+
+  it "reads a line and terminates on Ctrl+z" do
+    input << "Single line\C-z"
+    input.rewind
+    answer = reader.read_multiline
+    expect(answer).to eq(["Single line"])
   end
 
   it 'reads few lines' do
-    input << "First line\nSecond line\nThird line\n"
+    input << "First line\nSecond line\nThird line\n\C-d"
     input.rewind
     answer = reader.read_multiline
     expect(answer).to eq(["First line\n", "Second line\n", "Third line\n"])
   end
 
+  it "skips empty lines" do
+    input << "\n\nFirst line\n\n\n\n\nSecond line\C-d"
+    input.rewind
+    answer = reader.read_multiline
+    expect(answer).to eq(["First line\n", "Second line"])
+  end
+
   it 'reads and yiels every line' do
-    input << "First line\nSecond line\nThird line"
+    input << "First line\nSecond line\nThird line\C-z"
     input.rewind
     lines = []
     reader.read_multiline { |line| lines << line }
@@ -37,7 +51,7 @@ RSpec.describe TTY::Prompt::Reader, '#read_multiline' do
   end
 
   it 'reads multibyte lines' do
-    input << "국경의 긴 터널을 빠져나오자\n설국이었다."
+    input << "국경의 긴 터널을 빠져나오자\n설국이었다.\C-d"
     input.rewind
     lines = []
     reader.read_multiline { |line| lines << line }

data/spec/unit/select_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe TTY::Prompt, '#select' do
     choices = {large: 1, medium: 2, small: 3}
     prompt.input << " "
     prompt.input.rewind
-    expect(prompt.select('What size?', choices)).to eq(1)
+    expect(prompt.select('What size?', choices, default: 1)).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#{symbols[:pointer]} large\e[0m\n",
@@ -216,6 +216,26 @@ RSpec.describe TTY::Prompt, '#select' do
     ].join)
   end
 
+  it "changes help text through DSL" do
+    choices = %w(Large Medium Small)
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?') do |menu|
+              menu.help "(Bash keyboard)"
+              menu.choices choices
+            end
+    expect(value).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Bash keyboard)\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? \e[32mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
   it "sets prompt prefix" do
     prompt = TTY::TestPrompt.new(prefix: '[?] ')
     choices = %w(Large Medium Small)
@@ -251,6 +271,25 @@ RSpec.describe TTY::Prompt, '#select' do
     ].join)
   end
 
+  it "paginates choices as hash object" do
+    prompt = TTY::TestPrompt.new
+    choices = {A: 1, B: 2, C: 3, D: 4, E: 5, F: 6, G: 7, H: 8}
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.select("What letter?", choices, per_page: 3, default: 4)
+    expect(value).to eq(4)
+    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]} D\e[0m\n",
+      "  E\n",
+      "  F\n",
+      "\e[90m(Move up or down to reveal more choices)\e[0m",
+      "\e[2K\e[1G\e[1A" * 4,
+      "\e[2K\e[1G",
+      "What letter? \e[32mD\e[0m\n\e[?25h",
+    ].join)
+  end
+
   it "paginates long selections through DSL" do
     prompt = TTY::TestPrompt.new
     choices = %w(A B C D E F G H)