metanorma-standoc 2.0.3 → 2.0.5.1

data/lib/metanorma/standoc/validate.rb

@@ -49,9 +49,79 @@ module Metanorma
         iev_validate(doc.root)
         concept_validate(doc, "concept", "refterm")
         concept_validate(doc, "related", "preferred//name")
+        table_validate(doc)
         @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|
@@ -71,10 +141,9 @@ module Metanorma
           next if doc.at("//term[@id = '#{x['target']}']")
           next if doc.at("//definitions//dt[@id = '#{x['target']}']")
 
-          ref = x&.at("../#{refterm}")&.text
           @log.add("Anchors", x,
-                   "#{tag.capitalize} #{ref} is pointing to "\
-                   "#{x['target']}, which is not a term or symbol")
+                   "#{tag.capitalize} #{x&.at("../#{refterm}")&.text} is "\
+                   "pointing to #{x['target']}, which is not a term or symbol")
           found = true
         end
         found and
@@ -122,23 +191,23 @@ module Metanorma
 
       SVG_NS = "http://www.w3.org/2000/svg".freeze
 
+      WILDCARD_ATTRS =
+        "//*[@format] | //stem | //bibdata//description | "\
+        "//formattedref | //bibdata//note | //bibdata/abstract | "\
+        "//bibitem/abstract | //bibitem/note | //misc-container".freeze
+
       # RelaxNG cannot cope well with wildcard attributes. So we strip
       # any attributes from FormattedString instances (which can contain
       # xs:any markup, and are signalled with @format) before validation.
       def formattedstr_strip(doc)
-        doc.xpath("//*[@format] | //stem | //bibdata//description | "\
-                  "//formattedref | //bibdata//note | //bibdata/abstract | "\
-                  "//bibitem/abstract | //bibitem/note | //misc-container",
-                  "m" => SVG_NS).each do |n|
+        doc.xpath(WILDCARD_ATTRS, "m" => SVG_NS).each do |n|
           n.elements.each do |e|
             e.traverse do |e1|
               e1.element? and e1.each { |k, _v| e1.delete(k) }
             end
           end
         end
-        doc.xpath("//m:svg", "m" => SVG_NS).each do |n|
-          n.replace("<svg/>")
-        end
+        doc.xpath("//m:svg", "m" => SVG_NS).each { |n| n.replace("<svg/>") }
         doc
       end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.0.3".freeze
+    VERSION = "2.0.5.1".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
   spec.add_dependency "isodoc", "~> 2.0.0"
-  spec.add_dependency "metanorma-plugin-datastruct"
+  spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
@@ -52,6 +52,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sassc", "2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "vcr", "~> 5.0.0"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
 end

data/spec/assets/a2.adoc

@@ -1,8 +1,10 @@
-= X
-A
+= A2
+A2
 
 == Clause 2
 
 X
 
 embed::spec/assets/a3.adoc[]
+
+embed::spec/assets/a3a.adoc[]

data/spec/assets/a3.adoc

@@ -1,5 +1,5 @@
-= X
-A
+= A3
+A3
 
 == Clause 3
 

data/spec/assets/a3a.adoc

@@ -0,0 +1,7 @@
+= A3a
+A3a
+
+== Clause 3a
+
+X
+

data/spec/metanorma/base_spec.rb

@@ -1051,7 +1051,7 @@ QU1FOiB0ZXN0Cgo=
       .new(:standoc, header_footer: true)
       .doc_extract_attributes(node)
 
-    expect(options.dig(:mn2pdf, :font_manifest))
+    expect(options[:font_manifest])
       .to eq(node[Metanorma::Standoc::Base::FONTS_MANIFEST])
   end
 

data/spec/metanorma/cleanup_spec.rb

@@ -9,13 +9,21 @@ RSpec.describe Metanorma::Standoc do
       == "Quotation" A's
 
       '24:00:00'.
+
+      _emphasis_ *strong* `monospace` "double quote" 'single quote'
     INPUT
     output = <<~OUTPUT
-             #{BLANK_HDR}
+      #{BLANK_HDR}
                     <sections>
         <clause id="_" inline-header="false" obligation="normative">
         <title>“Quotation” A’s</title>
         <p id='_'>‘24:00:00’.</p>
+        <p id='_'>
+       <em>emphasis</em>
+       <strong>strong</strong>
+       <tt>monospace</tt>
+        “double quote” ‘single quote’
+       </p>
       </clause>
              </sections>
              </standard-document>
@@ -149,6 +157,10 @@ RSpec.describe Metanorma::Standoc do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
+      "*word*",
+
+      "link:http://example.com[]",
+
       "((ppt))",
 
       "((ppm))", "((ppt))"
@@ -160,16 +172,16 @@ RSpec.describe Metanorma::Standoc do
       ....
     INPUT
     output = <<~OUTPUT
-            #{BLANK_HDR}
-                   <sections>
-                              <p id='_'>
-                 &#8220;ppt&#8221;,
+      #{BLANK_HDR}
+        <sections>
+          <p id='_'>“<strong>word</strong>”,</p>
+           <p id='_'>“<link target='http://example.com'/>”,</p>
+          <p id='_'>&#8220;ppt&#8221;,
                  <index>
                    <primary>ppt</primary>
                  </index>
                </p>
-               <p id='_'>
-                 &#8220;ppm&#8221;,
+          <p id='_'>&#8220;ppm&#8221;,
                  <index>
                    <primary>ppm</primary>
                  </index>
@@ -178,12 +190,11 @@ RSpec.describe Metanorma::Standoc do
                    <primary>ppt</primary>
                  </index>
                </p>
-               <p id='_'>
-        &#8220;ppm
+          <p id='_'>&#8220;ppm
         <index>
           <primary>ppm</primary>
         </index>
-        &#8220;&#160;
+        &#8221;&#160;
       </p>
       <figure id='_'>
         <pre id='_'>((ppm))",</pre>
@@ -282,7 +293,7 @@ RSpec.describe Metanorma::Standoc do
               </localityStack>
               the reference,xyz</eref>
        <eref type='inline' bibitemid='iso216' citeas='ISO 216'>
-         <localityStack>
+         <localityStack connective="and">
            <locality type='whole'/>
            <locality type='clause'>
              <referenceFrom>3</referenceFrom>
@@ -298,7 +309,7 @@ RSpec.describe Metanorma::Standoc do
            <referenceFrom>the reference</referenceFrom>
            </locality>
          </localityStack>
-         <localityStack>
+         <localityStack connective="and">
            <locality type='whole'/>
            <locality type='clause'>
              <referenceFrom>3</referenceFrom>
@@ -1116,7 +1127,7 @@ RSpec.describe Metanorma::Standoc do
       <dd>
         <p id='_'>Definition 7</p>
       </dd>
-      <dt id="symbol-_-n-">
+      <dt id="symbol-n">
         <stem type='MathML'>
           <math xmlns='http://www.w3.org/1998/Math/MathML'>
             <mi>n</mi>
@@ -1178,7 +1189,7 @@ RSpec.describe Metanorma::Standoc do
               <dd>
                 <p id='_'>Definition 5</p>
               </dd>
-              <dt  id='symbol-_-xm-'><stem type='MathML'>
+              <dt  id='symbol-x-m'><stem type='MathML'>
               <math xmlns='http://www.w3.org/1998/Math/MathML'>
         <msub>
           <mrow>
@@ -1193,7 +1204,7 @@ RSpec.describe Metanorma::Standoc do
               <dd>
                 <p id='_'>Definition 4</p>
               </dd>
-              <dt  id='symbol-_-x1-'><stem type='MathML'>
+              <dt  id='symbol-x-1'><stem type='MathML'>
                <math xmlns='http://www.w3.org/1998/Math/MathML'>
          <msub>
            <mrow>
@@ -1212,7 +1223,7 @@ RSpec.describe Metanorma::Standoc do
               <dd>
                 <p id='_'>Definition 2</p>
               </dd>
-              <dt  id='symbol-_-__x3b1_-'>
+              <dt  id='symbol-__x3b1_'>
               <stem type='MathML'>
         <math xmlns='http://www.w3.org/1998/Math/MathML'>
           <mi>α</mi>
@@ -1829,13 +1840,13 @@ RSpec.describe Metanorma::Standoc do
            </ext>
          </bibdata>
          <preface>
-           <note id='_f91b621e-d8cb-30bf-eef6-7d0150204829'>
+           <note id='_2cfe95f6-7ad6-aa57-8207-6f7d7928aa8e'>
              <p id='_76d95913-a379-c60f-5144-1f09655cafa6'>
                Note which is very important
                <xref target='_76d95913-a379-c60f-5144-1f09655cafa6'/>
              </p>
            </note>
-           <foreword id='_0826616f-13a4-0634-baee-5003c5534175' obligation='informative'>
+           <foreword id='_96b556cb-657c-985b-351b-ed70d8bd6fdd' obligation='informative'>
              <title>Foreword</title>
              <p id='_d2f825bf-3e18-6143-8777-34e59928d48c'>Foreword</p>
            </foreword>
@@ -1845,7 +1856,7 @@ RSpec.describe Metanorma::Standoc do
            </introduction>
          </preface>
          <sections>
-           <admonition id='_068def71-3ec8-0395-8853-0e2d3ef5b841' type='important'>
+           <admonition id='_6abb9105-854c-e79c-c351-73a56d6ca81f' type='important'>
              <p id='_69ec375e-c992-5be3-76dd-a2311f9bb6cc'>Notice which is very important</p>
            </admonition>
            <clause id='_scope' type='scope' inline-header='false' obligation='normative'>
@@ -1858,7 +1869,7 @@ RSpec.describe Metanorma::Standoc do
     input1 = xmlpp(Asciidoctor.convert(input, *OPTIONS))
       .sub(/<p id='([^']+)'>(\s+)Note which is very important(\s+)<xref target='a'/,
            "<p id='\\1'>\\2Note which is very important\\3<xref target='\\1'")
-    expect(input1)
+    expect(xmlpp(input1))
       .to be_equivalent_to xmlpp(output)
   end
 

data/spec/metanorma/cleanup_terms_spec.rb

@@ -3,6 +3,7 @@ require "relaton_iec"
 require "fileutils"
 
 RSpec.describe Metanorma::Standoc do
+=begin
   it "processes term and designation metadata and term sources" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -180,8 +181,9 @@ RSpec.describe Metanorma::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
   end
-
-  it "permits multiple preferred terms, and treats them as synonyms in concepts" do
+=end
+  it "permits multiple preferred terms and admitted terms, "\
+     "and treats them as synonyms in concepts" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       == Terms and Definitions
@@ -209,6 +211,9 @@ RSpec.describe Metanorma::Standoc do
       {{First Designation}}
 
       {{Second Designation}}
+
+      {{Third Designation}}
+
     INPUT
     output = <<~OUTPUT
          #{BLANK_HDR}
@@ -279,11 +284,18 @@ RSpec.describe Metanorma::Standoc do
         </p>
         <p id='_'>
           <concept>
-            <refterm>Second Designation</refterm>
+            <refterm>First Designation</refterm>
             <renderterm>Second Designation</renderterm>
             <xref target='term-first-designation'/>
           </concept>
         </p>
+        <p id='_'>
+          <concept>
+            <refterm>First Designation</refterm>
+            <renderterm>Third Designation</renderterm>
+            <xref target='term-first-designation'/>
+          </concept>
+        </p>
       </clause>
          </sections>
          </standard-document>
@@ -728,7 +740,7 @@ RSpec.describe Metanorma::Standoc do
           <terms id='_' obligation='normative'>
             <title>Terms and definitions</title>
             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
-            <term id='term-_-t90-'>
+            <term id='term-t90'>
               <preferred>
                 <letter-symbol>
                   <name>

data/spec/metanorma/inline_spec.rb

@@ -444,6 +444,37 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to(output)
   end
 
+  it "processes combinations of crossreferences" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Section
+
+      <<ref1;to!ref2>>
+      <<from!ref1;to!ref2,text>>
+      <<ref1;ref2>>
+      <<ref1;and!ref2>>
+      <<ref1;or!ref2,text>>
+      <<from!ref1;to!ref2;and!ref3;to!ref4>>
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+       <sections>
+       <clause id="_" inline-header="false" obligation="normative">
+       <title>Section</title>
+       <p id="_"><xref target="ref1"><location target="ref1" connective="from"/><location target="ref2" connective="to"/></xref>
+       <xref target="ref1"><location target="ref1" connective="from"/><location target="ref2" connective="to"/>text</xref>
+       <xref target="ref1"><location target="ref1" connective="and"/><location target="ref2" connective="and"/></xref>
+       <xref target="ref1"><location target="ref1" connective="and"/><location target="ref2" connective="and"/></xref>
+       <xref target="ref1"><location target="ref1" connective="and"/><location target="ref2" connective="or"/>text</xref>
+       <xref target="ref1"><location target="ref1" connective="from"/><location target="ref2" connective="to"/><location target="ref3" connective="and"/><location target="ref4" connective="to"/></xref></p>
+       </clause>
+       </sections>
+       </standard-document>
+    OUTPUT
+    expect((strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to(output)
+  end
+
   it "processes bibliographic anchors" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/metanorma/macros_plantuml_spec.rb

@@ -129,51 +129,50 @@ RSpec.describe Metanorma::Standoc do
       expect(
         xmlpp(
           strip_guid(Asciidoctor.convert(input, *OPTIONS))
-                      .gsub(%r{".+spec/assets/lutaml/[^./]+\.},
-                            '"spec/assets/_.'),
+                      .gsub(%r{"[^".]+spec/assets/lutaml/[^./"]+\.png},
+                            '"spec/assets/_.png'),
         ),
-      )
-        .to(be_equivalent_to(xmlpp(output)))
+      ).to(be_equivalent_to(xmlpp(output)))
     end
+  end
 
-    context "when inline macro, path supplied as the second arg" do
-      let(:example_file) { fixtures_path("diagram_definitions.lutaml") }
-      let(:input) do
-        <<~TEXT
-          = Document title
-          Author
-          :docfile: test.adoc
-          :nodoc:
-          :novalid:
-          :no-isobib:
-          :imagesdir: spec/assets
-          :data-uri-image: false
-
-          lutaml_diagram::#{example_file}[]
-
-        TEXT
-      end
-      let(:output) do
-        <<~TEXT
-          #{BLANK_HDR}
-          <sections>
-          <figure id="_">
-          <image src="spec/assets/_.png" id="_" mimetype="image/png" height="auto" width="auto"/>
-          </figure>
-          </sections>
-          </standard-document>
-        TEXT
-      end
-
-      it "correctly renders input" do
-        expect(
-          xmlpp(
-            strip_guid(Asciidoctor.convert(input, *OPTIONS))
-                        .gsub(%r{".+spec/assets/lutaml/[^./]+\.},
-                              '"spec/assets/_.'),
-          ),
-        ).to(be_equivalent_to(xmlpp(output)))
-      end
+  context "when inline macro, path supplied as the second arg" do
+    let(:example_file) { fixtures_path("diagram_definitions.lutaml") }
+    let(:input) do
+      <<~TEXT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :nodoc:
+        :novalid:
+        :no-isobib:
+        :imagesdir: spec/assets
+        :data-uri-image: false
+
+        lutaml_diagram::#{example_file}[]
+
+      TEXT
+    end
+    let(:output) do
+      <<~TEXT
+        #{BLANK_HDR}
+        <sections>
+        <figure id="_">
+        <image src="spec/assets/_.png" id="_" mimetype="image/png" height="auto" width="auto"/>
+        </figure>
+        </sections>
+        </standard-document>
+      TEXT
+    end
+
+    it "correctly renders input" do
+      expect(
+        xmlpp(
+          strip_guid(Asciidoctor.convert(input, *OPTIONS))
+                      .gsub(%r{"[^".]+spec/assets/lutaml/[^./"]+\.png},
+                            '"spec/assets/_.png'),
+        ),
+      ).to(be_equivalent_to(xmlpp(output)))
     end
   end