kramdown-rfc2629 1.5.13 → 1.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44da042356d9bc536e5c05d3256718ed025a7d83a1678fa66ee86078daeaf440
-  data.tar.gz: 5ee1e04e156d30c36c070828f41ed382fb46a13a43310f8c6a2b5a597cb2fe4f
+  metadata.gz: 437ec106fe0458259c9f776fb89ed2993ffea7a466a66f087cb2dd4a460616b3
+  data.tar.gz: 255a5c80a71f8e5447c59a557b58c8ccbb6bc4ad503f838650a6e5c49083b0fb
 SHA512:
-  metadata.gz: 1ce55d74b92191986255d87e27f1891a4f60f7eb68fe4baff5ea0eedd264a76511870b5817bae23d6b76e553143621b9ab570c658cb6b197735c501b470cfc7a
-  data.tar.gz: 8f044f904be1ef0f9d56bd430a7104d5e522b630cae07a318ef98c862639393350099148ecdb2dd1a3a027a2da627489aae1b7dcb64c1c9cbd60b7f56ca09541
+  metadata.gz: d2a9724e14f28a37f6426b1173b25941a7fe1ed113be1a7c45da2e1bc855ae367723a5bf92c515ad6dd7da95d6616c91c8d16de51f366c0ec4c20417073c0ac8
+  data.tar.gz: '088030252b477385ecfa4447a4b76a472f8fbe33b0104c680feb8ea6493b4fe72334c087ec2321bfc567901595a3113750757fb35a7d69e794ef25c30071c435'

data/data/kramdown-rfc2629.erb

@@ -42,6 +42,43 @@
 
     </abstract>
 
+<% if $options.v3 -%>
+<%  venue = ps[:venue] -%>
+<%  if venue -%>
+<%    venue = KramdownRFC::ParameterSet.new(venue) -%>
+    <note title="Discussion Venues" removeInRFC="true">
+<%   mail = venue[:mail] -%>
+<%   homepage = venue[:home] -%>
+<%   gtype = venue[:type] -%>
+<%   if mail || homepage -%>
+      <t>
+<%   end -%>
+<%   if 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 "} -%>
+<%     gtype ||= "#{GROUPS[mail_subdomain]}Group" -%>
+        Discussion of this document takes place on the
+        <%=group%> <%=gtype%> mailing list (<eref target="mailto:<%=mail%>"/>),
+        which is archived at <eref target="<%=arch%>"/>.
+<%   end -%>
+<%   if homepage -%>
+        <%=gtype%> information can be found at <eref target="<%=homepage%>"/>.
+<%   end -%>
+<%   if mail || homepage -%>
+      </t>
+<%   end -%>
+<%   if repo = venue[:repo] || ((gh = venue[:github]) && "https://github.com/#{gh}") -%>
+      <t>Source for this draft and an issue tracker can be found at
+        <eref target="<%=repo%>"/>.</t>
+<%   end -%>
+    </note>
+<%  venue.warn_if_leftovers -%>
+<%  end -%>
+<% end -%>
+
 <% sechash.keys.each do |k| -%>
 <%   if k =~ /\A(to_be_removed_)?note_(.*)/ -%>
 
@@ -78,6 +115,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.13'
+  s.version = '1.5.17'
   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"]
@@ -590,11 +624,44 @@ COLORS
                 "sourcecode"
               end
             )
+            loc_str =
+              if anchor = el.attr['anchor']
+                "##{anchor}"
+              elsif lineno = el.options[:location]
+                "approx. line #{lineno}" # XXX
+              else
+                "UNKNOWN"
+              end
+            case t
+            when "json"
+              begin
+                JSON.load(result)
+              rescue => e
+                err1 = "*** #{loc_str}: JSON isn't: #{e.message[0..40]}\n"
+                begin
+                  JSON.load("{" << result << "}")
+                rescue => e
+                  warn err1 << "***  not even with braces added around: #{e.message[0..40]}"
+                end
+              end
+            when "json-from-yaml"
+              begin
+                y = YAML.safe_load(result, aliases: true, filename: loc_str)
+                result = JSON.pretty_generate(y)
+                t = "json"      # XXX, this could be another format!
+              rescue => e
+                warn "*** YAML isn't: #{e.message}\n"
+              end
+            end
             "#{' '*indent}<figure#{el_html_attributes(el)}><#{gi}#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></#{gi}></figure>\n"
           end
         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,6 +713,7 @@ COLORS
           if sl = el.attr.delete('slugifiedName') # could do general name- play
             attrstring = html_attributes({'slugifiedName' => sl})
           end
+          # 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))
@@ -1237,9 +1305,14 @@ COLORS
           return el.value
         end
 
-        title = @root.options[:abbrev_defs][el.value]
-        title = nil if title.empty?
         value = el.value
+        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>"

metadata

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