kramdown-rfc2629 1.4.14.pre → 1.4.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae0eb8f4dd2fc504dae8740508bde5266b9e914780999977d1633d16537a1aa
-  data.tar.gz: f373cfb67d09360f2d79480acca773d3f8af0454e643600406e845a4ffb8072f
+  metadata.gz: e9d0ef4b91bf819df60d48b12c30be152eab6a987ba2d88a3572bde42e180925
+  data.tar.gz: '09603840027889929894dfc79170f6f7d16a0e932cfe7b6dfc4d2d2501eb7f7d'
 SHA512:
-  metadata.gz: 88e3ed1e8713e1cf2ba6ceb4dd3aff3b83ab3397339edc83a9230fab5a2ac716a133be9acfd22a0a9bde793e8fecb709976f04285bfd0ebb09dec3c005fd3a1a
-  data.tar.gz: 8fe774e5ee8ab20885472f2a30fe5c65aab4ea56d80f7e4e334af25a4997a927fca85afd289b78d9088273822385b5ab96f15b0536657b4775516acb62fb049e
+  metadata.gz: 35f806b212b3f6e321614752853dc73ed351f1119c208b7fd83cbd471e3d64e40145b3af19a999a2e2e403a1ff780c5b12baef21c6b44e7e4f4ed8e434610e17
+  data.tar.gz: cb0ddd23e2ced4bda22a095d08926dbbaf6f12a8605faf53289a422c8e1bd2b9d5a9a01a350d88c5843c12ff0a0be4098425403507771d5ba526126bc130bb7d

data/README.md

@@ -317,6 +317,10 @@ Note that this feature does not play well with the CI (continuous
 integration) support in Martin Thomson's [I-D Template][], as that may
 not have the tools installed in its docker instance.
 
+More details have been collected on the [wiki][svg].
+
+[svg]: https://github.com/cabo/kramdown-rfc2629/wiki/SVG
+
 (1.2.9:)
 The YAML header now allows specifying [kramdown_options][].
 
@@ -558,7 +562,7 @@ remaining 20 % some more, but that hasn't been done.
 
 If you have XML, there is an experimental upconverter that does 99 %
 of the work.  Please [contact the
-author](mailto:cabo@tzi.org?subject=Markdown for RFCXML) if you want
+author](mailto:cabo@tzi.org?subject=Markdown%20for%20RFCXML) if you want
 to try it.
 
 Actually, if the XML was generated by kramdown-rfc2629, you can simply

data/bin/kdrfc

@@ -6,13 +6,15 @@ require 'open3'
 # try to get this from gemspec.
 KDRFC_VERSION=Gem.loaded_specs["kramdown-rfc2629"].version rescue "unknown-version"
 
+KDRFC_PREPEND = [ENV["KDRFC_PREPEND"]].compact
+
 def v3_flag?
   $options.v3 ? ["--v3"] : []
 end
 
 def process_mkd(input, output)
   warn "* converting locally from markdown #{input} to xml #{output}" if $options.verbose
-  o, s = Open3.capture2("kramdown-rfc2629", *v3_flag?, input)
+  o, s = Open3.capture2(*KDRFC_PREPEND, "kramdown-rfc2629", *v3_flag?, input)
   if s.success?
     File.open(output, "w") do |fo|
       fo.print(o)
@@ -41,7 +43,7 @@ end
 def process_xml_locally(input, output, *flags)
   warn "* converting locally from xml #{input} to txt #{output}" if $options.verbose
   begin
-    o, s = Open3.capture2("xml2rfc", *v3_flag?, *flags, input)
+    o, s = Open3.capture2(*KDRFC_PREPEND, "xml2rfc", *v3_flag?, *flags, input)
     puts o
     if s.success?
       warn "* #{output} written" if $options.verbose
@@ -51,19 +53,37 @@ def process_xml_locally(input, output, *flags)
     end
   rescue Errno::ENOENT
     warn "*** falling back to remote processing" if $options.verbose
-    process_xml_remotely(input, output)
+    process_xml_remotely(input, output, *flags)
   end
 end
 
 XML2RFC_WEBSERVICE = ENV["KRAMDOWN_XML2RFC_WEBSERVICE"] ||
                      'http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc-dev.cgi'
 
+MODE_AS_FORMAT = {
+  nil => {                    # v2
+    "--text" => "txt/ascii",
+    "--html" => "html/ascii",
+  },
+  true => {                     # v3
+    "--text" => "txt/v3ascii",
+    "--html" => "html/v3ascii",
+    "--v2v3" => "v3xml/ascii",
+  }
+}
 
-def process_xml_remotely(input, output)
+def process_xml_remotely(input, output, *flags)
   warn "* converting remotely from xml #{input} to txt #{output}" if $options.verbose
+  format = flags[0] || "--text"
+  # warn [:V3, $options.v3].inspect
+  maf = MODE_AS_FORMAT[$options.v3][format]
+  unless maf
+    warn "*** don't know how to convert remotely from xml #{input} to txt #{output}"
+    exit(1)
+  end
   url = URI(XML2RFC_WEBSERVICE)
   req = Net::HTTP::Post.new(url)
-  form = [["modeAsFormat", "txt/#{"v3" if $options.v3}ascii"],
+  form = [["modeAsFormat", maf],
           ["type", "binary"],
           ["input", File.open(input),
            {filename: "input.xml",
@@ -127,7 +147,7 @@ BANNER
   opts.on("-p", "--[no-]prep", "Convert xml to prepped xml") do |v|
     $options.prep = v
   end
-  opts.on("-P", "--[no-]pdf", "Convert xml to PDF") do |v|
+  opts.on("-P", "-f", "--[no-]pdf", "Convert xml to PDF") do |v|
     $options.pdf = v
   end
   opts.on("-c", "--[no-]convert", "Convert xml to v3 xml") do |v|

data/bin/kramdown-rfc-cache-i-d-bibxml

@@ -15,7 +15,7 @@ require 'fileutils'
 
 begin
   require 'net/http/persistent'
-rescue
+rescue LoadError
   warn "*** please install net-http-persistent:"
   warn "   gem install net-http-persistent"
   warn "(prefix by sudo only if required)."

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

@@ -14,7 +14,7 @@ require 'fileutils'
 
 begin
   require 'net/http/persistent'
-rescue
+rescue LoadError
   warn "*** please install net-http-persistent:"
   warn "   gem install net-http-persistent"
   warn "(prefix by sudo only if required)."

data/bin/kramdown-rfc2629

@@ -83,7 +83,7 @@ def do_the_tls_dance
 end
 
 RE_NL = /(?:\n|\r|\r\n)/
-RE_SECTION = /---(?:\s+(\w+)(-?))?\s*#{RE_NL}(.*?#{RE_NL})(?=---(?:\s+\w+-?)?\s*#{RE_NL}|\Z)/m
+RE_SECTION = /---(?: +(\w+)(-?))?\s*#{RE_NL}(.*?#{RE_NL})(?=---(?:\s+\w+-?)?\s*#{RE_NL}|\Z)/m
 
 NMDTAGS = ["{:/nomarkdown}\n\n", "\n\n{::nomarkdown}\n"]
 
@@ -195,6 +195,7 @@ def xml_from_sections(input)
   sechash = Hash.new{ |h,k| h[k] = ""}
   snames = []                   # a stack of section names
   sections.each do |sname, nmdflag, text|
+    # warn [:SNAME, sname, nmdflag, text[0..10]].inspect
     nmdin, nmdout = {
       "-" => ["", ""],          # stay in nomarkdown
       "" => NMDTAGS, # pop out temporarily
@@ -306,7 +307,7 @@ def xml_from_sections(input)
   [:normative, :informative].each do |sn|
     if refs = ps[sn]
       refs.each do |k, v|
-        href = k.gsub(/\A[0-9]/) { "_#{$&}" } # can't start an IDREF with a number
+        href = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(k)
         kramdown_options[:link_defs][k] = ["##{href}", nil]   # allow [RFC2119] in addition to {{RFC2119}}
 
         bibref = anchor_to_bibref[k] || k
@@ -328,7 +329,7 @@ def xml_from_sections(input)
           if bts && !v.delete("override")
             warn "*** warning: explicit settings completely override canned bibxml in reference #{k}"
           end
-          sechash[sn.to_s] << KramdownRFC::ref_to_xml(k, v)
+          sechash[sn.to_s] << KramdownRFC::ref_to_xml(href, v)
         end
       end
     end
@@ -363,7 +364,7 @@ def bibtagsys(bib, anchor=nil, stand_alone=true)
   elsif bib =~ /\A([-A-Z0-9]+)\./ &&
         (xro = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_MAP[$1])
     dir, _ttl, rewrite_anchor = xro
-    bib1 = bib.gsub(/\A[0-9]/) { "_#{$&}" } # can't start an ID with a number
+    bib1 = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(bib)
     if anchor && bib1 != anchor
       if rewrite_anchor
         a = %{?anchor=#{anchor}}
@@ -461,7 +462,18 @@ if coding_override
   input = input.encode(Encoding.find(coding_override), fallback: FALLBACK)
 end
 
+# 1.4.17: because of UTF-8 bibxml files, kramdown always needs to see UTF-8 (!)
+if input.encoding != Encoding::UTF_8
+  input = input.encode(Encoding::UTF_8)
+end
+
 # warn "options: #{options.inspect}"
 doc = Kramdown::Document.new(input, options)
 $stderr.puts doc.warnings.to_yaml unless doc.warnings.empty?
-puts doc.to_rfc2629
+output = doc.to_rfc2629
+
+if coding_override
+  output = output.encode(Encoding.find(coding_override), fallback: FALLBACK)
+end
+
+puts output

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.4.14.pre'
+  s.version = '1.4.19'
   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.}

data/lib/kramdown-rfc2629.rb

@@ -42,7 +42,7 @@ module Kramdown
         @block_parsers.unshift(:block_pi)
       end
 
-      XREF_BASE = /[\w.-]+/ # a token for a reference
+      XREF_BASE = /#{REXML::XMLTokens::NAME_CHAR}+/ # a token for a reference
       XREF_TXT = /(?:[^\(]|\([^\)]*\))+/ # parenthesized text
       XREF_RE = /#{XREF_BASE}(?: \(#{XREF_TXT}\))?/
       XREF_RE_M = /\A(#{XREF_BASE})(?: \((#{XREF_TXT})\))?/ # matching version of XREF_RE
@@ -51,6 +51,11 @@ module Kramdown
       XREF_ANY = /(?:#{XREF_SINGLE}|#{XREF_MULTI})/
       SECTIONS_RE = /(?:#{XREF_ANY} and )?#{XREF_ANY}/
 
+      def self.idref_cleanup(href)
+        # can't start an IDREF with a number or reserved start
+        href.gsub(/\A(?:[0-9]|section-|u-|figure-|table-|iref-)/) { "_#{$&}" }
+      end
+
       def handle_bares(s, attr, format, href, last_join = nil)
         if s.match(/\A(#{XREF_ANY}) and (#{XREF_ANY})\z/)
           handle_bares($1, {}, nil, href, " and ")
@@ -120,7 +125,7 @@ module Kramdown
             when /\A(.*) \((#{SECTIONS_RE})\)\z/
               href = $1
               handle_bares($2, attr, "parens", href)
-            when /\A([\w.]+)<(.+)\z/
+            when /\A(#{XREF_BASE})<(.+)\z/
               href = $2
               attr['section'] = $1
               attr['sectionFormat'] = 'bare'
@@ -132,11 +137,11 @@ module Kramdown
               attr['format'] = 'counter'
             end
           end
-          if href.match(XREF_RE_M)
+          if href.match(/#{XREF_RE_M}\z/)
             href = $1
             attr['text'] = $2
           end
-          href = href.gsub(/\A[0-9]/) { "_#{$&}" } # can't start an IDREF with a number
+          href = self.class.idref_cleanup(href)
           attr['target'] = href
           el = Element.new(:xref, nil, attr)
         end
@@ -212,10 +217,10 @@ module Kramdown
     def rfc2629_fix
       if a = attr
         if anchor = a.delete('id')
-          a['anchor'] = anchor
+          a['anchor'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
         end
         if anchor = a.delete('href')
-          a['target'] = anchor
+          a['target'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
         end
         attr.keys.each do |k|
           if (d = k.gsub(/_(.|$)/) { $1.upcase }) != k or d = STUDLY_ATTR_MAP[k]
@@ -251,7 +256,10 @@ module Kramdown
           require 'net/http/persistent'
           $http = Net::HTTP::Persistent.new name: 'kramdown-rfc'
         rescue Exception => e
-          warn "** Can't set up persistent HTTP -- #{e}"
+          warn "** Not using persistent HTTP -- #{e}"
+          warn "**   To silence this message and get full speed, try:"
+          warn "**     gem install net-http-persistent"
+          warn "**   If this doesn't work, you can ignore this warning."
         end
       end
 
@@ -917,6 +925,7 @@ COLORS
                  ],
         "W3C" => "bibxml4",
         "3GPP" => "bibxml5",
+        "SDO-3GPP" => "bibxml5",
         "ANSI" => "bibxml2",
         "CCITT" => "bibxml2",
         "FIPS" => "bibxml2",
@@ -955,7 +964,7 @@ COLORS
             warn "*** missing anchor for '#{src}'"
             src
           )
-          anchor.sub!(/\A[0-9]/) { "_#{$&}" } # can't start an ID with a number
+          anchor = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
           anchor.gsub!('/', '_')              # should take out all illegals
           to_insert = ""
           src.scan(/(W3C|3GPP|[A-Z-]+)[.]?([A-Za-z_0-9.\/\+-]+)/) do |t, n|
@@ -1024,7 +1033,7 @@ COLORS
         # "\n#{' '*indent}<cref>\n#{inner(el.value, indent, opts).rstrip}\n#{' '*indent}</cref>"
         content = inner(el.value, indent, opts).strip
         content = escape_html(content.sub(/\A<t>(.*)<\/t>\z/m) {$1}, :text) # text only...
-        name = el.options[:name].sub(/\A[0-9]/) {"_" << $&}
+        name = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(el.options[:name])
         while @footnote_names_in_use[name] do
           if name =~ /:\d+\z/
             name.succ!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.4.14.pre
+  version: 1.4.19
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -98,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.15
 signing_key: