kramdown-rfc2629 1.5.22 → 1.6.1

data/lib/kramdown-rfc/refxml.rb

@@ -8,6 +8,12 @@ module KramdownRFC
     escape_html(str.to_s, :attribute)
   end
 
+  AUTHOR_ATTRIBUTES = %w{
+    initials surname fullname
+    asciiInitials asciiSurname asciiFullname
+    role
+  }
+
   def self.ref_to_xml(k, v)
     vps = KramdownRFC::ParameterSet.new(v)
     erb = ERB.trim_new <<-REFERB, '-'
@@ -18,7 +24,7 @@ module KramdownRFC
 <% vps.arr("author", true, true) do |au|
    aups = authorps_from_hash(au)
  -%>
-    <author <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
+    <author <%=aups.attrs(*AUTHOR_ATTRIBUTES)%>>
       <%= aups.ele("organization=org", aups.attr("abbrev=orgabbrev"), "") %>
     </author>
 <%   aups.warn_if_leftovers  -%>
@@ -40,19 +46,110 @@ module KramdownRFC
     ret
   end
 
+  def self.treat_multi_attribute_member(ps, an)
+    value = ps.rest[an]
+    if Hash === value
+      value.each do |k, v|
+        ps.rest[if k == ':'
+                  an
+                else
+                  Kramdown::Element.attrmangle(k + an) ||
+                  Kramdown::Element.attrmangle(k) ||
+                  k
+                end] = v
+      end
+    end
+  end
+
+  def self.initializify(s)      # XXX Jean-Pierre
+    w = '\p{Lu}\p{Lo}'
+    if s =~ /\A[-.#{w}]+[.]/u
+      $&
+    elsif s =~ /\A([#{w}])[^-]*/u
+      ret = "#$1."
+      while (s = $') && s =~ /\A(-[\p{L}])[^-]*/u
+        ret << "#$1."
+      end
+      ret
+    else
+      warn "*** Can't initializify #{s}"
+      s
+    end
+  end
+
+  def self.looks_like_initial(s)
+    s =~ /\A[\p{Lu}\p{Lo}]([-.][\p{Lu}\p{Lo}]?)*\z/u
+  end
+
+  def self.initials_from_parts_and_surname(aups, parts, s)
+    ssz = s.size
+    nonsurname = parts[0...-ssz]
+    if (ns = parts[-ssz..-1]) != s
+      warn "*** inconsistent surnames #{ns} and #{s}"
+    end
+    nonsurname.map{|x| initializify(x)}.join(" ")
+  end
+
+  def self.handle_ins(aups, ins_k, initials_k, surname_k)
+    if ins = aups[ins_k]
+      parts = ins.split('.').map(&:strip) # split on dots first
+      # Coalesce H.-P.
+      i = 1; while i < parts.size
+        if parts[i][0] == "-"
+          parts[i-1..i] = [parts[i-1] + "." + parts[i]]
+        else
+          i += 1
+        end
+      end
+      # Multiple surnames in ins?
+      parts[-1..-1] = parts[-1].split
+      s = if surname = aups.rest[surname_k]
+            surname.split
+          else parts.reverse.take_while{|x| !looks_like_initial(x)}.reverse
+          end
+      aups.rest[initials_k] = initials_from_parts_and_surname(aups, parts, s)
+      aups.rest[surname_k] = s.join(" ")
+    end
+  end
+
+  def self.handle_name(aups, fn_k, initials_k, surname_k)
+    if name = aups.rest[fn_k]
+      names = name.split(/ *\| */, 2) # boundary for given/last name
+      if names[1]
+        aups.rest[fn_k] = name = names.join(" ") # remove boundary
+        if surname = aups.rest[surname_k]
+          if surname != names[1]
+            warn "*** inconsistent embedded surname #{names[1]} and surname #{surname}"
+          end
+        end
+        aups.rest[surname_k] = names[1]
+      end
+      parts = name.split
+      surname = aups.rest[surname_k] || parts[-1]
+      s = surname.split
+      aups.rest[initials_k] ||= initials_from_parts_and_surname(aups, parts, s)
+      aups.rest[surname_k] = s.join(" ")
+    end
+  end
+
   def self.authorps_from_hash(au)
     aups = KramdownRFC::ParameterSet.new(au)
-    if ins = aups[:ins]
-      parts = ins.split('.').map(&:strip)
-      aups.rest["initials"] = parts[0..-2].join('.') << '.'
-      aups.rest["surname"] = parts[-1]
+    if n = aups[:name]
+      warn "** both name #{n} and fullname #{fn} are set on one author" if fn = aups.rest["fullname"]
+      aups.rest["fullname"] = n
+      usename = true
+    end
+    ["fullname", "ins", "initials", "surname"].each do |an|
+      treat_multi_attribute_member(aups, an)
     end
+    handle_ins(aups, :ins, "initials", "surname")
+    handle_ins(aups, :asciiIns, "asciiInitials", "asciiSurname")
     # hack ("heuristic for") initials and surname from name
     # -- only works for people with exactly one last name and uncomplicated first names
-    if n = aups.rest["name"]
-      n = n.split
-      aups.rest["initials"] ||= n[0..-2].map(&:chr).join('.') << '.'
-      aups.rest["surname"] ||= n[-1]
+    # -- add surname for people with more than one last name
+    if usename
+      handle_name(aups, "fullname", "initials", "surname")
+      handle_name(aups, "asciiFullname", "asciiInitials", "asciiSurname")
     end
     aups
   end
@@ -69,7 +166,7 @@ module KramdownRFC
   #   country: Germany
 
   PERSON_ERB = <<~ERB
-    <<%= element_name%> <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
+    <<%= element_name%> <%=aups.attrs(*AUTHOR_ATTRIBUTES)%>>
       <%= aups.ele("organization=org", aups.attrs("abbrev=orgabbrev",
                                                   *[$options.v3 && "ascii=orgascii"]), "") %>
       <address>

data/lib/kramdown-rfc/rfc8792.rb

@@ -1,11 +1,22 @@
+FOLD_MSG = "NOTE: '\\' line wrapping per RFC 8792".freeze
+MIN_FOLD_COLUMNS = FOLD_MSG.size
 FOLD_COLUMNS = 69
 RE_IDENT = /\A[A-Za-z0-9_]\z/
 
-def fold8792_1(s, columns = FOLD_COLUMNS)
+def fold8792_1(s, columns = FOLD_COLUMNS, left = false, dry = false)
   if s.index("\t")
     warn "*** HT (\"TAB\") in text to be folded. Giving up."
     return s
   end
+  if columns < MIN_FOLD_COLUMNS
+    columns =
+      if columns == 0
+        FOLD_COLUMNS
+      else
+        warn "*** folding to #{MIN_FOLD_COLUMNS}, not #{columns}"
+        MIN_FOLD_COLUMNS
+      end
+  end
 
   lines = s.lines.map(&:chomp)
   did_fold = false
@@ -20,25 +31,26 @@ def fold8792_1(s, columns = FOLD_COLUMNS)
       ix += 1
     else
       did_fold = true
+      min_indent = left || 0
       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}"
+      if col <= min_indent
+        warn "*** Cannot RFC8792-fold1 to #{columns} cols #{"with indent #{left}" if left}  |#{li.inspect}|"
       else
         if RE_IDENT === li[col] # Don't split IDs
           col2 = col
-          while col2 > 0 && RE_IDENT === li[col2-1]
+          while col2 > min_indent && RE_IDENT === li[col2-1]
             col2 -= 1
           end
-          if col2 > 0
+          if col2 > min_indent
             col = col2
           end
         end
         rest = li[col..-1]
-        indent = columns - rest.size
-        if li[-1] == "\\"
+        indent = left || columns - rest.size
+        if !left && li[-1] == "\\"
           indent -= 1           # leave space for next round
         end
         if indent > 0
@@ -51,7 +63,13 @@ def fold8792_1(s, columns = FOLD_COLUMNS)
   end
 
   if did_fold
-    lines[0...0] = ["=== NOTE: '\\' line wrapping per RFC 8792 ===", ""]
+    msg = FOLD_MSG.dup
+    if !dry && columns >= msg.size + 4
+      delta = columns - msg.size - 2 # 2 spaces
+      half = delta/2
+      msg = "#{"=" * half} #{msg} #{"=" * (delta - half)}"
+    end
+    lines[0...0] = [msg, ""]
     lines.map{|x| x << "\n"}.join
   else
     s

data/lib/kramdown-rfc2629.rb

@@ -242,6 +242,14 @@ module Kramdown
     TRUTHY["false"] = false
     TRUTHY["no"] = false
 
+    # explicit or automatic studlification
+    # note that explicit (including trailing "_") opts out of automatic
+    def self.attrmangle(k)
+      if (d = k.gsub(/_(.|$)/) { $1.upcase }) != k or d = STUDLY_ATTR_MAP[k]
+        d
+      end
+    end
+
     def rfc2629_fix(opts)
       if a = attr
         if anchor = a.delete('id')
@@ -254,7 +262,7 @@ module Kramdown
           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]
+          if d = self.class.attrmangle(k)
             a[d] = a.delete(k)
           end
         end
@@ -1323,7 +1331,7 @@ COLORS
           if target == "#"
             target = value
           else
-            target = target[1..]
+            target = target[1..-1]
           end
         else
           target = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.5.22
+  version: 1.6.1
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -71,6 +71,7 @@ description: |-
   "kramdown" markdown parser.  Mostly useful for RFC writers.
 email: cabo@tzi.org
 executables:
+- kramdown-rfc
 - kramdown-rfc2629
 - doilit
 - kramdown-rfc-extract-markdown
@@ -86,6 +87,7 @@ files:
 - bin/de-gfm
 - bin/doilit
 - bin/kdrfc
+- bin/kramdown-rfc
 - bin/kramdown-rfc-cache-i-d-bibxml
 - bin/kramdown-rfc-cache-subseries-bibxml
 - bin/kramdown-rfc-extract-markdown
@@ -94,6 +96,7 @@ files:
 - data/kramdown-rfc2629.erb
 - data/math.json
 - kramdown-rfc2629.gemspec
+- lib/kramdown-rfc/command.rb
 - lib/kramdown-rfc/erb.rb
 - lib/kramdown-rfc/gzip-clone.rb
 - lib/kramdown-rfc/kdrfc-processor.rb
@@ -120,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.