kramdown-rfc2629 1.0.41 → 1.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58c77634b1a2903e61a5e2084454f4afe278960c
-  data.tar.gz: cb25b53f42b6f3a659265933e40e465ccdb511ac
+  metadata.gz: 75ac2b119d2630278f0db1cb169ca40a25dc8f55
+  data.tar.gz: 013e491c8bcd6bb1d0b694919dd87813b958df2f
 SHA512:
-  metadata.gz: 5e7bcf654220959f5a5ecf805e6e887d6c97339ef63c07d7c941c58ce07022e7d75e027f755a36a50682cb3fc9509d894bbcf1f089f59fb1c20ab8bb1fd0fc64
-  data.tar.gz: 0ec5125e2e848496d9f836d80ccacae49672989bb94adcd63b54e21e218a9a5f1d09ce34309d19f45c36df14b2653d9bcb1269246fa44476afedff496f26e787
+  metadata.gz: 8f229ee5ceeed8ae1d926ffbe72fefa90a7d37902aad0b78220db53653e5d95ad4721c79a4a7a22edd87608746dbf7a2428175b1ab2d21744081e67dd313fbbd
+  data.tar.gz: b8bfa1df8e6d4679992bae4297940a789bca034553d55e52f2fcec07f6c25f06d6bb117e737ef8b4128064562714c70f4980f67e7f276377809262a28a78e483

data/bin/kramdown-rfc2629

@@ -199,6 +199,10 @@ if input[0] == "\uFEFF"
    warn "*** There is a leading byte order mark. Ignored."
    input[0..0] = ''
 end
+if input[-1] != "\n"
+  # warn "*** added missing newline at end"
+  input << "\n"                 # fix #26
+end
 input.gsub!(/^\{::include\s+(.*?)\}/) {
   File.read($1).chomp
 } unless ENV["KRAMDOWN_SAFE"]

data/kramdown-rfc2629.gemspec

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

@@ -408,11 +408,15 @@ module Kramdown
       end
 
       REFCACHEDIR = ENV["KRAMDOWN_REFCACHEDIR"] || ".refcache"
-      def get_and_cache_resource(url, tn = Time.now, tvalid = 7200)
+
+      KRAMDOWN_OFFLINE = ENV["KRAMDOWN_OFFLINE"]
+      KRAMDOWN_REFCACHE_REFETCH = ENV["KRAMDOWN_REFCACHE_REFETCH"]
+
+      def get_and_cache_resource(url, tvalid = 7200, tn = Time.now)
         Dir.mkdir(REFCACHEDIR) unless Dir.exists?(REFCACHEDIR)
         fn = "#{REFCACHEDIR}/#{File.basename(url)}"
-        f = File.stat(fn) rescue nil
-        if !f || tn - f.ctime >= tvalid
+        f = File.stat(fn) rescue nil unless KRAMDOWN_REFCACHE_REFETCH
+        if !KRAMDOWN_OFFLINE && (!f || tn - f.ctime >= tvalid)
           if f
             message = "renewing (stale by #{"%.1f" % ((tn-f.ctime)/86400)} days)"
             fetch_timeout = 10 # seconds, give up quickly if just renewing
@@ -457,17 +461,22 @@ module Kramdown
       end
 
       XML_RESOURCE_ORG_MAP = {
-        "RFC" => "bibxml", "I-D" => "bibxml3", "W3C" => "bibxml4", "3GPP" => "bibxml5",
+        "RFC" => ["bibxml", 86400*7], # these should change rarely
+        "I-D" => "bibxml3",
+        "W3C" => "bibxml4",
+        "3GPP" => "bibxml5",
         "ANSI" => "bibxml2",
         "CCITT" => "bibxml2",
         "FIPS" => "bibxml2",
-        "IANA" => "bibxml2",
-        "IEEE" => "bibxml2",
+        # "IANA" => "bibxml2",   overtaken by bibxml8
+        "IEEE" => "bibxml2",    # now, how about bibxml6?
         "ISO" => "bibxml2",
         "ITU" => "bibxml2",
         "NIST" => "bibxml2",
         "OASIS" => "bibxml2",
         "PKCS" => "bibxml2",
+        "DOI" => ["bibxml7", 86400], # 24 h cache at source anyway
+        "IANA" => ["bibxml8", 86400], # ditto
       }
 
       # XML_RESOURCE_ORG_HOST = ENV["XML_RESOURCE_ORG_HOST"] || "xml.resource.org"
@@ -475,6 +484,8 @@ module Kramdown
       XML_RESOURCE_ORG_PREFIX = ENV["XML_RESOURCE_ORG_PREFIX"] ||
                                 "https://#{XML_RESOURCE_ORG_HOST}/public/rfc"
 
+      KRAMDOWN_REFCACHETTL = (e = ENV["KRAMDOWN_REFCACHETTL"]) ? e.to_i : 3600
+
       def convert_img(el, indent, opts) # misuse the tag!
         if a = el.attr
           alt = a.delete('alt').strip
@@ -487,10 +498,11 @@ module Kramdown
           to_insert = ""
           anchor.scan(/(W3C|3GPP|[A-Z-]+)[.]?([A-Za-z0-9.-]+)/) do |t, n|
             fn = "reference.#{t}.#{n}.xml"
-            sub = XML_RESOURCE_ORG_MAP[t]
+            sub, ttl = XML_RESOURCE_ORG_MAP[t]
+            ttl ||= KRAMDOWN_REFCACHETTL  # everything but RFCs might change a lot
             puts "Huh: ${fn}" unless sub
             url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}"
-            to_insert = get_and_cache_resource(url)
+            to_insert = get_and_cache_resource(url, ttl)
             to_insert.scrub! rescue nil # only do this for Ruby >= 2.1
           end
           to_insert.gsub(/<\?xml version=["']1.0["'] encoding=["']UTF-8["']\?>/, '').

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.0.41
+  version: 1.0.42
 platform: ruby
 authors:
 - Carsten Bormann