rfc-reader 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f626967d7919c641d14227967a9e863a2c4eaedfd5f97dc5ecde994349725cd5
-  data.tar.gz: 303d9bf3449ac2122f27f36f3053dfdbb7350b1f8900662517055aadfe8a6c42
+  metadata.gz: 9d0a782273a9c8f8accd5e24f7b526c7e12e03f870dec176fa7a48fc74650259
+  data.tar.gz: 7c682de619ec580ab71819c50913c609a422696bfb4b64d52b090688fba6773f
 SHA512:
-  metadata.gz: 1c29a80e008410ed0924921850c70ad84b8a8bf99e341725a6164757204db8469e7f4eab9c725e04557098251e9d22c23861eb1fbe9a0a9c1cd75603392d9aff
-  data.tar.gz: 3351a9b4447a38eabf3eb9ba5f0fd50415e9502af6db5fadd236ee1ab848ff57bde6b959b0a6ceaafb337387310f7ca656b9214b7ec063879df51daa275415f7
+  metadata.gz: a543898b48200f9f4f1e99a592ffdb903e83957bde3df0c8b8c91fee92f2690927309259524c4ee1eb126e33a79aa0b18ef0bcb463c4ef448a611b67321e69ff
+  data.tar.gz: f3e4c4d6f6ba2c4cd4aa5620c7801753c9e1fe4b29adb595014ee27e639e34b7ca37faea7fd79e8c2dc00c7952d60f224d087a85cdbc9e81e1d574c06ccb4c93

data/exe/rfc-reader

@@ -4,4 +4,4 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "rfc_reader"
 
-exit RfcReader::Command.start
+exit RfcReader.start

data/lib/rfc_reader/command.rb

@@ -49,10 +49,11 @@ module RfcReader
         warn "No search results for: #{term}"
         return FAILURE
       end
-      title = Terminal.choose("Choose an RFC to read:", search_results.keys)
-      url = search_results.fetch(title)
-      content = Library.download_document(title: title, url: url)
-      Terminal.page(content)
+      Terminal.choose("Choose an RFC to read:", search_results.keys) do |title|
+        url = search_results.fetch(title)
+        content = Library.download_document(title: title, url: url)
+        Terminal.page(content)
+      end
       SUCCESS
     end
 
@@ -70,10 +71,11 @@ module RfcReader
         warn "Error: Empty recent RFC list from rfc-editor.org RSS feed"
         return FAILURE
       end
-      title = Terminal.choose("Choose an RFC to read:", recent_results.keys)
-      url = recent_results.fetch(title)
-      content = Library.download_document(title: title, url: url)
-      Terminal.page(content)
+      Terminal.choose("Choose an RFC to read:", recent_results.keys) do |title|
+        url = recent_results.fetch(title)
+        content = Library.download_document(title: title, url: url)
+        Terminal.page(content)
+      end
       SUCCESS
     end
 
@@ -95,10 +97,11 @@ module RfcReader
         return FAILURE
       end
       all_titles = rfc_catalog.map { _1[:title] }
-      title = Terminal.choose("Choose an RFC to read:", all_titles)
-      rfc = rfc_catalog.find { _1[:title] == title }
-      content = Library.load_document(**rfc)
-      Terminal.page(content)
+      Terminal.choose("Choose an RFC to read:", all_titles) do |title|
+        rfc = rfc_catalog.find { _1[:title] == title }
+        content = Library.load_document(**rfc)
+        Terminal.page(content)
+      end
       SUCCESS
     end
 

data/lib/rfc_reader/error_context.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module RfcReader
+  module ErrorContext
+    class ContextError < StandardError
+      extend Forwardable
+
+      attr_reader :context
+
+      def_delegators :@cause, :message, :to_s, :backtrace, :backtrace_locations
+
+      # @param cause [StandardError]
+      # @param context [String] (Optional)
+      def initialize(cause:, context: nil)
+        @cause = cause
+        @context = context || default_context
+        super
+      end
+
+      def short_message
+        "Error: #{context}"
+      end
+
+      def full_message
+        <<~MESSAGE
+          Context:
+          #{indent(@context)}
+          Error:
+             #{@cause.class}
+          Message:
+          #{indent(message)}
+          Backtrace:
+          #{indent(backtrace)}
+        MESSAGE
+      end
+
+      private
+
+      def default_context
+        "#{@cause.class}: #{message.lines.first}"
+      end
+
+      def indent(string_or_array)
+        strings = case string_or_array
+                  when Array then string_or_array
+                  when String then string_or_array.lines
+                  else raise ArgumentError, "Expected string or array instead of #{string_or_array.class}"
+                  end
+
+        strings
+          .map { _1.prepend("   ") }
+          .join("\n")
+      end
+    end
+
+    # Yields an error context. Any `StandardError` that gets raised in this block
+    # gets wrapped by `ContextError` automatically and re-raised.
+    #
+    # If no error has been raised, it returns the result of the block.
+    #
+    # @param context [String]
+    # @return yielded block value
+    def self.wrap(context)
+      yield
+    rescue StandardError => e
+      raise ContextError.new(cause: e, context: context)
+    end
+
+    # Yields a handler context where any `StandardError` is caught and the error message is
+    # printed to stderr along with the context. It prints only a short message by default
+    # and prints the full error message if the `DEBUG` error message is set. It then exits
+    # with a non-zero error code.
+    #
+    # If no error has been raised, it returns the result of the block as an integer.
+    # If the result of block cannot be turned into an integer, it returns zero.
+    #
+    # @return [Integer] exit code
+    def self.handler
+      error = nil
+
+      begin
+        result = yield
+        return result.respond_to?(:to_i) ? result.to_i : 0
+      rescue ContextError => e
+        error = e
+      rescue StandardError => e
+        error = ContextError.new(cause: e)
+      end
+
+      if ENV["DEBUG"]
+        warn error.full_message
+      else
+        warn error.short_message
+        warn "Note: Set the `DEBUG` environment variable to see the full error context"
+      end
+
+      1
+    end
+  end
+end

data/lib/rfc_reader/library.rb

@@ -16,7 +16,10 @@ module RfcReader
       file_name = File.basename(url)
       file_path = File.join(library_cache_dir, file_name)
 
-      content = Net::HTTP.get(URI(url))
+      content = ErrorContext.wrap("Downloading RFC document") do
+        Net::HTTP.get(URI(url))
+      end
+
       FileUtils.mkdir_p(library_cache_dir)
       File.write(file_path, content)
       add_to_catalog(title: title, url: url, path: file_path)

data/lib/rfc_reader/recent.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "net/http"
-require "nokogiri"
+require "rss"
 
 module RfcReader
   module Recent
-    RECENT_RFCS_RSS_URI = URI("https://www.rfc-editor.org/rfcrss.xml").freeze
+    RECENT_RFCS_RSS_URI = URI("https://www.rfc-editor.org/rfcatom.xml").freeze
     private_constant :RECENT_RFCS_RSS_URI
 
     # @return [Hash<String, String>] from RFC title to text file url
@@ -16,7 +16,9 @@ module RfcReader
 
     # @return [String] the raw XML from the recent RFCs RSS feed
     def self.fetch
-      Net::HTTP.get(RECENT_RFCS_RSS_URI)
+      ErrorContext.wrap("Fetching the recent RFCs list") do
+        Net::HTTP.get(RECENT_RFCS_RSS_URI)
+      end
     end
 
     # Example: XML fragment we're trying to parse title and link data from.
@@ -36,18 +38,16 @@ module RfcReader
     # @param xml [String] the XML of the recent RFCs RSS endpoint
     # @return [Hash<String, String>] from RFC title to text file url
     def self.parse(xml)
-      Nokogiri::XML(xml).xpath("//item").to_h do |item|
-        item_hash = item.elements.to_h do |elem|
-          [elem.name, elem.text.strip]
-        end
+      ErrorContext.wrap("Parsing the recent RFCs list") do
+        RSS::Parser.parse(xml).items.to_h do |item|
+          # The link is to the webpage and not the plaintext document so we must convert it.
+          file_name = File.basename(item.link.href)
 
-        # The link is to the webpage and not the plaintext document so we must convert it.
-        file_name = File.basename(item_hash.fetch("link"))
-
-        [
-          item_hash.fetch("title"),
-          "https://www.rfc-editor.org/rfc/#{file_name}.txt",
-        ]
+          [
+            item.title.content,
+            "https://www.rfc-editor.org/rfc/#{file_name}.txt",
+          ]
+        end
       end
     end
   end

data/lib/rfc_reader/search.rb

@@ -18,7 +18,9 @@ module RfcReader
     # @param term [String]
     # @return [String] the raw HTML of the search results for the given term
     def self.fetch_by(term:)
-      Net::HTTP.post_form(RFC_SEARCH_URI, { combo_box: term }).body
+      ErrorContext.wrap("Fetching RFC search results") do
+        Net::HTTP.post_form(RFC_SEARCH_URI, { combo_box: term }).body
+      end
     end
 
     # Example: HTML fragment we're trying to parse title and link info from.
@@ -71,13 +73,23 @@ module RfcReader
     # @param html [String] the HTML of the search results
     # @return [Hash<String, String>] from RFC title to text file url
     def self.parse(html)
-      # NOTE: The first element in the table is just some general search information. See example HTML above.
-      Nokogiri::HTML(html).xpath("//div[@class='scrolltable']//table[@class='gridtable']//tr").drop(1).to_h do |tr_node|
-        td_nodes = tr_node.elements
-        title = td_nodes[2].text.strip
-        url = td_nodes[1].elements.map { _1.attribute("href").text.strip }.find { _1.end_with?(".txt") }
+      ErrorContext.wrap("Parsing RFC search results") do
+        # NOTE: The first element in the table is just some general search information. See example HTML above.
+        Nokogiri::HTML(html)
+          .xpath("//div[@class='scrolltable']//table[@class='gridtable']//tr")
+          .drop(1)
+          .to_h do |tr_node|
+            td_nodes = tr_node.elements
+            title = td_nodes[2]
+              .text
+              .strip
+            url = td_nodes[1]
+              .elements
+              .map { _1.attribute("href").text.strip }
+              .find { _1.end_with?(".txt") }
 
-        [title, url]
+            [title, url]
+          end
       end
     end
   end

data/lib/rfc_reader/terminal.rb

@@ -10,17 +10,75 @@ module RfcReader
 
     # @param prompt [String]
     # @param choices [Array<String>] where all choices are unique
-    def self.choose(prompt, choices)
-      require "tty-prompt"
-      TTY::Prompt
-        .new(
+    # @yield [String] yields until the user exits the prompt gracefully
+    def self.choose(message, choices)
+      while (choice = selector.select(message, choices))
+        yield choice
+      end
+    end
+
+    # @return [Selector]
+    def self.selector
+      @selector ||= Selector.new
+    end
+    private_class_method :selector
+
+    # Wrapper around `TTY::Prompt` that adds Vim keybindings and
+    # the ability to gracefully exit the prompt.
+    class Selector
+      def initialize
+        require "tty-prompt"
+        @prompt = TTY::Prompt.new(
           quiet: true,
           track_history: false,
           interrupt: :exit,
           symbols: { marker: ">" },
           enable_color: !ENV["NO_COLOR"]
         )
-        .select(prompt, choices)
+
+        # Indicate user intention to exit
+        @exit = false
+
+        # vim keybindings
+        @prompt.on(:keypress) do |event|
+          case event.value
+          when "j" # Move down
+            @prompt.trigger(:keydown)
+          when "k" # Move up
+            @prompt.trigger(:keyup)
+          when "h" # Move left
+            @prompt.trigger(:keyleft)
+          when "l" # Move right
+            @prompt.trigger(:keyright)
+          when "q" # Exit
+            @exit = true
+            @prompt.trigger(:keyenter)
+          end
+        end
+
+        # Exit on escape
+        @prompt.on(:keyescape) do
+          @exit = true
+          @prompt.trigger(:keyenter)
+        end
+      end
+
+      # @param prompt [String]
+      # @param choices [Array<String>] where all choices are unique
+      # @return [String|nil]
+      def select(message, choices)
+        choice = @prompt.select(
+          message,
+          choices,
+          per_page: 15,
+          help: "(Press Enter to select and Escape to leave)",
+          show_help: :always
+        )
+        choice unless @exit
+      ensure
+        @exit = false
+      end
     end
+    private_constant :Selector
   end
 end

data/lib/rfc_reader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RfcReader
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/rfc_reader.rb

@@ -8,4 +8,12 @@ module RfcReader
   autoload :Search, "rfc_reader/search"
   autoload :Terminal, "rfc_reader/terminal"
   autoload :Library, "rfc_reader/library"
+  autoload :ErrorContext, "rfc_reader/error_context"
+
+  # @return [Integer] exit code
+  def self.start
+    ErrorContext.handler do
+      Command.start
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rfc-reader
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Kevin Robell
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-28 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
-description:
 email:
 - apainintheneck@gmail.com
 executables:
@@ -77,6 +89,7 @@ files:
 - exe/rfc-reader
 - lib/rfc_reader.rb
 - lib/rfc_reader/command.rb
+- lib/rfc_reader/error_context.rb
 - lib/rfc_reader/library.rb
 - lib/rfc_reader/recent.rb
 - lib/rfc_reader/search.rb
@@ -90,7 +103,6 @@ metadata:
   source_code_uri: https://github.com/apainintheneck/rfc-reader/
   changelog_uri: https://github.com/apainintheneck/rfc-reader/blob/main/CHANELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Search for and read RFCs at the command line.
 test_files: []