kramdown-rfc2629 1.0.34 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8833ab278c338ba6955a4d6708b046923431e657
-  data.tar.gz: a64817b926813db7906b35867f2726dd14e580a4
+  metadata.gz: 2a1f1ed2a734a6ccf34f300ee6b1a5e46abdc7a5
+  data.tar.gz: 621309318d88a83810dfb337d90d1c5c39011e29
 SHA512:
-  metadata.gz: 8aebe69506ae8d318678a7ac3d40dc54a1699cd2651b0ce42891c376907ca82728b8ed4249d809e30e67cc2a8ba334122e01cbaf7250b993f9c0d420e2aeb58c
-  data.tar.gz: 3dafcdc46dabc1d28822e476fe932f768ba7ea9b9226c7da0898ca4e315a30c33633184c9d812e92962a08826707f91af9c15103b5923281fc2a2f3c2f2f3469
+  metadata.gz: 1b19dd534cb507d9b0dbcfc1d0d1008a9f8be0a962beb067ae68d7f475890e1516ec531b6a6f41f4309da92b7d2f8a81f5bf6d532e84520b6005a3e7d6775ef9
+  data.tar.gz: bb8ae29927a434c69ff02cbc81be85930dde4e9d2c60e46ddaf5e2963ab0abe8ae3cefee0a7a07c83bd38fc635e840cb3c6d3eb30669144be40fccc515f830e0

data/README.md

@@ -231,9 +231,21 @@ Most of the [kramdown syntax][kdsyntax] is supported and does
 something useful; with the exception of the math syntax (math has no
 special support in XML2RFC), and HTML syntax of course.
 
-A number of more esoteric features have recently been added.  
+A number of more esoteric features have recently been added.
 (The minimum required version for each full feature is indicated.)
 
+(1.0.35:)
+An experimental command `doilit` has been added.  It can be used to
+convert DOIs given on the command line into references entries for
+kramdown-rfc YAML, saving a lot of typing.  Note that the DOI database
+is not of very consistent quality, so you likely have to hand-edit the
+result before including it into the document (use `-v` to see raw JSON
+data from the DOI database, made somewhat readable by converting it
+into YAML).  Use `-c` to enable caching (requires `open-uri-cached`
+gem).  Use `-h=handle` in front of a DOI to set a handle different
+from the default `a`, `b`, etc.  Similarly, use `-x=handle` to
+generate XML2RFCv2 XML instead of kramdown-rfc YAML.
+
 (1.0.31:)
 The kramdown `smart_quotes` feature can be controlled better.
 By default, it is on (with default kramdown settings), unless `coding:

data/bin/doilit

@@ -2,15 +2,42 @@
 require 'open-uri'
 require 'yaml'
 require 'json'
+require 'kramdown-rfc2629'
+require 'kramdown-rfc/parameterset'
+require 'kramdown-rfc/refxml'
+
+# 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
+$handle = "a"
+$xml = false
 
+litent = {}
 ARGV.each do |doi|
-  if doi == "-v"
+  case doi
+  when "-c"
+    begin
+      require 'open-uri/cached'
+    rescue LoadError
+      warn '*** please "gem install open-uri-cached" to enable caching'
+    end
+    next
+  when "-v"
     $verbose = true
     next
+  when /\A-h=(.*)/
+    $handle = $1
+    next
+  when /\A-x=(.*)/
+    $handle = $1
+    $xml = true
+    next
+  when /\A-/
+    warn "*** Usage: doilit [-c] [-v] [-h=handle|-x=xmlhandle] doi..."
+    exit 1
   end
   cite = JSON.parse(open("http://dx.doi.org/#{doi}", ACCEPT_CITE_JSON).read)
   puts cite.to_yaml if $verbose
@@ -27,9 +54,9 @@ ARGV.each do |doi|
       lau
     end
   end
-  if i = cite["issued"]
-    if dp = i["date-parts"]
-      if Integer === (dp = dp[0])
+  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
@@ -51,5 +78,15 @@ ARGV.each do |doi|
     ser[pub] = info.join(", ")
   end
   lit["seriesinfo"]["DOI"] = cite["DOI"]
-  puts lit.to_yaml.gsub(/^/, "    ")
+  while litent[$handle]
+    $handle.succ!
+  end
+  litent[$handle] = lit
+end
+if $xml
+  litent.each do |k, v|
+    puts KramdownRFC::ref_to_xml(k, v)
+  end
+else
+  puts litent.to_yaml.gsub(/^/, "  ").lines[1..-1]
 end

data/bin/kramdown-rfc2629

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby2.1
 # -*- coding: utf-8 -*-
 require 'kramdown-rfc2629'
+require 'kramdown-rfc/parameterset'
+require 'kramdown-rfc/refxml'
 require 'yaml'
 require 'erb'
 require 'date'
@@ -21,7 +23,7 @@ def xml_from_sections(input)
   # the first section is a YAML with front matter parameters (don't put a label here)
   # We put back the "---" plus gratuitous blank lines to hack the line number in errors
   yaml_in = input[/---\s*/] << sections.shift[2]
-  ps = ParameterSet.new(YAML.load(yaml_in))
+  ps = KramdownRFC::ParameterSet.new(YAML.load(yaml_in))
   coding_override = ps.has(:coding)
   smart_quotes = ps[:smart_quotes]
 
@@ -131,33 +133,7 @@ def xml_from_sections(input)
             warn "*** don't know how to expand ref #{k}" 
             next
           end
-          vps = ParameterSet.new(v)
-          erb = ERB.new <<-REFERB, nil, '-'
-<reference anchor="<%= k %>" <%= vps.attr("target") %>>
-  <front>
-    <%= vps.ele("title") -%>
-
-<% vps.arr("author", true, true) do |au|
-   aups = authorps_from_hash(au)
- -%>
-    <author <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
-      <%= aups.ele("organization=org", aups.attr("abbrev=orgabbrev"), "") %>
-    </author>
-<%   aups.warn_if_leftovers  -%>
-<% end -%>
-    <date <%= dateattrs(vps[:date]) %>/>
-  </front>
-<% vps.arr("seriesinfo", false) do |k, v| -%>
-  <seriesInfo name="<%=k%>" value="<%=v%>"/>
-<% end -%>
-<% vps.arr("format", false) do |k, v| -%>
-  <format type="<%=k%>" target="<%=v%>"/>
-<% end -%>
-<%= vps.ele("annotation=ann") -%>
-</reference>
-          REFERB
-          sechash[sn.to_s] << erb.result(binding)
-          vps.warn_if_leftovers
+          sechash[sn.to_s] << KramdownRFC::ref_to_xml(k, v)
         end
       end
     end
@@ -177,55 +153,6 @@ def xml_from_sections(input)
   [input, coding_override, link_defs, smart_quotes]
 end
 
-class ParameterSet
-  include Kramdown::Utils::Html
-
-  attr_reader :f
-  def initialize(y)
-    raise "*** invalid parameter set #{y.inspect}" unless Hash === y
-    @f = y
-  end
-  def [](pn)
-    @f.delete(pn.to_s)
-  end
-  def has(pn)
-    @f[pn.to_s]
-  end
-  def van(pn)                   # pn is a parameter name, possibly with an =alias
-    an, pn = pn.to_s.split("=")
-    pn ||= an
-    [self[pn] || self[an], an]
-  end
-  def attr(pn)
-    val, an = van(pn)
-    %{#{an}="#{val}"}    if val
-  end
-  def attrs(*pns)
-    pns.map{ |pn| attr(pn) }.compact.join(" ")
-  end
-  def ele(pn, attr=nil, defcontent=nil)
-    val, an = van(pn)
-    val ||= defcontent
-    Array(val).map do |val1|
-      %{<#{[an, *Array(attr).map(&:to_s)].join(" ").strip}>#{escape_html(val1.to_s.strip)}</#{an}>}
-    end.join(" ")
-  end
-  def arr(an, converthash=true, must_have_one=false, &block)
-    arr = self[an] || []
-    arr = [arr] if Hash === arr && converthash
-    arr << { } if must_have_one && arr.empty?
-    Array(arr).each(&block)
-  end
-  def rest
-    @f
-  end
-  def warn_if_leftovers
-    if !@f.empty?
-      warn "*** attributes left #{@f.inspect}!"
-    end
-  end
-end
-
 XML_RESOURCE_ORG_PREFIX = Kramdown::Converter::Rfc2629::XML_RESOURCE_ORG_PREFIX
 
 def bibtagsys(bib)
@@ -241,43 +168,6 @@ def bibtagsys(bib)
   end
 end
 
-def authorps_from_hash(au)
-  aups = ParameterSet.new(au)
-  if ins = aups[:ins]
-    parts = ins.split('.').map(&:strip)
-    aups.rest["initials"] = parts[0..-2].join('.') << '.'
-    aups.rest["surname"] = parts[-1]
-  end
-  # hack ("heuristic for") initials and surname from name
-  # -- only works for people with exactly one last name and uncomplicated first names
-  if n = aups.rest["name"]
-    n = n.split
-    aups.rest["initials"] ||= n[0..-2].map(&:chr).join('.') << '.'
-    aups.rest["surname"] ||= n[-1]
-  end
-  aups
-end
-
-def dateattrs(date)
-  begin
-    case date
-    when Integer
-      %{year="#{"%04d" % date}"}
-    when String
-      Date.parse("#{date}-01").strftime(%{year="%Y" month="%B"})
-    when Date
-      date.strftime(%{year="%Y" month="%B" day="%d"})
-    when Array                  # this allows to explicitly give a string
-      %{year="#{date.join(" ")}"}
-    when nil
-      %{year="n.d."}
-    end
-
-  rescue ArgumentError
-    warn "*** Invalid date: #{date} -- use 2012, 2012-07, or 2012-07-28"
-  end
-end
-
 def read_encodings
   encfilename = File.expand_path '../../data/encoding-fallbacks.txt', __FILE__
   encfile = File.read(encfilename, coding: "UTF-8")

data/data/kramdown-rfc2629.erb

@@ -24,7 +24,7 @@
     <%= ps.ele("title", ps.attr("abbrev=titleabbrev")) %>
 
 <% ps.arr("author") do |au|
-   aups = authorps_from_hash(au)
+   aups = KramdownRFC::authorps_from_hash(au)
  -%>
     <author <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
       <%= aups.ele("organization=org", aups.attr("abbrev=orgabbrev"), "") %>
@@ -45,7 +45,7 @@
 <%   aups.warn_if_leftovers  -%>
 <% end -%>
 
-    <date <%= dateattrs(ps[:date]||Date.today) %>/>
+    <date <%= KramdownRFC::dateattrs(ps[:date]||Date.today) %>/>
 
     <%= ps.ele("area") %>
     <%= ps.ele("workgroup=wg") %>

data/kramdown-rfc2629.gemspec

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

@@ -0,0 +1,53 @@
+module KramdownRFC
+
+  class ParameterSet
+    include Kramdown::Utils::Html
+
+    attr_reader :f
+    def initialize(y)
+      raise "*** invalid parameter set #{y.inspect}" unless Hash === y
+      @f = y
+    end
+    def [](pn)
+      @f.delete(pn.to_s)
+    end
+    def has(pn)
+      @f[pn.to_s]
+    end
+    def van(pn)                   # pn is a parameter name, possibly with an =alias
+      an, pn = pn.to_s.split("=")
+      pn ||= an
+      [self[pn] || self[an], an]
+    end
+    def attr(pn)
+      val, an = van(pn)
+      %{#{an}="#{val}"}    if val
+    end
+    def attrs(*pns)
+      pns.map{ |pn| attr(pn) }.compact.join(" ")
+    end
+    def ele(pn, attr=nil, defcontent=nil)
+      val, an = van(pn)
+      val ||= defcontent
+      Array(val).map do |val1|
+        %{<#{[an, *Array(attr).map(&:to_s)].join(" ").strip}>#{escape_html(val1.to_s.strip)}</#{an}>}
+      end.join(" ")
+    end
+    def arr(an, converthash=true, must_have_one=false, &block)
+      arr = self[an] || []
+      arr = [arr] if Hash === arr && converthash
+      arr << { } if must_have_one && arr.empty?
+      Array(arr).each(&block)
+    end
+    def rest
+      @f
+    end
+    def warn_if_leftovers
+      if !@f.empty?
+        warn "*** attributes left #{@f.inspect}!"
+      end
+    end
+  end
+
+  
+end

data/lib/kramdown-rfc/refxml.rb

@@ -0,0 +1,72 @@
+module KramdownRFC
+
+  def self.ref_to_xml(k, v)
+    vps = KramdownRFC::ParameterSet.new(v)
+    erb = ERB.new <<-REFERB, nil, '-'
+<reference anchor="<%= k %>" <%= vps.attr("target") %>>
+  <front>
+    <%= vps.ele("title") -%>
+
+<% vps.arr("author", true, true) do |au|
+   aups = authorps_from_hash(au)
+ -%>
+    <author <%=aups.attrs("initials", "surname", "fullname=name", "role")%>>
+      <%= aups.ele("organization=org", aups.attr("abbrev=orgabbrev"), "") %>
+    </author>
+<%   aups.warn_if_leftovers  -%>
+<% end -%>
+    <date <%= dateattrs(vps[:date]) %>/>
+  </front>
+<% vps.arr("seriesinfo", false) do |k, v| -%>
+  <seriesInfo name="<%=k%>" value="<%=v%>"/>
+<% end -%>
+<% vps.arr("format", false) do |k, v| -%>
+  <format type="<%=k%>" target="<%=v%>"/>
+<% end -%>
+<%= vps.ele("annotation=ann") -%>
+</reference>
+    REFERB
+    ret = erb.result(binding)
+    vps.warn_if_leftovers
+    ret
+  end
+
+  def self.authorps_from_hash(au)
+    aups = KramdownRFC::ParameterSet.new(au)
+    if ins = aups[:ins]
+      parts = ins.split('.').map(&:strip)
+      aups.rest["initials"] = parts[0..-2].join('.') << '.'
+      aups.rest["surname"] = parts[-1]
+    end
+    # hack ("heuristic for") initials and surname from name
+    # -- only works for people with exactly one last name and uncomplicated first names
+    if n = aups.rest["name"]
+      n = n.split
+      aups.rest["initials"] ||= n[0..-2].map(&:chr).join('.') << '.'
+      aups.rest["surname"] ||= n[-1]
+    end
+    aups
+  end
+
+  def self.dateattrs(date)
+    begin
+      case date
+      when /\A\d\d\d\d\z/
+        %{year="#{date}"}
+      when Integer
+        %{year="#{"%04d" % date}"}
+      when String
+        Date.parse("#{date}-01").strftime(%{year="%Y" month="%B"})
+      when Date
+        date.strftime(%{year="%Y" month="%B" day="%d"})
+      when Array                  # this allows to explicitly give a string
+        %{year="#{date.join(" ")}"}
+      when nil
+        %{year="n.d."}
+      end
+
+    rescue ArgumentError
+      warn "*** Invalid date: #{date} -- use 2012, 2012-07, or 2012-07-28"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-rfc2629
 version: !ruby/object:Gem::Version
-  version: 1.0.34
+  version: 1.0.35
 platform: ruby
 authors:
 - Carsten Bormann
@@ -41,6 +41,8 @@ files:
 - data/encoding-fallbacks.txt
 - data/kramdown-rfc2629.erb
 - kramdown-rfc2629.gemspec
+- lib/kramdown-rfc/parameterset.rb
+- lib/kramdown-rfc/refxml.rb
 - lib/kramdown-rfc2629.rb
 homepage: http://github.com/cabo/kramdown-rfc2629
 licenses: