kramdown-rfc2629 1.5.14 → 1.5.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3097408dcedb58eab67f2de242d7ba51f8e62e82199e9da00b6a68ca0917c3dc
-  data.tar.gz: fbcac44963fb8a7ce2df22060e624410e8f7df4c439d2e7cdcc1fcb760f3b1c4
+  metadata.gz: 1899e3dda0205ba1affda979ec1e972a27fc7d13ae721737e14cf4ab737b13ff
+  data.tar.gz: 442106a989c71107a357d7c0bfec6ed9cf6b51c23cbfe870c81a26adc4542438
 SHA512:
-  metadata.gz: b79053e9e4a368ece939ef8a3cca6c8e72826dd0e35bee10a4cf1548f4e5b72d38fdf680a0ae33b17c33c24ab87335addd401d3df2d60b34476ccfb4f592a501
-  data.tar.gz: 0d1a39fbb8e26a5513deca8fdf9c844aed56cdcb27c02ab6695251bfadfbdd47721b0f3a90a2755171eb7eb58dc98629b57f8e528e0c7c00005f640a1d74bd6e
+  metadata.gz: 1072b3d275c6ff6692bdc2cb3e666ac76f3c4838d6978b822c034b6ac4c70bf29a5d0be20aad42881bd9dcdf1ef5b69decb59114ecbfbb4457988ef0b0a2f3aa
+  data.tar.gz: 81360978cd5ff6692263c0b0b3aff2780b0b806ed83edd2d96ac40e5f705120ed54a529b874a51b27d25be10b44f14fd4bb84a7d7fe067dd3b2b73e4e1234714

data/data/kramdown-rfc2629.erb

@@ -42,6 +42,53 @@
 
     </abstract>
 
+<% if $options.v3 -%>
+<%  venue = ps[:venue] -%>
+<%  if venue -%>
+<%    venue = KramdownRFC::ParameterSet.new(venue) -%>
+    <note title="About This Document" removeInRFC="true">
+<%   if (dn = ps.av[:docName]) &&
+       (dt = dn.rpartition('-')[0]) != ""
+-%>
+      <t>
+<%   if latest = venue[:latest] -%>
+        The latest revision of this draft can be found at <eref target="<%=latest%>"/>.
+<%   end -%>
+        Status information for this document may be found at <eref target="https://datatracker.ietf.org/doc/<%=dt%>/"/>.
+      </t>
+<%   end -%>
+<%   mail = venue[:mail] -%>
+<%   homepage = venue[:home] -%>
+<%   gtype = venue[:type] -%>
+<%   if mail || homepage -%>
+      <t>
+<%   end -%>
+<%   if mail && (mail_local, mail_host = mail.split("@", 2)) && mail_host -%>
+<%     mail_subdomain, mail_domain = mail_host.split(".", 2) -%>
+<%     group = venue[:group] || mail_local # XXX -%>
+<%     arch = venue[:arch] || "https://mailarchive.ietf.org/arch/browse/#{mail_local}/" -%>
+<%     GROUPS = {"ietf" => "Working ", "irtf" => "Research "} -%>
+<%     gtype ||= "#{GROUPS[mail_subdomain]}Group" -%>
+        Discussion of this document takes place on the
+        <%=group%> <%=gtype%> mailing list (<eref target="mailto:<%=mail%>"/>),
+        which is archived at <eref target="<%=arch%>"/>.
+<%   end -%>
+<%   if homepage -%>
+        <%=gtype%> information can be found at <eref target="<%=homepage%>"/>.
+<%   end -%>
+<%   if mail || homepage -%>
+      </t>
+<%   end -%>
+<%   if repo = venue[:repo] || ((gh = venue[:github]) && "https://github.com/#{gh}") -%>
+      <t>Source for this draft and an issue tracker can be found at
+        <eref target="<%=repo%>"/>.</t>
+<%   end -%>
+<%= venue.ele("t=text", nil, nil, true) -%>
+    </note>
+<%  venue.warn_if_leftovers -%>
+<%  end -%>
+<% end -%>
+
 <% sechash.keys.each do |k| -%>
 <%   if k =~ /\A(to_be_removed_)?note_(.*)/ -%>
 
@@ -78,6 +125,7 @@
 {:removeinrfc: removeinrfc="true"}
 {:notoc: toc="exclude"}
 {:compact: spacing="compact"}
+{:noabbrev: noabbrev="true"}
 {::nomarkdown}
 
 <%= sechash.delete("middle") %>

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.5.14'
+  s.version = '1.5.18'
   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-rfc/parameterset.rb

@@ -7,7 +7,9 @@ module KramdownRFC
     def initialize(y)
       raise "*** invalid parameter set #{y.inspect}" unless Hash === y
       @f = y
+      @av = {}
     end
+    attr :av
     def [](pn)
       @f.delete(pn.to_s)
     end
@@ -24,6 +26,7 @@ module KramdownRFC
     end
     def attr(pn)
       val, an = van(pn)
+      @av[an.intern] = val
       %{#{an}="#{escattr(val)}"}    if val
     end
     def attrs(*pns)

data/lib/kramdown-rfc2629.rb

@@ -34,6 +34,18 @@ module Kramdown
 
     class RFC2629Kramdown < Kramdown
 
+      def replace_abbreviations(el, regexps = nil)
+        unless regexps          # DUPLICATED AND MODIFIED CODE FROM UPSTREAM, CHECK ON UPSTREAM UPGRADE
+          sorted_abbrevs = @root.options[:abbrev_defs].keys.sort {|a, b| b.length <=> a.length }
+          regexps = [Regexp.union(*sorted_abbrevs.map {|k| 
+                                    /#{Regexp.escape(k).gsub(/\\\s/, "[\\s\\p{Z}]+").force_encoding(Encoding::UTF_8)}/})]
+          # warn regexps.inspect
+          regexps << /(?=(?:\W|^)#{regexps.first}(?!\w))/ # regexp should only match on word boundaries
+        end
+        super(el, regexps)
+      end
+
+
       def initialize(*doc)
         super
         @span_parsers.unshift(:xref)
@@ -226,7 +238,11 @@ module Kramdown
     )
     STUDLY_ATTR_MAP = Hash[STUDLY_ATTR.map {|s| [s.downcase, s]}]
 
-    def rfc2629_fix
+    TRUTHY = Hash.new {|h, k| k}
+    TRUTHY["false"] = false
+    TRUTHY["no"] = false
+
+    def rfc2629_fix(opts)
       if a = attr
         if anchor = a.delete('id')
           a['anchor'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
@@ -234,12 +250,16 @@ module Kramdown
         if anchor = a.delete('href')
           a['target'] = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor)
         end
+        if av = a.delete('noabbrev')      # pseudo attribute -> opts
+          opts = opts.merge(noabbrev: TRUTHY[av]) # updated copy
+        end
         attr.keys.each do |k|
           if (d = k.gsub(/_(.|$)/) { $1.upcase }) != k or d = STUDLY_ATTR_MAP[k]
             a[d] = a.delete(k)
           end
         end
       end
+      opts
     end
   end
 
@@ -294,15 +314,15 @@ module Kramdown
       end
 
       def convert1(el, indent, opts = {})
-        el.rfc2629_fix
-        send("convert_#{el.type}", el, indent, opts)
+        nopts = el.rfc2629_fix(opts)
+        send("convert_#{el.type}", el, indent, nopts)
       end
 
       def inner_a(el, indent, opts)
         indent += INDENTATION
         el.children.map do |inner_el|
-          inner_el.rfc2629_fix
-          send("convert_#{inner_el.type}", inner_el, indent, opts)
+          nopts = inner_el.rfc2629_fix(opts)
+          send("convert_#{inner_el.type}", inner_el, indent, nopts)
         end
       end
 
@@ -604,6 +624,35 @@ COLORS
                 "sourcecode"
               end
             )
+            loc_str =
+              if anchor = el.attr['anchor']
+                "##{anchor}"
+              elsif lineno = el.options[:location]
+                "approx. line #{lineno}" # XXX
+              else
+                "UNKNOWN"
+              end
+            case t
+            when "json"
+              begin
+                JSON.load(result)
+              rescue => e
+                err1 = "*** #{loc_str}: JSON isn't: #{e.message[0..40]}\n"
+                begin
+                  JSON.load("{" << result << "}")
+                rescue => e
+                  warn err1 << "***  not even with braces added around: #{e.message[0..40]}"
+                end
+              end
+            when "json-from-yaml"
+              begin
+                y = YAML.safe_load(result, aliases: true, filename: loc_str)
+                result = JSON.pretty_generate(y)
+                t = "json"      # XXX, this could be another format!
+              rescue => e
+                warn "*** YAML isn't: #{e.message}\n"
+              end
+            end
             "#{' '*indent}<figure#{el_html_attributes(el)}><#{gi}#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></#{gi}></figure>\n"
           end
         end
@@ -664,6 +713,7 @@ COLORS
           if sl = el.attr.delete('slugifiedName') # could do general name- play
             attrstring = html_attributes({'slugifiedName' => sl})
           end
+          # noabbrev: true -- Workaround for https://trac.ietf.org/trac/xml2rfc/ticket/683
           irefs = "<name#{attrstring}>#{inner(el, indent, opts.merge(noabbrev: true))}</name>" #
         else
         clean, irefs = clean_pcdata(inner_a(el, indent, opts))
@@ -1255,9 +1305,14 @@ COLORS
           return el.value
         end
 
-        title = @root.options[:abbrev_defs][el.value]
-        title = nil if title.empty?
         value = el.value
+        ix = value.gsub(/[\s\p{Z}]+/, " ")
+        title = @root.options[:abbrev_defs][ix]
+        if title.nil?
+          warn "*** abbrev mismatch: value = #{value.inspect} ix = #{ix.inspect}"
+        else
+          title = nil if title.empty?
+        end
 
         if title == "<bcp14>" && $options.v3
           return "<bcp14>#{value}</bcp14>"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.5.14
+  version: 1.5.18
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown