webri 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295d59fd4b80e45e52512d35242f62e51f5bcfc07728533dbff40fb7636f71f0
-  data.tar.gz: 820ad8115db7738ee02d50fba385ad24006c955e06e06e1ce2583b54ef3f5ead
+  metadata.gz: 68514ee1cc75ddf56d6e2571cf618e6cd9f4f1280ba36ead73b48dc55f1a76d2
+  data.tar.gz: ad21f3ead74402261aef2de10afe02f6d4dc84651e4ee455ec10fb69198470b7
 SHA512:
-  metadata.gz: acb1d71743a78d90158c7198b75748ab70acdc4d5422cfed6947ffef5de0d730015d2fe6a2031354c2aba41c4cb93951ab2dc50cfc940642a23c868435a34184
-  data.tar.gz: 0d52353858de9162c92378f839cf048516e83b7f78ed1560f9b273bb72c1a16d8f9d3d1d97356f5915e33eafdfee60cec216512c9a68835db7c91c05cbc65014
+  metadata.gz: ea208781efa16baa846c81f5760019dc22b8b291d3f82fda2f7e5f824f4fbb3079c22a5eb65beea5edeb6bc7e9e4c3c833e10a04d4393ad4ab12681aad4cc8d3
+  data.tar.gz: 55408e4193540296a0c9085ed8ba4c29843530ac91497b338cab2989bc19b407ba2b20c8f739b7c7d7698b2949bc140530a844578046af920cf2088e5f203fa3

data/exe/webri

@@ -5,7 +5,33 @@
 require 'optparse'
 require_relative '../lib/webri/version'
 require_relative '../lib/webri'
+require_relative '../lib/scraper'
 
+NAME = <<EOT
+
+Name:
+
+There are four types of names, as determined by prefixes:
+
+- Class or module: starts with a capital letter; e.g., 'Array'.
+- Singleton method: starts with '::'; e.g., '::new'.
+- Instance method: starts with '#' (escaped as '\\#', if your shell requires it);
+  e.g., '#inspect'.
+- Ruby file: starts with 'ruby:'; e.g., 'ruby:syntax_rdoc'.
+
+Name handling:
+
+- If name is a complete name of its type (and not also the start of other such names),
+  webri opens the page for that name.
+- If name is incomplete, but is the start of only one name of its type,
+  webri asks whether to open the page for that name.
+- If name is incomplete, but is the start of multiple names of its type,
+  webri displays those names and lets you choose.
+- If name is not a valid name of its type, webri asks whether show such names.
+- If name is not valid at all (i.e., does not start with any of the prefixes above),
+  webri prints an error message.
+
+EOT
 options = {}
 
 parser = OptionParser.new
@@ -15,13 +41,20 @@ parser.banner = <<-BANNER
 webri is a console application for displaying Ruby online HTML documentation.
 Documentation pages are opened in the default web browser.
 
-Usage: #{parser.program_name} [options]
-
-For more information, see https://github.com/BurdetteLamar/webri/blob/main/README.md.
+Usage: #{parser.program_name} [options] name
 
 BANNER
 
-parser.separator('Options:')
+RELEASES = Scraper.scrapers.keys.inspect
+
+parser.separator("Options:")
+release_description = <<-EOT
+
+EOT
+parser.on('-r', '--release RELEASE',
+          "Specify documentation release (one of #{RELEASES}).") do |value|
+  options[:release_name] = value
+end
 parser.on('-i', '--info', 'Print information about webri.') do
   options[:info] = true
 end
@@ -39,8 +72,9 @@ parser.on('-v', '--version', 'Print the version of webri.') do
   puts WebRI::VERSION
   exit
 end
+parser.separator(NAME)
 
 parser.parse!
 
-release_name = ARGV[0]
-WebRI.new(release_name, options)
+name = ARGV[0]
+WebRI.new(name, options)

data/lib/webri/version.rb

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

data/lib/webri.rb

@@ -61,22 +61,28 @@ class WebRI
                 :href_for_singleton_method_name,
                 :href_for_instance_method_name
 
-  def initialize(release_name = nil, options = {})
-    self.release_name = set_doc_release(release_name)
+  def initialize(name = nil, options = {})
     capture_options(options)
+    self.release_name = set_doc_release(@release_name)
     # data_file_path = File.join('data', self.release_name + '.json')
     data_file_path = File.expand_path("../data/#{self.release_name}.json", __dir__)
     json = open(data_file_path).read
     @data = JSON.parse(json, create_additions: true)
     make_groups
     print_info if @info
-    if os_type == :linux && !@noreline
+    if name
+      do_name(name)
+    elsif os_type == :linux && !@noreline
       repl_reline
     else
       repl_plain
     end
   end
 
+  def do_name(name)
+    show(name)
+  end
+
   def make_groups
     self.href_for_class_name = {}
     self.href_for_file_name = {}
@@ -98,7 +104,7 @@ class WebRI
 
   def repl_plain # Read-evaluate-print loop, without Reline.
     while true
-        $stdout.write(PROMPT)
+      $stdout.write(PROMPT)
       $stdout.flush
       response = $stdin.gets.chomp
       exit if response == 'exit'
@@ -191,6 +197,7 @@ class WebRI
     @noop = options[:noop]
     @info = options[:info]
     @noreline = options[:noreline]
+    @release_name = options[:release_name]
   end
 
   class Entry

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webri
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - BurdetteLamar