kramdown-rfc2629 1.7.39 → 1.7.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38aca91cefd454730d8c954f9d5d07035bca1a239fb1f580ab9d0d5fd41a60f3
-  data.tar.gz: 2eda7764ffdaef67e83376c0d748fa3b5a5d95db9655662454a63d5bda9ae4c0
+  metadata.gz: 5b32b21ea6b67eda069c4bb1c102f7e505b91ad149970e76ba182080111242a0
+  data.tar.gz: c3236319bb5e66f0f39f65d3b1f174d87fca1b85a22ca79e8b4067a98eb2b450
 SHA512:
-  metadata.gz: daca417b970b16cfdb61685947a38ec857dbf332259815a609ea54bac9959969dfa9ad0e5b392ac2a60616f0ca7ff51f9cb78f1238f04080cbb307dd7f0de9ca
-  data.tar.gz: fc157fa46ff9ea8ef0fc69689c14f35cfd09782fc0440a9815a706c7ddccc21e5035510b4b80a696c987bd392739fe1ab46661f3707aad2a9870ba7bbd8f3b1e
+  metadata.gz: 3457a313f0b84244f822de4ebc11feb12575db86c10647cfad6a6a0fae91340e1252bf0821959eafce8fc65ca31131b11ae9d3ddf4ac258c3c1d49a1bdcc27ed
+  data.tar.gz: d3c8f5fc6d5bf4fe947cb27a4304050682ec7dd14b4199644121a668ddc58f1bba4ff7116f9660b2f22bb0d33ce880b7b987d61a1ce1edfd7f602e372dfbddcb

data/README.md

@@ -12,10 +12,11 @@ Who would care?  Anybody who is writing Internet-Drafts and RFCs in
 the [IETF][] and prefers (or has co-authors who prefer) to do part of
 their work in markdown.
 
-kramdown-rfc is documented on this page, and also on
-[the wiki][].
+kramdown-rfc is documented on this page, as well as on
+[the wiki][] and via a "[Rosetta Stone]" maintained by the RFC Production Center.
 
 [the wiki]: https://github.com/cabo/kramdown-rfc/wiki
+[Rosetta Stone]: https://authors.ietf.org/en/rfcxml-markdown-syntax-tables
 
 # Usage
 

data/kramdown-rfc2629.gemspec

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

@@ -65,11 +65,8 @@ def process_includes(input)
                         $2)
     when "data"
       data = true
-    when /\Afold(?<columns>\d*)(?<hard>hard)?(?<left>left(?<spaces>\d*))?(?<dry>dry)?\z/
-      md = Regexp.last_match
-      columns = md[:columns].to_i
-      left = md[:spaces].to_i if md[:left]
-      fold = [columns, left, md[:dry], md[:hard]]
+    when ::FOLD8792_PROC_RE
+      fold = fold8792_options(Regexp.last_match)
     when "all", "last"
       fn_in = fn
       fn = fn.flat_map{|n| Dir[n]}

data/lib/kramdown-rfc/rfc8792.rb

@@ -22,6 +22,13 @@ end
 
 FOLD_MSG = "NOTE: '\\' line wrapping per RFC 8792".freeze
 UNFOLD_RE = /\A.*#{FOLD_MSG.sub("\\", "(\\\\\\\\\\\\\\\\?)")}.*\n\r?\n/
+# use indent as preferred synonym over smart
+FOLD8792_PROC_RE = /\Afold(?<columns>\d*)(?<hard>hard)?(?:(?<indent_type>left|smart|indent)(?<spaces>\d*))?(?<dry>dry)?\z/
+
+def fold8792_options(md)
+  indent_type = md[:indent_type].to_sym if md[:indent_type]
+  [md[:columns].to_i, indent_type, (md[:spaces] || 0).to_i, md[:dry], md[:hard]]
+end
 
 def unfold8792(s)
   if s =~ UNFOLD_RE
@@ -44,7 +51,7 @@ MIN_FOLD_COLUMNS = FOLD_MSG.size
 FOLD_COLUMNS = 69
 RE_IDENT = /\A[A-Za-z0-9_]\z/
 
-def fold8792_1(s, columns = FOLD_COLUMNS, left = false, dry = false, hard = false)
+def fold8792_1(s, columns = FOLD_COLUMNS, indent_type = nil, indent_spaces = 0, dry = false, hard = false)
   if s.index("\t")
     warn "*** HT (\"TAB\") in text to be folded. Giving up."
     return s
@@ -61,6 +68,7 @@ def fold8792_1(s, columns = FOLD_COLUMNS, left = false, dry = false, hard = fals
 
   lines = s.lines.map(&:chomp)
   did_fold = false
+  smart_indent = nil
   ix = 0
   while li = lines[ix]
     col = columns
@@ -69,16 +77,26 @@ def fold8792_1(s, columns = FOLD_COLUMNS, left = false, dry = false, hard = fals
         lines[ix..ix] = [li << "\\", ""]
         ix += 1
       end
+      smart_indent = nil
       ix += 1
     else
       did_fold = true
-      min_indent = left || 0
+      left_indent =
+        case indent_type
+        when :left
+          indent_spaces
+        when :smart, :indent
+          smart_indent ||= li[/\A */].size + indent_spaces
+        end
+      min_indent = left_indent || 0
       col -= 1                  # space for "\\"
       while li[col] == " "      # can't start new line with " "
         col -= 1
       end
       if col <= min_indent
-        warn "*** Cannot RFC8792-fold1 to #{columns} cols #{"with indent #{left}" if left}  |#{li.inspect}|"
+        indent_msg = "with indent #{min_indent}" if indent_type
+        warn "*** Cannot RFC8792-fold1 to #{columns} cols #{indent_msg}  |#{li.inspect}|"
+        smart_indent = nil
       else
         if !hard && RE_IDENT === li[col] # Don't split IDs
           col2 = col
@@ -90,8 +108,8 @@ def fold8792_1(s, columns = FOLD_COLUMNS, left = false, dry = false, hard = fals
           end
         end
         rest = li[col..-1]
-        indent = left || columns - rest.size
-        if !left && li[-1] == "\\"
+        indent = left_indent || columns - rest.size
+        if !left_indent && li[-1] == "\\"
           indent -= 1           # leave space for next round
         end
         if indent > 0

data/lib/kramdown-rfc2629.rb

@@ -109,8 +109,8 @@ module Kramdown
       XREF_TXT = /(?:[^\(]|\([^\)]*\))+/ # parenthesized text
       XREF_RE = /#{XREF_BASE}(?: \(#{XREF_TXT}\))?/
       XREF_RE_M = /\A(#{XREF_BASE})(?: \((#{XREF_TXT})\))?/ # matching version of XREF_RE
-      XREF_SINGLE = /(?:Section|Appendix) #{XREF_RE}/
-      XREF_MULTI = /(?:Sections|Appendices) (?:#{XREF_RE}, )*#{XREF_RE},? and #{XREF_RE}/
+      XREF_SINGLE = /(?:Section|Appendix|Table|Figure) #{XREF_RE}/
+      XREF_MULTI = /(?:Sections|Appendices|Tables|Figures) (?:#{XREF_RE}, )*#{XREF_RE},? and #{XREF_RE}/
       XREF_ANY = /(?:#{XREF_SINGLE}|#{XREF_MULTI})/
       SECTIONS_RE = /(?:#{XREF_ANY} and )?#{XREF_ANY}/
 
@@ -138,6 +138,8 @@ module Kramdown
           return
         end
 
+        reftype = s.match(/\A\w+/).to_s
+        issection = /[SA]/ =~ reftype[0]
         href = href.split(' ')[0] # Remove any trailing (...)
         target1, target2 = href.split("@", 2)
         multi = last_join != nil
@@ -146,7 +148,7 @@ module Kramdown
           m = s.match(/\A#{XREF_RE_M}(, (?:and )?| and )?/)
           break if not m
 
-          if not multi and not m[2] and not m[3] and not target2
+          if not multi and not m[2] and not m[3] and not target2 and issection
             # Modify |attr| if there is a single reference.  This can only be
             # used if there is only one section reference and the section part
             # has no title.
@@ -165,6 +167,9 @@ module Kramdown
           s[m[0]] = ''
 
           attr1 = { 'target' => target1, 'section' => m[1], 'sectionFormat' => 'bare', 'text' => m[2] }
+          if !issection
+            attr1['relative'] = "##{reftype.downcase.chomp('s')}-#{m[1]}"
+          end
           @tree.children << Element.new(:xref, nil, attr1)
           andof = m[3] || last_join || " of "
           if andof == " of " && target2
@@ -795,11 +800,8 @@ COLORS
         case proc
         when "dedent"
           result = remove_indentation(result)
-        when /\Afold(?<columns>\d*)(?<hard>hard)?(?<left>left(?<spaces>\d*))?(?<dry>dry)?\z/
-          md = Regexp.last_match
-          columns = md[:columns].to_i
-          left = md[:spaces].to_i if md[:left]
-          fold = [columns, left, md[:dry], md[:hard]]
+        when ::FOLD8792_PROC_RE
+          fold = fold8792_options(Regexp.last_match)
           result = fix_unterminated_line(fold8792_1(trim_empty_lines_around(result), *fold)) # XXX
         when /\Alines(\d*)\.\.(\.)?(\d*)\z/
           range = Range.new($1.empty? ? nil : $1.to_i, # compensate for

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.39
+  version: 1.7.41
 platform: ruby
 authors:
 - Carsten Bormann