kramdown-rfc2629 1.4.9 → 1.4.14.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be8093af3b860dba2fe1389dd720da6f34206ff112e84dcca98dd35ad200a07
-  data.tar.gz: 2772970e704ad1bcea1930602e3b7f2e21cfe34a5bcdde3e1fdd0e2a71722bcf
+  metadata.gz: eae0eb8f4dd2fc504dae8740508bde5266b9e914780999977d1633d16537a1aa
+  data.tar.gz: f373cfb67d09360f2d79480acca773d3f8af0454e643600406e845a4ffb8072f
 SHA512:
-  metadata.gz: 8feb2ef692ca46abe03f14dbfd34cce993856e03cb3eb2fa105db0c16766c931992facdcf6affbc0a164c6b48e3abe5110f2f76118c394c652d4c2bdff530769
-  data.tar.gz: 5fab2d82e41c88603abbe33224a763534d0920da3751529b01110b885dec060564a4431bd4617360427cc1ef6aaac4b5375888ec2387983b62daabad1fb6822e
+  metadata.gz: 88e3ed1e8713e1cf2ba6ceb4dd3aff3b83ab3397339edc83a9230fab5a2ac716a133be9acfd22a0a9bde793e8fecb709976f04285bfd0ebb09dec3c005fd3a1a
+  data.tar.gz: 8fe774e5ee8ab20885472f2a30fe5c65aab4ea56d80f7e4e334af25a4997a927fca85afd289b78d9088273822385b5ab96f15b0536657b4775516acb62fb049e

data/bin/kramdown-rfc2629

@@ -14,21 +14,29 @@ Encoding.default_external = "UTF-8" # wake up, smell the coffee
 
 def boilerplate(key)
   case key.downcase
-  when /\Abcp14(\+)?(-tagged)?\z/i
-    ret = <<RFC8174
+  when /\Abcp14(info)?(\+)?(-tagged)?\z/i
+    ret = ''
+    if $1
+      ret << <<RFC8174ise
+Although this document is not an IETF Standards Track publication, it
+adopts the conventions for normative language to provide clarity of
+instructions to the implementer.
+RFC8174ise
+    end
+    ret << <<RFC8174
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
 "MAY", and "OPTIONAL" in this document are to be interpreted as
 described in BCP 14 {{!RFC2119}} {{!RFC8174}} when, and only when, they
 appear in all capitals, as shown here.
 RFC8174
-    if $1
+    if $2
       ret << <<PLUS
 These words may also appear in this document in
 lower case as plain English words, absent their normative meanings.
 PLUS
     end
-    if $2
+    if $3
       if $options.v3
         ret << <<TAGGED
 
@@ -83,15 +91,75 @@ NORMINFORM = { "!" => :normative, "?" => :informative }
 
 def yaml_load(input, *args)
   if YAML.respond_to?(:safe_load)
-    YAML.safe_load(input, *args)
+    begin
+      YAML.safe_load(input, *args)
+    rescue ArgumentError
+      YAML.safe_load(input, permitted_classes: args[0], permitted_symbols: args[1], aliases: args[2])
+    end
   else
     YAML.load(input)
- end
+  end
+end
+
+def process_kramdown_options(coding_override = nil,
+                             smart_quotes = nil, typographic_symbols = nil,
+                             header_kramdown_options = nil)
+
+  ascii_target = coding_override && coding_override =~ /ascii/
+  suppress_typography = ascii_target || $options.v3
+  entity_output = ascii_target ? :numeric : :as_char;
+
+  options = {input: 'RFC2629Kramdown', entity_output: entity_output, link_defs: {}}
+
+  if smart_quotes.nil? && suppress_typography
+    smart_quotes = false
+  end
+  if smart_quotes == false
+    smart_quotes = ["'".ord, "'".ord, '"'.ord, '"'.ord]
+  end
+  case smart_quotes
+  when Array
+    options[:smart_quotes] = smart_quotes
+  when nil, true
+    # nothin
+  else
+    warn "*** Can't deal with smart_quotes value #{smart_quotes.inspect}"
+  end
+
+  if typographic_symbols.nil? && suppress_typography
+    typographic_symbols = false
+  end
+  if typographic_symbols == false
+    typographic_symbols = Hash[::Kramdown::Parser::Kramdown::TYPOGRAPHIC_SYMS.map { |k, v|
+                                 if Symbol === v
+                                   [v.intern, k]
+                                 end
+                               }.compact]
+  end
+  # warn [:TYPOGRAPHIC_SYMBOLS, typographic_symbols].to_yaml
+  case typographic_symbols
+  when Hash
+    options[:typographic_symbols] = typographic_symbols
+  when nil, true
+    # nothin
+  else
+    warn "*** Can't deal with typographic_symbols value #{typographic_symbols.inspect}"
+  end
+
+  if header_kramdown_options
+    options.merge! header_kramdown_options
+  end
+
+  $global_markdown_options = options   # For nested calls in bibref annotation processing and xref text
+
+  options
 end
 
 XREF_SECTIONS_RE = ::Kramdown::Parser::RFC2629Kramdown::SECTIONS_RE
 XSR_PREFIX = "#{XREF_SECTIONS_RE} of "
-XSR_SUFFIX = ", (#{XREF_SECTIONS_RE})| \((#{XREF_SECTIONS_RE})\)"
+XSR_SUFFIX = ", (#{XREF_SECTIONS_RE})| \\((#{XREF_SECTIONS_RE})\\)"
+XREF_TXT = ::Kramdown::Parser::RFC2629Kramdown::XREF_TXT
+XREF_TXT_SUFFIX = " \\(#{XREF_TXT}\\)"
 
 def spacify_re(s)
   s.gsub(' ', '[\u00A0\s]+')
@@ -113,10 +181,15 @@ def xml_from_sections(input)
   # We put back the "---" plus gratuitous blank lines to hack the line number in errors
   yaml_in = input[/---\s*/] << sections.shift[2]
   ps = KramdownRFC::ParameterSet.new(yaml_load(yaml_in, [Date], [], true))
+
   coding_override = ps.has(:coding)
   smart_quotes = ps[:smart_quotes]
   typographic_symbols = ps[:typographic_symbols]
-  kramdown_options = ps[:kramdown_options]
+  header_kramdown_options = ps[:kramdown_options]
+
+  kramdown_options = process_kramdown_options(coding_override,
+                                              smart_quotes, typographic_symbols,
+                                              header_kramdown_options)
 
   # all the other sections are put in a Hash, possibly concatenated from parts there
   sechash = Hash.new{ |h,k| h[k] = ""}
@@ -169,6 +242,8 @@ def xml_from_sections(input)
     v.gsub!(/{{(#{
       spacify_re(XSR_PREFIX)
     })?(?:([?!])(-)?|(-))([\w._\-]+)(?:=([\w.\/_\-]+))?(#{
+      XREF_TXT_SUFFIX
+    })?(#{
       spacify_re(XSR_SUFFIX)
     })?}}/) do |match|
       xsr_prefix = $1
@@ -176,7 +251,8 @@ def xml_from_sections(input)
       replacing = $3 || $4
       word = $5
       bibref = $6
-      xsr_suffix = $7
+      xrt_suffix = $7
+      xsr_suffix = $8
       if replacing
         if new = ref_replacements[word]
           word = new
@@ -200,7 +276,7 @@ def xml_from_sections(input)
       if norminform
         norm_ref[word] ||= norminform == '!' # one normative ref is enough
       end
-      "{{#{xsr_prefix}#{word}#{xsr_suffix}}}"
+      "{{#{xsr_prefix}#{word}#{xrt_suffix}#{xsr_suffix}}}"
     end
   end
 
@@ -226,13 +302,12 @@ def xml_from_sections(input)
   end
 
   stand_alone = ps[:stand_alone]
-  link_defs = {}
 
   [:normative, :informative].each do |sn|
     if refs = ps[sn]
       refs.each do |k, v|
         href = k.gsub(/\A[0-9]/) { "_#{$&}" } # can't start an IDREF with a number
-        link_defs[k] = ["##{href}", nil]            # allow [RFC2119] in addition to {{RFC2119}}
+        kramdown_options[:link_defs][k] = ["##{href}", nil]   # allow [RFC2119] in addition to {{RFC2119}}
 
         bibref = anchor_to_bibref[k] || k
         bts, url = bibtagsys(bibref, k, stand_alone)
@@ -253,8 +328,6 @@ def xml_from_sections(input)
           if bts && !v.delete("override")
             warn "*** warning: explicit settings completely override canned bibxml in reference #{k}"
           end
-          options = {input: 'RFC2629Kramdown', entity_output: coding_override, link_defs: link_defs}
-          $global_markdown_options = options # For recursive calls in bibref annotation processing.
           sechash[sn.to_s] << KramdownRFC::ref_to_xml(k, v)
         end
       end
@@ -272,7 +345,7 @@ def xml_from_sections(input)
     warn "*** sections left #{sechash.keys.inspect}!"
   end
 
-  [input, coding_override, link_defs, smart_quotes, typographic_symbols, kramdown_options]
+  [input, kramdown_options, coding_override]
 end
 
 XML_RESOURCE_ORG_PREFIX = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_PREFIX
@@ -354,7 +427,6 @@ if $options.verbose && $options.v3
   warn "*** not much RFCXMLv3 stuff implemented yet"
 end
 
-coding_override = :as_char
 input = ARGF.read
 if input[0] == "\uFEFF"
    warn "*** There is a leading byte order mark. Ignored."
@@ -375,59 +447,18 @@ if input =~ /[\t]/
    input = expand_tabs(input)
 end
 
-link_defs = {}
 if input =~ /\A---/        # this is a sectionized file
   do_the_tls_dance unless ENV["KRAMDOWN_DONT_VERIFY_HTTPS"]
-  input, target_coding, link_defs, smart_quotes, typographic_symbols, kramdown_options = xml_from_sections(input)
+  input, options, coding_override = xml_from_sections(input)
+else
+  options = process_kramdown_options # all default
 end
 if input =~ /\A<\?xml/          # if this is a whole XML file, protect it
   input = "{::nomarkdown}\n#{input}\n{:/nomarkdown}\n"
 end
-options = {input: 'RFC2629Kramdown', entity_output: coding_override, link_defs: link_defs}
-if smart_quotes.nil?
-  if (target_coding && target_coding =~ /ascii/) || $options.v3
-     smart_quotes = false
-  end
-end
-if smart_quotes == false
-  smart_quotes = ["'".ord, "'".ord, '"'.ord, '"'.ord]
-end
-case smart_quotes
-when Array
-  options[:smart_quotes] = smart_quotes
-when nil, true
-  # nothin
-else
-  warn "*** Can't deal with smart_quotes value #{smart_quotes.inspect}"
-end
-if typographic_symbols.nil?
-  if (target_coding && target_coding =~ /ascii/) || $options.v3
-     typographic_symbols = false
-  end
-end
-if typographic_symbols == false
-  typographic_symbols = Hash[::Kramdown::Parser::Kramdown::TYPOGRAPHIC_SYMS.map { |k, v|
-                               if Symbol === v
-                                 [v.intern, k]
-                               end
-                             }.compact]
-end
-# warn [:TYPOGRAPHIC_SYMBOLS, typographic_symbols].to_yaml
-case typographic_symbols
-when Hash
-  options[:typographic_symbols] = typographic_symbols
-when nil, true
-  # nothin
-else
-  warn "*** Can't deal with typographic_symbols value #{typographic_symbols.inspect}"
-end
-
-if kramdown_options
-  options.merge! kramdown_options
-end
 
-if target_coding
-  input = input.encode(Encoding.find(target_coding), fallback: FALLBACK)
+if coding_override
+  input = input.encode(Encoding.find(coding_override), fallback: FALLBACK)
 end
 
 # warn "options: #{options.inspect}"

data/kramdown-rfc2629.gemspec

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

@@ -363,6 +363,19 @@ COLORS
         end
       end
 
+      def svg_clean_kgt(s)
+        d = REXML::Document.new(s)
+        REXML::XPath.each(d.root, "//rect|//line|//path") do |x|
+          x.attributes["fill"] = "none"
+          x.attributes["stroke"] = "black"
+          x.attributes["stroke-width"] = "1.5"
+        end
+        d.to_s
+      rescue => detail
+        warn "*** Can't clean SVG: #{detail}"
+        d
+      end
+
       def svg_clean(s)          # expensive, risky
         d = REXML::Document.new(s)
         REXML::XPath.each(d.root, "//*[@shape-rendering]") { |x| x.attributes["shape-rendering"] = nil }  #; warn x.inspect }
@@ -407,9 +420,12 @@ COLORS
         file = Tempfile.new("kramdown-rfc")
         file.write(result)
         file.close
+        dont_clean = false
+        dont_check = false
         case t
         when "goat"
           result1, err, _s = Open3.capture3("goat #{file.path}", stdin_data: result);
+          dont_clean = true
         when "ditaa"        # XXX: This needs some form of option-setting
           result1, err, _s = Open3.capture3("ditaa #{file.path} --svg -o -", stdin_data: result);
         when "mscgen"
@@ -424,18 +440,27 @@ COLORS
           result1, err, _s = Open3.capture3("plantuml -pipe -tsvg", stdin_data: plantuml);
           result, err1, _s = Open3.capture3("plantuml -pipe -tutxt", stdin_data: plantuml) if t == "plantuml-utxt"
           err << err1.to_s
+        when "railroad", "railroad-utf8"
+          result1, err1, _s = Open3.capture3("kgt -l abnf -e svg", stdin_data: result);
+          result1 = svg_clean_kgt(result1); dont_clean = true
+          result, err, _s = Open3.capture3("kgt -l abnf -e rr#{t == "railroad" ? "text" : "utf8"}",
+                                            stdin_data: result);
+          err << err1.to_s
         when "math"
           result1, err, _s = Open3.capture3("tex2svg --font STIX --speech=false #{Shellwords.escape(' ' << result)}");
           result, err1, _s = Open3.capture3("asciitex -f #{file.path}")
           err << err1
         end
         capture_croak(t, err)
-        # warn ["goat:", result1.inspect]
+        # warn ["text:", result.inspect]
+        # warn ["svg:", result1.inspect]
         file.unlink
-        result1 = svg_clean(result1) unless t == "goat"
-        result1, err, _s = Open3.capture3("svgcheck -Xqa", stdin_data: result1);
-        capture_croak("svgcheck", err)
-        # warn ["svgcheck:", result1.inspect]
+        result1 = svg_clean(result1) unless dont_clean
+        unless dont_check
+          result1, err, _s = Open3.capture3("svgcheck -Xqa", stdin_data: result1);
+          # warn ["svgcheck:", result1.inspect]
+          capture_croak("svgcheck", err)
+        end
         if result1 == ''
           warn "*** could not create svg for #{result.inspect[0...20]}..."
           exit 65 # EX_DATAERR
@@ -490,7 +515,8 @@ COLORS
             end
           end
           case t
-          when "goat", "ditaa", "mscgen", "plantuml", "plantuml-utxt", "mermaid", "math"
+          when "goat", "ditaa", "mscgen", "plantuml", "plantuml-utxt", 
+               "railroad", "railroad-utf8", "mermaid", "math"
             if gi
               warn "*** Can't set GI #{gi} for composite SVG artset"
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 1.4.14.pre
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -98,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.15
 signing_key: