tty-reader 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995b414e2605c556220168d30b3f894771e021f2956aa75821fb3504f5ae6589
-  data.tar.gz: 4bfa84cd59cab3b14410d4eac314ae819765d94230c1c9b2a1ce94c09e13c80d
+  metadata.gz: 6193cf64fd770d652ff66d89ff395c28f52181521242ce432b3b651aa7b13d63
+  data.tar.gz: 7fa878638a8851265dfed9f8970f03fd360f975007c8ad0c865bf2bb304c64a1
 SHA512:
-  metadata.gz: 061eeb4dc0698c1ff226ad3a2bc9fe69e4c519fe455642bda6bb9675e758e52c385335bb1604256f2002c75f6b2ba8528007e8df9d332815df8f072b75bd1388
-  data.tar.gz: e964e5cf12b271ce1fee675afc1d348f7f6c59a01f007580936c2544e672f784a1297e0f7f8ee6acce2d6ee4f867ca32b2142d3d376f5a4a28c82e2ab6521713
+  metadata.gz: 91136b6cecab81d4705560af21775ae5e4140e860c1d2413e8c01b545652623f2d17c2a146494fcf790d0c3e996a4b38cab1a80741f1900d3422eb4018e861ac
+  data.tar.gz: bf159f08943f118a48c133171410bd5e9f8f6e8da0f83be54745e653648f9d3de7863025667a4a08da19d8ba27ab1c1c6cab0add921777de23a7a0b069c2ac15

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.6.0] - 2019-05-27
+
+### Added
+* Add :value option to #read_line to allow pre-populating of line content
+
+### Changed
+* Change to make InputInterrupt to derive from Interrupt by Samuel Williams(@ioquatix)
+* Change #read_line to trigger before line is printed to allow for line changes in key callbacks
+* Change Console#get_char :nonblock option to wait for readable input without blocking
+* Change to remove bundler version constraints
+* Change to update tty-screen dependency
+* Change to update tty-cursor dependency
+
 ## [v0.5.0] - 2018-11-24
 
 ### Added
@@ -47,6 +60,7 @@
 
 * Initial implementation and release
 
+[v0.6.0]: https://github.com/piotrmurach/tty-reader/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/piotrmurach/tty-reader/compare/v0.4.0...v0.5.0
 [v0.4.0]: https://github.com/piotrmurach/tty-reader/compare/v0.3.0...v0.4.0
 [v0.3.0]: https://github.com/piotrmurach/tty-reader/compare/v0.2.0...v0.3.0

data/README.md

@@ -140,7 +140,14 @@ You can also provide a line prefix displayed before input by passing it as a fir
 
 ```ruby
 reader.read_line(">> ")
-# >> input goes here ...
+# >>
+```
+
+To pre-populate the line content for editing use `:value` option:
+
+```ruby
+reader.read_line("> ", value: "edit me")
+# > edit me
 ```
 
 ### 2.3 read_multiline
@@ -230,13 +237,13 @@ class MyListener
 end
 ```
 
-Then subcribing is done:
+Then subscribing is done:
 
 ```ruby
 reader.subscribe(MyListener.new)
 ```
 
-Alternatively, `subscribe` allows you to listen to events only for the dueration of block execution like so:
+Alternatively, `subscribe` allows you to listen to events only for the duration of block execution like so:
 
 ```ruby
 reader.subscribe(MyListener) do
@@ -290,7 +297,7 @@ The available key events for character input are:
 * `:keyalpha`
 * `:keynum`
 
-The navigation relted key events are:
+The navigation related key events are:
 
 * `:keydown`
 * `:keyup`
@@ -333,7 +340,7 @@ reader = TTY::Reader.new(interrupt: :signal)
 
 ### 3.2. `:track_history`
 
-The `read_line` and `read_multiline` provide history buffer that tracks all the lines entered during `TTY::Reader.new` interactions. The history buffer provides previoius or next lines when user presses up/down arrows respectively. However, if you wish to disable this behaviour use `:track_history` option like so:
+The `read_line` and `read_multiline` provide history buffer that tracks all the lines entered during `TTY::Reader.new` interactions. The history buffer provides previous or next lines when user presses up/down arrows respectively. However, if you wish to disable this behaviour use `:track_history` option like so:
 
 ```ruby
 reader = TTY::Reader.new(track_history: false)
@@ -357,7 +364,7 @@ reader = TTY::Reader.new(history_duplicates: false)
 
 ### 3.5. `:history_exclude`
 
-This option allows you to exclude lines from being stored in history. It accepts a `Proc` with a line as a first argument. By default it is set to exlude empty lines. To change this:
+This option allows you to exclude lines from being stored in history. It accepts a `Proc` with a line as a first argument. By default it is set to exclude empty lines. To change this:
 
 ```ruby
 reader = TTY::Reader.new(history_exclude: ->(line) { ... })

data/examples/keypress_nonblock.rb

@@ -0,0 +1,17 @@
+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/lib/tty/reader.rb

@@ -23,7 +23,7 @@ module TTY
     # Raised when the user hits the interrupt key(Control-C)
     #
     # @api public
-    InputInterrupt = Class.new(StandardError)
+    InputInterrupt = Class.new(Interrupt)
 
     # Check if Windowz mode
     #
@@ -215,6 +215,9 @@ module TTY
     # @param [String] prompt
     #   the prompt to display before input
     #
+    # @param [String] value
+    #   the value to pre-populate line with
+    #
     # @param [Boolean] echo
     #   if true echo back characters, output nothing otherwise
     #
@@ -223,10 +226,11 @@ module TTY
     # @api public
     def read_line(prompt = '', **options)
       opts = { echo: true, raw: true }.merge(options)
-      line = Line.new(prompt: prompt)
+      value = options.fetch(:value, '')
+      line = Line.new(value, prompt: prompt)
       screen_width = TTY::Screen.width
 
-      output.print(line.prompt)
+      output.print(line)
 
       while (codes = get_codes(opts)) && (code = codes[0])
         char = codes.pack('U*')
@@ -277,6 +281,9 @@ module TTY
           end
         end
 
+        # trigger before line is printed to allow for line changes
+        trigger_key_event(char, line: line.to_s)
+
         if opts[:raw] && opts[:echo]
           output.print(line.to_s)
           if char == "\n"
@@ -286,8 +293,6 @@ module TTY
           end
         end
 
-        trigger_key_event(char, line: line.to_s)
-
         if [CARRIAGE_RETURN, NEWLINE].include?(code)
           output.puts unless opts[:echo]
           break

data/lib/tty/reader/console.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'io/wait'
+
 require_relative 'keys'
 require_relative 'mode'
 
@@ -9,6 +11,8 @@ module TTY
       ESC = "\e".freeze
       CSI = "\e[".freeze
 
+      TIMEOUT = 0.1
+
       # Key codes
       #
       # @return [Hash[Symbol]]
@@ -43,14 +47,12 @@ module TTY
         mode.raw(options[:raw]) do
           mode.echo(options[:echo]) do
             if options[:nonblock]
-              input.read_nonblock(1)
+              input.wait_readable(TIMEOUT) ? input.getc : nil
             else
               input.getc
             end
           end
         end
-      rescue IO::WaitReadable, EOFError
-        # no more bytes to read
       end
 
       protected

data/lib/tty/reader/line.rb

@@ -209,16 +209,19 @@ module TTY
       # Remove char from the line at current position
       #
       # @api public
-      def delete
-        @text.slice!(@cursor, 1)
+      def delete(n = 1)
+        @text.slice!(@cursor, n)
       end
 
       # Remove char from the line in front of the cursor
       #
+      # @param [Integer] n
+      #   the number of chars to remove
+      #
       # @api public
-      def remove
-        left
-        @text.slice!(@cursor, 1)
+      def remove(n = 1)
+        left(n)
+        @text.slice!(@cursor, n)
       end
 
       # Full line with prompt as string

data/lib/tty/reader/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Reader
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end # Reader
 end # TTY

data/spec/spec_helper.rb

@@ -16,6 +16,12 @@ 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"

data/spec/unit/line_spec.rb

@@ -108,8 +108,7 @@ RSpec.describe TTY::Reader::Line do
     line = described_class.new('abcdef')
     expect(line.cursor).to eq(6)
 
-    line.remove
-    line.remove
+    line.remove(2)
     expect(line.text).to eq('abcd')
     expect(line.cursor).to eq(4)
 

data/spec/unit/read_line_spec.rb

@@ -10,14 +10,18 @@ RSpec.describe TTY::Reader, '#read_line' do
   it 'masks characters' do
     input << "password\n"
     input.rewind
+
     answer = reader.read_line(echo: false)
+
     expect(answer).to eq("password\n")
   end
 
   it "echoes characters back" do
     input << "password\n"
     input.rewind
+
     answer = reader.read_line
+
     expect(answer).to eq("password\n")
     expect(output.string).to eq([
       "\e[2K\e[1Gp",
@@ -35,7 +39,9 @@ RSpec.describe TTY::Reader, '#read_line' do
   it "doesn't echo characters back" do
     input << "password\n"
     input.rewind
+
     answer = reader.read_line(echo: false)
+
     expect(answer).to eq("password\n")
     expect(output.string).to eq("\n")
   end
@@ -43,7 +49,9 @@ RSpec.describe TTY::Reader, '#read_line' do
   it "displays a prompt before input" do
     input << "aa\n"
     input.rewind
+
     answer = reader.read_line('>> ')
+
     expect(answer).to eq("aa\n")
     expect(output.string).to eq([
       ">> ",
@@ -53,17 +61,36 @@ RSpec.describe TTY::Reader, '#read_line' do
     ].join)
   end
 
+  it "displays custom input with a prompt" do
+    input << "aa\n"
+    input.rewind
+
+    answer = reader.read_line("> ", value: "xx")
+
+    expect(answer).to eq("xxaa\n")
+    expect(output.string).to eq([
+      "> xx",
+      "\e[2K\e[1G> xxa",
+      "\e[2K\e[1G> xxaa",
+      "\e[2K\e[1G> xxaa\n"
+    ].join)
+  end
+
   it 'deletes characters when backspace pressed' do
     input << "aa\ba\bcc\n"
     input.rewind
+
     answer = reader.read_line
+
     expect(answer).to eq("acc\n")
   end
 
   it 'reads multibyte line' do
     input << "한글"
     input.rewind
+
     answer = reader.read_line
+
     expect(answer).to eq("한글")
   end
 end

data/tty-reader.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = "tty-reader"
   spec.version       = TTY::Reader::VERSION
   spec.authors       = ["Piotr Murach"]
-  spec.email         = [""]
+  spec.email         = ["me@piotrmurach.com"]
   spec.summary       = %q{A set of methods for processing keyboard input in character, line and multiline modes.}
   spec.description   = %q{A set of methods for processing keyboard input in character, line and multiline modes. It maintains history of entered input with an ability to recall and re-edit those inputs. It lets you register to listen for keystroke events and trigger custom key events yourself.}
   spec.homepage      = "https://piotrmurach.github.io/tty"
@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency "wisper", "~> 2.0.0"
-  spec.add_dependency "tty-screen", "~> 0.6.4"
-  spec.add_dependency "tty-cursor", "~> 0.6.0"
+  spec.add_dependency "tty-screen", "~> 0.7"
+  spec.add_dependency "tty-cursor", "~> 0.7"
 
-  spec.add_development_dependency "bundler", ">= 1.5.0", "< 2.0"
-  spec.add_development_dependency "rake",    "~> 12.0"
+  spec.add_development_dependency "bundler", ">= 1.5.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec",   "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +59,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,23 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +99,7 @@ description: A set of methods for processing keyboard input in character, line a
   and re-edit those inputs. It lets you register to listen for keystroke events and
   trigger custom key events yourself.
 email:
-- ''
+- me@piotrmurach.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,6 +113,7 @@ files:
 - bin/console
 - bin/setup
 - examples/keypress.rb
+- examples/keypress_nonblock.rb
 - examples/line.rb
 - examples/multiline.rb
 - examples/noecho.rb
@@ -166,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A set of methods for processing keyboard input in character, line and multiline