tty-reader 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6193cf64fd770d652ff66d89ff395c28f52181521242ce432b3b651aa7b13d63
-  data.tar.gz: 7fa878638a8851265dfed9f8970f03fd360f975007c8ad0c865bf2bb304c64a1
+  metadata.gz: 5cafac5b8e629299d317c79b4bc5ff9b5f88873dbbcb966b152a773509c118a8
+  data.tar.gz: ebc42b1a9eb21652b74edf393f9555be025d9cfb3e84c9be14b667dc3012b59e
 SHA512:
-  metadata.gz: 91136b6cecab81d4705560af21775ae5e4140e860c1d2413e8c01b545652623f2d17c2a146494fcf790d0c3e996a4b38cab1a80741f1900d3422eb4018e861ac
-  data.tar.gz: bf159f08943f118a48c133171410bd5e9f8f6e8da0f83be54745e653648f9d3de7863025667a4a08da19d8ba27ab1c1c6cab0add921777de23a7a0b069c2ac15
+  metadata.gz: b7d0b5652ed3e3b7f6080c7a31c066457d00d20aefe780f2f581e221f06760a19bfe654c5d5b7edaa6317d2fed9f934a3a58adc36296e73b5529d74cf1147c92
+  data.tar.gz: b713a61cf2c195d11ae63a4ccc4b0901347286913e41fa014d1bf641bc65e7ff958ba1e334354e7d8622848caf2229363a799402a240946042aec217e4ef1577

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## [v0.7.0] - 2019-11-24
+
+### Added
+* Add support for a multi-line prompt by Katelyn Schiesser(@slowbro)
+* Add metadata to gemspec
+
 ## [v0.6.0] - 2019-05-27
 
 ### Added
@@ -60,6 +66,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.4.0]: https://github.com/piotrmurach/tty-reader/compare/v0.3.0...v0.4.0

data/examples/multi_prompt.rb

@@ -0,0 +1,9 @@
+require_relative "../lib/tty-reader"
+
+reader = TTY::Reader.new
+
+reader.on(:keyctrl_x, :keyescape) { puts "Exiting..."; exit }
+
+loop do
+  reader.read_line("one\ntwo\nthree")
+end

data/lib/tty/reader/line.rb

@@ -236,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/version.rb

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

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'

data/spec/unit/history_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe TTY::Reader::History do
   end
 
   it "allows to cycle through non-empty buffer" do
-    history = described_class.new(3, {cycle: true})
+    history = described_class.new(3, cycle: true)
     history << "line"
     expect(history.next?).to eq(true)
     expect(history.previous?).to eq(true)

data/spec/unit/read_line_spec.rb

@@ -93,4 +93,27 @@ RSpec.describe TTY::Reader, '#read_line' do
 
     expect(answer).to eq("한글")
   end
+
+  it "supports multiline prompts" do
+    allow(TTY::Screen).to receive(:width).and_return(50)
+    prompt = "one\ntwo\nthree"
+    input << "aa\n"
+    input.rewind
+
+    answer = reader.read_line(prompt)
+
+    expect(answer).to eq("aa\n")
+    expect(output.string).to eq([
+      prompt,
+      "\e[2K\e[1G\e[1A" * 2,
+      "\e[2K\e[1G",
+      prompt + "a",
+      "\e[2K\e[1G\e[1A" * 2,
+      "\e[2K\e[1G",
+      prompt + "aa",
+      "\e[2K\e[1G\e[1A" * 2,
+      "\e[2K\e[1G",
+      prompt + "aa\n"
+    ].join)
+  end
 end

data/tty-reader.gemspec

@@ -11,7 +11,16 @@ Gem::Specification.new do |spec|
   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"
   spec.license       = "MIT"
-
+  if spec.respond_to?(:metadata=)
+    spec.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"      => spec.homepage,
+      "source_code_uri"   => "https://github.com/piotrmurach/tty-reader"
+    }
+  end
   spec.files         = Dir['{lib,spec,examples,benchmarks}/**/*.rb']
   spec.files        += Dir['{bin,tasks}/*', 'tty-reader.gemspec']
   spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -115,6 +115,7 @@ files:
 - examples/keypress.rb
 - examples/keypress_nonblock.rb
 - examples/line.rb
+- examples/multi_prompt.rb
 - examples/multiline.rb
 - examples/noecho.rb
 - examples/shell.rb
@@ -145,7 +146,13 @@ files:
 homepage: https://piotrmurach.github.io/tty
 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://piotrmurach.github.io/tty
+  source_code_uri: https://github.com/piotrmurach/tty-reader
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -161,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A set of methods for processing keyboard input in character, line and multiline