webri 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4bc8110feecac22d65e1e47e5fda7dc5315ea7dd4f1d4ab67c62d30af6bb8cb
-  data.tar.gz: 9574bb0c08d78ffd32a6627d0c19ecf0f81e7f7ba0303d64c0b6e92e93f2395f
+  metadata.gz: 6217b650dbad69d9d6f446e5d7c5e615042ee5ca56d85fa98866d5c31fb332c6
+  data.tar.gz: b0b4bd81d6f463d1a5df7d39b30b21c6cedd2d082e8a14239ee1d6c54dcdf91b
 SHA512:
-  metadata.gz: c7b52fa6deb5b9b2029d70ff7ea2b226b2734aa39a2cd6aeb8dce1e7ee2f3e6a687321997beea7b9d958a11cf3b8017d149bcd8dee82a5a98e645619be50db48
-  data.tar.gz: 1942e35d5aca012c2c8843cdf222502e787226ee5834b10d88409d0a4ccde8178c874a79a52d38c0bf36325a01ca5dcfec4ff6188360493ba2d2f3b5cd42e9f6
+  metadata.gz: e66e895a9eea4695324e69ebf425b193e0e3774cb0390f8e4bfc2953af824eee9e68ad4b3cd8a5361dea6898a3cd81a9bdc2dc70012bd43429de8dc01b9d59fb
+  data.tar.gz: b5eec14697ef1d868d6285b8004969d3a770da7a3c807030c91a57ffe3b13277801b859f2e7eb1843f552f50f36d55c783d6c43abc200d6c8c844ce90994bf6d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## Releases
 
-## [0.1.0] - 2024-11-28
+## [1.0.1] - 2025-06-13
 
 - Initial release
+
+## [1.0.2] - 2025-06-14
+
+- Clarify concept: Ruby page (not Ruby file).

data/README.md

@@ -14,7 +14,7 @@ WebRI displays documentation for:
 
 - A **class** or **module**: opens its web page.
 - A **method**: opens the web page for its class/module _scrolled to the method's documentation_.
-- A Ruby **file**: opens a free-standing web page.
+- A Ruby **page**: opens a free-standing web page.
 
 ## Usage
 
@@ -43,7 +43,7 @@ At the prompt, you can type:
 - The name of a [class or module][1].
 - The name of a [singleton method][2].
 - The name of an [instance method][3].
-- The name of a [Ruby file][4].
+- The name of a [Ruby page][4].
 - An abbreviation of any of the above.
 - One of the [special names][5] `@help` or `@readme`.
 
@@ -196,19 +196,19 @@ Found no instance method name starting with '#nosuch'.
 Show names of all 10370 instance methods? (y or n):  n
 ```
 
-### Ruby 'File'
+### Ruby Page
 
 For a name beginning with `ruby:`,
-finds the names of ruby files beginning
+finds the names of ruby pages beginning
 with that name.
 
-When exactly one such file name is found:
+When exactly one such page name is found:
 
 - If the name is the exact name of the found name, opens its page:
 
 ```
 webri> ruby:operators
-Found one file name starting with 'operators'
+Found one page name starting with 'operators'
   operators (syntax/operators_rdoc.html)
 ```
 
@@ -216,18 +216,18 @@ Found one file name starting with 'operators'
 
 ```
 webri> ruby:opera
-Found one file name starting with 'opera'
+Found one page name starting with 'opera'
   operators (syntax/operators_rdoc.html)
 Open page syntax/operators_rdoc.html? (y or n):  y
 Opening web page https://docs.ruby-lang.org/en/3.4/syntax/operators_rdoc.html.
 
 ```
 
-When multiple such file names are found offer to list the found names:
+When multiple such page names are found offer to list the found names:
 
 ```
 webri> ruby:o
-Found 4 file names starting with 'o'.
+Found 4 page names starting with 'o'.
 Show 4 names?' (y or n):  y
        0:  operators (syntax/operators_rdoc.html)
        1:  option_dump (ruby/option_dump_md.html)
@@ -237,12 +237,12 @@ Type a number to choose, or Return to skip:  2
 
 ```
 
-When no such file name is found, offers to list all file names:
+When no such page name is found, offers to list all page names:
 
 ```
 webri> ruby:nosuch
-Found no file name starting with 'nosuch'.
-Show names of all 83 files? (y or n):  y
+Found no page name starting with 'nosuch'.
+Show names of all 83 pages? (y or n):  y
        0:  COPYING (COPYING.html)
        1:  COPYING.ja (COPYING_ja.html)
        2:  LEGAL (LEGAL.html)
@@ -374,7 +374,7 @@ Names:
    1364 class names
    1175 singleton_method names
    4407 instance_method names
-     81 file names
+     81 page names
 ```
 
 Option `--release` sets the release of the documentation to be used.
@@ -389,7 +389,7 @@ Names:
    1262 class names
    1301 singleton_method names
    4397 instance_method names
-     73 file names
+     73 page names
 $ webri --release=3.3 --info
 Ruby documentation release:  '3.3'
 Ruby documentation URL:      'https://docs.ruby-lang.org/en/3.3/table_of_contents.html'
@@ -398,7 +398,7 @@ Names:
    1469 class names
    1270 singleton_method names
    4638 instance_method names
-     77 file names
+     77 page names
 ```
 
 Issues a message if the given release is unknown:
@@ -452,5 +452,5 @@ to follow the [code of conduct](https://github.com/BurdetteLamar/webri/blob/mast
 [1]: rdoc-ref:README.md@Class+or+Module
 [2]: rdoc-ref:README.md@Singleton+Method
 [3]: rdoc-ref:README.md@Instance+Method
-[4]: rdoc-ref:README.md@Ruby+File
+[4]: rdoc-ref:README.md@Ruby+Page
 [5]: rdoc-ref:README.md@Special+Names

data/lib/webri/version.rb

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

data/lib/webri.rb

@@ -10,12 +10,9 @@ require 'cgi'
 # TODO: Subroutinize.
 # TODO: Make initialization faster.
 
-# TODO: Build test names from ruby-lang.org (not webri).
-#
 # TODO: Choose dynamically the test names (rather than fixed)?
-# TODO: Test methods with trailing special chars, and with all special chars
 # TODO: Test on Linux.
-# TODO: Test all releases.
+# TODO: Test all releases(?).
 # TODO: Test all pages(?).
 
 # TODO: Make it work for naked method ('parse') or dotted method ('.parse').
@@ -104,7 +101,7 @@ class WebRI
       class: {}, # Has both classes and modules.
       singleton_method: {},
       instance_method: {},
-      file: {},
+      page: {},
     }
     # Iterate over the lines of the TOC page.
     lines = @toc_html.split("\n")
@@ -139,7 +136,7 @@ class WebRI
         end
         entry.paths.push(path) unless entry.paths.include?(path)
       when 'file'
-        index = @index_for_type[:file]
+        index = @index_for_type[:page]
         if index.include?(full_name)
           entry = index[full_name]
         else
@@ -277,7 +274,7 @@ class WebRI
     when %w[fatal fata fat fa f].include?(name)
       show_class(name, @index_for_type[:class])
     when name.start_with?('ruby:')
-      show_file(name, @index_for_type[:file])
+      show_file(name, @index_for_type[:page])
     when name.start_with?('::')
       show_singleton_method(name, @index_for_type[:singleton_method])
     when name.start_with?('#')
@@ -342,11 +339,11 @@ class WebRI
     open_page(name, uri)
   end
 
-  # Show file.
+  # Show page.
   def show_file(name, file_index)
     # Target page is a free-standing page such as 'COPYING'.
     name = name.sub(/^ruby:/, '') # Discard leading 'ruby:'
-    all_entries = @index_for_type[:file]
+    all_entries = @index_for_type[:page]
     all_choices = FileEntry.choices(all_entries)
     # Find entries whose names that start with name.
     selected_entries = all_entries.select do |key, value|
@@ -364,7 +361,7 @@ class WebRI
       selected_choices = FileEntry.choices(selected_entries)
       choice = selected_choices.keys.first
       path = selected_choices.values.first
-      puts "Found one file name starting with '#{name}'\n  #{choice}"
+      puts "Found one page name starting with '#{name}'\n  #{choice}"
       full_name = FileEntry.full_name_for_choice(choice)
       if name != full_name
         message = "Open page #{path}?"
@@ -372,15 +369,15 @@ class WebRI
       end
       path
     when 0
-      puts "Found no file name starting with '#{name}'."
-      message = "Show names of all #{all_choices.size} files?"
+      puts "Found no page name starting with '#{name}'."
+      message = "Show names of all #{all_choices.size} pages?"
       return unless get_boolean_answer(message)
       key = get_choice(all_choices.keys)
       return if key.nil?
       path = all_choices[key]
     else
       selected_choices = FileEntry.choices(selected_entries)
-      puts "Found #{selected_choices.size} file names starting with '#{name}'."
+      puts "Found #{selected_choices.size} page names starting with '#{name}'."
       message = "Show #{selected_choices.size} names?'"
       return unless get_boolean_answer(message)
       key = get_choice(selected_choices.keys)

metadata

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