kramdown-rfc2629 1.5.12 → 1.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bb5b3f39e014d065b0dd2b72bd851804856c97610b1e24f863bd4c7c48a5c71
-  data.tar.gz: '09f66a0f2557a18c023d0d991d009a5fe48568a7fd4c20a39540d111d4610c02'
+  metadata.gz: def25c3e3ddc2683800f2521956c7b7546da22ff963d08ea373bdb3626f5be6f
+  data.tar.gz: 453b9c763e43fa1930fe6f9239efb4951d73e479c4a82df1578443c872cec588
 SHA512:
-  metadata.gz: 8a18e3db3281a30d45d60cf2f7e82f1addece4ff7867c70db1bfa104cbb015d416475659d677525ac50cc99ee83f46c874fddaba1bc04aa5109752bc7de56a6d
-  data.tar.gz: f3f0e0da73244c8c78cdf1148b5036e412dbb95bd0e6d743b0d262bb5d52a2e595ef982433f527dd0ecabba2e75a544da0c17990943382fd67c21fda140adacc
+  metadata.gz: c7b09f669ef3c392e932264a1818db17679956178095a426d00ec0858c83dd5305752f2c9dfd042117f7f2786b085b750aa397f5afe0cf114a0811ca316fcbee
+  data.tar.gz: a14a50df013430d0e73b1d1e03a954cf6b54feef3cdaaca402546b93b086eb954bb22f85484fc5eda8da2859e6e0cd8dcc2a073d1509825e99dcb8c9754f03b3

data/data/kramdown-rfc2629.erb

@@ -42,6 +42,31 @@
 
     </abstract>
 
+<% if $options.v3 -%>
+<%  venue = ps[:venue] -%>
+<%  if venue -%>
+<%    venue = KramdownRFC::ParameterSet.new(venue) -%>
+    <note title="Discussion Venues" removeInRFC="true">
+<%   if mail = venue[:mail] -%>
+<%     mail_local, mail_host = mail.split("@", 2) -%>
+<%     mail_subdomain, mail_domain = mail_host.split(".", 2) -%>
+<%     group = venue[:group] || mail_local # XXX -%>
+<%     arch = venue[:arch] || "https://mailarchive.ietf.org/arch/browse/#{mail_local}/" -%>
+<%     GROUPS = {"ietf" => "Working ", "irtf" => "Research "} -%>
+<%     type = venue[:type] || "#{GROUPS[mail_subdomain]}Group" -%>
+      <t>Discussion of this document takes place on the
+        <%=group%> <%=type%> mailing list (<%=mail%>),
+        which is archived at <eref target="<%=arch%>"/>.</t>
+<%   end -%>
+<%   if gh = venue[:github] -%>
+      <t>Source for this draft and an issue tracker can be found at
+        <eref target="https://github.com/<%=gh%>"/>.</t>
+<%   end -%>
+    </note>
+<%  venue.warn_if_leftovers -%>
+<%  end -%>
+<% end -%>
+
 <% sechash.keys.each do |k| -%>
 <%   if k =~ /\A(to_be_removed_)?note_(.*)/ -%>
 
@@ -78,6 +103,7 @@
 {:removeinrfc: removeinrfc="true"}
 {:notoc: toc="exclude"}
 {:compact: spacing="compact"}
+{:noabbrev: noabbrev="true"}
 {::nomarkdown}
 
 <%= sechash.delete("middle") %>

data/kramdown-rfc2629.gemspec

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

@@ -34,6 +34,18 @@ module Kramdown
 
     class RFC2629Kramdown < Kramdown
 
+      def replace_abbreviations(el, regexps = nil)
+        unless regexps          # DUPLICATED AND MODIFIED CODE FROM UPSTREAM, CHECK ON UPSTREAM UPGRADE
+          sorted_abbrevs = @root.options[:abbrev_defs].keys.sort {|a, b| b.length <=> a.length }
+          regexps = [Regexp.union(*sorted_abbrevs.map {|k| 
+                                    /#{Regexp.escape(k).gsub(/\\\s/, "[\\s\\p{Z}]+").force_encoding(Encoding::UTF_8)}/})]
+          # warn regexps.inspect
+          regexps << /(?=(?:\W|^)#{regexps.first}(?!\w))/ # regexp should only match on word boundaries
+        end
+        super(el, regexps)
+      end
+
+
       def initialize(*doc)
         super
         @span_parsers.unshift(:xref)
@@ -226,7 +238,11 @@ module Kramdown
     )
     STUDLY_ATTR_MAP = Hash[STUDLY_ATTR.map {|s| [s.downcase, s]}]
 
-    def rfc2629_fix
+    TRUTHY = Hash.new {|h, k| k}
+    TRUTHY["false"] = false
+    TRUTHY["no"] = false
+
+    def rfc2629_fix(opts)
       if a = attr
         if anchor = a.delete('id')
           a['anchor'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
@@ -234,12 +250,16 @@ module Kramdown
         if anchor = a.delete('href')
           a['target'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
         end
+        if av = a.delete('noabbrev')      # pseudo attribute -> opts
+          opts = opts.merge(noabbrev: TRUTHY[av]) # updated copy
+        end
         attr.keys.each do |k|
           if (d = k.gsub(/_(.|$)/) { $1.upcase }) != k or d = STUDLY_ATTR_MAP[k]
             a[d] = a.delete(k)
           end
         end
       end
+      opts
     end
   end
 
@@ -294,15 +314,15 @@ module Kramdown
       end
 
       def convert1(el, indent, opts = {})
-        el.rfc2629_fix
-        send("convert_#{el.type}", el, indent, opts)
+        nopts = el.rfc2629_fix(opts)
+        send("convert_#{el.type}", el, indent, nopts)
       end
 
       def inner_a(el, indent, opts)
         indent += INDENTATION
         el.children.map do |inner_el|
-          inner_el.rfc2629_fix
-          send("convert_#{inner_el.type}", inner_el, indent, opts)
+          nopts = inner_el.rfc2629_fix(opts)
+          send("convert_#{inner_el.type}", inner_el, indent, nopts)
         end
       end
 
@@ -447,59 +467,67 @@ COLORS
         end
       end
 
-      def svg_tool_process(t, result)
+      def shell_prepare(opt)
+        " " << opt.shellsplit.shelljoin
+      end
+
+      DEFAULT_AASVG="aasvg --spaces=1"
+
+      def svg_tool_process(t, svg_opt, txt_opt, result)
         require 'tempfile'
         file = Tempfile.new("kramdown-rfc")
         file.write(result)
         file.close
         dont_clean = false
         dont_check = false
+        svg_opt = shell_prepare(svg_opt) if svg_opt
+        txt_opt = shell_prepare(txt_opt) if txt_opt
         case t
         when "protocol", "protocol-goat", "protocol-aasvg"
           cmdparm = result.lines.map(&:strip).select {|x| x != ''}.join(',')
-          result, err, _s = Open3.capture3("protocol #{Shellwords.escape(cmdparm)}", stdin_data: '')
+          result, err, _s = Open3.capture3("protocol #{Shellwords.escape(cmdparm)}#{txt_opt}", stdin_data: '')
           if t == "protocol-goat"
             file.unlink
             file = Tempfile.new("kramdown-rfc")
             file.write(result)
             file.close
-            result1, err, _s = Open3.capture3("goat #{file.path}", stdin_data: result);
+            result1, err, _s = Open3.capture3("goat#{svg_opt} #{file.path}", stdin_data: result);
             dont_clean = true
           elsif t == "protocol-aasvg"
-            result1, err, _s = Open3.capture3("aasvg", stdin_data: result);
+            result1, err, _s = Open3.capture3("#{DEFAULT_AASVG}#{svg_opt}", stdin_data: result);
             dont_clean = true
           else
             result1 = nil
           end
         when "goat"
-          result1, err, _s = Open3.capture3("goat #{file.path}", stdin_data: result);
+          result1, err, _s = Open3.capture3("goat#{svg_opt} #{file.path}", stdin_data: result);
           dont_clean = true
         when "aasvg"
-          result1, err, _s = Open3.capture3("aasvg", stdin_data: result);
+          result1, err, _s = Open3.capture3("#{DEFAULT_AASVG}#{svg_opt}", stdin_data: result);
           dont_clean = true
         when "ditaa"        # XXX: This needs some form of option-setting
-          result1, err, _s = Open3.capture3("ditaa #{file.path} --svg -o -", stdin_data: result);
+          result1, err, _s = Open3.capture3("ditaa #{file.path} --svg -o -#{svg_opt}", stdin_data: result);
         when "mscgen"
-          result1, err, _s = Open3.capture3("mscgen -T svg -i #{file.path} -o -", stdin_data: result);
+          result1, err, _s = Open3.capture3("mscgen -T svg -i #{file.path} -o -#{svg_opt}", stdin_data: result);
         when "mermaid"
-          result1, err, _s = Open3.capture3("mmdc -i #{file.path}", stdin_data: result); #  -b transparent
+          result1, err, _s = Open3.capture3("mmdc -i #{file.path}#{svg_opt}", stdin_data: result); #  -b transparent
           outpath = file.path + ".svg"
           result1 = File.read(outpath) rescue '' # don't die before providing error message
           File.unlink(outpath) rescue nil        # ditto
         when "plantuml", "plantuml-utxt"
           plantuml = "@startuml\n#{result}\n@enduml"
-          result1, err, _s = Open3.capture3("plantuml -pipe -tsvg", stdin_data: plantuml);
-          result, err1, _s = Open3.capture3("plantuml -pipe -tutxt", stdin_data: plantuml) if t == "plantuml-utxt"
+          result1, err, _s = Open3.capture3("plantuml -pipe -tsvg#{svg_opt}", stdin_data: plantuml);
+          result, err1, _s = Open3.capture3("plantuml -pipe -tutxt#{txt_opt}", stdin_data: plantuml) if t == "plantuml-utxt"
           err << err1.to_s
         when "railroad", "railroad-utf8"
-          result1, err1, _s = Open3.capture3("kgt -l abnf -e svg", stdin_data: result);
+          result1, err1, _s = Open3.capture3("kgt -l abnf -e svg#{svg_opt}", stdin_data: result);
           result1 = svg_clean_kgt(result1); dont_clean = true
-          result, err, _s = Open3.capture3("kgt -l abnf -e rr#{t == "railroad" ? "text" : "utf8"}",
+          result, err, _s = Open3.capture3("kgt -l abnf -e rr#{t == "railroad" ? "text" : "utf8"}#{txt_opt}",
                                             stdin_data: result);
           err << err1.to_s
         when "math"
-          result1, err, _s = Open3.capture3("tex2svg --font STIX --speech=false #{Shellwords.escape(' ' << result)}");
-          result, err1, _s = Open3.capture3("asciitex -f #{file.path}")
+          result1, err, _s = Open3.capture3("tex2svg --font STIX --speech=false#{svg_opt} #{Shellwords.escape(' ' << result)}");
+          result, err1, _s = Open3.capture3("asciitex -f #{file.path}#{txt_opt}")
           err << err1
         end
         capture_croak(t, err)
@@ -576,12 +604,18 @@ COLORS
             if gi
               warn "*** Can't set GI #{gi} for composite SVG artset"
             end
-            result, result1 = memoize(:svg_tool_process, t, result)
-            if result1          # refactor!
-            "#{' '*indent}<figure#{el_html_attributes(el)}><artset><artwork #{html_attributes(artwork_attr.merge("type"=> "svg"))}>#{result1.sub(/.*?<svg/m, "<svg")}</artwork><artwork #{html_attributes(artwork_attr.merge("type"=> "ascii-art"))}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></artwork></artset></figure>\n"
-            else
-            "#{' '*indent}<figure#{el_html_attributes(el)}><artwork #{html_attributes(artwork_attr.merge("type"=> "ascii-art"))}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></artwork></figure>\n"
+            result, result1 = memoize(:svg_tool_process, t,
+                                      artwork_attr.delete("svg-options"),
+                                      artwork_attr.delete("txt-options"),
+                                      result)
+            retart = mk_artwork(artwork_attr, "ascii-art",
+                                "<![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]>")
+            if result1          # nest TXT in artset with SVG
+              retsvg = mk_artwork(artwork_attr, "svg",
+                                  result1.sub(/.*?<svg/m, "<svg"))
+              retart = "<artset>#{retsvg}#{retart}</artset>"
             end
+            "#{' '*indent}<figure#{el_html_attributes(el)}>#{retart}</figure>\n"
           else
             gi ||= (
               if !$options.v3 || !t || ARTWORK_TYPES.include?(t) || artwork_attr["align"]
@@ -595,6 +629,10 @@ COLORS
         end
       end
 
+      def mk_artwork(artwork_attr, typ, content)
+        "<artwork #{html_attributes(artwork_attr.merge("type" => typ))}>#{content}</artwork>"
+      end
+
       def convert_blockquote(el, indent, opts)
         text = inner(el, indent, opts)
         if $options.v3
@@ -646,7 +684,8 @@ COLORS
           if sl = el.attr.delete('slugifiedName') # could do general name- play
             attrstring = html_attributes({'slugifiedName' => sl})
           end
-          irefs = "<name#{attrstring}>#{inner(el, indent, opts)}</name>" #
+          # noabbrev: true -- Workaround for https://trac.ietf.org/trac/xml2rfc/ticket/683
+          irefs = "<name#{attrstring}>#{inner(el, indent, opts.merge(noabbrev: true))}</name>" #
         else
         clean, irefs = clean_pcdata(inner_a(el, indent, opts))
         el.attr['title'] = clean
@@ -1233,13 +1272,35 @@ COLORS
       end
 
       def convert_abbreviation(el, indent, opts) # XXX: This is wrong
-        title = @root.options[:abbrev_defs][el.value]
-        title = nil if title.empty?
+        if opts[:noabbrev]
+          return el.value
+        end
+
         value = el.value
-        if item = title
-          if item == "<bcp14>" && $options.v3
-            return "<bcp14>#{el.value}</bcp14>"
+        ix = value.gsub(/[\s\p{Z}]+/, " ")
+        title = @root.options[:abbrev_defs][ix]
+        if title.nil?
+          warn "*** abbrev mismatch: value = #{value.inspect} ix = #{ix.inspect}"
+        else
+          title = nil if title.empty?
+        end
+
+        if title == "<bcp14>" && $options.v3
+          return "<bcp14>#{value}</bcp14>"
+        end
+
+        if title && title[0] == "#"
+          target, title = title.split(' ', 2)
+          if target == "#"
+            target = value
+          else
+            target = target[1..]
           end
+        else
+          target = nil
+        end
+
+        if item = title
           m = title.scan(Parser::RFC2629Kramdown::IREF_START)
           if m.empty?
             subitem = value
@@ -1250,7 +1311,11 @@ COLORS
           item = value
         end
         iref ||= "<iref#{html_attributes(item: item, subitem: subitem)}/>"
-        "#{el.value}#{iref}"
+        if target
+          "<xref#{html_attributes(target: target, format: "none")}>#{value}</xref>#{iref}"
+        else
+          "#{value}#{iref}"
+        end
       end
 
       def convert_root(el, indent, opts)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.5.12
+  version: 1.5.16
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown