tty-prompt 0.1.0 → 0.2.0

data/lib/tty/prompt.rb

@@ -20,12 +20,12 @@ module TTY
     # @api private
     attr_reader :output
 
-    # Shell prompt prefix
+    # Prompt prefix
     #
     # @api private
     attr_reader :prefix
 
-    # Initialize a Shell
+    # Initialize a Prompt
     #
     # @api public
     def initialize(input = stdin, output = stdout, options = {})
@@ -37,7 +37,7 @@ module TTY
     # Ask a question.
     #
     # @example
-    #   shell = TTY::Shell.new
+    #   shell = TTY::Prompt.new
     #   shell.ask("What is your name?")
     #
     # @param [String] statement
@@ -51,22 +51,85 @@ module TTY
     # @return [TTY::Question]
     #
     # @api public
-    def ask(statement, *args, &block)
+    def ask(message, *args, &block)
       options = Utils.extract_options!(args)
 
-      question = Question.new self, options
-      question.instance_eval(&block) if block_given?
-      question.prompt(statement)
+      question = Question.new(self, options)
+      question.call(message, &block)
+    end
+
+    # Ask a question with a list of options
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   prompt.select("What size?", %w(large medium small))
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   prompt.select("What size?") do |menu|
+    #     menu.choice :large
+    #     menu.choices %w(:medium :small)
+    #   end
+    #
+    # @param [String] question
+    #   the question to ask
+    #
+    # @param [Array[Object]] choices
+    #   the choices to select from
+    #
+    # @api public
+    def select(question, *args, &block)
+      options = Utils.extract_options!(args)
+      choices = if block
+                  []
+                elsif args.empty?
+                  options
+                else
+                  args.flatten
+                end
+
+      list = List.new(self, options)
+      list.call(question, choices, &block)
+    end
+
+    # Ask a question with multiple attributes activated
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   choices = %w(Scorpion Jax Kitana Baraka Jade)
+    #   prompt.multi_select("Choose your destiny?", choices)
+    #
+    # @param [String] question
+    #   the question to ask
+    #
+    # @param [Array[Object]] choices
+    #   the choices to select from
+    #
+    # @return [String]
+    #
+    # @api public
+    def multi_select(question, *args, &block)
+      options = Utils.extract_options!(args)
+      choices = if block
+                  []
+                elsif args.empty?
+                  options
+                else
+                  args.flatten
+                end
+
+      list = MultiList.new(self, options)
+      list.call(question, choices, &block)
     end
 
     # A shortcut method to ask the user positive question and return
-    # true for 'yes' reply.
+    # true for 'yes' reply, false for 'no'.
     #
     # @return [Boolean]
     #
     # @api public
     def yes?(statement, *args, &block)
-      ask(statement, *args, &block).read_bool
+      ask(statement, {read: :bool}, &block)
     end
 
     # A shortcut method to ask the user negative question and return

data/lib/tty-prompt.rb

@@ -5,11 +5,22 @@ require 'pastel'
 require 'tty-platform'
 
 require 'tty/prompt'
+require 'tty/prompt/choice'
+require 'tty/prompt/choices'
+require 'tty/prompt/codes'
+require 'tty/prompt/cursor'
+require 'tty/prompt/list'
+require 'tty/prompt/multi_list'
 require 'tty/prompt/mode'
 require 'tty/prompt/question'
 require 'tty/prompt/reader'
 require 'tty/prompt/response'
 require 'tty/prompt/statement'
 require 'tty/prompt/suggestion'
+require 'tty/prompt/test'
 require 'tty/prompt/utils'
 require 'tty/prompt/version'
+
+module TTY
+  PromptConfigurationError = Class.new(StandardError)
+end

data/spec/unit/ask_spec.rb

@@ -3,74 +3,71 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt, '#ask' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prefix) { '' }
-  let(:options) { { prefix: prefix } }
 
-  subject(:prompt) { TTY::Prompt.new(input, output, options) }
+  subject(:prompt) { TTY::TestPrompt.new }
 
   it 'prints message' do
-    prompt.ask "What is your name?"
-    expect(output.string).to eql "What is your name?\n"
+    prompt.ask("What is your name?")
+    expect(prompt.output.string).to eql("What is your name?")
   end
 
   it 'prints an empty message ' do
-    prompt.ask ""
-    expect(output.string).to eql ""
+    prompt.ask('')
+    expect(prompt.output.string).to eql('')
   end
 
   it 'prints an empty message and returns nil if EOF is sent to stdin' do
-    input << nil
-    input.rewind
-    q = prompt.ask ""
-    expect(q.read).to eql nil
+    prompt.input << nil
+    prompt.input.rewind
+    response = prompt.ask("")
+    expect(response).to eql(nil)
+    expect(prompt.output.string).to eq('')
   end
 
-  context 'with a prompt prefix' do
-    let(:prefix) { ' > ' }
-
-    it "asks a question with '>'" do
-      input << ''
-      input.rewind
-      prompt.ask "Are you Polish?"
-      expect(output.string).to eql " > Are you Polish?\n"
-    end
+  it "asks a question with a prefix '>'" do
+    prompt = TTY::TestPrompt.new(prefix: ' > ')
+    prompt.input << ''
+    prompt.input.rewind
+    response = prompt.ask "Are you Polish?"
+    expect(response).to eq(nil)
+    expect(prompt.output.string).to eql " > Are you Polish?"
   end
 
   it 'asks a question with block' do
-    input << ''
-    input.rewind
-    q = prompt.ask "What is your name?" do
-      default 'Piotr'
+    prompt.input << ''
+    prompt.input.rewind
+    value = prompt.ask "What is your name?" do |q|
+      q.default 'Piotr'
     end
-    expect(q.read).to eql "Piotr"
+    expect(value).to eql "Piotr"
+    expect(prompt.output.string).to eq('What is your name?')
   end
 
   context 'yes?' do
     it 'agrees' do
-      input << 'yes'
-      input.rewind
+      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?')
     end
 
     it 'disagrees' do
-      input << 'no'
-      input.rewind
+      prompt.input << 'no'
+      prompt.input.rewind
       expect(prompt.yes?("Are you a human?")).to eq(false)
     end
   end
 
   context 'no?' do
     it 'agrees' do
-      input << 'no'
-      input.rewind
+      prompt.input << 'no'
+      prompt.input.rewind
       expect(prompt.no?("Are you a human?")).to eq(true)
     end
 
     it 'disagrees' do
-      input << 'yes'
-      input.rewind
+      prompt.input << 'yes'
+      prompt.input.rewind
       expect(prompt.no?("Are you a human?")).to eq(false)
     end
   end

data/spec/unit/choice/eql_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choice, '#==' do
+  it "is true with the same name and value attributes" do
+    expect(described_class.new(:large, 1)).
+      to eq(described_class.new(:large, 1))
+  end
+
+  it "is false with different name attribute" do
+    expect(described_class.new(:large, 1)).
+      not_to eq(described_class.new(:medium, 1))
+  end
+
+  it "is false with different value attribute" do
+    expect(described_class.new(:large, 1)).
+      not_to eq(described_class.new(:large, 2))
+  end
+
+  it "is false with non-choice object" do
+    expect(described_class.new(:large, 1)).not_to eq(:other)
+  end
+end

data/spec/unit/choice/from_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choice, '#from' do
+  it "creates choice from choice" do
+    choice = described_class.new(:large, 1)
+    expect(described_class.from(choice)).to eq(choice)
+  end
+
+  it "creates choice from string" do
+    choice = described_class.new('large', 'large')
+    expect(described_class.from('large')).to eq(choice)
+  end
+
+  it "creates choice from array" do
+    choice = described_class.new('large', 1)
+    expect(described_class.from([:large, 1])).to eq(choice)
+  end
+
+  it "creates choice from hash value" do
+    choice = described_class.new('large', 1)
+    expect(described_class.from({large: 1})).to eq(choice)
+  end
+end

data/spec/unit/choices/add_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choices, '#<<' do
+  it "adds choice to collection" do
+    choices = described_class.new
+    expect(choices).to be_empty
+    choice = TTY::Prompt::Choice.from([:label, 1])
+    choices << [:label, 1]
+    expect(choices.size).to eq(1)
+    expect(choices.to_ary).to eq([choice])
+  end
+end

data/spec/unit/choices/each_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choices, '.each' do
+  it "iterates over collection" do
+    choices = described_class[:large, :medium, :small]
+    actual = []
+    choices.each do |choice|
+      actual << choice.name
+    end
+    expect(actual).to eq([:large, :medium, :small])
+    expect(choices.each).to be_kind_of(Enumerator)
+  end
+end

data/spec/unit/choices/new_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choices, '.new' do
+  it "creates choices collection" do
+    choice_1 = TTY::Prompt::Choice.from(:label1)
+    choice_2 = TTY::Prompt::Choice.from(:label2)
+    collection = described_class[:label1, :label2]
+    expect(collection.choices).to eq([choice_1, choice_2])
+  end
+end

data/spec/unit/choices/pluck_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Choices, '.pluck' do
+  it "plucks choice from collection by name" do
+    collection = %w(large medium small)
+    choices = described_class[*collection]
+    expect(choices.pluck('medium').name).to eq('medium')
+  end
+end

data/spec/unit/cursor/new_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Cursor do
+  it "allows to print without mutating state" do
+    cursor = described_class.new
+    expect(cursor.shell).to eq(false)
+    expect(cursor.print.shell).to eq(true)
+    expect(cursor.shell).to eq(false)
+  end
+
+  it "shows cursor" do
+    cursor = described_class.new
+    expect(cursor.show).to eq("\e[?25h")
+  end
+
+  it "hides cursor" do
+    cursor = described_class.new
+    expect(cursor.hide).to eq("\e[?25l")
+  end
+
+  it "saves cursor position" do
+    cursor = described_class.new
+    expect(cursor.save).to eq("\e[s")
+  end
+
+  it "restores cursor position" do
+    cursor = described_class.new
+    expect(cursor.restore).to eq("\e[u")
+  end
+
+  it "moves up default by 1 line" do
+    cursor = described_class.new
+    expect(cursor.move_up).to eq("\e[1A")
+  end
+
+  it "moves up by 5 lines" do
+    cursor = described_class.new
+    expect(cursor.move_up(5)).to eq("\e[5A")
+  end
+
+  it "moves down default by 1 line" do
+    cursor = described_class.new
+    expect(cursor.move_down).to eq("\e[1B")
+  end
+
+  it "clears line" do
+    cursor = described_class.new
+    expect(cursor.clear_line).to eq("\e[1000D\e[K")
+  end
+
+  it "clears 5 lines up" do
+    cursor = described_class.new
+    expect(cursor.clear_lines(5)).to eq([
+      "\e[1A\e[1000D\e[K",
+      "\e[1A\e[1000D\e[K",
+      "\e[1A\e[1000D\e[K",
+      "\e[1A\e[1000D\e[K",
+      "\e[1A\e[1000D\e[K"
+    ].join)
+  end
+
+  it "clears 5 lines down" do
+    cursor = described_class.new
+    expect(cursor.clear_lines(5, :down)).to eq([
+      "\e[1B\e[1000D\e[K",
+      "\e[1B\e[1000D\e[K",
+      "\e[1B\e[1000D\e[K",
+      "\e[1B\e[1000D\e[K",
+      "\e[1B\e[1000D\e[K"
+    ].join)
+  end
+end

data/spec/unit/error_spec.rb

@@ -3,28 +3,24 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt, '.error' 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 'displays one message' do
     prompt.error "Nothing is fine!"
-    expect(output.string).to eql "\e[31mNothing is fine!\e[0m\n"
+    expect(prompt.output.string).to eql "\e[31mNothing is fine!\e[0m\n"
   end
 
   it 'displays many messages' do
     prompt.error "Nothing is fine!", "All is broken!"
-    expect(output.string).to eql "\e[31mNothing is fine!\e[0m\n\e[31mAll is broken!\e[0m\n"
+    expect(prompt.output.string).to eql "\e[31mNothing is fine!\e[0m\n\e[31mAll is broken!\e[0m\n"
   end
 
   it 'displays message with option' do
     prompt.error "Nothing is fine!", newline: false
-    expect(output.string).to eql "\e[31mNothing is fine!\e[0m"
+    expect(prompt.output.string).to eql "\e[31mNothing is fine!\e[0m"
   end
 end

data/spec/unit/multi_select_spec.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt do
+  let(:color) { Pastel.new(enabled: true) }
+
+  before { allow(Pastel).to receive(:new).and_return(color) }
+
+  it "selects nothing when return pressed immediately" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(vodka beer wine whisky bourbon)
+    prompt.input << "\r"
+    prompt.input.rewind
+    expect(prompt.multi_select("Select drinks?", choices)). to eq([])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "‣ ⬡ vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? \n\e[?25h"
+    ].join)
+  end
+
+  it "selects item when space pressed" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(vodka beer wine whisky bourbon)
+    prompt.input << " \r"
+    prompt.input.rewind
+    expect(prompt.multi_select("Select drinks?", choices)). to eq(['vodka'])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "‣ ⬡ vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? vodka\n",
+      "‣ \e[32m⬢\e[0m vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice custom values" do
+    prompt = TTY::TestPrompt.new
+    choices = {vodka: 1, beer: 2, wine: 3, whisky: 4, bourbon: 5}
+    prompt.input << " \r"
+    prompt.input.rewind
+    expect(prompt.multi_select("Select drinks?", choices)).to eq([1])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "‣ ⬡ vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? vodka\n",
+      "‣ \e[32m⬢\e[0m vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets choice name and value through DSL" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << " \r"
+    prompt.input.rewind
+    value = prompt.multi_select("Select drinks?") do |menu|
+              menu.choice :vodka, {score: 1}
+              menu.choice :beer, 2
+              menu.choice :wine, 3
+              menu.choices whisky: 4, bourbon: 5
+            end
+    expect(value).to eq([{score: 1}])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "‣ ⬡ vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? vodka\n",
+      "‣ \e[32m⬢\e[0m vodka\n",
+      "  ⬡ beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "  ⬡ bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
+    ].join)
+  end
+
+  it "sets default options through DSL syntax" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.multi_select("Select drinks?") do |menu|
+              menu.default 2, 5
+
+              menu.choice :vodka,   {score: 10}
+              menu.choice :beer,    {score: 20}
+              menu.choice :wine,    {score: 30}
+              menu.choice :whisky,  {score: 40}
+              menu.choice :bourbon, {score: 50}
+            end
+    expect(value).to match_array([{score: 20}, {score: 50}])
+    expect(prompt.output.string).to eq([
+      "\e[?25lSelect drinks? beer, bourbon\n",
+      "  ⬡ vodka\n",
+      "  \e[32m⬢\e[0m beer\n",
+      "  ⬡ wine\n",
+      "  ⬡ whisky\n",
+      "‣ \e[32m⬢\e[0m bourbon\n",
+      "\e[1A\e[1000D\e[K" * 6,
+      "Select drinks? \e[32mbeer, bourbon\e[0m\n\e[?25h",
+    ].join)
+  end
+
+  it "sets default options through hash syntax" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.multi_select("Select drinks?",default: [2, 5]) do |menu|
+              menu.choice :vodka,   {score: 10}
+              menu.choice :beer,    {score: 20}
+              menu.choice :wine,    {score: 30}
+              menu.choice :whisky,  {score: 40}
+              menu.choice :bourbon, {score: 50}
+            end
+    expect(value).to match_array([{score: 20}, {score: 50}])
+  end
+
+  it "raises error for defaults out of range" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\r"
+    prompt.input.rewind
+    expect {
+      prompt.multi_select("Select drinks?",default: [2, 6]) do |menu|
+        menu.choice :vodka,   {score: 10}
+        menu.choice :beer,    {score: 20}
+        menu.choice :wine,    {score: 30}
+        menu.choice :whisky,  {score: 40}
+        menu.choice :bourbon, {score: 50}
+      end
+    }.to raise_error(TTY::PromptConfigurationError,
+                     /default index `6` out of range \(1 - 5\)/)
+  end
+end

data/spec/unit/question/character_spec.rb

@@ -3,22 +3,11 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt::Question, '#character' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prompt) { TTY::Prompt.new(input, output) }
-
   it 'switches to character input' do
-    input << "abcd"
-    input.rewind
-    q = prompt.ask("Which one do you prefer a, b, c or d?").char(true)
-    expect(q.character)
-    expect(q.read_string).to eq("abcd")
-  end
-
-  it 'acts as reader without arguments' do
-    input << "abcd"
-    input.rewind
-    q = prompt.ask("Which one do you prefer a, b, c or d?")
-    expect(q.char).to eq(false)
+    prompt = TTY::TestPrompt.new
+    prompt.input << "abcd"
+    prompt.input.rewind
+    answer = prompt.ask("Which one do you prefer a, b, c or d?") { |q| q.char(true) }
+    expect(answer).to eq("abcd")
   end
 end

data/spec/unit/question/default_spec.rb

@@ -3,23 +3,17 @@
 require 'spec_helper'
 
 RSpec.describe TTY::Prompt::Question, '#default' do
-  let(:input)  { StringIO.new }
-  let(:output) { StringIO.new }
-  let(:prompt) { TTY::Prompt.new(input, output) }
-
   it 'uses default value' do
+    prompt = TTY::TestPrompt.new
     name = 'Anonymous'
-    q = prompt.ask("What is your name?").default(name)
-    answer = q.read
+    answer = prompt.ask('What is your name?', default: name)
     expect(answer).to eq(name)
   end
 
   it 'uses default value in block' do
+    prompt = TTY::TestPrompt.new
     name = 'Anonymous'
-    q = prompt.ask "What is your name?" do
-      default name
-    end
-    answer = q.read
+    answer = prompt.ask('What is your name?') { |q| q.default(name) }
     expect(answer).to eq(name)
   end
 end