kramdown-rfc2629 1.6.38 → 1.6.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b4707d20a26b963bdbf7423a2cc460769d6336d2ff01b47a3f74ec34f9a09fc
-  data.tar.gz: 3371f7774a039bf5effefb353baf1ffb7e1ccac76369db43f0f77c9b6e4284be
+  metadata.gz: 77429bca054e212b3c696036e1258ecb6d182d474d25e8a68fc2d6f1100ea735
+  data.tar.gz: c8f4306f3b9f8bd68992b3cf7cac334e265d910e32bb83b71fd639daccb03b69
 SHA512:
-  metadata.gz: ab844b01fc405878b32920b37ee05bc9354c6a5d3d9a2adf2eeeeca1862e89ebec0b94d7638afb893de745c3142d69ad4aecfa534f814dc7288b4208cb226fce
-  data.tar.gz: 60f42e7ded57af960bf618078eaa6d3f16591fc8099b897b1d5d7108bcf38b4e50c4123d198d1409197488f6ef7ab5678788c40bf42c097ccb859b6a09ebbe05
+  metadata.gz: 86f9a106f2bcb45257096fa91f261a19c2c427717683ca62a254d9a5c5db176b80040a8ddaadaea5b7d12567fd851be3f296b9fd358cf182ddcfcde290b49f1c
+  data.tar.gz: 32844ddd9b5f10a72541f3247a93f86cecdf019f456777522d62d38a8933ac249a6bef1b4618e32884043fa68edc14dad59a2bcbe5ce7cac659461316cf295e3

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.6.38'
+  s.version = '1.6.40'
   s.summary = "Kramdown extension for generating RFCXML (RFC 799x)."
   s.description = %{An RFCXML (RFC 799x) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}

data/lib/kramdown-rfc/command.rb

@@ -68,9 +68,9 @@ end
 
 
 def boilerplate(key)
+  ret = ''
   case key.downcase
   when /\Abcp14(info)?(\+)?(-tagged)?\z/i
-    ret = ''
     if $1
       ret << <<RFC8174ise
 Although this document is not an IETF Standards Track publication, it
@@ -109,8 +109,36 @@ PLUS
 TAGGED
     end
     ret
+  when /\Arfc\s*7942(info)?\z/i
+    if $1
+      ret << <<INFO
+(Boilerplate as per {{Section 2.1 of RFC7942}}:)
+
+INFO
+    end
+    ret << <<RFC7942
+This section records the status of known implementations of the
+protocol defined by this specification at the time of posting of
+this Internet-Draft, and is based on a proposal described in
+{{?RFC7942}}.  The description of implementations in this section is
+intended to assist the IETF in its decision processes in
+progressing drafts to RFCs.  Please note that the listing of any
+individual implementation here does not imply endorsement by the
+IETF.  Furthermore, no effort has been spent to verify the
+information presented here that was supplied by IETF contributors.
+This is not intended as, and must not be construed to be, a
+catalog of available implementations or their features.  Readers
+are advised to note that other implementations may exist.
+
+According to {{?RFC7942}}, "this will allow reviewers and working
+groups to assign due consideration to documents that have the
+benefit of running code, which may serve as evidence of valuable
+experimentation and feedback that have made the implemented
+protocols more mature.  It is up to the individual working groups
+to use this information as they see fit".
+RFC7942
   else
-    warn "** Unknwon boilerplate key: #{key}"
+    warn "** Unknown boilerplate key: #{key}"
     "{::boilerplate #{key}}"
   end
 end
@@ -222,6 +250,8 @@ def spacify_re(s)
   s.gsub(' ', '[\u00A0\s]+')
 end
 
+include ::Kramdown::Utils::Html
+
 def xml_from_sections(input)
 
   unless ENV["KRAMDOWN_NO_SOURCE"]
@@ -400,11 +430,14 @@ def xml_from_sections(input)
 
         bibref = anchor_to_bibref[k] || k
         bts, url = bibtagsys(bibref, k, stand_alone)
+        ann = v.delete("annotation") || v.delete("ann") if Hash === v
         if bts && (!v || v == {} || v.respond_to?(:to_str))
           if stand_alone
             a = %{{: anchor="#{k}"}}
+            a[-1...-1] = %{ ann="#{escape_html(ann, :attribute)}"} if ann
             sechash[sn.to_s] << %{\n#{NMDTAGS[0]}\n![:include:](#{bts})#{a}\n#{NMDTAGS[1]}\n}
           else
+            warn "*** please use standalone mode for adding annotations to references" if ann
             bts.gsub!('/', '_')
             (ps.rest["bibxml"] ||= []) << [bts, url]
             sechash[sn.to_s] << %{&#{bts};\n} # ???
@@ -417,6 +450,7 @@ def xml_from_sections(input)
           if bts && !v.delete("override")
             warn "*** warning: explicit settings completely override canned bibxml in reference #{k}"
           end
+          v["ann"] = ann if ann
           sechash[sn.to_s] << KramdownRFC::ref_to_xml(href, v)
         end
       end

data/lib/kramdown-rfc2629.rb

@@ -370,10 +370,19 @@ module Kramdown
         generate_id(value).gsub(/-+/, '-')
       end
 
-      def self.process_markdown(v)             # Uuh.  Heavy coupling.
+      def self.process_markdown1(v)             # Uuh.  Heavy coupling.
         doc = ::Kramdown::Document.new(v, $global_markdown_options)
         $stderr.puts doc.warnings.to_yaml unless doc.warnings.empty?
-        doc.to_rfc2629[3..-6] # skip <t>...</t>\n
+        doc.to_rfc2629
+      end
+
+      def self.process_markdown(v)
+        process_markdown1(v)[3..-6] # skip <t>...</t>\n
+      end
+
+      def self.process_markdown_to_rexml(v)
+        s = process_markdown1(v)
+        REXML::Document.new(s)
       end
 
       SVG_COLORS = Hash.new {|h, k| k}
@@ -1234,6 +1243,7 @@ COLORS
           end
         end
         if alt == ":include:"   # Really bad misuse of tag...
+          ann = el.attr.delete('ann')
           anchor = el.attr.delete('anchor') || (
             # not yet
             warn "*** missing anchor for '#{src}'"
@@ -1282,6 +1292,11 @@ COLORS
               elsif t == "IANA"
                 d.root.attributes["target"].sub!(%r{\Ahttp://www.iana.org/assignments/}, 'https://www.iana.org/assignments/')
               end
+              if ann
+                el = ::Kramdown::Converter::Rfc2629::process_markdown_to_rexml(ann).root
+                el.name = "annotation"
+                d.root.add_element(el)
+              end
               to_insert = d.to_s
             rescue Exception => e
               warn "** Can't manipulate reference XML: #{e}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.6.38
+  version: 1.6.40
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFCXML (RFC 799x).