webri 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295d59fd4b80e45e52512d35242f62e51f5bcfc07728533dbff40fb7636f71f0
-  data.tar.gz: 820ad8115db7738ee02d50fba385ad24006c955e06e06e1ce2583b54ef3f5ead
+  metadata.gz: f084a9f5fdfc0a04bc93e780f7a73c4fc371c294c99f10290c22174928f34330
+  data.tar.gz: 789d05f78b88eafca71373bf3db93ea911bbab28bb34a3a0a180e21054198c8d
 SHA512:
-  metadata.gz: acb1d71743a78d90158c7198b75748ab70acdc4d5422cfed6947ffef5de0d730015d2fe6a2031354c2aba41c4cb93951ab2dc50cfc940642a23c868435a34184
-  data.tar.gz: 0d52353858de9162c92378f839cf048516e83b7f78ed1560f9b273bb72c1a16d8f9d3d1d97356f5915e33eafdfee60cec216512c9a68835db7c91c05cbc65014
+  metadata.gz: f85eddc468ac54ba0bab2d99330442621a365384c5ace19f7679fc67a4d585e5101feb7303f5db37490fefb2082d588f2cd856ba03068918e5e3371a1af3e3eb
+  data.tar.gz: b39d8dbde0d310880b6a62383efadaf8509a80c51969c25bcbe64e445e7fa22296abf443b5c5aae13d5d5474b22a6c2cddc5619d6427ffc4935000e04ac76475

data/exe/webri

@@ -5,6 +5,7 @@
 require 'optparse'
 require_relative '../lib/webri/version'
 require_relative '../lib/webri'
+require_relative '../lib/scraper'
 
 options = {}
 
@@ -12,17 +13,22 @@ parser = OptionParser.new
 
 parser.version = WebRI::VERSION
 parser.banner = <<-BANNER
-webri is a console application for displaying Ruby online HTML documentation.
-Documentation pages are opened in the default web browser.
+Console application #{WebRI.webri} displays Ruby online HTML documentation
+in the default web browser.
 
-Usage: #{parser.program_name} [options]
-
-For more information, see https://github.com/BurdetteLamar/webri/blob/main/README.md.
+Usage: #{WebRI.webri} [options] #{WebRI.variable('name')}
 
 BANNER
 
-parser.separator('Options:')
-parser.on('-i', '--info', 'Print information about webri.') do
+RELEASES = Scraper.scrapers.keys.inspect
+
+parser.separator("Options:")
+
+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.webri}.") do
   options[:info] = true
 end
 parser.on('--noreline', 'Do not use Reline (useful for testing).') do |value|
@@ -35,12 +41,13 @@ parser.on('-h', '--help', 'Print this help.') do
   puts parser
   exit
 end
-parser.on('-v', '--version', 'Print the version of webri.') do
+parser.on('-v', '--version', "Print the version of #{WebRI.webri}.") do
   puts WebRI::VERSION
   exit
 end
+parser.separator(WebRI::HELP)
 
 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.2.0"
 end

data/lib/webri.rb

@@ -48,7 +48,9 @@ class WebRI
   # Site of the official documentation.
   DOC_SITE = 'https://docs.ruby-lang.org/en/'
 
-  PROMPT = "('?' for help) webri> "
+  def self.prompt
+    "(Type #{WebRI.tokenq('?')} for help, #{WebRI.tokenq('exit')} to exit) #{self.webri}> "
+  end
 
   CLASS = 'class/module'
   SINGLETON = 'singleton method'
@@ -61,22 +63,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 +106,7 @@ class WebRI
 
   def repl_plain # Read-evaluate-print loop, without Reline.
     while true
-        $stdout.write(PROMPT)
+      $stdout.write(WebRI.prompt)
       $stdout.flush
       response = $stdin.gets.chomp
       exit if response == 'exit'
@@ -126,7 +134,7 @@ class WebRI
       Reline.completion_proc = proc { |word|
         completion_words
       }
-      while line = Reline.readline(PROMPT, true)
+      while line = Reline.readline(WebRI.prompt, true)
         case line.chomp
         when 'exit'
           exit 0
@@ -191,6 +199,7 @@ class WebRI
     @noop = options[:noop]
     @info = options[:info]
     @noreline = options[:noreline]
+    @release_name = options[:release_name]
   end
 
   class Entry
@@ -418,7 +427,8 @@ class WebRI
     until range.include?(index)
       choices.each_with_index do |choice, i|
         s = "%6d" % i
-        puts "  #{s}:  #{choice}"
+        token = WebRI.token(choice)
+        puts "  #{s}:  #{token}"
       end
       while true
         message = if required
@@ -528,30 +538,136 @@ class WebRI
   end
 
   def help(response)
-    if response == '?'
-      puts <<HELP
+    puts WebRI::HELP
+    return
+    puts <<HELP
 Type:
-  - 'exit' to exit webri.
+  - #{WebRI.tokenq('exit')} to exit #{WebRI.webri}.
   - #{CLASS.capitalize} name (full or partial) to see #{CLASS} names:
-      - 'Array' (full name, not the start of other names).
-      - 'Ar' (partial name).
+      - #{WebRI.tokenq('Array')} (full name, not the start of other names).
+      - #{WebRI.tokenq('Ar')} (partial name).
   - #{SINGLETON.capitalize} name (full or partial) to see #{SINGLETON} names:
-      - '::tanh' (full name, not the start of other names).
-      - '::ta' (partial name).
+      - #{WebRI.tokenq('::tanh')} (full name, not the start of other names).
+      - #{WebRI.tokenq('::ta')} (partial name).
   - #{INSTANCE.capitalize} name (full or partial) to see #{INSTANCE} names:
-      - '#query=' (full name, not the start of other names).
-      - '#qu' (partial name).
+      - #{WebRI.tokenq('#query=')} (full name, not the start of other names).
+      - #{WebRI.tokenq('#qu')} (partial name).
   - #{FILE.capitalize}name (full or partial) to see #{FILE} names:
-      - 'ruby:syntax_rdoc' (full name, not the start of other names).
-      - 'ruby:syntax' (partial name).
+      - #{WebRI.tokenq('ruby:syntax_rdoc')} (full name, not the start of other names).
+      - #{WebRI.tokenq('ruby:syntax')} (partial name).
 HELP
-    else
-      p response
-    end
   end
 
   def help_main
 
   end
 
+  ANSI_COLOR = {
+    black: 30,
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34,
+    magenta: 35,
+    cyan: 36,
+    white: 37,
+    bright_black: 90,
+    bright_red: 91,
+    bright_green: 92,
+    bright_yellow: 93,
+    bright_blue: 94,
+    bright_magenta: 95,
+    bright_cyan: 96,
+    bright_white: 97,
+  }
+
+  def self.ansi_color(s, color)
+    return s unless $stdout.tty?
+    "\e[#{ANSI_COLOR[color]}m#{s}\e[0m"
+  end
+
+  def self.webri
+    self.ansi_color('webri', :blue)
+  end
+
+  def self.variable(s)
+    self.ansi_color(s, :yellow)
+  end
+
+  def self.string(s)
+    self.ansi_color("'#{s}'", :green)
+  end
+
+  def self.token(s)
+    color = case s
+            when /^[A-Z]/
+              :bright_blue
+            when /^::/
+              :bright_yellow
+            when /^#/
+              :bright_green
+            when /^ruby:/
+              :bright_red
+            else
+              :bright_cyan
+            end
+    self.ansi_color("#{s}", color)
+  end
+
+  def WebRI.tokenq(s)
+    "'" + WebRI.token("#{s}") + "'"
+  end
+
+  def self.file_name(s)
+    self.ansi_color("#{s}", :red)
+  end
+
+  def self.singleton_method_name(s)
+    self.ansi_color("#{s}", :magenta)
+  end
+
+  def self.instance_method_name(s)
+    self.ansi_color("#{s}", :cyan)
+  end
+
+  def self.class_name(s)
+    self.ansi_color("#{s}", :bright_blue)
+  end
+
+  HELP = <<EOT
+
+There are four types of #{WebRI.variable('name')}, as determined by prefixes:
+
+|------------------|----------------|--------------------|
+|       Type       |   Starts With  |      Example       |
+|------------------|----------------|--------------------|
+| Class/module     | Capital letter | #{WebRI.tokenq('Array')}          |
+| Singleton method | #{WebRI.tokenq('::')}           | #{WebRI.tokenq('::new')}            |
+| Instance method  | #{WebRI.tokenq('#')}            | #{WebRI.tokenq('#inspect')}         |
+| Ruby file        | #{WebRI.tokenq('ruby:')}        | #{WebRI.tokenq('ruby:syntax_rdoc')} |
+|------------------|----------------|--------------------|
+
+Note: On the command-line, the instance method prefix should be escaped as #{WebRI.string('\\#')} if your shell requires it.
+
+Name handling:
+
+- If #{WebRI.variable('name')} is exactly a name of its type (but not the beginning of other such names),
+  #{WebRI.webri} opens the page for that name.
+  Examples: #{WebRI.tokenq('Array')}, #{WebRI.tokenq('::trap')}, #{WebRI.tokenq('#xmlschema')}, #{WebRI.tokenq('ruby:syntax_rdoc')}. 
+- If #{WebRI.variable('name')} is the beginning of exactly one name of its type,
+  #{WebRI.webri} asks whether to open the page for that name.
+  Examples: #{WebRI.tokenq('Arra')}, #{WebRI.tokenq('::tra')}, #{WebRI.tokenq('#xmlschem')}, #{WebRI.tokenq('ruby:syntax_')}.
+- If #{WebRI.variable('name')} is the beginning of multiple names of its type,
+  #{WebRI.webri} displays those names and lets you choose.
+  Examples: #{WebRI.tokenq('A')}, #{WebRI.tokenq('::t')}, #{WebRI.tokenq('#')}, #{WebRI.tokenq('ruby:s')}.
+- If #{WebRI.variable('name')} is not a valid name of its type,
+  #{WebRI.webri} asks whether show such names.
+  Examples: #{WebRI.tokenq('Xyzzy')}, #{WebRI.tokenq('::xyzzy')}, #{WebRI.tokenq('#xyzzy')}, #{WebRI.tokenq('ruby:xyzzy')}.
+- If #{WebRI.variable('name')} is not valid at all (i.e., does not start with any of the prefixes above),
+  #{WebRI.webri} prints an error message.
+  Examples: #{WebRI.tokenq('nosuch')}, #{WebRI.tokenq('$foo')}, #{WebRI.tokenq('%Bar')}.
+
+EOT
+
+
 end

metadata

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