kramdown-rfc2629 1.3.27 → 1.3.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e75bef07cedf1af17c6bfc0f6c688171af4a5deeb5f473215597617f7c98888f
-  data.tar.gz: a8d16417fe3a37a092375fba5234857e61b15350eee5f99e9efe25aeeaed8165
+  metadata.gz: 7a63a768cc08e589dd15a5d52c77d3567ecd689ed5521ecb2f4772ee6b933a88
+  data.tar.gz: db71bef12f52b7777f1a19b84ff5c19bf1f37835761291b2aaaa626b92d67c54
 SHA512:
-  metadata.gz: fc5c770234e58c35c658de4ca7596d0d8ab0d3ea37bb9569e0689086909ba1c45ac0e4a68f39a0839a85abd1b4e55ef18c0b651f36954276be1686aabc501469
-  data.tar.gz: c3e226f620e093229c30549463dfa42eb99aeeb56bcd55022c0b7265a2531b5c469299f94010fbbe5de585787f08328a8c9991c1dcfebaba5c8552c97a192daa
+  metadata.gz: 51deb8472aa941d6c7d21ec8e60173064a59cb426ccd3e48fdc2fad463a633197077be21a4d7298d08c32280d4df79e0a4990da23d39b96b94a881a27e6f5a91
+  data.tar.gz: f38b8bde3c0464622b652994f67c0fb9bc501bd3fd3c7d53f3536d0e0dc251f8b706b38550967a268c1b21e156e272f78c3aafac4899621ed7077447bc5e0f91

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

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

@@ -178,6 +178,17 @@ module Kramdown
 
       # :stopdoc:
 
+      KRAMDOWN_PERSISTENT = ENV["KRAMDOWN_PERSISTENT"]
+
+      if KRAMDOWN_PERSISTENT
+        begin
+          require 'net/http/persistent'
+          $http = Net::HTTP::Persistent.new name: 'kramdown-rfc'
+        rescue Exception => e
+          warn "** Can't set up persistent HTTP -- #{e}"
+        end
+      end
+
       # Defines the amount of indentation used when nesting XML tags.
       INDENTATION = 2
 
@@ -289,7 +300,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 +346,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 +365,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
 
@@ -673,6 +693,34 @@ COLORS
       KRAMDOWN_OFFLINE = ENV["KRAMDOWN_OFFLINE"]
       KRAMDOWN_REFCACHE_REFETCH = ENV["KRAMDOWN_REFCACHE_REFETCH"]
 
+      def get_and_write_resource(url, fn)
+        options = {}
+        if ENV["KRAMDOWN_DONT_VERIFY_HTTPS"]
+          options[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE
+        end             # workaround for OpenSSL on Windows...
+        # URI.open(url, **options) do |uf|          # not portable to older versions
+        OpenURI.open_uri(url, **options) do |uf|
+          s = uf.read
+          if uf.status[0] != "200"
+            warn "*** Status code #{status} while fetching #{url}"
+          else
+            File.write(fn, s)
+          end
+        end
+      end
+
+      def get_and_write_resource_persistently(url, fn)
+        t1 = Time.now
+        response = $http.request(URI(url))
+        if response.code != "200"
+          raise "Status code #{response.code} while fetching #{url}"
+        else
+          File.write(fn, response.body)
+        end
+        t2 = Time.now
+        warn "(#{"%.3f" % (t2 - t1)} s)"
+      end
+
       # this is now slightly dangerous as multiple urls could map to the same cachefile
       def get_and_cache_resource(url, cachefile, tvalid = 7200, tn = Time.now)
         fn = "#{REFCACHEDIR}/#{cachefile}"
@@ -686,7 +734,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
@@ -701,18 +749,15 @@ COLORS
             require 'timeout'
             begin
               Timeout::timeout(fetch_timeout) do
-                options = {}
-                if ENV["KRAMDOWN_DONT_VERIFY_HTTPS"]
-                  options[:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE
-                end             # workaround for OpenSSL on Windows...
-#               URI.open(url, **options) do |uf|          # not portable to older versions
-                OpenURI.open_uri(url, **options) do |uf|
-                  s = uf.read
-                  if uf.status[0] != "200"
-                    warn "*** Status code #{status} while fetching #{url}"
-                  else
-                    File.write(fn, s)
+                if $http
+                  begin         # belt and suspenders
+                    get_and_write_resource_persistently(url, fn)
+                  rescue Exception => e
+                    warn "*** Can't get with persistent HTTP: #{e}"
+                    get_and_write_resource(url, fn)
                   end
+                else
+                  get_and_write_resource(url, fn)
                 end
               end
             rescue OpenURI::HTTPError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED,
@@ -730,8 +775,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 +801,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,16 +824,22 @@ 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
+            to_insert.gsub!(%r{target="https?://www.ietf.org/internet-drafts/},
+                            %{target="https://www.ietf.org/archive/id/}) if t == "I-D"
             # this may be a bit controversial: Don't break the build if reference is broken
             if KRAMDOWN_OFFLINE
               unless to_insert

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.3.27
+  version: 1.3.32
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown