highline 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb41764d2e42ab3b3c52ca1735f0cd6a587ff5ed3bb4525d0e7703dc4ccb61f
-  data.tar.gz: 0424d1467c1f787881abfe6558afdc0aceeb0e854d05efac8c5c6db9d07ba3cf
+  metadata.gz: 68bd1dba0eea8f51020e4b42bf027a432313b312efcf1365c20a6d5ca2b13244
+  data.tar.gz: d1dd90401ba1b29581afe8e89ef5a2ad3b443184e61f73dd7a60252404c30172
 SHA512:
-  metadata.gz: df0dd1fa4d206aace9512f7ad414bc1e6bdcbfe804fd91b3811a2bc5860dbe7862d3ab81a502fc812747134be1122a647ac9fdd8e95e88e3f9388f7a05f38c22
-  data.tar.gz: 70cbe01e01aeff63d8321a4768caaa43992082030ad4e3f93533693d7f7908b30175852c11286fe3a744c4a3a3be63ad3328e7b5b605a045ad4f634887e1340d
+  metadata.gz: b7bcd45c71419a9e90c9cdc9f1dba9c42be76618068cadc8e30e41600272413b16df3cd95d95266fc4d24d70c00c53668f6fe7134fb1e5cee4780740eabc2378
+  data.tar.gz: 20cfca01c3f433766f9d0884b5ea32dcfa690e6b3652fc6aeb9e691f5eb62f1ffc99ec9941fe724603684b660d374af23b8819054a1e5dfffb5655ff8107df1e

data/.github/workflows/ci.yml

@@ -10,14 +10,10 @@ jobs:
         os: [ubuntu-latest]
         ruby-version:
           - head
+          - '3.3'
           - '3.2'
           - '3.1'
           - '3.0'
-          - '2.7'
-          - '2.6'
-          - '2.5'
-          - '2.4'
-          - '2.3'
           - jruby
           - jruby-head
           - truffleruby
@@ -27,7 +23,7 @@ jobs:
           - os: windows-latest
             ruby-version: head
           - os: windows-latest
-            ruby-version: '3.1'
+            ruby-version: '3.3'
           - os: windows-latest
             ruby-version: mingw
           - os: windows-latest
@@ -37,10 +33,10 @@ jobs:
           - os: macos-latest
             ruby-version: 'head'
           - os: macos-latest
-            ruby-version: '3.1'
+            ruby-version: '3.3'
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:

data/Changelog.md

@@ -2,6 +2,28 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+### 3.1.0 / 2024-07-15
+* PR #272 / I #271 - Readline is now completed deprecated over Reline (@abinoam, issue by @64kramsystem)
+* PR #269 - Provide a 'Changelog' link on rubygems.org/gems/highline (@mark-young-atg)
+
+### 3.0.1 / 2024-01-20
+* PR #268 - Remove unused abbrev dependency (@zvkemp)
+
+### 3.0.0 / 2024-01-05
+* PR #265 - Change Readline for Reline for Ruby 3.3 compat (@abinoam)
+* PR #264 - Add abbrev gem as dependency (@mathieujobin)
+* 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)

data/README.md

@@ -43,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:
 
@@ -103,7 +139,7 @@ For more examples see the examples/ directory of this project.
 Requirements
 ------------
 
-HighLine from version >= 1.7.0 requires ruby >= 1.9.3
+HighLine from version >= 3.0.0 requires ruby >= 3.0.0
 
 Installing
 ----------

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,14 @@ DESCRIPTION
 
   spec.extra_rdoc_files = %w[README.md TODO Changelog.md LICENSE]
 
-  spec.required_ruby_version = ">= 2.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"
+
+  spec.add_runtime_dependency "reline"
+
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/Changelog.md"
 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
@@ -115,7 +116,7 @@ class HighLine
     #
     attr_accessor :echo
     #
-    # Use the Readline library to fetch input.  This allows input editing as
+    # Use the Reline library to fetch input.  This allows input editing as
     # well as keeping a history.  In addition, tab will auto-complete
     # within an Array of choices or a file listing.
     #
@@ -124,6 +125,7 @@ class HighLine
     # specified _input_ stream.
     #
     attr_accessor :readline
+
     #
     # Used to control whitespace processing for the answer to this question.
     # See HighLine::Question.remove_whitespace() for acceptable settings.
@@ -136,10 +138,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 +261,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 +506,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
 
     #
@@ -571,11 +581,6 @@ class HighLine
       end
     end
 
-    # readline() needs to handle its own output, but readline only supports
-    # full line reading.  Therefore if question.echo is anything but true,
-    # the prompt will not be issued. And we have to account for that now.
-    # Also, JRuby-1.7's ConsoleReader.readLine() needs to be passed the prompt
-    # to handle line editing properly.
     # @param highline [HighLine] context
     # @return [void]
     def show_question(highline)
@@ -607,15 +612,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

@@ -24,13 +24,15 @@ class HighLine
     #
     # @return [String] answer
     def ask_once
-      question.show_question(@highline)
+      # If in readline mode, let reline take care of the prompt
+      question.show_question(@highline) unless question.readline
 
       begin
         question.get_response_or_default(@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

@@ -95,9 +95,9 @@ class HighLine
     # Get one line using #readline_read
     # @param (see #get_line)
     def get_line_with_readline(question, highline)
-      require "readline" # load only if needed
+      require "reline" # load only if needed
 
-      raw_answer = readline_read(question)
+      raw_answer = readline_read(question, highline)
 
       if !raw_answer && highline.track_eof?
         raise EOFError, "The input stream is exhausted."
@@ -109,20 +109,22 @@ class HighLine
     # Use readline to read one line
     # @param question [HighLine::Question] question from where to get
     #   autocomplete candidate strings
-    def readline_read(question)
+    def readline_read(question, highline)
       # prep auto-completion
       unless question.selection.empty?
-        Readline.completion_proc = lambda do |str|
+        Reline.completion_proc = lambda do |str|
           question.selection.grep(/\A#{Regexp.escape(str)}/)
         end
       end
 
+      # TODO: Check if this is still needed after Reline
       # work-around ugly readline() warnings
       old_verbose = $VERBOSE
       $VERBOSE    = nil
 
       raw_answer  = run_preserving_stty do
-        Readline.readline("", true)
+        prompt = highline.render_and_ident_statement(question)
+        Reline.readline(prompt, true)
       end
 
       $VERBOSE = old_verbose
@@ -176,7 +178,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.1.0".freeze
+  VERSION = "3.1.0".freeze
 end

data/lib/highline.rb

@@ -14,7 +14,6 @@ require "English"
 require "erb"
 require "optparse"
 require "stringio"
-require "abbrev"
 require "highline/terminal"
 require "highline/custom_errors"
 require "highline/question"
@@ -371,10 +370,8 @@ class HighLine
   #
   # @param statement [Statement, String] what to be said
   def say(statement)
-    statement = render_statement(statement)
-    return if statement.empty?
-
-    statement = (indentation + statement)
+    statement = render_and_ident_statement(statement)
+    return statement if statement.empty?
 
     # Don't add a newline if statement ends with whitespace, OR
     # if statement ends with whitespace before a color escape code.
@@ -386,6 +383,18 @@ class HighLine
     end
   end
 
+  # Renders and indents a statement.
+  #
+  # Note: extracted here to be used by readline to render its prompt.
+  #
+  # @param statement [String] The statement to be rendered and indented.
+  # @return [String] The rendered and indented statement.
+  def render_and_ident_statement(statement)
+    statement = render_statement(statement)
+    statement = (indentation + statement) unless statement.empty?
+    statement
+  end
+
   # Renders a statement using {HighLine::Statement}
   # @param statement [String] any string
   # @return [Statement] rendered statement
@@ -538,6 +547,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 +555,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.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - James Edward Gray II
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ 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'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -83,6 +111,7 @@ files:
 - 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
@@ -127,8 +156,9 @@ files:
 homepage: https://github.com/JEG2/highline
 licenses:
 - Ruby
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/JEG2/highline/blob/master/Changelog.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +166,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: HighLine is a high-level command-line IO library.
 test_files: []