tty-prompt 0.10.1 → 0.11.0

data/spec/unit/question/default_spec.rb

@@ -12,8 +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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mAnonymous\e[0m\n"
     ].join)
   end
@@ -24,8 +23,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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mAnonymous\e[0m\n"
     ].join)
   end

data/spec/unit/question/echo_spec.rb

@@ -11,8 +11,7 @@ RSpec.describe TTY::Prompt::Question, '#echo' do
     expect(answer).to eql("password")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your password? \e[32mpassword\e[0m\n"
     ].join)
   end
@@ -24,7 +23,7 @@ RSpec.describe TTY::Prompt::Question, '#echo' do
     expect(answer).to eql("password")
     expect(prompt.output.string).to eq([
       "What is your password? ",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your password? \n"
     ].join)
   end

data/spec/unit/question/in_spec.rb

@@ -24,8 +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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "How do you like it on scale 1-10? \e[32m8\e[0m\n",
     ].join)
   end
@@ -41,8 +40,7 @@ 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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "How do you like it on scale 1-10? \e[32m8.1\e[0m\n",
     ].join)
   end
@@ -58,8 +56,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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "Your favourite vitamin? (A-K) \e[32mE\e[0m\n"
     ].join)
   end
@@ -73,12 +70,11 @@ 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[1000D\e[K",
       "\e[31m>>\e[0m Value A must be within the range 1..5\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "How spicy on scale? (1-5) ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "How spicy on scale? (1-5) \e[32m2\e[0m\n"
     ].join)
   end
@@ -95,12 +91,11 @@ 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[1000D\e[K",
       "\e[31m>>\e[0m Ohh dear what is this A doing in 1..5?\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "How spicy on scale? (1-5) ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "How spicy on scale? (1-5) \e[32m2\e[0m\n"
     ].join)
   end

data/spec/unit/question/modifier/letter_case_spec.rb

@@ -1,20 +1,41 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Question::Modifier, '#letter_case' do
-  let(:string) { 'text to modify' }
+  context "string" do
+    let(:string) { 'text to modify' }
 
-  it "changes to uppercase" do
-    modified = described_class.letter_case(:up, string)
-    expect(modified).to eq('TEXT TO MODIFY')
-  end
+    it "changes to uppercase" do
+      modified = described_class.letter_case(:up, string)
+      expect(modified).to eq('TEXT TO MODIFY')
+    end
+
+    it "changes to lower case" do
+      modified = described_class.letter_case(:down, string)
+      expect(modified).to eq('text to modify')
+    end
 
-  it "changes to lower case" do
-    modified = described_class.letter_case(:down, string)
-    expect(modified).to eq('text to modify')
+    it "capitalizes text" do
+      modified = described_class.letter_case(:capitalize, string)
+      expect(modified).to eq('Text to modify')
+    end
   end
 
-  it "capitalizes text" do
-    modified = described_class.letter_case(:capitalize, string)
-    expect(modified).to eq('Text to modify')
+  context "nil (empty user input)" do
+    let(:string) { nil }
+
+    example "up returns nil" do
+      modified = described_class.letter_case(:up, string)
+      expect(modified).to be_nil
+    end
+
+    example "down returns nil" do
+      modified = described_class.letter_case(:down, string)
+      expect(modified).to be_nil
+    end
+
+    example "capitalize returns nil" do
+      modified = described_class.letter_case(:capitalize, string)
+      expect(modified).to be_nil
+    end
   end
 end

data/spec/unit/question/modifier/whitespace_spec.rb

@@ -1,25 +1,51 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Question::Modifier, '#whitespace' do
-  let(:string) { "  text\t \n  to\t   modify\r\n" }
+  context "string with whitespaces" do
+    let(:string) { "  text\t \n  to\t   modify\r\n" }
 
-  it "trims whitespace" do
-    modified = described_class.whitespace(:trim, string)
-    expect(modified).to eq("text\t \n  to\t   modify")
-  end
+    it "trims whitespace" do
+      modified = described_class.whitespace(:trim, string)
+      expect(modified).to eq("text\t \n  to\t   modify")
+    end
 
-  it "chomps whitespace" do
-    modified = described_class.whitespace(:chomp, string)
-    expect(modified).to eq("  text\t \n  to\t   modify")
-  end
+    it "chomps whitespace" do
+      modified = described_class.whitespace(:chomp, string)
+      expect(modified).to eq("  text\t \n  to\t   modify")
+    end
 
-  it "collapses text" do
-    modified = described_class.whitespace(:collapse, string)
-    expect(modified).to eq(" text to modify ")
+    it "collapses text" do
+      modified = described_class.whitespace(:collapse, string)
+      expect(modified).to eq(" text to modify ")
+    end
+
+    it "removes whitespace" do
+      modified = described_class.whitespace(:remove, string)
+      expect(modified).to eq("texttomodify")
+    end
   end
 
-  it "removes whitespace" do
-    modified = described_class.whitespace(:remove, string)
-    expect(modified).to eq("texttomodify")
+  context "nil (empty user input)" do
+    let(:string) { nil }
+
+    example "trim returns nil" do
+      modified = described_class.whitespace(:trim, string)
+      expect(modified).to be_nil
+    end
+
+    example "chomp returns nil" do
+      modified = described_class.whitespace(:chomp, string)
+      expect(modified).to be_nil
+    end
+
+    example "collapse returns nil" do
+      modified = described_class.whitespace(:collapse, string)
+      expect(modified).to be_nil
+    end
+
+    example "remove returns nil" do
+      modified = described_class.whitespace(:remove, string)
+      expect(modified).to be_nil
+    end
   end
 end

data/spec/unit/question/required_spec.rb

@@ -10,8 +10,7 @@ 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[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mPiotr\e[0m\n"
     ].join)
   end
@@ -22,12 +21,11 @@ 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[1000D\e[K",
       "\e[31m>>\e[0m Value must be provided\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your name? ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "What is your name? \e[32mPiotr\e[0m\n"
     ].join)
   end
@@ -50,16 +48,14 @@ RSpec.describe TTY::Prompt::Question, '#required' do
     end
     expect(prompt.output.string).to eq([
       "File name? ",
-       "\e[1000D\e[K",
-       "\e[31m>>\e[0m File name must not be empty!",
-       "\e[1A\e[1000D\e[K",
+      "\e[31m>>\e[0m File name must not be empty!",
+      "\e[1A\e[2K\e[1G",
       "File name? ",
-      "\e[1000D\e[K",
       "\e[31m>>\e[0m File already exists!",
-      "\e[1A\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "File name? ",
-      "\e[1000D\e[K",
-      "\e[1A\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "File name? \e[32mtest\e[0m\n",
     ].join)
     expect(answer).to eq('test')

data/spec/unit/question/validate_spec.rb

@@ -15,8 +15,7 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
     expect(answer).to eq('piotr.murach')
     expect(prompt.output.string).to eq([
       "What is your username? ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[1A\e[2K\e[1G",
       "What is your username? \e[32mpiotr.murach\e[0m\n"
     ].join)
   end
@@ -54,12 +53,11 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
     expect(answer).to eq('piotr@example.com')
     expect(prompt.output.string).to eq([
       "What is your email? ",
-      "\e[1000D\e[K",
       "\e[31m>>\e[0m Your answer is invalid (must match :email)\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your email? ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "What is your email? \e[32mpiotr@example.com\e[0m\n"
     ].join)
   end
@@ -76,12 +74,11 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
     expect(answer).to eq('piotr@example.com')
     expect(prompt.output.string).to eq([
       "What is your email? ",
-      "\e[1000D\e[K",
       "\e[31m>>\e[0m Not an email!\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
       "What is your email? ",
-      "\e[1000D\e[K\e[1A",
-      "\e[1000D\e[K",
+      "\e[2K\e[1G",
+      "\e[1A\e[2K\e[1G",
       "What is your email? \e[32mpiotr@example.com\e[0m\n"
     ].join)
   end

data/spec/unit/reader/key_event_spec.rb

@@ -1,51 +1,56 @@
 # encoding: utf-8
 
 require 'shellwords'
+require 'tty/prompt/reader/codes'
 
 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
+  let(:keys) { TTY::Prompt::Reader::Codes.keys }
 
   it "parses backspace" do
-    event = described_class.from("\e\x7f")
+    event = described_class.from(keys, "\x7f")
     expect(event.key.name).to eq(:backspace)
-    expect(event.key.meta).to eq(true)
-    expect(event.value).to eq("\e\x7f")
+    expect(event.value).to eq("\x7f")
   end
 
   it "parses lowercase char" do
-    event = described_class.from('a')
-    expect(event.key.name).to eq('a')
+    event = described_class.from(keys, 'a')
+    expect(event.key.name).to eq(:alpha)
     expect(event.value).to eq('a')
   end
 
   it "parses uppercase char" do
-    event = described_class.from('A')
-    expect(event.key.name).to eq('a')
+    event = described_class.from(keys, 'A')
+    expect(event.key.name).to eq(:alpha)
     expect(event.value).to eq('A')
   end
 
+  it "parses ctrl-a to ctrl-z inputs" do
+    (1..26).zip('a'..'z').each do |code, char|
+      next if ['i', 'j', 'm'].include?(char)
+      event = described_class.from(keys, code.chr)
+      expect(event.key.name).to eq(:"ctrl_#{char}")
+      expect(event.value).to eq(code.chr)
+    end
+  end
+
   # F1-F12 keys
   {
-    f1:  ["\eOP", "\e[11~", "\e[[A"],
-    f2:  ["\eOQ", "\e[12~", "\e[[B"],
-    f3:  ["\eOR", "\e[13~", "\e[[C"],
-    f4:  ["\eOS", "\e[14~", "\e[[D"],
-    f5:  [        "\e[15~", "\e[[E"],
-    f6:  [        "\e[17~"         ],
-    f7:  [        "\e[18~"         ],
-    f8:  [        "\e[19~"         ],
-    f9:  [        "\e[20~"         ],
-    f10: [        "\e[21~"         ],
-    f11: [        "\e[23~"         ],
-    f12: [        "\e[24~"         ]
+    f1:  ["\eOP", "\e[11~"],
+    f2:  ["\eOQ", "\e[12~"],
+    f3:  ["\eOR", "\e[13~"],
+    f4:  ["\eOS", "\e[14~"],
+    f5:  [        "\e[15~"],
+    f6:  [        "\e[17~"],
+    f7:  [        "\e[18~"],
+    f8:  [        "\e[19~"],
+    f9:  [        "\e[20~"],
+    f10: [        "\e[21~"],
+    f11: [        "\e[23~"],
+    f12: [        "\e[24~"]
   }.each do |name, codes|
     codes.each do |code|
       it "parses #{Shellwords.escape(code)} as #{name} key" do
-        event = described_class.from(code)
+        event = described_class.from(keys, code)
         expect(event.key.name).to eq(name)
         expect(event.key.meta).to eq(false)
         expect(event.key.ctrl).to eq(false)
@@ -55,19 +60,18 @@ RSpec.describe TTY::Prompt::Reader::KeyEvent, '#from' do
   end
 
   # arrow keys & page navigation
-  #
   {
-    up:    ["\e[A", "\eOA"],
-    down:  ["\e[B", "\eOB"],
-    right: ["\e[C", "\eOC"],
-    left:  ["\e[D", "\eOD"],
-    clear: ["\e[E", "\eOE"],
+    up:    ["\e[A"],
+    down:  ["\e[B"],
+    right: ["\e[C"],
+    left:  ["\e[D"],
+    clear: ["\e[E"],
     end:   ["\e[F"],
     home:  ["\e[H"]
   }.each do |name, codes|
     codes.each do |code|
       it "parses #{Shellwords.escape(code)} as #{name} key" do
-        event = described_class.from(code)
+        event = described_class.from(keys, code)
         expect(event.key.name).to eq(name)
         expect(event.key.meta).to eq(false)
         expect(event.key.ctrl).to eq(false)
@@ -75,22 +79,4 @@ RSpec.describe TTY::Prompt::Reader::KeyEvent, '#from' do
       end
     end
   end
-
-  {
-    up:    ["\e[a"],
-    down:  ["\e[b"],
-    right: ["\e[c"],
-    left:  ["\e[d"],
-    clear: ["\e[e"],
-  }.each do |name, codes|
-    codes.each do |code|
-      it "parses #{Shellwords.escape(code)} as SHIFT + #{name} key" do
-        event = described_class.from(code)
-        expect(event.key.name).to eq(name)
-        expect(event.key.meta).to eq(false)
-        expect(event.key.ctrl).to eq(false)
-        expect(event.key.shift).to eq(true)
-      end
-    end
-  end
 end

data/spec/unit/reader/publish_keypress_event_spec.rb

@@ -3,7 +3,9 @@
 RSpec.describe TTY::Prompt::Reader, '#publish_keypress_event' do
   let(:input)  { StringIO.new }
   let(:out) { StringIO.new }
-  let(:reader) { described_class.new(input, out) }
+  let(:env)    { { "TTY_TEST" => true } }
+
+  let(:reader) { described_class.new(input, out, env: env) }
 
   it "publishes :keypress events" do
     input << "abc\n"
@@ -11,8 +13,8 @@ RSpec.describe TTY::Prompt::Reader, '#publish_keypress_event' do
     chars = []
     reader.on(:keypress) { |event| chars << event.value }
     answer = reader.read_line
-    expect(chars).to eq(%w(a b c))
-    expect(answer).to eq("abc")
+    expect(chars).to eq(%W(a b c \n))
+    expect(answer).to eq("abc\n")
   end
 
   it "publishes :keyup for read_keypress" do