tty-reader 0.3.0 → 0.8.0

data/lib/tty/reader/history.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module TTY
   class Reader
@@ -122,7 +121,7 @@ module TTY
         end
         line = @history[index]
         if line.nil?
-          raise IndexError, 'invalid index'
+          raise IndexError, "invalid index"
         end
         line.dup
       end

data/lib/tty/reader/key_event.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'keys'
+require_relative "keys"
 
 module TTY
   class Reader
@@ -17,7 +16,7 @@ module TTY
     # Represents key event emitted during keyboard press
     #
     # @api public
-    class KeyEvent < Struct.new(:value, :key)
+    class KeyEvent < Struct.new(:key, :value, :line)
       # Create key event from read input codes
       #
       # @param [Hash[Symbol]] keys
@@ -27,7 +26,7 @@ module TTY
       # @return [KeyEvent]
       #
       # @api public
-      def self.from(keys, char)
+      def self.from(keys, char, line = "")
         key = Key.new
         key.name = (name = keys[char]) ? name : :ignore
 
@@ -43,7 +42,7 @@ module TTY
           key.ctrl = true
         end
 
-        new(char, key)
+        new(key, char, line)
       end
 
       # Check if key event can be triggered

data/lib/tty/reader/keys.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module TTY
@@ -14,12 +13,12 @@ module TTY
           ?\C-e => :ctrl_e,
           ?\C-f => :ctrl_f,
           ?\C-g => :ctrl_g,
-          ?\C-h => :ctrl_h, # identical to '\b'
-          ?\C-i => :ctrl_i, # identical to '\t'
-          ?\C-j => :ctrl_j, # identical to '\n'
+          ?\C-h => :ctrl_h, # identical to "\b"
+          ?\C-i => :ctrl_i, # identical to "\t"
+          ?\C-j => :ctrl_j, # identical to "\n"
           ?\C-k => :ctrl_k,
           ?\C-l => :ctrl_l,
-          ?\C-m => :ctrl_m, # identical to '\r'
+          ?\C-m => :ctrl_m, # identical to "\r"
           ?\C-n => :ctrl_n,
           ?\C-o => :ctrl_o,
           ?\C-p => :ctrl_p,
@@ -134,18 +133,18 @@ module TTY
           "\e" => :escape,
           " "  => :space,
           "\b" => :backspace,
-          [224, 71].pack('U*') => :home,
-          [224, 79].pack('U*') => :end,
-          [224, 82].pack('U*') => :insert,
-          [224, 83].pack('U*') => :delete,
-          [224, 73].pack('U*') => :page_up,
-          [224, 81].pack('U*') => :page_down,
+          [224, 71].pack("U*") => :home,
+          [224, 79].pack("U*") => :end,
+          [224, 82].pack("U*") => :insert,
+          [224, 83].pack("U*") => :delete,
+          [224, 73].pack("U*") => :page_up,
+          [224, 81].pack("U*") => :page_down,
 
-          [224, 72].pack('U*') => :up,
-          [224, 80].pack('U*') => :down,
-          [224, 77].pack('U*') => :right,
-          [224, 75].pack('U*') => :left,
-          [224, 83].pack('U*') => :clear,
+          [224, 72].pack("U*") => :up,
+          [224, 80].pack("U*") => :down,
+          [224, 77].pack("U*") => :right,
+          [224, 75].pack("U*") => :left,
+          [224, 83].pack("U*") => :clear,
 
           "\x00;" => :f1,
           "\x00<" => :f2,

data/lib/tty/reader/line.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module TTY
   class Reader
@@ -15,7 +15,7 @@ module TTY
       #
       # @api public
       def self.sanitize(text)
-        text.dup.gsub(ANSI_MATCHER, '')
+        text.dup.gsub(ANSI_MATCHER, "")
       end
 
       # The editable text
@@ -30,13 +30,19 @@ module TTY
       # @api public
       attr_reader :mode
 
+      # The prompt displayed before input
+      # @api public
       attr_reader :prompt
 
-      def initialize(prompt, text = '')
+      # Create a Line instance
+      #
+      # @api private
+      def initialize(text = "", prompt: "")
         @prompt = prompt.dup
         @text   = text.dup
         @cursor = [0, @text.length].max
         @mode   = :edit
+
         yield self if block_given?
       end
 
@@ -128,14 +134,18 @@ module TTY
       # @param [Integer] i
       #   the index to insert at
       #
+      # @param [String] chars
+      #   the characters to insert
+      #
       # @example
-      #   text = 'aaa'
-      #   line[5]= 'b'
-      #   => 'aaa  b'
+      #   text = "aaa"
+      #   line[5]= "b"
+      #   => "aaa  b"
       #
       # @api public
       def []=(i, chars)
         edit_mode
+
         if i.is_a?(Range)
           @text[i] = chars
           @cursor += chars.length
@@ -143,12 +153,9 @@ module TTY
         end
 
         if i <= 0
-          before_text = ''
+          before_text = ""
           after_text = @text.dup
-        elsif i == @text.length - 1
-          before_text = @text.dup
-          after_text = ''
-        elsif i > @text.length - 1
+        elsif i > @text.length - 1 # insert outside of line input
           before_text = @text.dup
           after_text = ?\s * (i - @text.length)
           @cursor += after_text.length
@@ -202,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
@@ -226,7 +236,10 @@ module TTY
       #
       # @api public
       def prompt_size
-        self.class.sanitize(@prompt).size
+        p = self.class.sanitize(@prompt).split(/\r?\n/)
+        # return the length of each line + screen width for every line past the first
+        # which accounts for multi-line prompts
+        p.join.length + ((p.length - 1) * TTY::Screen.width )
       end
 
       # Text size

data/lib/tty/reader/mode.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'io/console'
+require "io/console"
 
 module TTY
   class Reader

data/lib/tty/reader/version.rb

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

data/lib/tty/reader/win_api.rb

@@ -1,16 +1,13 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'fiddle'
+require "fiddle"
 
 module TTY
   class Reader
     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,14 +1,13 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'keys'
+require_relative "keys"
 
 module TTY
   class Reader
     class WinConsole
-      ESC     = "\e".freeze
-      NUL_HEX = "\x00".freeze
-      EXT_HEX = "\xE0".freeze
+      ESC     = "\e"
+      NUL_HEX = "\x00"
+      EXT_HEX = "\xE0"
 
       # Key codes
       #
@@ -25,7 +24,7 @@ module TTY
       attr_reader :escape_codes
 
       def initialize(input)
-        require_relative 'win_api'
+        require_relative "win_api"
         @input = input
         @keys = Keys.ctrl_keys.merge(Keys.win_keys)
         @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]

metadata

@@ -1,91 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: wisper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !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
@@ -101,33 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: A set of methods for processing keyboard input in character, line and
-  multiline modes. In addition it maintains history of entered input with an ability
-  to recall and re-edit those inputs and register to listen for keystrokes.
+  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.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- benchmarks/speed_read_char.rb
-- benchmarks/speed_read_line.rb
-- bin/console
-- bin/setup
-- examples/keypress.rb
-- examples/line.rb
-- examples/multiline.rb
-- examples/noecho.rb
-- examples/shell.rb
 - lib/tty-reader.rb
 - lib/tty/reader.rb
 - lib/tty/reader/console.rb
@@ -139,14 +107,16 @@ files:
 - lib/tty/reader/version.rb
 - lib/tty/reader/win_api.rb
 - lib/tty/reader/win_console.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-reader.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-reader/issues
+  changelog_uri: https://github.com/piotrmurach/tty-reader/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-reader
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-reader
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -162,8 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A set of methods for processing keyboard input in character, line and multiline