metanorma-ogc 1.4.1 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06257175ed17babd9928b2e5fecaf8aef1ab4e70ba53d494244813e28180d5b
-  data.tar.gz: 7f6d69a86ba6427adeed77e5b47565a4a286278f6931cbf451ee8606fdc0cf5e
+  metadata.gz: 8b004271fb32dddbacb0a918bdb44b5e505d9897031d79d68230f62af3b00fbb
+  data.tar.gz: 054f0f06008fbfe87cf6de3ccb472b54354ea6c5ae24214591a2d93d315b6024
 SHA512:
-  metadata.gz: 3396cd1cb78a0d014003913d57a4460b38b377b980441a98a1e453f125ea9b10636782ab6eff031e425518863cdcf5ef4c3228561cda5d4d6b0d720310b93fb4
-  data.tar.gz: 85705853508542c024f56181bd1ba871b8c869aa4e5b2f3df4689864fa0d7876193f08bb43638260ae5eff5d0eb4d9631892a13bf0a9a934b33af3e94793f1ae
+  metadata.gz: a3eef75cb366bcac20327b3a9c7e75d3fa57dc7408b55ba6dc890f0515af24ffc974e4ea565f37b0d4154a3ce1342678fe80baed6766b80b89d9ce3e61204e71
+  data.tar.gz: 4aba2501b403301014127dfd18fc85b70493ddf43081045c61aabd086322a8b6f2808446d97a6cfc0dfc2e6653742c84d2585916e48bb891ecddc475a23bbb24

data/lib/asciidoctor/ogc/basicdoc.rng

@@ -624,6 +624,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +637,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +647,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +833,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +848,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +864,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">

data/lib/asciidoctor/ogc/cleanup.rb

@@ -0,0 +1,173 @@
+module Asciidoctor
+  module Ogc
+    class Converter < Standoc::Converter
+      def sections_cleanup(xml)
+        super
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def make_preface(xml, sect)
+        super
+        insert_security(xml, sect)
+        insert_submitters(xml, sect)
+      end
+
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def insert_security(xml, sect)
+        description = "document"
+        description = "standard" if %w(standard community-standard)
+          .include?(sect&.at("//bibdata/ext/doctype")&.text)
+        preface = sect.at("//preface") ||
+          sect.add_previous_sibling("<preface/>").first
+        sect = xml&.at("//clause[@type = 'security']")&.remove ||
+          "<clause type='security' #{add_id}>"\
+          "<title>Security considerations</title>"\
+          "<p>#{@i18n.security_empty.sub(/%/, description)}</p></clause>"
+        preface.add_child sect
+      end
+
+      def insert_submitters(xml, sect)
+        if xml.at("//submitters")
+          preface = sect.at("//preface") ||
+            sect.add_previous_sibling("<preface/>").first
+          submitters = xml.at("//submitters").remove
+          submitters.xpath(".//table").each do |t|
+            t["unnumbered"] = true
+          end
+          preface.add_child submitters.remove
+        end
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc); end
+
+      def bibdata_cleanup(xmldoc)
+        super
+        a = xmldoc.at("//bibdata/status/stage")
+        a.text == "published" and a.children = "approved"
+      end
+
+      def section_names_terms_cleanup(xml)
+        replace_title(xml, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(xml, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
+        replace_title(xml, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(xml, "//sections//terms#{SYMnoABBR} | "\
+                           "//sections//clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(xml, "//sections//terms#{ABBRnoSYM} | "\
+                           "//sections//clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(xml, "//sections//terms#{SYMABBR} | "\
+                           "//sections//clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(xml, "//sections//terms#{NO_SYMABBR} | "\
+                           "//sections//clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(xml, "//sections//terms[not(.//definitions)] | "\
+                           "//sections//clause[.//terms][not(.//definitions)]",
+                      @i18n&.termsdef, true)
+      end
+
+      def requirement_metadata_component_tags
+        %w(test-purpose test-method test-method-type conditions part description
+           reference step requirement permission recommendation)
+      end
+
+      def requirement_metadata1(reqt, dlist, ins)
+        ins1 = super
+        dlist.xpath("./dt").each do |e|
+          tag = e&.text&.gsub(/ /, "-")&.downcase
+          next unless requirement_metadata_component_tags.include? tag
+
+          ins1.next = requirement_metadata1_component(e, tag)
+          ins1 = ins1.next
+        end
+      end
+
+      def requirement_metadata1_component(term, tag)
+        val = term.at("./following::dd")
+        val.name = tag
+        val.xpath("./dl").each do |d|
+          requirement_metadata1(val, d, d)
+          d.remove
+        end
+        if %w(requirement permission
+              recommendation).include?(term.text) && !val.text.empty?
+          val["label"] = val.text.strip
+          val.children.remove
+        end
+        val
+      end
+
+      def requirement_metadata(xmldoc)
+        super
+        xmldoc.xpath(REQRECPER).each do |r|
+          requirement_metadata_to_component(r)
+          requirement_metadata_to_requirement(r)
+          requirement_subparts_to_blocks(r)
+        end
+      end
+
+      def requirement_metadata_to_component(reqt)
+        reqt.xpath(".//test-method | .//test-purpose | .//conditions | "\
+                   ".//part | .//test-method-type | .//step | .//reference")
+          .each do |c|
+          c["class"] = c.name
+          c.name = "component"
+        end
+      end
+
+      def requirement_metadata_to_requirement(reqt)
+        reqt.xpath("./requirement | ./permission | ./recommendation")
+          .each do |c|
+          c["id"] = Metanorma::Utils::anchor_or_uuid
+        end
+      end
+
+      def requirement_subparts_to_blocks(reqt)
+        reqt.xpath(".//component | .//description").each do |c|
+          next if %w(p ol ul dl table component description)
+            .include?(c&.elements&.first&.name)
+
+          c.children = "<p>#{c.children.to_xml}</p>"
+        end
+      end
+
+      # skip annex/terms/terms, which is empty node
+      def termdef_subclause_cleanup(xmldoc)
+        xmldoc.xpath("//annex//terms[terms]").each do |t|
+          next if t.parent.name == "terms"
+
+          t.children.each { |n| n.parent = t.parent }
+          t.remove
+        end
+      end
+
+      def requirement_cleanup(xmldoc)
+        requirement_type(xmldoc)
+        super
+      end
+
+      def requirement_type(xmldoc)
+        xmldoc.xpath(REQRECPER).each do |r|
+          next unless r["type"]
+
+          r["type"] = case r["type"]
+                      when "requirement", "recommendation", "permission"
+                        "general"
+                      when "requirements_class" then "class"
+                      when "conformance_test" then "verification"
+                      when "conformance_class" then "conformanceclass"
+                      when "abstract_test" then "abstracttest"
+                      else r["type"]
+                      end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/ogc/converter.rb

@@ -3,6 +3,7 @@ require "asciidoctor/standoc/converter"
 require "fileutils"
 require_relative "front"
 require_relative "validate"
+require_relative "cleanup"
 
 module Asciidoctor
   module Ogc
@@ -40,6 +41,14 @@ module Asciidoctor
         d
       end
 
+      def sectiontype(node, level = true)
+        ret = sectiontype_streamline(sectiontype1(node))
+        return ret if ret == "terms and definitions" &&
+          node.attr("style") == "appendix" && node.level == 1
+
+        super
+      end
+
       def sectiontype_streamline(ret)
         case ret
         when "preface" then "foreword"
@@ -62,55 +71,6 @@ module Asciidoctor
                                      false, "#{@filename}.pdf")
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "ogc.rng"))
-      end
-
-      def sections_cleanup(xml)
-        super
-        xml.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def make_preface(xml, sect)
-        super
-        insert_security(xml, sect)
-        insert_submitters(xml, sect)
-      end
-
-      def add_id
-        %(id="_#{UUIDTools::UUID.random_create}")
-      end
-
-      def insert_security(xml, sect)
-        doctype = sect&.at("//bibdata/ext/doctype")&.text
-        description = if %w(standard
-                            community-standard).include?(doctype)
-                        "standard"
-                      else
-                        "document"
-                      end
-        preface = sect.at("//preface") ||
-          sect.add_previous_sibling("<preface/>").first
-        sect = xml&.at("//clause[@type = 'security']")&.remove ||
-          "<clause type='security' #{add_id}>"\
-          "<title>Security Considerations</title>"\
-          "<p>#{@i18n.security_empty.sub(/%/, description)}</p></clause>"
-        preface.add_child sect
-      end
-
-      def insert_submitters(xml, sect)
-        if xml.at("//submitters")
-          preface = sect.at("//preface") ||
-            sect.add_previous_sibling("<preface/>").first
-          submitters = xml.at("//submitters").remove
-          preface.add_child submitters.remove
-        end
-      end
-
       def clause_parse(attrs, xml, node)
         case node&.attr("heading")&.downcase || node.title.downcase
         when "submitters" then return submitters_parse(attrs, xml, node)
@@ -132,8 +92,6 @@ module Asciidoctor
         nil
       end
 
-      def termdef_boilerplate_cleanup(xmldoc); end
-
       def term_def_parse(attrs, xml, node, _toplevel)
         if node.attr("style") == "appendix" && node.level == 1
           terms_annex_parse(attrs, xml, node)
@@ -160,35 +118,20 @@ module Asciidoctor
         end
       end
 
-      def bibdata_cleanup(xmldoc)
-        super
-        a = xmldoc.at("//bibdata/status/stage")
-        a.text == "published" and a.children = "approved"
-      end
-
-      def section_names_terms_cleanup(xml)
-        replace_title(xml, "//definitions[@type = 'symbols']", @i18n&.symbols)
-        replace_title(xml, "//definitions[@type = 'abbreviated_terms']",
-                      @i18n&.abbrev)
-        replace_title(xml, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
-        replace_title(xml, "//sections//terms#{SYMnoABBR} | //sections//clause[.//terms]#{SYMnoABBR}",
-                      @i18n&.termsdefsymbols, true)
-        replace_title(xml, "//sections//terms#{ABBRnoSYM} | //sections//clause[.//terms]#{ABBRnoSYM}",
-                      @i18n&.termsdefabbrev, true)
-        replace_title(xml, "//sections//terms#{SYMABBR} | //sections//clause[.//terms]#{SYMABBR}",
-                      @i18n&.termsdefsymbolsabbrev, true)
-        replace_title(xml, "//sections//terms#{NO_SYMABBR} | //sections//clause[.//terms]#{NO_SYMABBR}",
-                      @i18n&.termsdefsymbolsabbrev, true)
-        replace_title(
-          xml, "//sections//terms[not(.//definitions)] | //sections//clause[.//terms][not(.//definitions)]",
-          @i18n&.termsdef, true
-        )
-      end
-
       def highlight_parse(text, xml)
         xml.hi { |s| s << text }
       end
 
+      def example(node)
+        role = node.role || node.attr("style")
+        if %w(requirements_class conformance_test conformance_class
+              abstract_test).include?(role)
+          node.set_attr("type", role)
+          return requirement(node, "requirement")
+        end
+        super
+      end
+
       def presentation_xml_converter(node)
         IsoDoc::Ogc::PresentationXMLConvert.new(html_extract_attributes(node))
       end