kramdown-rfc2629 1.3.2 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cdf03ff424a3911001953ad3890547406acc73568b3f6a3a474b5e0cb2a2ead
-  data.tar.gz: 1b444ffd149931d0bc83a79d94d2eb8862d90f2bd3b4534194928146db6d5939
+  metadata.gz: 6b34bf25043259c59faad1a28e37420d84708298d7d1132954855e9bc9f80469
+  data.tar.gz: 598bdd61e5206c389e32e8014469688f516abf4c3b965fc8c14ddd9f10210d63
 SHA512:
-  metadata.gz: 316a02ae7a37a32c6f875175d38b18d34a2104b812ea6a46889f33e65df84dfcc66458bdfbf26a577fa634766d2d37150ad2b4938b90f3e153cb092457d2a64a
-  data.tar.gz: 4a456d50fe6eed21d68229a2647a4ede87e4e5189c434e2167a02c7a8f1e5b0534dfd2cc0c6aed46262acbc2d9aaa97e67f0082a7088c715f1c9baef7e7ec002
+  metadata.gz: ef912cb94fce48cb61f0a352d9a2b0c701eb9c8149fe46608fdff508f2e974289a777d773a5a95dbc433c7cfbbd667aacf0391b68371aa549baabf75a325890d
+  data.tar.gz: c54c3cc14bdefcbae8a9650522653851af06b9c054ac239eb0555714c85fe5dd14e03fa5d16836c6e12ee83a559ed808c4c4e79d8665592966688f5b6fcba5bd

data/bin/kdrfc

@@ -96,6 +96,9 @@ op = OptionParser.new do |opts|
   opts.on("-x", "--[no-]xml", "Convert to xml only") do |v|
     $options.xml_only = v
   end
+  opts.on("-p", "--[no-]prep", "Convert xml to prepped xml") do |v|
+    $options.prep = v
+  end
   opts.on("-h", "--[no-]html", "Convert to html as well") do |v|
     $options.html = v
   end
@@ -108,6 +111,12 @@ op = OptionParser.new do |opts|
 end
 op.parse!
 
+def process_the_xml(fn, base)
+  process_xml(fn, "#{base}.prepped.xml", "--preptool") if $options.prep
+  process_xml(fn, "#{base}.txt") if $options.txt
+  process_xml(fn, "#{base}.html", "--html") if $options.html
+end
+
 case ARGV.size
 when 1
   fn = ARGV[0]
@@ -116,14 +125,12 @@ when 1
     if $options.xml_only
       warn "*** You already have XML"
     else                        # FIXME: copy/paste
-      process_xml(fn, "#$1.txt") unless $options.xml_only or not $options.txt
-      process_xml(fn, "#$1.html", "--html") unless $options.xml_only or not $options.html
+      process_the_xml(fn, $1)
     end
   when /(.*)\.mk?d\z/
     xml = "#$1.xml"
     process_mkd(fn, xml)
-    process_xml(xml, "#$1.txt") unless $options.xml_only or not $options.txt
-    process_xml(xml, "#$1.html", "--html") unless $options.xml_only or not $options.html
+    process_the_xml(xml, $1) unless $options.xml_only
   else
     warn "Unknown file type: #{fn}"
     exit 1

data/data/kramdown-rfc2629.erb

@@ -43,9 +43,20 @@
     </abstract>
 
 <% sechash.keys.each do |k| -%>
-<%   if k =~ /\Anote_(.*)/ -%>
-
-    <note title="<%= $1.gsub("_", " ")%>">
+<%   if k =~ /\A(to_be_removed_)?note_(.*)/ -%>
+
+<% option = ""
+       text = ""
+       if $1
+         if $options.v3
+           option = " removeInRFC=\"true\""
+         else
+           text = "      <t>[This note is to be removed before publishing as an RFC.]</t>\n"
+         end
+       end
+    -%>
+    <note title="<%= $2.gsub("_", " ")%>"<%= option %>>
+<%= text -%>
 
 <%= sechash.delete(k) -%>
 

data/kramdown-rfc2629.gemspec

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

@@ -150,6 +150,16 @@ module Kramdown
         generate_id(value).gsub(/-+/, '-')
       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='#000000']") { |x| x.attributes["stroke"] = "black" } #; warn x.inspect }
+        REXML::XPath.each(d.root, "//*[@stroke='none']") { |x| x.attributes["stroke"] = nil }  #; warn x.inspect }
+        d.to_s
+      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,12 +204,21 @@ module Kramdown
             end
           end
           case t
-          when "goat"
+          when "goat", "ditaa", "mscgen"
             require 'tempfile'
             file = Tempfile.new("kramdown-rfc")
             file.write(result)
             file.close
-            result1, _s = Open3.capture2("goat #{file.path}", stdin_data: result);
+            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);
+              result1 = svg_clean(result1)
+            when "mscgen"
+              result1, _s = Open3.capture2("mscgen -T svg -i #{file.path} -o -", stdin_data: result);
+              result1 = svg_clean(result1)
+            end
             # warn ["goat:", result1.inspect]
             file.unlink
             result1, _s = Open3.capture2("svgcheck -qa", stdin_data: result1);
@@ -477,7 +496,8 @@ module Kramdown
                   end
                 end
               end
-            rescue OpenURI::HTTPError, SocketError, Timeout::Error => e
+            rescue OpenURI::HTTPError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED,
+                   SocketError, Timeout::Error => e
               warn "*** #{e} while fetching #{url}"
             end
           end
@@ -485,7 +505,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
 
@@ -537,7 +557,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}"
@@ -547,7 +567,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.2
+  version: 1.3.7
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown