kramdown-rfc2629 1.4.13 → 1.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 509111a53b346a7af409423bc1aea0e64c3fbded3e42868a875de6b867392429
-  data.tar.gz: 3c882b8d76cbbfcc9e070157c453a25105fe23de1d061a2c0bc56591857e7f08
+  metadata.gz: f351fb251c634da227a9ce9202094ee20ac11689be7b2144f118ba07aa2b31fb
+  data.tar.gz: 45d0559f1f6c6ff2c4ba18bab26a4e88bec8faad622cf0b9183c144eb419441f
 SHA512:
-  metadata.gz: a42a8122990612bb885799121492673d37f47285d1481a0b2db4e0a2e12b2ebee9b630131596f228a99daed62190fcf411317b37434dc46cf84e429ede139bdb
-  data.tar.gz: e5197f5394cfa12dd11042bb5c90d73dd02e6582f05175e7b2516c1d731fbd13d7699106666f43b1bd1ec1c98473229ba618f3cfde48a40759ec137d1e10087f
+  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/kdrfc

@@ -127,7 +127,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-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"]
 
@@ -98,7 +98,61 @@ def yaml_load(input, *args)
     end
   else
     YAML.load(input)
- end
+  end
+end
+
+def process_kramdown_options(coding_override = nil,
+                             smart_quotes = nil, typographic_symbols = nil,
+                             header_kramdown_options = nil)
+
+  ascii_target = coding_override && coding_override =~ /ascii/
+  suppress_typography = ascii_target || $options.v3
+  entity_output = ascii_target ? :numeric : :as_char;
+
+  options = {input: 'RFC2629Kramdown', entity_output: entity_output, link_defs: {}}
+
+  if smart_quotes.nil? && suppress_typography
+    smart_quotes = false
+  end
+  if smart_quotes == false
+    smart_quotes = ["'".ord, "'".ord, '"'.ord, '"'.ord]
+  end
+  case smart_quotes
+  when Array
+    options[:smart_quotes] = smart_quotes
+  when nil, true
+    # nothin
+  else
+    warn "*** Can't deal with smart_quotes value #{smart_quotes.inspect}"
+  end
+
+  if typographic_symbols.nil? && suppress_typography
+    typographic_symbols = false
+  end
+  if typographic_symbols == false
+    typographic_symbols = Hash[::Kramdown::Parser::Kramdown::TYPOGRAPHIC_SYMS.map { |k, v|
+                                 if Symbol === v
+                                   [v.intern, k]
+                                 end
+                               }.compact]
+  end
+  # warn [:TYPOGRAPHIC_SYMBOLS, typographic_symbols].to_yaml
+  case typographic_symbols
+  when Hash
+    options[:typographic_symbols] = typographic_symbols
+  when nil, true
+    # nothin
+  else
+    warn "*** Can't deal with typographic_symbols value #{typographic_symbols.inspect}"
+  end
+
+  if header_kramdown_options
+    options.merge! header_kramdown_options
+  end
+
+  $global_markdown_options = options   # For nested calls in bibref annotation processing and xref text
+
+  options
 end
 
 XREF_SECTIONS_RE = ::Kramdown::Parser::RFC2629Kramdown::SECTIONS_RE
@@ -127,15 +181,21 @@ def xml_from_sections(input)
   # We put back the "---" plus gratuitous blank lines to hack the line number in errors
   yaml_in = input[/---\s*/] << sections.shift[2]
   ps = KramdownRFC::ParameterSet.new(yaml_load(yaml_in, [Date], [], true))
+
   coding_override = ps.has(:coding)
   smart_quotes = ps[:smart_quotes]
   typographic_symbols = ps[:typographic_symbols]
-  kramdown_options = ps[:kramdown_options]
+  header_kramdown_options = ps[:kramdown_options]
+
+  kramdown_options = process_kramdown_options(coding_override,
+                                              smart_quotes, typographic_symbols,
+                                              header_kramdown_options)
 
   # all the other sections are put in a Hash, possibly concatenated from parts there
   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
@@ -243,13 +303,12 @@ def xml_from_sections(input)
   end
 
   stand_alone = ps[:stand_alone]
-  link_defs = {}
 
   [: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
-        link_defs[k] = ["##{href}", nil]            # allow [RFC2119] in addition to {{RFC2119}}
+        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
         bts, url = bibtagsys(bibref, k, stand_alone)
@@ -270,9 +329,7 @@ def xml_from_sections(input)
           if bts && !v.delete("override")
             warn "*** warning: explicit settings completely override canned bibxml in reference #{k}"
           end
-          options = {input: 'RFC2629Kramdown', entity_output: coding_override, link_defs: link_defs}
-          $global_markdown_options = options # For recursive calls in bibref annotation processing.
-          sechash[sn.to_s] << KramdownRFC::ref_to_xml(k, v)
+          sechash[sn.to_s] << KramdownRFC::ref_to_xml(href, v)
         end
       end
     end
@@ -289,7 +346,7 @@ def xml_from_sections(input)
     warn "*** sections left #{sechash.keys.inspect}!"
   end
 
-  [input, coding_override, link_defs, smart_quotes, typographic_symbols, kramdown_options]
+  [input, kramdown_options, coding_override]
 end
 
 XML_RESOURCE_ORG_PREFIX = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_PREFIX
@@ -307,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}}
@@ -371,7 +428,6 @@ if $options.verbose && $options.v3
   warn "*** not much RFCXMLv3 stuff implemented yet"
 end
 
-coding_override = :as_char
 input = ARGF.read
 if input[0] == "\uFEFF"
    warn "*** There is a leading byte order mark. Ignored."
@@ -392,62 +448,32 @@ if input =~ /[\t]/
    input = expand_tabs(input)
 end
 
-link_defs = {}
 if input =~ /\A---/        # this is a sectionized file
   do_the_tls_dance unless ENV["KRAMDOWN_DONT_VERIFY_HTTPS"]
-  input, target_coding, link_defs, smart_quotes, typographic_symbols, kramdown_options = xml_from_sections(input)
+  input, options, coding_override = xml_from_sections(input)
+else
+  options = process_kramdown_options # all default
 end
 if input =~ /\A<\?xml/          # if this is a whole XML file, protect it
   input = "{::nomarkdown}\n#{input}\n{:/nomarkdown}\n"
 end
-options = {input: 'RFC2629Kramdown', entity_output: coding_override, link_defs: link_defs}
-if smart_quotes.nil?
-  if (target_coding && target_coding =~ /ascii/) || $options.v3
-     smart_quotes = false
-  end
-end
-if smart_quotes == false
-  smart_quotes = ["'".ord, "'".ord, '"'.ord, '"'.ord]
-end
-case smart_quotes
-when Array
-  options[:smart_quotes] = smart_quotes
-when nil, true
-  # nothin
-else
-  warn "*** Can't deal with smart_quotes value #{smart_quotes.inspect}"
-end
-if typographic_symbols.nil?
-  if (target_coding && target_coding =~ /ascii/) || $options.v3
-     typographic_symbols = false
-  end
-end
-if typographic_symbols == false
-  typographic_symbols = Hash[::Kramdown::Parser::Kramdown::TYPOGRAPHIC_SYMS.map { |k, v|
-                               if Symbol === v
-                                 [v.intern, k]
-                               end
-                             }.compact]
-end
-# warn [:TYPOGRAPHIC_SYMBOLS, typographic_symbols].to_yaml
-case typographic_symbols
-when Hash
-  options[:typographic_symbols] = typographic_symbols
-when nil, true
-  # nothin
-else
-  warn "*** Can't deal with typographic_symbols value #{typographic_symbols.inspect}"
-end
 
-if kramdown_options
-  options.merge! kramdown_options
+if coding_override
+  input = input.encode(Encoding.find(coding_override), fallback: FALLBACK)
 end
 
-if target_coding
-  input = input.encode(Encoding.find(target_coding), fallback: FALLBACK)
+# 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.13'
+  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]
@@ -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.13
+  version: 1.4.18
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown