metanorma-cc 1.4.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ccd3c862d1d967d0782115e2319f5d9c41a1346a06b85fa1cbd25626101b939
-  data.tar.gz: 10076bc4151a870b5f219461fa29ffd062bfe6888800daf923ecf4475b1c887a
+  metadata.gz: 7e7ea8aa4a98c9025bee7fe799d5fceef2e3509ecc5418805f66feae05184edd
+  data.tar.gz: 9d4d96365f854898f09da7b73593991aa8c0a8b8b4c6dad051fc94b9b05a6873
 SHA512:
-  metadata.gz: 27ebb897618ae5d5bc58ea3e0e9831435268f509c6dc0cc3920c17e6f66c84b79decb38f57d27b70ef4835fd7c5715224cd488c2d200391e6dd365f417191b31
-  data.tar.gz: 0c4646dd8aaaf21ff10b0f7becf143973566c801dec65bb6b5fa3b8d0f04e6a8a836f7e74ce6116e0467e93abad9ac7a4b2e753310ee96858d44d2a9c449febd
+  metadata.gz: 8c473d1ed5976283580bf9f5569aff23d1f545d9f5ea4b093ef990fe94db6cf7900e13e1060cbcf30d00c7fd7241060ccc212d9e3e027589003d562efe7fe23f
+  data.tar.gz: 9643f9dbbafe84104aaaa774bbc21bd708a39c9509526da74851978b7447a87ed414433bf77d35f0446336b04ccc0bfe18b94c8158a49dd5fb43929ce0039f8d

data/lib/asciidoctor/cc/basicdoc.rng

@@ -158,7 +158,17 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <ref name="paragraph"/>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="table"/>
+          <ref name="figure"/>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -402,6 +412,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +449,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>

data/lib/asciidoctor/cc/converter.rb

@@ -27,9 +27,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)

data/lib/asciidoctor/cc/front.rb

@@ -4,26 +4,9 @@ require "fileutils"
 
 module Asciidoctor
   module CC
-
     class Converter < Standoc::Converter
-
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
-        personal_author(node, xml)
-      end
-
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
+      def default_publisher
+        "CalConnect"
       end
 
       def metadata_committee(node, xml)
@@ -50,7 +33,7 @@ module Asciidoctor
 
       def prefix_id(node)
         prefix = "CC"
-        typesuffix = ::Metanorma::CC::DOCSUFFIX[node.attr("doctype")] || ""
+        typesuffix = ::Metanorma::CC::DOCSUFFIX[doctype(node)] || ""
         prefix += "/#{typesuffix}" unless typesuffix.empty?
         status = ::Metanorma::CC::DOCSTATUS[node.attr("status")] || ""
         prefix += "/#{status}" unless status.empty?
@@ -67,27 +50,18 @@ module Asciidoctor
         xml.docnumber node.attr("docnumber")
       end
 
+      @log_doctype = false
+
       def doctype(node)
-        d = node.attr("doctype")
-        unless ::Metanorma::CC::DOCSUFFIX.keys.include?(d)
+        d = super
+        unless ::Metanorma::CC::DOCSUFFIX.keys.include?(d) && !@log_doctype
           @log.add("Document Attributes", nil,
                    "#{d} is not a legal document type: reverting to 'standard'")
+          @log_doctype = true
           d = "standard"
         end
         d
       end
-
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "CalConnect"
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/asciidoctor/cc/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">
@@ -578,6 +581,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +666,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +712,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -922,6 +947,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +989,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1017,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1039,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1067,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1211,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1501,4 +1535,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/cc/validate_section.rb

@@ -30,9 +30,10 @@ module Asciidoctor
 
       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
@@ -43,32 +44,20 @@ module Asciidoctor
         [
           {
             msg: "Initial section must be (content) Foreword",
-            val:  [{ tag: "foreword", title: "Foreword" }],
+            val:  ["./self::foreword"]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val:  [{ tag: "introduction", title: "Introduction" },
-                   { tag: "clause", title: "Scope" }],
+            val:  ["./self::introduction", "./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: [{ tag: "clause", title: "Scope" }],
+            val: ["./self::clause[@type = 'scope']" ]
           },
           {
             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
 
@@ -78,50 +67,47 @@ module Asciidoctor
         "//clause[descendant::references][not(parent::clause)]".freeze
 
       def sections_sequence_validate(root)
-        f = root.xpath(SECTIONS_XPATH)
-        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
+        names = root.xpath(SECTIONS_XPATH)
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) 
         n = names[0]
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
-        if n == { tag: "introduction", title: "Introduction" }
-          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
+        if n&.at("./self::introduction")
+          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) 
         end
-        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) || return
+        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) 
         n = names.shift
-        if n == { tag: "definitions", title: nil }
-          n = names.shift || return
+        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
-        n[:tag] == "clause" ||
+        n&.at("./self::clause") ||
           @log.add("Style", nil, "Document must contain clause after "\
                "Terms and Definitions")
-        n == { tag: "clause", title: "Scope" } &&
+        n&.at("./self::clause[@type = 'scope']") &&
           @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-        n = names.shift || return
-        while n[:tag] == "clause"
-          n[:title] == "Scope" &&
+        n = names.shift 
+        while n&.name == "clause"
+          n&.at("./self::clause[@type = 'scope']")
             @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-          n = names.shift || return
+          n = names.shift 
         end
-        unless n[:tag] == "annex" || n[:tag] == "references"
+         unless %w(annex references).include? n&.name
           @log.add("Style", nil, "Only annexes and references can follow clauses")
         end
-        while n[:tag] == "annex"
+         while n&.name == "annex"
           n = names.shift
           if n.nil?
             @log.add("Style", nil, "Document must include (references) "\
                  "Normative References")
-            return
           end
         end
-        n == { tag: "references", title: "Normative References" } ||
+         n&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                "Normative References")
-        n = names.shift
-        n == { tag: "references", title: "Bibliography" } ||
+        n = names&.shift
+        n&.at("./self::references[@normative = 'false']") ||
           @log.add("Style", nil, "Final section must be (references) Bibliography")
         names.empty? ||
           @log.add("Style", nil, "There are sections after the final Bibliography")