highline 3.0.0.pre.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a520ba256dca588d4af090b8a9c41d808bd208966d3d3eabaf17a5e5516ad1
-  data.tar.gz: c0ab504488edce75cb6e290a119467ffb91ebbd9abbab3acedcc3da7198ad554
+  metadata.gz: 735a6b484551754886d61f83a5b2a8526c500a8e17302c000959de02d7cf5f82
+  data.tar.gz: a5a5a390bd2951386d1f82c8124e300ad77af2e16460272a18d0ce7615e90434
 SHA512:
-  metadata.gz: '09efdc10dabb3dfedf2155faff822c845f819119f18abdcaa298607df6cf279ed955d693e31db5038509a16dbbee35f61fa18dc88591cfa6d2aa9543213d0129'
-  data.tar.gz: c0a80e2ed2caaada155c2b66433dcafec06e0abb63bfe206470e65697b46f8a9888bbc7d2c64bb21f7cbf46218b5561a00f62f115f9d4355d098cbf911cf1523
+  metadata.gz: 25d3b1034cdf2bae31625ec982f2ea0dbe8261e9b32ac7071ad8ef6d84ff6da9e872998f1388050f808bffeab8085d47da1c080b98e1523445d44739cd38e3a0
+  data.tar.gz: 70b42a24ef3b03046ffe82074b6b82acc5519fc37c6c07c95adf6b8edddeef66d211dcf5b44967460e2ec9116763a9871d668e8aaab5cff0cdb996958fc7fb50

data/.github/workflows/ci.yml

@@ -10,6 +10,7 @@ jobs:
         os: [ubuntu-latest]
         ruby-version:
           - head
+          - '3.3'
           - '3.2'
           - '3.1'
           - '3.0'
@@ -22,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
@@ -32,7 +33,7 @@ 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

data/Changelog.md

@@ -2,7 +2,9 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
-### 3.0.0.pre.1 / 2023-04-27
+### 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)

data/README.md

@@ -139,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/highline.gemspec

@@ -29,8 +29,10 @@ DESCRIPTION
 
   spec.required_ruby_version = ">= 3.0"
 
+  spec.add_runtime_dependency "abbrev"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "dry-types"
+  spec.add_development_dependency "reline"
 end

data/lib/highline/question.rb

@@ -116,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.
     #
@@ -125,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.
@@ -580,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)

data/lib/highline/question_asker.rb

@@ -24,7 +24,8 @@ 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)

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,7 +109,7 @@ 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|
@@ -117,12 +117,14 @@ class HighLine
         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)
+        Readline.readline(prompt, true)
       end
 
       $VERBOSE = old_verbose

data/lib/highline/version.rb

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

data/lib/highline.rb

@@ -371,10 +371,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 +384,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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: highline
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.1
+  version: 3.0.0
 platform: ruby
 authors:
 - James Edward Gray II
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: abbrev
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !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: :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
@@ -154,11 +182,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: HighLine is a high-level command-line IO library.