kramdown-rfc2629 1.5.15 → 1.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a7de9b6c78edf74415c185732e4b41a2d5685b07968bd187ce0948ea6dfd607
-  data.tar.gz: 52abd5a775d5c9922531b199fc957fbfe645621b4db3b59a624b0940ec328bf9
+  metadata.gz: 4a589f2a63da88b17cc5b56af63afe5a0faa9e7aae446f99b0a14aed7876e22d
+  data.tar.gz: 693ce583c48dbe4768727d684f3aa303436ad46bf824f291a9f0b3d63063d62c
 SHA512:
-  metadata.gz: 6a10a5fa3678b60ac5e1fa56ca42ef38529ff577e1a206c87784d9afb53d73af853ba16fbf0ec233152c55614b0ee9a22b40e332c0fd2b14bf7371333359baf7
-  data.tar.gz: 4dd3ef2b8698068f39b3e2c032f3bd76d281ac8fadb46820867b266339bee9aa86787eb0a60b72d853f03b33f0190256c4125fdf8950d8a877106dbdb855e6e3
+  metadata.gz: 965e4be16c1a7b5f372a911d861d5bfca8fdca3ebc999b1e61feb1aaabb003b3504f882f28224185ec497777eba1c4e6aa1be98890cf9f05ae0493b9b5d146a5
+  data.tar.gz: 4b9a3ec95bc29455192af45e0dac1701b2e76f934816746edea7b57ffca1001f23ed11df91b710398a60356297e955807d9e5d912298eb320ebb62daab17302c

data/README.md

@@ -28,7 +28,8 @@ structure provided by kramdown.  `bin/kramdown-rfc2629` started out as
 a simple command-line program showing how to use this, but can now do
 much more (see below).
 
-To use kramdown-rfc2629, you'll need a Ruby 2.x, and maybe
+To use kramdown-rfc2629, you'll need Ruby (at least version 2.3, but
+preferably a current version), and maybe
 [XML2RFC][] if you want to see the fruits of your work.
 
     kramdown-rfc2629 mydraft.mkd >mydraft.xml

data/data/kramdown-rfc2629.erb

@@ -12,14 +12,36 @@
 <% end -%>
 ]>
 
-<% ps.arr("pi", false) do |pi, val| -%>
-<?rfc <%=pi%>="<%= {true => "yes", false => "no", nil => "yes"}[val] || val %>"?>
+<%
+  ps.rest.fetch("consensus") do
+    # consensus not given -- default intelligently
+    cat = ps.has("category") || ps.has("cat")
+    MUST_CONSENSUS = {"std" => true, "bcp" => true}
+    ps["consensus"] = true if MUST_CONSENSUS[cat]
+  end
+  rfcattrs = ps.attrs("ipr", "docName=docname", "category=cat",
+                      "consensus", "submissionType=submissiontype", "xml:lang=lang",
+                      "number", "obsoletes", "updates", "seriesNo=seriesno")
+  TRUE_FALSE = {nil => "true", false => "false", true => "true"}
+  YES_NO = {"true" => "yes", "false" => "no"}
+  pis = KramdownRFC::ParameterSet.new({})
+  ps.arr("pi", false) do |pi, val|
+    pis[pi] = TRUE_FALSE[val] || val
+  end
+  if $options.v3
+    piattrs = pis.attrs("tocDepth=tocdepth", "tocInclude=toc",
+                        "sortRefs=sortrefs", "symRefs=symrefs", "indexInclude=index")
+    if piattrs != ""
+      rfcattrs << " " << piattrs
+    end
+  end
+  pis.rest.each do |pi, val|
+    v = YES_NO[val] || escape_html(val.to_s, :attribute)
+-%>
+<?rfc <%=pi%>="<%=v%>"?>
 <% end -%>
 
-<rfc <%= ps.attrs("ipr", "docName=docname", "category=cat",
-                  "consensus", "submissionType=submissiontype", "xml:lang=lang",
-                  "number", "obsoletes", "updates", "seriesNo=seriesno") %>>
-
+<rfc <%=rfcattrs%>>
   <front>
     <%= ps.ele("title", ps.attr("abbrev=titleabbrev")) %>
 
@@ -46,22 +68,44 @@
 <%  venue = ps[:venue] -%>
 <%  if venue -%>
 <%    venue = KramdownRFC::ParameterSet.new(venue) -%>
-    <note title="Discussion Venues" removeInRFC="true">
-<%   if mail = venue[:mail] -%>
-<%     mail_local, mail_host = mail.split("@", 2) -%>
+    <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 "} -%>
-<%     type = venue[:type] || "#{GROUPS[mail_subdomain]}Group" -%>
-      <t>Discussion of this document takes place on the
-        <%=group%> <%=type%> mailing list (<%=mail%>),
-        which is archived at <eref target="<%=arch%>"/>.</t>
+<%     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 gh = venue[:github] -%>
+<%   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="https://github.com/<%=gh%>"/>.</t>
+        <eref target="<%=repo%>"/>.</t>
 <%   end -%>
+<%= venue.ele("t=text", nil, nil, true) -%>
     </note>
 <%  venue.warn_if_leftovers -%>
 <%  end -%>

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.5.15'
+  s.version = '1.5.19'
   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,10 +7,15 @@ 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
+    def []=(pn, val)
+      @f[pn] = val
+    end
     def has(pn)
       @f[pn.to_s]
     end
@@ -24,6 +29,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)
@@ -612,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
@@ -1264,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.15
+  version: 1.5.19
 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