rfc-reader 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7f0a4142e7e5cb5b1ed4b8a5ecda4728177df15e6f9c8d7e84dcc557b660e4
-  data.tar.gz: 89e7ac7472c84e84d87feed86e66f35f14dbc65a7af39e6a55fe65e158b78e89
+  metadata.gz: 9d0a782273a9c8f8accd5e24f7b526c7e12e03f870dec176fa7a48fc74650259
+  data.tar.gz: 7c682de619ec580ab71819c50913c609a422696bfb4b64d52b090688fba6773f
 SHA512:
-  metadata.gz: 0b0588ecb6c225fa8d2ef6c1c27506dda70d59ae2af050797f6ed71536a379423848570022223b04f0911ca3d987431d2b28ab4c019c8c74c31ece1fed3e037a
-  data.tar.gz: 51e9100f05269801e8fcbbe879405181ae0d3910e42593d5a9ad5933d6d8f3f45214cc8a8827d809b75e920029ccfd7584139c707e6a9e3fe0ec12ca750c4f77
+  metadata.gz: a543898b48200f9f4f1e99a592ffdb903e83957bde3df0c8b8c91fee92f2690927309259524c4ee1eb126e33a79aa0b18ef0bcb463c4ef448a611b67321e69ff
+  data.tar.gz: f3e4c4d6f6ba2c4cd4aa5620c7801753c9e1fe4b29adb595014ee27e639e34b7ca37faea7fd79e8c2dc00c7952d60f224d087a85cdbc9e81e1d574c06ccb4c93

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/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
@@ -39,16 +39,12 @@ module RfcReader
     # @return [Hash<String, String>] from RFC title to text file url
     def self.parse(xml)
       ErrorContext.wrap("Parsing the recent RFCs list") do
-        Nokogiri::XML(xml).xpath("//item").to_h do |item|
-          item_hash = item.elements.to_h do |elem|
-            [elem.name, elem.text.strip]
-          end
-
+        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_hash.fetch("link"))
+          file_name = File.basename(item.link.href)
 
           [
-            item_hash.fetch("title"),
+            item.title.content,
             "https://www.rfc-editor.org/rfc/#{file_name}.txt",
           ]
         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.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rfc-reader
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Kevin Robell
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-06 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:
@@ -91,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
@@ -106,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: []