tty-reader 0.1.0 → 0.2.0

data/lib/tty/reader/line.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'forwardable'
@@ -6,28 +5,84 @@ require 'forwardable'
 module TTY
   class Reader
     class Line
-      extend Forwardable
+      ANSI_MATCHER = /(\[)?\033(\[)?[;?\d]*[\dA-Za-z](\])?/
 
-      def_delegators :@text, :size, :length, :to_s, :inspect,
-                      :slice!, :empty?
+      # Strip ANSI characters from the text
+      #
+      # @param [String] text
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.sanitize(text)
+        text.dup.gsub(ANSI_MATCHER, '')
+      end
 
-      attr_accessor :text
+      # The editable text
+      # @api public
+      attr_reader :text
 
-      attr_accessor :cursor
+      # The current cursor position witin the text
+      # @api public
+      attr_reader :cursor
 
-      def initialize(text = "")
-        @text = text
+      # The line mode
+      # @api public
+      attr_reader :mode
+
+      attr_reader :prompt
+
+      def initialize(prompt, text = '')
+        @prompt = prompt.dup
+        @text   = text.dup
         @cursor = [0, @text.length].max
+        @mode   = :edit
         yield self if block_given?
       end
 
+      # Check if line is in edit mode
+      #
+      # @return [Boolean]
+      #
+      # @public
+      def editing?
+        @mode == :edit
+      end
+
+      # Enable edit mode
+      #
+      # @return [Boolean]
+      #
+      # @public
+      def edit_mode
+        @mode = :edit
+      end
+
+      # Check if line is in replace mode
+      #
+      # @return [Boolean]
+      #
+      # @public
+      def replacing?
+        @mode == :replace
+      end
+
+      # Enable replace mode
+      #
+      # @return [Boolean]
+      #
+      # @public
+      def replace_mode
+        @mode = :replace
+      end
+
       # Check if cursor reached beginning of the line
       #
       # @return [Boolean]
       #
       # @api public
       def start?
-        @cursor == 0
+        @cursor.zero?
       end
 
       # Check if cursor reached end of the line
@@ -80,6 +135,7 @@ module TTY
       #
       # @api public
       def []=(i, chars)
+        edit_mode
         if i.is_a?(Range)
           @text[i] = chars
           @cursor += chars.length
@@ -125,6 +181,7 @@ module TTY
       def replace(text)
         @text = text
         @cursor = @text.length # put cursor outside of text
+        replace_mode
       end
 
       # Insert char(s) at cursor position
@@ -156,6 +213,36 @@ module TTY
         left
         @text.slice!(@cursor, 1)
       end
+
+      # Full line with prompt as string
+      #
+      # @api public
+      def to_s
+        "#{@prompt}#{@text}"
+      end
+      alias inspect to_s
+
+      # Prompt size
+      #
+      # @api public
+      def prompt_size
+        self.class.sanitize(@prompt).size
+      end
+
+      # Text size
+      #
+      # @api public
+      def text_size
+        self.class.sanitize(@text).size
+      end
+
+      # Full line size with prompt
+      #
+      # @api public
+      def size
+        prompt_size + text_size
+      end
+      alias length size
     end # Line
   end # Reader
 end # TTY

data/lib/tty/reader/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Reader
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'.freeze
   end # Reader
 end # TTY

data/lib/tty/reader/win_console.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'codes'
+require_relative 'keys'
 
 module TTY
   class Reader
@@ -27,7 +27,7 @@ module TTY
       def initialize(input)
         require_relative 'win_api'
         @input = input
-        @keys = Codes.win_keys
+        @keys = Keys.ctrl_keys.merge(Keys.win_keys)
         @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]
       end
 

data/tty-reader.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = TTY::Reader::VERSION
   spec.authors       = ["Piotr Murach"]
   spec.email         = [""]
-  spec.summary       = %q{Provides a set of methods for processing keyboard input in character, line and multiline modes.}
-  spec.description   = %q{Provides 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.}
+  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. In addition it maintains history of entered input with an ability to recall and re-edit those inputs and register to listen for keystrokes.}
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
@@ -20,9 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  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.5.0"
 
   spec.add_development_dependency "bundler", ">= 1.5.0", "< 2.0"
-  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rake",    "~> 12.0"
   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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,9 +100,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Provides 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.
+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.
 email:
 - ''
 executables: []
@@ -91,14 +119,21 @@ files:
 - 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/codes.rb
 - lib/tty/reader/console.rb
 - lib/tty/reader/history.rb
 - lib/tty/reader/key_event.rb
+- lib/tty/reader/keys.rb
 - lib/tty/reader/line.rb
 - lib/tty/reader/mode.rb
 - lib/tty/reader/version.rb
@@ -120,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -131,7 +166,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Provides a set of methods for processing keyboard input in character, line
-  and multiline modes.
+summary: A set of methods for processing keyboard input in character, line and multiline
+  modes.
 test_files: []
-has_rdoc: 

data/lib/tty/reader/codes.rb

@@ -1,120 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-module TTY
-  class Reader
-    module Codes
-      def ctrl_keys
-        {
-          ctrl_a: ?\C-a,
-          ctrl_b: ?\C-b,
-          ctrl_c: ?\C-c,
-          ctrl_d: ?\C-d,
-          ctrl_e: ?\C-e,
-          ctrl_f: ?\C-f,
-          ctrl_g: ?\C-g,
-          ctrl_h: ?\C-h,
-          ctrl_i: ?\C-i,
-          ctrl_j: ?\C-j,
-          ctrl_k: ?\C-k,
-          ctrl_l: ?\C-l,
-          ctrl_m: ?\C-m,
-          ctrl_n: ?\C-n,
-          ctrl_o: ?\C-o,
-          ctrl_p: ?\C-p,
-          ctrl_q: ?\C-q,
-          ctrl_r: ?\C-r,
-          ctrl_s: ?\C-s,
-          ctrl_t: ?\C-t,
-          ctrl_u: ?\C-u,
-          ctrl_v: ?\C-v,
-          ctrl_w: ?\C-w,
-          ctrl_x: ?\C-x,
-          ctrl_y: ?\C-y,
-          ctrl_z: ?\C-z
-        }
-      end
-      module_function :ctrl_keys
-
-      def keys
-        {
-          tab:       "\t",
-          enter:     "\n",
-          return:    "\r",
-          escape:    "\e",
-          space:     " ",
-          backspace: ?\C-?,
-          home:      "\e[1~",
-          insert:    "\e[2~",
-          delete:    "\e[3~",
-          end:       "\e[4~",
-          page_up:   "\e[5~",
-          page_down: "\e[6~",
-
-          up:     "\e[A",
-          down:   "\e[B",
-          right:  "\e[C",
-          left:   "\e[D",
-          clear:  "\e[E",
-
-          f1_xterm: "\eOP",
-          f2_xterm: "\eOQ",
-          f3_xterm: "\eOR",
-          f4_xterm: "\eOS",
-
-          f1:  "\e[11~",
-          f2:  "\e[12~",
-          f3:  "\e[13~",
-          f4:  "\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~"
-        }.merge(ctrl_keys)
-      end
-      module_function :keys
-
-      def win_keys
-        {
-          tab:       "\t",
-          enter:     "\r",
-          return:    "\r",
-          escape:    "\e",
-          space:     " ",
-          backspace: "\b",
-          home:      [224, 71].pack('U*'),
-          end:       [224, 79].pack('U*'),
-          insert:    [224, 82].pack('U*'),
-          delete:    [224, 83].pack('U*'),
-          page_up:   [224, 73].pack('U*'),
-          page_down: [224, 81].pack('U*'),
-
-          up:     [224, 72].pack('U*'),
-          down:   [224, 80].pack('U*'),
-          right:  [224, 77].pack('U*'),
-          left:   [224, 75].pack('U*'),
-          clear:  [224, 83].pack('U*'),
-
-          f1:  "\x00;",
-          f2:  "\x00<",
-          f3:  "\x00",
-          f4:  "\x00=",
-          f5:  "\x00?",
-          f6:  "\x00@",
-          f7:  "\x00A",
-          f8:  "\x00B",
-          f9:  "\x00C",
-          f10: "\x00D",
-          f11: "\x00\x85",
-          f12: "\x00\x86"
-        }.merge(ctrl_keys)
-      end
-      module_function :win_keys
-
-    end # Codes
-  end # Reader
-end # TTY