kramdown-rfc2629 1.5.18 → 1.5.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1899e3dda0205ba1affda979ec1e972a27fc7d13ae721737e14cf4ab737b13ff
-  data.tar.gz: 442106a989c71107a357d7c0bfec6ed9cf6b51c23cbfe870c81a26adc4542438
+  metadata.gz: 90fd02030501ff7ce234af8b2f2412b5c1372c8e865b368db995ab0a32347dc0
+  data.tar.gz: 31d7f8eed4b7adc64e8ff4458368e1380351089aa44478faf2987a78239d5cae
 SHA512:
-  metadata.gz: 1072b3d275c6ff6692bdc2cb3e666ac76f3c4838d6978b822c034b6ac4c70bf29a5d0be20aad42881bd9dcdf1ef5b69decb59114ecbfbb4457988ef0b0a2f3aa
-  data.tar.gz: 81360978cd5ff6692263c0b0b3aff2780b0b806ed83edd2d96ac40e5f705120ed54a529b874a51b27d25be10b44f14fd4bb84a7d7fe067dd3b2b73e4e1234714
+  metadata.gz: a39fa3bf7a2703f958dbc443d1d8d850a0a89ec9797f619218e921cdadd372e4466f628a1a3dbf13f178163a16f92141026ac34bfd52c82f1950fd3780d187aa
+  data.tar.gz: f02da291a9a611a4cb21097c2f31ee490a6327558cf1d66018279c89ef5f56f4ad87884046b19e44d347d5946346d0108a017e19aabb6b0db180f53a9847430a

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/bin/kramdown-rfc2629

@@ -3,6 +3,7 @@
 require 'kramdown-rfc2629'
 require 'kramdown-rfc/parameterset'
 require 'kramdown-rfc/refxml'
+require 'kramdown-rfc/rfc8792'
 require 'yaml'
 require 'kramdown-rfc/erb'
 require 'date'
@@ -24,8 +25,9 @@ def add_quote(s)
   l.map {|li| "> #{li}"}.join
 end
 
-def process_chunk(s, dedent, quote)
+def process_chunk(s, dedent, fold, quote)
   s = remove_indentation(s) if dedent
+  s = fold8792_1(s) if fold
   s = add_quote(s) if quote
   s
 end
@@ -460,6 +462,7 @@ input.gsub!(/^\{::include((?:-[a-z]+)*)\s+(.*?)\}/) {
   fn = [$2]
   chunks = false
   dedent = false
+  fold = false
   quote = false
   include_flags.split("-") do |flag|
     case flag
@@ -468,11 +471,13 @@ input.gsub!(/^\{::include((?:-[a-z]+)*)\s+(.*?)\}/) {
       quote = true
     when "dedent"
       dedent = true
+    when "fold"
+      fold = true
     when "all", "last"
       fn = fn.flat_map{|n| Dir[n]}
       fn = [fn.last] if flag == "last"
       chunks = fn.map{ |f|
-        ret = process_chunk(File.read(f), dedent, quote)
+        ret = process_chunk(File.read(f), dedent, fold, quote)
         dedent = false; quote = false
         ret
       }
@@ -481,7 +486,7 @@ input.gsub!(/^\{::include((?:-[a-z]+)*)\s+(.*?)\}/) {
     end
   end
   chunks = fn.map{|f| File.read(f)} unless chunks # no all/last
-  chunks = chunks.map {|ch| process_chunk(ch, dedent, quote)}
+  chunks = chunks.map {|ch| process_chunk(ch, dedent, fold, quote)}
   chunks.join.chomp
 } unless ENV["KRAMDOWN_SAFE"]
 input.gsub!(/^\{::boilerplate\s+(.*?)\}/) {

data/data/kramdown-rfc2629.erb

@@ -12,14 +12,37 @@
 <% 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" => "true", "no" => "false"}
+  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] || pis.escattr(val)
+-%>
+<?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")) %>
 

data/kramdown-rfc2629.gemspec

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

@@ -13,6 +13,9 @@ module KramdownRFC
     def [](pn)
       @f.delete(pn.to_s)
     end
+    def []=(pn, val)
+      @f[pn] = val
+    end
     def has(pn)
       @f[pn.to_s]
     end
@@ -30,7 +33,7 @@ module KramdownRFC
       %{#{an}="#{escattr(val)}"}    if val
     end
     def attrs(*pns)
-      pns.map{ |pn| attr(pn) }.compact.join(" ")
+      pns.map{ |pn| attr(pn) if pn }.compact.join(" ")
     end
     def ele(pn, attr=nil, defcontent=nil, markdown=false)
       val, an = van(pn)
@@ -62,5 +65,4 @@ module KramdownRFC
     end
   end
 
-  
 end

data/lib/kramdown-rfc/rfc8792.rb

@@ -0,0 +1,59 @@
+FOLD_COLUMNS = 69
+RE_IDENT = /\A[A-Za-z0-9_]\z/
+
+def fold8792_1(s, columns = FOLD_COLUMNS)
+  if s.index("\t")
+    warn "*** HT (\"TAB\") in text to be folded. Giving up."
+    return s
+  end
+
+  lines = s.lines.map(&:chomp)
+  did_fold = false
+  ix = 0
+  while li = lines[ix]
+    col = columns
+    if li[col].nil?
+      if li[-1] == "\\"
+        lines[ix..ix] = [li << "\\", ""]
+        ix += 1
+      end
+      ix += 1
+    else
+      did_fold = true
+      col -= 1                  # space for "\\"
+      while li[col] == " "      # can't start new line with " "
+        col -= 1
+      end
+      if col <= 0
+        warn "*** Cannot RFC8792-fold1 #{li.inspect}"
+      else
+        if RE_IDENT === li[col] # Don't split IDs
+          col2 = col
+          while col2 > 0 && RE_IDENT === li[col2-1]
+            col2 -= 1
+          end
+          if col2 > 0
+            col = col2
+          end
+        end
+        rest = li[col..-1]
+        indent = columns - rest.size
+        if li[-1] == "\\"
+          indent -= 1           # leave space for next round
+        end
+        if indent > 0
+         rest = " " * indent + rest
+        end
+        lines[ix..ix] = [li[0...col] << "\\", rest]
+      end
+      ix += 1
+    end
+  end
+
+  if did_fold
+    lines[0...0] = ["=== NOTE: '\\' line wrapping per RFC 8792 ===", ""]
+    lines.map{|x| x << "\n"}.join
+  else
+    s
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.5.18
+  version: 1.5.22
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -99,6 +99,7 @@ files:
 - lib/kramdown-rfc/kdrfc-processor.rb
 - lib/kramdown-rfc/parameterset.rb
 - lib/kramdown-rfc/refxml.rb
+- lib/kramdown-rfc/rfc8792.rb
 - lib/kramdown-rfc2629.rb
 homepage: http://github.com/cabo/kramdown-rfc2629
 licenses:
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.