kramdown-rfc2629 1.3.25 → 1.3.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a18c9460f832be1f0bb626cc1b6ea385a6535b7af585212ec0c961ae1945d36
-  data.tar.gz: f34512123c073979fff13351c1fdd3ec640376a604e9aba7e849652d59172023
+  metadata.gz: 450d01ba97272a13529eebbfacb09eeca5bc2ab11ca5e62ffbb030283fe27d46
+  data.tar.gz: 1c8662ed374b3b5de9977d84600c71ebe95ff58844270fe40048a85e5b04eb17
 SHA512:
-  metadata.gz: 69f0328719872f0bef0d81bffb5fa495e384f599a0fb3843cc4c9d6065811be71f21e7ab9700cb1d1f3419d5a91dc88af62c855b5f97f499519b15b11f888bef
-  data.tar.gz: 56778f5ec4e581ac21d17637c1098924ccd6a0b97facd12a2e636fdae755798c6ce7a545e5b8395ec17168e9e118230c1cca00e23ab8332eedbca6a0cf57dccc
+  metadata.gz: 79145499d9ee1c7a8596d730956175c28278e8b66d011aa37a1797c043104abba756b3e37b4a69b19b687603530d7ae980ccaace45444614e272ec7e522c4c0d
+  data.tar.gz: f1acecfe30457df4f7c4a8e9083a29b7d9d17fd26a971a960e295ceabbbc72019529e5422af71c83bea76d1abc25d187d6cb69b6bf15342ac3ee19d52197685d

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/kramdown-rfc2629.gemspec

@@ -1,12 +1,12 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.25'
+  s.version = '1.3.30'
   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-rfc2629.rb

@@ -289,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)
@@ -330,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}")
@@ -349,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
 
@@ -686,7 +695,7 @@ COLORS
             message = "fetching"
             fetch_timeout = 60 # seconds; long timeout needed for Travis
           end
-          $stderr.puts "#{fn}: #{message}"
+          $stderr.puts "#{fn}: #{message} from #{url}"
           if ENV["HAVE_WGET"]
             `cd #{REFCACHEDIR}; wget -t 3 -T #{fetch_timeout} -Nnv "#{url}"` # ignore errors if offline (hack)
             begin
@@ -730,8 +739,12 @@ COLORS
 
       # [subdirectory name, cache ttl in seconds, does it provide for ?anchor=]
       XML_RESOURCE_ORG_MAP = {
-        "RFC" => ["bibxml", 86400*7], # these should change rarely
-        "I-D" => "bibxml3",
+        "RFC" => ["bibxml", 86400*7, false,
+                  ->(fn, n){ "https://www.rfc-editor.org/refs/bibxml/#{fn}"}
+                 ],
+        "I-D" => ["bibxml3", false, false,
+                  ->(fn, n){ "https://datatracker.ietf.org/doc/bibxml3/draft-#{n.sub(/\Adraft-/, '')}/xml" }
+                 ],
         "W3C" => "bibxml4",
         "3GPP" => "bibxml5",
         "ANSI" => "bibxml2",
@@ -752,6 +765,7 @@ COLORS
       XML_RESOURCE_ORG_HOST = ENV["XML_RESOURCE_ORG_HOST"] || "xml2rfc.tools.ietf.org"
       XML_RESOURCE_ORG_PREFIX = ENV["XML_RESOURCE_ORG_PREFIX"] ||
                                 "https://#{XML_RESOURCE_ORG_HOST}/public/rfc"
+      KRAMDOWN_USE_TOOLS_SERVER = ENV["KRAMDOWN_USE_TOOLS_SERVER"]
 
       KRAMDOWN_REFCACHETTL = (e = ENV["KRAMDOWN_REFCACHETTL"]) ? e.to_i : 3600
 
@@ -774,14 +788,18 @@ COLORS
           to_insert = ""
           src.scan(/(W3C|3GPP|[A-Z-]+)[.]?([A-Za-z_0-9.\/\+-]+)/) do |t, n|
             fn = "reference.#{t}.#{n}.xml"
-            sub, ttl, can_anchor = XML_RESOURCE_ORG_MAP[t]
+            sub, ttl, can_anchor, altproc = XML_RESOURCE_ORG_MAP[t]
             ttl ||= KRAMDOWN_REFCACHETTL  # everything but RFCs might change a lot
             puts "*** Huh: #{fn}" unless sub
-            url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}"
-            if can_anchor # create anchor server-side for stand_alone: false
-              url << "?anchor=#{anchor}"
-              fn[/.xml$/] = "--anchor=#{anchor}.xml"
+            if altproc && !KRAMDOWN_USE_TOOLS_SERVER
+              url = altproc.call(fn, n)
+            else
+              url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}"
             end
+            # if can_anchor # create anchor server-side for stand_alone: false
+            #   url << "?anchor=#{anchor}"
+            #   fn[/.xml$/] = "--anchor=#{anchor}.xml"
+            # end
             to_insert = get_and_cache_resource(url, fn.gsub('/', '_'), ttl)
             to_insert.scrub! rescue nil # only do this for Ruby >= 2.1
             # this may be a bit controversial: Don't break the build if reference is broken

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.3.25
+  version: 1.3.30
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-12 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:
     - - "~>"