tty-prompt 0.3.0 → 0.4.0

data/lib/tty/prompt/symbols.rb

@@ -3,11 +3,17 @@
 module TTY
   class Prompt
     module Symbols
-      SPACE = " "
+      SPACE   = " "
+      SUCCESS = "✓"
+      FAILURE = "✘"
+
       ITEM_SECURE     = "•"
       ITEM_SELECTED   = "‣"
       RADIO_CHECKED   = "⬢"
       RADIO_UNCHECKED = "⬡"
+      SLIDER_HANDLE   = 'O'
+      SLIDER_RANGE    = '-'
+      SLIDER_END      = '|'
     end # Symbols
   end # Prompt
 end # TTY

data/lib/tty/prompt/utils.rb

@@ -4,13 +4,41 @@ module TTY
   module Utils
     module_function
 
-    def extract_options!(args)
-      args.last.respond_to?(:to_hash) ? args.pop : {}
-    end
+    BLANK_REGEX = /\A[[:space:]]*\z/o.freeze
 
+    # Extract options hash from array argument
+    #
+    # @param [Array[Object]] args
+    #
+    # @api public
     def extract_options(args)
       options = args.last
       options.respond_to?(:to_hash) ? options.to_hash.dup : {}
     end
+
+    def extract_options!(args)
+      args.last.respond_to?(:to_hash) ? args.pop : {}
+    end
+
+    # Check if value is nil or an empty string
+    #
+    # @param [Object] value
+    #   the value to check
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def blank?(value)
+      value.nil? ||
+      value.respond_to?(:empty?) && value.empty? ||
+      BLANK_REGEX === value
+    end
+
+    # Deep copy object
+    #
+    # @api public
+    def deep_copy(object)
+      Marshal.load(Marshal.dump(object))
+    end
   end # Utils
 end # TTY

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # Prompt
 end # TTY

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
 end
 
 require 'tty-prompt'
+require 'rspec/mocks/matchers/have_received'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/spec/unit/converters/convert_bool_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe TTY::Prompt::Question, 'convert bool' do
     prompt.input.rewind
     expect {
       prompt.ask("Do you read books?", convert: :bool)
-    }.to raise_error(Necromancer::ConversionTypeError)
+    }.to raise_error(TTY::Prompt::ConversionError)
   end
 
   it "handles default values" do

data/spec/unit/converters/convert_date_spec.rb

@@ -1,8 +1,18 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Question, 'convert date' do
+
+  subject(:prompt) { TTY::TestPrompt.new}
+
+  it 'fails to convert date' do
+    prompt.input << 'invalid'
+    prompt.input.rewind
+    expect {
+      prompt.ask("When were you born?", convert: :date)
+    }.to raise_error(TTY::Prompt::ConversionError)
+  end
+
   it 'converts date' do
-    prompt = TTY::TestPrompt.new
     prompt.input << "20th April 1887"
     prompt.input.rewind
     response = prompt.ask("When were your born?", convert: :date)
@@ -13,7 +23,6 @@ RSpec.describe TTY::Prompt::Question, 'convert date' do
   end
 
   it "converts datetime" do
-    prompt = TTY::TestPrompt.new
     prompt.input << "20th April 1887"
     prompt.input.rewind
     response = prompt.ask("When were your born?", convert: :datetime)

data/spec/unit/converters/convert_file_spec.rb

@@ -9,6 +9,6 @@ RSpec.describe TTY::Prompt::Question, 'convert file' do
     prompt.input.rewind
     answer = prompt.ask("Which file to open?", convert: :file)
     expect(answer).to eq(file)
-    # expect(File).to have_received(:open).with(/test\.txt/)
+    expect(File).to have_received(:open).with(/test\.txt/)
   end
 end

data/spec/unit/converters/convert_number_spec.rb

@@ -1,8 +1,18 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Question, 'convert numbers' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'fails to convert integer' do
+    prompt.input << 'invalid'
+    prompt.input.rewind
+    expect {
+      prompt.ask("What temparture?", convert: :int)
+    }.to raise_error(TTY::Prompt::ConversionError)
+  end
+
   it 'converts integer' do
-    prompt = TTY::TestPrompt.new
     prompt.input << 35
     prompt.input.rewind
     answer = prompt.ask("What temperature?", convert: :int)
@@ -10,8 +20,15 @@ RSpec.describe TTY::Prompt::Question, 'convert numbers' do
     expect(answer).to eq(35)
   end
 
+  it 'fails to convert float' do
+    prompt.input << 'invalid'
+    prompt.input.rewind
+    expect {
+      prompt.ask("How tall are you?", convert: :float)
+    }.to raise_error(TTY::Prompt::ConversionError)
+  end
+
   it 'converts float' do
-    prompt = TTY::TestPrompt.new
     number = 6.666
     prompt.input << number
     prompt.input.rewind

data/spec/unit/converters/convert_path_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe TTY::Prompt::Question, 'convert path' do
     prompt.input << "/path/to/file"
     prompt.input.rewind
     answer = prompt.ask('File location?', convert: :path)
-    # expect(Pathname).to have_received(:new).with(/path\/to\/file/)
     expect(answer).to eql(path)
+    expect(Pathname).to have_received(:new).with(/path\/to\/file/)
   end
 end

data/spec/unit/converters/convert_range_spec.rb

@@ -1,8 +1,10 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Question, 'convert range' do
+
+  subject(:prompt) { TTY::TestPrompt.new}
+
   it 'converts with valid range' do
-    prompt = TTY::TestPrompt.new
     prompt.input << "20-30"
     prompt.input.rewind
     answer = prompt.ask("Which age group?", convert: :range)
@@ -11,11 +13,10 @@ RSpec.describe TTY::Prompt::Question, 'convert range' do
   end
 
   it "fails to convert to range" do
-    prompt = TTY::TestPrompt.new
     prompt.input << "abcd"
     prompt.input.rewind
     expect {
       prompt.ask('Which age group?', convert: :range)
-    }.to raise_error(Necromancer::ConversionTypeError)
+    }.to raise_error(TTY::Prompt::ConversionError)
   end
 end

data/spec/unit/enum_select_spec.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it "selects default option when return pressed immediately" do
+    choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    expect(prompt.enum_select("Select an editor?", choices)).to eq('/bin/nano')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "\e[32m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: ",
+      "\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\e[J",
+      "Select an editor? \e[32m/bin/nano\e[0m\n"
+    ].join)
+  end
+
+  it "selects option by index from the list" do
+    choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+    prompt.input << "3\n"
+    prompt.input.rewind
+
+    expect(prompt.enum_select("Select an editor?", choices, default: 2)).to eq('/usr/bin/vim.tiny')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "  1) /bin/nano\n",
+      "\e[32m  2) /usr/bin/vim.basic\e[0m\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [2]: ",
+      "\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\e[J",
+      "Select an editor? \n",
+      "  1) /bin/nano\n",
+      "  2) /usr/bin/vim.basic\n",
+      "\e[32m  3) /usr/bin/vim.tiny\e[0m\n",
+      "  Choose 1-3 [2]: 3",
+      "\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\e[J",
+      "Select an editor? \e[32m/usr/bin/vim.tiny\e[0m\n"
+    ].join)
+  end
+
+  it "selects option through DSL" do
+    prompt.input << "\n"
+    prompt.input.rewind
+    value = prompt.enum_select("Select an editor?") do |menu|
+      menu.default 2
+      menu.enum '.'
+
+      menu.choice "/bin/nano"
+      menu.choice "/usr/bin/vim.basic"
+      menu.choice "/usr/bin/vim.tiny"
+    end
+
+    expect(value).to eq('/usr/bin/vim.basic')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "  1. /bin/nano\n",
+      "\e[32m  2. /usr/bin/vim.basic\e[0m\n",
+      "  3. /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [2]: ",
+      "\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\e[J",
+      "Select an editor? \e[32m/usr/bin/vim.basic\e[0m\n"
+    ].join)
+  end
+
+  it "selects option through DSL with key and value" do
+    prompt.input << "\n"
+    prompt.input.rewind
+    value = prompt.enum_select("Select an editor?") do |menu|
+      menu.default 2
+
+      menu.choice :nano,  '/bin/nano'
+      menu.choice :vim,   '/usr/bin/vim'
+      menu.choice :emacs, '/usr/bin/emacs'
+    end
+
+    expect(value).to eq('/usr/bin/vim')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "  1) nano\n",
+      "\e[32m  2) vim\e[0m\n",
+      "  3) emacs\n",
+      "  Choose 1-3 [2]: ",
+      "\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\e[J",
+      "Select an editor? \e[32mvim\e[0m\n"
+    ].join)
+  end
+end

data/spec/unit/multi_select_spec.rb

@@ -74,6 +74,8 @@ RSpec.describe TTY::Prompt do
     prompt.input << " \r"
     prompt.input.rewind
     value = prompt.multi_select("Select drinks?") do |menu|
+              menu.enum ')'
+
               menu.choice :vodka, {score: 1}
               menu.choice :beer, 2
               menu.choice :wine, 3
@@ -81,19 +83,19 @@ RSpec.describe TTY::Prompt do
             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",
+      "\e[?25lSelect drinks? \e[90m(Use arrow or number (0-9) keys, press Space to select and Enter to finish)\e[0m\n",
+      "‣ ⬡ 1) vodka\n",
+      "  ⬡ 2) beer\n",
+      "  ⬡ 3) wine\n",
+      "  ⬡ 4) whisky\n",
+      "  ⬡ 5) bourbon",
       "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
       "Select drinks? vodka\n",
-      "‣ \e[32m⬢\e[0m vodka\n",
-      "  ⬡ beer\n",
-      "  ⬡ wine\n",
-      "  ⬡ whisky\n",
-      "  ⬡ bourbon",
+      "‣ \e[32m⬢\e[0m 1) vodka\n",
+      "  ⬡ 2) beer\n",
+      "  ⬡ 3) wine\n",
+      "  ⬡ 4) whisky\n",
+      "  ⬡ 5) bourbon",
       "\e[1000D\e[K\e[1A" * 5, "\e[1000D\e[K",
       "Select drinks? \e[32mvodka\e[0m\n\e[?25h"
     ].join)
@@ -151,7 +153,7 @@ RSpec.describe TTY::Prompt do
         menu.choice :whisky,  {score: 40}
         menu.choice :bourbon, {score: 50}
       end
-    }.to raise_error(TTY::PromptConfigurationError,
+    }.to raise_error(TTY::Prompt::ConfigurationError,
                      /default index `6` out of range \(1 - 5\)/)
   end
 

data/spec/unit/question/checks_spec.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Question do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it "passes range check" do
+    question = described_class.new(prompt)
+    question.in 1..10
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 2)
+
+    expect(result).to eq([2])
+  end
+
+  it "fails range check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.in 1..10
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 11)
+
+    expect(result).to eq([11, ["Value 11 must be within the range 1..10"]])
+  end
+
+  it "fails range check" do
+    question = described_class.new(prompt)
+    question.in 1..10, 'Outside of range!'
+
+    result = TTY::Prompt::Question::Checks::CheckRange.call(question, 11)
+
+    expect(result).to eq([11, ['Outside of range!']])
+  end
+
+  it "passes validation check" do
+    question = described_class.new(prompt)
+    question.validate(/\A\d{5}\Z/)
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, '12345')
+
+    expect(result).to eq(['12345'])
+  end
+
+  it "fails validation check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.validate(/\A\d{5}\Z/)
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, '123')
+
+    expect(result).to eq(['123', ['Your answer is invalid (must match /\\A\\d{5}\\Z/)']])
+  end
+
+  it "fails validation check with inlined custom message" do
+    question = described_class.new(prompt)
+    question.validate(/\A\w+@\w+\.\w+\Z/, 'Invalid email address')
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, 'piotr@com')
+
+    expect(result).to eq(['piotr@com', ['Invalid email address']])
+  end
+
+  it "fails validation check with custom message" do
+    question = described_class.new(prompt)
+    question.validate(/\A\w+@\w+\.\w+\Z/)
+    question.messages[:valid?] = 'Invalid email address'
+
+    result = TTY::Prompt::Question::Checks::CheckValidation.call(question, 'piotr@com')
+
+    expect(result).to eq(['piotr@com', ['Invalid email address']])
+  end
+
+  it "passes required check" do
+    question = described_class.new(prompt)
+    question.required true
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, 'Piotr')
+
+    expect(result).to eq(['Piotr'])
+  end
+
+  it "fails required check" do
+    question = described_class.new(prompt, messages: TTY::Prompt.messages)
+    question.required true
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, nil)
+
+    expect(result).to eq([nil, ['Value must be provided']])
+  end
+
+  it "fails required check with custom message" do
+    question = described_class.new(prompt)
+    question.required true, 'Required input'
+
+    result = TTY::Prompt::Question::Checks::CheckRequired.call(question, nil)
+
+    expect(result).to eq([nil, ['Required input']])
+  end
+end

data/spec/unit/reader/key_event_spec.rb

@@ -0,0 +1,67 @@
+# encoding
+
+RSpec.describe TTY::Prompt::Reader::KeyEvent, '::from' do
+
+  it "parses ctrl+h" do
+    event = described_class.from("\b")
+    expect(event.key.name).to eq(:backspace)
+    expect(event.value).to eq("\b")
+  end
+
+  it "parses lowercase char" do
+    event = described_class.from('a')
+    expect(event.key.name).to eq('a')
+    expect(event.value).to eq('a')
+  end
+
+  it "parses uppercase char" do
+    event = described_class.from('A')
+    expect(event.key.name).to eq('a')
+    expect(event.value).to eq('A')
+  end
+
+  it "parses f5 key" do
+    event = described_class.from("\e[15~")
+    expect(event.key.name).to eq(:f5)
+  end
+
+  it "parses up key" do
+    event = described_class.from("\e[A")
+    expect(event.key.name).to eq(:up)
+  end
+
+  it "parses up key on gnome" do
+    event = described_class.from("\eOA")
+    expect(event.key.name).to eq(:up)
+  end
+
+  it "parses down key" do
+    event = described_class.from("\e[B")
+    expect(event.key.name).to eq(:down)
+  end
+
+  it "parses right key" do
+    event = described_class.from("\e[C")
+    expect(event.key.name).to eq(:right)
+  end
+
+  it "parses left key" do
+    event = described_class.from("\e[D")
+    expect(event.key.name).to eq(:left)
+  end
+
+  it "parses clear key" do
+    event = described_class.from("\e[E")
+    expect(event.key.name).to eq(:clear)
+  end
+
+  it "parses end key" do
+    event = described_class.from("\e[F")
+    expect(event.key.name).to eq(:end)
+  end
+
+  it "parses home key" do
+    event = described_class.from("\e[H")
+    expect(event.key.name).to eq(:home)
+  end
+end