metanorma-ietf 2.3.5 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7629e0ade5cff517d3fdf80296490da26a339654c338d7976d1b7f028aebb147
-  data.tar.gz: 3add51632aeb8f9c1f06c96ca276e3bb947d129ce704c902eb918e998331914a
+  metadata.gz: 1a19bfaee2381bda7dd532941697aa43f6c9804940b9c2f82897f6950d195cc7
+  data.tar.gz: ba4c70b46014f9c41c4971e99da7608df7f2780855bbdbd005e6e4c542dda215
 SHA512:
-  metadata.gz: 3519faef8dccfc5c474c0d3e4b12401aad30e98f666c50939aa1abf8736c9dddca67129dd6c50bc2cad77ce9f4589469d6ab93943462866d61d49b17fb888a3b
-  data.tar.gz: 490a7fddbb7c158c746445f3607b7fe5225b9e8d082b5e0f529c30b08c7db497bf0826872d904f4c95628e630b35d3048d4f4511602cc06fb3f8169dda5812f1
+  metadata.gz: 4b3eafc5eccb17ceaa77851f1aef2d66ea2fd6b39213b2537643571ee4f3b827a1b5b4d2fc2f9e3622649302661285035a483567b90d32cdddc693ca0d62f86d
+  data.tar.gz: 41c2f933072a61553455c06ac46ce40cd49e81fa86e162740b179a3099ad033eafd9a09723cbfe05c6d7b86227bf5fbd2e4121d4c92e6f625927a535e53ee58e

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/isodoc.rng

@@ -204,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">
@@ -899,7 +911,7 @@
   </include>
   <!-- end overrides -->
   <define name="docsubtype">
-    <element name="docsubtype">
+    <element name="subdoctype">
       <ref name="DocumentSubtype"/>
     </element>
   </define>
@@ -954,6 +966,16 @@
   </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>
         <element name="refterm">
           <zeroOrMore>
@@ -998,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1490,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/metanorma/ietf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 2.3.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc
@@ -275,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