metanorma-ietf 2.2.9 → 2.3.3

data/lib/asciidoctor/ietf/validate.rb

@@ -1,3 +1,5 @@
+require "open-uri"
+
 module Asciidoctor
   module Ietf
     class Converter < ::Asciidoctor::Standoc::Converter
@@ -10,15 +12,18 @@ module Asciidoctor
       def image_validate(doc)
         doc.xpath("//image").each do |i|
           next if i["mimetype"] == "image/svg+xml"
+
           @log.add("MIME", i, "image #{i['src'][0, 40]} is not SVG!")
         end
       end
 
       def workgroup_validate(doc)
         return if @workgroups.empty?
+
         doc.xpath("//bibdata/ext/editorialgroup/workgroup").each do |wg|
           wg_norm = wg.text.sub(/ (Working|Research) Group$/, "")
           next if @workgroups.include?(wg_norm)
+
           @log.add("Document Attributes", nil, "IETF: unrecognised working group #{wg.text}")
         end
       end
@@ -29,25 +34,29 @@ module Asciidoctor
                         File.join(File.dirname(__FILE__), "ietf.rng"))
       end
 
+      def wgcache_name
+        "#{Dir.home}/.metanorma-ietf-workgroup-cache.json"
+      end
+
       def open_wg_cache(node)
-        wgcache_name = "#{Dir.home}/.metanorma-ietf-workgroup-cache.json"
-        node.attr("flush-caches") == "true" and FileUtils.rm wgcache_name, :force => true
+        node.attr("flush-caches") == "true" and
+          FileUtils.rm wgcache_name, force: true
         wg = []
         if Pathname.new(wgcache_name).file?
           begin
             File.open(wgcache_name, "r") { |f| wg = JSON.parse(f.read) }
           rescue Exception => e
-            STDERR.puts "Cache #{wgcache_name} is invalid, drop it"
+            warn "Cache #{wgcache_name} is invalid, drop it"
           end
         end
         [wg, wgcache_name]
       end
 
-      def cache_workgroup_ietf(wg, b)
-        STDERR.puts "Reading workgroups from https://tools.ietf.org/wg/..."
-        Kernel.open("https://tools.ietf.org/wg/") do |f|
-          f.each_line do |line|
-            line.scan(%r{<td width="50%" style='padding: 0 1ex'>([^<]+)</td>}) do |w|
+      def cache_workgroup_ietf(wg, _b)
+        warn "Reading workgroups from https://tools.ietf.org/wg/..."
+        URI.open("https://tools.ietf.org/wg/") do |f|
+          f.each_line do |l|
+            l.scan(%r{<td width="50%" style='padding: 0 1ex'>([^<]+)</td>}) do |w|
               wg << w[0].gsub(/\s+$/, "").gsub(/ Working Group$/, "")
             end
           end
@@ -55,11 +64,11 @@ module Asciidoctor
         wg
       end
 
-      def cache_workgroup_irtf(wg, b)
-        STDERR.puts "Reading workgroups from https://irtf.org/groups..."
-        Kernel.open("https://irtf.org/groups", ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |f|
-          f.each_line do |line|
-            line.scan(%r{<a title="([^"]+) Research Group"[^>]+>([^<]+)<}) do |w|
+      def cache_workgroup_irtf(wg, _b)
+        warn "Reading workgroups from https://irtf.org/groups..."
+        URI.open("https://irtf.org/groups", ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |f|
+          f.each_line do |l|
+            l.scan(%r{<a title="([^"]+) Research Group"[^>]+>([^<]+)<}) do |w|
               wg << w[0].gsub(/\s+$/, "")
               wg << w[1].gsub(/\s+$/, "") # abbrev
             end

data/lib/isodoc/ietf/blocks.rb

@@ -43,7 +43,7 @@ module IsoDoc::Ietf
     end
 
     def ol_attrs(node)
-      { anchor: node["id"], 
+      { anchor: node["id"],
         spacing: node["spacing"],
         type: ol_style(node["type"]),
         group: node["group"],
@@ -73,7 +73,9 @@ module IsoDoc::Ietf
 
     def note_label(node)
       n = @xrefs.get[node["id"]]
-      return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? || n[:label].empty?
+      return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? ||
+        n[:label].empty?
+
       l10n("#{@i18n.note} #{n[:label]}: ")
     end
 
@@ -98,7 +100,7 @@ module IsoDoc::Ietf
     def example_label(node, div, name)
       n = @xrefs.get[node["id"]]
       div.t **attr_code(anchor: node["id"], keepWithNext: "true") do |p|
-        lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example :
+        lbl = n.nil? || n[:label].nil? || n[:label].empty? ? @i18n.example :
           l10n("#{@i18n.example} #{n[:label]}")
         p << lbl
         name and !lbl.nil? and p << ": "
@@ -107,15 +109,11 @@ module IsoDoc::Ietf
     end
 
     def sourcecode_parse(node, out)
-      out.figure **attr_code(anchor: node["id"]) do |div|
-        name = node&.at(ns("./name"))&.remove and div.name do |n|
-          name.children.each { |nn| parse(nn, n) }
-        end
-        div.sourcecode **attr_code(type: node["lang"], name: node["filename"],
-                                   markers: node["markers"],
-                                   src: node["src"]) do |s|
-                                     node.children.each { |x| parse(x, s) unless x.name == "name" }
-                                   end
+      out.sourcecode **attr_code(
+        anchor: node["id"], type: node["lang"], name: node["filename"],
+        markers: node["markers"], src: node["src"]
+      ) do |s|
+        node.children.each { |x| parse(x, s) unless x.name == "name" }
       end
     end
 
@@ -139,6 +137,7 @@ module IsoDoc::Ietf
 
     def formula_where(dl, out)
       return unless dl
+
       out.t { |p| p << @i18n.where }
       parse(dl, out)
     end
@@ -146,7 +145,7 @@ module IsoDoc::Ietf
     def formula_parse1(node, out)
       out.t **attr_code(anchor: node["id"]) do |p|
         parse(node.at(ns("./stem")), p)
-        lbl = @xrefs.anchor(node['id'], :label, false)
+        lbl = @xrefs.anchor(node["id"], :label, false)
         lbl.nil? or
           p << "    (#{lbl})"
       end
@@ -157,6 +156,7 @@ module IsoDoc::Ietf
       formula_where(node.at(ns("./dl")), out)
       node.children.each do |n|
         next if %w(stem dl).include? n.name
+
         parse(n, out)
       end
     end
@@ -176,7 +176,7 @@ module IsoDoc::Ietf
     end
 
     def admonition_name_parse(_node, div, name)
-      div.t **{keepWithNext: "true" } do |p|
+      div.t **{ keepWithNext: "true" } do |p|
         name.children.each { |n| parse(n, p) }
       end
     end
@@ -200,8 +200,9 @@ module IsoDoc::Ietf
       end
     end
 
-    def figure_name_parse(node, div, name)
+    def figure_name_parse(_node, div, name)
       return if name.nil?
+
       div.name do |n|
         name.children.each { |n| parse(n, div) }
       end
@@ -214,6 +215,7 @@ module IsoDoc::Ietf
     def figure_parse(node, out)
       return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
         node["type"] == "pseudocode"
+
       @in_figure = true
       out.figure **attr_code(anchor: node["id"]) do |div|
         figure_name_parse(node, div, node.at(ns("./name")))

data/lib/isodoc/ietf/cleanup.rb

@@ -15,14 +15,14 @@ module IsoDoc::Ietf
     end
 
     # TODO: insert <u>
-    
+
     def front_cleanup(xmldoc)
-        xmldoc.xpath("//title").each { |s| s.children = s.text }
-        xmldoc.xpath("//reference/front[not(author)]").each do |f|
-          insert = f.at("./seriesInfo[last()]") || f.at("./title")
-          insert.next = "<author surname='Unknown'/>"
-        end
+      xmldoc.xpath("//title").each { |s| s.children = s.text }
+      xmldoc.xpath("//reference/front[not(author)]").each do |f|
+        insert = f.at("./seriesInfo[last()]") || f.at("./title")
+        insert.next = "<author surname='Unknown'/>"
       end
+    end
 
     def table_footnote_cleanup(docxml)
       docxml.xpath("//table[descendant::fn]").each do |t|
@@ -46,25 +46,19 @@ module IsoDoc::Ietf
 
     def figure_cleanup(docxml)
       figure_postamble(docxml)
-      figure_wrap_artwork(docxml)
       figure_unnest(docxml)
       figure_footnote_cleanup(docxml)
     end
 
-    def figure_wrap_artwork(docxml)
-      docxml.xpath("//artwork[not(parent::figure)] | "\
-                   "//sourcecode[not(parent::figure)]").each do |a|
-        a.wrap("<figure></figure>")
-      end
-    end
-
     def figure_unnest(docxml)
       docxml.xpath("//figure[descendant::figure]").each do |f|
         insert = f
         f.xpath(".//figure").each do |a|
+          title = f.at("./name") and a.children.first.previous = title.remove
           insert.next = a.remove
           insert = insert.next_element
         end
+        f.remove
       end
     end
 
@@ -134,8 +128,10 @@ module IsoDoc::Ietf
 
     def make_endnotes(docxml)
       return unless docxml.at("//fn")
-      endnotes = docxml.at("//back") or
-      docxml << "<back/>" and endnotes = docxml.at("//back")
+
+      unless endnotes = docxml.at("//back")
+        docxml << "<back/>" and endnotes = docxml.at("//back")
+      end
       endnotes << "<section><name>Endnotes</name></section>"
       endnotes = docxml.at("//back/section[last()]")
     end
@@ -146,7 +142,7 @@ module IsoDoc::Ietf
         t.xpath(".//artwork").each_with_index do |a, i|
           insert.next = a.dup
           insert = insert.next
-          a.replace("[IMAGE #{i+1}]")
+          a.replace("[IMAGE #{i + 1}]")
         end
       end
     end
@@ -154,8 +150,8 @@ module IsoDoc::Ietf
     # for markup in pseudocode
     def sourcecode_cleanup(docxml)
       docxml.xpath("//sourcecode").each do |s|
-        s.children = s.children.to_xml.gsub(%r{<br/>\n}, "\n").
-          gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
+        s.children = s.children.to_xml.gsub(%r{<br/>\n}, "\n")
+          .gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
         sourcecode_remove_markup(s)
         text = HTMLEntities.new.decode(s.children.to_xml.sub(/\A\n+/, ""))
         s.children = "<![CDATA[#{text}]]>"
@@ -166,8 +162,10 @@ module IsoDoc::Ietf
       s.traverse do |n|
         next if n.text?
         next if %w(name callout annotation note sourcecode).include? n.name
-        if n.name == "br" then n.replace("\n")
-        elsif n.name == "t" then n.replace("\n\n#{n.children}")
+
+        case n.name
+        when "br" then n.replace("\n")
+        when "t" then n.replace("\n\n#{n.children}")
         else
           n.replace(n.children)
         end
@@ -177,6 +175,7 @@ module IsoDoc::Ietf
     def annotation_cleanup(docxml)
       docxml.xpath("//reference").each do |r|
         next unless r&.next_element&.name == "aside"
+
         aside = r.next_element
         aside.name = "annotation"
         aside.traverse do |n|
@@ -184,7 +183,7 @@ module IsoDoc::Ietf
         end
         r << aside
       end
-      docxml.xpath("//references/aside").each { |r| r.remove }
+      docxml.xpath("//references/aside").each(&:remove)
     end
 
     def deflist_cleanup(docxml)
@@ -211,9 +210,7 @@ module IsoDoc::Ietf
     end
 
     def bookmark_cleanup(docxml)
-      docxml.xpath("//bookmark").each do |b|
-        b.remove
-      end
+      docxml.xpath("//bookmark").each(&:remove)
     end
 
     def aside_cleanup(docxml)

data/lib/isodoc/ietf/front.rb

@@ -25,10 +25,11 @@ module IsoDoc::Ietf
 
     def output_if_translit(text)
       return nil if text.nil?
+
       text.transliterate != text ? text.transliterate : nil
     end
 
-    def title(isoxml, front)
+    def title(_isoxml, front)
       title = @meta.get[:doctitle] or return
       front.title title, **attr_code(abbrev: @meta.get[:docabbrev],
                                      ascii: (@meta.get[:docascii] ||
@@ -49,18 +50,20 @@ module IsoDoc::Ietf
     end
 
     def rfc_seriesinfo(isoxml, front)
-      front.seriesInfo **seriesinfo_attr(isoxml).merge({name: "RFC",
-                                                        asciiName: "RFC"})
+      front.seriesInfo **seriesinfo_attr(isoxml).merge({ name: "RFC",
+                                                         asciiName: "RFC" })
       i = isoxml&.at(ns("//bibdata/series[@type = 'intended']")) and
         front.seriesInfo nil,
-        **attr_code(name: "", status: i&.at(ns("./title"))&.text,
-                    value: i&.at(ns("./number"))&.text || "")
+                         **attr_code(name: "",
+                                     status: i&.at(ns("./title"))&.text,
+                                     value: i&.at(ns("./number"))&.text || "")
     end
 
     def id_seriesinfo(isoxml, front)
       front.seriesInfo nil,
-        **seriesinfo_attr(isoxml).merge({name: "Internet-Draft",
-                                         asciiName: "Internet-Draft"})
+                       **seriesinfo_attr(isoxml)
+                         .merge({ name: "Internet-Draft",
+                                  asciiName: "Internet-Draft" })
       i = isoxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text and
         front.seriesInfo **attr_code(name: "", value: "", status: i)
     end
@@ -74,44 +77,49 @@ module IsoDoc::Ietf
       end
     end
 
-    def person_author_attrs(c, role)
-      return {} if c.nil?
-      full = c&.at(ns("./completename"))&.text
-      init = c&.at(ns("./initial"))&.text ||
-        c&.xpath(ns("./forename")).map { |n| n.text[0] }.join(".")
+    def person_author_attrs(contrib, role)
+      return {} if contrib.nil?
+
+      full = contrib&.at(ns("./completename"))&.text
+      init = contrib&.at(ns("./initial"))&.text ||
+        contrib&.xpath(ns("./forename"))&.map { |n| n.text[0] }&.join(".")
       init = nil if init.empty?
       ret = attr_code(role: role, fullname: full, initials: init,
-                      surname: c&.at(ns("./surname"))&.text)
-      pers_author_attrs1(ret, full, init, c)
-    end
-
-    def pers_author_attrs1(ret, full, init, c)
-      full and ret.merge!(attr_code(
-        asciiFullname: output_if_translit(full),
-        asciiInitials: output_if_translit(init),
-        asciiSurname: output_if_translit(c&.at(ns("./surname")))))
+                      surname: contrib&.at(ns("./surname"))&.text)
+      pers_author_attrs1(ret, full, init, contrib)
+    end
+
+    def pers_author_attrs1(ret, full, init, contrib)
+      full and ret.merge!(
+        attr_code(
+          asciiFullname: output_if_translit(full),
+          asciiInitials: output_if_translit(init),
+          asciiSurname: output_if_translit(contrib&.at(ns("./surname"))),
+        ),
+      )
       ret
     end
 
-    def person_author(c, role, front)
-      front.author **person_author_attrs(c.at(ns("./person/name")), role) do |a|
-        org = c.at(ns("./person/affiliation/organization")) and
-          organization(org, a, c.document.at(ns("//showOnFrontPage")))
-        address(c.xpath(ns(".//address")),
-                c.at(ns(".//phone[not(@type = 'fax')]")),
-                c.at(ns(".//phone[@type = 'fax']")),
-                c.xpath(ns(".//email")), c.xpath(ns(".//uri")), a)
+    def person_author(contrib, role, front)
+      attrs = person_author_attrs(contrib.at(ns("./person/name")), role)
+      front.author **attrs do |a|
+        org = contrib.at(ns("./person/affiliation/organization")) and
+          organization(org, a, contrib.document.at(ns("//showOnFrontPage")))
+        address(contrib.xpath(ns(".//address")),
+                contrib.at(ns(".//phone[not(@type = 'fax')]")),
+                contrib.at(ns(".//phone[@type = 'fax']")),
+                contrib.xpath(ns(".//email")), contrib.xpath(ns(".//uri")), a)
       end
     end
 
-    def org_author(c, role, front)
+    def org_author(contrib, role, front)
       front.author **attr_code(role: role) do |a|
-        organization(c.at(ns("./organization")), a,
-                     c.document.at(ns("//showOnFrontPage")))
-        address(c.at(ns(".//address")),
-                c.at(ns(".//phone[not(@type = 'fax')]")),
-                c.at(ns(".//phone[@type = 'fax']")),
-                c.at(ns(".//email")), c.at(ns(".//uri")), a)
+        organization(contrib.at(ns("./organization")), a,
+                     contrib.document.at(ns("//showOnFrontPage")))
+        address(contrib.at(ns(".//address")),
+                contrib.at(ns(".//phone[not(@type = 'fax')]")),
+                contrib.at(ns(".//phone[@type = 'fax']")),
+                contrib.at(ns(".//email")), contrib.at(ns(".//uri")), a)
       end
     end
 
@@ -120,11 +128,13 @@ module IsoDoc::Ietf
       out.organization name, **attr_code(
         showOnFrontPage: show&.text, ascii: output_if_translit(name),
         asciiAbbrev: output_if_translit(org.at(ns("./abbreviation"))),
-        abbrev: org.at(ns("./abbreviation")))
+        abbrev: org.at(ns("./abbreviation"))
+      )
     end
 
     def address(addr, phone, fax, email, uri, out)
       return unless addr || phone || fax || email || uri
+
       out.address do |a|
         addr and postal(addr, a)
         phone and a.phone phone.text
@@ -137,6 +147,7 @@ module IsoDoc::Ietf
     def postal(addr, out)
       out.postal do |p|
         if line = addr.at(ns("./formattedAddress"))
+          line.xpath(ns(".//br")).each { |br| br.replace("\n") }
           line.text.split(/\n/).each do |l|
             p.postalLine l, **attr_code(ascii: l.transliterate)
           end
@@ -163,10 +174,10 @@ module IsoDoc::Ietf
     def email(email, out)
       ascii = email.text.transliterate
       out.email email.text,
-        **attr_code(ascii: ascii == email.text ? nil : ascii )
+                **attr_code(ascii: ascii == email.text ? nil : ascii)
     end
 
-    def date(isoxml, front)
+    def date(_isoxml, front)
       date = @meta.get[:publisheddate] || @meta.get[:circulateddate] || return
       date = date.gsub(/T.*$/, "")
       attr = date_attr(date) || return
@@ -175,8 +186,9 @@ module IsoDoc::Ietf
 
     def date_attr(date)
       return nil if date.nil?
+
       if date.length == 4 && date =~ /^\d\d\d\d$/ then { year: date }
-      elsif date =~ /^\d\d\d\d-?\d\d$/
+      elsif /^\d\d\d\d-?\d\d$/.match?(date)
         m = /^(?<year>\d\d\d\d)-(?<month>\d\d)$/.match date
         { month: Date::MONTHNAMES[(m[:month]).to_i], year: m[:year] }
       else
@@ -184,25 +196,25 @@ module IsoDoc::Ietf
           d = Date.iso8601 date
           { day: d.day.to_s.gsub(/^0/, ""), year: d.year,
             month: Date::MONTHNAMES[d.month] }
-        rescue
+        rescue StandardError
           nil
         end
       end
     end
 
-    def area(isoxml, front)
+    def area(_isoxml, front)
       @meta.get[:areas].each do |w|
         front.area w
       end
     end
 
-    def workgroup(isoxml, front)
+    def workgroup(_isoxml, front)
       @meta.get[:wg].each do |w|
         front.workgroup w
       end
     end
 
-    def keyword(isoxml, front)
+    def keyword(_isoxml, front)
       @meta.get[:keywords].each do |kw|
         front.keyword kw
       end
@@ -230,7 +242,6 @@ module IsoDoc::Ietf
       end
     end
 
-    def boilerplate(isoxml, front)
-    end
+    def boilerplate(isoxml, front); end
   end
 end