metanorma-ogc 1.1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2421990413977914ea161a6565552ab89b79410f8565c55c2e075a47d67c23e
-  data.tar.gz: 84d00c4e381efc9fe62e9b1d9d66950f63133b92e559d7297282afdd4af20ab3
+  metadata.gz: c2015d66f65b872e8bd41ffbc65c7a9ebb50228937f7efb5ee32a5e254f41ff2
+  data.tar.gz: ca391594fc897a87f4c20c64776660737d6f702eb2a7a58d1125fbb49a7078be
 SHA512:
-  metadata.gz: cf9c21efa5e92165362d868acb0dd12db79c99ec47251e49807234641ff06d71161525d06620a9c941471a9fad6ec8ff1133e629de6a88c2382bc8def66235c1
-  data.tar.gz: a25fe7ef0b9a0db87259fd02683499906a8736e8b97f87973a6173ec25ab201cfb20e44099964a22c1e09d5797f8260b5d2d1e3f8bf7d5e90f253048cccc22a9
+  metadata.gz: f8b982136f75e99af1b8f834714aa420f050ba75b85a473cc1175b8f393abcffbd1fc23991e3d13f5888875b1e81e75c2b7bc630e979591eb042562d3540d0c3
+  data.tar.gz: 447069d2e3be876e342c3730de38e1e564e42b672e701cdbadbafc331a1cc0bc2ac76fea1c89402f118afcd86eb8e81d7bb0a1657b88822fe515c0f32969ceb8

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/asciidoctor/ogc/boilerplate.xml

@@ -3,16 +3,16 @@
     <clause>
       <title>Copyright notice</title>
 
-      <p>Copyright
+      <p align="center">Copyright
         © {{ docyear }} Open Geospatial Consortium<br/>
         To obtain additional rights of use, visit 
         <link target="http://www.opengeospatial.org/legal/">http://www.opengeospatial.org/legal/</link></p>
     </clause>
     <clause>
       <title>Note</title>
-      <p>Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.</p>
+      <p align="left">Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.</p>
 
-      <p>Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.</p>
+      <p align="left">Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.</p>
     </clause>
   </copyright-statement>
   <license-statement>

data/lib/asciidoctor/ogc/converter.rb

@@ -25,7 +25,7 @@ module Asciidoctor
       end
 
       def doctype(node)
-        d = node.attr("doctype")
+        d = super
         d1 = ::IsoDoc::Ogc::DOCTYPE_ABBR.invert[d] and d = d1
         unless %w{abstract-specification-topic best-practice 
           change-request-supporting-document community-practice 
@@ -55,9 +55,12 @@ module Asciidoctor
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+        html_converter(node).convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert(@filename + ".presentation.xml", 
+                                    nil, false, "#{@filename}.doc")
+        pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.pdf")
       end
 
       def validate(doc)
@@ -84,15 +87,16 @@ module Asciidoctor
       end
 
       def clause_parse(attrs, xml, node)
-        clausetype = node&.attr("heading")&.downcase || node.title.downcase
-        if clausetype == "submitters" then submitters_parse(attrs, xml, node)
-        else
-          super
+        case clausetype = node&.attr("heading")&.downcase || node.title.downcase
+        when "submitters" then return submitters_parse(attrs, xml, node)
+        when "conformance" then attrs = attrs.merge(type: "conformance")
         end
+        super
       end
 
       def submitters_parse(attrs, xml, node)
         xml.submitters **attr_code(attrs) do |xml_section|
+          xml_section.title @i18n.submitters
           xml_section << node.content
         end
       end

data/lib/asciidoctor/ogc/front.rb

@@ -12,8 +12,8 @@ module Asciidoctor
 
       def corporate_author(node, xml)
         return unless node.attr("submitting-organizations")
-        HTMLEntities.new.decode(node.attr("submitting-organizations")).
-          split(/;[ ]*/).each do |org|
+        csv_split(HTMLEntities.new.decode(node.attr("submitting-organizations")),
+                  ";")&.each do |org|
           xml.contributor do |c|
             c.role **{ type: "author" }
             c.organization do |a|
@@ -63,13 +63,8 @@ module Asciidoctor
         end
       end
 
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name Metanorma::Ogc::ORGANIZATION_NAME_SHORT
-          end
-        end
+      def default_publisher
+        "Open Geospatial Consortium"
       end
 
       def metadata_committee(node, xml)
@@ -109,7 +104,7 @@ module Asciidoctor
       end
 
       def externalurl(node)
-        if node.attr("doctype") == "engineering-report"
+        if doctype(node) == "engineering-report"
           "http://www.opengis.net/doc/PER/t14-#{node.attr('referenceurlid')}"
         else
           node.attr('referenceurlid')
@@ -123,16 +118,9 @@ module Asciidoctor
       end
 
       def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || node.attr("copyrightyear") ||
-          Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name Metanorma::Ogc::ORGANIZATION_NAME_SHORT
-            end
-          end
-        end
+        node.attr("copyrightyear") and
+          node.set_attr("copyright-year", node.attr("copyrightyear"))
+        super
       end
 
       def metadata_date(node, xml)

data/lib/asciidoctor/ogc/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -922,6 +925,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +967,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +995,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1017,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1045,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1186,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/ogc/validate.rb

@@ -49,35 +49,25 @@ module Asciidoctor
         [
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: [{ tag: "clause", title: "Scope" }],
+            val: ["./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Scope must be followed by Conformance",
-            val: [{ tag: "clause", title: "Conformance" }],
+            val: ["./self::clause[@type = 'conformance']" ]
           },
           {
             msg: "Normative References must be followed by "\
             "Terms and Definitions",
-            val: [
-              { tag: "terms", title: "Terms and definitions" },
-              { tag: "clause", title: "Terms and definitions" },
-              {
-                tag: "terms",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-              {
-                tag: "clause",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-            ],
+            val: ["./self::terms | .//terms"]
           },
       ].freeze
 
       def seqcheck(names, msg, accepted)
         n = names.shift
-        unless accepted.include? n
+        return [] if n.nil?
+        test = accepted.map { |a| n.at(a) }
+        if test.all? { |a| a.nil? }
           @log.add("Style", nil, msg)
-          names = []
         end
         names
       end
@@ -85,23 +75,21 @@ module Asciidoctor
       def sections_sequence_validate(root)
         return unless STANDARDTYPE.include?(
           root&.at("//bibdata/ext/doctype")&.text)
-        f = root.at("//sections").elements
-        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
-        names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        names = root.xpath("//sections/* | //bibliography/*")
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
+        names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val])
         n = names.shift
-        if !n.nil? && n[:tag] == "definitions"
+        if n&.at("./self::definitions")
           n = names.shift
         end
-        unless n
+        if n.nil? || n.name != "clause"
           @log.add("Style", nil, "Document must contain at least one clause")
           return
         end
         root.at("//references | //clause[descendant::references]"\
                 "[not(parent::clause)]") or
-        seqcheck([{tag: "clause"}],
-                 "Normative References are mandatory", [{tag: "references"}])
+        @log.add("Style", nil, "Normative References are mandatory")
       end
 
       def preface_sequence_validate(root)

data/lib/isodoc/ogc/base_convert.rb

@@ -1,6 +1,4 @@
 require "isodoc"
-require_relative "metadata"
-require_relative "reqt"
 require_relative "biblio"
 require_relative "sections"
 require "fileutils"
@@ -8,44 +6,12 @@ require "fileutils"
 module IsoDoc
   module Ogc
     module BaseConvert
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
-      def xref_init(lang, script, klass, labels, options)
-        @xrefs = Xref.new(lang, script, klass, labels, options)
-      end
-
-      def fileloc(loc)
-        File.join(File.dirname(__FILE__), loc)
-      end
-
       def cleanup(docxml)
-        requirement_table_cleanup(docxml)
+        #requirement_table_cleanup(docxml)
         super
         term_cleanup(docxml)
       end
 
-      # table nested in table: merge label and caption into a single row
-      def requirement_table_cleanup(docxml)
-        docxml.xpath("//table[@class = 'recommendclass']//table").each do |t|
-          x = t.at("./thead") and x.replace(x.children)
-          x = t.at("./tbody") and x.replace(x.children)
-          x = t.at("./tfoot") and x.replace(x.children)
-          if x = t.at("./tr/th[@colspan = '2']") and
-              y = t.at("./tr/td[@colspan = '2']")
-            x["colspan"] = "1"
-            y["colspan"] = "1"
-            x.name = "td"
-            p = x.at("./p[@class = 'RecommendationTitle']") and
-              p.delete("class")
-            x << y.dup
-            y.parent.remove
-          end
-          t.replace(t.children)
-        end
-      end
-
       def term_cleanup(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
           h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
@@ -55,14 +21,6 @@ module IsoDoc
         docxml
       end
 
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            else
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            end
-        super.merge(y)
-      end
-
       def example_parse(node, out)
         name = node.at(ns("./name"))
         example_name_parse(node, out, name) #if name
@@ -73,17 +31,19 @@ module IsoDoc
       end
 
       def example_name_parse(node, div, name)
-        lbl = @xrefs.anchor(node['id'], :label, false)
         div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
-          lbl.nil? or p << l10n("#{@example_lbl} #{lbl}")
-          name and !lbl.nil? and p << "&nbsp;&mdash; "
           name&.children&.each { |n| parse(n, p) }
         end
       end
 
       def middle_clause
-        "//clause[parent::sections][not(xmlns:title = 'Scope' or "\
-        "xmlns:title = 'Conformance')][not(descendant::terms)]"
+        "//clause[parent::sections][not(@type = 'scope' or "\
+        "@type = 'conformance')][not(descendant::terms)]"
+      end
+
+      def is_clause?(name)
+        return true if name == "submitters"
+        super
       end
 
       def middle(isoxml, out)
@@ -98,6 +58,31 @@ module IsoDoc
         annex isoxml, out
         bibliography isoxml, out
       end
+
+      def table_attrs(node)
+        ret = super
+        %w(recommendation requirement permission).include?(node["class"]) and
+          ret = ret.merge(class: node["type"], style:
+                          "border-collapse:collapse;border-spacing:0;"\
+                          "#{keep_style(node)}")
+        ret
+      end
+
+      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']")
+          ret[:style] = "vertical-align:top;"
+          ret[:class] = "recommend"
+        end
+        ret
+      end
+
+      def para_class(node)
+        return node["class"] if node["class"]
+        super
+      end
     end
   end
 end

data/lib/isodoc/ogc/biblio.rb

@@ -60,13 +60,34 @@ module IsoDoc
         return [multiplenames_and(names), (abbrs.map { |x| x.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?
+        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
+        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("")
+        i.empty? and f = p.xpath(ns("./forename")) and
+          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
-        return "#{from}–#{to}" if from
+        return on if on && !on.empty?
+        return "#{from}–#{to}" if from && !from.empty?
         nil
       end
 
@@ -82,17 +103,24 @@ module IsoDoc
         b.at(ns("./place"))
       end
 
+      def extract_uri(b)
+        b.at(ns("./uri"))
+      end
+
       # {author}: {document identifier}, {title}. {publisher}, {city} ({year})
       def standard_citation(out, b)
         if ftitle = b.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)
-          out << "#{pub_abbrev}: " if pub_abbrev
+          u = extract_uri(b)
+          out << "#{author || pub_abbrev}: " if author || pub_abbrev
           id = render_identifier(inline_bibitem_ref_code(b))
           out << id[1] if id[1]
+          out << " (Draft)" if ogc_draft_ref?(b)
           out << ", "
           out.i do |i|
             iso_title(b)&.children&.each { |n| parse(n, i) }
@@ -102,7 +130,8 @@ module IsoDoc
           out << ", " if pub && c
           c&.children&.each { |n| parse(n, out) }
           out << " " if (pub || c) && y
-          out << "(#{y})." if y
+          out << "(#{y}). " if y
+          u and out << "<a href='#{u.text}'>#{u.text}</a>"
         end
       end