kramdown-rfc2629 1.7.3 → 1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb7b62deaf23ec115b6b5b470e27bc099169d24ec1b09cd78e39a53f710d0319
-  data.tar.gz: 28ceab4f96a1c33dee2ab4c53ae4423069bb5f9d6f61e55a69ec8a1991b8109e
+  metadata.gz: c4312704a187b582d3529a40e9823be50ad351fed98b6e29ab808098c56f9a0b
+  data.tar.gz: 27b76a9e2993053e0833e26989d97c074a0a3dcae3b47fd40d1aeaa96d928620
 SHA512:
-  metadata.gz: 5e95b5dcecb044404550dc3f481581d7cd044e4738b805cd8156c217910cf22a5e69f50b0c5bfc907d2f10c58c568d8eb8856924e4a0ca84429861a1ea0429ef
-  data.tar.gz: e0298c6433e0063aad63e04336f4f4f722ff878d053a565efc2502b3de35a286388952c68ca72805b32f1322b9f71c541fae8f0a80ce22a5532817ac1327f816
+  metadata.gz: c759b0acce805b13a263ec9b7246524a880715ff347d2b55e804a068c267dac09dc4bbc0630fc397ccdf364dd1b33102eff048729acacb271601b161502365c1
+  data.tar.gz: 4fb895add0affa38a4504c0e610676cef702a336e4377fee1142b41ddf1f83541ec64084aceb103857d944a14680561b53d19327d4661b15ae65e65de5b7b67e

data/README.md

@@ -475,8 +475,8 @@ allow for automatic entry of items as normative/informative.
 (1.0.16:) Markdown footnotes are converted into `cref`s (XML2RFC formal
 comments; note that these are only visible if the pi "comments" is set to yes).
 The anchor is taken from the markdown footnote name. The source, if
-needed, can be supplied by an IAD, as in (first example with
-ALD):
+needed, can be supplied by an [IAL][], as in (first example also uses an
+[ALD][]):
 
 ```markdown
 {:cabo: source="cabo"}
@@ -494,7 +494,7 @@ Note that XML2RFC v2 doesn't allow structure in crefs. If you put any,
 you get the escaped verbatim XML...
 
 (1.0.11:) Allow overriding "style" attribute (via IAL =
-[inline attribute list][kdsyntax-ial]) in lists and spans
+[inline attribute list][IAL]) in lists and spans
 as in:
 
 ```markdown
@@ -549,8 +549,9 @@ note that this creates ugly blank space in some HTML converters).
 
 # Risks and Side-Effects
 
-The code is not very polished, but now quite stable; it has been successfully used for a
-number of non-trivial Internet-Drafts and RFCs.  You probably still need to
+The code is not very polished, but now quite stable; it has been
+successfully used for hundreds of non-trivial Internet-Drafts and RFCs.
+You probably still need to
 skim [v3][] if you want to write an Internet-Draft, but you
 don't really need to understand XML very much.  Knowing the basics of
 YAML helps with the metadata (but you'll understand it from the
@@ -563,12 +564,29 @@ This can for instance be used to obtain unnumbered appendices:
 ```markdown
 Acknowledgements
 ================
-{: numbered="no"}
+{: numbered="false"}
+
+John Mattsson was nice enough to point out the need for this being documented.
+```
+
+
+Note that this specific example is covered by a predefined
+kramdown-rfc ["attribute list definition" (ALD)][ALD]:
+
+```markdown
+{:unnumbered: numbered="false"}
+```
+
+so the conventional way to write this example would be the somewhat simpler:
+
+```markdown
+Acknowledgements
+================
+{:unnumbered}
 
 John Mattsson was nice enough to point out the need for this being documented.
 ```
 
-[IAL]: https://kramdown.gettalong.org/syntax.html#inline-attribute-lists
 
 # Upconversion
 
@@ -638,7 +656,8 @@ made it possible to license kramdown-rfc under the same license.
 
 [kramdown]: https://kramdown.gettalong.org
 [kdsyntax]: http://kramdown.gettalong.org/syntax.html
-[kdsyntax-ial]: http://kramdown.gettalong.org/syntax.html#inline-attribute-lists
+[IAL]: https://kramdown.gettalong.org/syntax.html#inline-attribute-lists
+[ALD]: https://kramdown.gettalong.org/syntax.html#attribute-list-definitions
 [stupid]: http://tools.ietf.org/id/draft-hartke-xmpp-stupid-00
 [RFC 2629]: https://www.rfc-editor.org/rfc/rfc2629.html
 [RFC 7749]: https://www.rfc-editor.org/rfc/rfc7749.html

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,17 +77,54 @@ 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] = ''

data/kramdown-rfc2629.gemspec

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

@@ -40,11 +40,19 @@ module KramdownRFC
     def attr(pn)
       val, an = van(pn)
       @av[an.intern] = val
-      %{#{an}="#{escattr(val)}"}    if val
+      %{#{an}="#{escattr(val)}"}    if val # see attrtf below
     end
     def attrs(*pns)
       pns.map{ |pn| attr(pn) if pn }.compact.join(" ")
     end
+    def attrtf(pn)              # can do an overriding false value
+      val, an = van(pn)
+      @av[an.intern] = val
+      %{#{an}="#{escattr(val)}"}    unless val.nil?
+    end
+    def attrstf(*pns)
+      pns.map{ |pn| attrtf(pn) if pn }.compact.join(" ")
+    end
     def ele(pn, attr=nil, defcontent=nil, markdown=false)
       val, an = van(pn)
       val ||= defcontent

data/lib/kramdown-rfc/refxml.rb

@@ -17,7 +17,8 @@ module KramdownRFC
   def self.ref_to_xml(k, v)
     vps = KramdownRFC::ParameterSet.new(v)
     erb = ERB.trim_new <<-REFERB, '-'
-<reference anchor="<%= escattr(k) %>" <%= vps.attr("target") %>>
+<reference anchor="<%= escattr(k) %>" <%=
+        vps.attrstf("target", "quoteTitle=quote-title=quotetitle=qt") %>>
   <front>
     <%= vps.ele("title") -%>
 

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.3
+  version: 1.7.5
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown