metanorma-ogc 1.3.7 → 1.4.2

data/lib/asciidoctor/ogc/ogc.rng

@@ -62,6 +62,19 @@
         </optional>
       </element>
     </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>conceptual-model</value>
+        <value>conceptual-model-and-encoding</value>
+        <value>conceptual-model-and-implementation</value>
+        <value>encoding</value>
+        <value>extension</value>
+        <value>implementation</value>
+        <value>profile</value>
+        <value>profile-with-extension</value>
+        <value>general</value>
+      </choice>
+    </define>
   </include>
   <define name="TextElement" combine="choice">
     <ref name="hi"/>
@@ -79,19 +92,6 @@
       </zeroOrMore>
     </element>
   </define>
-  <define name="DocumentSubtype">
-    <choice>
-      <value>conceptual-model</value>
-      <value>conceptual-model-and-encoding</value>
-      <value>conceptual-model-and-implementation</value>
-      <value>encoding</value>
-      <value>extension</value>
-      <value>implementation</value>
-      <value>profile</value>
-      <value>profile-with-extension</value>
-      <value>general</value>
-    </choice>
-  </define>
   <define name="submitters">
     <element name="submitters">
       <ref name="Basic-Section"/>

data/lib/asciidoctor/ogc/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/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
-

data/lib/isodoc/ogc/base_convert.rb

@@ -15,7 +15,7 @@ module IsoDoc
       end
 
       def hi_parse(node, out)
-        out.span **{class: "hi"} do |e|
+        out.span **{ class: "hi" } do |e|
           node.children.each { |n| parse(n, e) }
         end
       end
@@ -27,23 +27,58 @@ module IsoDoc
 
       def term_cleanup(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
-          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child(" ")
-          h2.add_child(d.remove)
+          term_cleanup_merge_termnum(d)
+          term_cleanup_merge_admitted(d)
         end
         docxml
       end
 
+      def term_cleanup_merge_termnum(term)
+        h2 = term.at("./preceding-sibling::*[@class = 'TermNum'][1]")
+        term["class"] = h2["class"]
+        term["id"] = h2["id"]
+        term.children.first.previous = " "
+        term.children.first.previous = h2.remove.children
+      end
+
+      def term_cleanup_merge_admitted(term)
+        term.xpath("./following-sibling::p[@class = 'AltTerms' or "\
+                   "@class = 'DeprecatedTerms']").each do |a|
+          term << " "
+          term << a.children
+          a.remove
+        end
+      end
+
+      def deprecated_term_parse(node, out)
+        out.p **{ class: "DeprecatedTerms" } do |p|
+          node.children.each { |c| parse(c, p) }
+          p << "&#xa0;"
+          p.span **{ class: "AdmittedLabel" } do |s|
+            s << l10n(@i18n.deprecated)
+          end
+        end
+      end
+
+      def admitted_term_parse(node, out)
+        out.p **{ class: "AltTerms" } do |p|
+          node.children.each { |c| parse(c, p) }
+          p << "&#xa0;"
+          p.span **{ class: "AdmittedLabel" } do |s|
+            s << l10n(@i18n.admitted)
+          end
+        end
+      end
+
       def example_parse(node, out)
         name = node.at(ns("./name"))
-        example_name_parse(node, out, name) #if name
+        example_name_parse(node, out, name) # if name
         super
       end
 
-      def example_label(node, div, name)
-      end
+      def example_label(node, div, name); end
 
-      def example_name_parse(node, div, name)
+      def example_name_parse(_node, div, name)
         div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
           name&.children&.each { |n| parse(n, p) }
         end
@@ -56,6 +91,7 @@ module IsoDoc
 
       def is_clause?(name)
         return true if name == "submitters"
+
         super
       end
 
@@ -84,8 +120,8 @@ module IsoDoc
       def make_tr_attr(td, row, totalrows, header)
         ret = super
         if td.at("./ancestor::xmlns:table[@class = 'recommendation'] | "\
-            "./ancestor::xmlns:table[@class = 'requirement'] | "\
-            "./ancestor::xmlns:table[@class = 'permission']")
+                 "./ancestor::xmlns:table[@class = 'requirement'] | "\
+                 "./ancestor::xmlns:table[@class = 'permission']")
           ret[:style] = "vertical-align:top;"
           ret[:class] = "recommend"
         end
@@ -94,6 +130,7 @@ module IsoDoc
 
       def para_class(node)
         return node["class"] if node["class"]
+
         super
       end
     end

data/lib/isodoc/ogc/biblio.rb

@@ -1,31 +1,31 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def std_bibitem_entry(list, b, ordinal, biblio)
-        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+      def std_bibitem_entry(list, bib, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
           prefix_bracketed_ref(ref, "[#{ordinal}]") if biblio
-          standard_citation(ref, b)
+          standard_citation(ref, bib)
         end
       end
 
-      def nonstd_bibitem(list, b, ordinal, bibliography)
-        list.p **attr_code(iso_bibitem_entry_attrs(b, bibliography)) do |r|
-          id = bibitem_ref_code(b)
+      def nonstd_bibitem(list, bib, ordinal, bibliography)
+        list.p **attr_code(iso_bibitem_entry_attrs(bib, bibliography)) do |r|
+          id = bibitem_ref_code(bib)
           identifier = render_identifier(id)
           identifier[1] = nil
           if bibliography
             ref_entry_code(r, ordinal, identifier, id)
           end
-          reference_format(b, r)
+          reference_format(bib, r)
         end
       end
 
-      def reference_format(b, r)
-        if ftitle = b.at(ns("./formattedref"))
-          ftitle&.children&.each { |n| parse(n, r) }
+      def reference_format(bib, ref)
+        if ftitle = bib.at(ns("./formattedref"))
+          ftitle&.children&.each { |n| parse(n, ref) }
         else
           # eventually will be full LNCS reference
-          standard_citation(r, b)
+          standard_citation(ref, bib)
         end
       end
 
@@ -34,97 +34,101 @@ module IsoDoc
       end
 
       def multiplenames_and(names)
-        return "" if names.length == 0
+        return "" if names.empty?
         return names[0] if names.length == 1
         return "#{names[0]} and #{names[1]}" if names.length == 2
+
         names[0..-2].join(", ") + " and #{names[-1]}"
       end
 
-      def nodes_to_span(n)
+      def nodes_to_span(node)
         noko do |xml|
           xml.span do |s|
-            n&.children&.each { |x| parse(x, s) }
+            node&.children&.each { |x| parse(x, s) }
           end
-        end.join("")
+        end.join
       end
 
-      def extract_publisher(b)
-        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
+      def extract_publisher(bib)
         abbrs = []
         names = []
-        c&.each do |c1|
+        bib.xpath(ns("./contributor[role/@type = 'publisher']"\
+                     "[organization]"))&.each do |c1|
           n = c1.at(ns("./organization/name")) or next
           abbrs << (c1.at(ns("./organization/abbreviation")) || n)
           names << nodes_to_span(n)
         end
         return [nil, nil] if names.empty?
-        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
+
+        [multiplenames_and(names), abbrs.map(&:text).join("/")]
       end
 
-      def extract_author(b)
-        c = b.xpath(ns("./contributor[role/@type = 'author']"))
-        c = b.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
+      def extract_author(bib)
+        c = bib.xpath(ns("./contributor[role/@type = 'author']"))
+        c = bib.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
         return nil if c.empty?
+
         c.map do |c1|
           c1&.at(ns("./organization/name"))&.text || extract_person_name(c1)
         end.reject { |e| e.nil? || e.empty? }.join(", ")
       end
 
-      def extract_person_name(b)
-        p = b.at(ns("./person/name")) or return
+      def extract_person_name(bib)
+        p = bib.at(ns("./person/name")) or return
         c = p.at(ns("./completename")) and return c.text
         s = p&.at(ns("./surname"))&.text or return
         i = p.xpath(ns("./initial")) and
-          front = i.map { |e| e.text.gsub(/[^[:upper:]]/, "") }.join("")
+          front = i.map { |e| e.text.gsub(/[^[:upper:]]/, "") }.join
         i.empty? and f = p.xpath(ns("./forename")) and
-          front = f.map { |e| e.text[0].upcase }.join("")
+          front = f.map { |e| e.text[0].upcase }.join
         front ? "#{s} #{front}" : s
       end
 
-
       def date_render(date)
         return nil if date.nil?
+
         on = date&.at(ns("./on"))&.text
         from = date&.at(ns("./from"))&.text
         to = date&.at(ns("./to"))&.text
         return on if on && !on.empty?
         return "#{from}&ndash;#{to}" if from && !from.empty?
+
         nil
       end
 
-      def extract_year(b)
-        d = b.at(ns("./date[@type = 'published']")) ||
-          b.at(ns("./date[@type = 'issued']")) ||
-          b.at(ns("./date[@type = 'circulated']")) ||
-          b.at(ns("./date"))
+      def extract_year(bib)
+        d = bib.at(ns("./date[@type = 'published']")) ||
+          bib.at(ns("./date[@type = 'issued']")) ||
+          bib.at(ns("./date[@type = 'circulated']")) ||
+          bib.at(ns("./date"))
         date_render(d)
       end
 
-      def extract_city(b)
-        b.at(ns("./place"))
+      def extract_city(bib)
+        bib.at(ns("./place"))
       end
 
-      def extract_uri(b)
-        b.at(ns("./uri"))
+      def extract_uri(bib)
+        bib.at(ns("./uri"))
       end
 
       # {author}: {document identifier}, {title}. {publisher}, {city} ({year})
-      def standard_citation(out, b)
-        if ftitle = b.at(ns("./formattedref"))
+      def standard_citation(out, bib)
+        if ftitle = bib.at(ns("./formattedref"))
           ftitle&.children&.each { |n| parse(n, out) }
         else
-          pub, pub_abbrev = extract_publisher(b)
-          author = extract_author(b)
-          c = extract_city(b)
-          y = extract_year(b)
-          u = extract_uri(b)
+          pub, pub_abbrev = extract_publisher(bib)
+          author = extract_author(bib)
+          c = extract_city(bib)
+          y = extract_year(bib)
+          u = extract_uri(bib)
           out << "#{author || pub_abbrev}: " if author || pub_abbrev
-          id = render_identifier(inline_bibitem_ref_code(b))
+          id = render_identifier(inline_bibitem_ref_code(bib))
           out << id[1] if id[1]
-          out << " (Draft)" if ogc_draft_ref?(b)
+          out << " (Draft)" if ogc_draft_ref?(bib)
           out << ", "
           out.i do |i|
-            iso_title(b)&.children&.each { |n| parse(n, i) }
+            iso_title(bib)&.children&.each { |n| parse(n, i) }
           end
           out << ". "
           out << pub if pub
@@ -136,12 +140,14 @@ module IsoDoc
         end
       end
 
-      def inline_bibitem_ref_code(b)
-        id = b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                     "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
-        id ||= b.at(ns("./docidentifier[not(@type = 'metanorma')]"))
+      def inline_bibitem_ref_code(bib)
+        id = bib.at(ns("./docidentifier[not(@type = 'DOI' "\
+                       "or @type = 'metanorma' or @type = 'ISSN' "\
+                       "or @type = 'ISBN' or @type = 'rfc-anchor')]"))
+        id ||= bib.at(ns("./docidentifier[not(@type = 'metanorma')]"))
         return [nil, id, nil] if id
-        id = Nokogiri::XML::Node.new("docidentifier", b.document)
+
+        id = Nokogiri::XML::Node.new("docidentifier", bib.document)
         id << "(NO ID)"
         [nil, id, nil]
       end