kramdown-rfc2629 1.3.29 → 1.3.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e453f1845b6d5384b372a0e934068226afe4d2241c7f0b16bf0bd4efc216ef8
-  data.tar.gz: 9e2d8c085ad1c78a95347843650b5d47f05872108ac7d93a91e6eaad62285e0a
+  metadata.gz: aea9fb4169327aa3629088261ef7ca4f99b6cdc205326d782a8c43d97818f76b
+  data.tar.gz: 1319c3c4e0435633b9dac413c5ed13384a10b245708b8abf55c8c943178ba9e1
 SHA512:
-  metadata.gz: 52d76611fd7500af5b0d688e43b858d0d97a83c0e0cba73ef42d5cb076f922be008fc7c2a053a77bbbf0c11465038891f1c07d823f6d2675918adb5708e4f0d0
-  data.tar.gz: 44aa98da4b6e6d263d77865a7d2335d64320ce4422ecac139c61f5f060acd47781f8bac49197c938e2ccf97dfe4c8ebf23770eaf503cd3422e77b27ce9752002
+  metadata.gz: 79cedc2bf3905da08feafd6a856d67d4f4928cc53d21ed2035b05607e2ce55bf8ec455cb7a94f67afc4296c813b05668d425d5c280a1f0e61b435c611dd66ad8
+  data.tar.gz: e9026c235426738610a9d3d5a4a2a3d803a5afde25714cab72e4012e882cc285e82755d41d3dfe2d89a8456a044c4c7b1fb14e6f53992db93b3b8d1ac1f2ba1d

data/kramdown-rfc2629.gemspec

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

@@ -20,6 +20,7 @@ Kramdown::Parser::Html::Constants::HTML_SPAN_ELEMENTS.concat my_span_elements
 require 'rexml/parsers/baseparser'
 require 'open3'                 # for math
 require 'json'                  # for math
+require 'rexml/document'        # for SVG and bibxml acrobatics
 
 class Object
   def deep_clone
@@ -178,6 +179,18 @@ module Kramdown
 
       # :stopdoc:
 
+      KRAMDOWN_PERSISTENT = ENV["KRAMDOWN_PERSISTENT"]
+      KRAMDOWN_PERSISTENT_VERBOSE = /v/ === 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
 
@@ -281,7 +294,6 @@ COLORS
       end
 
       def svg_clean(s)          # expensive, risky
-        require "rexml/document"
         d = REXML::Document.new(s)
         REXML::XPath.each(d.root, "//*[@shape-rendering]") { |x| x.attributes["shape-rendering"] = nil }  #; warn x.inspect }
         REXML::XPath.each(d.root, "//*[@text-rendering]") { |x| x.attributes["text-rendering"] = nil }  #; warn x.inspect  }
@@ -361,9 +373,12 @@ COLORS
         [result, result1]       # text, svg
       end
 
+      ARTWORK_TYPES = %w(ascii-art binary-art call-flow hex-dump svg)
+
       def convert_codeblock(el, indent, opts)
         # el.attr['anchor'] ||= saner_generate_id(el.value) -- no longer in 1.0.6
         result = el.value
+        gi = el.attr.delete('gi')
         blockclass = el.attr.delete('class')
         if blockclass == 'language-tbreak'
           result = result.lines.map {|line| [line.chomp, 0]}
@@ -390,7 +405,7 @@ COLORS
               if md = cl.match(/\Alanguage-(.*)/)
                 t = artwork_attr["type"] = md[1] # XXX overwrite
               else
-                $stderr.puts "*** Unimplemented block class: #{cl}"
+                $stderr.puts "*** Unimplemented codeblock class: #{cl}"
               end
             end
           end
@@ -399,17 +414,27 @@ COLORS
             result[0,0] = "\n" unless result[0,1] == "\n"
           end
           el.attr.each do |k, v|
-            if md = k.match(/\Aartwork-(.*)/)
+            if md = k.match(/\A(?:artwork|sourcecode)-(.*)/)
               el.attr.delete(k)
               artwork_attr[md[1]] = v
             end
           end
           case t
           when "goat", "ditaa", "mscgen", "plantuml", "plantuml-utxt", "mermaid", "math"
+            if gi
+              warn "*** Can't set GI #{gi} for composite SVG artset"
+            end
             result, result1 = memoize(:svg_tool_process, t, result)
             "#{' '*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)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></artwork></figure>\n"
+            gi ||= (
+              if !$options.v3 || !t || ARTWORK_TYPES.include?(t)
+                "artwork"
+              else
+                "sourcecode"
+              end
+            )
+            "#{' '*indent}<figure#{el_html_attributes(el)}><#{gi}#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></#{gi}></figure>\n"
           end
         end
       end
@@ -682,6 +707,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)" if KRAMDOWN_PERSISTENT_VERBOSE
+      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}"
@@ -695,7 +748,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
@@ -710,18 +763,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,
@@ -739,8 +789,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",
@@ -761,9 +815,12 @@ 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
 
+      KRAMDOWN_NO_TARGETS = ENV['KRAMDOWN_NO_TARGETS']
+
       def convert_img(el, indent, opts) # misuse the tag!
         if a = el.attr
           alt = a.delete('alt').strip
@@ -783,18 +840,46 @@ 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 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
+
+            begin
+              d = REXML::Document.new(to_insert)
+              d.xml_decl.nowrite
+              d.root.attributes["anchor"] = anchor
+              if t == "RFC" or t == "I-D"
+                if KRAMDOWN_NO_TARGETS
+                  d.root.attributes["target"] = nil
+                  REXML::XPath.each(d.root, "/reference/format") { |x|
+                    d.root.delete_element(x)
+                  }
+                else
+                  REXML::XPath.each(d.root, "/reference/format") { |x|
+                    x.attributes["target"].sub!(%r{https?://www.ietf.org/internet-drafts/}, 
+                                                %{https://www.ietf.org/archive/id/}) if t == "I-D"
+                  }
+                end
+              end
+              to_insert = d.to_s
+            rescue Exception => e
+              warn "** Can't manipulate reference XML: #{e}"
+              broken = true
+              to_insert = nil
+            end
             # this may be a bit controversial: Don't break the build if reference is broken
-            if KRAMDOWN_OFFLINE
+            if KRAMDOWN_OFFLINE || broken
               unless to_insert
                 to_insert = "<reference anchor='#{anchor}'> <front> <title>*** BROKEN REFERENCE ***</title> <author> <organization/> </author> <date/> </front> </reference>"
                 warn "*** KRAMDOWN_OFFLINE: Inserting broken reference for #{fn}"
@@ -803,8 +888,7 @@ COLORS
               exit 66 unless to_insert # EX_NOINPUT
             end
           end
-          to_insert.sub(/<\?xml version=["']1.0["'] encoding=["']UTF-8["']\?>/, '')
-            .sub(/\banchor=(?:"[^"]+"|'[^']+')/, "anchor=\"#{anchor}\"")
+          to_insert
         else
           "<xref#{el_html_attributes(el)}>#{alt}</xref>"
         end

metadata

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