tty-prompt 0.16.1 → 0.17.0

data/spec/unit/question/initialize_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#initialize' do
+
+  subject(:question) { described_class.new(TTY::TestPrompt.new)}
+
+  it { expect(question.echo).to eq(true) }
+
+  it { expect(question.modifier).to eq([]) }
+
+  it { expect(question.validation).to eq(TTY::Prompt::Question::UndefinedSetting) }
+end

data/spec/unit/question/modifier/apply_to_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question::Modifier, '#apply_to' do
+  let(:string)   { "text   to   be    modified"}
+
+  it "doesn't apply modifiers" do
+    modifier = described_class.new([])
+    expect(modifier.apply_to(string)).to eq(string)
+  end
+
+  it 'combines whitespace & letter case modifications' do
+    modifiers = [:collapse, :capitalize]
+    modifier = described_class.new(modifiers)
+    modified = modifier.apply_to(string)
+    expect(modified).to eq('Text to be modified')
+  end
+
+  it 'combines letter case & whitespace modifications' do
+    modifiers = [:up, :collapse]
+    modifier = described_class.new(modifiers)
+    modified = modifier.apply_to(string)
+    expect(modified).to eq('TEXT TO BE MODIFIED')
+  end
+end

data/spec/unit/question/modifier/letter_case_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question::Modifier, '#letter_case' do
+  context "string" do
+    let(:string) { 'text to modify' }
+
+    it "changes to uppercase" do
+      modified = described_class.letter_case(:up, string)
+      expect(modified).to eq('TEXT TO MODIFY')
+    end
+
+    it "changes to lower case" do
+      modified = described_class.letter_case(:down, string)
+      expect(modified).to eq('text to modify')
+    end
+
+    it "capitalizes text" do
+      modified = described_class.letter_case(:capitalize, string)
+      expect(modified).to eq('Text to modify')
+    end
+  end
+
+  context "nil (empty user input)" do
+    let(:string) { nil }
+
+    example "up returns nil" do
+      modified = described_class.letter_case(:up, string)
+      expect(modified).to be_nil
+    end
+
+    example "down returns nil" do
+      modified = described_class.letter_case(:down, string)
+      expect(modified).to be_nil
+    end
+
+    example "capitalize returns nil" do
+      modified = described_class.letter_case(:capitalize, string)
+      expect(modified).to be_nil
+    end
+  end
+end

data/spec/unit/question/modifier/whitespace_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question::Modifier, '#whitespace' do
+  context "string with whitespaces" do
+    let(:string) { "  text\t \n  to\t   modify\r\n" }
+
+    it "trims whitespace" do
+      modified = described_class.whitespace(:trim, string)
+      expect(modified).to eq("text\t \n  to\t   modify")
+    end
+
+    it "chomps whitespace" do
+      modified = described_class.whitespace(:chomp, string)
+      expect(modified).to eq("  text\t \n  to\t   modify")
+    end
+
+    it "collapses text" do
+      modified = described_class.whitespace(:collapse, string)
+      expect(modified).to eq(" text to modify ")
+    end
+
+    it "removes whitespace" do
+      modified = described_class.whitespace(:remove, string)
+      expect(modified).to eq("texttomodify")
+    end
+  end
+
+  context "nil (empty user input)" do
+    let(:string) { nil }
+
+    example "trim returns nil" do
+      modified = described_class.whitespace(:trim, string)
+      expect(modified).to be_nil
+    end
+
+    example "chomp returns nil" do
+      modified = described_class.whitespace(:chomp, string)
+      expect(modified).to be_nil
+    end
+
+    example "collapse returns nil" do
+      modified = described_class.whitespace(:collapse, string)
+      expect(modified).to be_nil
+    end
+
+    example "remove returns nil" do
+      modified = described_class.whitespace(:remove, string)
+      expect(modified).to be_nil
+    end
+  end
+end

data/spec/unit/question/modify_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#modify' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'preserves answer for unkown modification' do
+    prompt.input << 'piotr'
+    prompt.input.rewind
+    answer = prompt.ask("What is your name?") { |q| q.modify(:none) }
+    expect(answer).to eq('piotr')
+  end
+
+  it 'converts to upper case' do
+    prompt.input << 'piotr'
+    prompt.input.rewind
+    answer = prompt.ask("What is your name?") { |q| q.modify(:upcase) }
+    expect(answer).to eq('PIOTR')
+  end
+
+  it 'trims whitespace' do
+    prompt.input << " Some   white\t   space\t \there!   \n"
+    prompt.input.rewind
+    answer = prompt.ask('Enter some text: ') { |q| q.modify(:trim) }
+    expect(answer).to eq("Some   white\t   space\t \there!")
+  end
+
+  it 'collapses whitespace' do
+    prompt.input << " Some   white\t   space\t \there!   \n"
+    prompt.input.rewind
+    answer = prompt.ask('Enter some text: ') { |q| q.modify(:collapse) }
+    expect(answer).to eq(' Some white space here! ')
+  end
+
+  it 'strips and collapses whitespace' do
+    prompt.input << " Some   white\t   space\t \there!   \n"
+    prompt.input.rewind
+    answer = prompt.ask('Enter some text: ') { |q| q.modify(:strip, :collapse) }
+    expect(answer).to eq('Some white space here!')
+  end
+end

data/spec/unit/question/required_spec.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#required' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'requires value to be present' do
+    prompt.input << "Piotr"
+    prompt.input.rewind
+    prompt.ask('What is your name?') { |q| q.required(true) }
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[2K\e[1GWhat is your name? P",
+      "\e[2K\e[1GWhat is your name? Pi",
+      "\e[2K\e[1GWhat is your name? Pio",
+      "\e[2K\e[1GWhat is your name? Piot",
+      "\e[2K\e[1GWhat is your name? Piotr",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[32mPiotr\e[0m\n"
+    ].join)
+  end
+
+  it 'requires value to be present with option' do
+    prompt.input << "  \nPiotr"
+    prompt.input.rewind
+    prompt.ask('What is your name?', required: true)
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[2K\e[1GWhat is your name?  ",
+      "\e[2K\e[1GWhat is your name?   ",
+      "\e[2K\e[1GWhat is your name?   \n",
+      "\e[31m>>\e[0m Value must be provided\e[1A",
+      "\e[2K\e[1G",
+      "What is your name? ",
+      "\e[2K\e[1GWhat is your name? P",
+      "\e[2K\e[1GWhat is your name? Pi",
+      "\e[2K\e[1GWhat is your name? Pio",
+      "\e[2K\e[1GWhat is your name? Piot",
+      "\e[2K\e[1GWhat is your name? Piotr",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[32mPiotr\e[0m\n"
+    ].join)
+  end
+
+  it "doesn't require value to be present" do
+    prompt.input << ''
+    prompt.input.rewind
+    answer = prompt.ask('What is your name?') { |q| q.required(false) }
+    expect(answer).to be_nil
+  end
+
+  it "uses required in validation check" do
+    prompt.input << "  \nexists\ntest\n"
+    prompt.input.rewind
+    answer = prompt.ask('File name?') do |q|
+      q.required(true)
+      q.validate { |v| !(v =~ /exists/) }
+      q.messages[:required?] = 'File name must not be empty!'
+      q.messages[:valid?]   = 'File already exists!'
+    end
+    expect(answer).to eq('test')
+    expect(prompt.output.string).to eq([
+      "File name? ",
+      "\e[2K\e[1GFile name?  ",
+      "\e[2K\e[1GFile name?   ",
+      "\e[2K\e[1GFile name?   \n",
+      "\e[31m>>\e[0m File name must not be empty!",
+      "\e[1A\e[2K\e[1G",
+      "File name? ",
+      "\e[2K\e[1GFile name? e",
+      "\e[2K\e[1GFile name? ex",
+      "\e[2K\e[1GFile name? exi",
+      "\e[2K\e[1GFile name? exis",
+      "\e[2K\e[1GFile name? exist",
+      "\e[2K\e[1GFile name? exists",
+      "\e[2K\e[1GFile name? exists\n",
+      "\e[31m>>\e[0m File already exists!",
+      "\e[1A\e[2K\e[1G",
+      "File name? ",
+      "\e[2K\e[1GFile name? t",
+      "\e[2K\e[1GFile name? te",
+      "\e[2K\e[1GFile name? tes",
+      "\e[2K\e[1GFile name? test",
+      "\e[2K\e[1GFile name? test\n",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "File name? \e[32mtest\e[0m\n",
+    ].join)
+    expect(answer).to eq('test')
+  end
+end

data/spec/unit/question/validate_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#validate' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'validates input with regex' do
+    prompt.input << 'p.m'
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your username?') do |q|
+      q.validate(/^[^\.]+\.[^\.]+/)
+    end
+
+    expect(answer).to eq('p.m')
+    expect(prompt.output.string).to eq([
+      "What is your username? ",
+      "\e[2K\e[1GWhat is your username? p",
+      "\e[2K\e[1GWhat is your username? p.",
+      "\e[2K\e[1GWhat is your username? p.m",
+      "\e[1A\e[2K\e[1G",
+      "What is your username? \e[32mp.m\e[0m\n"
+    ].join)
+  end
+
+  it 'validates input with proc' do
+    prompt.input << 'piotr.murach'
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your username?') do |q|
+      q.validate { |input| input =~ /^[^\.]+\.[^\.]+/ }
+    end
+
+    expect(answer).to eq('piotr.murach')
+  end
+
+  it 'understands custom validation like :email' do
+    prompt.input << 'piotr@example.com'
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your email?') do |q|
+      q.validate :email
+    end
+
+    expect(answer).to eq('piotr@example.com')
+  end
+
+  it "provides default error message for wrong input" do
+    prompt.input << "wrong\np@m.com\n"
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your email?') do |q|
+      q.validate :email
+    end
+
+    expect(answer).to eq('p@m.com')
+    expect(prompt.output.string).to eq([
+      "What is your email? ",
+      "\e[2K\e[1GWhat is your email? w",
+      "\e[2K\e[1GWhat is your email? wr",
+      "\e[2K\e[1GWhat is your email? wro",
+      "\e[2K\e[1GWhat is your email? wron",
+      "\e[2K\e[1GWhat is your email? wrong",
+      "\e[2K\e[1GWhat is your email? wrong\n",
+      "\e[31m>>\e[0m Your answer is invalid (must match :email)\e[1A",
+      "\e[2K\e[1G",
+      "What is your email? ",
+      "\e[2K\e[1GWhat is your email? p",
+      "\e[2K\e[1GWhat is your email? p@",
+      "\e[2K\e[1GWhat is your email? p@m",
+      "\e[2K\e[1GWhat is your email? p@m.",
+      "\e[2K\e[1GWhat is your email? p@m.c",
+      "\e[2K\e[1GWhat is your email? p@m.co",
+      "\e[2K\e[1GWhat is your email? p@m.com",
+      "\e[2K\e[1GWhat is your email? p@m.com\n",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "What is your email? \e[32mp@m.com\e[0m\n"
+    ].join)
+  end
+
+  it "provides custom error message for wrong input" do
+    prompt.input << "wrong\np@m.com"
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your email?') do |q|
+      q.validate :email
+      q.messages[:valid?] = 'Not an email!'
+    end
+
+    expect(answer).to eq('p@m.com')
+    expect(prompt.output.string).to eq([
+      "What is your email? ",
+      "\e[2K\e[1GWhat is your email? w",
+      "\e[2K\e[1GWhat is your email? wr",
+      "\e[2K\e[1GWhat is your email? wro",
+      "\e[2K\e[1GWhat is your email? wron",
+      "\e[2K\e[1GWhat is your email? wrong",
+      "\e[2K\e[1GWhat is your email? wrong\n",
+      "\e[31m>>\e[0m Not an email!\e[1A",
+      "\e[2K\e[1G",
+      "What is your email? ",
+      "\e[2K\e[1GWhat is your email? p",
+      "\e[2K\e[1GWhat is your email? p@",
+      "\e[2K\e[1GWhat is your email? p@m",
+      "\e[2K\e[1GWhat is your email? p@m.",
+      "\e[2K\e[1GWhat is your email? p@m.c",
+      "\e[2K\e[1GWhat is your email? p@m.co",
+      "\e[2K\e[1GWhat is your email? p@m.com",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
+      "What is your email? \e[32mp@m.com\e[0m\n"
+    ].join)
+  end
+end

data/spec/unit/question/validation/call_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question::Validation, '#call' do
+  let(:pattern) { /^[^\.]+\.[^\.]+/ }
+
+  it "validates nil input" do
+    validation = described_class.new(pattern)
+    expect(validation.(nil)).to eq(false)
+  end
+
+  it "validates successfully when the value matches pattern" do
+    validation = described_class.new(pattern)
+    expect(validation.('piotr.murach')).to eq(true)
+  end
+
+  it "validates with a proc" do
+    pat = proc { |input| !pattern.match(input).nil? }
+    validation = described_class.new(pat)
+    expect(validation.call('piotr.murach')).to eq(true)
+  end
+
+  it "validates with custom name" do
+    validation = described_class.new(:email)
+    expect(validation.call('piotr@example.com')).to eq(true)
+  end
+
+  it "fails validation when not maching pattern" do
+    validation = described_class.new(pattern)
+    expect(validation.('piotrmurach')).to eq(false)
+  end
+end

data/spec/unit/question/validation/coerce_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question::Validation, '#coerce' do
+  let(:instance) { described_class.new }
+
+  it "coerces lambda into proc" do
+    pattern = lambda { "^[^\.]+\.[^\.]+" }
+    validation = described_class.new(pattern)
+    expect(validation.pattern).to be_a(Proc)
+  end
+
+  it "doesn't coerce symbols" do
+    pattern = :email
+    validation =described_class.new(pattern)
+    expect(validation.pattern).to eq(:email)
+  end
+
+  it "coerces into regex" do
+    pattern = /^[^\.]+\.[^\.]+/
+    validation = described_class.new(pattern)
+    expect(validation.pattern).to be_a(Regexp)
+  end
+
+  it "fails to coerce pattern into validation" do
+    pattern = Object.new
+    expect {
+      described_class.new(pattern)
+    }.to raise_error(TTY::Prompt::ValidationCoercion)
+  end
+end