kramdown-rfc2629 1.3.31 → 1.3.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286d2a372490fa260547c5a4bf637105047bcb9c855c2e705488f133cb007064
-  data.tar.gz: 995c3dfb713b13495106130e48334d08ab8ca4f2cbbba77d8b71c2a34975a5bf
+  metadata.gz: 1a7a8c78c412d9bf4830f3335bba088f220a983e391057bdf90cad5d716d2d2f
+  data.tar.gz: 8fbac5333fb0e14e732aac23ba11b9a110fe8ca9948e6aa89ce953e88c95a193
 SHA512:
-  metadata.gz: 24403a2dbc66d9e03a6029df76b3e668679e07c56297142c46bf7b19cc1424b55b84beae56a6376d8098230b02278fd66d159746e513d523ea1b5fc71daaa705
-  data.tar.gz: e6706b1f539574aa7c6d324dc0d91a6b9431eba200070244f87410b064576e9f44c180a68cb7d0840db6aa0f90569944866c123346f2b5f9c792b0aba729293a
+  metadata.gz: 889c151d93059ebd22e6adb9b7bc295206056c70ae69adab2c300b736c9b3037d7a7ec1af865ff7aeba29af5a4d3ab82525aebbd1bcddb8fb9f8ad2b9ba5c0af
+  data.tar.gz: 9e067408ad82182fb0ae4f0461b0e47db3888d3839b6a1e2915333fd1acffa34c783b8a7185ebe8afdb56a64a89854638de1c1d6a2c781aa95c4c093e58793fb

data/bin/kramdown-rfc-cache-i-d-bibxml

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# prerequisite:
+# gem install net-http-persistent
+#
+# dumps all bibxml for current, "Active" I-Ds in cache
+# reasonably efficient after initial call if the output is retained
+#
+# requires Ruby 2.4 or above because of "liberal_parsing" option
+#
+# uses ENV["KRAMDOWN_REFCACHEDIR"] for where you want to have your bibxml3 data
+#
+
+require 'csv'
+require 'fileutils'
+
+begin
+  require 'net/http/persistent'
+rescue
+  warn "*** please install net-http-persistent:"
+  warn "   gem install net-http-persistent"
+  warn "(prefix by sudo only if required)."
+  exit 72                       # EX_OSFILE
+end
+
+
+TARGET_DIR = ENV["KRAMDOWN_REFCACHEDIR"] || (
+  path = File.expand_path("~/.cache/xml2rfc")
+  warn "*** set environment variable KRAMDOWN_REFCACHEDIR to #{path} to actually use the cache"
+  path
+)
+
+FileUtils.mkdir_p(TARGET_DIR)
+FileUtils.chdir(TARGET_DIR)
+
+$http = Net::HTTP::Persistent.new name: 'allid'
+
+KRAMDOWN_PERSISTENT_VERBOSE = true
+
+      def get_and_write_resource_persistently(url, fn, age_verbose=false)
+        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 "#{url} -> #{fn} (#{"%.3f" % (t2 - t1)} s)" if KRAMDOWN_PERSISTENT_VERBOSE
+        if age_verbose
+          if age = response.get_fields("age")
+            warn "(working from a web cache, index is #{age.first} seconds stale)"
+          end
+        end
+      end
+
+CLEAR_RET = "\e[K\r" # XXX all the world is ECMA-48 (ISO 6429), no?
+
+      def noisy(name)
+        print "#{name}...#{CLEAR_RET}"
+      end
+      def clear_noise
+        print CLEAR_RET
+      end
+
+ALL_ID2_SOURCE = "https://www.ietf.org/id/all_id2.txt"
+ALL_ID2_COPY = ".all_id2.txt"
+
+get_and_write_resource_persistently(ALL_ID2_SOURCE, ALL_ID2_COPY, true) unless ENV["KRAMDOWN_DONT_REFRESH_ALL_ID2"]
+ix = File.read(ALL_ID2_COPY).lines.grep_v(/^#/).join
+
+csv = CSV.new(ix, col_sep: "\t", liberal_parsing: true)
+
+drafts = csv.read
+active = drafts.select { |d| d[2] == "Active" }
+active_names = active.map { |a| a[0] }
+puts "#{active_names.size} active drafts"
+
+active_names.each do |name|
+  if name =~ /\Adraft-(.*)-(\d\d)\z/
+    namepart = $1
+    version = $2
+    name0 = "reference.I-D.#{namepart}.xml"
+    noisy(name0) if File.exists?(name0)
+    name1 = "reference.I-D.draft-#{namepart}-#{version}.xml"
+    if File.exists?(name1)
+      noisy(name1)
+      FileUtils.touch(name0)    # because name1 already exists, we believe name0 is fresh
+    else
+      begin
+        url0 = "https://datatracker.ietf.org/doc/bibxml3/draft-#{namepart}/xml"
+        get_and_write_resource_persistently(url0, name0) # get name0 first
+        url1 = "https://datatracker.ietf.org/doc/bibxml3/draft-#{namepart}-#{version}/xml"
+        get_and_write_resource_persistently(url1, name1) # then name1 to mark this as updated
+      rescue => e
+        warn "*** #{name0}: #{e}"
+      end
+    end
+  else
+    warn "*** Malformed draft name: #{name}"
+  end
+end
+clear_noise

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.31'
+  s.version = '1.3.36'
   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.}
@@ -9,7 +9,8 @@ spec = Gem::Specification.new do |s|
   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']
+  s.executables = ['kramdown-rfc2629', 'doilit', 'kramdown-rfc-extract-markdown',
+                   'kdrfc', 'kramdown-rfc-cache-i-d-bibxml']
   s.required_ruby_version = '>= 2.3.0'
   # s.requirements = 'wget'
   #  s.has_rdoc = true

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_attr["align"]
+                "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}"
@@ -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,
@@ -769,6 +819,8 @@ COLORS
 
       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
@@ -788,7 +840,7 @@ 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, altproc = 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
             if altproc && !KRAMDOWN_USE_TOOLS_SERVER
@@ -802,10 +854,32 @@ COLORS
             # 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"
+
+            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}"
@@ -814,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.31
+  version: 1.3.36
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -61,6 +61,7 @@ executables:
 - doilit
 - kramdown-rfc-extract-markdown
 - kdrfc
+- kramdown-rfc-cache-i-d-bibxml
 extensions: []
 extra_rdoc_files: []
 files:
@@ -68,6 +69,7 @@ files:
 - README.md
 - bin/doilit
 - bin/kdrfc
+- bin/kramdown-rfc-cache-i-d-bibxml
 - bin/kramdown-rfc-extract-markdown
 - bin/kramdown-rfc2629
 - data/encoding-fallbacks.txt