kramdown-rfc2629 1.7.2 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fd72c01ed7024958d451c3342f16b8985dc145ef09a6e4d33ba2f3d290d81e4
-  data.tar.gz: 7ada0cb08e8481cfef450606bcfdaab0303a49b0306fdf5be7041121b57a1143
+  metadata.gz: 6c60909608ac8c84853d39c03fdf0da2cdfd179601a63a5b07a52099925a8ce9
+  data.tar.gz: ce8fcfe62f77fc23a8a5514e329ade31864ac099f5a45c6bbce976e3a8210a1e
 SHA512:
-  metadata.gz: c525300de7bf414755c50476de45b9842ab011965a2dcfa82206d9e614a12b482b958707021dc3fff51a6c66f98b39b55d3dd6556d001ec255b50fde926a82e9
-  data.tar.gz: 200cb7e1760cc81b628354dc2343eaee5595294d1334b16d17b1e47ed3bc2f83174ee588d9e5d50289aebf0b0f579b4ad635124779cc66e5578bd600f4e17b9f
+  metadata.gz: 3b11fe08773c3e5c80aaaaeff16bf6728ab8656ee95ce0186bf786b2da2b99832b65b36fa32e7801e36b3f9c32b4e90830fa4c14f5136d0f7945c2c342ba17d1
+  data.tar.gz: 35a372c29219550c56a2335a497b3117621ac7b998792d596272fad84725a6f464a89bb931c9472a0ef4320eee40b69088e3f595ef8e6a028e7ba0a57e58436f

data/README.md

@@ -150,7 +150,7 @@ or
         email: pthubert@cisco.com
 
 (the hash keys are the XML GIs from RFC 7749, with a flattened
-structure.  As RFC 7749 requiresd giving both the full name and
+structure.  As RFC 7749 requires giving both the full name and
 surname/initials, we use `ins` as an abbreviation for
 "initials/surname".  Yes, the toolchain is Unicode-capable, even if
 the final RFC output is still in ASCII.)

data/bin/kramdown-rfc-extract-sourcecode

@@ -9,10 +9,35 @@ require_relative '../lib/kramdown-rfc/rexml-all-text.rb'
 def clean(s)
   s.gsub!(/\//, ":")
   s.gsub!(/\A([-.]+)/) {"_" * $1.size }
-  s.gsub!(/[^-.:\w]/, "_")
+  s.gsub!(/[^-.:\w]+/, "-")
   s
 end
 
+$seen_slugs = {}
+
+def slugify_like_xml2rfc(s, delta = 0)
+  s = s.unicode_normalize(:nfkd).force_encoding(Encoding::ASCII).scrub('').downcase
+  s.gsub!(/[^-\w\s\/]/, '')
+  s = s.strip
+  s.gsub!(/[-\s\/]/, '-')
+  n = 32 - delta
+  nmax = [s.size, 40 - delta].min
+  while $seen_slugs[slugex = s[0...n]] && n < nmax
+    n += 1
+  end
+  if $seen_slugs[slugex]
+    m = 2
+    while $seen_slugs[slugex = "#{s[0...n]}-#{m}"]
+      m += 1
+      if m == 1000
+        raise ArgumentError, "Can't build distinguishable slug for '#{s}'"
+      end
+    end
+  end
+  $seen_slugs[slugex] = s
+  slugex
+end
+
 target = nil
 dir = nil
 unfold = true
@@ -52,22 +77,67 @@ warned = Hash.new { |h, k| h[k] = Hash.new }
 d = REXML::Document.new(ARGF)
 REXML::XPath.each(d.root, "//sourcecode|//artwork") do |x|
   if ty = x[:type]
+    is_svg = false
+    REXML::XPath.each(x, "svg") do is_svg = true end
     ty = clean(ty)
+    if is_svg && ty != "svg"
+      warn "** replacing SVG type '#{ty}' by type 'svg'"
+      ty = "svg"
+    end
+    ext = ty
+    if ty.empty?
+      ty = "=txt"
+      ext = "txt"
+    end
     name = x[:name]
+    name_is_from_slug = false
     if !name || name.empty?
-      name = gensym.succ!.dup
-      name = "#{name}.#{ty}" unless ty.empty?
+      REXML::XPath.each(x, "ancestor::*/name[position() = 1]") do |nameel|
+        unless sname = nameel['slugifiedName']
+          alltext = nameel.all_text
+          nameel.add_attribute('slugifiedName',
+                               sname = clean("name-" << slugify_like_xml2rfc(alltext, 5)))
+        end
+        name = clean(sname.to_s.sub(/^name-/, ''))
+        name_is_from_slug = true
+      end
+      if !name || name.empty?
+        name = gensym.succ!.dup
+      end
+      name = "#{name}.#{ext}"
     end
     name = clean(name)
     if taken[ty][name]
-      unless warned[ty][name]
-        warn "Concatenating to #{ty}/#{name}."
-        warned[ty][name] = true
+      if name_is_from_slug || is_svg
+        # rename old entry as well if it was from slug?
+        nameparts = name.split(".")
+        if is_svg && nameparts[-1] != "svg"
+          nameparts << "svg"
+        end
+        ext1 = nameparts.pop || "txt"
+        suffix = "b"
+        while taken[ty][name = [*nameparts[0...-1], "#{nameparts[-1]}-#{suffix}", ext1].join(".")]
+          suffix.succ!
+        end
+        taken[ty][name] = ''
+      else
+        unless warned[ty][name]
+          warn "Concatenating to #{ty}/#{name}."
+          warned[ty][name] = true
+        end
       end
     else
       taken[ty][name] = ''
     end
-    taken[ty][name] << handle_artwork_sourcecode(x.all_text, unfold)
+    extracted = false
+    REXML::XPath.each(x, "svg") do |svg|
+      # According to v3.rnc, there should be only one...
+      taken[ty][name] << svg.to_s
+      extracted = true
+    end
+    unless extracted
+      taken[ty][name] << handle_artwork_sourcecode(x.all_text, unfold)
+    end
   end
 end
 

data/kramdown-rfc2629.gemspec

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

@@ -702,6 +702,10 @@ COLORS
             checks = el.attr.delete("check")
             postprocs = el.attr.delete("post")
             case t
+            when "cbor"
+              warn "** There is no sourcecode-type “cbor”."
+              warn "**   Do you mean “cbor-diag” (diagnostic notation)"
+              warn "**   or “cbor-pretty” (annotated hex-dump)?"
             when "json"
               checks ||= "json"
             when /\A(.*)-from-yaml\z/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.4
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 2023-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown