kramdown-rfc2629 1.7.8 → 1.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c99a7ec32844a2fced30e2bfe3e2298e8aeedd25ee6a2121dbe9a78192c5ec20
-  data.tar.gz: 93120c8aea044967c819a98b25b653996bfc6e2336b5e5e7a8ec22a97912c55f
+  metadata.gz: b0a5264ae5d33d3262c29ecb664f1e40d0ad952fe43eea5858d291aab075159b
+  data.tar.gz: b3658555f711dce89c2c2919520b7e1734d620cdebba552b2eec33a24de78bf2
 SHA512:
-  metadata.gz: c665a92ccd06bfd50109368d23f403afbb520fe1bad419907cef87be7a035de77616a423ddcee8fadea525cb182cb05797f06cb50a78677c72039dc12074d24d
-  data.tar.gz: f6b7fbd510a50e88b48bae36be9447755ff970b04876e8ebfe0bdfbcdcb8a292abe24745f900f4c9445d8988e10af6585b8ca1dd6cdfc9701eeaafb3fc33fbb5
+  metadata.gz: 9624afa4465c9e3307568787cbd49f18efa8f8924d12398b3c40c413607af0dd23b592e3456fe21d18ce7ac4a37cf8925aefc86f32ef8d5c183ded1197c52404
+  data.tar.gz: 4627bc17140218836e34cb22237a7cea860c9f6b74452292dcab4e83ced32444386236c247848984afd62a7d5db84500b46890c2a369e12cfda5510c838b6bc0

data/README.md

@@ -180,7 +180,7 @@ and then just write `{{RFC2119}}` or `{{RFC1925}}`.  (Yes, there is a
 colon in the YAML, because this is a hash that could provide other
 information.)
 
-Since version 1.1, references imported from the [XML2RFC][] databases
+Since version 1.1, references imported from the [BibXML][] databases
 can be supplied with a replacement label (anchor name).  E.g., RFC 793
 could be referenced as `{{!TCP=RFC0793}}`, further references then just
 can say `{{TCP}}`; both will get `[TCP]` as the label.  In the
@@ -205,7 +205,7 @@ Notes about this feature:
   maintaining live references then may require some manual editing to
   get rid of the custom anchors.
 
-If your references are not in the [XML2RFC][] databases and do not
+If your references are not in the [BibXML][] databases and do not
 have a DOI (that also happens to have correct data) either, you need
 to spell it out like in the examples below:
 
@@ -667,7 +667,7 @@ made it possible to license kramdown-rfc under the same license.
 [IETF]: http://www.ietf.org
 [Miek Gieben]: http://www.miek.nl/
 [pandoc2rfc]: https://github.com/miekg/pandoc2rfc/
-[XML2RFC]: http://xml.resource.org
+[XML2RFC]: https://github.com/ietf-tools/xml2rfc
 [RFC 7328]: http://tools.ietf.org/html/rfc7328
 [mmark-git]: https://github.com/miekg/mmark
 [mmark]: https://mmark.nl
@@ -676,3 +676,4 @@ made it possible to license kramdown-rfc under the same license.
 [asciidoctor-rfc]: https://github.com/metanorma/asciidoctor-rfc
 [asciidoc]: http://www.methods.co.nz/asciidoc/
 [orgmode]: http://orgmode.org
+[BibXML]: https://bib.ietf.org/

data/kramdown-rfc2629.gemspec

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

@@ -33,6 +33,44 @@ end
 
 module Kramdown
 
+  Kramdown::Options.define(:nested_ol_types, Object, %w[1], <<~EOF) do |val|
+      Values for type= attribute for nested ordered lists (ol).
+      The value needs to be an array of <ol type= values, expressed as one of:
+      1. A YAML array
+      2. A string that will be split on commas (with optional blank space following)
+      3. A string that will be split on blank space
+
+      Default: ["1"]
+      Used by: RFCXML converter
+    EOF
+    val = case val
+          when String
+            if val[0] == "[" && val[-1] == "]"
+              begin
+                val = YAML.safe_load(val)
+              rescue Psych::SyntaxError
+                warn "** YAML syntax error in nested_ol_types=#{val.inspect}"
+                val = %w[1]
+              end
+            else
+              val = val.split(/, */)
+              val = val[0].split(/ +/) if val.size == 1
+            end
+            Kramdown::Options.simple_array_validator(val, :nested_ol_types)
+          when Array
+            val.map!{ |x| x.to_s }
+            val = Kramdown::Options.simple_array_validator(val, :nested_ol_types)
+          else
+            raise Kramdown::Error, "Invalid value for option '#{:nested_ol_types}': '#{val.inspect}'"
+          end
+    if val == []
+      val = %w[1]
+      warn "** Option #{:nested_ol_types} cannot be empty, defaulting to #{val.inspect}"
+    end
+    val
+  end
+
+
   module Parser
 
     class RFC2629Kramdown < Kramdown
@@ -347,7 +385,14 @@ module Kramdown
         location + @location_delta + @location_correction
       end
 
-      def convert(el, indent = -INDENTATION, opts = {})
+      def convert(el)
+        opts = el.options[:options]
+        # warn "** tree opts #{opts.inspect}"
+        if nested_ol_types = @options[:nested_ol_types]
+          opts[:nested_ol_types] ||= nested_ol_types
+          # warn "** tree opts out #{opts.inspect}"
+        end
+        indent = -INDENTATION
         if el.children[-1].type == :raw
           raw = convert1(el.children.pop, indent, opts)
         end
@@ -872,7 +917,22 @@ COLORS
           "#{' '*indent}<t><list#{attrstring}>\n#{inner(el, indent, opts)}#{' '*indent}</list></t>\n"
         end
       end
-      alias :convert_ol :convert_ul
+
+      def convert_ol(el, indent, opts)
+        nested_types = opts[:nested_ol_types] || ["1"]
+        # warn "** ol opts #{opts.inspect} types #{nested_types.inspect}"
+        if nested_attr = el.attr.delete('nestedOlTypes')
+          nested_types = ::Kramdown::Options.parse(:nested_ol_types, nested_attr)
+        end
+        if nested_types = nested_types.dup
+          # warn "** nested_types #{nested_types.inspect}"
+          nested_here = nested_types.shift
+          opts = opts.merge(nested_ol_types: nested_types << nested_here)
+          el.attr['type'] ||= nested_here
+          # warn "** actual ol type #{el.attr['type'].inspect}"
+        end
+        convert_ul(el, indent, opts)
+      end
 
       def convert_dl(el, indent, opts)
         if $options.v3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.8
+  version: 1.7.10
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFCXML (RFC 799x).