webri 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6217b650dbad69d9d6f446e5d7c5e615042ee5ca56d85fa98866d5c31fb332c6
-  data.tar.gz: b0b4bd81d6f463d1a5df7d39b30b21c6cedd2d082e8a14239ee1d6c54dcdf91b
+  metadata.gz: 6c3d0d85a57c242ce0e81aa73823aef986a893a1f48e1d675d6b4d5a268cbb45
+  data.tar.gz: '050383f4ecf292a67ab9445f7fbbf5b1523be63062a642b4d74eaf9f20b766e8'
 SHA512:
-  metadata.gz: e66e895a9eea4695324e69ebf425b193e0e3774cb0390f8e4bfc2953af824eee9e68ad4b3cd8a5361dea6898a3cd81a9bdc2dc70012bd43429de8dc01b9d59fb
-  data.tar.gz: b5eec14697ef1d868d6285b8004969d3a770da7a3c807030c91a57ffe3b13277801b859f2e7eb1843f552f50f36d55c783d6c43abc200d6c8c844ce90994bf6d
+  metadata.gz: f859eb825ce282a5198e7e50ee3114f71ecd39098b6416fa2538c79507cacf942366aa8c2c46e7c14b6d06e66b90f908fa8b756ce61d9c055920ba354fd60295
+  data.tar.gz: 8c31cc2229776e28c6f47320c7a2cdc8eb1d61157d3c10c10492e0dc7b682394c414a87bff694b25d21d3fad60ee2c82c2fe8ccc89dde7c69838177428bddc89

data/CHANGELOG.md

@@ -7,3 +7,7 @@
 ## [1.0.2] - 2025-06-14
 
 - Clarify concept: Ruby page (not Ruby file).
+
+## [1.0.3] - 2025-06-16
+
+- Add support for Reline.

data/README.md

@@ -1,4 +1,4 @@
-# WebRI
+# WebRI - Quick Access to Ruby Online Documentation
 
 WebRI has a command-line utility, `webri`, for displaying Ruby online documentation.
 
@@ -335,6 +335,7 @@ Opening web page https://docs.ruby-lang.org/en/3.4/regexp/unicode_properties_rdo
 To display the WebRI help text, use the special name `@help`:
 
 ```
+$ ruby bin/webri
 webri> @help
 Showing help.
 webri is a console application for displaying Ruby online HTML documentation.
@@ -347,6 +348,7 @@ For more information, see https://github.com/BurdetteLamar/webri/blob/main/READM
 Options:
     -i, --info                       Prints information about webri.
     -r, --release=RELEASE            Sets the Ruby release to document.
+        --noreline                   Does not use Reline (helps testing).
     -n, --noop                       Does not actually open web pages.
     -h, --help                       Prints this help.
     -v, --version                    Prints the version of webri.
@@ -359,6 +361,14 @@ webri> @readme
 Opening web page https://github.com/BurdetteLamar/webri/blob/main/README.md.
 ```
 
+### Reline
+
+`webri` uses [Reline](https://ruby.github.io/reline/Reline.html)
+(on Linux, but not on other OS platforms).
+
+Reline enables editing of text at the `webri` prompt (use left- and right-arrows),
+and gives access to history (use up-arrow).
+
 ### Options
 
 Option `--info` prints information about WebRI,
@@ -422,6 +432,8 @@ Opening web page https://docs.ruby-lang.org/en/3.4/Array.html.
 Command: 'start https://docs.ruby-lang.org/en/3.4/Array.html'
 ```
 
+Option `--noreline` blocks Reline behavior; see [Reline][6].
+
 Option `--help` prints the WebRI help text.
 
 Option `--version` prints the WebRI version.
@@ -454,3 +466,4 @@ to follow the [code of conduct](https://github.com/BurdetteLamar/webri/blob/mast
 [3]: rdoc-ref:README.md@Instance+Method
 [4]: rdoc-ref:README.md@Ruby+Page
 [5]: rdoc-ref:README.md@Special+Names
+[6]: rdoc-ref:README.md@Reline

data/bin/webri

@@ -28,6 +28,9 @@ end
 parser.on('-r=RELEASE', '--release=RELEASE', 'Sets the Ruby release to document.') do |value|
   options[:release] = value
 end
+parser.on('--noreline', 'Does not use Reline (helps testing).') do |value|
+  options[:noreline] = true
+end
 parser.on('-n', '--noop', 'Does not actually open web pages.') do |value|
   options[:noop] = true
 end

data/lib/webri/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class WebRI
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/webri.rb

@@ -4,6 +4,7 @@ require 'rbconfig'
 require 'open-uri'
 require 'rexml'
 require 'cgi'
+require 'reline'
 
 # TODO: Use reline.
 #
@@ -37,6 +38,15 @@ class WebRI
     get_toc_html
     build_indexes
     print_info if @info
+    print @noreline
+    if os_type == :linux && !@noreline
+      repl_reline
+    else
+      repl_plain
+    end
+  end
+
+  def repl_plain # Read-evaluate-print loop, without Reline.
     while true
       $stdout.write('webri> ')
       $stdout.flush
@@ -51,6 +61,46 @@ class WebRI
     end
   end
 
+  def repl_reline # Read-evaluate-print loop, with Reline.
+    begin
+      stty_save = `stty -g`.chomp
+    rescue
+    end
+
+    begin
+      completion_words= []
+      @index_for_type.each_pair do |type, index|
+        if type == :page
+          completion_words += index.keys.map {|name| 'ruby:' + name }
+        else
+          completion_words += index.keys
+        end
+      end
+      Reline.completion_proc = proc { |word|
+        completion_words
+      }
+      while line = Reline.readline("webri> ", true)
+        case line.chomp
+        when 'exit'
+          exit 0
+        when ''
+          # NOOP
+        else
+          if line.split(' ').size > 1
+            puts "One name at a time, please."
+            next
+          end
+          show(line)
+        end
+      end
+    rescue Interrupt
+      puts '^C'
+      `stty #{stty_save}` if stty_save
+      exit 0
+    end
+    puts
+  end
+
   def set_doc_release
     supported_releases = []
     unsupported_releases = []
@@ -176,6 +226,7 @@ class WebRI
   def capture_options(options)
     @noop = options[:noop]
     @info = options[:info]
+    @noreline = options[:noreline]
     @doc_release = options[:release]
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: webri
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - BurdetteLamar
 bindir: bin
 cert_chain: []
-date: 2025-06-14 00:00:00.000000000 Z
+date: 2025-06-16 00:00:00.000000000 Z
 dependencies: []
 description: Command-line utility for displaying Ruby online documentation
 email: