kramdown-rfc2629 1.7.10 → 1.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a5264ae5d33d3262c29ecb664f1e40d0ad952fe43eea5858d291aab075159b
-  data.tar.gz: b3658555f711dce89c2c2919520b7e1734d620cdebba552b2eec33a24de78bf2
+  metadata.gz: a02556065093c31f3e45dd93a7497bd94a08e304d8eb00a409d2ee15da28987c
+  data.tar.gz: 8bb1dd4ea40f37625497b6742fa0c8822620c9a237e773ed1d2f6797e47269ba
 SHA512:
-  metadata.gz: 9624afa4465c9e3307568787cbd49f18efa8f8924d12398b3c40c413607af0dd23b592e3456fe21d18ce7ac4a37cf8925aefc86f32ef8d5c183ded1197c52404
-  data.tar.gz: 4627bc17140218836e34cb22237a7cea860c9f6b74452292dcab4e83ced32444386236c247848984afd62a7d5db84500b46890c2a369e12cfda5510c838b6bc0
+  metadata.gz: bd31dc90ac74e3f080491ef7df46814f90b7f60d801547598c8e4086215462280fa78e58c01b25b28c26753fb5021025828c768bbb8a792db67c494d398f05e7
+  data.tar.gz: 917ebce9132621c9117160273cdab943cf1ec947cc632f320557c0cdb18dbcc01c1c9ead0e79c3a254671d34eb3c4cf91f4fdc6578b0bd6c7454348cb3999a48

data/bin/kramdown-rfc-lsr

@@ -0,0 +1,185 @@
+#!/usr/bin/env ruby -KU
+# frozen_string_literal: true
+require 'rexml/document'        # for SVG and bibxml acrobatics
+require 'yaml'
+require 'json'
+require 'shellwords'
+require 'fileutils'
+begin
+  require 'open-uri/cached'
+rescue LoadError
+  warn '*** please "gem install open-uri-cached" to enable caching'
+  require 'open-uri'
+end
+require_relative '../lib/kramdown-rfc/rexml-all-text.rb'
+
+target = :shortname
+require 'optparse'
+begin
+  op = OptionParser.new do |opts|
+    opts.banner = "Usage: kramdown-rfc-lsr [options] xml-source"
+    opts.on("-u", "--url", "Source is URL") do |v|
+      target = :url
+    end
+    opts.on("-s", "--shortname", "Source is shortname (default)") do |v|
+      target = :shortname
+    end
+    opts.on("-f", "--file", "Source is filename") do |v|
+      target = :file
+    end
+  end
+  op.parse!
+rescue Exception => e
+  warn e
+  exit 1
+end
+
+$exit_code = 0
+
+if target != :file && ARGV.size != 1
+  puts op
+  exit 1
+end
+xmlsource = ARGV[0]
+if target == :shortname
+  xmlsource = case xmlsource
+              when /^(?:rfc)?(\d+)$/i
+                "https://www.rfc-editor.org/rfc/rfc#{$1.to_i.to_s}.xml"
+              when /^(?:draft-|I-D.|)(.*-\d\d)$/
+                "https://www.ietf.org/archive/id/draft-#$1.xml"
+              # XXX find xml source for most recent version!
+              else
+                warn "*** Can't parse shortname #{xmlsource.inspect}"
+                puts op
+                exit 1
+              end
+  target = :url
+end
+
+begin
+  xml = case target
+        when :file
+          ARGF.read
+        when :url
+          URI(xmlsource).open.read
+        else
+          fail
+        end
+rescue Exception => e
+  warn "#{xmlsource.inspect}: #{e}"
+  exit 1
+end
+
+doc = REXML::Document.new(xml)
+
+def series_info_to_URI(si)
+  case si[:name]
+  when "RFC"
+    "https://www.rfc-editor.org/rfc/rfc#{si[:value]}.xml"
+  when "Internet-Draft"
+    "https://www.ietf.org/archive/id/#{si[:value]}.xml"
+  end
+end
+
+
+def series_info_to_name(si)
+  case si[:name]
+  when "RFC"
+    "RFC#{si[:value]}"
+  when "Internet-Draft"
+    si[:value]
+  end
+end
+
+def section_number_to_pn(s)
+  if /^[0-9]/ =~ s
+    "section-#{s}"
+  elsif /[.]/ =~ s
+    "section-#{s.downcase}"
+  else
+    "section-appendix.#{s.downcase}"
+  end
+end
+
+references = Hash[REXML::XPath.match(doc.root, "//reference").map {|r|
+                    si = REXML::XPath.match(r, "seriesInfo").map {|s|
+                      series_info_to_URI(s)}.compact.first
+                    sn = REXML::XPath.match(r, "seriesInfo").map {|s|
+                      series_info_to_name(s)}.compact.first
+                    [r[:anchor], si ? [si, sn] : nil]
+}]                              # XXX duplicates?
+
+puts "# #{xmlsource}"
+
+per_reference = Hash.new { |h, k| h[k] = Set[]}
+
+REXML::XPath.each(doc.root, "//xref[@section]") do |x|
+  trg = x[:target]
+  if x[:relative]
+    puts "\n## #{x[:target]}#{x[:relative]}: #{x[:section]}"
+  else
+    # p x
+    per_reference[trg] << x[:section]
+  end
+end
+
+def error_out(s)
+  warn ""
+  warn s
+  warn ""
+  $exit_code = 1
+end
+
+per_reference.keys.sort.each do |trg|
+  uri, sname = references[trg]
+  add = +''
+  if sname != trg
+    add << " [#{sname}]"
+  end
+  begin
+    ref = URI(uri).open.read
+    refdoc = REXML::Document.new(ref)
+    add << " (#{REXML::XPath.match(refdoc.root, "//title").first.all_text})"
+  rescue OpenURI::HTTPError => e
+    begin
+      refjson = URI(uri.sub(/\.xml$/, ".json")).open.read
+      refdata = JSON.load(refjson)
+      add << " (#{refdata["title"]})"
+    rescue Exception => e
+      add << " [No XML or JSON]"
+    end
+  rescue Exception => e
+    warn "*** error getting #{uri.inspect}: #{e}"
+  end
+  puts "\n## #{trg}#{add}"
+  per_reference[trg].to_a.sort.each do |s| # XXX numerically
+    secterm = if /^[0-9]/ =~ s
+                "Section"
+              else
+                "Appendix"
+              end
+    add = +''
+    if refdoc
+      # find section name from anchor s
+      # secname = "DUMMY" # REXML::XPath.match(refdoc.root, "//section").first.all_text
+      secpn = section_number_to_pn(s)
+      secs = REXML::XPath.match(refdoc.root, "//section[@pn=$pn]", {}, {"pn" => secpn})
+      secname = nil
+      case secs.size
+      when 0
+        error_out "*** cannot match #{secpn} in #{trg}"
+        secname = "*** DOESN'T EXIST ***"
+      when 1
+        sec = secs.first
+        secname = sec[:title] || sec.elements["name"].all_text
+      else
+        error_out "*** multiple matches for #{secpn} in #{trg}"
+        secname = "*** MULTIPLE MATCHES ***"
+      end
+      add << " (#{secname})"
+    end
+    puts "* #{secterm} #{s}#{add}"
+  end
+end
+
+exit $exit_code

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.7.10'
+  s.version = '1.7.12'
   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.}
@@ -13,11 +13,12 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('unicode-scripts', '~> 1.0')
   s.add_dependency('net-http-persistent', '~> 4.0')
   s.add_dependency('differ', '~>0.1')
-  s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc bin/kramdown-rfc2629 bin/doilit bin/echars bin/kramdown-rfc-extract-markdown bin/kramdown-rfc-extract-sourcecode data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json bin/kramdown-rfc-cache-subseries-bibxml bin/kramdown-rfc-autolink-iref-cleanup bin/de-gfm bin/kramdown-rfc-clean-svg-ids)
+  s.files = Dir['lib/**/*.rb'] + %w(README.md LICENSE kramdown-rfc2629.gemspec bin/kdrfc bin/kramdown-rfc bin/kramdown-rfc2629 bin/doilit bin/echars bin/kramdown-rfc-extract-markdown bin/kramdown-rfc-extract-sourcecode bin/kramdown-rfc-lsr data/kramdown-rfc2629.erb data/encoding-fallbacks.txt data/math.json bin/kramdown-rfc-cache-subseries-bibxml bin/kramdown-rfc-autolink-iref-cleanup bin/de-gfm bin/kramdown-rfc-clean-svg-ids)
   s.require_path = 'lib'
   s.executables = ['kramdown-rfc', 'kramdown-rfc2629', 'doilit', 'echars',
                    'kramdown-rfc-extract-markdown',
                    'kramdown-rfc-extract-sourcecode',
+                   'kramdown-rfc-lsr',
                    'kdrfc', 'kramdown-rfc-cache-i-d-bibxml',
                    'kramdown-rfc-cache-subseries-bibxml',
                    'kramdown-rfc-autolink-iref-cleanup',

data/lib/kramdown-rfc2629.rb

@@ -33,6 +33,15 @@ end
 
 module Kramdown
 
+  Kramdown::Options.define(:ol_start_at_first_marker, Kramdown::Options::Boolean, false, <<~EOF)
+      If this option is `true`, an ordered list (<ol) will use the
+      number in its first marker (1 for 1. etc.) as the default value
+      of the start= attribute.
+
+      Default: false (for backward compatibility)
+      Used by: RFCXML converter
+    EOF
+
   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:
@@ -919,6 +928,10 @@ COLORS
       end
 
       def convert_ol(el, indent, opts)
+        if @options[:ol_start_at_first_marker] and (first_list_marker =
+                                                    el.options[:first_list_marker])
+          el.attr['start'] ||= first_list_marker[/\d+/]
+        end
         nested_types = opts[:nested_ol_types] || ["1"]
         # warn "** ol opts #{opts.inspect} types #{nested_types.inspect}"
         if nested_attr = el.attr.delete('nestedOlTypes')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.7.10
+  version: 1.7.12
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -147,6 +147,7 @@ executables:
 - echars
 - kramdown-rfc-extract-markdown
 - kramdown-rfc-extract-sourcecode
+- kramdown-rfc-lsr
 - kdrfc
 - kramdown-rfc-cache-i-d-bibxml
 - kramdown-rfc-cache-subseries-bibxml
@@ -169,6 +170,7 @@ files:
 - bin/kramdown-rfc-clean-svg-ids
 - bin/kramdown-rfc-extract-markdown
 - bin/kramdown-rfc-extract-sourcecode
+- bin/kramdown-rfc-lsr
 - bin/kramdown-rfc2629
 - data/encoding-fallbacks.txt
 - data/kramdown-rfc2629.erb
@@ -206,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFCXML (RFC 799x).