tty-reader 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cafac5b8e629299d317c79b4bc5ff9b5f88873dbbcb966b152a773509c118a8
-  data.tar.gz: ebc42b1a9eb21652b74edf393f9555be025d9cfb3e84c9be14b667dc3012b59e
+  metadata.gz: 7f034dd9a1da1468f59ef2cf8c1ef164c5d85991d7aa0d9760eca05558d09978
+  data.tar.gz: '097df714a88a98b2352e202e69c7da48db124a8f637516449676a8647aee31f3'
 SHA512:
-  metadata.gz: b7d0b5652ed3e3b7f6080c7a31c066457d00d20aefe780f2f581e221f06760a19bfe654c5d5b7edaa6317d2fed9f934a3a58adc36296e73b5529d74cf1147c92
-  data.tar.gz: b713a61cf2c195d11ae63a4ccc4b0901347286913e41fa014d1bf641bc65e7ff958ba1e334354e7d8622848caf2229363a799402a240946042aec217e4ef1577
+  metadata.gz: 04cf6b1571693791baadf0f686f320393e17a0bd6b1a51aa61c28a34b20e65cb5a6efcca77a3ef21b0c4e2ff422ce3467cea3285b7c477783a5c91f3b1f08bde
+  data.tar.gz: ef5d9d50c2bad451a4cb326547e979a36bca173c0f02df90c202fc702823bd12c2bed8c47d0b47e16ccd6a9d1b644552d1ecea3f605629afaa0b975ac60d0b2b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log
 
+## [v0.8.0] - 2020-06-28
+
+### Changed
+* Change gemspec to load version directly and remove test artefacts
+* Change to update tty-screen dependency
+* Change to remove bundler dev dependency and relax wisper version
+
 ## [v0.7.0] - 2019-11-24
 
 ### Added
@@ -66,6 +73,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.5.0]: https://github.com/piotrmurach/tty-reader/compare/v0.4.0...v0.5.0

data/README.md

@@ -112,6 +112,7 @@ To read a single key stroke from the user use `read_char` or `read_keypress`:
 ```ruby
 reader.read_char
 reader.read_keypress
+reader.read_keypress(nonblock: true)
 ```
 
 ### 2.2 read_line

data/lib/tty/reader.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'tty-cursor'
-require 'tty-screen'
-require 'wisper'
+require "tty-cursor"
+require "tty-screen"
+require "wisper"
 
-require_relative 'reader/history'
-require_relative 'reader/line'
-require_relative 'reader/key_event'
-require_relative 'reader/console'
-require_relative 'reader/win_console'
-require_relative 'reader/version'
+require_relative "reader/history"
+require_relative "reader/line"
+require_relative "reader/key_event"
+require_relative "reader/console"
+require_relative "reader/win_console"
+require_relative "reader/version"
 
 module TTY
   # A class responsible for reading character input from STDIN
@@ -31,7 +31,7 @@ module TTY
     #
     # @api public
     def self.windows?
-      ::File::ALT_SEPARATOR == '\\'
+      ::File::ALT_SEPARATOR == "\\"
     end
 
     attr_reader :input
@@ -74,7 +74,7 @@ module TTY
 
       @track_history = options.fetch(:track_history) { true }
       @history_cycle = options.fetch(:history_cycle) { false }
-      exclude_proc   = ->(line) { line.strip == '' }
+      exclude_proc   = ->(line) { line.strip == "" }
       @history_exclude    = options.fetch(:history_exclude) { exclude_proc }
       @history_duplicates = options.fetch(:history_duplicates) { false }
 
@@ -131,7 +131,7 @@ module TTY
     #
     # @api private
     def select_console(input)
-      if self.class.windows? && !env['TTY_TEST']
+      if self.class.windows? && !env["TTY_TEST"]
         WinConsole.new(input)
       else
         Console.new(input)
@@ -172,7 +172,7 @@ module TTY
     def read_keypress(options = {})
       opts  = { echo: false, raw: true }.merge(options)
       codes = unbufferred { get_codes(opts) }
-      char  = codes ? codes.pack('U*') : nil
+      char  = codes ? codes.pack("U*") : nil
 
       trigger_key_event(char) if char
       char
@@ -224,16 +224,16 @@ module TTY
     # @return [String]
     #
     # @api public
-    def read_line(prompt = '', **options)
+    def read_line(prompt = "", **options)
       opts = { echo: true, raw: true }.merge(options)
-      value = options.fetch(:value, '')
+      value = options.fetch(:value, "")
       line = Line.new(value, prompt: prompt)
       screen_width = TTY::Screen.width
 
       output.print(line)
 
       while (codes = get_codes(opts)) && (code = codes[0])
-        char = codes.pack('U*')
+        char = codes.pack("U*")
 
         if [:ctrl_d, :ctrl_z].include?(console.keys[char])
           trigger_key_event(char, line: line.to_s)
@@ -256,7 +256,7 @@ module TTY
         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 : "")
         elsif console.keys[char] == :left
           line.left
         elsif console.keys[char] == :right
@@ -277,7 +277,7 @@ module TTY
           if opts[:raw]
             output.print("\e[1X") unless line.start?
           else
-            output.print(?\s + (line.start? ? '' : ?\b))
+            output.print(?\s + (line.start? ? "" : ?\b))
           end
         end
 
@@ -362,7 +362,7 @@ module TTY
       lines = []
       loop do
         line = read_line(*args)
-        break if !line || line == ''
+        break if !line || line == ""
         next  if line !~ /\S/ && !@stop
         if block_given?
           yield(line) unless line.to_s.empty?
@@ -431,7 +431,7 @@ module TTY
     # @return [nil]
     #
     # @api private
-    def trigger_key_event(char, line: '')
+    def trigger_key_event(char, line: "")
       event = KeyEvent.from(console.keys, char, line)
       trigger(:"key#{event.key.name}", event) if event.trigger?
       trigger(:keypress, event)
@@ -443,7 +443,7 @@ module TTY
     def handle_interrupt
       case @interrupt
       when :signal
-        Process.kill('SIGINT', Process.pid)
+        Process.kill("SIGINT", Process.pid)
       when :exit
         exit(130)
       when Proc

data/lib/tty/reader/console.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'io/wait'
+require "io/wait"
 
-require_relative 'keys'
-require_relative 'mode'
+require_relative "keys"
+require_relative "mode"
 
 module TTY
   class Reader
     class Console
-      ESC = "\e".freeze
-      CSI = "\e[".freeze
+      ESC = "\e"
+      CSI = "\e["
 
       TIMEOUT = 0.1
 

data/lib/tty/reader/history.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module TTY
   class Reader
@@ -121,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,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'keys'
+require_relative "keys"
 
 module TTY
   class Reader
@@ -26,7 +26,7 @@ module TTY
       # @return [KeyEvent]
       #
       # @api public
-      def self.from(keys, char, line = '')
+      def self.from(keys, char, line = "")
         key = Key.new
         key.name = (name = keys[char]) ? name : :ignore
 

data/lib/tty/reader/keys.rb

@@ -13,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,
@@ -133,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
@@ -37,7 +37,7 @@ module TTY
       # Create a Line instance
       #
       # @api private
-      def initialize(text = '', prompt: '')
+      def initialize(text = "", prompt: "")
         @prompt = prompt.dup
         @text   = text.dup
         @cursor = [0, @text.length].max
@@ -138,9 +138,9 @@ module TTY
       #   the characters to insert
       #
       # @example
-      #   text = 'aaa'
-      #   line[5]= 'b'
-      #   => 'aaa  b'
+      #   text = "aaa"
+      #   line[5]= "b"
+      #   => "aaa  b"
       #
       # @api public
       def []=(i, chars)
@@ -153,7 +153,7 @@ module TTY
         end
 
         if i <= 0
-          before_text = ''
+          before_text = ""
           after_text = @text.dup
         elsif i > @text.length - 1 # insert outside of line input
           before_text = @text.dup

data/lib/tty/reader/mode.rb

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

data/lib/tty/reader/version.rb

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

data/lib/tty/reader/win_api.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fiddle'
+require "fiddle"
 
 module TTY
   class Reader

data/lib/tty/reader/win_console.rb

@@ -1,13 +1,13 @@
 # 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
       #
@@ -24,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,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: wisper
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: tty-screen
+  name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: tty-cursor
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,26 +85,17 @@ 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
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmarks/speed_read_char.rb
-- benchmarks/speed_read_line.rb
-- bin/console
-- bin/setup
-- examples/keypress.rb
-- examples/keypress_nonblock.rb
-- examples/line.rb
-- examples/multi_prompt.rb
-- examples/multiline.rb
-- examples/noecho.rb
-- examples/shell.rb
 - lib/tty-reader.rb
 - lib/tty/reader.rb
 - lib/tty/reader/console.rb
@@ -130,20 +107,7 @@ files:
 - lib/tty/reader/version.rb
 - lib/tty/reader/win_api.rb
 - lib/tty/reader/win_console.rb
-- spec/spec_helper.rb
-- spec/unit/history_spec.rb
-- spec/unit/key_event_spec.rb
-- spec/unit/line_spec.rb
-- spec/unit/publish_keypress_event_spec.rb
-- spec/unit/read_keypress_spec.rb
-- spec/unit/read_line_spec.rb
-- spec/unit/read_multiline_spec.rb
-- spec/unit/subscribe_spec.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:
@@ -151,7 +115,7 @@ metadata:
   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://piotrmurach.github.io/tty
+  homepage_uri: https://ttytoolkit.org
   source_code_uri: https://github.com/piotrmurach/tty-reader
 post_install_message: 
 rdoc_options: []
@@ -168,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A set of methods for processing keyboard input in character, line and multiline