tty-prompt 0.16.1 → 0.17.0

data/spec/unit/multiline_spec.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#multiline' do
+  it 'reads no lines' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?")
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \n"
+    ].join)
+  end
+
+  it "uses defualt when no input" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?", default: 'A super sweet prompt')
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \e[32mA super sweet prompt\e[0m\n"
+    ].join)
+  end
+
+  it "changes help text" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?") do |q|
+      q.default 'A super sweet prompt'
+      q.help '(Press thy ctrl-d to end)'
+    end
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press thy ctrl-d to end)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \e[32mA super sweet prompt\e[0m\n"
+    ].join)
+  end
+
+  it 'reads multiple lines with empty lines' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "aa\n\nbb\n\n\ncc\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?")
+    expect(answer).to eq(["aa\n", "bb\n", "cc"])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1Ga",
+      "\e[2K\e[1Gaa",
+      "\e[2K\e[1Gaa\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1Gb",
+      "\e[2K\e[1Gbb",
+      "\e[2K\e[1Gbb\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1Gc",
+      "\e[2K\e[1Gcc",
+      "\e[2K\e[1G\e[1A" * 6,
+      "\e[2K\e[1G",
+      "Description? \e[32maa ...\e[0m\n"
+    ].join)
+  end
+end

data/spec/unit/new_spec.rb

@@ -0,0 +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: "[?]", env: env)
+    expect(prompt.prefix).to eq("[?]")
+  end
+
+  it "sets input stream" do
+    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, env: env)
+    expect(prompt.output).to eq(:stream2)
+  end
+end

data/spec/unit/ok_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, 'ok' do
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'prints text in green' do
+    prompt.ok("All is fine")
+    expect(prompt.output.string).to eq("\e[32mAll is fine\e[0m\n")
+  end
+end

data/spec/unit/paginator_spec.rb

@@ -0,0 +1,73 @@
+# 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})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 2).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 3).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 4).to_a).to eq([['b',1], ['c',2], ['d',3]])
+    expect(paginator.paginate(list, 5).to_a).to eq([['c',2], ['d',3], ['e',4]])
+    expect(paginator.paginate(list, 6).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 7).to_a).to eq([['d',3], ['e',4], ['f',5]])
+  end
+
+  it "paginates items not matching per_page count" do
+    list = %w(a b c d e f g)
+    paginator = described_class.new({per_page: 3})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 2).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 3).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 4).to_a).to eq([['b',1], ['c',2], ['d',3]])
+    expect(paginator.paginate(list, 5).to_a).to eq([['c',2], ['d',3], ['e',4]])
+    expect(paginator.paginate(list, 6).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 7).to_a).to eq([['e',4], ['f',5], ['g',6]])
+    expect(paginator.paginate(list, 8).to_a).to eq([['e',4], ['f',5], ['g',6]])
+  end
+
+  it "finds maximum 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, 4)
+    expect(paginator.max_index).to eq(3)
+    paginator.paginate(list, 5)
+    expect(paginator.max_index).to eq(4)
+  end
+
+  it "starts with default selection" do
+    list = %w(a b c d e f g)
+    paginator = described_class.new({per_page: 3, default: 3})
+
+    expect(paginator.paginate(list, 4).to_a).to eq([['d',3], ['e',4], ['f',5]])
+  end
+
+  it "doesn't accept invalid pagination" do
+    list = %w(a b c d e f g)
+
+    paginator = described_class.new({per_page: 0})
+
+    expect {
+      paginator.paginate(list, 4)
+    }.to raise_error(TTY::Prompt::InvalidArgument, /per_page must be > 0/)
+  end
+end

data/spec/unit/question/checks_spec.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it "passes range check" do
+    question = described_class.new(prompt)
+    question.in 1..10
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 2)
+
+    expect(result).to eq([2])
+  end
+
+  it "fails range check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.in 1..10
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 11)
+
+    expect(result).to eq([11, ["Value 11 must be within the range 1..10"]])
+  end
+
+  it "fails range check" do
+    question = described_class.new(prompt)
+    question.in 1..10, 'Outside of range!'
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 11)
+
+    expect(result).to eq([11, ['Outside of range!']])
+  end
+
+  it "passes validation check" do
+    question = described_class.new(prompt)
+    question.validate(/\A\d{5}\Z/)
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, '12345')
+
+    expect(result).to eq(['12345'])
+  end
+
+  it "fails validation check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.validate(/\A\d{5}\Z/)
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, '123')
+
+    expect(result).to eq(['123', ['Your answer is invalid (must match /\\A\\d{5}\\Z/)']])
+  end
+
+  it "fails validation check with inlined custom message" do
+    question = described_class.new(prompt)
+    question.validate(/\A\w+@\w+\.\w+\Z/, 'Invalid email address')
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, 'piotr@com')
+
+    expect(result).to eq(['piotr@com', ['Invalid email address']])
+  end
+
+  it "fails validation check with custom message" do
+    question = described_class.new(prompt)
+    question.validate(/\A\w+@\w+\.\w+\Z/)
+    question.messages[:valid?] = 'Invalid email address'
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, 'piotr@com')
+
+    expect(result).to eq(['piotr@com', ['Invalid email address']])
+  end
+
+  it "passes required check" do
+    question = described_class.new(prompt)
+    question.required true
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, 'Piotr')
+
+    expect(result).to eq(['Piotr'])
+  end
+
+  it "fails required check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.required true
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, nil)
+
+    expect(result).to eq([nil, ['Value must be provided']])
+  end
+
+  it "fails required check with custom message" do
+    question = described_class.new(prompt)
+    question.required true, 'Required input'
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, nil)
+
+    expect(result).to eq([nil, ['Required input']])
+  end
+end

data/spec/unit/question/default_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#default' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'uses default value' do
+    name = 'Anonymous'
+    prompt.input << "\n"
+    prompt.input.rewind
+    answer = prompt.ask('What is your name?', default: name)
+    expect(answer).to eq(name)
+    expect(prompt.output.string).to eq([
+      "What is your name? \e[90m(Anonymous)\e[0m ",
+      "\e[2K\e[1GWhat is your name? \e[90m(Anonymous)\e[0m \n",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[32mAnonymous\e[0m\n"
+    ].join)
+  end
+
+  it 'uses default value in block' do
+    name = 'Anonymous'
+    answer = prompt.ask('What is your name?') { |q| q.default(name) }
+    expect(answer).to eq(name)
+    expect(prompt.output.string).to eq([
+      "What is your name? \e[90m(Anonymous)\e[0m ",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[32mAnonymous\e[0m\n"
+    ].join)
+  end
+end

data/spec/unit/question/echo_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#echo' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'asks with echo on' do
+    prompt.input << "password"
+    prompt.input.rewind
+    answer = prompt.ask("What is your password?") { |q| q.echo(true) }
+    expect(answer).to eql("password")
+    expect(prompt.output.string).to eq([
+      "What is your password? ",
+      "\e[2K\e[1GWhat is your password? p",
+      "\e[2K\e[1GWhat is your password? pa",
+      "\e[2K\e[1GWhat is your password? pas",
+      "\e[2K\e[1GWhat is your password? pass",
+      "\e[2K\e[1GWhat is your password? passw",
+      "\e[2K\e[1GWhat is your password? passwo",
+      "\e[2K\e[1GWhat is your password? passwor",
+      "\e[2K\e[1GWhat is your password? password",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[32mpassword\e[0m\n"
+    ].join)
+  end
+
+  it 'asks with echo off' do
+    prompt.input << "password"
+    prompt.input.rewind
+    answer = prompt.ask("What is your password?", echo: false)
+    expect(answer).to eql("password")
+    expect(prompt.output.string).to eq([
+      "What is your password? ",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \n"
+    ].join)
+  end
+end

data/spec/unit/question/in_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#in' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it "reads range from option" do
+    prompt.input << '8'
+    prompt.input.rewind
+
+    answer = prompt.ask("How do you like it on scale 1-10?", in: '1-10')
+
+    expect(answer).to eq('8')
+  end
+
+  it 'reads number within string range' do
+    prompt.input << '8'
+    prompt.input.rewind
+
+    answer = prompt.ask("How do you like it on scale 1-10?") do |q|
+      q.in('1-10')
+    end
+
+    expect(answer).to eq('8')
+    expect(prompt.output.string).to eq([
+      "How do you like it on scale 1-10? ",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8",
+      "\e[1A\e[2K\e[1G",
+      "How do you like it on scale 1-10? \e[32m8\e[0m\n",
+    ].join)
+  end
+
+  it 'reads number within digit range' do
+    prompt.input << '8.1'
+    prompt.input.rewind
+
+    answer = prompt.ask("How do you like it on scale 1-10?") do |q|
+      q.in(1.0..11.5)
+    end
+
+    expect(answer).to eq('8.1')
+    expect(prompt.output.string).to eq([
+      "How do you like it on scale 1-10? ",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8.",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8.1",
+      "\e[1A\e[2K\e[1G",
+      "How do you like it on scale 1-10? \e[32m8.1\e[0m\n",
+    ].join)
+  end
+
+  it 'reads letters within range' do
+    prompt.input << 'E'
+    prompt.input.rewind
+
+    answer = prompt.ask("Your favourite vitamin? (A-K)") do |q|
+      q.in('A-K')
+    end
+
+    expect(answer).to eq('E')
+    expect(prompt.output.string).to eq([
+      "Your favourite vitamin? (A-K) ",
+      "\e[2K\e[1GYour favourite vitamin? (A-K) E",
+      "\e[1A\e[2K\e[1G",
+      "Your favourite vitamin? (A-K) \e[32mE\e[0m\n"
+    ].join)
+  end
+
+  it "provides default error message when wrong input" do
+    prompt.input << "A\n2\n"
+    prompt.input.rewind
+
+    answer = prompt.ask("How spicy on scale? (1-5)", in: '1-5')
+
+    expect(answer).to eq('2')
+    expect(prompt.output.string).to eq([
+      "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A\n",
+      "\e[31m>>\e[0m Value A must be within the range 1..5\e[1A",
+      "\e[2K\e[1G",
+      "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2\n",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "How spicy on scale? (1-5) \e[32m2\e[0m\n"
+    ].join)
+  end
+
+  it "overwrites default error message when wrong input" do
+    prompt.input << "A\n2\n"
+    prompt.input.rewind
+
+    answer = prompt.ask("How spicy on scale? (1-5)") do |q|
+      q.in '1-5'
+      q.messages[:range?] = 'Ohh dear what is this %{value} doing in %{in}?'
+    end
+
+    expect(answer).to eq('2')
+    expect(prompt.output.string).to eq([
+      "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A\n",
+      "\e[31m>>\e[0m Ohh dear what is this A doing in 1..5?\e[1A",
+      "\e[2K\e[1G",
+      "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2\n",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "How spicy on scale? (1-5) \e[32m2\e[0m\n"
+    ].join)
+  end
+end