tty-prompt 0.11.0 → 0.12.0

data/lib/tty/prompt/timeout.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Timeout
+      Error = Class.new(RuntimeError)
+
+      TIMEOUT_HANDLER = proc { |t| t.raise Error, 'timeout expired' }
+
+      def initialize(options = {})
+        @timeout_handler  = options.fetch(:timeout_handler) { TIMEOUT_HANDLER }
+        @interval_handler = options.fetch(:interval_handler) { proc { } }
+        @lock = Mutex.new
+      end
+
+      def self.timeout(secs, interval, &block)
+        (@scheduler ||= new).timeout(secs, interval, &block)
+      end
+
+      def timeout(secs, interval, &block)
+        return block.() if secs.nil? || secs.to_i.zero?
+        @lock.synchronize do
+          @runner = Thread.new {
+            run_in(secs, interval)
+          }
+        end
+        block.()
+      end
+
+      def run_in(secs, interval)
+        Thread.current.abort_on_exception = true
+        start = Time.now
+
+        loop do
+          sleep(interval)
+          runtime = Time.now - start
+          delta = secs - runtime
+          @interval_handler.(delta.round)
+
+          if delta < 0.0
+            @timeout_handler.(Thread.current)
+            break
+          end
+        end
+      end
+    end # Scheduler
+  end # Prompt
+end # TTY

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end # Prompt
 end # TTY

data/spec/unit/ask_spec.rb

@@ -34,6 +34,7 @@ RSpec.describe TTY::Prompt, '#ask' do
     expect(answer).to eq(nil)
     expect(prompt.output.string).to eq([
       "[?] Are you Polish? ",
+      "\e[2K\e[1G[?] Are you Polish? \n",
       "\e[1A\e[2K\e[1G",
       "[?] Are you Polish? \n"
     ].join)
@@ -74,6 +75,7 @@ RSpec.describe TTY::Prompt, '#ask' do
     expect(answer).to eq('')
     expect(prompt.output.string).to eq([
       "What is your name? ",
+      "\e[2K\e[1GWhat is your name? \n",
       "\e[1A\e[2K\e[1G",
       "What is your name? \n"
     ].join)
@@ -87,6 +89,7 @@ RSpec.describe TTY::Prompt, '#ask' do
     expect(answer).to eq(nil)
     expect(prompt.output.string).to eq([
       "What is your name? ",
+      "\e[2K\e[1GWhat is your name? \n",
       "\e[1A\e[2K\e[1G",
       "What is your name? \n"
     ].join)
@@ -107,9 +110,21 @@ RSpec.describe TTY::Prompt, '#ask' do
 
     expect(prompt.output.string).to eq([
       "[?] What is your name? ",
+      "\e[2K\e[1G[?] What is your name? P",
+      "\e[2K\e[1G[?] What is your name? Pi",
+      "\e[2K\e[1G[?] What is your name? Pio",
+      "\e[2K\e[1G[?] What is your name? Piot",
+      "\e[2K\e[1G[?] What is your name? Piotr",
+      "\e[2K\e[1G[?] What is your name? Piotr\n",
       "\e[1A\e[2K\e[1G",
       "[?] What is your name? \e[36mPiotr\e[0m\n",
       ":-) What is your name? ",
+      "\e[2K\e[1G:-) What is your name? P",
+      "\e[2K\e[1G:-) What is your name? Pi",
+      "\e[2K\e[1G:-) What is your name? Pio",
+      "\e[2K\e[1G:-) What is your name? Piot",
+      "\e[2K\e[1G:-) What is your name? Piotr",
+      "\e[2K\e[1G:-) What is your name? Piotr\n",
       "\e[1A\e[2K\e[1G",
       ":-) What is your name? \e[34mPiotr\e[0m\n"
     ].join)

data/spec/unit/converters/convert_bool_spec.rb

@@ -19,6 +19,7 @@ RSpec.describe TTY::Prompt::Question, 'convert bool' do
     expect(response).to eql(true)
     expect(prompt.output.string).to eq([
       "Do you read books? \e[90m(true)\e[0m ",
+      "\e[2K\e[1GDo you read books? \e[90m(true)\e[0m \n",
       "\e[1A\e[2K\e[1G",
       "Do you read books? \e[32mtrue\e[0m\n"
     ].join)

data/spec/unit/keypress_spec.rb

@@ -1,20 +1,49 @@
 # encoding: utf-8
 
-RSpec.describe TTY::Prompt::Question, 'ask keypress' do
-  it 'asks for a keypress with :read option' do
+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",
+      "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.ask("Which one do you prefer a, b, c or d?", read: :keypress)
+
+    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 method' do
+  it 'asks for a keypress with echo off' do
     prompt = TTY::TestPrompt.new
     prompt.input << "abcd"
     prompt.input.rewind
-    answer = prompt.keypress("Which one do you prefer a, b, c or d?")
+
+    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
@@ -23,7 +52,7 @@ RSpec.describe TTY::Prompt::Question, 'ask keypress' do
     prompt.input.rewind
 
     expect {
-      prompt.keypress("Which one do you prefer a, b, c or d?")
+      prompt.keypress("Press key:")
     }.to raise_error(SystemExit)
   end
 end

data/spec/unit/multi_select_spec.rb

@@ -257,6 +257,24 @@ RSpec.describe TTY::Prompt do
     ].join)
   end
 
+  it "paginates choices as hash object" do
+    prompt = TTY::TestPrompt.new
+    choices = {A: 1, B: 2, C: 3, D: 4, E: 5, F: 6, G: 7, H: 8}
+    prompt.input << "\r"
+    prompt.input.rewind
+    value = prompt.multi_select("What letter?", choices, default: 4, per_page: 3)
+    expect(value).to eq([4])
+    expect(prompt.output.string).to eq([
+      "\e[?25lWhat letter? D \e[90m(Use arrow keys, press Space to select and Enter to finish)\e[0m\n",
+      "#{symbols[:pointer]} \e[32m#{symbols[:radio_on]}\e[0m D\n",
+      "  #{symbols[:radio_off]} E\n",
+      "  #{symbols[:radio_off]} F\n",
+      "\e[90m(Move up or down to reveal more choices)\e[0m",
+      "\e[2K\e[1G\e[1A" * 4, "\e[2K\e[1G",
+      "What letter? \e[32mD\e[0m\n\e[?25h",
+    ].join)
+  end
+
   it "paginates long selections through DSL" do
     prompt = TTY::TestPrompt.new
     choices = %w(A B C D E F G H)

data/spec/unit/multiline_spec.rb

@@ -1,19 +1,77 @@
 # encoding: utf-8
 
-RSpec.describe TTY::Prompt::Question, 'ask multiline' do
-  it 'reads multiple lines with :read option' do
+RSpec.describe TTY::Prompt::Question, '#multiline' do
+  it 'reads no lines' do
     prompt = TTY::TestPrompt.new
-    prompt.input << "First line\nSecond line\nThird line"
+    prompt.input << "\C-d"
     prompt.input.rewind
-    answer = prompt.ask("Provide description?", read: :multiline)
-    expect(answer).to eq(['First line', 'Second line', 'Third line'])
+
+    answer = prompt.multiline("Description?")
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \n"
+    ].join)
+  end
+
+  it "uses defualt when no input" do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?", default: 'A super sweet prompt')
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \e[32mA super sweet prompt\e[0m\n"
+    ].join)
   end
 
-  it 'reads multiple lines with method' do
+  it "changes help text" do
     prompt = TTY::TestPrompt.new
-    prompt.input << "First\nSecond\nThird"
+    prompt.input << "\C-d"
     prompt.input.rewind
-    answer = prompt.multiline("Provide description?")
-    expect(answer).to eq(['First', 'Second', 'Third'])
+
+    answer = prompt.multiline("Description?") do |q|
+      q.default 'A super sweet prompt'
+      q.help '(Press thy ctrl-d to end)'
+    end
+
+    expect(answer).to eq([])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press thy ctrl-d to end)\e[0m\n",
+      "\e[2K\e[1G\e[1A\e[2K\e[1G",
+      "Description? \e[32mA super sweet prompt\e[0m\n"
+    ].join)
+  end
+
+  it 'reads multiple lines with empty lines' do
+    prompt = TTY::TestPrompt.new
+    prompt.input << "aa\n\nbb\n\n\ncc\C-d"
+    prompt.input.rewind
+
+    answer = prompt.multiline("Description?")
+    expect(answer).to eq(["aa\n", "bb\n", "cc"])
+    expect(prompt.output.string).to eq([
+      "Description? \e[90m(Press CTRL-D or CTRL-Z to finish)\e[0m\n",
+      "\e[2K\e[1Ga",
+      "\e[2K\e[1Gaa",
+      "\e[2K\e[1Gaa\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1Gb",
+      "\e[2K\e[1Gbb",
+      "\e[2K\e[1Gbb\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1G\n",
+      "\e[2K\e[1Gc",
+      "\e[2K\e[1Gcc",
+      "\e[2K\e[1G\e[1A" * 6,
+      "\e[2K\e[1G",
+      "Description? \e[32maa ...\e[0m\n"
+    ].join)
   end
 end

data/spec/unit/question/default_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe TTY::Prompt::Question, '#default' do
     expect(answer).to eq(name)
     expect(prompt.output.string).to eq([
       "What is your name? \e[90m(Anonymous)\e[0m ",
+      "\e[2K\e[1GWhat is your name? \e[90m(Anonymous)\e[0m \n",
       "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mAnonymous\e[0m\n"
     ].join)

data/spec/unit/question/echo_spec.rb

@@ -11,6 +11,14 @@ RSpec.describe TTY::Prompt::Question, '#echo' do
     expect(answer).to eql("password")
     expect(prompt.output.string).to eq([
       "What is your password? ",
+      "\e[2K\e[1GWhat is your password? p",
+      "\e[2K\e[1GWhat is your password? pa",
+      "\e[2K\e[1GWhat is your password? pas",
+      "\e[2K\e[1GWhat is your password? pass",
+      "\e[2K\e[1GWhat is your password? passw",
+      "\e[2K\e[1GWhat is your password? passwo",
+      "\e[2K\e[1GWhat is your password? passwor",
+      "\e[2K\e[1GWhat is your password? password",
       "\e[1A\e[2K\e[1G",
       "What is your password? \e[32mpassword\e[0m\n"
     ].join)

data/spec/unit/question/in_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe TTY::Prompt::Question, '#in' do
     expect(answer).to eq('8')
     expect(prompt.output.string).to eq([
       "How do you like it on scale 1-10? ",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8",
       "\e[1A\e[2K\e[1G",
       "How do you like it on scale 1-10? \e[32m8\e[0m\n",
     ].join)
@@ -40,6 +41,9 @@ RSpec.describe TTY::Prompt::Question, '#in' do
     expect(answer).to eq('8.1')
     expect(prompt.output.string).to eq([
       "How do you like it on scale 1-10? ",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8.",
+      "\e[2K\e[1GHow do you like it on scale 1-10? 8.1",
       "\e[1A\e[2K\e[1G",
       "How do you like it on scale 1-10? \e[32m8.1\e[0m\n",
     ].join)
@@ -56,6 +60,7 @@ RSpec.describe TTY::Prompt::Question, '#in' do
     expect(answer).to eq('E')
     expect(prompt.output.string).to eq([
       "Your favourite vitamin? (A-K) ",
+      "\e[2K\e[1GYour favourite vitamin? (A-K) E",
       "\e[1A\e[2K\e[1G",
       "Your favourite vitamin? (A-K) \e[32mE\e[0m\n"
     ].join)
@@ -70,9 +75,13 @@ RSpec.describe TTY::Prompt::Question, '#in' do
     expect(answer).to eq('2')
     expect(prompt.output.string).to eq([
       "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A\n",
       "\e[31m>>\e[0m Value A must be within the range 1..5\e[1A",
       "\e[2K\e[1G",
       "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2\n",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
       "How spicy on scale? (1-5) \e[32m2\e[0m\n"
@@ -91,9 +100,13 @@ RSpec.describe TTY::Prompt::Question, '#in' do
     expect(answer).to eq('2')
     expect(prompt.output.string).to eq([
       "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A",
+      "\e[2K\e[1GHow spicy on scale? (1-5) A\n",
       "\e[31m>>\e[0m Ohh dear what is this A doing in 1..5?\e[1A",
       "\e[2K\e[1G",
       "How spicy on scale? (1-5) ",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2",
+      "\e[2K\e[1GHow spicy on scale? (1-5) 2\n",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
       "How spicy on scale? (1-5) \e[32m2\e[0m\n"

data/spec/unit/question/required_spec.rb

@@ -10,6 +10,11 @@ RSpec.describe TTY::Prompt::Question, '#required' do
     prompt.ask('What is your name?') { |q| q.required(true) }
     expect(prompt.output.string).to eq([
       "What is your name? ",
+      "\e[2K\e[1GWhat is your name? P",
+      "\e[2K\e[1GWhat is your name? Pi",
+      "\e[2K\e[1GWhat is your name? Pio",
+      "\e[2K\e[1GWhat is your name? Piot",
+      "\e[2K\e[1GWhat is your name? Piotr",
       "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mPiotr\e[0m\n"
     ].join)
@@ -21,9 +26,17 @@ RSpec.describe TTY::Prompt::Question, '#required' do
     prompt.ask('What is your name?', required: true)
     expect(prompt.output.string).to eq([
       "What is your name? ",
+      "\e[2K\e[1GWhat is your name?  ",
+      "\e[2K\e[1GWhat is your name?   ",
+      "\e[2K\e[1GWhat is your name?   \n",
       "\e[31m>>\e[0m Value must be provided\e[1A",
       "\e[2K\e[1G",
       "What is your name? ",
+      "\e[2K\e[1GWhat is your name? P",
+      "\e[2K\e[1GWhat is your name? Pi",
+      "\e[2K\e[1GWhat is your name? Pio",
+      "\e[2K\e[1GWhat is your name? Piot",
+      "\e[2K\e[1GWhat is your name? Piotr",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mPiotr\e[0m\n"
@@ -38,22 +51,38 @@ RSpec.describe TTY::Prompt::Question, '#required' do
   end
 
   it "uses required in validation check" do
-    prompt.input << "  \n#{__FILE__}\ntest\n"
+    prompt.input << "  \nexists\ntest\n"
     prompt.input.rewind
     answer = prompt.ask('File name?') do |q|
       q.required(true)
-      q.validate { |v| !::File.exist?(v) }
+      q.validate { |v| !(v =~ /exists/) }
       q.messages[:required?] = 'File name must not be empty!'
       q.messages[:valid?]   = 'File already exists!'
     end
+    expect(answer).to eq('test')
     expect(prompt.output.string).to eq([
       "File name? ",
+      "\e[2K\e[1GFile name?  ",
+      "\e[2K\e[1GFile name?   ",
+      "\e[2K\e[1GFile name?   \n",
       "\e[31m>>\e[0m File name must not be empty!",
       "\e[1A\e[2K\e[1G",
       "File name? ",
+      "\e[2K\e[1GFile name? e",
+      "\e[2K\e[1GFile name? ex",
+      "\e[2K\e[1GFile name? exi",
+      "\e[2K\e[1GFile name? exis",
+      "\e[2K\e[1GFile name? exist",
+      "\e[2K\e[1GFile name? exists",
+      "\e[2K\e[1GFile name? exists\n",
       "\e[31m>>\e[0m File already exists!",
       "\e[1A\e[2K\e[1G",
       "File name? ",
+      "\e[2K\e[1GFile name? t",
+      "\e[2K\e[1GFile name? te",
+      "\e[2K\e[1GFile name? tes",
+      "\e[2K\e[1GFile name? test",
+      "\e[2K\e[1GFile name? test\n",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
       "File name? \e[32mtest\e[0m\n",

data/spec/unit/question/validate_spec.rb

@@ -5,18 +5,21 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
   subject(:prompt) { TTY::TestPrompt.new }
 
   it 'validates input with regex' do
-    prompt.input << 'piotr.murach'
+    prompt.input << 'p.m'
     prompt.input.rewind
 
     answer = prompt.ask('What is your username?') do |q|
       q.validate(/^[^\.]+\.[^\.]+/)
     end
 
-    expect(answer).to eq('piotr.murach')
+    expect(answer).to eq('p.m')
     expect(prompt.output.string).to eq([
       "What is your username? ",
+      "\e[2K\e[1GWhat is your username? p",
+      "\e[2K\e[1GWhat is your username? p.",
+      "\e[2K\e[1GWhat is your username? p.m",
       "\e[1A\e[2K\e[1G",
-      "What is your username? \e[32mpiotr.murach\e[0m\n"
+      "What is your username? \e[32mp.m\e[0m\n"
     ].join)
   end
 
@@ -43,27 +46,41 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
   end
 
   it "provides default error message for wrong input" do
-    prompt.input << "invalid\npiotr@example.com"
+    prompt.input << "wrong\np@m.com\n"
     prompt.input.rewind
 
     answer = prompt.ask('What is your email?') do |q|
       q.validate :email
     end
 
-    expect(answer).to eq('piotr@example.com')
+    expect(answer).to eq('p@m.com')
     expect(prompt.output.string).to eq([
       "What is your email? ",
+      "\e[2K\e[1GWhat is your email? w",
+      "\e[2K\e[1GWhat is your email? wr",
+      "\e[2K\e[1GWhat is your email? wro",
+      "\e[2K\e[1GWhat is your email? wron",
+      "\e[2K\e[1GWhat is your email? wrong",
+      "\e[2K\e[1GWhat is your email? wrong\n",
       "\e[31m>>\e[0m Your answer is invalid (must match :email)\e[1A",
       "\e[2K\e[1G",
       "What is your email? ",
+      "\e[2K\e[1GWhat is your email? p",
+      "\e[2K\e[1GWhat is your email? p@",
+      "\e[2K\e[1GWhat is your email? p@m",
+      "\e[2K\e[1GWhat is your email? p@m.",
+      "\e[2K\e[1GWhat is your email? p@m.c",
+      "\e[2K\e[1GWhat is your email? p@m.co",
+      "\e[2K\e[1GWhat is your email? p@m.com",
+      "\e[2K\e[1GWhat is your email? p@m.com\n",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
-      "What is your email? \e[32mpiotr@example.com\e[0m\n"
+      "What is your email? \e[32mp@m.com\e[0m\n"
     ].join)
   end
 
   it "provides custom error message for wrong input" do
-    prompt.input << "invalid\npiotr@example.com"
+    prompt.input << "wrong\np@m.com"
     prompt.input.rewind
 
     answer = prompt.ask('What is your email?') do |q|
@@ -71,15 +88,28 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
       q.messages[:valid?] = 'Not an email!'
     end
 
-    expect(answer).to eq('piotr@example.com')
+    expect(answer).to eq('p@m.com')
     expect(prompt.output.string).to eq([
       "What is your email? ",
+      "\e[2K\e[1GWhat is your email? w",
+      "\e[2K\e[1GWhat is your email? wr",
+      "\e[2K\e[1GWhat is your email? wro",
+      "\e[2K\e[1GWhat is your email? wron",
+      "\e[2K\e[1GWhat is your email? wrong",
+      "\e[2K\e[1GWhat is your email? wrong\n",
       "\e[31m>>\e[0m Not an email!\e[1A",
       "\e[2K\e[1G",
       "What is your email? ",
+      "\e[2K\e[1GWhat is your email? p",
+      "\e[2K\e[1GWhat is your email? p@",
+      "\e[2K\e[1GWhat is your email? p@m",
+      "\e[2K\e[1GWhat is your email? p@m.",
+      "\e[2K\e[1GWhat is your email? p@m.c",
+      "\e[2K\e[1GWhat is your email? p@m.co",
+      "\e[2K\e[1GWhat is your email? p@m.com",
       "\e[2K\e[1G",
       "\e[1A\e[2K\e[1G",
-      "What is your email? \e[32mpiotr@example.com\e[0m\n"
+      "What is your email? \e[32mp@m.com\e[0m\n"
     ].join)
   end
 end