tty-prompt 0.16.1 → 0.17.0

data/spec/unit/evaluator_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Evaluator do
+  it "checks chained validation procs" do
+    question = double(:question)
+    evaluator = TTY::Prompt::Evaluator.new(question)
+
+    evaluator.check { |quest, value|
+      if value < 21
+        [value, ["#{value} is not bigger than 21"]]
+      else
+        value
+      end
+    }
+
+    evaluator.check { |quest, value|
+      if value < 42
+        [value, ["#{value} is not bigger than 42"]]
+      else
+        value
+      end
+    }
+
+    answer = evaluator.call(2)
+    expect(answer.errors.count).to eq(2)
+    expect(answer.value).to eq(2)
+    expect(answer.success?).to eq(false)
+    expect(answer.failure?).to eq(true)
+  end
+
+  it "checks chained validation objects" do
+    question = double(:question)
+    evaluator = TTY::Prompt::Evaluator.new(question)
+
+    LessThan21 = Class.new do
+      def self.call(quest, value)
+        if value < 21
+          [value, ["#{value} is not bigger than 21"]]
+        else
+          value
+        end
+      end
+    end
+
+    LessThan42 = Class.new do
+      def self.call(quest, value)
+        if value < 42
+          [value, ["#{value} is not bigger than 42"]]
+        else
+          value
+        end
+      end
+    end
+
+    evaluator.check(LessThan21)
+    evaluator.check(LessThan42)
+
+    answer = evaluator.call(2)
+    expect(answer.errors).to match_array([
+      "2 is not bigger than 21",
+      "2 is not bigger than 42"
+    ])
+    expect(answer.value).to eq(2)
+    expect(answer.success?).to eq(false)
+    expect(answer.failure?).to eq(true)
+  end
+end

data/spec/unit/expand_spec.rb

@@ -0,0 +1,198 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#expand' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  let(:choices) {
+    [{
+      key: 'y',
+      name: 'Overwrite',
+      value: :yes
+    }, {
+      key: 'n',
+      name: 'Skip',
+      value: :no
+    }, {
+      key: 'a',
+      name: 'Overwrite all',
+      value: :all
+    }, {
+      key: 'd',
+      name: 'Show diff',
+      value: :diff
+    }, {
+      key: 'q',
+      name: 'Quit',
+      value: :quit
+    }]
+  }
+
+  it "expands default option" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:yes)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
+    ].join)
+  end
+
+  it "changes default option" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices, default: 3)
+    expect(result).to eq(:all)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
+    ].join)
+  end
+
+  it "expands chosen option with extra information" do
+    prompt.input << "a\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:all)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
+      "a\n",
+      "\e[32m>> \e[0mOverwrite all",
+      "\e[A\e[1G\e[55C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
+    ].join)
+  end
+
+  it "expands help option and then defaults" do
+    prompt.input << "h\nd\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:diff)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,d,q,\e[32mh\e[0m] h\n",
+      "\e[32m>> \e[0mprint help",
+      "\e[A\e[1G\e[55C",
+      "\e[2K\e[1G",
+      "\e[1B",
+      "\e[2K\e[1G",
+      "\e[A\e[1G",
+      "Overwrite Gemfile? \n",
+      "  y - Overwrite\n",
+      "  n - Skip\n",
+      "  a - Overwrite all\n",
+      "  d - Show diff\n",
+      "  q - Quit\n",
+      "  h - print help\n",
+      "  Choice [y]: ",
+      "\e[2K\e[1G\e[1A" * 7,
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \n",
+      "  y - Overwrite\n",
+      "  n - Skip\n",
+      "  a - Overwrite all\n",
+      "  \e[32md - Show diff\e[0m\n",
+      "  q - Quit\n",
+      "  h - print help\n",
+      "  Choice [y]: d",
+      "\e[2K\e[1G\e[1A" * 7,
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \e[32mShow diff\e[0m\n",
+    ].join)
+  end
+
+  it "specifies options through DSL" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?') do |q|
+      q.default 4
+
+      q.choice key: 'y', name: 'Overwrite',     value: :yes
+      q.choice key: 'n', name: 'Skip',          value: :no
+      q.choice key: 'a', name: 'Overwrite all', value: :all
+      q.choice key: 'd', name: 'Show diff',     value: :diff
+      q.choice key: 'q', name: 'Quit',          value: :quit
+    end
+
+    expect(result).to eq(:diff)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,\e[32md\e[0m,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \e[32mShow diff\e[0m\n"
+    ].join)
+  end
+
+  it "specifies options through DSL and executes value" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?') do |q|
+      q.choice key: 'y', name: 'Overwrite'      do :ok end
+      q.choice key: 'n', name: 'Skip',          value: :no
+      q.choice key: 'a', name: 'Overwrite all', value: :all
+      q.choice key: 'd', name: 'Show diff',     value: :diff
+      q.choice key: 'q', name: 'Quit',          value: :quit
+    end
+
+    expect(result).to eq(:ok)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[2K\e[1G",
+      "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
+    ].join)
+  end
+
+  it "fails to expand due to lack of key attribute" do
+    choices = [{ name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice Overwrite is missing a :key attribute/)
+  end
+
+  it "fails to expand due to wrong key length" do
+    choices = [{ key: 'long', name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `long` is more than one character long/)
+  end
+
+  it "fails to expand due to reserve key" do
+    choices = [{ key: 'h', name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `h` is reserved for help menu/)
+  end
+
+  it "fails to expand due to duplicate key" do
+    choices = [{ key: 'y', name: 'Overwrite', value: :yes },
+               { key: 'y', name: 'Change', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `y` is a duplicate/)
+  end
+end

data/spec/unit/keypress_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question, '#keypress' do
+  it 'receives line feed with echo on' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    answer = prompt.keypress("Press key:", echo: true)
+
+    expect(answer).to eq("\n")
+    expect(prompt.output.string).to eq([
+      "Press key: ",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Press key: \e[32m\n\e[0m\n",
+    ].join)
+  end
+
+  it 'asks for a keypress with echo on' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "abcd"
+    prompt.input.rewind
+
+    answer = prompt.keypress("Press key:", echo: true)
+
+    expect(answer).to eq("a")
+    expect(prompt.output.string).to eq([
+      "Press key: ",
+      "\e[2K\e[1G",
+      "Press key: \e[32ma\e[0m\n",
+    ].join)
+  end
+
+  it 'asks for a keypress with echo off' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "abcd"
+    prompt.input.rewind
+
+    answer = prompt.keypress("Press key:")
+
+    expect(answer).to eq("a")
+    expect(prompt.output.string).to eq([
+      "Press key: ",
+      "\e[2K\e[1G",
+      "Press key: \n",
+    ].join)
+  end
+
+  it "interrupts input" do
+    prompt = TTY::TestPrompt.new(interrupt: :exit)
+    prompt.input << "\x03"
+    prompt.input.rewind
+
+    expect {
+      prompt.keypress("Press key:")
+    }.to raise_error(SystemExit)
+  end
+
+  it "timeouts when no key provided" do
+    prompt = TTY::TestPrompt.new(interrupt: :exit)
+
+    prompt.keypress("Press any key or continue in :countdown", timeout: 0.1)
+
+    expect(prompt.output.string).to eq([
+      "Press any key or continue in 0.1 ",
+      "\e[2K\e[1G",
+      "Press any key or continue in 0 ",
+      "\e[2K\e[1G",
+      "Press any key or continue in 0 \n"
+    ].join)
+  end
+end

data/spec/unit/mask_spec.rb

@@ -0,0 +1,132 @@
+# encoding: utf-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
+    answer = prompt.mask("What is your password?")
+    expect(answer).to eql("pass")
+    expect(prompt.output.string).to eq([
+      "What is your password? ",
+      "\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
+
+  it 'masks output with custom character' do
+    prompt.input << "pass\r"
+    prompt.input.rewind
+    answer = prompt.mask("What is your password?") { |q| q.mask('*') }
+    expect(answer).to eql("pass")
+    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[2K\e[1G",
+      "What is your password? ****",
+      "\e[2K\e[1G",
+      "What is your password? \e[32m****\e[0m\n",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[32m****\e[0m\n",
+    ].join)
+  end
+
+  it "masks with unicode character" do
+    prompt.input << "lov\n"
+    prompt.input.rewind
+    answer = prompt.mask("What is your password?", mask: "\u2665")
+    expect(answer).to eql("lov")
+    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[2K\e[1G",
+      "What is your password? \e[32m♥♥♥\e[0m\n",
+      "\e[1A\e[2K\e[1G",
+      "What is your password? \e[32m♥♥♥\e[0m\n",
+    ].join)
+  end
+
+  it 'ignores mask if echo is off' do
+    prompt.input << "pass\n"
+    prompt.input.rewind
+    answer = prompt.mask('What is your password?') do |q|
+      q.echo false
+      q.mask '*'
+    end
+    expect(answer).to eql("pass")
+    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[2K\e[1G",
+      "What is your password? ",
+      "\e[2K\e[1G",
+      "What is your password? \n",
+      "\e[1A\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