metanorma-standoc 2.2.0.1 → 2.2.2

data/spec/metanorma/reqt_spec.rb

@@ -0,0 +1,130 @@
+require "spec_helper"
+require "open3"
+
+RSpec.describe Metanorma::Standoc do
+  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 "applies default requirement model" do
+    mock_default_recommendation_model("ogc")
+    input = <<~"INPUT"
+      #{ASCIIDOC_BLANK_HDR}
+
+      [[A]]
+      [.permission]
+      ====
+      I permit this
+
+
+      [[B]]
+      [.permission]
+      =====
+      I also permit this
+
+      . List
+      . List
+      =====
+      ====
+    INPUT
+
+    xml = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
+    expect(xml.at("//xmlns:permission[@id = 'A']/@model").text).to eq("ogc")
+    expect(xml.at("//xmlns:permission/xmlns:permission/@model").text)
+      .to eq("ogc")
+  end
+
+  it "overrides default requirement model" do
+    mock_default_recommendation_model("ogc")
+    input = <<~"INPUT"
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :data-uri-image: false
+      :requirements-model: default
+
+      [[A]]
+      [.permission]
+      ====
+      I permit this
+
+      [[B]]
+      [.permission]
+      =====
+      I also permit this
+
+      . List
+      . List
+      =====
+      ====
+    INPUT
+
+    xml = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
+    expect(xml.at("//xmlns:permission[@id = 'A']/@model").text).to eq("default")
+    expect(xml.at("//xmlns:permission/xmlns:permission/@model").text)
+      .to eq("default")
+  end
+
+  it "inherits requirement model from parent" do
+    mock_default_recommendation_model("ogc")
+    input = <<~"INPUT"
+
+      #{ASCIIDOC_BLANK_HDR}
+      [[A]]
+      [.permission,model=ogc]
+      ====
+      I permit this
+
+      [[B]]
+      [.permission,model=default]
+      =====
+      I also permit this
+
+      . List
+      . List
+      =====
+      ====
+    INPUT
+
+    xml = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
+    expect(xml.at("//xmlns:permission[@id = 'A']/@model").text).to eq("ogc")
+    expect(xml.at("//xmlns:permission/xmlns:permission/@model").text)
+      .to eq("ogc")
+  end
+
+  private
+
+  def mock_default_recommendation_model(model)
+    allow_any_instance_of(::Metanorma::Standoc::Blocks)
+      .to receive(:default_requirement_model).and_return(
+        model,
+      )
+  end
+end

data/spec/metanorma/section_spec.rb

@@ -77,6 +77,8 @@ RSpec.describe Metanorma::Standoc do
 
       == Terms and Definitions
 
+      == Acknowledgements
+
       [appendix]
       == Annex
 
@@ -175,6 +177,9 @@ RSpec.describe Metanorma::Standoc do
       <clause id="_" inline-header="false" obligation="normative">
         <title>Terms and Definitions</title>
       </clause>
+      <clause id='_' inline-header='false' obligation='normative'>
+        <title>Acknowledgements</title>
+      </clause>
       </sections><annex id="_" inline-header="false" obligation="normative">
         <title>Annex</title>
         <clause id="_" inline-header="false" obligation="normative">

data/spec/metanorma/validate_spec.rb

@@ -782,4 +782,53 @@ RSpec.describe Metanorma::Standoc do
     expect(File.read("test.err"))
       .not_to include "Symbol reference in `symbol[xyz]` missing:"
   end
+
+  it "warns and aborts if corrupt PNG" do
+    FileUtils.rm_f "test.xml"
+    FileUtils.rm_f "test.err"
+    begin
+      input = <<~INPUT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :no-pdf:
+
+        == Clause
+        image::spec/assets/corrupt.png[]
+
+      INPUT
+      expect do
+        Asciidoctor.convert(input, *OPTIONS)
+      end.to raise_error(SystemExit)
+    rescue SystemExit, RuntimeError
+    end
+    warn File.read("test.err")
+    expect(File.read("test.err"))
+      .to include "Corrupt PNG image"
+    expect(File.exist?("test.xml")).to be false
+  end
+
+  it "does not warn and abort if not corrupt PNG" do
+    FileUtils.rm_f "test.xml"
+    FileUtils.rm_f "test.err"
+    begin
+      input = <<~INPUT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :no-pdf:
+
+        == Clause
+        image::spec/assets/correct.png[]
+
+      INPUT
+      expect do
+        Asciidoctor.convert(input, *OPTIONS)
+      end.not_to raise_error
+    rescue SystemExit, RuntimeError
+    end
+    expect(File.read("test.err"))
+      .not_to include "Corrupt PNG image"
+    expect(File.exist?("test.xml")).to be true
+  end
 end

data/spec/requirements/default/blocks_spec.rb

@@ -0,0 +1,250 @@
+require "spec_helper"
+require "open3"
+
+RSpec.describe Metanorma::Requirements::Default do
+  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' model="default">
+              <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' model="default">
+        <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="_" model="default"><description><p id="_">I permit this</p>
+      <example id="_">
+        <p id="_">Example 2</p>
+      </example></description>
+      <permission id="_" model="default">
+        <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' model="default">
+      <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" model="default"><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
+end

data/spec/requirements/default/cleanup_spec.rb

@@ -0,0 +1,173 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Metanorma::Requirements::Default do
+    it "moves requirement metadata deflist to correct location" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause
+
+      [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2"]
+      ====
+      [%metadata]
+      model:: ogc
+      type:: class
+      identifier:: http://www.opengis.net/spec/waterml/2.0/req/xsd-xml-rules[*req/core*]
+      subject:: Encoding of logical models
+      inherit:: urn:iso:dis:iso:19156:clause:7.2.2
+      inherit:: urn:iso:dis:iso:19156:clause:8
+      inherit:: http://www.opengis.net/doc/IS/GML/3.2/clause/2.4
+      inherit:: O&M Abstract model, OGC 10-004r3, clause D.3.4
+      inherit:: http://www.opengis.net/spec/SWE/2.0/req/core/core-concepts-used
+      inherit:: <<ref2>>
+      inherit:: <<ref3>>
+      target:: http://www.example.com
+      classification:: priority:P0
+      classification:: domain:Hydrology,Groundwater
+      classification:: control-class:Technical
+      obligation:: recommendation,requirement
+
+      I recommend this
+      ====
+    INPUT
+    output = <<~OUTPUT
+            #{BLANK_HDR}
+            <sections>
+        <clause id='_' inline-header='false' obligation='normative'>
+          <title>Clause</title>
+          <requirement id='_' subsequence='A' obligation='recommendation,requirement' model='ogc' type='class'>
+            <identifier>http://www.opengis.net/spec/waterml/2.0/req/xsd-xml-rules</identifier>
+            <subject>Encoding of logical models</subject>
+            <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
+            <inherit>urn:iso:dis:iso:19156:clause:7.2.2</inherit>
+            <inherit>urn:iso:dis:iso:19156:clause:8</inherit>
+            <inherit>http://www.opengis.net/doc/IS/GML/3.2/clause/2.4</inherit>
+            <inherit>O&amp;M Abstract model, OGC 10-004r3, clause D.3.4</inherit>
+            <inherit>http://www.opengis.net/spec/SWE/2.0/req/core/core-concepts-used</inherit>
+            <inherit>
+              <xref target='ref2'/>
+            </inherit>
+            <inherit>
+              <xref target='ref3'/>
+            </inherit>
+            <classification>
+                 <tag>priority</tag>
+                 <value>P0</value>
+               </classification>
+               <classification>
+                 <tag>domain</tag>
+                 <value>Hydrology</value>
+               </classification>
+               <classification>
+                 <tag>domain</tag>
+                 <value>Groundwater</value>
+               </classification>
+               <classification>
+                 <tag>control-class</tag>
+                 <value>Technical</value>
+               </classification>
+               <classification>
+                 <tag>target</tag>
+                 <value><link target='http://www.example.com'/></value>
+               </classification>
+            <description>
+              <p id='_'>I recommend this</p>
+            </description>
+          </requirement>
+        </clause>
+      </sections>
+            </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "moves inherit macros to correct location" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause
+
+      [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2"]
+      .Title
+      ====
+      inherit:[A]
+      inherit:[B]
+      I recommend this
+      ====
+
+      [.requirement,subsequence="A",classification="X:Y"]
+      .Title
+      ====
+      inherit:[A]
+      I recommend this
+      ====
+
+      [.requirement,subsequence="A"]
+      .Title
+      ====
+      inherit:[A]
+      I recommend this
+      ====
+
+      [.requirement,subsequence="A"]
+      .Title
+      ====
+      inherit:[A]
+      ====
+
+      [.requirement,subsequence="A"]
+      ====
+      inherit:[A]
+      ====
+
+    INPUT
+    output = <<~OUTPUT
+        #{BLANK_HDR}
+        <sections>
+          <clause id='_' inline-header='false' obligation='normative'>
+            <title>Clause</title>
+            <requirement id='_' subsequence='A' model="default">
+                         <title>Title</title>
+              <inherit>A</inherit>
+              <inherit>B</inherit>
+              <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
+              <description>
+                <p id='_'> I recommend this</p>
+              </description>
+            </requirement>
+            <requirement id='_' subsequence='A' model="default">
+              <title>Title</title>
+              <inherit>A</inherit>
+              <classification>
+                <tag>X</tag>
+                <value>Y</value>
+              </classification>
+              <description>
+                <p id='_'> I recommend this</p>
+              </description>
+            </requirement>
+            <requirement id='_' subsequence='A' model="default">
+              <title>Title</title>
+              <inherit>A</inherit>
+              <description>
+                <p id='_'> I recommend this</p>
+              </description>
+            </requirement>
+            <requirement id='_' subsequence='A' model="default">
+              <title>Title</title>
+                 <inherit>A</inherit>
+              </requirement>
+              <requirement id='_' subsequence='A' model="default">
+              <inherit>A</inherit>
+            </requirement>
+          </clause>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+end
+