metanorma-ogc 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06257175ed17babd9928b2e5fecaf8aef1ab4e70ba53d494244813e28180d5b
-  data.tar.gz: 7f6d69a86ba6427adeed77e5b47565a4a286278f6931cbf451ee8606fdc0cf5e
+  metadata.gz: aa7220c37ec4c4f57f175cc19ded9faa15b4cef238107d9dbf20fed3350e7964
+  data.tar.gz: 652a56390a308dc6d52c991b6492fbc733275a87b64bdc3b7ebcfd33519e7743
 SHA512:
-  metadata.gz: 3396cd1cb78a0d014003913d57a4460b38b377b980441a98a1e453f125ea9b10636782ab6eff031e425518863cdcf5ef4c3228561cda5d4d6b0d720310b93fb4
-  data.tar.gz: 85705853508542c024f56181bd1ba871b8c869aa4e5b2f3df4689864fa0d7876193f08bb43638260ae5eff5d0eb4d9631892a13bf0a9a934b33af3e94793f1ae
+  metadata.gz: a6374615ac10104cb610e08015f44df88f2ba8a2d11f9830dc91cc4055a881d240d50a54f2db3fb253de8ff00a1900cfc4a6e76db5867b939c15b9abf791db35
+  data.tar.gz: e0c934e414bae2c2749033a9b62add64765d0adc44f72711f97c8f48eb1e15ccf311a5c46d7538cdaf5f91acfd39b2e13ab91432a41e593543090b19eb87aa71

data/lib/asciidoctor/ogc/cleanup.rb

@@ -0,0 +1,145 @@
+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 conditions part description reference
+           requirement permission recommendation)
+      end
+
+      def requirement_metadata1(reqt, dlist)
+        ins = super
+        dlist.xpath("./dt").each do |e|
+          next unless requirement_metadata_component_tags.include? e.text
+
+          ins.next = requirement_metadata1_component(e)
+          ins = ins.next
+        end
+      end
+
+      def requirement_metadata1_component(term)
+        val = term.at("./following::dd")
+        val.name = term.text
+        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 | "\
+                   "./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|
+          %w(p ol ul dl table).include?(c&.elements&.first&.name) and next
+          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
+    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,31 +118,6 @@ 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

data/lib/asciidoctor/ogc/isodoc.rng

@@ -990,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>
@@ -1700,7 +1710,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1763,7 +1775,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1772,6 +1784,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/ogc/validate.rb

@@ -1,7 +1,13 @@
 module Asciidoctor
   module Ogc
     class Converter < Standoc::Converter
-      def title_validate(root)
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "ogc.rng"))
+      end
+
+      def title_validate(_root)
         nil
       end
 
@@ -18,8 +24,9 @@ module Asciidoctor
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(swg-draft oab-review public-rfc tc-vote
-        approved deprecated retired).include? stage or
-        @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
+           approved deprecated retired).include? stage or
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised status")
       end
 
       def version_validate(xmldoc)
@@ -27,10 +34,12 @@ module Asciidoctor
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         if %w(engineering-report discussion-paper).include? doctype
           version.nil? or
-          @log.add("Document Attributes", nil, "Version not permitted for #{doctype}") 
+            @log.add("Document Attributes", nil,
+                     "Version not permitted for #{doctype}")
         else
           version.nil? and
-          @log.add("Document Attributes", nil,  "Version required for #{doctype}") 
+            @log.add("Document Attributes", nil,
+                     "Version required for #{doctype}")
         end
       end
 
@@ -41,7 +50,7 @@ module Asciidoctor
       end
 
       STANDARDTYPE = %w{standard standard-with-suite abstract-specification
-      community-standard profile}.freeze
+                        community-standard profile}.freeze
 
       # spec of permissible section sequence
       # we skip normative references, it goes to end of list
@@ -49,24 +58,25 @@ module Asciidoctor
         [
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: ["./self::clause[@type = 'scope']" ]
+            val: ["./self::clause[@type = 'scope']"],
           },
           {
             msg: "Scope must be followed by Conformance",
-            val: ["./self::clause[@type = 'conformance']" ]
+            val: ["./self::clause[@type = 'conformance']"],
           },
           {
             msg: "Normative References must be followed by "\
-            "Terms and Definitions",
-            val: ["./self::terms | .//terms"]
+                 "Terms and Definitions",
+            val: ["./self::terms | .//terms"],
           },
-      ].freeze
+        ].freeze
 
       def seqcheck(names, msg, accepted)
         n = names.shift
         return [] if n.nil?
+
         test = accepted.map { |a| n.at(a) }
-        if test.all? { |a| a.nil? }
+        if test.all?(&:nil?)
           @log.add("Style", nil, msg)
         end
         names
@@ -74,7 +84,9 @@ module Asciidoctor
 
       def sections_sequence_validate(root)
         return unless STANDARDTYPE.include?(
-          root&.at("//bibdata/ext/doctype")&.text)
+          root&.at("//bibdata/ext/doctype")&.text,
+        )
+
         names = root.xpath("//sections/* | //bibliography/*")
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
         names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
@@ -84,25 +96,28 @@ module Asciidoctor
           n = names.shift
         end
         if n.nil? || n.name != "clause"
-          @log.add("Style", nil, "Document must contain at least one clause")
+          @log.add("Style", nil,
+                   "Document must contain at least one clause")
           return
         end
         root.at("//references | //clause[descendant::references]"\
                 "[not(parent::clause)]") or
-        @log.add("Style", nil, "Normative References are mandatory")
+          @log.add("Style", nil, "Normative References are mandatory")
       end
 
       def preface_sequence_validate(root)
-        root.at("//preface/abstract") or @log.add("Style", nil, "Abstract is missing!")
+        root.at("//preface/abstract") or @log.add("Style", nil,
+                                                  "Abstract is missing!")
         root.at("//bibdata/keyword | //bibdata/ext/keyword") or
           @log.add("Style", nil, "Keywords are missing!")
-        root.at("//foreword") or @log.add("Style", nil,  "Preface is missing!")
+        root.at("//foreword") or @log.add("Style", nil,
+                                          "Preface is missing!")
         root.at("//bibdata/contributor[role/@type = 'author']/organization/"\
                 "name") or
-               @log.add("Style", nil, "Submitting Organizations is missing!")
-        root.at("//submitters") or @log.add("Style", nil, "Submitters is missing!")
+          @log.add("Style", nil, "Submitting Organizations is missing!")
+        root.at("//submitters") or @log.add("Style", nil,
+                                            "Submitters is missing!")
       end
     end
   end
 end
-