kramdown-rfc2629 1.3.23 → 1.3.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07194d52bdfea697e714e5775fc5d668f153eb7bad63503ef7b582bf43c7e0b
-  data.tar.gz: e92c7dc7adcf6a2cf45d234c382d7196e7b20fcfbbae650df0a7a0d341f8e0fc
+  metadata.gz: c6818d86a47ba8a06c199cdbca16a30644b06c4bb517fc7a5a5a35d93161a0e6
+  data.tar.gz: cb90602fd0b11b2e010200ffc4fac1727cd0aa446d2e59e5861d4fcd6b1cf579
 SHA512:
-  metadata.gz: a20a4204e3b2b3bc571814508309857c6a4a0bea9fb66bf2424d9a08ce425cfc7ff8d9ab007ac51471a45e8916ae11c9e47a7b070386967e8def1eae24cb1b00
-  data.tar.gz: 80cec91ada39501a454d92b02aa0f786293342272654d0758789feebcd27e0f7476b3607e985038887f0f44ea5c88b9f345d91c4e3fd778430617d98daf7e091
+  metadata.gz: b2c6ca51eaf892fb8b52c4bf115a82830deb1df21afcc0fb28c58eabbe273b727872be851d5e858c1018ce97e3ee5b8e7464086d4652a17af2f1144dda5f86a4
+  data.tar.gz: fb3125ce8ee03845999ad6f7e09cc9047ee4f4f3406da987c6a1458c0a4de65d0c2d590f62d02c516aa1d3de4d71e21660d33313fbf370452d57ee98d0a472ee

data/README.md

@@ -294,13 +294,24 @@ output generated by the tool (e.g., `plantuml-utxt`).
 
 Currently supported labels as of 1.3.9:
 
-* goat, ditaa: ASCII (plaintext) art to figure conversion
-* mscgen: Message Sequence Charts
-* plantuml: widely used multi-purpose diagram generator
+* [goat][], [ditaa][]: ASCII (plaintext) art to figure conversion
+* [mscgen][]: Message Sequence Charts
+* [plantuml][]: widely used multi-purpose diagram generator
 * plantuml-utxt: Like plantuml, except that a plantuml-generated
   plaintext form is used
-* mermaid: Very experimental; the conversion to SVG is prone to
+* [mermaid][]: Very experimental; the conversion to SVG is prone to
   generate black-on-black text in this version
+* math: display math using [tex2svg][] for HTML/PDF and [asciitex][]
+  (fork: [asciiTeX][asciiTeX-eggert]) for plaintext
+
+[goat]: https://github.com/blampe/goat
+[ditaa]:  https://github.com/stathissideris/ditaa
+[mscgen]: http://www.mcternan.me.uk/mscgen/
+[plantuml]: https://plantuml.com
+[mermaid]: https://github.com/mermaid-js/mermaid-cli
+[tex2svg]: https://github.com/mathjax/MathJax-demos-node/blob/master/direct/tex2svg
+[asciitex]: http://asciitex.sourceforge.net/
+[asciiTeX-eggert]: https://github.com/larseggert/asciiTeX
 
 Note that this feature does not play well with the CI (continuous
 integration) support in Martin Thomson's [I-D Template][], as that may

data/bin/kdrfc

@@ -24,6 +24,12 @@ def process_mkd(input, output)
   end
 end
 
+def run_idnits(txt_fn)
+  unless system("idnits", txt_fn)
+    warn "*** problem #$? running idnits"
+  end
+end
+
 def process_xml(*args)
   if $options.remote
     process_xml_remotely(*args)
@@ -124,6 +130,9 @@ BANNER
   opts.on("-c", "--[no-]convert", "Convert xml to v3 xml") do |v|
     $options.v2v3 = v
   end
+  opts.on("-i", "--[no-]idnits", "Run idnits on the resulting text") do |v|
+    $options.idnits = v
+  end
   opts.on("-h", "--[no-]html", "Convert to html as well") do |v|
     $options.html = v
   end
@@ -139,8 +148,9 @@ op.parse!
 def process_the_xml(fn, base)
   process_xml(fn, "#{base}.prepped.xml", "--preptool") if $options.prep
   process_xml(fn, "#{base}.v2v3.xml", "--v2v3") if $options.v2v3
-  process_xml(fn, "#{base}.txt") if $options.txt
+  process_xml(fn, "#{base}.txt") if $options.txt || $options.idnits
   process_xml(fn, "#{base}.html", "--html") if $options.html
+  run_idnits("#{base}.txt") if $options.idnits
 end
 
 case ARGV.size

data/bin/kramdown-rfc2629

@@ -4,7 +4,7 @@ require 'kramdown-rfc2629'
 require 'kramdown-rfc/parameterset'
 require 'kramdown-rfc/refxml'
 require 'yaml'
-require 'erb'
+require 'kramdown-rfc/erb'
 require 'date'
 
 # try to get this from gemspec.
@@ -154,7 +154,7 @@ def xml_from_sections(input)
       if bibref
         if old = anchor_to_bibref[word]
           if bibref != old
-            warn "*** conflicting definitions for xref #{anchor}: #{old} != #{bibref}"
+            warn "*** conflicting definitions for xref #{word}: #{old} != #{bibref}"
           end
         else
           anchor_to_bibref[word] = bibref
@@ -229,7 +229,7 @@ def xml_from_sections(input)
 
   erbfilename = File.expand_path '../../data/kramdown-rfc2629.erb', __FILE__
   erbfile = File.read(erbfilename, coding: "UTF-8")
-  erb = ERB.new(erbfile, nil, '-')
+  erb = ERB.trim_new(erbfile, '-')
   # remove redundant nomarkdown pop outs/pop ins as they confuse kramdown
   input = erb.result(binding).gsub(%r"{::nomarkdown}\s*{:/nomarkdown}"m, "")
   ps.warn_if_leftovers

data/kramdown-rfc2629.gemspec

@@ -1,12 +1,12 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.23'
+  s.version = '1.3.28'
   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.}
   s.add_dependency('kramdown', '~> 1.17.0')
   s.add_dependency('certified', '~> 1.0')
-  s.add_dependency('json', '~> 2.0')
+  s.add_dependency('json_pure', '~> 2.0')
   s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc2629 bin/doilit bin/kramdown-rfc-extract-markdown data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc2629', 'doilit', 'kramdown-rfc-extract-markdown', 'kdrfc']

data/lib/kramdown-rfc/erb.rb

@@ -0,0 +1,16 @@
+require 'erb'
+
+class ERB
+
+  case version.sub("erb.rb [", "")
+  when /\A2.1/                    # works back to 1.9.1
+    def self.trim_new(s, trim)
+      ERB.new(s, nil, trim)
+    end
+  else
+    def self.trim_new(s, trim)
+      ERB.new(s, trim_mode: trim)
+    end
+  end
+
+end

data/lib/kramdown-rfc/refxml.rb

@@ -1,3 +1,5 @@
+require 'kramdown-rfc/erb'
+
 module KramdownRFC
 
   extend Kramdown::Utils::Html
@@ -8,7 +10,7 @@ module KramdownRFC
 
   def self.ref_to_xml(k, v)
     vps = KramdownRFC::ParameterSet.new(v)
-    erb = ERB.new <<-REFERB, nil, '-'
+    erb = ERB.trim_new <<-REFERB, '-'
 <reference anchor="<%= escattr(k) %>" <%= vps.attr("target") %>>
   <front>
     <%= vps.ele("title") -%>
@@ -75,7 +77,7 @@ module KramdownRFC
   ERB
 
   def self.person_element_from_aups(element_name, aups)
-    erb = ERB.new(PERSON_ERB, nil, '-')
+    erb = ERB.trim_new(PERSON_ERB, '-')
     erb.result(binding)
   end
 

data/lib/kramdown-rfc2629.rb

@@ -128,6 +128,22 @@ module Kramdown
   end
 
   class Element
+
+    # Not fixing studly element names postalLine and seriesInfo yet
+
+    # occasionally regenerate the studly attribute name list via
+    # script in data/studly.rb
+    STUDLY_ATTR = %w(
+    asciiAbbrev asciiFullname asciiInitials asciiName asciiSurname
+    asciiValue blankLines derivedAnchor derivedContent derivedCounter
+    derivedLink displayFormat docName expiresDate hangIndent hangText
+    indexInclude iprExtract keepWithNext keepWithPrevious originalSrc
+    prepTime quoteTitle quotedFrom removeInRFC sectionFormat seriesNo
+    showOnFrontPage slugifiedName sortRefs submissionType symRefs tocDepth
+    tocInclude
+    )
+    STUDLY_ATTR_MAP = Hash[STUDLY_ATTR.map {|s| [s.downcase, s]}]
+
     def rfc2629_fix
       if a = attr
         if anchor = a.delete('id')
@@ -136,6 +152,11 @@ module Kramdown
         if anchor = a.delete('href')
           a['target'] = anchor
         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
     end
   end
@@ -268,7 +289,12 @@ COLORS
         REXML::XPath.each(d.root, "//*[@fill]") { |x| x.attributes["fill"] = svg_munch_color(x.attributes["fill"], true) }
         REXML::XPath.each(d.root, "//*[@id]") { |x| x.attributes["id"] = svg_munch_id(x.attributes["id"]) }
 ##      REXML::XPath.each(d.root, "//rect") { |x| x.attributes["style"] = "fill:none;stroke:black;stroke-width:1" unless x.attributes["style"] }
+        # Fix for mermaid:
+        REXML::XPath.each(d.root, "//polygon") { |x| x.attributes["rx"] = nil; x.attributes["ry"] = nil }
         d.to_s
+      rescue => detail
+        warn "*** Can't clean SVG: #{detail}"
+        d
       end
 
       def memoize(meth, *args)
@@ -309,13 +335,13 @@ COLORS
         when "mermaid"
           result1, err, _s = Open3.capture3("mmdc -i #{file.path}", stdin_data: result); #  -b transparent
           outpath = file.path + ".svg"
-          result1 = File.read(outpath)
-          File.unlink(outpath)
+          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"
-          err << err1
+          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}")
@@ -328,6 +354,10 @@ COLORS
         result1, err, _s = Open3.capture3("svgcheck -qa", stdin_data: result1);
         capture_croak("svgcheck", err)
         # warn ["svgcheck:", result1.inspect]
+        if result1 == ''
+          warn "*** could not create svg for #{result.inspect[0...20]}..."
+          exit 65 # EX_DATAERR
+        end
         [result, result1]       # text, svg
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.3.23
+  version: 1.3.28
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-21 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -74,6 +74,7 @@ files:
 - data/kramdown-rfc2629.erb
 - data/math.json
 - kramdown-rfc2629.gemspec
+- lib/kramdown-rfc/erb.rb
 - lib/kramdown-rfc/gzip-clone.rb
 - lib/kramdown-rfc/parameterset.rb
 - lib/kramdown-rfc/refxml.rb
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.