RubyGems - metanorma-ietf - Versions diffs - 2.3.5 → 2.4.2 - Mend

metanorma-ietf 2.3.5 → 2.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

checksums.yaml +4 -4
data/lib/asciidoctor/ietf/cleanup.rb +99 -0
data/lib/asciidoctor/ietf/converter.rb +23 -89
data/lib/asciidoctor/ietf/front.rb +1 -1
data/lib/asciidoctor/ietf/ietf.rng +5 -2
data/lib/asciidoctor/ietf/isodoc.rng +93 -18
data/lib/asciidoctor/ietf/macros.rb +17 -0
data/lib/asciidoctor/ietf/reqt.rng +15 -4
data/lib/asciidoctor/ietf/validate.rb +3 -54
data/lib/isodoc/ietf/blocks.rb +181 -174
data/lib/isodoc/ietf/cleanup.rb +19 -1
data/lib/isodoc/ietf/inline.rb +127 -124
data/lib/isodoc/ietf/references.rb +152 -128
data/lib/isodoc/ietf/section.rb +1 -1
data/lib/isodoc/ietf/validation.rb +158 -157
data/lib/metanorma/ietf/version.rb +1 -1
data/metanorma-ietf.gemspec +1 -1
metadata +12 -10

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7629e0ade5cff517d3fdf80296490da26a339654c338d7976d1b7f028aebb147
-  data.tar.gz: 3add51632aeb8f9c1f06c96ca276e3bb947d129ce704c902eb918e998331914a
+  metadata.gz: e0bce55e3d73f441a77b94d2aa6f7f464e727b914dd8e8c6fa67dbf035122d63
+  data.tar.gz: 1eaa61e2a47f793b47653f76e8ff6a7fd53a8f7889a06b9e43e61132cb6b066d
 SHA512:
-  metadata.gz: 3519faef8dccfc5c474c0d3e4b12401aad30e98f666c50939aa1abf8736c9dddca67129dd6c50bc2cad77ce9f4589469d6ab93943462866d61d49b17fb888a3b
-  data.tar.gz: 490a7fddbb7c158c746445f3607b7fe5225b9e8d082b5e0f529c30b08c7db497bf0826872d904f4c95628e630b35d3048d4f4511602cc06fb3f8169dda5812f1
+  metadata.gz: c8f01b1753308bdb0d335a766fa4ed638a417a81433bb6f6b95a02518674d5eff55b3951db0717e748f7dc8dc3d0def3db27ddadb0f0a36105247f666747099b
+  data.tar.gz: af96278d659ea2949ad3aa2a435cdbe17017e171502fdea71cd5c332d13d7f7a2dade54361e8173aaf9b41e0614af7402fed6773d6f978e2388616f929108007

data/lib/asciidoctor/ietf/cleanup.rb ADDED Viewed

@@ -0,0 +1,99 @@
+module Asciidoctor
+  module Ietf
+    class Converter < ::Asciidoctor::Standoc::Converter
+      def cleanup(xmldoc)
+        bcp14_cleanup(xmldoc)
+        abstract_cleanup(xmldoc)
+        super
+        rfc_anchor_cleanup(xmldoc)
+        cref_cleanup(xmldoc)
+        xmldoc
+      end
+      def abstract_cleanup(xmldoc)
+        xmldoc.xpath("//abstract[not(text())]").each do |x|
+          x.remove
+          warn "Empty abstract section removed"
+        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
+        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_with_object({}) do |b, m|
+          next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
+          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"]]
+        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 CHANGED Viewed

@@ -4,10 +4,16 @@ require "isodoc/ietf/rfc_convert"
 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
@@ -22,13 +28,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 +69,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
@@ -112,69 +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")
-          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")
@@ -194,34 +138,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/front.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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>
@@ -204,6 +218,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">
@@ -899,7 +925,7 @@
   </include>
   <!-- end overrides -->
   <define name="docsubtype">
-    <element name="docsubtype">
+    <element name="subdoctype">
       <ref name="DocumentSubtype"/>
     </element>
   </define>
@@ -954,6 +980,26 @@
   </define>
   <define name="concept">
     <element name="concept">
+      <optional>
+        <attribute name="ital">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="ref">
+          <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>
@@ -989,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">
@@ -998,6 +1059,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1229,6 +1293,12 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
     <text/>
   </define>
   <define name="ics">
@@ -1490,26 +1560,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>
@@ -1649,7 +1719,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1712,7 +1784,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1721,6 +1793,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/ietf/macros.rb ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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