kramdown-rfc2629 1.7.12 → 1.7.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a02556065093c31f3e45dd93a7497bd94a08e304d8eb00a409d2ee15da28987c
-  data.tar.gz: 8bb1dd4ea40f37625497b6742fa0c8822620c9a237e773ed1d2f6797e47269ba
+  metadata.gz: 37a6e52b1686d310bf22c8c2530ce893e3ea30b74675b6cdd17143c141a51321
+  data.tar.gz: f9cedeb1b71146d4be4affd7ba343c1a2a497b607e82565b772445d7fc686c06
 SHA512:
-  metadata.gz: bd31dc90ac74e3f080491ef7df46814f90b7f60d801547598c8e4086215462280fa78e58c01b25b28c26753fb5021025828c768bbb8a792db67c494d398f05e7
-  data.tar.gz: 917ebce9132621c9117160273cdab943cf1ec947cc632f320557c0cdb18dbcc01c1c9ead0e79c3a254671d34eb3c4cf91f4fdc6578b0bd6c7454348cb3999a48
+  metadata.gz: 92fc3fc628cbcc21b0368f692f078206caa01fa8d5eb8f712777f369632f1d472efa20c0af96cd71a0e0e2752449d1efbeb2c354973fca4f740722545811b213
+  data.tar.gz: 924dc4cd075193b1cc9310ddee259290e5bd0026a5ccbb7ff2da65ea897ec3a6560e2fccbaee5122cacaa262ac9d4b692bfb14417359b6f39dfbdb8aaea7b340

data/README.md

@@ -12,6 +12,11 @@ Who would care?  Anybody who is writing Internet-Drafts and RFCs in
 the [IETF][] and prefers (or has co-authors who prefer) to do part of
 their work in markdown.
 
+kramdown-rfc is documented on this page, and also on
+[the wiki][].
+
+[the wiki]: https://github.com/cabo/kramdown-rfc/wiki
+
 # Usage
 
 Start by installing the kramdown-rfc gem (this automatically

data/bin/kramdown-rfc-lsr

@@ -1,6 +1,13 @@
 #!/usr/bin/env ruby -KU
 # frozen_string_literal: true
-require 'rexml/document'        # for SVG and bibxml acrobatics
+
+# List Section References from a RFCXML document
+#
+# (PoC, in urgent need of refactoring)
+# Requires xml2rfc and tidy commands in path
+# Use without open-uri-cached is untested
+
+require 'rexml/document'
 require 'yaml'
 require 'json'
 require 'shellwords'
@@ -91,13 +98,21 @@ def series_info_to_name(si)
   end
 end
 
-def section_number_to_pn(s)
+def section_number_to_pn_candidates(s)
   if /^[0-9]/ =~ s
-    "section-#{s}"
+    ["section-#{s}"]
   elsif /[.]/ =~ s
-    "section-#{s.downcase}"
+    ["section-#{s.downcase}", "section-appendix.#{s.downcase}"]
   else
-    "section-appendix.#{s.downcase}"
+    ["section-appendix.#{s.downcase}"]
+  end
+end
+
+def section_number_to_htmlid(s)
+  if /^[0-9]/ =~ s
+    "section-#{s}"
+  else
+    "appendix-#{s.upcase}"
   end
 end
 
@@ -109,7 +124,10 @@ references = Hash[REXML::XPath.match(doc.root, "//reference").map {|r|
                     [r[:anchor], si ? [si, sn] : nil]
 }]                              # XXX duplicates?
 
-puts "# #{xmlsource}"
+heading1 = "# #{xmlsource}"
+title = REXML::XPath.first(doc.root, "//title")
+heading1 << "\n(#{title.all_text})" if title
+puts heading1
 
 per_reference = Hash.new { |h, k| h[k] = Set[]}
 
@@ -130,7 +148,44 @@ def error_out(s)
   $exit_code = 1
 end
 
-per_reference.keys.sort.each do |trg|
+def num_expand(s)
+  s.gsub(/\d+/) {|n| "%09d" % n.to_i}
+end
+
+require 'open3'
+
+module OpenURI
+  class << self
+    def prepped(uri, *rest)
+      newuri = uri.to_s.sub(/\.xml$/, ".prepped.xml")
+      response = Cache.get(newuri) || (
+        unprepped = open_uri(uri, *rest).read
+        fn = [OpenURI::Cache.cache_path, uri.sub(/.*\//, '')].join('/')
+        File.open(fn, 'wb'){|f| f.write unprepped }
+        _prep_out, s = Open3.capture2("xml2rfc", "--prep", fn)
+        fail s.inspect unless s.success?
+        new_fn = fn.sub(/\.xml$/, ".prepped.xml")
+        Cache.set(newuri, File.open(new_fn))
+      )
+      response
+    end
+    def tidied(uri, *rest)
+      newuri = uri.to_s.sub(/\.html$/, ".tidied.html")
+      response = Cache.get(newuri) || (
+        unprepped = open_uri(uri, *rest).read
+        fn = [OpenURI::Cache.cache_path, uri.sub(/.*\//, '')].join('/')
+        File.open(fn, 'wb'){|f| f.write unprepped }
+        _prep_out, s = Open3.capture2("tidy", "-mq", "-asxml", "-f", "/dev/null", fn)
+        fail s.inspect unless s.exited?
+        Cache.set(newuri, File.open(fn))
+      )
+      response
+    end
+  end
+end
+
+# go through section-referenced documents in sequence
+per_reference.keys.sort_by {|x| num_expand(x)}.each do |trg|
   uri, sname = references[trg]
   add = +''
   if sname != trg
@@ -139,46 +194,75 @@ per_reference.keys.sort.each do |trg|
   begin
     ref = URI(uri).open.read
     refdoc = REXML::Document.new(ref)
+    if REXML::XPath.match(refdoc.root, "/rfc/front/abstract[@pn]").size == 0
+      ref = OpenURI.prepped(uri).read
+      refdoc = REXML::Document.new(ref)
+      add << " [+prep]"
+    end
     add << " (#{REXML::XPath.match(refdoc.root, "//title").first.all_text})"
   rescue OpenURI::HTTPError => e
     begin
-      refjson = URI(uri.sub(/\.xml$/, ".json")).open.read
+      jsonuri = uri.sub(/\.xml$/, ".json")
+      refjson = URI(jsonuri).open.read
       refdata = JSON.load(refjson)
-      add << " (#{refdata["title"]})"
-    rescue Exception => e
+      add << " (#{refdata["title"].strip})"
+    rescue OpenURI::HTTPError => e
       add << " [No XML or JSON]"
+    rescue Exception => e
+      warn "*** error getting #{jsonuri.inspect}: #{e}"
     end
   rescue Exception => e
     warn "*** error getting #{uri.inspect}: #{e}"
   end
   puts "\n## #{trg}#{add}"
-  per_reference[trg].to_a.sort.each do |s| # XXX numerically
-    secterm = if /^[0-9]/ =~ s
-                "Section"
-              else
-                "Appendix"
-              end
+  unless refdoc
+    begin
+      htmluri = uri.sub(/\.xml$/, ".html")
+      refhtml = OpenURI.tidied(htmluri).read
+      refhtmldoc = REXML::Document.new(refhtml)
+    rescue Exception => e
+      warn "*** error tidying up HTML for #{htmluri.inspect}: #{e}"
+    end
+  end
+  # go through individual section references in sequence
+  per_reference[trg].to_a.sort_by {|x| num_expand(x)}.each do |s|
     add = +''
-    if refdoc
-      # find section name from anchor s
-      # secname = "DUMMY" # REXML::XPath.match(refdoc.root, "//section").first.all_text
-      secpn = section_number_to_pn(s)
-      secs = REXML::XPath.match(refdoc.root, "//section[@pn=$pn]", {}, {"pn" => secpn})
-      secname = nil
-      case secs.size
-      when 0
-        error_out "*** cannot match #{secpn} in #{trg}"
-        secname = "*** DOESN'T EXIST ***"
-      when 1
-        sec = secs.first
-        secname = sec[:title] || sec.elements["name"].all_text
-      else
-        error_out "*** multiple matches for #{secpn} in #{trg}"
-        secname = "*** MULTIPLE MATCHES ***"
-      end
-      add << " (#{secname})"
+    if refdoc      # find section name in XML from anchor s
+      secpn = section_number_to_pn_candidates(s)
+      secs = secpn.flat_map{ |c|
+        REXML::XPath.match(refdoc.root, "//section[@pn=$pn]",
+                           {}, {"pn" => c})}
+      what = "#{secpn.join(" or ")} in #{trg}"
+      add << " (#{case secs.size
+                  when 0
+                    error_out "*** cannot match #{what}"
+                    "*** DOESN'T EXIST ***"
+                  when 1
+                    sec = secs.first
+                    sec[:title] || sec.elements["name"].all_text
+                  else
+                    error_out "*** multiple matches for #{what}"
+                    "*** MULTIPLE MATCHES ***"
+                  end})"
+    elsif refhtmldoc      # find section name in HTML from anchor s
+      secpn = section_number_to_htmlid(s)
+      secs = REXML::XPath.match(refhtmldoc.root,
+                                "//xmlns:a[@id=$pn]/ancestor::xmlns:span",
+                                {"xmlns" => "http://www.w3.org/1999/xhtml"},
+                                {"pn" => secpn})
+      what = "#{secpn} in #{trg}"
+      add << " (#{case secs.size
+                  when 0
+                    error_out "*** cannot match #{what}"
+                    "*** DOESN'T EXIST ***"
+                  when 1
+                    secs.first.text.sub(/^\.\s+/, '')
+                  else
+                    error_out "*** multiple matches for #{what}"
+                    "*** MULTIPLE MATCHES ***"
+                  end})"
     end
-    puts "* #{secterm} #{s}#{add}"
+    puts "* #{/^[0-9]/ =~ s ? "Section" : "Appendix"} #{s}#{add}"
   end
 end
 

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.7.12'
+  s.version = '1.7.13'
   s.summary = "Kramdown extension for generating RFCXML (RFC 799x)."
   s.description = %{An RFCXML (RFC 799x) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.12
+  version: 1.7.13
 platform: ruby
 authors:
 - Carsten Bormann