tty-reader 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f034dd9a1da1468f59ef2cf8c1ef164c5d85991d7aa0d9760eca05558d09978
-  data.tar.gz: '097df714a88a98b2352e202e69c7da48db124a8f637516449676a8647aee31f3'
+  metadata.gz: 7766384b749f39d5646ce4ff20d95c1bdfdaac5af096d4a996a7a347379874ee
+  data.tar.gz: c5a85b72fae90d018f79acdd9303c9926b75236fb67a2b24e641f6737a001372
 SHA512:
-  metadata.gz: 04cf6b1571693791baadf0f686f320393e17a0bd6b1a51aa61c28a34b20e65cb5a6efcca77a3ef21b0c4e2ff422ce3467cea3285b7c477783a5c91f3b1f08bde
-  data.tar.gz: ef5d9d50c2bad451a4cb326547e979a36bca173c0f02df90c202fc702823bd12c2bed8c47d0b47e16ccd6a9d1b644552d1ecea3f605629afaa0b975ac60d0b2b
+  metadata.gz: 74bd44d949d086d8debe53bdd571755b263fce26d991dd7798d45fbb24513cdadea0a29c31e3388a65ce8f81f3b3514955d69c44c30af87465ba32933f5f6997
+  data.tar.gz: 4ad0c8d086506a2672f2a8bb8db1fbd9f951e2f1f9200f4c258e82967cf61bbea209a33fdd86aa4cfb99adf4e5b7fcdcf6e5b0f992da6fe9956daa5d5aade238

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## [v0.9.0] - 2020-12-08
+
+### Added
+* Add buffer to save input when traversing history and restore it back
+  similar to shell
+
+### Changed
+* Pressing :down no longer erases the #read_line input if history is disabled by Charles Pence (@pencechp)
+* Change Reader initializer to use keyword arguments in place of options hash
+* Change history to only exclude empty lines without any space or invisible characters
+* Change all input reading methods to use explicit keyword arguments
+
+### Fix
+* Fix #read_multiline :value parameter to insert content only once in the first line
+
 ## [v0.8.0] - 2020-06-28
 
 ### Changed
@@ -73,6 +88,7 @@
 
 * Initial implementation and release
 
+[v0.9.0]: https://github.com/piotrmurach/tty-reader/compare/v0.8.0...v0.9.0
 [v0.8.0]: https://github.com/piotrmurach/tty-reader/compare/v0.7.0...v0.8.0
 [v0.7.0]: https://github.com/piotrmurach/tty-reader/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/piotrmurach/tty-reader/compare/v0.5.0...v0.6.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Piotr Murach
+Copyright (c) 2017 Piotr Murach (https://piotrmurach.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,11 +1,11 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo" /></a>
 </div>
 
 # TTY::Reader [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-reader.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-reader.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/tty-reader/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/cj4owy2vlty2q1ko?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/2f68d5e8ecc271bda820/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-reader/badge.svg)][coverage]
@@ -13,6 +13,7 @@
 
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-reader
+[gh_actions_ci]: https://github.com/piotrmurach/tty-reader/actions?query=workflow%3ACI
 [travis]: http://travis-ci.org/piotrmurach/tty-reader
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-reader
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-reader/maintainability
@@ -48,7 +49,7 @@ The `tty-reader` is not compatible with the GNU Readline and doesn't aim to be.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-reader'
+gem "tty-reader"
 ```
 
 And then execute:
@@ -99,7 +100,7 @@ Finally, keep asking user for line input with a `=>` as a prompt:
 
 ```ruby
 loop do
-  reader.read_line('=> ')
+  reader.read_line("=> ")
 end
 ```
 
@@ -207,11 +208,11 @@ For example, to add listen to vim like navigation keys, one would do the followi
 
 ```ruby
 reader.on(:keypress) do |event|
-  if event.value == 'j'
+  if event.value == "j"
     ...
   end
 
-  if event.value == 'k'
+  if event.value == "k"
     ...
   end
 end
@@ -220,8 +221,8 @@ end
 You can subscribe to more than one event:
 
 ```ruby
-prompt.on(:keypress) { |key| ... }
-      .on(:keydown)  { |key| ... }
+reader.on(:keypress) { |event| ... }
+      .on(:keydown)  { |event| ... }
 ```
 
 ### 2.5 subscribe
@@ -274,10 +275,10 @@ To add vim bindings for line editing you could discern between alphanumeric inpu
 
 ```ruby
 reader.on(:keypress) do |event|
-  if event.value == 'j'
+  if event.value == "j"
     reader.trigger(:keydown)
   end
-  if evevnt.value == 'k'
+  if evevnt.value == "k"
     reader.trigger(:keyup)
   end
 end

data/lib/tty/reader.rb

@@ -20,6 +20,15 @@ module TTY
   class Reader
     include Wisper::Publisher
 
+    # Key codes
+    CARRIAGE_RETURN = 13
+    NEWLINE         = 10
+    BACKSPACE       = 8
+    DELETE          = 127
+
+    # Keys that terminate input
+    EXIT_KEYS = [:ctrl_d, :ctrl_z]
+
     # Raised when the user hits the interrupt key(Control-C)
     #
     # @api public
@@ -47,42 +56,44 @@ module TTY
 
     attr_reader :cursor
 
-    # Key codes
-    CARRIAGE_RETURN = 13
-    NEWLINE         = 10
-    BACKSPACE       = 8
-    DELETE          = 127
-
     # Initialize a Reader
     #
     # @param [IO] input
     #   the input stream
     # @param [IO] output
     #   the output stream
-    # @param [Hash] options
-    # @option options [Symbol] :interrupt
-    #   handling of Ctrl+C key out of :signal, :exit, :noop
-    # @option options [Boolean] :track_history
+    # @param [Symbol] interrupt
+    #   the way to handle the Ctrl+C key out of :signal, :exit, :noop
+    # @param [Hash] env
+    #   the environment variables
+    # @param [Boolean] track_history
     #   disable line history tracking, true by default
+    # @param [Boolean] history_cycle
+    #   allow cycling through history, false by default
+    # @param [Boolean] history_duplicates
+    #   allow duplicate entires, false by default
+    # @param [Proc] history_exclude
+    #   exclude lines from history, by default all lines are stored
     #
     # @api public
-    def initialize(**options)
-      @input     = options.fetch(:input) { $stdin }
-      @output    = options.fetch(:output) { $stdout }
-      @interrupt = options.fetch(:interrupt) { :error }
-      @env       = options.fetch(:env) { ENV }
-
-      @track_history = options.fetch(:track_history) { true }
-      @history_cycle = options.fetch(:history_cycle) { false }
-      exclude_proc   = ->(line) { line.strip == "" }
-      @history_exclude    = options.fetch(:history_exclude) { exclude_proc }
-      @history_duplicates = options.fetch(:history_duplicates) { false }
-
-      @console   = select_console(input)
-      @history   = History.new do |h|
-        h.cycle = @history_cycle
-        h.duplicates = @history_duplicates
-        h.exclude = @history_exclude
+    def initialize(input: $stdin, output: $stdout, interrupt: :error,
+                   env: ENV, track_history: true, history_cycle: false,
+                   history_exclude: History::DEFAULT_EXCLUDE,
+                   history_duplicates: false)
+      @input = input
+      @output = output
+      @interrupt = interrupt
+      @env = env
+      @track_history = track_history
+      @history_cycle = history_cycle
+      @history_exclude = history_exclude
+      @history_duplicates = history_duplicates
+
+      @console = select_console(input)
+      @history = History.new do |h|
+        h.cycle = history_cycle
+        h.duplicates = history_duplicates
+        h.exclude = history_exclude
       end
       @stop = false # gathering input
       @cursor = TTY::Cursor
@@ -155,24 +166,26 @@ module TTY
       output.sync = bufferring
     end
 
-    # Read a keypress  including invisible multibyte codes
-    # and return a character as a string.
+    # Read a keypress including invisible multibyte codes and return
+    # a character as a string.
     # Nothing is echoed to the console. This call will block for a
     # single keypress, but will not wait for Enter to be pressed.
     #
-    # @param [Hash[Symbol]] options
-    # @option options [Boolean] echo
+    # @param [Boolean] echo
     #   whether to echo chars back or not, defaults to false
-    # @option options [Boolean] raw
-    #   whenther raw mode enabled, defaults to true
+    # @option [Boolean] raw
+    #   whenther raw mode is enabled, defaults to true
+    # @option [Boolean] nonblock
+    #   whether to wait for input or not, defaults to false
     #
     # @return [String]
     #
     # @api public
-    def read_keypress(options = {})
-      opts  = { echo: false, raw: true }.merge(options)
-      codes = unbufferred { get_codes(opts) }
-      char  = codes ? codes.pack("U*") : nil
+    def read_keypress(echo: false, raw: true, nonblock: false)
+      codes = unbufferred do
+        get_codes(echo: echo, raw: raw, nonblock: nonblock)
+      end
+      char = codes ? codes.pack("U*") : nil
 
       trigger_key_event(char) if char
       char
@@ -181,19 +194,24 @@ module TTY
 
     # Get input code points
     #
-    # @param [Hash[Symbol]] options
+    # @param [Boolean] echo
+    #   whether to echo chars back or not, defaults to false
+    # @option [Boolean] raw
+    #   whenther raw mode is enabled, defaults to true
+    # @option [Boolean] nonblock
+    #   whether to wait for input or not, defaults to false
     # @param [Array[Integer]] codes
+    #   the currently read char code points
     #
     # @return [Array[Integer]]
     #
     # @api private
-    def get_codes(options = {}, codes = [])
-      opts = { echo: true, raw: false }.merge(options)
-      char = console.get_char(opts)
+    def get_codes(echo: true, raw: false, nonblock: false, codes: [])
+      char = console.get_char(echo: echo, raw: raw, nonblock: nonblock)
       handle_interrupt if console.keys[char] == :ctrl_c
       return if char.nil?
-      codes << char.ord
 
+      codes << char.ord
       condition = proc { |escape|
         (codes - escape).empty? ||
         (escape - codes).empty? &&
@@ -201,7 +219,8 @@ module TTY
       }
 
       while console.escape_codes.any?(&condition)
-        char_codes = get_codes(options.merge(nonblock: true), codes)
+        char_codes = get_codes(echo: echo, raw: raw,
+                               nonblock: true, codes: codes)
         break if char_codes.nil?
       end
 
@@ -214,49 +233,51 @@ 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
+    #   whether to echo chars back or not, defaults to false
+    # @option [Boolean] raw
+    #   whenther raw mode is enabled, defaults to true
+    # @option [Boolean] nonblock
+    #   whether to wait for input or not, defaults to false
     #
     # @return [String]
     #
     # @api public
-    def read_line(prompt = "", **options)
-      opts = { echo: true, raw: true }.merge(options)
-      value = options.fetch(:value, "")
+    def read_line(prompt = "", value: "", echo: true, raw: true, nonblock: false)
       line = Line.new(value, prompt: prompt)
       screen_width = TTY::Screen.width
+      buffer = ""
 
       output.print(line)
 
-      while (codes = get_codes(opts)) && (code = codes[0])
+      while (codes = get_codes(echo: echo, raw: raw, nonblock: nonblock)) &&
+            (code = codes[0])
         char = codes.pack("U*")
 
-        if [:ctrl_d, :ctrl_z].include?(console.keys[char])
+        if EXIT_KEYS.include?(console.keys[char])
           trigger_key_event(char, line: line.to_s)
           break
         end
 
-        if opts[:raw] && opts[:echo]
+        if raw && echo
           clear_display(line, screen_width)
         end
 
-        if console.keys[char] == :backspace || BACKSPACE == code
+        if console.keys[char] == :backspace || code == BACKSPACE
           if !line.start?
             line.left
             line.delete
           end
-        elsif console.keys[char] == :delete || DELETE == code
+        elsif console.keys[char] == :delete || code == DELETE
           line.delete
         elsif console.keys[char].to_s =~ /ctrl_/
           # skip
         elsif console.keys[char] == :up
           line.replace(history_previous) if history_previous?
         elsif console.keys[char] == :down
-          line.replace(history_next? ? history_next : "")
+          line.replace(history_next? ? history_next : buffer) if track_history?
         elsif console.keys[char] == :left
           line.left
         elsif console.keys[char] == :right
@@ -266,15 +287,16 @@ module TTY
         elsif console.keys[char] == :end
           line.move_to_end
         else
-          if opts[:raw] && code == CARRIAGE_RETURN
+          if raw && code == CARRIAGE_RETURN
             char = "\n"
             line.move_to_end
           end
           line.insert(char)
+          buffer = line.text
         end
 
-        if (console.keys[char] == :backspace || BACKSPACE == code) && opts[:echo]
-          if opts[:raw]
+        if (console.keys[char] == :backspace || code == BACKSPACE) && echo
+          if raw
             output.print("\e[1X") unless line.start?
           else
             output.print(?\s + (line.start? ? "" : ?\b))
@@ -284,7 +306,7 @@ module TTY
         # trigger before line is printed to allow for line changes
         trigger_key_event(char, line: line.to_s)
 
-        if opts[:raw] && opts[:echo]
+        if raw && echo
           output.print(line.to_s)
           if char == "\n"
             line.move_to_start
@@ -294,13 +316,16 @@ module TTY
         end
 
         if [CARRIAGE_RETURN, NEWLINE].include?(code)
-          output.puts unless opts[:echo]
+          buffer = ""
+          output.puts unless echo
           break
         end
       end
-      if track_history? && opts[:echo]
+
+      if track_history? && echo
         add_to_history(line.text.rstrip)
       end
+
       line.text
     end
 
@@ -351,19 +376,33 @@ module TTY
     #
     # @param [String] prompt
     #   the prompt displayed before the input
+    # @param [String] value
+    #   the value to pre-populate line with
+    # @param [Boolean] echo
+    #   whether to echo chars back or not, defaults to false
+    # @option [Boolean] raw
+    #   whenther raw mode is enabled, defaults to true
+    # @option [Boolean] nonblock
+    #   whether to wait for input or not, defaults to false
     #
     # @yield [String] line
     #
     # @return [Array[String]]
     #
     # @api public
-    def read_multiline(*args)
+    def read_multiline(prompt = "", value: "", echo: true, raw: true,
+                       nonblock: false)
       @stop = false
       lines = []
+      empty_str = ""
+
       loop do
-        line = read_line(*args)
-        break if !line || line == ""
+        line = read_line(prompt, value: value, echo: echo, raw: raw,
+                                 nonblock: nonblock)
+        value = empty_str unless value.empty? # reset
+        break if !line || line == empty_str
         next  if line !~ /\S/ && !@stop
+
         if block_given?
           yield(line) unless line.to_s.empty?
         else
@@ -371,6 +410,7 @@ module TTY
         end
         break if @stop
       end
+
       lines
     end
     alias read_lines read_multiline
@@ -449,7 +489,7 @@ module TTY
       when Proc
         @interrupt.call
       when :noop
-        return
+        # Noop
       else
         raise InputInterrupt
       end

data/lib/tty/reader/console.rb

@@ -36,17 +36,20 @@ module TTY
 
       # Get a character from console with echo
       #
-      # @param [Hash[Symbol]] options
-      # @option options [Symbol] :echo
-      #   the echo toggle
+      # @param [Boolean] echo
+      #   whether to echo input back or not, defaults to true
+      # @param [Boolean] raw
+      #   whether to use raw mode or not, defaults to false
+      # @param [Boolean] nonblock
+      #   whether to wait for input or not, defaults to false
       #
       # @return [String]
       #
       # @api private
-      def get_char(options)
-        mode.raw(options[:raw]) do
-          mode.echo(options[:echo]) do
-            if options[:nonblock]
+      def get_char(echo: true, raw: false, nonblock: false)
+        mode.raw(raw) do
+          mode.echo(echo) do
+            if nonblock
               input.wait_readable(TIMEOUT) ? input.getc : nil
             else
               input.getc

data/lib/tty/reader/history.rb

@@ -15,49 +15,72 @@ module TTY
       # Default maximum size
       DEFAULT_SIZE = 32 << 4
 
+      # Default exclude
+      DEFAULT_EXCLUDE = ->(line) { line.chomp == "" }
+
       def_delegators :@history, :size, :length, :to_s, :inspect
 
       # Set and retrieve the maximum size of the buffer
       attr_accessor :max_size
 
+      # The current index
+      #
+      # @return [Integer]
+      #
+      # @api private
       attr_reader :index
 
+      # Decides whether or not to allow cycling through stored lines.
+      #
+      # @return [Boolean]
+      #
+      # @api public
       attr_accessor :cycle
 
+      # Decides wether or not duplicate lines are stored.
+      #
+      # @return [Boolean]
+      #
+      # @api public
       attr_accessor :duplicates
 
+      # Dictates which lines are stored.
+      #
+      # @return [Proc]
+      #
+      # @public
       attr_accessor :exclude
 
       # Create a History buffer
       #
-      # param [Integer] max_size
+      # @param [Integer] max_size
       #   the maximum size for history buffer
-      #
-      # param [Hash[Symbol]] options
-      # @option options [Boolean] :cycle
+      # @param [Boolean] cycle
       #   whether or not the history should cycle, false by default
-      # @option options [Boolean] :duplicates
+      # @param [Boolean] duplicates
       #   whether or not to store duplicates, true by default
-      # @option options [Boolean] :exclude
+      # @param [Boolean] exclude
       #   a Proc to exclude items from storing in history
       #
       # @api public
-      def initialize(max_size = DEFAULT_SIZE, **options)
+      def initialize(max_size = DEFAULT_SIZE, duplicates: true, cycle: false,
+                     exclude: DEFAULT_EXCLUDE)
         @max_size   = max_size
         @index      = nil
         @history    = []
-        @duplicates = options.fetch(:duplicates) { true }
-        @exclude    = options.fetch(:exclude) { proc {} }
-        @cycle      = options.fetch(:cycle) { false }
+        @duplicates = duplicates
+        @exclude    = exclude
+        @cycle      = cycle
+
         yield self if block_given?
       end
 
       # Iterates over history lines
       #
       # @api public
-      def each
+      def each(&block)
         if block_given?
-          @history.each { |line| yield line }
+          @history.each(&block)
         else
           @history.to_enum
         end
@@ -85,6 +108,7 @@ module TTY
       # @api public
       def next
         return if size.zero?
+
         if @index == size - 1
           @index = 0 if @cycle
         else
@@ -99,6 +123,7 @@ module TTY
       # Move the pointer to the previous line in the history
       def previous
         return if size.zero?
+
         if @index.zero?
           @index = size - 1 if @cycle
         else

data/lib/tty/reader/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Reader
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end # Reader
 end # TTY

data/lib/tty/reader/win_console.rb

@@ -32,26 +32,27 @@ module TTY
 
       # Get a character from console blocking for input
       #
-      # @param [Hash[Symbol]] options
-      # @option options [Symbol] :echo
-      #   the echo mode toggle
-      # @option options [Symbol] :raw
-      #   the raw mode toggle
+      # @param [Boolean] echo
+      #   whether to echo input back or not, defaults to true
+      # @param [Boolean] raw
+      #   whether to use raw mode or not, defaults to false
+      # @param [Boolean] nonblock
+      #   whether to wait for input or not, defaults to false
       #
       # @return [String]
       #
       # @api private
-      def get_char(options)
-        if options[:raw] && options[:echo]
-          if options[:nonblock]
+      def get_char(echo: true, raw: false, nonblock: false)
+        if raw && echo
+          if nonblock
             get_char_echo_non_blocking
           else
             get_char_echo_blocking
           end
-        elsif options[:raw] && !options[:echo]
-          options[:nonblock] ? get_char_non_blocking : get_char_blocking
-        elsif !options[:raw] && !options[:echo]
-          options[:nonblock] ? get_char_non_blocking : get_char_blocking
+        elsif raw && !echo
+          nonblock ? get_char_non_blocking : get_char_blocking
+        elsif !raw && !echo
+          nonblock ? get_char_non_blocking : get_char_blocking
         else
           @input.getc
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -70,14 +70,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: A set of methods for processing keyboard input in character, line and