kramdown-rfc2629 1.3.33 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b532912e56847cec71ed5c419ea08af4d19d3f6c7a4d91edffbfaa3005dd37f
-  data.tar.gz: 6dbf519c9eadbddb50a07f6b1cef88cdcc9d877a5f66614ececf6bf5bc2d3353
+  metadata.gz: e810a295696230d06daa18981cff3c92ad0913175b717027788ee41351d4df6f
+  data.tar.gz: 5d5db17408cc47211883b0d95071139d47fb7fd8d8391cb9eff59217e81c330d
 SHA512:
-  metadata.gz: 0f7f9faf79c570a7bcca633aef94a6f27d997d861eca1ecad0855795eef44728d925cc1d1b7751454b6c122168d12ef4f341b4ed350d8aeb9247b53e13d523ba
-  data.tar.gz: 2dcdb7cf588bd99e8e983b71eefbbb0a2aec8785f466abe8e83f6b7ea40061aecea69abe6466d94d2dc69c019dd798a0569e5ed66b65efc42bf76d448ef45778
+  metadata.gz: 30d01f719beb7b67932396d4e28f6e1c4f9446029e04555706089e33615c305a673443922927136dad47f974c5c45cd871655a778c97347fa40a6f5454df7970
+  data.tar.gz: ef7be0d8a0b914f67a871e813533ad5eee7280bb31d67047d688ddf164ce124763653980b6c097f4be596be4211d32062efae15e5726d90618aca709cc63a462

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

@@ -108,6 +108,13 @@
        aups = KramdownRFC::authorps_from_hash(au)
    -%>
 <%= KramdownRFC::person_element_from_aups("contact", aups) -%>
+<%= if contrib = aups["contribution"]
+    <<CONTRIBUTION
+{:/nomarkdown}
+#{contrib}
+{::nomarkdown}
+CONTRIBUTION
+    end -%>
 <%   aups.warn_if_leftovers  -%>
 <%   end -%>
 <% end -%>

data/kramdown-rfc2629.gemspec

@@ -1,15 +1,16 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.33'
+  s.version = '1.4.1'
   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('kramdown', '~> 2.3.0')
   s.add_dependency('certified', '~> 1.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']
+  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

@@ -12,7 +12,7 @@ require 'shellwords'
 
 raise "sorry, 1.8 was last decade" unless RUBY_VERSION >= '1.9'
 
-gem 'kramdown', '~> 1.17.0'
+gem 'kramdown', '~> 2.3.0'
 require 'kramdown'
 my_span_elements =  %w{list figure xref eref iref cref spanx vspace}
 Kramdown::Parser::Html::Constants::HTML_SPAN_ELEMENTS.concat my_span_elements
@@ -38,6 +38,8 @@ module Kramdown
         super
         @span_parsers.unshift(:xref)
         @span_parsers.unshift(:iref)
+        @span_parsers.unshift(:span_pi)
+        @block_parsers.unshift(:block_pi)
       end
 
       SECTIONS_RE = /Section(?:s (?:[\w.]+, )*[\w.]+,? and)? [\w.]+/
@@ -112,7 +114,7 @@ module Kramdown
         end
         @tree.children << el
       end
-      define_parser(:xref, XREF_START, '{{')
+      define_parser(:xref, XREF_START, '\{\{')
 
       IREF_START = /\(\(\((.*?)\)\)\)/u
 
@@ -125,6 +127,40 @@ module Kramdown
       end
       define_parser(:iref, IREF_START, '\(\(\(')
 
+      # HTML_INSTRUCTION_RE = /<\?(.*?)\?>/m    # still defined!
+
+      # warn [:OPT_SPACE, OPT_SPACE, HTML_INSTRUCTION_RE].inspect
+
+      PI_BLOCK_START = /^#{OPT_SPACE}<\?/u
+
+      def parse_block_pi
+        # warn [:BLOCK].inspect
+        line = @src.current_line_number
+        if (result = @src.scan(HTML_INSTRUCTION_RE))
+          @tree.children << Element.new(:xml_pi, result, nil, category: :block, location: line)
+          @src.scan(TRAILING_WHITESPACE)
+          true
+        else
+          false
+        end
+      end
+      define_parser(:block_pi, PI_BLOCK_START)
+
+      PI_SPAN_START = /<\?/u
+
+      def parse_span_pi
+        # warn [:SPAN].inspect
+        line = @src.current_line_number
+        if (result = @src.scan(HTML_INSTRUCTION_RE))
+          @tree.children << Element.new(:xml_pi, result, nil, category: :span, location: line)
+        else
+          add_text(@src.getch)
+        end
+      end
+      define_parser(:span_pi, PI_SPAN_START, '<\?')
+
+      # warn [:HERE, @@parsers.keys].inspect
+
     end
   end
 
@@ -373,9 +409,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]}
@@ -402,7 +441,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
@@ -411,17 +450,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.3.33
+  version: 1.4.1
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: certified
   requirement: !ruby/object:Gem::Requirement
@@ -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