kramdown-rfc2629 1.4.17 → 1.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995b589ce86783d0aa3f5e3193cdb0399ace572b239fade7995c5699f6e4f8de
-  data.tar.gz: ea44d32db3e9c9a57210da431859ede63d5a2d756dd05f0beee9bbc1722e2cc3
+  metadata.gz: f351fb251c634da227a9ce9202094ee20ac11689be7b2144f118ba07aa2b31fb
+  data.tar.gz: 45d0559f1f6c6ff2c4ba18bab26a4e88bec8faad622cf0b9183c144eb419441f
 SHA512:
-  metadata.gz: 8e51f7d06bc29eb1cef1c475443f207474e23e903e0b9880ec29507a902aba034407821dbfa177aca297905571a6f404e651eefb62005bea55715fed885dd575
-  data.tar.gz: fccef7a2f854bebea02100f3dea2ab5c5cbcd0800f2bcd83272869d40255d1455aa76ecc5137e78c22f4871b4971acbbc02a00b7656a12cd595ebe1444447fb7
+  metadata.gz: 2d3acf198070f8d7b69995f9f581302a6d20bbb24241350a169ef8cc5ccfeb49d191adfaaa11442df5859534812761d91c7f7c5a8b22b5a2aec19c8d2a02e48b
+  data.tar.gz: b1c5d6d9c968d82a453bcdfcc234e1dc4f3844ba9084942f73fd5212258d0d1e361f55fc1cb36910b58a4c2e68286cfe20695cf8d6d1c9e538a9907164d89d71

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][].
 

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
@@ -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}}

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.4.17'
+  s.version = '1.4.18'
   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 ")
@@ -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]
@@ -959,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|
@@ -1028,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.17
+  version: 1.4.18
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown