kramdown-rfc2629 1.4.2 → 1.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec107f9381d395a6a6000d553ed820c673ed113d4d7f652f16dfef98aebda64
-  data.tar.gz: 01ccac9bef6597540b689ae5a31600509d18adb489d56dc833940626397df7b0
+  metadata.gz: 92b7379a1d7172926d1d84ccdc5c816821a0c62c838b597dbc4e92cac91cff0d
+  data.tar.gz: b501c48e3ff1bddaca7abec20125dc360de97f67076341d2b9812a3913cbf314
 SHA512:
-  metadata.gz: d926cdd5b45667c0e70bf6c00485795e97993b64f022199443a03c48ad3edca2078657274302dd93ed657bff0fd1d703dfe951981bfdb3d81ac4c86c033ef759
-  data.tar.gz: 21c2a803dd8203d23f0633e0ac9d254b857c4e84af378f63ae1160d48612d58b556b425c26f83e6fe211315d1e2ee3e9b520bab33fa5ecb3bfcdd33e10dddd1f
+  metadata.gz: 3ae6bd5ad655d1300c426b06b00c92a7f56c15636b990d3d0ee02e2cc2a0481a7900d002e6076baa467aa2b3dc309719bedff0fd9e85912f083e85b0a9ef332c
+  data.tar.gz: c5cce63d97840efc638bd14240f6652955bb291c46cc038426bb8209c2b65725c14ee3db850954e8ba1bf5f23781f44d388c5d9984be38a4a0f55e63eaef6b1f

data/README.md

@@ -616,7 +616,7 @@ Other human-oriented markup input languages that are being used for authoring RF
 Since kramdown version 1.0, kramdown itself is MIT licensed, which
 made it possible to license kramdown-rfc2629 under the same license.
 
-[kramdown]: http://kramdown.rubyforge.org/
+[kramdown]: https://kramdown.gettalong.org
 [kdsyntax]: http://kramdown.gettalong.org/syntax.html
 [kdsyntax-ial]: http://kramdown.gettalong.org/syntax.html#inline-attribute-lists
 [stupid]: http://tools.ietf.org/id/draft-hartke-xmpp-stupid-00

data/bin/doilit

@@ -75,7 +75,11 @@ ARGV.each do |doi|
   if (ct = cite["container-title"]) && ct != []
     info = []
     if v = cite["volume"]
-      info << "Vol. #{v}"
+      vi = "vol. #{v}"
+      if (v = cite["journal-issue"]) && (issue = v["issue"])
+        vi << ", no. #{issue}"
+      end
+      info << vi
     end
     if p = cite["page"]
       info << "pp. #{p}"

data/bin/kramdown-rfc-cache-subseries-bibxml

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+# prerequisite:
+# gem install net-http-persistent
+#
+# generates referencegroup files for BCP and STD series (like bibxml9)
+# unfortunately, needs to re-fetch rfc-index.xml
+# uses pretty slow built-in XML parser, so it will take a while even on regen
+#
+# uses ENV["KRAMDOWN_REFCACHEDIR"] for where you want to have your bibxml9 data
+#
+
+require 'rexml/document'
+require 'fileutils'
+
+begin
+  require 'net/http/persistent'
+rescue
+  warn "*** please install net-http-persistent:"
+  warn "   gem install net-http-persistent"
+  warn "(prefix by sudo only if required)."
+  exit 72                       # EX_OSFILE
+end
+
+
+TARGET_DIR = ENV["KRAMDOWN_REFCACHEDIR"] || (
+  path = File.expand_path("~/.cache/xml2rfc")
+  warn "*** set environment variable KRAMDOWN_REFCACHEDIR to #{path} to actually use the cache"
+  path
+)
+
+FileUtils.mkdir_p(TARGET_DIR)
+FileUtils.chdir(TARGET_DIR)
+
+$http = Net::HTTP::Persistent.new name: 'subseries'
+
+KRAMDOWN_PERSISTENT_VERBOSE = true
+
+      def get_and_write_resource_persistently(url, fn, age_verbose=false)
+        t1 = Time.now
+        response = $http.request(URI(url))
+        if response.code != "200"
+          raise "*** Status code #{response.code} while fetching #{url}"
+        else
+          File.write(fn, response.body)
+        end
+        t2 = Time.now
+        warn "#{url} -> #{fn} (#{"%.3f" % (t2 - t1)} s)" if KRAMDOWN_PERSISTENT_VERBOSE
+        if age_verbose
+          if age = response.get_fields("age")
+            warn "(working from a web cache, index is #{age.first} seconds stale)"
+          end
+        end
+      end
+
+CLEAR_RET = "\e[K\r" # XXX all the world is ECMA-48 (ISO 6429), no?
+
+      def noisy(name)
+        print "#{name}...#{CLEAR_RET}"
+      end
+      def clear_noise
+        print CLEAR_RET
+      end
+
+def normalize_name(n)
+  n.sub(/([A-Z])0+/) {$1}
+end
+
+def regress_name(n)
+  n.sub(/([A-Z])(\d+)/) {"#$1#{"%04d" % $2.to_i}"}
+end
+
+def regress_name_dot(n)
+  n.sub(/([A-Z])(\d+)/) {"#$1.#{"%04d" % $2.to_i}"}
+end
+
+def get_ref(rfcname)
+  name = "reference.#{regress_name_dot(rfcname)}.xml"
+  begin
+    file = File.read(name)      # no age check
+  rescue Errno::ENOENT
+    get_and_write_resource_persistently("https://www.rfc-editor.org/refs/bibxml/" << name, name)
+    file = File.read(name)
+  end
+  d = REXML::Document.new(file)
+  d.xml_decl.nowrite
+  "<!-- #{name} -->\n" << d.to_s.lstrip
+end
+
+def create_bib(series, subname, rfcnames)
+  p [series, subname, rfcnames]
+  subname_norm = normalize_name(subname)
+  refs = %{<?xml version='1.0' encoding='UTF-8'?>\n}
+  refs << %{<referencegroup anchor='#{subname_norm}' target='https://www.rfc-editor.org/info/#{subname_norm.downcase}'>\n}
+  refs << rfcnames.map {|x| get_ref(x)}.join
+  refs << "</referencegroup>\n"
+  File.write("reference.#{regress_name_dot(subname)}.xml", refs)
+end
+
+def handle_sub(series, entry)
+  ids = entry.get_elements("doc-id")
+  warn "** ids #{ids} #{entry}" unless ids.size == 1
+  subname = ids.first.text
+  isalso = entry.get_elements("is-also")
+  if isalso.size == 1
+    rfcs = isalso.first.get_elements("doc-id")
+    if rfcs.size > 0
+      rfcnames = rfcs.map {|r| r.text}
+      create_bib(series, subname, rfcnames)
+    end
+  end
+end
+
+RFCINDEX_SOURCE = "https://www.rfc-editor.org/rfc/rfc-index.xml"
+RFCINDEX_COPY = File.basename(RFCINDEX_SOURCE)
+
+get_and_write_resource_persistently(RFCINDEX_SOURCE, RFCINDEX_COPY, true) unless ENV["KRAMDOWN_DONT_REFRESH_RFCINDEX"]
+
+doc = REXML::Document.new(File.read(RFCINDEX_COPY))
+REXML::XPath.each(doc.root, "/rfc-index/bcp-entry") { |e| handle_sub("BCP", e) }
+REXML::XPath.each(doc.root, "/rfc-index/std-entry") { |e| handle_sub("STD", e) }

data/bin/kramdown-rfc2629

@@ -14,7 +14,7 @@ Encoding.default_external = "UTF-8" # wake up, smell the coffee
 
 def boilerplate(key)
   case key.downcase
-  when /\Abcp14(\+)?\z/i
+  when /\Abcp14(\+)?(-tagged)?\z/i
     ret = <<RFC8174
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
@@ -28,6 +28,26 @@ These words may also appear in this document in
 lower case as plain English words, absent their normative meanings.
 PLUS
     end
+    if $2
+      if $options.v3
+        ret << <<TAGGED
+
+*[MUST]: <bcp14>
+*[MUST NOT]: <bcp14>
+*[REQUIRED]: <bcp14>
+*[SHALL]: <bcp14>
+*[SHALL NOT]: <bcp14>
+*[SHOULD]: <bcp14>
+*[SHOULD NOT]: <bcp14>
+*[RECOMMENDED]: <bcp14>
+*[NOT RECOMMENDED]: <bcp14>
+*[MAY]: <bcp14>
+*[OPTIONAL]: <bcp14>
+TAGGED
+      else
+        warn "** need --v3 to tag bcp14"
+      end
+    end
     ret
   else
     warn "** Unknwon boilerplate key: #{key}"
@@ -249,6 +269,10 @@ def bibtagsys(bib, anchor=nil, stand_alone=true)
     rfc4d = "%04d" % $1.to_i
     [bib.upcase,
      "#{XML_RESOURCE_ORG_PREFIX}/bibxml/reference.RFC.#{rfc4d}.xml"]
+  elsif $options.v3 && bib =~ /\A(bcp|std)(\d+)/i
+    n4d = "%04d" % $2.to_i
+    [bib.upcase,
+     "#{XML_RESOURCE_ORG_PREFIX}/bibxml-rfcsubseries-new/reference.#{$1.upcase}.#{n4d}.xml"]
   elsif bib =~ /\A([-A-Z0-9]+)\./ &&
         (xro = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_MAP[$1])
     dir, _ttl, rewrite_anchor = xro

data/data/encoding-fallbacks.txt

@@ -1,3 +1,4 @@
+00a0  
 00a1 !
 00a2 [cents]
 00a3 GBP

data/data/kramdown-rfc2629.erb

@@ -100,7 +100,7 @@
         <name>Contributors</name>
 <%   else -%>
     <section anchor="contributors" numbered="false" title="Contributors">
-<%     warn "*** Cannot process YAML contributors under V2 rules" if consec -%>
+<%     warn "*** To use YAML contributors, use --v3 (kdrfc -3)" if consec -%>
 <%   end -%>
 <%= sh -%>
 <% if $options.v3 && consec

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.4.2'
+  s.version = '1.4.7'
   s.summary = "Kramdown extension for generating RFC 7749 XML."
   s.description = %{An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}
@@ -10,7 +10,8 @@ spec = Gem::Specification.new do |s|
   s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc2629 bin/doilit bin/kramdown-rfc-extract-markdown data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc2629', 'doilit', 'kramdown-rfc-extract-markdown',
-                   'kdrfc', 'kramdown-rfc-cache-i-d-bibxml']
+                   'kdrfc', 'kramdown-rfc-cache-i-d-bibxml',
+                   'kramdown-rfc-cache-subseries-bibxml']
   s.required_ruby_version = '>= 2.3.0'
   # s.requirements = 'wget'
   #  s.has_rdoc = true

data/lib/kramdown-rfc/refxml.rb

@@ -32,6 +32,7 @@ module KramdownRFC
   <format type="<%=escattr(k)%>" target="<%=escattr(v)%>"/>
 <% end -%>
 <%= vps.ele("annotation=ann", nil, nil, true) -%>
+<%= vps.ele("refcontent=rc", nil, nil, true) -%>
 </reference>
     REFERB
     ret = erb.result(binding)

data/lib/kramdown-rfc2629.rb

@@ -102,10 +102,16 @@ module Kramdown
             when /\A(.*) \((#{SECTIONS_RE})\)\z/
               href = $1
               handle_bares($2, attr, "parens", href)
-            when /\A([\w.]+)<(.*)\z/
+            when /\A([\w.]+)<(.+)\z/
               href = $2
               attr['section'] = $1
               attr['sectionFormat'] = 'bare'
+            when /\A<<(.+)\z/
+              href = $1
+              attr['format'] = 'title'
+            when /\A<(.+)\z/
+              href = $1
+              attr['format'] = 'counter'
             end
           end
           href = href.gsub(/\A[0-9]/) { "_#{$&}" } # can't start an IDREF with a number
@@ -399,7 +405,7 @@ COLORS
         # warn ["goat:", result1.inspect]
         file.unlink
         result1 = svg_clean(result1) unless t == "goat"
-        result1, err, _s = Open3.capture3("svgcheck -NXqa", stdin_data: result1);
+        result1, err, _s = Open3.capture3("svgcheck -Xqa", stdin_data: result1);
         capture_croak("svgcheck", err)
         # warn ["svgcheck:", result1.inspect]
         if result1 == ''
@@ -827,13 +833,27 @@ COLORS
         end
       end
 
+      def self.bcp_std_ref(t, n)
+        warn "*** #{t} anchors not supported in v2 format" unless $options.v3
+        [name = "reference.#{t}.#{"%04d" % n.to_i}.xml",
+         "#{XML_RESOURCE_ORG_PREFIX}/bibxml-rfcsubseries-new/#{name}"] # FOR NOW
+      end
+
       # [subdirectory name, cache ttl in seconds, does it provide for ?anchor=]
       XML_RESOURCE_ORG_MAP = {
         "RFC" => ["bibxml", 86400*7, false,
-                  ->(fn, n){ "https://www.rfc-editor.org/refs/bibxml/#{fn}"}
+                  ->(fn, n){ [name = "reference.RFC.#{"%04d" % n.to_i}.xml",
+                              "https://www.rfc-editor.org/refs/bibxml/#{name}"] }
                  ],
         "I-D" => ["bibxml3", false, false,
-                  ->(fn, n){ "https://datatracker.ietf.org/doc/bibxml3/draft-#{n.sub(/\Adraft-/, '')}/xml" }
+                  ->(fn, n){ [fn,
+                              "https://datatracker.ietf.org/doc/bibxml3/draft-#{n.sub(/\Adraft-/, '')}/xml"] }
+                 ],
+        "BCP" => ["bibxml-rfcsubseries", 86400*7, false,
+                  ->(fn, n){ Rfc2629::bcp_std_ref("BCP", n) }
+                 ],
+        "STD" => ["bibxml-rfcsubseries", 86400*7, false,
+                  ->(fn, n){ Rfc2629::bcp_std_ref("STD", n) }
                  ],
         "W3C" => "bibxml4",
         "3GPP" => "bibxml5",
@@ -884,7 +904,7 @@ COLORS
             ttl ||= KRAMDOWN_REFCACHETTL  # everything but RFCs might change a lot
             puts "*** Huh: #{fn}" unless sub
             if altproc && !KRAMDOWN_USE_TOOLS_SERVER
-              url = altproc.call(fn, n)
+              fn, url = altproc.call(fn, n)
             else
               url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}"
             end
@@ -907,7 +927,7 @@ COLORS
                   }
                 else
                   REXML::XPath.each(d.root, "/reference/format") { |x|
-                    x.attributes["target"].sub!(%r{https?://www.ietf.org/internet-drafts/}, 
+                    x.attributes["target"].sub!(%r{https?://www.ietf.org/internet-drafts/},
                                                 %{https://www.ietf.org/archive/id/}) if t == "I-D"
                   }
                 end
@@ -1073,6 +1093,9 @@ COLORS
         title = nil if title.empty?
         value = el.value
         if item = title
+          if item == "<bcp14>" && $options.v3
+            return "<bcp14>#{el.value}</bcp14>"
+          end
           m = title.scan(Parser::RFC2629Kramdown::IREF_START)
           if m.empty?
             subitem = value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.7
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -62,6 +62,7 @@ executables:
 - kramdown-rfc-extract-markdown
 - kdrfc
 - kramdown-rfc-cache-i-d-bibxml
+- kramdown-rfc-cache-subseries-bibxml
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,6 +71,7 @@ files:
 - bin/doilit
 - bin/kdrfc
 - bin/kramdown-rfc-cache-i-d-bibxml
+- bin/kramdown-rfc-cache-subseries-bibxml
 - bin/kramdown-rfc-extract-markdown
 - bin/kramdown-rfc2629
 - data/encoding-fallbacks.txt
@@ -100,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.