metanorma-ogc 1.5.4 → 2.0.1

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -189,22 +189,33 @@ module IsoDoc
       end
 
       def bibdata_i18n(bib)
-        stage = bib&.at(ns("./status/stage"))
         doctype = bib&.at(ns("./ext/doctype"))
+        rename_stage(bib&.at(ns("./status/stage")), doctype, bib)
+        rename_doctype(doctype, bib&.at(ns("./date[@type = 'published']")) ||
+                       bib&.at(ns("./date[@type = 'issued']")))
+        super
+      end
+
+      def rename_stage(stage, doctype, _bib)
         if stage&.text == "approved" &&
             !%w(standard abstract-specification-topic
                 community-standard).include?(doctype&.text)
           stage.children = "published"
         end
-        super
       end
 
-      def ol(docxml)
-        docxml.xpath(ns("//ol")).each do |f|
-          ol1(f)
+      def rename_doctype(doctype, date)
+        return unless doctype&.text == "white-paper" && date
+
+        if Date.iso8601(date.text) >= Date.iso8601("2021-12-16")
+          doctype.children = "technical-paper"
         end
       end
 
+      def ol(docxml)
+        docxml.xpath(ns("//ol")).each { |f| ol1(f) }
+      end
+
       def ol1(elem)
         return unless elem["class"] == "steps"
 
@@ -214,11 +225,16 @@ module IsoDoc
       end
 
       def termsource1(elem)
-        mod = elem.at(ns("./modification")) and
-          termsource_modification(mod)
+        while elem&.next_element&.name == "termsource"
+          elem << "; #{elem.next_element.remove.children.to_xml}"
+        end
         elem.children = l10n("[<strong>#{@i18n.source}:</strong> "\
                              "#{elem.children.to_xml.strip}]")
-        elem&.next_element&.name == "termsource" and elem.next = "; "
+      end
+
+      def bibliography_bibitem_number_skip(bibitem)
+        @xrefs.klass.implicit_reference(bibitem) ||
+          bibitem.at(ns(".//docidentifier[@type = 'metanorma-ordinal']"))
       end
 
       include Init

data/lib/isodoc/ogc/reqt.rb

@@ -33,9 +33,8 @@ module IsoDoc
 
       def recommendation_name(node, out)
         b = out.add_child("<p class='#{recommendation_class(node)}'></p>").first
-        if name = node&.at(ns("./name"))&.remove
+        name = node&.at(ns("./name"))&.remove and
           name.children.each { |n| b << n }
-        end
         if title = node&.at(ns("./title"))&.remove
           b << l10n(": ") if name
           title.children.each { |n| b << n }
@@ -64,6 +63,9 @@ module IsoDoc
         oblig = node["obligation"] and out << ["Obligation", oblig]
         subj = node&.at(ns("./subject"))&.remove&.children and
           out << [rec_subj(node), subj]
+        %w(general class).include?(node["type_original"]) and
+          test = @reqt_links[node["id"]] and
+          out << ["Conformance test", "<xref target='#{test}'/>"]
         node.xpath(ns("./inherit")).each do |i|
           out << ["Dependency", i.remove.children]
         end
@@ -75,7 +77,8 @@ module IsoDoc
         return node unless node.at(ns("./component[@class = 'step']"))
 
         d = node.at(ns("./component[@class = 'step']"))
-        d = d.replace("<ol class='steps'><li>#{d.children.to_xml}</li></ol>").first
+        d = d.replace("<ol class='steps'><li>#{d.children.to_xml}</li></ol>")
+          .first
         node.xpath(ns("./component[@class = 'step']")).each do |f|
           f = f.replace("<li>#{f.children.to_xml}</li>").first
           d << f
@@ -177,6 +180,7 @@ module IsoDoc
       end
 
       def recommendation_to_table(docxml)
+        @reqt_links = reqt_links(docxml)
         docxml.xpath(ns("//recommendation")).each do |r|
           recommendation_parse1(r, "recommendation")
         end
@@ -189,6 +193,16 @@ module IsoDoc
         requirement_table_cleanup(docxml)
       end
 
+      def reqt_links(docxml)
+        docxml.xpath(ns("//requirement | //recommendation | //permission"))
+          .each_with_object({}) do |r, m|
+            next unless %w(conformanceclass verification).include?(r["type"])
+            next unless subject = r&.at(ns("./subject/xref/@target"))&.text
+
+            m[subject] = r["id"]
+          end
+      end
+
       # table nested in table: merge label and caption into a single row
       def requirement_table_cleanup1(outer, inner)
         outer.delete("colspan")

data/lib/{asciidoctor → metanorma}/ogc/cleanup.rb

@@ -1,4 +1,4 @@
-module Asciidoctor
+module Metanorma
   module Ogc
     class Converter < Standoc::Converter
       def sections_cleanup(xml)
@@ -58,6 +58,9 @@ module Asciidoctor
         super
         a = xmldoc.at("//bibdata/status/stage")
         a.text == "published" and a.children = "approved"
+        doctype = xmldoc.at("//bibdata/ext/doctype")
+        doctype.text == "technical-paper" and
+          doctype.children = "white-paper"
       end
 
       def section_names_terms_cleanup(xml)
@@ -171,17 +174,58 @@ module Asciidoctor
         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
+          requirement_type1(r)
         end
       end
+
+      def requirement_type1(reqt)
+        reqt["type"] = case reqt["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 reqt["type"]
+                       end
+      end
+
+      def normref_cleanup(xmldoc)
+        r1 = xmldoc.at("//references[title[translate(text(), 'R', 'r') = "\
+                       "'Normative references']]")
+        r2 = xmldoc.at("//references[title[text() = 'References']]")
+        if r1 && r2
+          r2["normative"] = false
+        end
+        super
+      end
+
+      def obligations_cleanup_inherit(xml)
+        xml.xpath("//annex").each do |r|
+          r["obligation"] = "informative" unless r["obligation"]
+        end
+        xml.xpath("//clause[not(ancestor::boilerplate)]").each do |r|
+          r["obligation"] = "normative" unless r["obligation"]
+        end
+        xml.xpath(::Metanorma::Standoc::Utils::SUBCLAUSE_XPATH).each do |r|
+          o = r&.at("./ancestor::*/@obligation")&.text and r["obligation"] = o
+        end
+      end
+
+      def sections_order_cleanup(xml)
+        super
+        sort_annexes(xml)
+      end
+
+      def sort_annexes(xml)
+        last = xml.at("//annex[last()]") or return
+        last.next = "<sentinel/>" and last = last.next_element
+        gl = xml.at("//annex[.//term]") and last.previous = gl.remove
+        rev = xml.at("//annex[title[normalize-space(.) = 'Revision history']]") ||
+          xml.at("//annex[title[normalize-space(.) = 'Revision History']]") and
+          last.previous = rev.remove
+        last.remove
+      end
     end
   end
 end

data/lib/{asciidoctor → metanorma}/ogc/converter.rb

@@ -1,11 +1,11 @@
 require "asciidoctor"
-require "asciidoctor/standoc/converter"
+require "metanorma/standoc/converter"
 require "fileutils"
 require_relative "front"
 require_relative "validate"
 require_relative "cleanup"
 
-module Asciidoctor
+module Metanorma
   module Ogc
     # A {Converter} implementation that generates RSD output, and a document
     # schema encapsulation of the document for validation
@@ -31,7 +31,7 @@ module Asciidoctor
                   change-request-supporting-document community-practice
                   community-standard discussion-paper engineering-report
                   reference-model release-notes standard user-guide white-paper
-                  test-suite}.include? d
+                  technical-paper test-suite}.include? d
           @warned_doctype or
             @log.add("Document Attributes", nil,
                      "'#{d}' is not a legal document type: reverting to 'standard'")
@@ -134,6 +134,16 @@ module Asciidoctor
         super
       end
 
+      def set_obligation(attrs, node)
+        if node.attr("style") == "appendix" && node.level == 1
+          attrs[:obligation] = if node.attributes.has_key?("obligation")
+                                 node.attr("obligation")
+                               else "informative"
+                               end
+        else super
+        end
+      end
+
       def presentation_xml_converter(node)
         IsoDoc::Ogc::PresentationXMLConvert.new(html_extract_attributes(node))
       end

data/lib/{asciidoctor → metanorma}/ogc/front.rb

@@ -1,8 +1,8 @@
 require "asciidoctor"
-require "asciidoctor/standoc/converter"
+require "metanorma/standoc/converter"
 require "fileutils"
 
-module Asciidoctor
+module Metanorma
   module Ogc
     class Converter < Standoc::Converter
       def metadata_author(node, xml)

data/lib/{asciidoctor → metanorma}/ogc/isodoc.rng

@@ -32,6 +32,19 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="bibitem">
+      <element name="bibitem">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="hidden">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="BibliographicItem"/>
+      </element>
+    </define>
     <define name="section-title">
       <element name="title">
         <zeroOrMore>
@@ -690,6 +703,7 @@
             <ref name="terms"/>
             <ref name="term-clause"/>
             <ref name="definitions"/>
+            <ref name="floating-title"/>
           </choice>
         </oneOrMore>
       </element>
@@ -1680,6 +1694,7 @@
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
+          <ref name="floating-title"/>
         </choice>
       </oneOrMore>
     </choice>
@@ -1722,6 +1737,7 @@
           <ref name="terms"/>
           <ref name="definitions"/>
           <ref name="references"/>
+          <ref name="floating-title"/>
         </choice>
       </zeroOrMore>
     </group>
@@ -1973,7 +1989,11 @@
       </optional>
       <element name="name">
         <zeroOrMore>
-          <ref name="PureTextElement"/>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
         </zeroOrMore>
       </element>
       <optional>
@@ -1987,7 +2007,7 @@
         </element>
       </optional>
       <optional>
-        <element name="grammar-info">
+        <element name="grammar">
           <ref name="Grammar"/>
         </element>
       </optional>
@@ -2530,4 +2550,17 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="floating-title">
+    <element name="floating-title">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="depth">
+        <data type="int"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/{asciidoctor → metanorma}/ogc/validate.rb

@@ -1,4 +1,4 @@
-module Asciidoctor
+module Metanorma
   module Ogc
     class Converter < Standoc::Converter
       def validate(doc)
@@ -14,6 +14,44 @@ module Asciidoctor
       def content_validate(doc)
         super
         bibdata_validate(doc.root)
+        reqt_link_validate(doc.root)
+      end
+
+      def reqt_link_validate(docxml)
+        ids = reqt_links(docxml)
+        reqt_to_conformance(ids, "general", "verification", "Requirement",
+                            "Conformance test")
+        reqt_to_conformance(ids, "class", "conformanceclass",
+                            "Requirement class", "Conformance class test")
+        conformance_to_reqt(ids, "general", "verification", "Requirement",
+                            "Conformance test")
+        conformance_to_reqt(ids, "class", "conformanceclass",
+                            "Requirement class", "Conformance class test")
+      end
+
+      def reqt_to_conformance(ids, reqtclass, confclass, reqtlabel, conflabel)
+        ids[reqtclass]&.each do |r|
+          ids[confclass]&.any? { |x| x[:subject] == r[:id] } or
+            @log.add("Requirements", r[:elem],
+                     "#{reqtlabel} #{r[:id]} has no corresponding #{conflabel}")
+        end
+      end
+
+      def conformance_to_reqt(ids, reqtclass, confclass, reqtlabel, conflabel)
+        ids[confclass]&.each do |x|
+          ids[reqtclass]&.any? { |r| x[:subject] == r[:id] } or
+            @log.add("Requirements", x[:elem],
+                     "#{conflabel} #{x[:id]} has no corresponding #{reqtlabel}")
+        end
+      end
+
+      def reqt_links(docxml)
+        docxml.xpath("//requirement | //recommendation | //permission")
+          .each_with_object({}) do |r, m|
+            m[r["type"]] ||= []
+            m[r["type"]] << { id: r["id"], elem: r,
+                              subject: r&.at("./subject/xref/@target")&.text }
+          end
       end
 
       def bibdata_validate(doc)

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "1.5.4".freeze
+    VERSION = "2.0.1".freeze
   end
 end

data/lib/metanorma/ogc.rb

@@ -1,5 +1,6 @@
 require "metanorma/ogc/version"
 require "metanorma/ogc/processor"
+require "metanorma/ogc/converter"
 
 module Metanorma
   module Ogc

data/lib/metanorma-ogc.rb

@@ -1,6 +1,5 @@
 require "metanorma/ogc"
 require "asciidoctor"
-require "asciidoctor/ogc"
 require "isodoc/ogc"
 
 if defined? Metanorma

data/metanorma-ogc.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "iso-639"
-  spec.add_dependency "metanorma-standoc", "~> 1.11.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 2.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -199,17 +199,6 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
-- lib/asciidoctor/ogc.rb
-- lib/asciidoctor/ogc/basicdoc.rng
-- lib/asciidoctor/ogc/biblio.rng
-- lib/asciidoctor/ogc/boilerplate.xml
-- lib/asciidoctor/ogc/cleanup.rb
-- lib/asciidoctor/ogc/converter.rb
-- lib/asciidoctor/ogc/front.rb
-- lib/asciidoctor/ogc/isodoc.rng
-- lib/asciidoctor/ogc/ogc.rng
-- lib/asciidoctor/ogc/reqt.rng
-- lib/asciidoctor/ogc/validate.rb
 - lib/isodoc/ogc.rb
 - lib/isodoc/ogc/base_convert.rb
 - lib/isodoc/ogc/biblio.rb
@@ -264,7 +253,17 @@ files:
 - lib/isodoc/ogc/xref.rb
 - lib/metanorma-ogc.rb
 - lib/metanorma/ogc.rb
+- lib/metanorma/ogc/basicdoc.rng
+- lib/metanorma/ogc/biblio.rng
+- lib/metanorma/ogc/boilerplate.xml
+- lib/metanorma/ogc/cleanup.rb
+- lib/metanorma/ogc/converter.rb
+- lib/metanorma/ogc/front.rb
+- lib/metanorma/ogc/isodoc.rng
+- lib/metanorma/ogc/ogc.rng
 - lib/metanorma/ogc/processor.rb
+- lib/metanorma/ogc/reqt.rng
+- lib/metanorma/ogc/validate.rb
 - lib/metanorma/ogc/version.rb
 - metanorma-ogc.gemspec
 homepage: https://github.com/metanorma/metanorma-ogc

data/lib/asciidoctor/ogc.rb

@@ -1,6 +0,0 @@
-require "asciidoctor/ogc/converter"
-
-module Asciidoctor
-  module Ogc
-  end
-end