tty-reader 0.4.0 → 0.5.0

data/lib/tty/reader/mode.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'io/console'

data/lib/tty/reader/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Reader
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'
   end # Reader
 end # TTY

data/lib/tty/reader/win_api.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'fiddle'
@@ -8,9 +7,7 @@ module TTY
     module WinAPI
       include Fiddle
 
-      Handle = RUBY_VERSION >= "2.0.0" ? Fiddle::Handle : DL::Handle
-
-      CRT_HANDLE = Handle.new("msvcrt") rescue Handle.new("crtdll")
+      CRT_HANDLE = Fiddle::Handle.new("msvcrt") rescue Fiddle::Handle.new("crtdll")
 
       # Get a character from the console without echo.
       #

data/lib/tty/reader/win_console.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require_relative 'keys'

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require "bundler/setup"
+require "tty-reader"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/history_spec.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Reader::History do
+  it "has no lines" do
+    history = described_class.new
+    expect(history.size).to eq(0)
+  end
+
+  it "doesn't navigate through empty buffer" do
+    history = described_class.new
+    expect(history.next?).to eq(false)
+    expect(history.previous?).to eq(false)
+  end
+
+  it "allows to cycle through non-empty buffer" do
+    history = described_class.new(3, {cycle: true})
+    history << "line"
+    expect(history.next?).to eq(true)
+    expect(history.previous?).to eq(true)
+  end
+
+  it "defaults maximum size" do
+    history = described_class.new
+    expect(history.max_size).to eq(512)
+  end
+
+  it "presents string representation" do
+    history = described_class.new
+    expect(history.to_s).to eq("[]")
+  end
+
+  it "adds items to history without overflowing" do
+    history = described_class.new(3)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+    history << "line #4"
+
+    expect(history.to_a).to eq(["line #2", "line #3", "line #4"])
+    expect(history.index).to eq(2)
+  end
+
+  it "excludes items" do
+    exclude = proc { |line| /line #[23]/.match(line) }
+    history = described_class.new(exclude: exclude)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.to_a).to eq(["line #1"])
+    expect(history.index).to eq(0)
+  end
+
+  it "allows duplicates" do
+    history = described_class.new
+    history << "line #1"
+    history << "line #1"
+    history << "line #1"
+
+    expect(history.to_a).to eq(["line #1", "line #1", "line #1"])
+  end
+
+  it "prevents duplicates" do
+    history = described_class.new(duplicates: false)
+    history << "line #1"
+    history << "line #1"
+    history << "line #1"
+
+    expect(history.to_a).to eq(["line #1"])
+  end
+
+  it "navigates through history buffer without cycling" do
+    history = described_class.new(3)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.index).to eq(2)
+    history.previous
+    history.previous
+    expect(history.index).to eq(0)
+    history.previous
+    expect(history.index).to eq(0)
+    history.next
+    history.next
+    expect(history.index).to eq(2)
+    history.next
+    expect(history.next?).to eq(false)
+    expect(history.index).to eq(2)
+  end
+
+  it "navigates through history buffer with cycling" do
+    history = described_class.new(3, cycle: true)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.index).to eq(2)
+    history.previous
+    history.previous
+    expect(history.index).to eq(0)
+    history.previous
+    expect(history.index).to eq(2)
+    expect(history.next?).to eq(true)
+    history.next
+    history.next
+    expect(history.index).to eq(1)
+    history.next
+    expect(history.index).to eq(2)
+  end
+
+  it "checks if navigation is possible" do
+    history = described_class.new(3)
+
+    expect(history.index).to eq(nil)
+    expect(history.previous?).to eq(false)
+    expect(history.next?).to eq(false)
+
+    history << "line #1"
+    history << "line #2"
+    expect(history.index).to eq(1)
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(false)
+
+    history.previous
+    expect(history.index).to eq(0)
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(true)
+
+    history.previous
+    expect(history.index).to eq(0)
+    expect(history.previous?).to eq(true)
+    expect(history.next?).to eq(true)
+  end
+
+  it "gets line based on index" do
+    history = described_class.new(3, cycle: true)
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history[-1]).to eq('line #3')
+    expect(history[1]).to eq('line #2')
+    expect {
+      history[11]
+    }.to raise_error(IndexError, 'invalid index')
+  end
+
+  it "retrieves current line" do
+    history = described_class.new(3, cycle: true)
+    expect(history.get).to eq(nil)
+
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.get).to eq("line #3")
+    history.previous
+    history.previous
+    expect(history.get).to eq("line #1")
+    history.next
+    expect(history.get).to eq("line #2")
+  end
+
+  it "clears all lines" do
+    history = described_class.new(3)
+
+    history << "line #1"
+    history << "line #2"
+    history << "line #3"
+
+    expect(history.size).to eq(3)
+    history.clear
+    expect(history.size).to eq(0)
+    expect(history.index).to eq(0)
+  end
+end

data/spec/unit/key_event_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+RSpec.describe TTY::Reader::KeyEvent, '#from' do
+  let(:keys) { TTY::Reader::Keys.keys }
+
+  it "parses backspace" do
+    event = described_class.from(keys, "\x7f")
+    expect(event.key.name).to eq(:backspace)
+    expect(event.value).to eq("\x7f")
+  end
+
+  it "parses lowercase char" do
+    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(keys, 'A')
+    expect(event.key.name).to eq(:alpha)
+    expect(event.value).to eq('A')
+  end
+
+  it "parses number char" do
+    event = described_class.from(keys, '666')
+    expect(event.key.name).to eq(:num)
+    expect(event.value).to eq('666')
+  end
+
+  it "parses ctrl-a to ctrl-z inputs" do
+    (1..26).zip('a'..'z').each do |code, char|
+      event = described_class.from(TTY::Reader::Keys.ctrl_keys, code.chr)
+      expect(event.key.name).to eq(:"ctrl_#{char}")
+      expect(event.value).to eq(code.chr)
+    end
+  end
+
+  it "parses uknown key" do
+    no_keys = {}
+    event = described_class.from(no_keys, '*')
+    expect(event.key.name).to eq(:ignore)
+    expect(event.value).to eq('*')
+  end
+
+  it "exposes line value" do
+    event = described_class.from(keys, 'c', 'ab')
+    expect(event.line).to eq('ab')
+  end
+
+  # F1-F12 keys
+  {
+    f1:  ["\eOP","\e[[A","\e[11~"],
+    f2:  ["\eOQ","\e[[B","\e[12~"],
+    f3:  ["\eOR","\e[[C","\e[13~"],
+    f4:  ["\eOS","\e[[D","\e[14~"],
+    f5:  [       "\e[[E","\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(keys, 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(false)
+      end
+    end
+  end
+
+  # arrow keys & text editing
+  {
+    up:     ["\e[A"],
+    down:   ["\e[B"],
+    right:  ["\e[C"],
+    left:   ["\e[D"],
+    clear:  ["\e[E"],
+    home:   ["\e[1~", "\e[7~", "\e[H"],
+    end:    ["\e[4~", "\eOF", "\e[F"],
+    insert: ["\e[2~"],
+    delete: ["\e[3~"],
+    page_up:   ["\e[5~"],
+    page_down: ["\e[6~"]
+  }.each do |name, codes|
+    codes.each do |code|
+      it "parses #{Shellwords.escape(code)} as #{name} key" do
+        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)
+        expect(event.key.shift).to eq(false)
+      end
+    end
+  end
+end

data/spec/unit/line_spec.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Reader::Line do
+  it "provides access to the prompt" do
+    line = described_class.new('aaa', prompt: '>> ')
+    expect(line.prompt).to eq('>> ')
+    expect(line.text).to eq('aaa')
+    expect(line.size).to eq(6)
+    expect(line.to_s).to eq(">> aaa")
+  end
+
+  it "inserts characters inside a line" do
+    line = described_class.new('aaaaa')
+
+    line[0] = 'test'
+    expect(line.text).to eq('testaaaaa')
+
+    line[4..6] = ''
+    expect(line.text).to eq('testaa')
+  end
+
+  it "moves cursor left and right" do
+    line = described_class.new('aaaaa')
+
+    5.times { line.left }
+    expect(line.cursor).to eq(0)
+    expect(line.start?).to eq(true)
+
+    line.left(5)
+    expect(line.cursor).to eq(0)
+
+    line.right(20)
+    expect(line.cursor).to eq(5)
+    expect(line.end?).to eq(true)
+  end
+
+  it "inserts char at start of the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+
+    line[0] = 'b'
+    expect(line.cursor).to eq(1)
+    expect(line.text).to eq('baaaaa')
+
+    line.insert('b')
+    expect(line.text).to eq('bbaaaaa')
+  end
+
+  it "inserts char at end of the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+
+    line[4] = 'b'
+    expect(line.cursor).to eq(5)
+    expect(line.text).to eq('aaaaba')
+  end
+
+  it "inserts char inside the line" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+
+    line[2] = 'b'
+    expect(line.cursor).to eq(3)
+    expect(line.text).to eq('aabaaa')
+  end
+
+  it "inserts char outside of the line size" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+
+    line[10] = 'b'
+    expect(line.cursor).to eq(11)
+    expect(line.text).to eq('aaaaa     b')
+  end
+
+  it "inserts chars in empty string" do
+    line = described_class.new('')
+    expect(line.cursor).to eq(0)
+
+    line.insert('a')
+    expect(line.cursor).to eq(1)
+
+    line.insert('b')
+    expect(line.cursor).to eq(2)
+    expect(line.to_s).to eq('ab')
+
+    line.insert('cc')
+    expect(line.cursor).to eq(4)
+    expect(line.to_s).to eq('abcc')
+  end
+
+  it "inserts characters with #insert call" do
+    line = described_class.new('aaaaa')
+    expect(line.cursor).to eq(5)
+
+    line.left(2)
+    expect(line.cursor).to eq(3)
+
+    line.insert(' test ')
+    expect(line.text).to eq('aaa test aa')
+    expect(line.cursor).to eq(9)
+
+    line.right
+    expect(line.cursor).to eq(10)
+  end
+
+  it "removes char before current cursor position" do
+    line = described_class.new('abcdef')
+    expect(line.cursor).to eq(6)
+
+    line.remove
+    line.remove
+    expect(line.text).to eq('abcd')
+    expect(line.cursor).to eq(4)
+
+    line.left
+    line.left
+    line.remove
+    expect(line.text).to eq('acd')
+    expect(line.cursor).to eq(1)
+
+    line.insert('x')
+    expect(line.text).to eq('axcd')
+  end
+
+  it "deletes char under current cursor position" do
+    line = described_class.new('abcdef')
+
+    line.left(3)
+    line.delete
+    expect(line.text).to eq('abcef')
+
+    line.right
+    line.delete
+    expect(line.text).to eq('abce')
+
+    line.left(4)
+    line.delete
+    expect(line.text).to eq('bce')
+  end
+
+  it "replaces current line with new preserving cursor" do
+    line = described_class.new('x' * 6)
+    expect(line.text).to eq('xxxxxx')
+    expect(line.cursor).to eq(6)
+    expect(line.mode).to eq(:edit)
+    expect(line.editing?).to eq(true)
+
+    line.replace('y' * 8)
+    expect(line.text).to eq('y' * 8)
+    expect(line.cursor).to eq(8)
+    expect(line.replacing?).to eq(true)
+
+    line.insert('z')
+    expect(line.text).to eq('y' * 8 + 'z')
+    expect(line.cursor).to eq(9)
+    expect(line.editing?).to eq(true)
+  end
+end