kramdown-rfc2629 1.3.28 → 1.3.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6818d86a47ba8a06c199cdbca16a30644b06c4bb517fc7a5a5a35d93161a0e6
-  data.tar.gz: cb90602fd0b11b2e010200ffc4fac1727cd0aa446d2e59e5861d4fcd6b1cf579
+  metadata.gz: 7b532912e56847cec71ed5c419ea08af4d19d3f6c7a4d91edffbfaa3005dd37f
+  data.tar.gz: 6dbf519c9eadbddb50a07f6b1cef88cdcc9d877a5f66614ececf6bf5bc2d3353
 SHA512:
-  metadata.gz: b2c6ca51eaf892fb8b52c4bf115a82830deb1df21afcc0fb28c58eabbe273b727872be851d5e858c1018ce97e3ee5b8e7464086d4652a17af2f1144dda5f86a4
-  data.tar.gz: fb3125ce8ee03845999ad6f7e09cc9047ee4f4f3406da987c6a1458c0a4de65d0c2d590f62d02c516aa1d3de4d71e21660d33313fbf370452d57ee98d0a472ee
+  metadata.gz: 0f7f9faf79c570a7bcca633aef94a6f27d997d861eca1ecad0855795eef44728d925cc1d1b7751454b6c122168d12ef4f341b4ed350d8aeb9247b53e13d523ba
+  data.tar.gz: 2dcdb7cf588bd99e8e983b71eefbbb0a2aec8785f466abe8e83f6b7ea40061aecea69abe6466d94d2dc69c019dd798a0569e5ed66b65efc42bf76d448ef45778

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.28'
+  s.version = '1.3.33'
   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  }
@@ -682,6 +694,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 +735,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 +750,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 +776,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 +802,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 +827,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 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
+
+            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 +875,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.28
+  version: 1.3.33
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown