highline 2.0.3 → 3.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c2652997ba01a32e3b6357a60c0567724e235d3763fa7dd000a6adbf71a6d75
-  data.tar.gz: 93fa0727991ba6d16e36a3a76f48784b54c15b8d4e8b32a0703a12c665e62601
+  metadata.gz: 00a520ba256dca588d4af090b8a9c41d808bd208966d3d3eabaf17a5e5516ad1
+  data.tar.gz: c0ab504488edce75cb6e290a119467ffb91ebbd9abbab3acedcc3da7198ad554
 SHA512:
-  metadata.gz: aae3c4c97d87a3b3fd5e12fcb234acc5a3470e3392942db6b369ea42c83fdd2ae90104b8a6957f8250616c35c16f1ab5acb11edeeb585f505f392367293154e9
-  data.tar.gz: 1dc931251446b234c9fff7c2389cd4d156a2fdd8619dc3f57a74cc06b8b50cf4c10ae7943fdfb6b20c2ef1359721d38faa03c875c5ef973bf38a87942173c060
+  metadata.gz: '09efdc10dabb3dfedf2155faff822c845f819119f18abdcaa298607df6cf279ed955d693e31db5038509a16dbbee35f61fa18dc88591cfa6d2aa9543213d0129'
+  data.tar.gz: c0a80e2ed2caaada155c2b66433dcafec06e0abb63bfe206470e65697b46f8a9888bbc7d2c64bb21f7cbf46218b5561a00f62f115f9d4355d098cbf911cf1523

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby-version:
+          - head
+          - '3.2'
+          - '3.1'
+          - '3.0'
+          - jruby
+          - jruby-head
+          - truffleruby
+          - truffleruby-head
+          - truffleruby+graalvm
+        include:
+          - os: windows-latest
+            ruby-version: head
+          - os: windows-latest
+            ruby-version: '3.1'
+          - os: windows-latest
+            ruby-version: mingw
+          - os: windows-latest
+            ruby-version: mswin
+          - os: windows-latest
+            ruby-version: ucrt
+          - os: macos-latest
+            ruby-version: 'head'
+          - os: macos-latest
+            ruby-version: '3.1'
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake test

data/Changelog.md

@@ -2,6 +2,25 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+### 3.0.0.pre.1 / 2023-04-27
+* PR #263 - Release 3.0.0.pre.1
+  * Raise minimum Ruby version requirement to 3.0
+* PR #262 - Do not call stty on non-tty (@kbrock)
+* PR #260 / I #43 - Ctrl-U (erase line) handling (@abinoam, issue by @gutenye)
+* PR #259 / I #236 - Handle Ctrl-C when Question#echo = false (@abinoam, @Fahhetah, issue by @aspyct)
+* PR #258 / I #246 - Add validation class support (@abinoam, issue by @Joshfindit)
+  * Make it dry-types compatible through the use of `#valid?`
+  * Solve the multiple answers in one line problem with a combination of custom coercion (parser) and custom validation
+* PR #257 / I #233 - Show Question#default hint for non String values (@abinoam, issue by @branch14)
+  * Add Question#default_hint_show to allow disabling it.
+* PR #256 / I #249 - Fix Array validation in Question#in (@abinoam, issue by @esotericpig)
+
+### 2.1.0 / 2022-12-31
+* PR #255 - Change minimum Ruby version requirement to 2.3 (@abinoam)
+* PR #254 - Improve Github Actions file (@abinoam)
+* PR #253, PR #251 - Setup GitHub Actions and remove Travis (@petergoldstein, rev by @AlexWayfer)
+* PR #250 - Fix file permissions (@bdunne)
+
 ### 2.0.3 / 2019-10-11
 * PR #245 - Suppress `Psych.safe_load` arg warn (@koic)
 

data/Gemfile

@@ -7,16 +7,13 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in tgem.gemspec
 gemspec
 
-platform :ruby do
-  # Running only on MRI
-  gem "simplecov", group: :test
-end
+gem "simplecov", group: :test, require: false
 
 group :code_quality do
   gem "flog", require: false
   gem "pronto", require: false, platform: :ruby
   gem "pronto-flay", require: false, platform: :ruby
-  gem "pronto-poper", require: false, platform: :ruby
+  # gem "pronto-poper", require: false, platform: :ruby
   gem "pronto-reek", require: false, platform: :ruby
   gem "pronto-rubocop", require: false, platform: :ruby
 end

data/README.md

@@ -1,8 +1,7 @@
 HighLine
 ========
 
-[![Build Status](https://travis-ci.org/JEG2/highline.svg?branch=master)](https://travis-ci.org/JEG2/highline)
-[![Build status](https://ci.appveyor.com/api/projects/status/4p05fijpah77d28x/branch/master?svg=true)](https://ci.appveyor.com/project/JEG2/highline/branch/master)
+[![Tests](https://github.com/JEG2/highline/actions/workflows/ci.yml/badge.svg)](https://github.com/JEG2/highline/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/highline.svg)](https://badge.fury.io/rb/highline)
 [![Code Climate](https://codeclimate.com/github/JEG2/highline/badges/gpa.svg)](https://codeclimate.com/github/JEG2/highline)
 [![Test Coverage](https://codeclimate.com/github/JEG2/highline/badges/coverage.svg)](https://codeclimate.com/github/JEG2/highline/coverage)
@@ -44,12 +43,48 @@ puts "You have answered: #{answer}"
 
 cli.ask("Company?  ") { |q| q.default = "none" }
 
+## Disable default value hint showing
+
+my_special_default_object = Object.new
+
+cli.ask("Question?  ") do |q|
+  q.default = my_special_default_object
+  q.default_hint_show = false
+end
+
 
 # Validation
 
 cli.ask("Age?  ", Integer) { |q| q.in = 0..105 }
 cli.ask("Name?  (last, first)  ") { |q| q.validate = /\A\w+, ?\w+\Z/ }
 
+## Validation with custom class
+class ZeroToTwentyFourValidator
+  def self.valid?(answer)
+    (0..24).include? answer.to_i
+  end
+
+  def self.inspect
+    "(0..24) rule"
+  end
+end
+
+cli.ask("What hour of the day is it?:  ", Integer) do |q|
+  q.validate = ZeroToTwentyFourValidator
+end
+
+## Validation with Dry::Types
+## `Dry::Types` provides a `valid?` method so it can be used effortlessly
+
+require 'dry-type'
+
+module Types
+  include Dry.Types
+end
+
+cli.ask("Type an integer:", Integer) do |q|
+  q.validate = Types::Coercible::Integer
+end
 
 # Type conversion for answers:
 

data/examples/custom_parser_custom_validator.rb

@@ -0,0 +1,39 @@
+require 'highline'
+
+cli = HighLine.new
+
+# The parser
+class ArrayOfNumbersFromString
+  def self.parse(string)
+    string.scan(/\d+/).map(&:to_i)
+  end
+end
+
+# The validator
+class ArrayOfNumbersFromStringInRange
+  def self.in?(range)
+    new(range)
+  end
+
+  attr_reader :range
+
+  def initialize(range)
+    @range = range
+  end
+
+  def valid?(answer)
+    ary = ArrayOfNumbersFromString.parse(answer)
+    ary.all? ->(number) { range.include? number }
+  end
+
+  def inspect
+    "in range #@range validator"
+  end
+end
+
+answer = cli.ask("Which number? (0 or <Enter> to skip): ", ArrayOfNumbersFromString) { |q|
+  q.validate = ArrayOfNumbersFromStringInRange.in?(0..10)
+  q.default = 0
+}
+
+puts "Your answer was: #{answer} and it was correctly validated and coerced into an #{answer.class}"

data/highline.gemspec

@@ -27,9 +27,10 @@ DESCRIPTION
 
   spec.extra_rdoc_files = %w[README.md TODO Changelog.md LICENSE]
 
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "dry-types"
 end

data/lib/highline/io_console_compatible.rb

@@ -13,7 +13,7 @@ require "tempfile"
 #
 
 module IOConsoleCompatible
-  def getch
+  def getch(min:nil, time:nil, intr: nil)
     getc
   end
 

data/lib/highline/question/answer_converter.rb

@@ -9,7 +9,7 @@ class HighLine
       extend Forwardable
 
       def_delegators :@question,
-                     :answer, :answer=, :check_range,
+                     :answer, :answer=,
                      :directory, :answer_type, :choices_complete
 
       # It should be initialized with a Question object.
@@ -26,10 +26,7 @@ class HighLine
       # it makes the conversion and returns the answer.
       # @return [Object] the converted answer.
       def convert
-        return unless answer_type
-
-        self.answer = convert_by_answer_type
-        check_range
+        self.answer = convert_by_answer_type if answer_type
         answer
       end
 

data/lib/highline/question.rb

@@ -56,6 +56,7 @@ class HighLine
       @completion  = @answer_type
 
       @echo         = true
+      @default_hint_show = true
       @whitespace   = :strip
       @case         = nil
       @in           = nil
@@ -136,10 +137,17 @@ class HighLine
     attr_accessor :case
     # Used to provide a default answer to this question.
     attr_accessor :default
+    # Set it to a truthy or falsy value to enable or disable showing the default
+    # value hint between vertical bars (pipes) when asking the question.
+    # Defaults to +true+
+    attr_accessor :default_hint_show
     #
     # If set to a Regexp, the answer must match (before type conversion).
     # Can also be set to a Proc which will be called with the provided
     # answer to validate with a +true+ or +false+ return.
+    # It's possible to use a custom validator class. It must respond to
+    # `#valid?`. The result of `#inspect` will be used in error messages.
+    # See README.md for details.
     #
     attr_accessor :validate
     # Used to control range checks for answer.
@@ -252,7 +260,7 @@ class HighLine
     #   Same as {#answer_type}.
 
     def build_responses(message_source = answer_type)
-      append_default if [::String, Symbol].include? default.class
+      append_default_to_template if default_hint_show
 
       new_hash = build_responses_new_hash(message_source)
       # Update our internal responses with the new hash
@@ -497,7 +505,8 @@ class HighLine
     def valid_answer?
       !validate ||
         (validate.is_a?(Regexp) && answer =~ validate) ||
-        (validate.is_a?(Proc)   && validate[answer])
+        (validate.is_a?(Proc)   && validate[answer]) ||
+        (validate.respond_to?(:valid?) && validate.valid?(answer))
     end
 
     #
@@ -607,15 +616,20 @@ class HighLine
     # Trailing whitespace is preserved so the function of HighLine.say() is
     # not affected.
     #
-    def append_default
+    def append_default_to_template
+      return unless default.respond_to? :to_s
+
+      default_str = default.to_s
+      return if default_str.empty?
+
       if template =~ /([\t ]+)\Z/
-        template << "|#{default}|#{Regexp.last_match(1)}"
+        template << "|#{default_str}|#{Regexp.last_match(1)}"
       elsif template == ""
-        template << "|#{default}|  "
+        template << "|#{default_str}|  "
       elsif template[-1, 1] == "\n"
-        template[-2, 0] = "  |#{default}|"
+        template[-2, 0] = "  |#{default_str}|"
       else
-        template << "  |#{default}|"
+        template << "  |#{default_str}|"
       end
     end
 

data/lib/highline/question_asker.rb

@@ -31,6 +31,7 @@ class HighLine
         raise NotValidQuestionError unless question.valid_answer?
 
         question.convert
+        question.check_range
 
         if question.confirm
           confirmation = @highline.send(:confirm, question)

data/lib/highline/terminal/io_console.rb

@@ -27,7 +27,7 @@ class HighLine
 
       # (see Terminal#get_character)
       def get_character
-        input.getch # from ruby io/console
+        input.getch(intr: true) # from ruby io/console
       rescue Errno::ENOTTY
         input.getc
       end

data/lib/highline/terminal/unix_stty.rb

@@ -20,7 +20,9 @@ class HighLine
         rescue LoadError
         end
 
-        if /solaris/ =~ RUBY_PLATFORM &&
+        if !@output.tty?
+          [80, 24]
+        elsif /solaris/ =~ RUBY_PLATFORM &&
            `stty` =~ /\brows = (\d+).*\bcolumns = (\d+)/
           [Regexp.last_match(2), Regexp.last_match(1)].map(&:to_i)
         elsif `stty size` =~ /^(\d+)\s(\d+)$/
@@ -32,13 +34,13 @@ class HighLine
 
       # (see Terminal#raw_no_echo_mode)
       def raw_no_echo_mode
-        @state = `stty -g`
-        system "stty raw -echo -icanon isig"
+        save_stty 
+        system "stty raw -echo -icanon isig" if input.tty?
       end
 
       # (see Terminal#restore_mode)
       def restore_mode
-        system "stty #{@state}"
+        restore_stty
         print "\r"
       end
 

data/lib/highline/terminal.rb

@@ -176,7 +176,7 @@ class HighLine
     # Saves terminal state using shell stty command.
     def save_stty
       @stty_save = begin
-                     `stty -g`.chomp
+                     `stty -g`.chomp if input.tty?
                    rescue StandardError
                      nil
                    end

data/lib/highline/version.rb

@@ -2,5 +2,5 @@
 
 class HighLine
   # The version of the installed library.
-  VERSION = "2.0.3".freeze
+  VERSION = "3.0.0.pre.1".freeze
 end

data/lib/highline.rb

@@ -538,6 +538,7 @@ class HighLine
     terminal.raw_no_echo_mode_exec do
       loop do
         character = terminal.get_character
+        raise Interrupt if character == "\u0003"
         break unless character
         break if ["\n", "\r"].include? character
 
@@ -545,6 +546,9 @@ class HighLine
         if character == "\b" || character == "\u007F"
           chopped = line.chop!
           output_erase_char if chopped && question.echo
+        elsif character == "\cU"
+          line.size.times { output_erase_char } if question.echo
+          line = ""
         elsif character == "\e"
           ignore_arrow_key
         else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highline
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0.pre.1
 platform: ruby
 authors:
 - James Edward Gray II
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   A high-level IO library that provides validation, type conversion, and more for
   command-line interfaces. HighLine also includes a complete menu system that can
@@ -66,10 +80,10 @@ extra_rdoc_files:
 - Changelog.md
 - LICENSE
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - AUTHORS
 - COPYING
 - Changelog.md
@@ -78,12 +92,12 @@ files:
 - README.md
 - Rakefile
 - TODO
-- appveyor.yml
 - doc/.cvsignore
 - examples/ansi_colors.rb
 - examples/asking_for_arrays.rb
 - examples/basic_usage.rb
 - examples/color_scheme.rb
+- examples/custom_parser_custom_validator.rb
 - examples/get_character.rb
 - examples/limit.rb
 - examples/menus.rb
@@ -137,14 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: HighLine is a high-level command-line IO library.

data/.travis.yml

@@ -1,43 +0,0 @@
----
-language: ruby
-dist: trusty
-cache: bundler
-script: "bundle exec rake test"
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - jruby-19mode # JRuby in 1.9 mode
-  - jruby-head
-
-notifications:
-  email: false
-matrix:
-  allow_failures:
-    - rvm: 1.9
-    - rvm: ruby-head
-    - rvm: rbx-3.81
-    - rvm: jruby-19mode # JRuby in 1.9 mode
-    - rvm: jruby-head
-  fast_finish: true
-  include:
-    - rvm: 1.9
-      before_install:
-        - "gem update --system -N"
-        - "gem update bundler -N"
-    - rvm: 2.5
-      before_install:
-        - gem install bundler
-    - rvm: 2.6
-      before_install:
-        - gem install bundler
-    - rvm: ruby-head
-      before_install:
-          - gem install bundler
-    - rvm: rbx-3.81
-      before_install:
-          - gem install bundler
-
-bundler_args: --without code_quality

data/appveyor.yml

@@ -1,37 +0,0 @@
-version: 2.0.{build}-{branch}
-
-cache:
-  - vendor/bundle
-
-environment:
-  matrix:
-    - RUBY_VERSION: "193"
-    - RUBY_VERSION: "200"
-    - RUBY_VERSION: "200-x64"
-    - RUBY_VERSION: "21"
-    - RUBY_VERSION: "21-x64"
-    - RUBY_VERSION: "22"
-    - RUBY_VERSION: "22-x64"
-    - RUBY_VERSION: "23"
-    - RUBY_VERSION: "23-x64"
-    - RUBY_VERSION: "24"
-    - RUBY_VERSION: "24-x64"
-
-matrix:
-  allow_failures:
-    - RUBY_VERSION: "193"
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle config --local path vendor/bundle
-  - bundle install --retry=3 --without code_quality
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake