metanorma-ietf 2.3.6 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a19bfaee2381bda7dd532941697aa43f6c9804940b9c2f82897f6950d195cc7
-  data.tar.gz: ba4c70b46014f9c41c4971e99da7608df7f2780855bbdbd005e6e4c542dda215
+  metadata.gz: 8b22c8815c0cc3923b629bedb736f56ff20f06aca37abf875d67ff91a63ac6af
+  data.tar.gz: 7a2dd5c740d7f2343c07f684f1f7c672b5577f03e5acc48467da7e3d63f6eb2f
 SHA512:
-  metadata.gz: 4b3eafc5eccb17ceaa77851f1aef2d66ea2fd6b39213b2537643571ee4f3b827a1b5b4d2fc2f9e3622649302661285035a483567b90d32cdddc693ca0d62f86d
-  data.tar.gz: 41c2f933072a61553455c06ac46ce40cd49e81fa86e162740b179a3099ad033eafd9a09723cbfe05c6d7b86227bf5fbd2e4121d4c92e6f625927a535e53ee58e
+  metadata.gz: f602fe12119c1bf21a3d35ef675d67ce68964373a41a34e39c3f6c38ba5233d129cc43e39599a87ac3237c0b1da2ece3773d50e499b8f3b1a36dce35c6d1acd0
+  data.tar.gz: 03fbcf5cb80118d00fdf3753cc00277f52c16fe60c229b03e360ac47cd9b8df3982a11b35a5226dd36c58c593c2aba6e1a08158ebbc5c4184f7aaaceb95d8959

data/lib/asciidoctor/ietf/cleanup.rb

@@ -6,12 +6,10 @@ module Asciidoctor
         abstract_cleanup(xmldoc)
         super
         rfc_anchor_cleanup(xmldoc)
+        cref_cleanup(xmldoc)
+        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
@@ -19,6 +17,21 @@ module Asciidoctor
         end
       end
 
+      def cref_cleanup(xmldoc)
+        xmldoc.xpath("//crefref").each do |r|
+          if c = xmldoc.at("//review[@id = '#{r.text}']")
+            r.replace(c.remove)
+          else
+            @log.add("Crossrefences", r,
+                     "No matching review for cref:[#{r.text}]")
+          end
+        end
+      end
+
+      BCP_KEYWORDS = ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+                      "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
+                      "OPTIONAL"].freeze
+
       def bcp14_cleanup(xmldoc)
         return unless @bcp_bold
 
@@ -30,12 +43,13 @@ module Asciidoctor
       end
 
       def rfc_anchor_cleanup(xmldoc)
-        map = {}
-        xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
-          next if b.at("./ancestor::bibdata")
+        map = xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']")
+          .each_with_object({}) do |b, m|
+          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
+          id = b.at("./docidentifier[@type = 'rfc-anchor']").text
+          m[b["id"]] = id
+          b["id"] = id
         end
         xmldoc.xpath("//eref | //origin").each do |x|
           map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
@@ -49,7 +63,10 @@ module Asciidoctor
 
           n.replace(HTMLEntities.new.encode(
                       n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
-                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic
+                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"')
+                      .gsub(/[\u2010-\u2015]/, "-")
+                      .gsub(/[\u2000-\u200a]|\u202f|\u205f/, " "),
+                      :basic,
                     ))
         end
         xmldoc

data/lib/asciidoctor/ietf/converter.rb

@@ -5,10 +5,15 @@ require_relative "./front"
 require_relative "./blocks"
 require_relative "./validate"
 require_relative "./cleanup"
+require_relative "./macros"
 
 module Asciidoctor
   module Ietf
     class Converter < ::Asciidoctor::Standoc::Converter
+      Asciidoctor::Extensions.register do
+        inline_macro Asciidoctor::Ietf::InlineCrefMacro
+      end
+
       XML_ROOT_TAG = "ietf-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/ietf".freeze
 
@@ -113,70 +118,7 @@ module Asciidoctor
         [t, rel]
       end
 
-      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 | ./ancestor::bibitem")
-
-          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(x)
-        super
-        x.delete("format")
-      end
-
-      def xref_cleanup(xmldoc)
-        super
-        xmldoc.xpath("//xref").each do |x|
-          x.delete("displayFormat")
-          x.delete("relative")
-        end
-      end
-
-      def norm_ref_preface(f)
-      end
+      def norm_ref_preface(sect); end
 
       def clause_parse(attrs, xml, node)
         attrs[:numbered] = node.attr("numbered")

data/lib/asciidoctor/ietf/front.rb

@@ -119,7 +119,7 @@ module Asciidoctor
           strict: node.attr("strict"),
           compact: node.attr("compact"),
           subcompact: node.attr("subcompact"),
-          toc: node.attr("toc-include") == "false" ? "no" : "yes",
+          tocinclude: node.attr("toc-include") == "false" ? "no" : "yes",
           tocdepth: node.attr("toc-depth"),
           symrefs: node.attr("sym-refs"),
           sortrefs: node.attr("sort-refs"),

data/lib/asciidoctor/ietf/ietf.rng

@@ -602,7 +602,10 @@
     </define>
   </include>
   <define name="TextElement" combine="choice">
-    <ref name="bcp14"/>
+    <choice>
+      <ref name="bcp14"/>
+      <ref name="review"/>
+    </choice>
   </define>
   <define name="bcp14">
     <element name="bcp14">
@@ -842,7 +845,7 @@
         </element>
       </optional>
       <optional>
-        <element name="toc">
+        <element name="tocinclude">
           <text/>
         </element>
       </optional>

data/lib/asciidoctor/ietf/isodoc.rng

@@ -32,6 +32,18 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="section-title">
+      <element name="title">
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+      <zeroOrMore>
+        <element name="variant-title">
+          <ref name="TypedTitleString"/>
+        </element>
+      </zeroOrMore>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -158,15 +170,17 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <attribute name="type">
-          <choice>
-            <value>roman</value>
-            <value>alphabet</value>
-            <value>arabic</value>
-            <value>roman_upper</value>
-            <value>alphabet_upper</value>
-          </choice>
-        </attribute>
+        <optional>
+          <attribute name="type">
+            <choice>
+              <value>roman</value>
+              <value>alphabet</value>
+              <value>arabic</value>
+              <value>roman_upper</value>
+              <value>alphabet_upper</value>
+            </choice>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -976,6 +990,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="linkmention">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="linkref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -1011,8 +1035,23 @@
       <ref name="imagemap"/>
       <ref name="svgmap"/>
       <ref name="inputform"/>
+      <ref name="toc"/>
+      <ref name="passthrough"/>
     </choice>
   </define>
+  <define name="toc">
+    <element name="toc">
+      <ref name="ul"/>
+    </element>
+  </define>
+  <define name="passthrough">
+    <element name="passthrough">
+      <optional>
+        <attribute name="formats"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
   <define name="inputform">
     <element name="form">
       <attribute name="id">
@@ -1254,6 +1293,12 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
     <text/>
   </define>
   <define name="ics">
@@ -1674,7 +1719,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1737,7 +1784,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1746,6 +1793,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/ietf/macros.rb

@@ -0,0 +1,17 @@
+require "asciidoctor/extensions"
+
+module Asciidoctor
+  module Ietf
+    class InlineCrefMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :cref
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<crefref>#{out}</crefref>}
+      end
+    end
+  end
+end

data/lib/asciidoctor/ietf/reqt.rng

@@ -64,9 +64,9 @@
     <optional>
       <ref name="label"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="subject"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="reqinherit"/>
     </zeroOrMore>
@@ -80,6 +80,7 @@
         <ref name="verification"/>
         <ref name="import"/>
         <ref name="description"/>
+        <ref name="component"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -105,12 +106,16 @@
   </define>
   <define name="subject">
     <element name="subject">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="reqinherit">
     <element name="inherit">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="measurementtarget">
@@ -138,6 +143,12 @@
       <ref name="RequirementSubpart"/>
     </element>
   </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
   <define name="reqt_references">
     <element name="references">
       <oneOrMore>

data/lib/asciidoctor/ietf/validate.rb

@@ -1,4 +1,4 @@
-require "open-uri"
+require "metanorma/ietf/data/workgroups"
 
 module Asciidoctor
   module Ietf
@@ -34,59 +34,8 @@ 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)
-        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
-            warn "Cache #{wgcache_name} is invalid, drop it"
-          end
-        end
-        [wg, wgcache_name]
-      end
-
-      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
-        end
-        wg
-      end
-
-      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
-          end
-        end
-        wg
-      end
-
-      def cache_workgroup(node)
-        wg, wgcache_name = open_wg_cache(node)
-        if wg.empty?
-          File.open(wgcache_name, "w") do |b|
-            wg = cache_workgroup_ietf(wg, b)
-            wg = cache_workgroup_irtf(wg, b)
-            b << wg.to_json
-          end
-        end
-        wg
+      def cache_workgroup(_node)
+        Metanorma::Ietf::Data::WORKGROUPS
       end
     end
   end