kramdown-rfc2629 1.6.13 → 1.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52ce81714c14272005b47807396c6cac7764fa7a2931ca93b2661dfb479d4cf
-  data.tar.gz: a99b8e49ba4145ca88690ca0af1a1c6549c25a995cbfcb008763adea8a0b7b5d
+  metadata.gz: c27f3051dfa496902009b54c1999bcc3c54e28aec350bc04d1d69cfed6dd47f8
+  data.tar.gz: bf804a07bf573d56a6c4aaa561613b97efcd2803bb7ba4f98f38c7b196a409f2
 SHA512:
-  metadata.gz: 6204f7e5f2bbfebd84c4b3b068819008a66535948e5bf8f8eefdfe8a010ec69cde2cf910c0cec73ef74b9f75feb6e5d96d57519dd2e30f5a255406de82b10491
-  data.tar.gz: 3b595453599f3c33b44a2834ec4bea7306d48b2e6a3a0f1af27843e92013428e03341c20fe5d9f8b6398acca6a39c31890678d9afc1fa99f76eb2511eb72a27c
+  metadata.gz: 31250b75f0f17bc4afe558110461ffb5821cebdbffe2114d69bd6985dd0bd6152bcdcee02994726f08232495781da16453e9f7484f00cd94813d4f2568d6b934
+  data.tar.gz: 17a58bc7ac58cc18e7472802f9a0dc91b6a309adb4f3632ad563b54485b2bd913bb4abce8e8aac682633d81fee860bc5b9d81b8c6e168a41e1c5b36a910e8cf1

data/bin/doilit

@@ -1,16 +1,12 @@
 #!/usr/bin/env ruby
-require 'open-uri'
 require 'yaml'
-require 'json'
 require 'kramdown-rfc2629'
 require 'kramdown-rfc/parameterset'
 require 'kramdown-rfc/refxml'
+require 'kramdown-rfc/doi'
 
 # doilit -c 10.6028/NIST.SP.800-183 10.1016/j.adhoc.2015.04.007 10.1109/MIC.2012.29 10.1145/2507924.2507954
 
-
-ACCEPT_CITE_JSON = {"Accept" => "application/citeproc+json"}
-
 $verbose = false
 $fuzzy = false
 $handle = "a"
@@ -43,79 +39,9 @@ ARGV.each do |doi|
     warn "*** Usage: doilit [-c] [-f] [-v] [-h=handle|-x=xmlhandle] doi..."
     exit 1
   end
-  cite = JSON.parse(URI("https://dx.doi.org/#{doi}").open(ACCEPT_CITE_JSON).read)
-  puts cite.to_yaml if $verbose
-  lit = {}
-  ser = lit["seriesinfo"] = {}
-  lit["title"] = cite["title"]
-  if (st = cite["subtitle"]) && Array === st # defensive
-    st.delete('')
-    if st != []
-      lit["title"] << ": " << st.join("; ")
-    end
-  end
-  if authors = cite["author"]
-    lit["author"] = authors.map do |au|
-      lau = {}
-      if (f = au["family"])
-        if (g = au["given"])
-          lau["name"] = "#{g} #{f}"
-          lau["ins"] =  "#{g[0]}. #{f}"
-        else
-          lau["name"] = "#{f}"
-#          lau["ins"] =  "#{g[0]}. #{f}"
-        end
-      end
-      lau
-    end
-  end
-  if iss = cite["issued"]
-    if dp = iss["date-parts"]
-      if Integer === (dp = dp[0])[0]
-        lit["date"] = ["%04d" % dp[0], *dp[1..-1].map {|p| "%02d" % p}].join("-")
-      end
-    end
-  end
-  if !lit.key?("date") && $fuzzy && (iss = cite["created"])
-    if dp = iss["date-parts"]
-      if Integer === (dp = dp[0])[0]
-        lit["date"] = ["%04d" % dp[0], *dp[1..-1].map {|p| "%02d" % p}].join("-")
-      end
-    end
-  end
-  if (ct = cite["container-title"]) && ct != []
-    info = []
-    if v = cite["volume"]
-      vi = "vol. #{v}"
-      if (v = cite["journal-issue"]) && (issue = v["issue"])
-        vi << ", no. #{issue}"
-      end
-      info << vi
-    end
-    if p = cite["page"]
-      info << "pp. #{p}"
-    end
-    rhs = info.join(", ")
-    if info != []
-      ser[ct] = rhs
-    else
-      spl = ct.split(" ")
-      ser[spl[0..-2].join(" ")] = spl[-1]
-    end
-  elsif pub = cite["publisher"]
-    info = []
-    if t = cite["type"]
-      info << t
-    end
-    rhs = info.join(", ")
-    if info != []
-      ser[pub] = rhs
-    else
-      spl = pub.split(" ")
-      ser[spl[0..-2].join(" ")] = spl[-1]
-    end
-  end
-  lit["seriesinfo"]["DOI"] = cite["DOI"]
+
+  lit = doi_fetch_and_convert(doi, fuzzy: $fuzzy, verbose: $verbose)
+
   while litent[$handle]
     $handle.succ!
   end

data/data/kramdown-rfc2629.erb

@@ -99,14 +99,23 @@
        mail_local, mail_host = mail.split("@", 2)
      end
      if mail_host -%>
-<%     mail_subdomain, mail_domain = mail_host.split(".", 2) -%>
-<%     group = venue[:group] || mail_local # XXX -%>
-<%     arch = venue[:arch] || "https://mailarchive.ietf.org/arch/browse/#{mail_local}/" -%>
-<%     GROUPS = {"ietf" => "Working ", "irtf" => "Research "} -%>
-<%     gtype ||= "#{GROUPS[mail_subdomain]}Group" -%>
+<%     default_links = {
+                         "iab.org" => true,
+                         "ietf.org" => true,
+                         "irtf.org" => true,
+                       }[mail_host]
+       mail_subdomain, mail_domain = mail_host.split(".", 2)
+       group = venue[:group] || mail_local # XXX
+       arch = venue[:arch] || default_links && "https://mailarchive.ietf.org/arch/browse/#{mail_local}/"
+       subscribe = venue[:subscribe] || default_links && "https://www.ietf.org/mailman/listinfo/#{mail_local}/"
+       GROUPS = {"ietf" => "Working ", "irtf" => "Research "}
+       gtype ||= "#{GROUPS[mail_subdomain]}Group" -%>
         Discussion of this document takes place on the
-        <%=group%> <%=gtype%> mailing list (<eref target="mailto:<%=mail%>"/>),
-        which is archived at <eref target="<%=arch%>"/>.
+        <%=group%> <%=gtype%> mailing list (<eref target="mailto:<%=mail%>"/>)<% if arch -%>,
+        which is archived at <eref target="<%=arch%>"/><% end -%>.
+<% if subscribe -%>
+        Subscribe at <eref target="<%=subscribe%>"/>.
+<% end -%>
 <%   end -%>
 <%   if homepage -%>
         <%=gtype%> information can be found at <eref target="<%=homepage%>"/>.

data/kramdown-rfc2629.gemspec

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

@@ -0,0 +1,92 @@
+require 'open-uri'
+require 'json'
+require 'yaml'
+
+ACCEPT_CITE_JSON = {"Accept" => "application/citeproc+json"}
+
+def doi_fetch_and_convert(doi, fuzzy: false, verbose: false)
+  cite = JSON.parse(URI("https://dx.doi.org/#{doi}").open(ACCEPT_CITE_JSON).read)
+  puts cite.to_yaml if verbose
+  lit = {}
+  ser = lit["seriesinfo"] = {}
+  lit["title"] = cite["title"]
+  if (st = cite["subtitle"]) && Array === st # defensive
+    st.delete('')
+    if st != []
+      lit["title"] << ": " << st.join("; ")
+    end
+  end
+  if authors = cite["author"]
+    lit["author"] = authors.map do |au|
+      lau = {}
+      if (f = au["family"])
+        if (g = au["given"])
+          lau["name"] = "#{g} #{f}"
+          lau["ins"] =  "#{g[0]}. #{f}"
+        else
+          lau["name"] = "#{f}"
+#          lau["ins"] =  "#{g[0]}. #{f}"
+        end
+      end
+      if (f = au["affiliation"]) && Array === f
+        names = f.map { |affn|
+          if Hash === affn && (n = affn["name"]) && String === n
+            n
+          end
+        }.compact
+        if names.size > 0
+          lau["org"] = names.join("; ")
+        end
+      end
+      lau
+    end
+  end
+  if iss = cite["issued"]
+    if dp = iss["date-parts"]
+      if Integer === (dp = dp[0])[0]
+        lit["date"] = ["%04d" % dp[0], *dp[1..-1].map {|p| "%02d" % p}].join("-")
+      end
+    end
+  end
+  if !lit.key?("date") && fuzzy && (iss = cite["created"])
+    if dp = iss["date-parts"]
+      if Integer === (dp = dp[0])[0]
+        lit["date"] = ["%04d" % dp[0], *dp[1..-1].map {|p| "%02d" % p}].join("-")
+      end
+    end
+  end
+  if (ct = cite["container-title"]) && ct != []
+    info = []
+    if v = cite["volume"]
+      vi = "vol. #{v}"
+      if (v = cite["journal-issue"]) && (issue = v["issue"])
+        vi << ", no. #{issue}"
+      end
+      info << vi
+    end
+    if p = cite["page"]
+      info << "pp. #{p}"
+    end
+    rhs = info.join(", ")
+    if info != []
+      ser[ct] = rhs
+    else
+      spl = ct.split(" ")
+      ser[spl[0..-2].join(" ")] = spl[-1]
+    end
+  elsif pub = cite["publisher"]
+    info = []
+    if t = cite["type"]
+      info << t
+    end
+    rhs = info.join(", ")
+    if info != []
+      ser[pub] = rhs
+    else
+      spl = pub.split(" ")
+      ser[spl[0..-2].join(" ")] = spl[-1]
+    end
+  end
+  ser["DOI"] = cite["DOI"]
+  lit
+end

data/lib/kramdown-rfc2629.rb

@@ -22,6 +22,8 @@ require 'open3'                 # for math
 require 'json'                  # for math
 require 'rexml/document'        # for SVG and bibxml acrobatics
 
+require 'kramdown-rfc/doi'      # for fetching information for a DOI
+
 class Object
   def deep_clone
     Marshal.load(Marshal.dump(self))
@@ -1002,6 +1004,12 @@ COLORS
         warn "(#{"%.3f" % (t2 - t1)} s)" if KRAMDOWN_PERSISTENT_VERBOSE
       end
 
+      def get_doi(refname)
+        lit = doi_fetch_and_convert(refname, fuzzy: true)
+        anchor = "DOI_#{refname.gsub("/", "_")}"
+        KramdownRFC::ref_to_xml(anchor, lit)
+      end
+
       # this is now slightly dangerous as multiple urls could map to the same cachefile
       def get_and_cache_resource(url, cachefile, tvalid = 7200, tn = Time.now)
         fn = "#{REFCACHEDIR}/#{cachefile}"
@@ -1016,7 +1024,17 @@ COLORS
             fetch_timeout = 60 # seconds; long timeout needed for Travis
           end
           $stderr.puts "#{fn}: #{message} from #{url}"
-          if ENV["HAVE_WGET"]
+          if Array === url
+            begin
+              case url[0]
+              when :DOI
+                ref = get_doi(url[1])
+                File.write(fn, ref)
+              end
+            rescue Exception => e
+              warn "*** Error fetching #{url[0]} #{url[1].inspect}: #{e}"
+            end
+          elsif ENV["HAVE_WGET"]
             `cd #{REFCACHEDIR}; wget -t 3 -T #{fetch_timeout} -Nnv "#{url}"` # ignore errors if offline (hack)
             begin
               File.utime nil, nil, fn
@@ -1089,7 +1107,8 @@ COLORS
         "NIST" => "bibxml2",
         "OASIS" => "bibxml2",
         "PKCS" => "bibxml2",
-        "DOI" => ["bibxml7", 86400, true], # 24 h cache at source anyway
+        "DOI" => ["bibxml7", 86400, true, ->(fn, n){ ["computed-#{fn}", [:DOI, n] ] }, true # always_altproc
+                 ], # emulate old 24 h cache
         "IANA" => ["bibxml8", 86400, true], # ditto
       }
 
@@ -1122,14 +1141,16 @@ COLORS
           anchor.gsub!('/', '_')              # should take out all illegals
           to_insert = ""
           src.scan(/(W3C|3GPP|[A-Z-]+)[.]?([A-Za-z_0-9.\(\)\/\+-]+)/) do |t, n|
+            never_altproc = n.sub!(/^[.]/, "")
             fn = "reference.#{t}.#{n}.xml"
-            sub, ttl, _can_anchor, altproc = XML_RESOURCE_ORG_MAP[t]
+            sub, ttl, _can_anchor, altproc, always_altproc = XML_RESOURCE_ORG_MAP[t]
             ttl ||= KRAMDOWN_REFCACHETTL  # everything but RFCs might change a lot
             puts "*** Huh: #{fn}" unless sub
-            if altproc && !KRAMDOWN_USE_TOOLS_SERVER
+            if altproc && !never_altproc && (!KRAMDOWN_USE_TOOLS_SERVER || always_altproc)
               fn, url = altproc.call(fn, n)
             else
               url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}"
+              fn = "alt-#{fn}" if never_altproc || KRAMDOWN_USE_TOOLS_SERVER
             end
             # if can_anchor # create anchor server-side for stand_alone: false
             #   url << "?anchor=#{anchor}"
@@ -1141,6 +1162,7 @@ COLORS
             begin
               d = REXML::Document.new(to_insert)
               d.xml_decl.nowrite
+              d.delete d.doctype
               d.root.attributes["anchor"] = anchor
               if t == "RFC" or t == "I-D"
                 if KRAMDOWN_NO_TARGETS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.6.13
+  version: 1.6.16
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -100,6 +100,7 @@ files:
 - kramdown-rfc2629.gemspec
 - lib/kramdown-rfc/autolink-iref-cleanup.rb
 - lib/kramdown-rfc/command.rb
+- lib/kramdown-rfc/doi.rb
 - lib/kramdown-rfc/erb.rb
 - lib/kramdown-rfc/gzip-clone.rb
 - lib/kramdown-rfc/kdrfc-processor.rb