metanorma-ietf 2.2.10 → 2.3.4

data/lib/isodoc/ietf/references.rb

@@ -3,6 +3,9 @@ module IsoDoc::Ietf
     # TODO displayreference will be implemented as combination of autofetch and user-provided citations
 
     def bibliography(isoxml, out)
+      isoxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
+        i.children = docid_prefix(i["type"], i.text)
+      end
       isoxml.xpath(ns("//bibliography/references | "\
                       "//bibliography/clause[.//references] | "\
                       "//annex/clause[.//references] | "\
@@ -31,22 +34,21 @@ module IsoDoc::Ietf
       i = 0
       f.xpath(ns("./bibitem | ./note")).each do |b|
         next if implicit_reference(b)
+
         i += 1 if b.name == "bibitem"
         if b.name == "note" then note_parse(b, div)
-        elsif(is_ietf(b)) then ietf_bibitem_entry(div, b, i)
+        elsif is_ietf(b) then ietf_bibitem_entry(div, b, i)
         else
           nonstd_bibitem(div, b, i, biblio)
         end
       end
     end
 
-    def nonstd_bibitem(list, b, ordinal, bibliography)
+    def nonstd_bibitem(list, b, _ordinal, _bibliography)
       uris = b.xpath(ns("./uri"))
       target = nil
       uris&.each do |u|
-        if u["type"] == "src" then
-          target = u.text
-        end
+        target = u.text if u["type"] == "src"
       end
       list.reference **attr_code(target: target,
                                  anchor: b["id"]) do |r|
@@ -66,7 +68,8 @@ module IsoDoc::Ietf
           r.refcontent id[1]
         docidentifiers&.each do |u|
           if %w(DOI IETF).include? u["type"]
-            r.seriesInfo nil, **attr_code(value: u.text, name: u["type"])
+            r.seriesInfo nil, **attr_code(value: u.text.sub(/^DOI /, ""),
+                                          name: u["type"])
           end
         end
       end
@@ -86,7 +89,7 @@ module IsoDoc::Ietf
                                           "'publisher']"))
       auths.each do |a|
         role = a.at(ns("./role[@type = 'editor']")) ? "editor" : nil
-        p = a&.at(ns("./person/name")) and 
+        p = a&.at(ns("./person/name")) and
           relaton_person_to_author(p, role, f) or
           relaton_org_to_author(a&.at(ns("./organization")), role, f)
       end
@@ -99,17 +102,17 @@ module IsoDoc::Ietf
         p&.xpath(ns("./forename"))&.map { |i| i.text[0] }&.join(" ")
       initials = nil if initials.empty?
       f.author nil,
-        **attr_code(fullname: fullname, asciiFullname: fullname&.transliterate,
-                    role: role, surname: surname, initials: initials,
-                    asciiSurname: fullname ? surname&.transliterate : nil,
-                    asciiInitials: fullname ? initials&.transliterate : nil)
+               **attr_code(fullname: fullname, asciiFullname: fullname&.transliterate,
+                           role: role, surname: surname, initials: initials,
+                           asciiSurname: fullname ? surname&.transliterate : nil,
+                           asciiInitials: fullname ? initials&.transliterate : nil)
     end
 
-    def relaton_org_to_author(o, role, f)
+    def relaton_org_to_author(o, _role, f)
       name = o&.at(ns("./name"))&.text
       abbrev = o&.at(ns("./abbreviation"))&.text
-      f.author do |a|
-        f.organization name, **attr_code(ascii: name&.transliterate, 
+      f.author do |_a|
+        f.organization name, **attr_code(ascii: name&.transliterate,
                                          abbrev: abbrev)
       end
     end
@@ -119,6 +122,7 @@ module IsoDoc::Ietf
         b.at(ns("./date[@type = 'issued']")) ||
         b.at(ns("./date[@type = 'circulated']"))
       return unless date
+
       attr = date_attr(date&.at(ns("./on | ./from"))&.text) || return
       f.date **attr_code(attr)
     end
@@ -145,13 +149,14 @@ module IsoDoc::Ietf
       end
     end
 
-    def ietf_bibitem_entry(div, b, i)
+    def ietf_bibitem_entry(div, b, _i)
       url = b&.at(ns("./uri[@type = 'xml']"))&.text
       div << "<xi:include href='#{url}'/>"
     end
 
     def is_ietf(b)
       return false if !@xinclude
+
       url = b.at(ns("./uri[@type = 'xml']")) or return false
       /xml2rfc\.tools\.ietf\.org/.match(url)
     end

data/lib/isodoc/ietf/section.rb

@@ -2,7 +2,7 @@ module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
     def common_rfc_pis(node)
       rfc_pis = {
-         artworkdelimiter: node&.at(ns("//pi/artworkdelimiter"))&.text,
+        artworkdelimiter: node&.at(ns("//pi/artworkdelimiter"))&.text,
         artworklines: node&.at(ns("//pi/artworklines"))&.text,
         authorship: node&.at(ns("//pi/authorship"))&.text,
         autobreaks: node&.at(ns("//pi/autobreaks"))&.text,
@@ -53,30 +53,32 @@ module IsoDoc::Ietf
 
     def rfc_attributes(docxml)
       t = Time.now.getutc
-      obs = xpath_comma(docxml.xpath(ns(
-        "//bibdata/relation[@type = 'obsoletes']/bibitem/docidentifier")))
-      upd = xpath_comma(docxml.xpath(ns(
-        "//bibdata/relation[@type = 'updates']/bibitem/docidentifier")))
+      obs = xpath_comma(docxml
+        .xpath(ns("//bibdata/relation[@type = 'obsoletes']/bibitem/docidentifier")))
+      upd = xpath_comma(docxml
+        .xpath(ns("//bibdata/relation[@type = 'updates']/bibitem/docidentifier")))
       {
-        docName:        @meta.get[:doctype] == "Internet Draft" ? @meta.get[:docnumber] : nil,
-        number:         @meta.get[:doctype].casecmp?("rfc") ? @meta.get[:docnumber] : nil,
-        category:       series2category(
-          docxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text),
-        ipr:            docxml&.at(ns("//bibdata/ext/ipr"))&.text,
-        consensus:      docxml&.at(ns("//bibdata/ext/consensus"))&.text,
-        obsoletes:      obs,
-        updates:        upd,
-        indexInclude:   docxml&.at(ns("//bibdata/ext/indexInclude"))&.text,
-        iprExtract:     docxml&.at(ns("//bibdata/ext/iprExtract"))&.text,
-        sortRefs:       docxml&.at(ns("//bibdata/ext/sortRefs"))&.text,
-        symRefs:        docxml&.at(ns("//bibdata/ext/symRefs"))&.text,
-        tocInclude:     docxml&.at(ns("//bibdata/ext/tocInclude"))&.text,
-        tocDepth:       docxml&.at(ns("//bibdata/ext/tocDepth"))&.text,
+        docName: @meta.get[:doctype] == "Internet Draft" ? @meta.get[:docnumber] : nil,
+        number: @meta.get[:doctype].casecmp?("rfc") ? @meta.get[:docnumber] : nil,
+        category: series2category(
+          docxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text,
+        ),
+        ipr: docxml&.at(ns("//bibdata/ext/ipr"))&.text,
+        consensus: docxml&.at(ns("//bibdata/ext/consensus"))&.text,
+        obsoletes: obs,
+        updates: upd,
+        indexInclude: docxml&.at(ns("//bibdata/ext/indexInclude"))&.text,
+        iprExtract: docxml&.at(ns("//bibdata/ext/iprExtract"))&.text,
+        sortRefs: docxml&.at(ns("//bibdata/ext/sortRefs"))&.text,
+        symRefs: docxml&.at(ns("//bibdata/ext/symRefs"))&.text,
+        tocInclude: docxml&.at(ns("//bibdata/ext/tocInclude"))&.text,
+        tocDepth: docxml&.at(ns("//bibdata/ext/tocDepth"))&.text,
         submissionType: docxml&.at(ns(
-          "//bibdata/series[@type = 'stream']/title"))&.text || "IETF",
-        'xml:lang':     docxml&.at(ns("//bibdata/language"))&.text,
-        version:        "3",
-        'xmlns:xi':        "http://www.w3.org/2001/XInclude",
+          "//bibdata/series[@type = 'stream']/title",
+        ))&.text || "IETF",
+        'xml:lang': docxml&.at(ns("//bibdata/language"))&.text,
+        version: "3",
+        'xmlns:xi': "http://www.w3.org/2001/XInclude",
       }
     end
 
@@ -86,7 +88,7 @@ module IsoDoc::Ietf
       when "informational", "info" then "info"
       when "experimental", "exp" then "exp"
       when "bcp" then "bcp"
-      when "fyi", "info" then "info"
+      when "fyi" then "info"
       when "full-standard" then "std"
       when "historic" then "historic"
       else
@@ -96,17 +98,19 @@ module IsoDoc::Ietf
 
     def xpath_comma(xpath)
       return nil if xpath.empty?
-      xpath.map { |x| x.text }.join(", ")
+
+      xpath.map(&:text).join(", ")
     end
 
     def make_link(out, isoxml)
-      links = isoxml.xpath(ns(
-        "//bibdata/relation[@type = 'includedIn' or @type = 'describedBy' or "\
-        "@type = 'derivedFrom' or @type = 'instance']")) || return
-        links.each do |l|
-          out.link **{ href: l&.at(ns("./bibitem/docidentifier"))&.text,
-                       rel: rel2iana(l["type"]) }
-        end
+      links = isoxml
+        .xpath(ns("//bibdata/relation[@type = 'includedIn' or "\
+      "@type = 'describedBy' or @type = 'derivedFrom' or "\
+      "@type = 'instance']")) || return
+      links.each do |l|
+        out.link **{ href: l&.at(ns("./bibitem/docidentifier"))&.text,
+                     rel: rel2iana(l["type"]) }
+      end
     end
 
     def rel2iana(type)
@@ -115,7 +119,7 @@ module IsoDoc::Ietf
       when "describedBy" then "describedby"
       when "derivedFrom" then "convertedfrom"
       when "instance" then "alternate"
-      else 
+      else
         "alternate"
       end
     end
@@ -133,17 +137,21 @@ module IsoDoc::Ietf
       end
     end
 
-    def clause_parse_title(node, div, c1, out, _heading_attrs = {})
-      return unless c1
+    def clause_parse_title(_node, div, clause, _out, _heading_attrs = {})
+      return unless clause
+
       div.name do |n|
-        c1&.children&.each { |c2| parse(c2, n) }
+        clause&.children&.each { |c2| parse(c2, n) }
       end
     end
 
     def clause_parse(node, out)
       return if node.at(ns(".//references"))
-      out.section **attr_code( anchor: node["id"], numbered: node["numbered"],
-                              removeInRFC: node["removeInRFC"], toc: node["toc"]) do |div|
+
+      out.section **attr_code(
+        anchor: node["id"], numbered: node["numbered"],
+        removeInRFC: node["removeInRFC"], toc: node["toc"]
+      ) do |div|
         clause_parse_title(node, div, node.at(ns("./title")), out)
         node.children.reject { |c1| c1.name == "title" }.each do |c1|
           parse(c1, div)
@@ -152,11 +160,12 @@ module IsoDoc::Ietf
     end
 
     def clause(isoxml, out)
-      isoxml.xpath("//xmlns:preface/child::*[not(name() = 'abstract' or name() = 'foreword')] "\
+      isoxml.xpath("//xmlns:preface/child::*"\
+                   "[not(name() = 'abstract' or name() = 'foreword')] "\
                    "| //xmlns:sections/child::*").each do |c|
-        #cdup = c.dup
-        #cdup.xpath(ns(".//references")).each { |r| r.remove }
-        #cdup.at("./*[local-name() != 'title'][normalize-space(text()) != '']") or next
+        # cdup = c.dup
+        # cdup.xpath(ns(".//references")).each { |r| r.remove }
+        # cdup.at("./*[local-name() != 'title'][normalize-space(text()) != '']") or next
         clause_parse(c, out)
       end
     end

data/lib/metanorma/ietf/processor.rb

@@ -1,11 +1,14 @@
 require "metanorma/processor"
 require "tempfile"
 
+require "isodoc/ietf/rfc_convert"
+
 module Metanorma
   module Ietf
-    class Processor < Metanorma::Processor
+    RfcConvert = ::IsoDoc::Ietf::RfcConvert
 
-      def initialize
+    class Processor < Metanorma::Processor
+      def initialize # rubocop:disable Lint/MissingSuper
         @short = :ietf
         @input_format = :asciidoc
         @asciidoctor_backend = :ietf
@@ -18,7 +21,7 @@ module Metanorma
           rfc: "rfc.xml",
           html: "html",
           txt: "txt",
-          pdf: "pdf"
+          pdf: "pdf",
         }
       end
 
@@ -26,15 +29,15 @@ module Metanorma
         "Metanorma::Ietf #{::Metanorma::Ietf::VERSION}"
       end
 
-      def extract_options(isodocxml)
+      def extract_options(_isodocxml)
         {}
       end
 
       # From mislav: https://stackoverflow.com/questions/2108727
       #        /which-in-ruby-checking-if-program-exists-in-path-from-ruby
       def which(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
           exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
@@ -43,49 +46,43 @@ module Metanorma
         nil
       end
 
-      def use_presentation_xml(ext)
+      def use_presentation_xml(_ext)
         false
       end
 
-      def xml2rfc_present?
-        !which("xml2rfc").nil?
+      def check_xml2rfc_present?(format)
+        if which("xml2rfc").nil?
+          raise "[metanorma-ietf] Fatal: unable to generate #{format}," \
+                " the command `xml2rfc` is not found in path."
+        end
       end
 
-      def output(isodoc_node, inname, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options = {})
         case format
         when :rfc
           outname ||= inname.sub(/\.xml$/, ".rfc.xml")
-          IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
+          RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
-
         when :txt, :pdf, :html
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
-          end
+          xml2rfc(isodoc_node, inname, outname, format, options)
+        else
+          super
+        end
+      end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          unless @done_rfc && File.exist?(rfcname)
-            output(isodoc_node, inname, rfcname, :rfc, options)
-          end
+      def xml2rfc(isodoc_node, inname, outname, format, options)
+        check_xml2rfc_present?(format)
 
-          outext = case format
-            when :txt then ".txt"
-            when :pdf then ".pdf"
-            when :html then ".html"
-          end
+        rfcname = inname.sub(/\.xml$/, ".rfc.xml")
+        unless @done_rfc && File.exist?(rfcname)
+          output(isodoc_node, inname, rfcname, :rfc, options)
+        end
 
-          outflag = case format
-            when :txt then "--text"
-            when :pdf then "--pdf"
-            when :html then "--html"
-          end
+        outext = { txt: ".txt", pdf: ".pdf", html: ".html" }[format]
+        outflag = { txt: "--text", pdf: "--pdf", html: "--html" }[format]
 
-          outname ||= inname.sub(/\.xml$/, outext)
-          system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
-        else
-          super
-        end
+        outname ||= inname.sub(/\.xml$/, outext)
+        system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
       end
     end
   end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.10".freeze
+    VERSION = "2.3.4".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "metanorma/ietf/version"
 
@@ -33,12 +33,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 1.8.0"
-  spec.add_dependency "isodoc", "~> 1.5.0"
+  spec.add_dependency "isodoc", "~> 1.6.0"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "nokogiri", "~> 1.10.4"
+  spec.add_dependency "metanorma-standoc", "~> 1.9.0"
+  spec.add_dependency "nokogiri", "~> 1.11.6"
+  spec.add_dependency "open-uri"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.2.10
+  version: 2.3.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: metanorma-standoc
+  name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: isodoc
+  name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mathml2asciimath
+  name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.11.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.11.6
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -306,7 +320,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="