webri 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6217b650dbad69d9d6f446e5d7c5e615042ee5ca56d85fa98866d5c31fb332c6
-  data.tar.gz: b0b4bd81d6f463d1a5df7d39b30b21c6cedd2d082e8a14239ee1d6c54dcdf91b
+  metadata.gz: 7ef41bc56c51b1f70b9dcf6ad2b041954ca23553f92929293018212124c8f0af
+  data.tar.gz: ab1d68150314f7047165777f04aeb4f1e3451e7d3e8329b7f0ce0b8982519f45
 SHA512:
-  metadata.gz: e66e895a9eea4695324e69ebf425b193e0e3774cb0390f8e4bfc2953af824eee9e68ad4b3cd8a5361dea6898a3cd81a9bdc2dc70012bd43429de8dc01b9d59fb
-  data.tar.gz: b5eec14697ef1d868d6285b8004969d3a770da7a3c807030c91a57ffe3b13277801b859f2e7eb1843f552f50f36d55c783d6c43abc200d6c8c844ce90994bf6d
+  metadata.gz: 0b473b80056568a02d1eb052300969181d0c74cd5328ad8136d1f2c5c89c9bc0a927c2ffb2dcf75c68fbca1197bc962e91e1fe8f58f19dea50d8ce46dbea7a38
+  data.tar.gz: '09258648444b4f7323ccd8ff4977689e2d82e7b8f4c9509ca848b5bbec8a24dfcd9fb65c66e8b4f8a10bc1d337e93511cf9d442080c29dbc134d73309ef833da'

data/CHANGELOG.md

@@ -1,9 +1,13 @@
-## Releases
-
-## [1.0.1] - 2025-06-13
-
-- Initial release
-
-## [1.0.2] - 2025-06-14
-
-- Clarify concept: Ruby page (not Ruby file).
+## Releases
+
+## [1.0.1] - 2025-06-13
+
+- Initial release
+
+## [1.0.2] - 2025-06-14
+
+- Clarify concept: Ruby page (not Ruby file).
+
+## [1.0.3] - 2025-06-16
+
+- Add support for Reline.

data/CODE_OF_CONDUCT.md

@@ -1,132 +1,132 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-https://github.com/BurdetteLamar/webri/issues.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+https://github.com/BurdetteLamar/webri/issues.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 BurdetteLamar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2024 BurdetteLamar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-task default: :test
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/bin/webri

@@ -12,6 +12,16 @@ parser = OptionParser.new
 
 parser.version = WebRI::VERSION
 parser.banner = <<-BANNER
+=====================================================
+17-Jul-2026
+
+Webri was broken by the Ruby documentation's change
+from Darkfish format to Aliki format,
+and by the removal of CGI from the Ruby core.
+
+Expect fixes within this month.
+=====================================================
+
 webri is a console application for displaying Ruby online HTML documentation.
 Documentation pages are opened in the default web browser.
 
@@ -28,6 +38,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.4"
 end

data/lib/webri.rb

@@ -4,7 +4,9 @@ require 'rbconfig'
 require 'open-uri'
 require 'rexml'
 require 'cgi'
+require 'reline'
 
+# TODO: Make it work on Aliki.
 # TODO: Use reline.
 #
 # TODO: Subroutinize.
@@ -12,7 +14,7 @@ require 'cgi'
 
 # TODO: Choose dynamically the test names (rather than fixed)?
 # TODO: Test on Linux.
-# TODO: Test all releases(?).
+# TODO: Test all releases(?).0
 # TODO: Test all pages(?).
 
 # TODO: Make it work for naked method ('parse') or dotted method ('.parse').
@@ -37,6 +39,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 +62,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 +227,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.4
 platform: ruby
 authors:
 - BurdetteLamar
 bindir: bin
 cert_chain: []
-date: 2025-06-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Command-line utility for displaying Ruby online documentation
 email:
@@ -44,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: RI for web pages
 test_files: []