tty-prompt 0.1.0 → 0.2.0

data/spec/unit/response/read_string_spec.rb

@@ -2,18 +2,13 @@
 
 require 'spec_helper'
 
-RSpec.describe TTY::Prompt::Question, '#initialize' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prompt)  { TTY::Prompt.new(input, output) }
-
+RSpec.describe TTY::Prompt::Question, '#read_string' do
   it 'reads string' do
-    name = "Piotr"
-    input << name
-    input.rewind
-    q = prompt.ask("What is your name?")
-    answer = q.read_string
-    expect(answer).to be_kind_of String
-    expect(answer).to eql name
+    prompt = TTY::TestPrompt.new
+    prompt.input << 'Piotr'
+    prompt.input.rewind
+    answer = prompt.ask("What is your name?", read: :string)
+    expect(answer).to be_a(String)
+    expect(answer).to eq('Piotr')
   end
 end

data/spec/unit/say_spec.rb

@@ -3,64 +3,60 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt, '#say' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
   let(:color)  { Pastel.new(enabled: true) }
 
-  subject(:prompt) { described_class.new(input, output) }
+  subject(:prompt) { TTY::TestPrompt.new }
 
   before { allow(Pastel).to receive(:new).and_return(color) }
 
-  after { output.rewind }
-
   it 'prints an empty message' do
     prompt.say ""
-    expect(output.string).to eql ""
+    expect(prompt.output.string).to eql ""
   end
 
   context 'with new line' do
     it 'prints a message with newline' do
       prompt.say "Hell yeah!\n"
-      expect(output.string).to eql "Hell yeah!\n"
+      expect(prompt.output.string).to eql "Hell yeah!\n"
     end
 
     it 'prints a message with implicit newline' do
       prompt.say "Hell yeah!\n"
-      expect(output.string).to eql "Hell yeah!\n"
+      expect(prompt.output.string).to eql "Hell yeah!\n"
     end
 
     it 'prints a message with newline within text' do
       prompt.say "Hell\n yeah!"
-      expect(output.string).to eql "Hell\n yeah!\n"
+      expect(prompt.output.string).to eql "Hell\n yeah!\n"
     end
 
     it 'prints a message with newline within text and blank space' do
       prompt.say "Hell\n yeah! "
-      expect(output.string).to eql "Hell\n yeah! "
+      expect(prompt.output.string).to eql "Hell\n yeah! "
     end
 
     it 'prints a message without newline' do
       prompt.say "Hell yeah!", newline: false
-      expect(output.string).to eql "Hell yeah!"
+      expect(prompt.output.string).to eql "Hell yeah!"
     end
   end
 
   context 'with tab or space' do
     it 'prints ' do
       prompt.say "Hell yeah!\t"
-      expect(output.string).to eql "Hell yeah!\t"
+      expect(prompt.output.string).to eql "Hell yeah!\t"
     end
   end
 
   context 'with color' do
     it 'prints message with ansi color' do
       prompt.say "Hell yeah!", color: :green
-      expect(output.string).to eql "\e[32mHell yeah!\e[0m\n"
+      expect(prompt.output.string).to eql "\e[32mHell yeah!\e[0m\n"
     end
 
     it 'prints message with ansi color without newline' do
       prompt.say "Hell yeah! ", color: :green
-      expect(output.string).to eql "\e[32mHell yeah! \e[0m"
+      expect(prompt.output.string).to eql "\e[32mHell yeah! \e[0m"
     end
   end
 end

data/spec/unit/select_spec.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt, '#select' do
+  let(:color) { Pastel.new(enabled: true) }
+
+  before { allow(Pastel).to receive(:new).and_return(color) }
+
+  it "selects by default first option" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(Large Medium Small)
+    prompt.input << "\r"
+    prompt.input.rewind
+    expect(prompt.select('What size?', choices)).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "\e[32m‣ Large\e[0m\n",
+      "  Medium\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice name and value" do
+    prompt = TTY::TestPrompt.new
+    choices = {large: 1, medium: 2, small: 3}
+    prompt.input << " "
+    prompt.input.rewind
+    expect(prompt.select('What size?', choices)).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‣ large\e[0m\n",
+      "  medium\n",
+      "  small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mlarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice name through DSL" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?') do |menu|
+              menu.choice "Large"
+              menu.choice "Medium"
+              menu.choice "Small"
+            end
+    expect(value).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "\e[32m‣ Large\e[0m\n",
+      "  Medium\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice name & value through DSL" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?') do |menu|
+              menu.choice :large, 1
+              menu.choice :medium, 2
+              menu.choice :small, 3
+            end
+    expect(value).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‣ large\e[0m\n",
+      "  medium\n",
+      "  small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mlarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choices and single choice through DSL" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?') do |menu|
+              menu.choice 'Large'
+              menu.choices %w(Medium Small)
+            end
+    expect(value).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "\e[32m‣ Large\e[0m\n",
+      "  Medium\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice name & value through DSL" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?') do |menu|
+              menu.default 2
+
+              menu.choice :large, 1
+              menu.choice :medium, 2
+              menu.choice :small, 3
+            end
+    expect(value).to eq(2)
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "  large\n",
+      "\e[32m‣ medium\e[0m\n",
+      "  small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mmedium\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice value to proc and executes it" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?', default: 2) do |menu|
+              menu.choice :large, 1
+              menu.choice :medium do 'Good choice!' end
+              menu.choice :small, 3
+            end
+    expect(value).to eq('Good choice!')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "  large\n",
+      "\e[32m‣ medium\e[0m\n",
+      "  small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mmedium\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets default option through hash syntax" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(Large Medium Small)
+    prompt.input << " "
+    prompt.input.rewind
+    expect(prompt.select('What size?', choices, default: 2)).to eq('Medium')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "  Large\n",
+      "\e[32m‣ Medium\e[0m\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mMedium\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "changes selected item color & marker" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(Large Medium Small)
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?', choices, color: :blue, marker: '>')
+    expect(value).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Use arrow keys, press Enter to select)\e[0m\n",
+      "\e[34m> Large\e[0m\n",
+      "  Medium\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[34mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "changes help text" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(Large Medium Small)
+    prompt.input << " "
+    prompt.input.rewind
+    value = prompt.select('What size?', choices, help: "(Bash keyboard)")
+    expect(value).to eq('Large')
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat size? \e[90m(Bash keyboard)\e[0m\n",
+      "\e[32m‣ Large\e[0m\n",
+      "  Medium\n",
+      "  Small\n",
+      "\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K",
+      "What size? \e[32mLarge\e[0m\n\e[?25h"
+    ].join)
+  end
+end

data/spec/unit/statement/initialize_spec.rb

@@ -3,10 +3,6 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt::Statement, '#new' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:shell) { TTY::Prompt.new(input, output) }
-
   it "forces newline after the prompt message" do
     statement = described_class.new
     expect(statement.newline).to eq(true)

data/spec/unit/suggest_spec.rb

@@ -3,31 +3,28 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt, '#suggest' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
   let(:possible) { %w(status stage stash commit branch blame) }
 
-  subject(:prompt) { described_class.new(input, output) }
-
-  after { output.rewind }
+  subject(:prompt) { TTY::TestPrompt.new }
 
   it 'suggests few matches' do
     prompt.suggest('sta', possible)
-    expect(output.string).to eql("Did you mean one of these?\n        stage\n        stash\n")
+    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(output.string).to eql("Did you mean this?\n        blame\n")
+    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(output.string).to eql("Did you mean this?\n        commit\n")
+    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(output.string).to eql("Perhaps you meant?\n    blame\n")
+    expect(prompt.output.string).to eql("Perhaps you meant?\n    blame\n")
   end
 end

data/spec/unit/warn_spec.rb

@@ -3,28 +3,24 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt, '#warn' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
   let(:color)  { Pastel.new(enabled: true) }
 
-  subject(:prompt) { TTY::Prompt.new(input, output) }
+  subject(:prompt) { TTY::TestPrompt.new }
 
   before { allow(Pastel).to receive(:new).and_return(color) }
 
-  after { output.rewind }
-
   it 'displays one message' do
     prompt.warn "Careful young apprentice!"
-    expect(output.string).to eql "\e[33mCareful young apprentice!\e[0m\n"
+    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(output.string).to eql "\e[33mCareful there!\e[0m\n\e[33mIt's dangerous!\e[0m\n"
+    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(output.string).to eql "\e[33mCareful young apprentice!\e[0m"
+    expect(prompt.output.string).to eql "\e[33mCareful young apprentice!\e[0m"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -78,18 +78,25 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tty-prompt.rb
 - lib/tty/prompt.rb
+- lib/tty/prompt/choice.rb
+- lib/tty/prompt/choices.rb
+- lib/tty/prompt/codes.rb
+- lib/tty/prompt/cursor.rb
 - lib/tty/prompt/distance.rb
 - lib/tty/prompt/error.rb
 - lib/tty/prompt/history.rb
+- lib/tty/prompt/list.rb
 - lib/tty/prompt/mode.rb
 - lib/tty/prompt/mode/echo.rb
 - lib/tty/prompt/mode/raw.rb
+- lib/tty/prompt/multi_list.rb
 - lib/tty/prompt/question.rb
 - lib/tty/prompt/question/modifier.rb
 - lib/tty/prompt/question/validation.rb
@@ -98,13 +105,21 @@ files:
 - lib/tty/prompt/response_delegation.rb
 - lib/tty/prompt/statement.rb
 - lib/tty/prompt/suggestion.rb
+- lib/tty/prompt/test.rb
 - lib/tty/prompt/utils.rb
 - lib/tty/prompt/version.rb
 - spec/spec_helper.rb
 - spec/unit/ask_spec.rb
+- spec/unit/choice/eql_spec.rb
+- spec/unit/choice/from_spec.rb
+- spec/unit/choices/add_spec.rb
+- spec/unit/choices/each_spec.rb
+- spec/unit/choices/new_spec.rb
+- spec/unit/choices/pluck_spec.rb
+- spec/unit/cursor/new_spec.rb
 - spec/unit/distance/distance_spec.rb
 - spec/unit/error_spec.rb
-- spec/unit/question/argument_spec.rb
+- spec/unit/multi_select_spec.rb
 - spec/unit/question/character_spec.rb
 - spec/unit/question/default_spec.rb
 - spec/unit/question/in_spec.rb
@@ -113,10 +128,10 @@ files:
 - spec/unit/question/modifier/letter_case_spec.rb
 - spec/unit/question/modifier/whitespace_spec.rb
 - spec/unit/question/modify_spec.rb
-- spec/unit/question/valid_spec.rb
+- spec/unit/question/required_spec.rb
 - spec/unit/question/validate_spec.rb
+- spec/unit/question/validation/call_spec.rb
 - spec/unit/question/validation/coerce_spec.rb
-- spec/unit/question/validation/valid_value_spec.rb
 - spec/unit/reader/getc_spec.rb
 - spec/unit/response/read_bool_spec.rb
 - spec/unit/response/read_char_spec.rb
@@ -128,6 +143,7 @@ files:
 - spec/unit/response/read_spec.rb
 - spec/unit/response/read_string_spec.rb
 - spec/unit/say_spec.rb
+- spec/unit/select_spec.rb
 - spec/unit/statement/initialize_spec.rb
 - spec/unit/suggest_spec.rb
 - spec/unit/warn_spec.rb
@@ -162,9 +178,16 @@ summary: A beautiful and powerful interactive command line prompt.
 test_files:
 - spec/spec_helper.rb
 - spec/unit/ask_spec.rb
+- spec/unit/choice/eql_spec.rb
+- spec/unit/choice/from_spec.rb
+- spec/unit/choices/add_spec.rb
+- spec/unit/choices/each_spec.rb
+- spec/unit/choices/new_spec.rb
+- spec/unit/choices/pluck_spec.rb
+- spec/unit/cursor/new_spec.rb
 - spec/unit/distance/distance_spec.rb
 - spec/unit/error_spec.rb
-- spec/unit/question/argument_spec.rb
+- spec/unit/multi_select_spec.rb
 - spec/unit/question/character_spec.rb
 - spec/unit/question/default_spec.rb
 - spec/unit/question/in_spec.rb
@@ -173,10 +196,10 @@ test_files:
 - spec/unit/question/modifier/letter_case_spec.rb
 - spec/unit/question/modifier/whitespace_spec.rb
 - spec/unit/question/modify_spec.rb
-- spec/unit/question/valid_spec.rb
+- spec/unit/question/required_spec.rb
 - spec/unit/question/validate_spec.rb
+- spec/unit/question/validation/call_spec.rb
 - spec/unit/question/validation/coerce_spec.rb
-- spec/unit/question/validation/valid_value_spec.rb
 - spec/unit/reader/getc_spec.rb
 - spec/unit/response/read_bool_spec.rb
 - spec/unit/response/read_char_spec.rb
@@ -188,6 +211,7 @@ test_files:
 - spec/unit/response/read_spec.rb
 - spec/unit/response/read_string_spec.rb
 - spec/unit/say_spec.rb
+- spec/unit/select_spec.rb
 - spec/unit/statement/initialize_spec.rb
 - spec/unit/suggest_spec.rb
 - spec/unit/warn_spec.rb

data/spec/unit/question/argument_spec.rb

@@ -1,30 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Prompt::Question, '#argument' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prompt)  { TTY::Prompt.new(input, output) }
-
-  it 'requires value to be present with helper' do
-    input << ''
-    input.rewind
-    q = prompt.ask("What is your name?").argument(:required)
-    expect { q.read }.to raise_error(ArgumentError)
-  end
-
-  it 'requires value to be present with option' do
-    input << ''
-    input.rewind
-    q = prompt.ask("What is your name?", required: true)
-    expect { q.read }.to raise_error(ArgumentError)
-  end
-
-  it "doesn't require value to be present" do
-    input << ''
-    input.rewind
-    q = prompt.ask("What is your name?").argument(:optional)
-    expect(q.read).to be_nil
-  end
-end

data/spec/unit/question/valid_spec.rb

@@ -1,46 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Prompt::Question, '#valid' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prompt) { TTY::Prompt.new(input, output) }
-
-  let(:cards) { %w[ club diamond spade heart ] }
-
-  it 'reads valid optios with helper' do
-    input << 'club'
-    input.rewind
-    q = prompt.ask("What is your card suit sir?").valid(cards)
-    expect(q.read_choice).to eq('club')
-  end
-
-  it 'reads valid options with option hash' do
-    input << 'club'
-    input.rewind
-    q = prompt.ask("What is your card suit sir?", valid: cards)
-    expect(q.read_choice).to eq('club')
-  end
-
-  it 'reads invalid option' do
-    input << 'clover'
-    input.rewind
-    q = prompt.ask("What is your card suit sir?").valid(cards)
-    expect { q.read_choice }.to raise_error(TTY::Prompt::InvalidArgument)
-  end
-
-  it 'needs argument' do
-    input << ''
-    input.rewind
-    q = prompt.ask("What is your card suit sir?").valid(cards)
-    expect { q.read_choice }.to raise_error(TTY::Prompt::ArgumentRequired)
-  end
-
-  it 'reads with default' do
-    input << ''
-    input.rewind
-    q = prompt.ask("What is your card suit sir?").valid(cards).default('club')
-    expect(q.read_choice).to eq('club')
-  end
-end

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

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-RSpec.describe TTY::Prompt::Question::Validation, '#valid_value?' do
-  let(:validation) { /^[^\.]+\.[^\.]+/ }
-  let(:instance) { described_class.new validation }
-
-  it "validates nil input" do
-    expect(instance.valid_value?(nil)).to eq(false)
-  end
-
-  it "validates successfully when the value matches pattern" do
-    expect(instance.valid_value?('piotr.murach')).to eq(true)
-  end
-
-  it "fails validation when not maching pattern" do
-    expect {
-      instance.valid_value?('piotrmurach')
-    }.to raise_error(TTY::Prompt::InvalidArgument)
-  end
-end