kramdown-rfc2629 1.3.5 → 1.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01978871f76d690940f07e334a95f5c062159cefe031b4bb8a716d03ca6d775d'
-  data.tar.gz: 59bd6e3fcb40cf3dbb0e0bb8bf82cd6f85c16468d63e87bf4070876c5e3bf62b
+  metadata.gz: 55399c42e77abc9fd6e071e0e56de872ea053b4d7aa4a4b3d1218570deb3593a
+  data.tar.gz: 0e8358cfaf63d47fe0f5b79de0ebc59809b1163d8cb0c33fd4bbb83116505510
 SHA512:
-  metadata.gz: 1ecb98246f285e547d43c7db6ba7c226236f63fb4cec6b560baf11e6c64b48cf2b388a5ca34a89e7f0389b5237eacdf791ec72706a61bb715e8ef30332493d49
-  data.tar.gz: 27291914e97a7001ff067c52c50b415bea02b2888ecea3288ffdf4907ca1eff0136acb3858d47a971031e391ae0be97ae935dd5b462cf8fdd955503127aa65f2
+  metadata.gz: 7c1ddd9f5c0ca683bd889815050f5979a662561cb599b801b557e9a1df457f6bc97a6118cb826120bcee5a39b6fbe3701c8f922501ae0ec58e64cdd6ca25e3a7
+  data.tar.gz: 1cc42537f1bf204f5257cfe7f71edcde433e5639cbfea83fe55730f61d00c8e8114d7806a9113582a6c68ace85d14a07ec9ccf582de1e8ea9500fb4e64f51414

data/README.md

@@ -281,6 +281,31 @@ special support in XML2RFC), and HTML syntax of course.
 A number of more esoteric features have recently been added.
 (The minimum required version for each full feature is indicated.)
 
+(1.3.x)
+Slowly improving support for SVG generating tools for XML2RFCv3 (i.e.,
+with `-3` flag).
+These tools must be installed and callable from the command line.
+
+The basic idea is to mark an input code block with one of the following
+labels (language types), yielding some plaintext form in the .TXT
+output and a graphical form in the .HTML output.  The plaintext is the
+input in some cases (e.g., ASCII art, `mscgen`), or some plaintext
+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
+* plantuml-utxt: Like plantuml, except that a plantuml-generated
+  plaintext form is used
+* mermaid: Very experimental; the conversion to SVG is prone to
+  generate black-on-black text in this version
+
+Note that this feature does not play well with the CI (continuous
+integration) support in Martin Thomson's [I-D Template][], as that may
+not have the tools installed in its docker instance.
+
 (1.2.9:)
 The YAML header now allows specifying [kramdown_options][].
 

data/bin/doilit

@@ -39,7 +39,7 @@ ARGV.each do |doi|
     warn "*** Usage: doilit [-c] [-v] [-h=handle|-x=xmlhandle] doi..."
     exit 1
   end
-  cite = JSON.parse(open("https://dx.doi.org/#{doi}", ACCEPT_CITE_JSON).read)
+  cite = JSON.parse(URI("https://dx.doi.org/#{doi}").open(ACCEPT_CITE_JSON).read)
   puts cite.to_yaml if $verbose
   lit = {}
   ser = lit["seriesinfo"] = {}

data/bin/kdrfc

@@ -3,6 +3,9 @@ require 'uri'
 require 'net/http'
 require 'open3'
 
+# try to get this from gemspec.
+KDRFC_VERSION=Gem.loaded_specs["kramdown-rfc2629"].version rescue "unknown-version"
+
 def v3_flag?
   $options.v3 ? ["--v3"] : []
 end
@@ -46,16 +49,21 @@ def process_xml_locally(input, output, *flags)
   end
 end
 
+XML2RFC_WEBSERVICE = ENV["KRAMDOWN_XML2RFC_WEBSERVICE"] ||
+                     'http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc-dev.cgi'
+
+
 def process_xml_remotely(input, output)
   warn "* converting remotely from xml #{input} to txt #{output}" if $options.verbose
-  url = URI('http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc.cgi')
+  url = URI(XML2RFC_WEBSERVICE)
   req = Net::HTTP::Post.new(url)
-  req.set_form([["modeAsFormat", "txt/#{"v3" if $options.v3}ascii"],
-                ["type", "binary"],
-                ["input", File.open(input),
-                 {filename: "input.xml",
-                  content_type: "text/plain"}]],
-               'multipart/form-data')
+  form = [["modeAsFormat", "txt/#{"v3" if $options.v3}ascii"],
+          ["type", "binary"],
+          ["input", File.open(input),
+           {filename: "input.xml",
+            content_type: "text/plain"}]]
+  diag = ["url/form: ", url, form].inspect
+  req.set_form(form, 'multipart/form-data')
   res = Net::HTTP::start(url.hostname, url.port,
                          :use_ssl => url.scheme == 'https' ) {|http|
     http.request(req)
@@ -69,12 +77,12 @@ def process_xml_remotely(input, output)
       end
       warn "* #{output} written" if $options.verbose
     else
-      warn "*** HTTP response has unexpected content_type #{res.content_type} with status #{res.code}"
+      warn "*** HTTP response has unexpected content_type #{res.content_type} with status #{res.code}, #{diag}"
       warn res.body
       exit 1
     end
   else
-    warn "*** HTTP response: #{res.code}"
+    warn "*** HTTP response: #{res.code}, #{diag}"
     exit 1
   end
 end
@@ -85,8 +93,18 @@ require 'ostruct'
 $options = OpenStruct.new
 $options.txt = true             # default
 op = OptionParser.new do |opts|
-  opts.banner = "Usage: kdrfc [options] file.md|file.mkd|file.xml"
-
+  opts.banner = <<BANNER
+Usage: kdrfc [options] file.md|file.mkd|file.xml
+Version: #{KDRFC_VERSION}
+BANNER
+  opts.on("-V", "--version", "Show version and exit") do |v|
+    puts "kdrfc, from kramdown-rfc2629 #{KDRFC_VERSION}"
+    exit
+  end
+  opts.on("-H", "--help", "Show option summary and exit") do |v|
+    puts opts
+    exit
+  end
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     $options.verbose = v
   end

data/bin/kramdown-rfc2629

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby2.1
+#!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
 require 'kramdown-rfc2629'
 require 'kramdown-rfc/parameterset'
@@ -7,6 +7,9 @@ require 'yaml'
 require 'erb'
 require 'date'
 
+# try to get this from gemspec.
+KDRFC_VERSION=Gem.loaded_specs["kramdown-rfc2629"].version rescue "unknown-version"
+
 Encoding.default_external = "UTF-8" # wake up, smell the coffee
 
 def boilerplate(key)
@@ -287,8 +290,18 @@ require 'ostruct'
 
 $options = OpenStruct.new
 op = OptionParser.new do |opts|
-  opts.banner = "Usage: kramdown-rfc2629 [options] file.md|file.mkd > file.xml"
-
+  opts.banner = <<BANNER
+Usage: kramdown-rfc2629 [options] file.md|file.mkd > file.xml
+Version: #{KDRFC_VERSION}
+BANNER
+  opts.on("-V", "--version", "Show version and exit") do |v|
+    puts "kramdown-rfc2629 #{KDRFC_VERSION}"
+    exit
+  end
+  opts.on("-H", "--help", "Show option summary and exit") do |v|
+    puts opts
+    exit
+  end
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     $options.verbose = v
   end

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.3.5'
+  s.version = '1.3.10'
   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,6 @@ spec = Gem::Specification.new do |s|
   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)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc2629', 'doilit', 'kramdown-rfc-extract-markdown', 'kdrfc']
-  s.default_executable = 'kramdown-rfc2629'
   s.required_ruby_version = '>= 2.3.0'
   # s.requirements = 'wget'
   #  s.has_rdoc = true

data/lib/kramdown-rfc2629.rb

@@ -150,6 +150,110 @@ module Kramdown
         generate_id(value).gsub(/-+/, '-')
       end
 
+      SVG_COLORS = Hash.new {|h, k| k}
+      <<COLORS.each_line {|l| k, v = l.chomp.split; SVG_COLORS[k] = v}
+black	#000000
+silver	#C0C0C0
+gray	#808080
+white	#FFFFFF
+maroon	#800000
+red	#FF0000
+purple	#800080
+fuchsia	#FF00FF
+green	#008000
+lime	#00FF00
+olive	#808000
+yellow	#FFFF00
+navy	#000080
+blue	#0000FF
+teal	#008080
+aqua	#00FFFF
+COLORS
+
+      def svg_munch_id(id)
+        id.gsub(/[^-._A-Za-z0-9]/) {|x| "_%02X" % x.ord}
+      end
+
+      def self.hex_to_lin(h)
+        h.to_i(16)**2.22        # approximating sRGB gamma
+      end
+      define_method :hex_to_lin, &method(:hex_to_lin)
+
+      B_W_THRESHOLD = hex_to_lin("a4") # a little brighter than 1/2 0xFF -> white
+
+      def svg_munch_color(c, fill)
+        c = SVG_COLORS[c]
+        case c
+        when /\A#(..)(..)(..)\z/
+          if hex_to_lin($1)*0.2126 + hex_to_lin($2)*0.7152 + hex_to_lin($3)*0.0722 >= B_W_THRESHOLD
+            'white'
+          else
+            'black'
+          end
+        when 'none'
+          'none' if fill        # delete for stroke
+        else
+          c
+        end
+      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  }
+        REXML::XPath.each(d.root, "//*[@stroke]") { |x| x.attributes["stroke"] = svg_munch_color(x.attributes["stroke"], false) }
+        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"] }
+        d.to_s
+      end
+
+      def memoize(meth, *args)
+        require 'digest'
+        Dir.mkdir(REFCACHEDIR) unless Dir.exists?(REFCACHEDIR)
+        kdrfc_version = Gem.loaded_specs["kramdown-rfc2629"].version.to_s.gsub('.', '_') rescue "UNKNOWN"
+        fn = "#{REFCACHEDIR}/kdrfc-#{kdrfc_version}-#{meth}-#{Digest::SHA256.hexdigest(Marshal.dump(args))[0...40]}.cache"
+        begin
+          out = Marshal.load(File.binread(fn))
+        rescue StandardError => e
+          # warn e.inspect
+          out = method(meth).call(*args)
+          File.binwrite(fn, Marshal.dump(out))
+        end
+        out
+      end
+
+      def svg_tool_process(t, result)
+        require 'tempfile'
+        file = Tempfile.new("kramdown-rfc")
+        file.write(result)
+        file.close
+        case t
+        when "goat"
+          result1, _s = Open3.capture2("goat #{file.path}", stdin_data: result);
+        when "ditaa"        # XXX: This needs some form of option-setting
+          result1, _s = Open3.capture2("ditaa #{file.path} --svg -o -", stdin_data: result);
+        when "mscgen"
+          result1, _s = Open3.capture2("mscgen -T svg -i #{file.path} -o -", stdin_data: result);
+        when "mermaid"
+          result1, _s = Open3.capture2("mmdc -i #{file.path}", stdin_data: result); #  -b transparent
+          outpath = file.path + ".svg"
+          result1 = File.read(outpath)
+          File.unlink(outpath)
+        when "plantuml", "plantuml-utxt"
+          plantuml = "@startuml\n#{result}\n@enduml"
+          result1, _s = Open3.capture2("plantuml -pipe -tsvg", stdin_data: plantuml);
+          result, _s = Open3.capture2("plantuml -pipe -tutxt", stdin_data: plantuml) if t == "plantuml-utxt"
+        end
+        # warn ["goat:", result1.inspect]
+        file.unlink
+        result1 = svg_clean(result1) unless t == "goat"
+        result1, _s = Open3.capture2("svgcheck -qa", stdin_data: result1);
+        # warn ["svgcheck:", result1.inspect]
+        [result, result1]
+      end
+
       def convert_codeblock(el, indent, opts)
         # el.attr['anchor'] ||= saner_generate_id(el.value) -- no longer in 1.0.6
         result = el.value
@@ -194,16 +298,8 @@ module Kramdown
             end
           end
           case t
-          when "goat"
-            require 'tempfile'
-            file = Tempfile.new("kramdown-rfc")
-            file.write(result)
-            file.close
-            result1, _s = Open3.capture2("goat #{file.path}", stdin_data: result);
-            # warn ["goat:", result1.inspect]
-            file.unlink
-            result1, _s = Open3.capture2("svgcheck -qa", stdin_data: result1);
-            # warn ["svgcheck:", result1.inspect]
+          when "goat", "ditaa", "mscgen", "plantuml", "plantuml-utxt", "mermaid"
+            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"
@@ -486,7 +582,7 @@ module Kramdown
         begin
           File.read(fn) # this blows up if no cache available after fetch attempt
         rescue Errno::ENOENT => e
-          warn "*** #{e} for ${fn}"
+          warn "*** #{e} for #{fn}"
         end
       end
 
@@ -538,7 +634,7 @@ module Kramdown
             fn = "reference.#{t}.#{n}.xml"
             sub, ttl, can_anchor = XML_RESOURCE_ORG_MAP[t]
             ttl ||= KRAMDOWN_REFCACHETTL  # everything but RFCs might change a lot
-            puts "Huh: ${fn}" unless sub
+            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}"
@@ -548,7 +644,10 @@ module Kramdown
             to_insert.scrub! rescue nil # only do this for Ruby >= 2.1
             # this may be a bit controversial: Don't break the build if reference is broken
             if KRAMDOWN_OFFLINE
-              to_insert ||= "<reference anchor='#{anchor}'> <front> <title>*** BROKEN REFERENCE ***</title> <author> <organization/> </author> <date/> </front> </reference>"
+              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}"
+              end
             else
               exit 66 unless to_insert # EX_NOINPUT
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.10
 platform: ruby
 authors:
 - Carsten Bormann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-19 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -67,7 +67,7 @@ homepage: http://github.com/cabo/kramdown-rfc2629
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.
 test_files: []