kramdown-rfc2629 1.7.11 → 1.7.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65eafab5401726cc8bc76b674b42e783436d603b4c3b5080ba0d374f953905f8
-  data.tar.gz: 64dd363a024b30944017274f1e2765e145e6596af7e337627189019e22f4c9ed
+  metadata.gz: 37a6e52b1686d310bf22c8c2530ce893e3ea30b74675b6cdd17143c141a51321
+  data.tar.gz: f9cedeb1b71146d4be4affd7ba343c1a2a497b607e82565b772445d7fc686c06
 SHA512:
-  metadata.gz: 0dd35229efeddba497fdc091b262f2f90e200b798f873b42394dd65dd037ea1c4d2620aaa6740c59f32e8e5ba65eb3f352f58a56e4e89121fb1d6159aec76386
-  data.tar.gz: 1789e1772da25692d7f9e7706d537927e4e09ec03cba97037f12bdd6b9fbf8caebc848cb0ddac292da42b02aa1321d54ee7b94176b17272ff08aa23163aeef41
+  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

@@ -0,0 +1,269 @@
+#!/usr/bin/env ruby -KU
+# frozen_string_literal: true
+
+# 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'
+require 'fileutils'
+begin
+  require 'open-uri/cached'
+rescue LoadError
+  warn '*** please "gem install open-uri-cached" to enable caching'
+  require 'open-uri'
+end
+require_relative '../lib/kramdown-rfc/rexml-all-text.rb'
+
+target = :shortname
+require 'optparse'
+begin
+  op = OptionParser.new do |opts|
+    opts.banner = "Usage: kramdown-rfc-lsr [options] xml-source"
+    opts.on("-u", "--url", "Source is URL") do |v|
+      target = :url
+    end
+    opts.on("-s", "--shortname", "Source is shortname (default)") do |v|
+      target = :shortname
+    end
+    opts.on("-f", "--file", "Source is filename") do |v|
+      target = :file
+    end
+  end
+  op.parse!
+rescue Exception => e
+  warn e
+  exit 1
+end
+
+$exit_code = 0
+
+if target != :file && ARGV.size != 1
+  puts op
+  exit 1
+end
+xmlsource = ARGV[0]
+if target == :shortname
+  xmlsource = case xmlsource
+              when /^(?:rfc)?(\d+)$/i
+                "https://www.rfc-editor.org/rfc/rfc#{$1.to_i.to_s}.xml"
+              when /^(?:draft-|I-D.|)(.*-\d\d)$/
+                "https://www.ietf.org/archive/id/draft-#$1.xml"
+              # XXX find xml source for most recent version!
+              else
+                warn "*** Can't parse shortname #{xmlsource.inspect}"
+                puts op
+                exit 1
+              end
+  target = :url
+end
+
+begin
+  xml = case target
+        when :file
+          ARGF.read
+        when :url
+          URI(xmlsource).open.read
+        else
+          fail
+        end
+rescue Exception => e
+  warn "#{xmlsource.inspect}: #{e}"
+  exit 1
+end
+
+doc = REXML::Document.new(xml)
+
+def series_info_to_URI(si)
+  case si[:name]
+  when "RFC"
+    "https://www.rfc-editor.org/rfc/rfc#{si[:value]}.xml"
+  when "Internet-Draft"
+    "https://www.ietf.org/archive/id/#{si[:value]}.xml"
+  end
+end
+
+
+def series_info_to_name(si)
+  case si[:name]
+  when "RFC"
+    "RFC#{si[:value]}"
+  when "Internet-Draft"
+    si[:value]
+  end
+end
+
+def section_number_to_pn_candidates(s)
+  if /^[0-9]/ =~ s
+    ["section-#{s}"]
+  elsif /[.]/ =~ s
+    ["section-#{s.downcase}", "section-appendix.#{s.downcase}"]
+  else
+    ["section-appendix.#{s.downcase}"]
+  end
+end
+
+def section_number_to_htmlid(s)
+  if /^[0-9]/ =~ s
+    "section-#{s}"
+  else
+    "appendix-#{s.upcase}"
+  end
+end
+
+references = Hash[REXML::XPath.match(doc.root, "//reference").map {|r|
+                    si = REXML::XPath.match(r, "seriesInfo").map {|s|
+                      series_info_to_URI(s)}.compact.first
+                    sn = REXML::XPath.match(r, "seriesInfo").map {|s|
+                      series_info_to_name(s)}.compact.first
+                    [r[:anchor], si ? [si, sn] : nil]
+}]                              # XXX duplicates?
+
+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[]}
+
+REXML::XPath.each(doc.root, "//xref[@section]") do |x|
+  trg = x[:target]
+  if x[:relative]
+    puts "\n## #{x[:target]}#{x[:relative]}: #{x[:section]}"
+  else
+    # p x
+    per_reference[trg] << x[:section]
+  end
+end
+
+def error_out(s)
+  warn ""
+  warn s
+  warn ""
+  $exit_code = 1
+end
+
+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
+    add << " [#{sname}]"
+  end
+  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
+      jsonuri = uri.sub(/\.xml$/, ".json")
+      refjson = URI(jsonuri).open.read
+      refdata = JSON.load(refjson)
+      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}"
+  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 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 "* #{/^[0-9]/ =~ s ? "Section" : "Appendix"} #{s}#{add}"
+  end
+end
+
+exit $exit_code

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.7.11'
+  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.}
@@ -13,11 +13,12 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('unicode-scripts', '~> 1.0')
   s.add_dependency('net-http-persistent', '~> 4.0')
   s.add_dependency('differ', '~>0.1')
-  s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc bin/kramdown-rfc2629 bin/doilit bin/echars bin/kramdown-rfc-extract-markdown bin/kramdown-rfc-extract-sourcecode data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json bin/kramdown-rfc-cache-subseries-bibxml bin/kramdown-rfc-autolink-iref-cleanup bin/de-gfm bin/kramdown-rfc-clean-svg-ids)
+  s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc bin/kramdown-rfc2629 bin/doilit bin/echars bin/kramdown-rfc-extract-markdown bin/kramdown-rfc-extract-sourcecode bin/kramdown-rfc-lsr data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json bin/kramdown-rfc-cache-subseries-bibxml bin/kramdown-rfc-autolink-iref-cleanup bin/de-gfm bin/kramdown-rfc-clean-svg-ids)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc', 'kramdown-rfc2629', 'doilit', 'echars',
                    'kramdown-rfc-extract-markdown',
                    'kramdown-rfc-extract-sourcecode',
+                   'kramdown-rfc-lsr',
                    'kdrfc', 'kramdown-rfc-cache-i-d-bibxml',
                    'kramdown-rfc-cache-subseries-bibxml',
                    'kramdown-rfc-autolink-iref-cleanup',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.11
+  version: 1.7.13
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -147,6 +147,7 @@ executables:
 - echars
 - kramdown-rfc-extract-markdown
 - kramdown-rfc-extract-sourcecode
+- kramdown-rfc-lsr
 - kdrfc
 - kramdown-rfc-cache-i-d-bibxml
 - kramdown-rfc-cache-subseries-bibxml
@@ -169,6 +170,7 @@ files:
 - bin/kramdown-rfc-clean-svg-ids
 - bin/kramdown-rfc-extract-markdown
 - bin/kramdown-rfc-extract-sourcecode
+- bin/kramdown-rfc-lsr
 - bin/kramdown-rfc2629
 - data/encoding-fallbacks.txt
 - data/kramdown-rfc2629.erb
@@ -206,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFCXML (RFC 799x).