metanorma-standoc 2.2.0 → 2.2.1.1

data/lib/metanorma/standoc/validate.rb

@@ -1,5 +1,6 @@
 require "metanorma/standoc/utils"
 require_relative "./validate_section"
+require_relative "./validate_table"
 require "nokogiri"
 require "jing"
 require "iev"
@@ -53,75 +54,6 @@ module Metanorma
         @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
       end
 
-      def table_validate(doc)
-        doc.xpath("//table[colgroup]").each do |t|
-          maxrowcols_validate(t, t.xpath("./colgroup/col").size)
-        end
-        doc.xpath("//table[.//*[@colspan] | .//*[@rowspan]]").each do |t|
-          maxrowcols_validate(t, max_td_count(t))
-        end
-      end
-
-      def max_td_count(table)
-        max = 0
-        table.xpath("./tr").each do |tr|
-          n = tr.xpath("./td | ./th").size
-          max < n and max = n
-        end
-        max
-      end
-
-      def maxrowcols_validate(table, maxcols)
-        cells2d = table.xpath("./*/tr").each_with_object([]) { |_r, m| m << {} }
-        table.xpath("./*/tr").each_with_index do |tr, r|
-          curr = 0
-          tr.xpath("./td | ./th").each do |td|
-            curr = maxcols_validate1(td, r, curr, cells2d, maxcols)
-          end
-        end
-        maxrows_validate(table, cells2d)
-      end
-
-      # code doesn't actually do anything, since Asciidoctor refuses to generate
-      # table with inconsistent column count
-      def maxcols_validate1(tcell, row, curr, cells2d, maxcols)
-        rs = tcell&.attr("rowspan")&.to_i || 1
-        cs = tcell&.attr("colspan")&.to_i || 1
-        curr = table_tracker_update(cells2d, row, curr, rs, cs)
-        maxcols_check(curr + cs - 1, maxcols, tcell)
-        curr + cs
-      end
-
-      def table_tracker_update(cells2d, row, curr, rowspan, colspan)
-        cells2d[row] ||= {}
-        while cells2d[row][curr]
-          curr += 1
-        end
-        (row..(row + rowspan - 1)).each do |y2|
-          cells2d[y2] ||= {}
-          (curr..(curr + colspan - 1)).each { |x2| cells2d[y2][x2] = 1 }
-        end
-        curr
-      end
-
-      def maxrows_validate(table, cells2d)
-        if cells2d.any? { |x| x.size != cells2d.first.size }
-          @log.add("Table", table,
-                   "Table rows in table are inconsistent: check rowspan")
-          @fatalerror << "Table rows in table are inconsistent: check rowspan"
-        end
-      end
-
-      # if maxcols or maxrows negative, do not check them
-      def maxcols_check(col, maxcols, tcell)
-        if maxcols.positive? && col > maxcols
-          @log.add("Table", tcell, "Table exceeds maximum number of columns "\
-                                   "defined (#{maxcols})")
-          @fatalerror << "Table exceeds maximum number of columns defined "\
-                         "(#{maxcols})"
-        end
-      end
-
       def norm_ref_validate(doc)
         found = false
         doc.xpath("//references[@normative = 'true']/bibitem").each do |b|

data/lib/metanorma/standoc/validate_table.rb

@@ -0,0 +1,91 @@
+module Metanorma
+  module Standoc
+    module Validate
+      def table_validate(doc)
+        doc.xpath("//table[colgroup]").each do |t|
+          maxrowcols_validate(t, t.xpath("./colgroup/col").size)
+        end
+        doc.xpath("//table[.//*[@colspan] | .//*[@rowspan]]").each do |t|
+          maxrowcols_validate(t, max_td_count(t), mode: "row_cols")
+        end
+        doc.xpath("//table[.//*[@rowspan]]").each do |t|
+          maxrowcols_validate(t, max_td_count(t), mode: "thead_row")
+        end
+      end
+
+      def max_td_count(table)
+        max = 0
+        table.xpath("./tr").each do |tr|
+          n = tr.xpath("./td | ./th").size
+          max < n and max = n
+        end
+        max
+      end
+
+      def maxrowcols_validate(table, maxcols, mode: "row_cols")
+        case mode
+        when "row_cols"
+          maxrowcols_validate0(table, maxcols, "*", mode)
+        when "thead_row"
+          %w{thead tbody tfoot}.each do |w|
+            maxrowcols_validate0(table, maxcols, w, mode)
+          end
+        end
+      end
+
+      def maxrowcols_validate0(table, maxcols, tablechild, mode)
+        cells2d = table.xpath("./#{tablechild}/tr")
+          .each_with_object([]) { |_r, m| m << {} }
+        table.xpath("./#{tablechild}/tr").each_with_index do |tr, r|
+          curr = 0
+          tr.xpath("./td | ./th").each do |td|
+            curr = maxcols_validate1(td, r, curr, cells2d, maxcols, mode)
+          end
+        end
+        maxrows_validate(table, cells2d, tablechild, mode)
+      end
+
+      # code doesn't actually do anything, since Asciidoctor refuses to generate
+      # table with inconsistent column count
+      def maxcols_validate1(tcell, row, curr, cells2d, maxcols, mode)
+        rs = tcell&.attr("rowspan")&.to_i || 1
+        cs = tcell&.attr("colspan")&.to_i || 1
+        curr = table_tracker_update(cells2d, row, curr, rs, cs)
+        maxcols_check(curr + cs - 1, maxcols, tcell) if mode == "row_cols"
+        curr + cs
+      end
+
+      def table_tracker_update(cells2d, row, curr, rowspan, colspan)
+        cells2d[row] ||= {}
+        while cells2d[row][curr]
+          curr += 1
+        end
+        (row..(row + rowspan - 1)).each do |y2|
+          cells2d[y2] ||= {}
+          (curr..(curr + colspan - 1)).each { |x2| cells2d[y2][x2] = 1 }
+        end
+        curr
+      end
+
+      def maxrows_validate(table, cells2d, tablechild, mode)
+        err = "are inconsistent"
+        mode == "thead_row" and err = "cannot go outside #{tablechild}"
+        err = "Table rows in table #{err}: check rowspan"
+        if cells2d.any? { |x| x.size != cells2d.first.size }
+          @log.add("Table", table, err)
+          @fatalerror << err
+        end
+      end
+
+      # if maxcols or maxrows negative, do not check them
+      def maxcols_check(col, maxcols, tcell)
+        if maxcols.positive? && col > maxcols
+          @log.add("Table", tcell, "Table exceeds maximum number of columns "\
+                                   "defined (#{maxcols})")
+          @fatalerror << "Table exceeds maximum number of columns defined "\
+                         "(#{maxcols})"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.2.0".freeze
+    VERSION = "2.2.1.1".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -36,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "metanorma-utils", "~> 1.2.8"
-  spec.add_dependency "relaton-cli", "~> 1.12.0"
+  spec.add_dependency "mn-requirements", "~> 0.0.1"
+  spec.add_dependency "relaton-cli", "~> 1.13.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 

data/spec/metanorma/biblio_spec.rb

@@ -235,7 +235,7 @@ RSpec.describe Metanorma::Standoc do
       person::
         name:::
           language:::: en
-          initial:::: A.
+          formatted_initials:::: A.
           surname:::: Bierman
         affiliation:::
       +
@@ -377,8 +377,8 @@ RSpec.describe Metanorma::Standoc do
           <role type="author"/>
           <person>
             <name>
-              <initial language="en">A.</initial>
-              <surname language="en">Bierman</surname>
+              <formatted-initials>A.</formatted-initials>
+              <surname>Bierman</surname>
             </name>
             <affiliation>
               <description language="en" script="Latn">Affiliation description</description>
@@ -590,7 +590,7 @@ RSpec.describe Metanorma::Standoc do
       contributor.role:: publisher
       contributor::
       contributor.person.name.language:: en
-      contributor.person.name.initial:: A.
+      contributor.person.name.formatted_initials:: A.
       contributor.person.name.surname:: Bierman
       contributor.person.affiliation.organization.name:: IETF
       contributor.person.affiliation.organization.abbreviation:: IETF
@@ -706,8 +706,8 @@ RSpec.describe Metanorma::Standoc do
           <role type="author"/>
           <person>
             <name>
-              <initial language="en">A.</initial>
-              <surname language="en">Bierman</surname>
+              <formatted-initials>A.</formatted-initials>
+              <surname>Bierman</surname>
             </name>
             <affiliation>
               <description language="en" script="Latn">Affiliation description</description>
@@ -896,7 +896,7 @@ RSpec.describe Metanorma::Standoc do
       [bibliography]
       === Normative References
 
-      * [[[A, B]]], s:surname[Wozniak], s:initials[S.] & s:givenname[Steve] s:surname[Jobs]. s:pubyear[1996]. s:title[_Work_]. In s:surname.editor[Gates], s:initials.editor[W. H], Collected Essays. s:docid.ISO[ISO 1234]. s:pubplace[Geneva]: s:publisher[International Standardization Organization]. s:uri.citation[http://www.example.com]. s:type[inbook]
+      * [[[A, B]]], span:surname[Wozniak], span:initials[S.] & span:givenname[Steve] span:surname[Jobs]. span:pubyear[1996]. span:title[_Work_]. In span:surname.editor[Gates], span:initials.editor[W. H], Collected Essays. span:docid.ISO[ISO 1234]. span:pubplace[Geneva]: span:publisher[International Standardization Organization]. span:uri.citation[http://www.example.com]. span:type[inbook]
     INPUT
     output = <<~OUTPUT
       #{BLANK_HDR}
@@ -933,7 +933,7 @@ RSpec.describe Metanorma::Standoc do
                  <role type='author'/>
                  <person>
                    <name>
-                     <initial>S.</initial>
+                     <formatted-initials>S.</formatted-initials>
                      <surname>Wozniak</surname>
                    </name>
                  </person>
@@ -951,7 +951,7 @@ RSpec.describe Metanorma::Standoc do
                  <role type='editor'/>
                  <person>
                    <name>
-                     <initial>W. H</initial>
+                     <formatted-initials>W. H</formatted-initials>
                      <surname>Gates</surname>
                    </name>
                  </person>

data/spec/metanorma/blocks_spec.rb

@@ -456,16 +456,16 @@ RSpec.describe Metanorma::Standoc do
       ====
     INPUT
     output = <<~OUTPUT
-                   #{BLANK_HDR}
-            <sections>
-                <clause id='_' inline-header='false' obligation='normative'>
-      <title>Clause</title>
-      <termnote id='_'>
-        <p id='_'>XYZ</p>
-      </termnote>
-    </clause>
-            </sections>
-            </standard-document>
+                     #{BLANK_HDR}
+              <sections>
+                  <clause id='_' inline-header='false' obligation='normative'>
+        <title>Clause</title>
+        <termnote id='_'>
+          <p id='_'>XYZ</p>
+        </termnote>
+      </clause>
+              </sections>
+              </standard-document>
     OUTPUT
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
@@ -764,16 +764,16 @@ RSpec.describe Metanorma::Standoc do
       ====
     INPUT
     output = <<~OUTPUT
-      #{BLANK_HDR}
-            <sections>
-                <clause id='_' inline-header='false' obligation='normative'>
-      <title>Clause</title>
-      <termexample id='_'>
-        <p id='_'>XYZ</p>
-      </termexample>
-    </clause>
-            </sections>
-            </standard-document>
+        #{BLANK_HDR}
+              <sections>
+                  <clause id='_' inline-header='false' obligation='normative'>
+        <title>Clause</title>
+        <termexample id='_'>
+          <p id='_'>XYZ</p>
+        </termexample>
+      </clause>
+              </sections>
+              </standard-document>
     OUTPUT
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
@@ -1616,252 +1616,6 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes recommendation" do
-    input = <<~"INPUT"
-      #{ASCIIDOC_BLANK_HDR}
-      [.recommendation,identifier="/ogc/recommendation/wfs/2",subject="user;developer, implementer",inherit="/ss/584/2015/level/1; /ss/584/2015/level/2",options="unnumbered",type=verification,model=ogc,tag=X,multilingual-rendering=common]
-      ====
-      I recommend this
-      ====
-    INPUT
-    output = <<~"OUTPUT"
-      #{BLANK_HDR}
-              <sections>
-         <recommendation id="_" unnumbered="true" type="verification" model="ogc" tag='X' multilingual-rendering='common'>
-         <identifier>/ogc/recommendation/wfs/2</identifier>
-       <subject>user</subject>
-       <subject>developer, implementer</subject>
-       <inherit>/ss/584/2015/level/1</inherit>
-       <inherit>/ss/584/2015/level/2</inherit>
-         <description><p id="_">I recommend this</p>
-       </description>
-       </recommendation>
-              </sections>
-              </standard-document>
-    OUTPUT
-
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes requirement" do
-    input = <<~"INPUT"
-      #{ASCIIDOC_BLANK_HDR}
-      [[ABC]]
-      [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2",number=3,keep-with-next=true,keep-lines-together=true,tag=X,multilingual-rendering=common]
-      .Title
-      ====
-      I recommend this
-
-      . http://www.example.com[]
-      . <<ABC>>
-      ====
-    INPUT
-    output = <<~OUTPUT
-      #{BLANK_HDR}
-             <sections>
-        <requirement id="ABC" subsequence="A" number="3" keep-with-next="true" keep-lines-together="true" tag='X' multilingual-rendering='common'>
-              <title>Title</title>
-        <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
-        <description><p id="_">I recommend this</p>
-                       <ol id='_' type='arabic'>
-                 <li>
-                   <p id='_'>
-                     <link target='http://www.example.com'/>
-                   </p>
-                 </li>
-                 <li>
-                   <p id='_'>
-                     <xref target='ABC'/>
-                   </p>
-                 </li>
-               </ol>
-      </description>
-      </requirement>
-             </sections>
-             </standard-document>
-    OUTPUT
-
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes permission" do
-    input = <<~"INPUT"
-      #{ASCIIDOC_BLANK_HDR}
-
-      [[ABC]]
-      [.permission,tag=X,multilingual-rendering=common]
-      ====
-      I recommend this
-      ====
-    INPUT
-    output = <<~"OUTPUT"
-                  #{BLANK_HDR}
-             <sections>
-        <permission id="ABC" tag='X' multilingual-rendering='common'>
-        <description><p id="_">I recommend this</p></description>
-      </permission>
-             </sections>
-             </standard-document>
-    OUTPUT
-
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes nested permissions" do
-    input = <<~"INPUT"
-      #{ASCIIDOC_BLANK_HDR}
-      [.permission]
-      ====
-      I permit this
-
-      =====
-      Example 2
-      =====
-
-      [.permission]
-      =====
-      I also permit this
-
-      . List
-      . List
-      =====
-
-      [requirement,type="general",identifier="/req/core/quantities-uom"]
-      ======
-      ======
-      ====
-    INPUT
-    output = <<~"OUTPUT"
-      #{BLANK_HDR}
-             <sections>
-               <permission id="_"><description><p id="_">I permit this</p>
-      <example id="_">
-        <p id="_">Example 2</p>
-      </example></description>
-      <permission id="_">
-        <description><p id="_">I also permit this</p>
-                  <ol id='_' type='arabic'>
-            <li>
-              <p id='_'>List</p>
-            </li>
-            <li>
-              <p id='_'>List</p>
-            </li>
-          </ol>
-        </description>
-      </permission>
-      <requirement id='_' type='general'>
-      <identifier>/req/core/quantities-uom</identifier>
-      </requirement>
-      </permission>
-      </sections>
-      </standard-document>
-    OUTPUT
-
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes recommendation with internal markup of structure" do
-    input = <<~"INPUT"
-      #{ASCIIDOC_BLANK_HDR}
-
-      [[ABC]]
-      [.recommendation,identifier="/ogc/recommendation/wfs/2",subject="user",classification="control-class:Technical;priority:P0;family:System &amp; Communications Protection,System and Communications Protocols",obligation="permission,recommendation",filename="reqt1.rq"]
-      ====
-      I recommend _this_.
-
-      [.specification,type="tabular",keep-with-next=true,keep-lines-together=true]
-      --
-      This is the object of the recommendation:
-      |===
-      |Object |Value
-      |Mission | Accomplished
-      |===
-      --
-
-      As for the measurement targets,
-
-      [.measurement-target]
-      --
-      The measurement target shall be measured as:
-      [stem]
-      ++++
-      r/1 = 0
-      ++++
-      --
-
-      [.verification]
-      --
-      The following code will be run for verification:
-
-      [source,CoreRoot]
-      ----
-      CoreRoot(success): HttpResponse
-      if (success)
-        recommendation(label: success-response)
-      end
-      ----
-      --
-
-      [.import%exclude]
-      --
-      [source,CoreRoot]
-      ----
-      success-response()
-      ----
-      --
-
-      [.component]
-      --
-      Hello
-      --
-
-      [.component,class=condition]
-      --
-      If this be thus
-      --
-      ====
-    INPUT
-    output = <<~"OUTPUT"
-         #{BLANK_HDR}
-                 <sections>
-                 <recommendation id="ABC"  obligation="permission,recommendation" filename="reqt1.rq"><identifier>/ogc/recommendation/wfs/2</identifier><subject>user</subject>
-          <classification><tag>control-class</tag><value>Technical</value></classification><classification><tag>priority</tag><value>P0</value></classification><classification><tag>family</tag><value>System &amp; Communications Protection</value></classification><classification><tag>family</tag><value>System and Communications Protocols</value></classification>
-                  <description><p id="_">I recommend <em>this</em>.</p>
-                 </description><specification exclude="false" type="tabular" keep-with-next="true" keep-lines-together="true"><p id="_">This is the object of the recommendation:</p><table id="_">  <tbody>    <tr>      <td valign="top" align="left">Object</td>      <td valign="top" align="left">Value</td>    </tr>    <tr>      <td valign="top" align="left">Mission</td>      <td valign="top" align="left">Accomplished</td>    </tr>  </tbody></table></specification><description>
-                 <p id="_">As for the measurement targets,</p>
-                 </description><measurement-target exclude="false"><p id="_">The measurement target shall be measured as:</p><formula id="_">  <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mfrac>
-                 <mrow>
-            <mi>r</mi>
-          </mrow>
-          <mrow>
-            <mn>1</mn>
-          </mrow>
-          </mfrac><mo>=</mo><mn>0</mn></math></stem></formula></measurement-target>
-                 <verification exclude="false"><p id="_">The following code will be run for verification:</p><sourcecode  lang="CoreRoot" id="_">CoreRoot(success): HttpResponse
-          if (success)
-            recommendation(label: success-response)
-          end</sourcecode></verification>
-                 <import exclude="true">  <sourcecode  lang="CoreRoot" id="_">success-response()</sourcecode></import>
-                 <component exclude='false' class='component'>
-        <p id='_'>Hello</p>
-      </component>
-      <component exclude='false' class='condition'>
-        <p id='_'>If this be thus</p>
-      </component>
-          </recommendation>
-                 </sections>
-                 </standard-document>
-    OUTPUT
-
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
   it "processes delete change clauses" do
     input = <<~"INPUT"
       #{ASCIIDOC_BLANK_HDR}