tty-prompt 0.16.1 → 0.17.0

data/spec/unit/slider_spec.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+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? ",
+      symbols[:line] * 6,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 5} 44",
+      "\n\e[90m(Use arrow keys, press Enter to select)\e[0m",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? \e[32m44\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "specifies default value" do
+    prompt.input << "\r"
+    prompt.input.rewind
+    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? ",
+      symbols[:line] * 3,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 8} 38",
+      "\n\e[90m(Use arrow keys, press Enter to select)\e[0m",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? \e[32m38\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "specifies range through DSL" do
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.slider('What size?') do |range|
+              range.default 6
+              range.min 0
+              range.max 20
+              range.step 2
+              range.format "|:slider| %d%%"
+            end
+    expect(value).to eq(6)
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? ",
+      symbols[:pipe] + symbols[:line] * 3,
+      "\e[32m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 7 + symbols[:pipe]} 6%",
+      "\n\e[90m(Use arrow keys, press Enter to select)\e[0m",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? \e[32m6\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "changes display colors" do
+    prompt.input << "\r"
+    prompt.input.rewind
+    options = {active_color: :red, help_color: :cyan}
+    expect(prompt.slider('What size?', options)).to eq(5)
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? ",
+      symbols[:line] * 5,
+      "\e[31m#{symbols[:handle]}\e[0m",
+      "#{symbols[:line] * 5} 5",
+      "\n\e[36m(Use arrow keys, press Enter to select)\e[0m",
+      "\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? ",
+      symbols[:line] * 10,
+      "\e[32m#{symbols[:handle]}\e[0m 10",
+      "\n\e[90m(Use arrow keys, press Enter to select)\e[0m",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "What size? ",
+      symbols[:line] * 10,
+      "\e[32m#{symbols[:handle]}\e[0m 10",
+      "\e[2K\e[1G",
+      "What size? \e[32m10\e[0m\n\e[?25h"
+    ].join)
+  end
+end

data/spec/unit/statement/initialize_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Statement, '#new' do
+  it "forces newline after the prompt message" do
+    prompt = TTY::TestPrompt.new
+    statement = described_class.new(prompt)
+    expect(statement.newline).to eq(true)
+  end
+
+  it "displays prompt message in color" do
+    prompt = TTY::TestPrompt.new
+    statement = described_class.new(prompt)
+    expect(statement.color).to eq(false)
+  end
+end

data/spec/unit/subscribe_spec.rb

@@ -0,0 +1,20 @@
+RSpec.describe TTY::Prompt, '#subscribe' do
+  it "subscribes to key events only for the current prompt" do
+    prompt = TTY::TestPrompt.new
+    uuid = '14c3b412-e0c5-4ff5-9cd8-25ec3f18c702'
+    prompt.input << "3\n#{uuid}\n"
+    prompt.input.rewind
+    keys = []
+
+    prompt.on(:keypress) do |event|
+      keys << :enter if event.key.name == :enter
+    end
+
+    letter = prompt.enum_select('Select something', ('A'..'Z').to_a)
+    id = prompt.ask('Request ID?')
+
+    expect(letter).to eq('C')
+    expect(id).to eq(uuid)
+    expect(keys).to eq([:enter, :enter])
+  end
+end

data/spec/unit/suggest_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#suggest' do
+  let(:possible) { %w(status stage stash commit branch blame) }
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'suggests few matches' do
+    prompt.suggest('sta', possible)
+    expect(prompt.output.string).
+      to eql("Did you mean one of these?\n        stage\n        stash\n")
+  end
+
+  it 'suggests a single match for one character' do
+    prompt.suggest('b', possible)
+    expect(prompt.output.string).to eql("Did you mean this?\n        blame\n")
+  end
+
+  it 'suggests a single match for two characters' do
+    prompt.suggest('co', possible)
+    expect(prompt.output.string).to eql("Did you mean this?\n        commit\n")
+  end
+
+  it 'suggests with different text and indentation' do
+    prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
+    expect(prompt.output.string).to eql("Perhaps you meant?\n    blame\n")
+  end
+end

data/spec/unit/warn_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#warn' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'displays one message' do
+    prompt.warn "Careful young apprentice!"
+    expect(prompt.output.string).to eql "\e[33mCareful young apprentice!\e[0m\n"
+  end
+
+  it 'displays many messages' do
+    prompt.warn "Careful there!", "It's dangerous!"
+    expect(prompt.output.string).to eql "\e[33mCareful there!\e[0m\n\e[33mIt's dangerous!\e[0m\n"
+  end
+
+  it 'displays message with option' do
+    prompt.warn "Careful young apprentice!", newline: false
+    expect(prompt.output.string).to eql "\e[33mCareful young apprentice!\e[0m"
+  end
+end

data/spec/unit/yes_no_spec.rb

@@ -0,0 +1,235 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, 'confirmation' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  context '#yes?' do
+    it 'agrees with question' do
+      prompt.input << 'yes'
+      prompt.input.rewind
+      expect(prompt.yes?("Are you a human?")).to eq(true)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Y/n)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m y",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m ye",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m yes",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mYes\e[0m\n"
+      ].join)
+    end
+
+    it 'disagrees with question' do
+      prompt.input << 'no'
+      prompt.input.rewind
+      expect(prompt.yes?("Are you a human?")).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Y/n)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m n",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m no",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mno\e[0m\n"
+      ].join)
+    end
+
+    it 'assumes default true' do
+      prompt.input << "\r"
+      prompt.input.rewind
+      expect(prompt.yes?("Are you a human?")).to eq(true)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Y/n)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m \n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mYes\e[0m\n"
+      ].join)
+    end
+
+    it 'changes default' do
+      prompt.input << "\n"
+      prompt.input.rewind
+      expect(prompt.yes?("Are you a human?", default: false)).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(y/N)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m \n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mNo\e[0m\n"
+      ].join)
+    end
+
+    it "defaults suffix and converter" do
+      prompt.input << "Nope\n"
+      prompt.input.rewind
+      result = prompt.yes?("Are you a human?") do |q|
+        q.positive 'Yup'
+        q.negative 'nope'
+      end
+      expect(result).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Yup/nope)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m N",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m No",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nop",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nope",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nope\n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mnope\e[0m\n"
+      ].join)
+    end
+
+    it "defaults positive and negative" do
+      prompt.input << "Nope\n"
+      prompt.input.rewind
+      result = prompt.yes?("Are you a human?") do |q|
+        q.suffix 'Yup/nope'
+      end
+      expect(result).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Yup/nope)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m N",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m No",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nop",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nope",
+        "\e[2K\e[1GAre you a human? \e[90m(Yup/nope)\e[0m Nope\n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mnope\e[0m\n"
+      ].join)
+    end
+
+    it "customizes question through options" do
+      prompt.input << "\r"
+      prompt.input.rewind
+      result = prompt.yes?("Are you a human?", suffix: 'Agree/Disagree',
+                            positive: 'Agree', negative: 'Disagree')
+      expect(result).to eq(true)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Agree/Disagree)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m \n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mAgree\e[0m\n"
+      ].join)
+    end
+
+    it "customizes question through DSL" do
+      prompt.input << "disagree\r"
+      prompt.input.rewind
+      conversion = proc { |input| !input.match(/^agree$/i).nil? }
+      result = prompt.yes?("Are you a human?") do |q|
+                 q.suffix 'Agree/Disagree'
+                 q.positive 'Agree'
+                 q.negative 'Disagree'
+                 q.convert conversion
+               end
+      expect(result).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Agree/Disagree)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m d",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m di",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m dis",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disa",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disag",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disagr",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disagre",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disagree",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m disagree\n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mDisagree\e[0m\n"
+      ].join)
+    end
+  end
+
+  context '#no?' do
+    it 'agrees with question' do
+      prompt.input << 'no'
+      prompt.input.rewind
+      expect(prompt.no?("Are you a human?")).to eq(true)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(y/N)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m n",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m no",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mNo\e[0m\n"
+      ].join)
+    end
+
+    it 'disagrees with question' do
+      prompt.input << 'yes'
+      prompt.input.rewind
+      expect(prompt.no?("Are you a human?")).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(y/N)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m y",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m ye",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m yes",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32myes\e[0m\n"
+      ].join)
+    end
+
+    it 'assumes default false' do
+      prompt.input << "\r"
+      prompt.input.rewind
+      expect(prompt.no?("Are you a human?")).to eq(true)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(y/N)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(y/N)\e[0m \n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mNo\e[0m\n"
+      ].join)
+    end
+
+    it 'changes default' do
+      prompt.input << "\r"
+      prompt.input.rewind
+      expect(prompt.no?("Are you a human?", default: true)).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Y/n)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Y/n)\e[0m \n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mYes\e[0m\n"
+      ].join)
+    end
+
+    it "defaults suffix and converter" do
+      prompt.input << "Yup\n"
+      prompt.input.rewind
+      result = prompt.no?("Are you a human?") do |q|
+        q.positive 'yup'
+        q.negative 'Nope'
+      end
+      expect(result).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(yup/Nope)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(yup/Nope)\e[0m Y",
+        "\e[2K\e[1GAre you a human? \e[90m(yup/Nope)\e[0m Yu",
+        "\e[2K\e[1GAre you a human? \e[90m(yup/Nope)\e[0m Yup",
+        "\e[2K\e[1GAre you a human? \e[90m(yup/Nope)\e[0m Yup\n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32myup\e[0m\n"
+      ].join)
+    end
+
+    it "customizes question through DSL" do
+      prompt.input << "agree\r"
+      prompt.input.rewind
+      conversion = proc { |input| !input.match(/^agree$/i).nil? }
+      result = prompt.no?("Are you a human?") do |q|
+                 q.suffix 'Agree/Disagree'
+                 q.positive 'Agree'
+                 q.negative 'Disagree'
+                 q.convert conversion
+               end
+      expect(result).to eq(false)
+      expect(prompt.output.string).to eq([
+        "Are you a human? \e[90m(Agree/Disagree)\e[0m ",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m a",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m ag",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m agr",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m agre",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m agree",
+        "\e[2K\e[1GAre you a human? \e[90m(Agree/Disagree)\e[0m agree\n",
+        "\e[1A\e[2K\e[1G",
+        "Are you a human? \e[32mAgree\e[0m\n"
+      ].join)
+    end
+  end
+end

data/tty-prompt.gemspec

@@ -13,11 +13,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-                          f.match(%r{^(test|spec|features)/})
-                        end
+  spec.files         = Dir["README.md", "LICENSE.txt", "Rakefile", "lib/**/*.rb", "examples/**/*.rb", "tasks/**", "tty-prompt.gemspec"]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = Dir["spec/**/*.rb"]
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.0.0'
@@ -25,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'necromancer',  '~> 0.4.0'
   spec.add_dependency 'pastel',       '~> 0.7.0'
   spec.add_dependency 'timers',       '~> 4.0'
-  spec.add_dependency 'tty-cursor',   '~> 0.5.0'
-  spec.add_dependency 'tty-reader',   '~> 0.3.0'
+  spec.add_dependency 'tty-cursor',   '~> 0.6.0'
+  spec.add_dependency 'tty-reader',   '~> 0.4.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake'