kramdown-rfc2629 1.4.18 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f351fb251c634da227a9ce9202094ee20ac11689be7b2144f118ba07aa2b31fb
-  data.tar.gz: 45d0559f1f6c6ff2c4ba18bab26a4e88bec8faad622cf0b9183c144eb419441f
+  metadata.gz: aca914cd77e805824fc1d15d642e3f0e453f12e5ffe0ee17f56b0a497b047382
+  data.tar.gz: df4c1b4c6d73a796183ba2bf8503ff8b7b943025fd61842767250de4107b27be
 SHA512:
-  metadata.gz: 2d3acf198070f8d7b69995f9f581302a6d20bbb24241350a169ef8cc5ccfeb49d191adfaaa11442df5859534812761d91c7f7c5a8b22b5a2aec19c8d2a02e48b
-  data.tar.gz: b1c5d6d9c968d82a453bcdfcc234e1dc4f3844ba9084942f73fd5212258d0d1e361f55fc1cb36910b58a4c2e68286cfe20695cf8d6d1c9e538a9907164d89d71
+  metadata.gz: 5219932525720483e742f5c0e0bb90957c1766c9a019c76491b45b05351e3a864be4ff69bebff5ec942dfb39a090c4b0fbf7f6b4b502f4f526105b46b03c00ca
+  data.tar.gz: eb2d6d95a67cb80ca52ba46eb299d6edb4a11d9e760c09c36377372876b8c99cfcfd36b6e6461a47797d7e15bd85c3ce1f9e00aa8317a1140361cfea7658cfee

data/README.md

@@ -562,7 +562,7 @@ remaining 20 % some more, but that hasn't been done.
 
 If you have XML, there is an experimental upconverter that does 99 %
 of the work.  Please [contact the
-author](mailto:cabo@tzi.org?subject=Markdown for RFCXML) if you want
+author](mailto:cabo@tzi.org?subject=Markdown%20for%20RFCXML) if you want
 to try it.
 
 Actually, if the XML was generated by kramdown-rfc2629, you can simply

data/bin/kdrfc

@@ -1,107 +1,13 @@
 #!/usr/bin/env ruby -KU
-require 'uri'
-require 'net/http'
-require 'open3'
+require 'kramdown-rfc/kdrfc-processor'
+require 'optparse'
 
 # try to get this from gemspec.
 KDRFC_VERSION=Gem.loaded_specs["kramdown-rfc2629"].version rescue "unknown-version"
 
-def v3_flag?
-  $options.v3 ? ["--v3"] : []
-end
-
-def process_mkd(input, output)
-  warn "* converting locally from markdown #{input} to xml #{output}" if $options.verbose
-  o, s = Open3.capture2("kramdown-rfc2629", *v3_flag?, input)
-  if s.success?
-    File.open(output, "w") do |fo|
-      fo.print(o)
-    end
-    warn "* #{output} written" if $options.verbose
-  else
-    warn "*** kramdown-rfc failed, status #{s.exitstatus}"
-    exit 1
-  end
-end
-
-def run_idnits(txt_fn)
-  unless system("idnits", txt_fn)
-    warn "*** problem #$? running idnits"
-  end
-end
+kdrfc = KramdownRFC::KDRFC.new
+kdrfc.options.txt = true             # default
 
-def process_xml(*args)
-  if $options.remote
-    process_xml_remotely(*args)
-  else
-    process_xml_locally(*args)
-  end
-end
-
-def process_xml_locally(input, output, *flags)
-  warn "* converting locally from xml #{input} to txt #{output}" if $options.verbose
-  begin
-    o, s = Open3.capture2("xml2rfc", *v3_flag?, *flags, input)
-    puts o
-    if s.success?
-      warn "* #{output} written" if $options.verbose
-    else
-      warn "*** xml2rfc failed, status #{s.exitstatus} (possibly try with -r)"
-      exit 1
-    end
-  rescue Errno::ENOENT
-    warn "*** falling back to remote processing" if $options.verbose
-    process_xml_remotely(input, output)
-  end
-end
-
-XML2RFC_WEBSERVICE = ENV["KRAMDOWN_XML2RFC_WEBSERVICE"] ||
-                     'http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc-dev.cgi'
-
-
-def process_xml_remotely(input, output)
-  warn "* converting remotely from xml #{input} to txt #{output}" if $options.verbose
-  url = URI(XML2RFC_WEBSERVICE)
-  req = Net::HTTP::Post.new(url)
-  form = [["modeAsFormat", "txt/#{"v3" if $options.v3}ascii"],
-          ["type", "binary"],
-          ["input", File.open(input),
-           {filename: "input.xml",
-            content_type: "text/plain"}]]
-  diag = ["url/form: ", url, form].inspect
-  req.set_form(form, 'multipart/form-data')
-  res = Net::HTTP::start(url.hostname, url.port,
-                         :use_ssl => url.scheme == 'https' ) {|http|
-    http.request(req)
-  }
-  case res
-  when Net::HTTPOK
-    case res.content_type
-    when 'application/octet-stream'
-      if res.body == ''
-        warn "*** HTTP response is empty with status #{res.code}, not written"
-        exit 1
-      end
-      File.open(output, "w") do |fo|
-        fo.print(res.body)
-      end
-      warn "* #{output} written" if $options.verbose
-    else
-      warn "*** HTTP response has unexpected content_type #{res.content_type} with status #{res.code}, #{diag}"
-      warn res.body
-      exit 1
-    end
-  else
-    warn "*** HTTP response: #{res.code}, #{diag}"
-    exit 1
-  end
-end
-
-require 'optparse'
-require 'ostruct'
-
-$options = OpenStruct.new
-$options.txt = true             # default
 op = OptionParser.new do |opts|
   opts.banner = <<BANNER
 Usage: kdrfc [options] file.md|file.mkd|file.xml
@@ -116,63 +22,45 @@ BANNER
     exit
   end
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    $options.verbose = v
+    kdrfc.options.verbose = v
   end
   opts.on("-r", "--[no-]remote", "Run xml2rfc remotely even if there is a local one") do |v|
-    $options.remote = v
+    kdrfc.options.remote = v
   end
   opts.on("-x", "--[no-]xml", "Convert to xml only") do |v|
-    $options.xml_only = v
+    kdrfc.options.xml_only = v
   end
   opts.on("-p", "--[no-]prep", "Convert xml to prepped xml") do |v|
-    $options.prep = v
+    kdrfc.options.prep = v
   end
   opts.on("-P", "-f", "--[no-]pdf", "Convert xml to PDF") do |v|
-    $options.pdf = v
+    kdrfc.options.pdf = v
   end
   opts.on("-c", "--[no-]convert", "Convert xml to v3 xml") do |v|
-    $options.v2v3 = v
+    kdrfc.options.v2v3 = v
   end
   opts.on("-i", "--[no-]idnits", "Run idnits on the resulting text") do |v|
-    $options.idnits = v
+    kdrfc.options.idnits = v
   end
   opts.on("-h", "--[no-]html", "Convert to html as well") do |v|
-    $options.html = v
+    kdrfc.options.html = v
   end
   opts.on("-t", "--[no-]txt", "Convert to txt as well") do |v|
-    $options.txt = v
+    kdrfc.options.txt = v
   end
   opts.on("-3", "--[no-]v3", "Use RFCXML v3 processing rules") do |v|
-    $options.v3 = v
+    kdrfc.options.v3 = v
   end
 end
 op.parse!
 
-def process_the_xml(fn, base)
-  process_xml(fn, "#{base}.prepped.xml", "--preptool") if $options.prep
-  process_xml(fn, "#{base}.v2v3.xml", "--v2v3") if $options.v2v3
-  process_xml(fn, "#{base}.txt") if $options.txt || $options.idnits
-  process_xml(fn, "#{base}.html", "--html") if $options.html
-  process_xml(fn, "#{base}.pdf", "--pdf") if $options.pdf
-  run_idnits("#{base}.txt") if $options.idnits
-end
-
 case ARGV.size
 when 1
   fn = ARGV[0]
-  case fn
-  when /(.*)\.xml\z/
-    if $options.xml_only
-      warn "*** You already have XML"
-    else                        # FIXME: copy/paste
-      process_the_xml(fn, $1)
-    end
-  when /(.*)\.mk?d\z/
-    xml = "#$1.xml"
-    process_mkd(fn, xml)
-    process_the_xml(xml, $1) unless $options.xml_only
-  else
-    warn "Unknown file type: #{fn}"
+  begin
+    kdrfc.process(fn)
+  rescue StandardError => e
+    warn e.to_s
     exit 1
   end
 else

data/bin/kramdown-rfc-cache-subseries-bibxml

@@ -14,7 +14,7 @@ require 'fileutils'
 
 begin
   require 'net/http/persistent'
-rescue
+rescue LoadError
   warn "*** please install net-http-persistent:"
   warn "   gem install net-http-persistent"
   warn "(prefix by sudo only if required)."

data/data/kramdown-rfc2629.erb

@@ -69,6 +69,17 @@
 
   <middle>
 
+{:/nomarkdown}
+{:quote: gi="blockquote"}
+{:aside: gi="aside"}
+{:markers: sourcecode-markers="true"}
+{:unnumbered: numbered="false"}
+{:vspace: vspace="0"}
+{:removeinrfc: removeinrfc="true"}
+{:notoc: toc="exclude"}
+{:compact: spacing="compact"}
+{::nomarkdown}
+
 <%= sechash.delete("middle") %>
 
   </middle>

data/kramdown-rfc2629.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'kramdown-rfc2629'
-  s.version = '1.4.18'
+  s.version = '1.5.3'
   s.summary = "Kramdown extension for generating RFC 7749 XML."
   s.description = %{An RFC7749 (XML2RFC) generating backend for Thomas Leitner's
 "kramdown" markdown parser.  Mostly useful for RFC writers.}

data/lib/kramdown-rfc/kdrfc-processor.rb

@@ -0,0 +1,154 @@
+require 'uri'
+require 'net/http'
+require 'open3'
+require 'ostruct'
+
+module KramdownRFC
+
+class KDRFC
+
+  attr_reader :options
+
+  def initialize
+    @options = OpenStruct.new
+  end
+
+  # )))
+
+KDRFC_PREPEND = [ENV["KDRFC_PREPEND"]].compact
+
+def v3_flag?
+  @options.v3 ? ["--v3"] : []
+end
+
+def process_mkd(input, output)
+  warn "* converting locally from markdown #{input} to xml #{output}" if @options.verbose
+  o, s = Open3.capture2(*KDRFC_PREPEND, "kramdown-rfc2629", *v3_flag?, input)
+  if s.success?
+    File.open(output, "w") do |fo|
+      fo.print(o)
+    end
+    warn "* #{output} written" if @options.verbose
+  else
+    raise IOError.new("*** kramdown-rfc failed, status #{s.exitstatus}")
+  end
+end
+
+def run_idnits(txt_fn)
+  unless system("idnits", txt_fn)
+    warn "*** problem #$? running idnits"
+  end
+end
+
+def process_xml(*args)
+  if @options.remote
+    process_xml_remotely(*args)
+  else
+    process_xml_locally(*args)
+  end
+end
+
+def process_xml_locally(input, output, *flags)
+  warn "* converting locally from xml #{input} to txt #{output}" if @options.verbose
+  begin
+    o, s = Open3.capture2(*KDRFC_PREPEND, "xml2rfc", *v3_flag?, *flags, input)
+    puts o
+    if s.success?
+      warn "* #{output} written" if @options.verbose
+    else
+      raise IOError.new("*** xml2rfc failed, status #{s.exitstatus} (possibly try with -r)")
+    end
+  rescue Errno::ENOENT
+    warn "*** falling back to remote xml2rfc processing (web service)" # if @options.verbose
+    process_xml_remotely(input, output, *flags)
+  end
+end
+
+XML2RFC_WEBSERVICE = ENV["KRAMDOWN_XML2RFC_WEBSERVICE"] ||
+                     'http://xml2rfc.tools.ietf.org/cgi-bin/xml2rfc-dev.cgi'
+
+MODE_AS_FORMAT = {
+  nil => {                    # v2
+    "--text" => "txt/ascii",
+    "--html" => "html/ascii",
+  },
+  true => {                     # v3
+    "--text" => "txt/v3ascii",
+    "--html" => "html/v3ascii",
+    "--v2v3" => "v3xml/ascii",
+  }
+}
+
+def process_xml_remotely(input, output, *flags)
+  warn "* converting remotely from xml #{input} to txt #{output}" if @options.verbose
+  format = flags[0] || "--text"
+  # warn [:V3, @options.v3].inspect
+  maf = MODE_AS_FORMAT[@options.v3][format]
+  unless maf
+    raise ArgumentError.new("*** don't know how to convert remotely from xml #{input} to txt #{output}")
+  end
+  url = URI(XML2RFC_WEBSERVICE)
+  req = Net::HTTP::Post.new(url)
+  form = [["modeAsFormat", maf],
+          ["type", "binary"],
+          ["input", File.open(input),
+           {filename: "input.xml",
+            content_type: "text/plain"}]]
+  diag = ["url/form: ", url, form].inspect
+  req.set_form(form, 'multipart/form-data')
+  res = Net::HTTP::start(url.hostname, url.port,
+                         :use_ssl => url.scheme == 'https' ) {|http|
+    http.request(req)
+  }
+  case res
+  when Net::HTTPOK
+    case res.content_type
+    when 'application/octet-stream'
+      if res.body == ''
+        raise IOError.new("*** HTTP response is empty with status #{res.code}, not written")
+      end
+      File.open(output, "w") do |fo|
+        fo.print(res.body)
+      end
+      warn "* #{output} written" if @options.verbose
+    else
+      warning = "*** HTTP response has unexpected content_type #{res.content_type} with status #{res.code}, #{diag}"
+      warning << "\n"
+      warning << res.body
+      raise IOError.new(warning)
+    end
+  else
+    raise IOError.new("*** HTTP response: #{res.code}, #{diag}")
+  end
+end
+
+def process_the_xml(fn, base)
+  process_xml(fn, "#{base}.prepped.xml", "--preptool") if @options.prep
+  process_xml(fn, "#{base}.v2v3.xml", "--v2v3") if @options.v2v3
+  process_xml(fn, "#{base}.txt") if @options.txt || @options.idnits
+  process_xml(fn, "#{base}.html", "--html") if @options.html
+  process_xml(fn, "#{base}.pdf", "--pdf") if @options.pdf
+  run_idnits("#{base}.txt") if @options.idnits
+end
+
+def process(fn)
+  case fn
+  when /(.*)\.xml\z/
+    if @options.xml_only
+      warn "*** You already have XML"
+    else                        # FIXME: copy/paste
+      process_the_xml(fn, $1)
+    end
+  when /(.*)\.mk?d\z/
+    xml = "#$1.xml"
+    process_mkd(fn, xml)
+    process_the_xml(xml, $1) unless @options.xml_only
+  else
+    raise ArgumentError.new("Unknown file type: #{fn}")
+  end
+end
+
+# (((
+end
+
+end

data/lib/kramdown-rfc/refxml.rb

@@ -57,17 +57,35 @@ module KramdownRFC
     aups
   end
 
+  # The below anticipates the "postalLine" changes.
+  # If a postalLine is used (abbreviated "postal" in YAML),
+  # non-postalLine elements are appended as further postalLines.
+  # This prepares for how "country" is expected to be handled
+  # specially with the next schema update.
+  # So an address is now best keyboarded as:
+  #   postal:
+  #     - Foo Street
+  #     - 28359 Bar
+  #   country: Germany
+
   PERSON_ERB = <<~ERB
     <<%= element_name%> <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
       <%= aups.ele("organization=org", aups.attrs("abbrev=orgabbrev",
                                                   *[$options.v3 && "ascii=orgascii"]), "") %>
       <address>
-<% postal = %w{street city region code country}.select{|gi| aups.has(gi)}
-   if postal != [] -%>
+<% postal_elements = %w{extaddr pobox street cityarea city region code sortingcode country postal}.select{|gi| aups.has(gi)}
+   if postal_elements != [] -%>
         <postal>
-<%   postal.each do |gi| -%>
+<% if pl = postal_elements.delete("postal") -%>
+          <%= aups.ele("postalLine=postal") %>
+<%   postal_elements.each do |gi| -%>
+          <%= aups.ele("postalLine=" << gi) %>
+<%   end -%>
+<% else -%>
+<%   postal_elements.each do |gi| -%>
           <%= aups.ele(gi) %>
 <%   end -%>
+<% end -%>
         </postal>
 <% end -%>
 <% %w{phone facsimile email uri}.select{|gi| aups.has(gi)}.each do |gi| -%>

data/lib/kramdown-rfc2629.rb

@@ -53,6 +53,9 @@ module Kramdown
 
       def self.idref_cleanup(href)
         # can't start an IDREF with a number or reserved start
+        if href =~ / /
+          warn "** space(s) in cross-reference '#{href}' -- are you trying to use section references?"
+        end
         href.gsub(/\A(?:[0-9]|section-|u-|figure-|table-|iref-)/) { "_#{$&}" }
       end
 
@@ -125,7 +128,7 @@ module Kramdown
             when /\A(.*) \((#{SECTIONS_RE})\)\z/
               href = $1
               handle_bares($2, attr, "parens", href)
-            when /\A([\w.]+)<(.+)\z/
+            when /\A(#{XREF_BASE})<(.+)\z/
               href = $2
               attr['section'] = $1
               attr['sectionFormat'] = 'bare'
@@ -545,8 +548,17 @@ COLORS
 
       def convert_blockquote(el, indent, opts)
         text = inner(el, indent, opts)
+        if $options.v3
+          gi = el.attr.delete('gi')
+          if gi && gi != 'ul'
+            "#{' '*indent}<#{gi}#{el_html_attributes(el)}>\n#{text}#{' '*indent}</#{gi}>\n"
+          else
+            "#{' '*indent}<ul#{el_html_attributes_with(el, {"empty" => 'true'})}><li>\n#{text}#{' '*indent}</li></ul>\n"
+          end
+        else
         text = "<t></t>" unless text =~ /</ # empty block quote
         "#{' '*indent}<t><list style='empty'#{el_html_attributes(el)}>\n#{text}#{' '*indent}</list></t>\n"
+        end
       end
 
       def end_sections(to_level, indent)
@@ -1032,18 +1044,30 @@ COLORS
         # this would be more like xml2rfc v3:
         # "\n#{' '*indent}<cref>\n#{inner(el.value, indent, opts).rstrip}\n#{' '*indent}</cref>"
         content = inner(el.value, indent, opts).strip
-        content = escape_html(content.sub(/\A<t>(.*)<\/t>\z/m) {$1}, :text) # text only...
+        content = content.sub(/\A<t>(.*)<\/t>\z/m) {$1}
         name = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(el.options[:name])
+        o_name = name.dup
         while @footnote_names_in_use[name] do
-          if name =~ /:\d+\z/
+          if name =~ /_\d+\z/
             name.succ!
           else
-            name << ":1"
+            name << "_1"
           end
         end
         @footnote_names_in_use[name] = true
         attrstring = el_html_attributes_with(el, {"anchor" => name})
-        "\n#{' '*indent}<cref#{attrstring}>#{content}</cref>"
+        if $options.v3
+          if o_name[-1] == "-"
+            # Ignore HTML attributes.  Hmm.
+            content
+          else
+            # do not indent span-level so we can stick to previous word.  Good?
+            "<cref#{attrstring}>#{content}</cref>"
+          end
+        else
+          content = escape_html(content, :text) # text only...
+          "\n#{' '*indent}<cref#{attrstring}>#{content}</cref>"
+        end
       end
 
       def convert_raw(el, indent, opts)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.4.18
+  version: 1.5.3
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -80,6 +80,7 @@ files:
 - kramdown-rfc2629.gemspec
 - lib/kramdown-rfc/erb.rb
 - lib/kramdown-rfc/gzip-clone.rb
+- lib/kramdown-rfc/kdrfc-processor.rb
 - lib/kramdown-rfc/parameterset.rb
 - lib/kramdown-rfc/refxml.rb
 - lib/kramdown-rfc2629.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Kramdown extension for generating RFC 7749 XML.