tty-reader 0.7.0 → 0.8.0

data/Rakefile

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/benchmarks/speed_read_char.rb

@@ -1,34 +0,0 @@
-require 'benchmark/ips'
-require 'tty-reader'
-
-input = StringIO.new("a")
-output = StringIO.new
-$stdin = input
-reader = TTY::Reader.new(input, output)
-
-Benchmark.ips do |x|
-  x.report('getc') do
-    input.rewind
-    $stdin.getc
-  end
-
-  x.report('read_char') do
-    input.rewind
-    reader.read_char
-  end
-
-  x.compare!
-end
-
-# v0.1.0
-#
-# Calculating -------------------------------------
-#                 getc     52462 i/100ms
-#            read_char       751 i/100ms
-# -------------------------------------------------
-#                 getc  2484819.4 (±4.1%) i/s -   12433494 in   5.013438s
-#            read_char     7736.4 (±2.9%) i/s -      39052 in   5.052628s
-#
-# Comparison:
-#                 getc:  2484819.4 i/s
-#            read_char:     7736.4 i/s - 321.19x slower

data/benchmarks/speed_read_line.rb

@@ -1,34 +0,0 @@
-require 'benchmark/ips'
-require 'tty-reader'
-
-input = StringIO.new("abc\n")
-output = StringIO.new
-$stdin = input
-reader = TTY::Reader.new(input, output)
-
-Benchmark.ips do |x|
-  x.report('gets') do
-    input.rewind
-    $stdin.gets
-  end
-
-  x.report('read_line') do
-    input.rewind
-    reader.read_line
-  end
-
-  x.compare!
-end
-
-# v0.1.0
-#
-# Calculating -------------------------------------
-#                 gets     51729 i/100ms
-#            read_line       164 i/100ms
-# -------------------------------------------------
-#                 gets  1955255.2 (±3.7%) i/s -    9776781 in   5.008004s
-#            read_line     1215.1 (±33.1%) i/s -       5248 in   5.066569s
-#
-# Comparison:
-#                 gets:  1955255.2 i/s
-#            read_line:     1215.1 i/s - 1609.19x slower

data/bin/console

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/reader"
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/keypress.rb

@@ -1,16 +0,0 @@
-require_relative '../lib/tty-reader'
-
-reader = TTY::Reader.new
-
-puts "Press a key (or Ctrl-X to exit)"
-
-loop do
-  print "=> "
-  char = reader.read_keypress
-  if ?\C-x == char
-    puts "Exiting..."
-    exit
-  else
-    puts "#{char.inspect} [#{char.ord}] (hex: #{char.ord.to_s(16)})"
-  end
-end

data/examples/keypress_nonblock.rb

@@ -1,17 +0,0 @@
-require_relative '../lib/tty-reader'
-
-reader = TTY::Reader.new
-
-puts "Press a key (or Ctrl-X to exit)"
-
-loop do
-  print reader.cursor.clear_line
-  print "=> "
-  char = reader.read_keypress(nonblock: true)
-  if ?\C-x == char
-    puts "Exiting..."
-    exit
-  elsif char
-    puts "#{char.inspect} [#{char.ord}] (hex: #{char.ord.to_s(16)})"
-  end
-end

data/examples/line.rb

@@ -1,7 +0,0 @@
-require_relative '../lib/tty-reader'
-
-reader = TTY::Reader.new
-
-answer = reader.read_line(">> ")
-
-puts "answer: #{answer}"

data/examples/multi_prompt.rb

@@ -1,9 +0,0 @@
-require_relative "../lib/tty-reader"
-
-reader = TTY::Reader.new
-
-reader.on(:keyctrl_x, :keyescape) { puts "Exiting..."; exit }
-
-loop do
-  reader.read_line("one\ntwo\nthree")
-end

data/examples/multiline.rb

@@ -1,7 +0,0 @@
-require_relative '../lib/tty-reader'
-
-reader = TTY::Reader.new
-
-answer = reader.read_multiline(">> ")
-
-puts "\nanswer: #{answer}"

data/examples/noecho.rb

@@ -1,6 +0,0 @@
-require_relative '../lib/tty-reader'
-
-reader = TTY::Reader.new
-
-answer = reader.read_line('=> ', echo: false)
-puts "Answer: #{answer}"

data/examples/shell.rb

@@ -1,12 +0,0 @@
-require_relative '../lib/tty-reader'
-
-puts "*** TTY::Reader Shell ***"
-puts "Press Ctrl-X or ESC to exit"
-
-reader = TTY::Reader.new
-
-reader.on(:keyctrl_x, :keyescape) { puts "Exiting..."; exit }
-
-loop do
-  reader.read_line('=> ')
-end

data/spec/spec_helper.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ])
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require "bundler/setup"
-require "tty-reader"
-
-class StringIO
-  def wait_readable(*)
-    true
-  end
-end
-
-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

@@ -1,177 +0,0 @@
-# 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

@@ -1,102 +0,0 @@
-# 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