metanorma-ietf 2.3.2 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a4d62d9ba4598f0bc4a7e03e9a2685e157adf44914b5513d75e664e625a9e2
-  data.tar.gz: 56a43f317ad9b8feae2469e3a0f27ccb4c52960611df53ab6a6678989c5504c5
+  metadata.gz: 1a19bfaee2381bda7dd532941697aa43f6c9804940b9c2f82897f6950d195cc7
+  data.tar.gz: ba4c70b46014f9c41c4971e99da7608df7f2780855bbdbd005e6e4c542dda215
 SHA512:
-  metadata.gz: 05e58bfa09d771d279fd9358253d27ce7be451ae8cfb223aac2438dc4971f51736a630d983d435ab33140ac6ba52898b71f2b9dcb5efc7852d4e488e33cd2205
-  data.tar.gz: 6ecac088b4b00f92fbf1044d7345d50cc391280b0576cf300b7980e2edf5cf4ec4c1fd2a44b8a9e4b9b583dcbf763f894094c54696121af0e1fa1c90919e6684
+  metadata.gz: 4b3eafc5eccb17ceaa77851f1aef2d66ea2fd6b39213b2537643571ee4f3b827a1b5b4d2fc2f9e3622649302661285035a483567b90d32cdddc693ca0d62f86d
+  data.tar.gz: 41c2f933072a61553455c06ac46ce40cd49e81fa86e162740b179a3099ad033eafd9a09723cbfe05c6d7b86227bf5fbd2e4121d4c92e6f625927a535e53ee58e

data/.github/workflows/rake.yml

@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
 
     steps:
       - uses: actions/checkout@master
@@ -68,7 +58,7 @@ jobs:
         with:
           path: ~/.cache/xml2rfc
           key: xml2rfc
-          restore-key: xml2rfc
+          restore-keys: xml2rfc
 
       - if: matrix.os == 'macos-latest'
         run: brew install libmagic
@@ -88,5 +78,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,12 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/ietf/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/ietf/cleanup.rb

@@ -0,0 +1,85 @@
+module Asciidoctor
+  module Ietf
+    class Converter < ::Asciidoctor::Standoc::Converter
+      def cleanup(xmldoc)
+        bcp14_cleanup(xmldoc)
+        abstract_cleanup(xmldoc)
+        super
+        rfc_anchor_cleanup(xmldoc)
+      end
+
+      BCP_KEYWORDS =
+        ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+         "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL"].freeze
+
+      def abstract_cleanup(xmldoc)
+        xmldoc.xpath("//abstract[not(text())]").each do |x|
+          x.remove
+          warn "Empty abstract section removed"
+        end
+      end
+
+      def bcp14_cleanup(xmldoc)
+        return unless @bcp_bold
+
+        xmldoc.xpath("//strong").each do |s|
+          next unless BCP_KEYWORDS.include?(s.text)
+
+          s.name = "bcp14"
+        end
+      end
+
+      def rfc_anchor_cleanup(xmldoc)
+        map = {}
+        xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
+          next if b.at("./ancestor::bibdata")
+
+          map[b["id"]] = b.at("./docidentifier[@type = 'rfc-anchor']").text
+          b["id"] = b.at("./docidentifier[@type = 'rfc-anchor']").text
+        end
+        xmldoc.xpath("//eref | //origin").each do |x|
+          map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
+        end
+        xmldoc
+      end
+
+      def smartquotes_cleanup(xmldoc)
+        xmldoc.traverse do |n|
+          next unless n.text?
+
+          n.replace(HTMLEntities.new.encode(
+                      n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
+                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic
+                    ))
+        end
+        xmldoc
+      end
+
+      def xref_to_eref(xref)
+        super
+        xref.delete("format")
+      end
+
+      def xref_cleanup(xmldoc)
+        super
+        xmldoc.xpath("//xref").each do |x|
+          x.delete("displayFormat")
+          x.delete("relative")
+        end
+      end
+
+      def quotesource_cleanup(xmldoc)
+        xmldoc.xpath("//quote/source | //terms/source").each do |x|
+          if x["target"]&.match?(URI::DEFAULT_PARSER.make_regexp)
+            x["uri"] = x["target"]
+            x.delete("target")
+          else
+            xref_to_eref(x)
+          end
+        end
+      end
+
+      def section_names_refs_cleanup(xml); end
+    end
+  end
+end

data/lib/asciidoctor/ietf/converter.rb

@@ -4,6 +4,7 @@ require "isodoc/ietf/rfc_convert"
 require_relative "./front"
 require_relative "./blocks"
 require_relative "./validate"
+require_relative "./cleanup"
 
 module Asciidoctor
   module Ietf
@@ -22,13 +23,13 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @workgroups = cache_workgroup(node)
         @bcp_bold = !node.attr?("no-rfc-bold-bcp14")
-        @xinclude = node.attr?("use-xinclude") 
+        @xinclude = node.attr?("use-xinclude")
         super
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        rfc_converter(node).convert(@filename + ".xml")
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        rfc_converter(node).convert("#{@filename}.xml")
       end
 
       def doctype(node)
@@ -63,12 +64,12 @@ module Asciidoctor
         f, c = xref_text(node)
         f1, c = eref_text(node) if f.nil?
         t, rel = xref_rel(node)
+        attrs = { target: t, type: "inline", displayFormat: f1, format: f,
+                  relative: rel }
         noko do |xml|
-          xml.xref **attr_code(target: t, type: "inline",
-                               displayFormat: f1, format: f,
-                               relative: rel ) do |x|
-                                 x << c
-                               end
+          xml.xref **attr_code(attrs) do |x|
+            x << c
+          end
         end.join
       end
 
@@ -140,7 +141,8 @@ module Asciidoctor
       def rfc_anchor_cleanup(xmldoc)
         map = {}
         xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
-          next if b.at("./ancestor::bibdata")
+          next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
+
           map[b["id"]] = b.at("./docidentifier[@type = 'rfc-anchor']").text
           b["id"] = b.at("./docidentifier[@type = 'rfc-anchor']").text
         end
@@ -194,34 +196,24 @@ module Asciidoctor
         clause_parse(attrs, xml, node)
       end
 
-      def quotesource_cleanup(xmldoc)
-        xmldoc.xpath("//quote/source | //terms/source").each do |x|
-          if x["target"] =~ URI::DEFAULT_PARSER.make_regexp
-            x["uri"] = x["target"]
-            x.delete("target")
-          else
-            xref_to_eref(x)
-          end
-        end
-      end
-
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text.sub(/^primary:(?=\S)/, "")
           terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
-          if /^primary:\S/.match(terms[0])
+          if /^primary:\S/.match?(terms[0])
             terms[0].sub!(/^primary:/, "")
             has_primary = true
           end
-          xml.index **attr_code(primary: has_primary) do |i|
-            i.primary { |x| x << terms[0] }
-            a = terms.dig(1) and i.secondary { |x| x << a }
-            a = terms.dig(2) and i.tertiary { |x| x << a }
-          end
+          inline_indexterm1(has_primary, terms, xml)
         end.join
       end
 
-      def section_names_refs_cleanup(x)
+      def inline_indexterm1(has_primary, terms, xml)
+        xml.index **attr_code(primary: has_primary) do |i|
+          i.primary { |x| x << terms[0] }
+          a = terms[1] and i.secondary { |x| x << a }
+          a = terms[2] and i.tertiary { |x| x << a }
+        end
       end
 
       def html_extract_attributes(node)

data/lib/asciidoctor/ietf/ietf.rng

@@ -19,6 +19,9 @@
       <optional>
         <ref name="doctype"/>
       </optional>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <zeroOrMore>
         <ref name="editorialgroup"/>
       </zeroOrMore>

data/lib/asciidoctor/ietf/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -199,6 +204,18 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="dt">
+      <element name="dt">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -543,6 +560,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -890,6 +910,14 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="subdoctype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -939,7 +967,34 @@
   <define name="concept">
     <element name="concept">
       <optional>
-        <attribute name="term"/>
+        <attribute name="ital">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="ref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <element name="refterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="renderterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
       </optional>
       <choice>
         <ref name="eref"/>
@@ -965,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1191,9 +1249,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>
@@ -1459,26 +1515,26 @@
     <optional>
       <ref name="section-title"/>
     </optional>
-    <group>
+    <choice>
       <choice>
         <group>
-          <zeroOrMore>
+          <oneOrMore>
             <ref name="BasicBlock"/>
-          </zeroOrMore>
+          </oneOrMore>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>
         </group>
         <ref name="amend"/>
       </choice>
-      <zeroOrMore>
+      <oneOrMore>
         <choice>
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
         </choice>
-      </zeroOrMore>
-    </group>
+      </oneOrMore>
+    </choice>
   </define>
   <define name="Annex-Section">
     <optional>

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/cleanup.rb

@@ -48,6 +48,17 @@ module IsoDoc::Ietf
       figure_postamble(docxml)
       figure_unnest(docxml)
       figure_footnote_cleanup(docxml)
+      figure_data_uri(docxml)
+    end
+
+    def figure_data_uri(docxml)
+      docxml.xpath("//artwork").each do |a|
+        next unless %r{^data:image/svg\+xml;base64}.match?(a["src"])
+
+        f = Metanorma::Utils::save_dataimage(a["src"])
+        a.delete("src")
+        a.children = File.read(f).sub(%r{<\?.+\?>}, "")
+      end
     end
 
     def figure_unnest(docxml)
@@ -133,7 +144,7 @@ module IsoDoc::Ietf
         docxml << "<back/>" and endnotes = docxml.at("//back")
       end
       endnotes << "<section><name>Endnotes</name></section>"
-      endnotes = docxml.at("//back/section[last()]")
+      docxml.at("//back/section[last()]")
     end
 
     def image_cleanup(docxml)
@@ -153,13 +164,13 @@ module IsoDoc::Ietf
         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}]]>"
+        s.children = "<![CDATA[#{HTMLEntities.new.decode(s
+        .children.to_xml.sub(/\A\n+/, ''))}]]>"
       end
     end
 
-    def sourcecode_remove_markup(s)
-      s.traverse do |n|
+    def sourcecode_remove_markup(node)
+      node.traverse do |n|
         next if n.text?
         next if %w(name callout annotation note sourcecode).include? n.name
 

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
@@ -164,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
@@ -176,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
@@ -185,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
@@ -231,7 +242,6 @@ module IsoDoc::Ietf
       end
     end
 
-    def boilerplate(isoxml, front)
-    end
+    def boilerplate(isoxml, front); end
   end
 end

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/rfc_convert.rb

@@ -15,7 +15,7 @@ require_relative "./init"
 
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
-    def convert1(docxml, filename, dir)
+    def convert1(docxml, _filename, _dir)
       @xrefs.parse docxml
       info docxml, nil
       xml = noko do |xml|
@@ -51,6 +51,7 @@ module IsoDoc::Ietf
     def error_parse(node, out)
       case node.name
       when "bcp14" then bcp14_parse(node, out)
+      when "concept" then concept_parse(node, out)
       else
         text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
         out.t { |p| p << text }
@@ -59,6 +60,7 @@ module IsoDoc::Ietf
 
     def omit_docid_prefix(prefix)
       return true if prefix == "IETF"
+
       super
     end
 
@@ -67,9 +69,9 @@ module IsoDoc::Ietf
     end
 
     def postprocess(result, filename, _dir)
-      result = from_xhtml(cleanup(to_xhtml(textcleanup(result)))).
-        sub(/<!DOCTYPE[^>]+>\n/, "").
-        sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
+      result = from_xhtml(cleanup(to_xhtml(textcleanup(result))))
+        .sub(/<!DOCTYPE[^>]+>\n/, "")
+        .sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
       File.open(filename, "w:UTF-8") { |f| f.write(result) }
       schema_validate(filename)
       @files_to_delete.each { |f| FileUtils.rm_rf f }

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/isodoc/ietf/terms.rb

@@ -1,6 +1,5 @@
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
-
     def definition_parse(node, out)
       node.children.each { |n| parse(n, out) }
     end
@@ -46,7 +45,19 @@ module IsoDoc::Ietf
       clause_parse(node, out)
     end
 
-    def termdocsource_parse(_node, _out)
+    def termdocsource_parse(_node, _out); end
+
+    def concept_parse(node, out)
+      if d = node.at(ns("./renderterm"))
+        out.em do |em|
+          d.children.each { |n| parse(n, em) }
+        end
+        out << " "
+      end
+      out << "[term defined in "
+      r = node.at(ns("./xref | ./eref | ./termref"))
+      parse(r, out)
+      out << "]"
     end
   end
 end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "2.3.2".freeze
+    VERSION = "2.3.6".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -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 "isodoc", "~> 1.6.0"
+  spec.add_dependency "isodoc", "~> 1.7.0"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "metanorma-standoc", "~> 1.9.0"
-  spec.add_dependency "nokogiri", "~> 1.10.4"
+  spec.add_dependency "metanorma-standoc", "~> 1.10.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.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
@@ -261,6 +275,7 @@ files:
 - lib/asciidoctor/ietf/basicdoc.rng
 - lib/asciidoctor/ietf/biblio.rng
 - lib/asciidoctor/ietf/blocks.rb
+- lib/asciidoctor/ietf/cleanup.rb
 - lib/asciidoctor/ietf/converter.rb
 - lib/asciidoctor/ietf/front.rb
 - lib/asciidoctor/ietf/ietf.rng
@@ -306,7 +321,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:
   - - ">="