metanorma-standoc 1.3.28 → 1.4.3

data/metanorma-standoc.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.0.20"
+  spec.add_dependency "isodoc", "~> 1.1.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 1.0.0"
+  spec.add_dependency "relaton", "~> 1.2.0"
   spec.add_dependency "relaton-iev", "~> 1.0.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "open3"
 
 RSpec.describe Asciidoctor::Standoc do
-    it "processes pass blocks" do
+    it "processes format-specific pass blocks" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
       
@@ -19,6 +19,26 @@ RSpec.describe Asciidoctor::Standoc do
     OUTPUT
   end
 
+  it "processes Metanorma XML pass blocks" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+
+      ++++
+      <abc>X &gt;
+      ++++
+
+      ++++
+      Y</abc>
+      ++++
+    INPUT
+        #{BLANK_HDR}
+       <sections>
+       <abc>X &gt; Y</abc>
+       </sections>
+       </standard-document>
+    OUTPUT
+  end
+
   it "processes open blocks" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -43,7 +63,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [stem%inequality]
+      [stem%inequality,number=3,keep-with-next=true,keep-lines-together=true]
       ++++
       r = 1 % 
       r = 1 % 
@@ -67,7 +87,7 @@ RSpec.describe Asciidoctor::Standoc do
     INPUT
             #{BLANK_HDR}
        <sections>
-         <formula id="ABC" inequality="true">
+         <formula id="ABC" inequality="true" number="3" keep-with-next="true" keep-lines-together="true">
          <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>r</mi><mo>=</mo><mn>1</mn><mi>%</mi><mi>r</mi><mo>=</mo><mn>1</mn><mi>%</mi></math></stem>
        </formula>
 
@@ -76,7 +96,7 @@ RSpec.describe Asciidoctor::Standoc do
        </formula>
               <formula id="_" subsequence="A">
          <stem type="MathML">
-       <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
+       <math xmlns="http://www.w3.org/1998/Math/MathML">
          <mrow>
            <mi>M</mi>
            <mo>=</mo>
@@ -310,6 +330,11 @@ RSpec.describe Asciidoctor::Standoc do
       === Term1
 
       NOTE: This is a note
+
+      [NOTE,keep-separate=true]
+      ====
+      XYZ
+      ====
       INPUT
               #{BLANK_HDR}
        <sections>
@@ -321,6 +346,9 @@ RSpec.describe Asciidoctor::Standoc do
          <termnote id="_">
          <p id="_">This is a note</p>
        </termnote>
+        <termnote id='_'>
+   <p id='_'>XYZ</p>
+ </termnote>
        </term>
        </terms>
        </sections>
@@ -395,6 +423,11 @@ RSpec.describe Asciidoctor::Standoc do
 
       [[ABC]]
       NOTE: This is a note
+
+      [NOTE,keep-separate=true,number=7,subsequence=A,beforeclauses=true,keep-with-next=true,keep-lines-together=true,type=classified]
+      ====
+      XYZ
+      ====
       INPUT
               #{BLANK_HDR}
               <preface><foreword id="_" obligation="informative">
@@ -403,6 +436,9 @@ RSpec.describe Asciidoctor::Standoc do
          <p id="_">This is a note</p>
        </note>
        </foreword></preface><sections>
+         <note id='_' number="7" subsequence="A" keep-with-next="true" keep-lines-together="true" type="classified">
+    <p id='_'>XYZ</p>
+  </note>
        <clause id="_" inline-header="false" obligation="normative">
          <title>Clause 1</title>
          <note id="ABC">
@@ -420,7 +456,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [alt=Literal]
+      [alt=Literal,keep-with-next=true,keep-lines-together=true]
       ....
       <LITERAL>
       FIGURATIVE
@@ -428,7 +464,7 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
       #{BLANK_HDR}
        <sections>
-           <figure id="ABC">
+           <figure id="ABC" keep-with-next="true" keep-lines-together="true">
         <pre alt="Literal" id="_">&lt;LITERAL&gt;
         FIGURATIVE
         </pre>
@@ -461,7 +497,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
       
       [[ABC]]
-      [CAUTION,type=Safety Precautions]
+      [CAUTION,type=Safety Precautions,keep-with-next="true",keep-lines-together="true"]
       .Precautions
       ====
       While werewolves are hardy community members, keep in mind the following dietary concerns:
@@ -473,7 +509,8 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
       #{BLANK_HDR}
       <sections>
-         <admonition id="ABC" type="safety precautions"><name>Precautions</name><p id="_">While werewolves are hardy community members, keep in mind the following dietary concerns:</p>
+         <admonition id="ABC" type="safety precautions" keep-with-next="true" keep-lines-together="true">
+        <name>Precautions</name><p id="_">While werewolves are hardy community members, keep in mind the following dietary concerns:</p>
        <ol id="_" type="arabic">
          <li>
            <p id="_">They are allergic to cinnamon.</p>
@@ -582,7 +619,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [example,subsequence=A]
+      [example,subsequence=A,keep-with-next=true,keep-lines-together=next]
       .Title
       ====
       This is an example
@@ -594,14 +631,20 @@ RSpec.describe Asciidoctor::Standoc do
       ====
       This is another example
       ====
+
+      [example,number=3]
+      ====
+      This is yet another example
+      ====
       INPUT
       #{BLANK_HDR}
        <sections>
-         <example id="ABC" subsequence="A">
+         <example id="ABC" subsequence="A"  keep-with-next='true' keep-lines-together='next'>
          <name>Title</name>
         <p id="_">This is an example</p>
        <p id="_">Amen</p></example>
          <example id="_" unnumbered="true"><p id="_">This is another example</p></example>
+         <example id="_" number="3"><p id="_">This is yet another example</p></example>
        </sections>
        </standard-document>
       OUTPUT
@@ -725,14 +768,14 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [%unnumbered]
+      [%unnumbered,number=3]
       .Split-it-right sample divider
       image::spec/examples/rice_images/rice_image1.png[alttext]
 
       INPUT
       #{BLANK_HDR}
               <sections>
-         <figure id="ABC" unnumbered="true">
+         <figure id="ABC" unnumbered="true" number="3">
          <name>Split-it-right sample divider</name>
                   <image src="spec/examples/rice_images/rice_image1.png" id="_" mimetype="image/png" height="auto" width="auto" alt="alttext"/>
        </figure>
@@ -824,15 +867,15 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
     end
 
-    it "accepts alignment attribute on paragraphs" do
+    it "accepts attributes on paragraphs" do
       expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
-      [align=right]
+      [align=right,keep-with-next=true,keep-lines-together=true]
       This para is right-aligned.
       INPUT
       #{BLANK_HDR}
       <sections>
-         <p align="right" id="_">This para is right-aligned.</p>
+         <p align="right" id="_" keep-with-next="true" keep-lines-together="true">This para is right-aligned.</p>
        </sections>
       </standard-document>
       OUTPUT
@@ -843,14 +886,14 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [quote, ISO, "ISO7301,section 1"]
+      [quote, ISO, "ISO7301,section 1",align="right",keep-with-next=true,keep-lines-together=true]
       ____
       Block quotation
       ____
       INPUT
       #{BLANK_HDR}
        <sections>
-         <quote id="ABC">
+         <quote id="ABC" align="right" keep-with-next="true" keep-lines-together="true">
          <source type="inline" bibitemid="ISO7301" citeas="">
          <localityStack>
         <locality type="section"><referenceFrom>1</referenceFrom></locality>
@@ -870,7 +913,7 @@ RSpec.describe Asciidoctor::Standoc do
       
       [[ABC]]
       .Caption
-      [source%unnumbered,ruby,filename=sourcecode1.rb]
+      [source%unnumbered,ruby,number=3,filename=sourcecode1.rb,keep-with-next=true,keep-lines-together=true]
       --
       puts "Hello, world."
       %w{a b c}.each do |x|
@@ -880,7 +923,8 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
       #{BLANK_HDR}
        <sections>
-         <sourcecode id="ABC" lang="ruby" filename="sourcecode1.rb" unnumbered="true"><name>Caption</name>puts "Hello, world."
+         <sourcecode id="ABC" lang="ruby" filename="sourcecode1.rb" unnumbered="true" number="3" keep-with-next="true" keep-lines-together="true">
+        <name>Caption</name>puts "Hello, world."
        %w{a b c}.each do |x|
          puts x
        end</sourcecode>
@@ -1066,7 +1110,7 @@ RSpec.describe Asciidoctor::Standoc do
     input = <<~"INPUT"
       #{ASCIIDOC_BLANK_HDR}
       [[ABC]]
-      [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2"]
+      [.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]
       .Title
       ====
       I recommend this
@@ -1075,7 +1119,8 @@ RSpec.describe Asciidoctor::Standoc do
              output = <<~"OUTPUT"
             #{BLANK_HDR}
        <sections>
-  <requirement id="ABC" subsequence="A"><title>Title</title>
+  <requirement id="ABC" subsequence="A" number="3" keep-with-next="true" keep-lines-together="true">
+        <title>Title</title>
   <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
   <description><p id="_">I recommend this</p></description>
 </requirement>
@@ -1153,7 +1198,7 @@ RSpec.describe Asciidoctor::Standoc do
       ====
       I recommend _this_.
 
-      [.specification,type="tabular"]
+      [.specification,type="tabular",keep-with-next=true,keep-lines-together=true]
       --
       This is the object of the recommendation:
       |===
@@ -1201,7 +1246,7 @@ RSpec.describe Asciidoctor::Standoc do
        <recommendation id="ABC"  obligation="permission,recommendation" filename="reqt1.rq"><label>/ogc/recommendation/wfs/2</label><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"><p id="_">This is the object of the recommendation:</p><table id="_">  <tbody>    <tr>      <td align="left">Object</td>      <td align="left">Value</td>    </tr>    <tr>      <td align="left">Mission</td>      <td align="left">Accomplished</td>    </tr>  </tbody></table></specification><description>
+       </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 align="left">Object</td>      <td align="left">Value</td>    </tr>    <tr>      <td align="left">Mission</td>      <td 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><mi>r</mi><mn>1</mn></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

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -293,6 +293,35 @@ RSpec.describe Asciidoctor::Standoc do
     OUTPUT
   end
 
+    it "does not move notes inside preceding blocks, if they are marked as keep-separate" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+
+      [stem]
+      ++++
+      r = 1 %
+      r = 1 %
+      ++++
+
+      [NOTE,keep-separate=true]
+      ====
+      That formula does not do much
+      ====
+
+      Indeed.
+    INPUT
+       #{BLANK_HDR}
+    <sections><formula id="_">
+  <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>r</mi><mo>=</mo><mn>1</mn><mi>%</mi><mi>r</mi><mo>=</mo><mn>1</mn><mi>%</mi></math></stem></formula>
+<note id="_">
+  <p id="_">That formula does not do much</p>
+</note>
+
+       <p id="_">Indeed.</p></sections>
+       </standard-document>
+    OUTPUT
+  end
+
   it "does not move notes inside preceding blocks, if they are at clause end" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -797,7 +826,7 @@ end
     INPUT
        #{BLANK_HDR}
        <sections><formula id="_">
-         <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>F</mi><mtext>or</mtext><mi>μ</mi><mi>l</mi><mi>a</mi></math></stem> 
+         <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>F</mi><mi>or</mi><mi>μ</mi><mi>l</mi><mi>a</mi></math></stem> 
        <dl id="_">
          <dt>a</dt>
          <dd>
@@ -953,7 +982,7 @@ end
              <name>ISO</name>
            </organization>
          </contributor>
-         <note format="text/plain">ISO DATE: The standard is in press</note>
+         <note format="text/plain" type="ISO DATE">The standard is in press</note>
        </bibitem>
       </references>
       </bibliography>
@@ -1175,7 +1204,7 @@ end
           <fetched>#{Date.today}</fetched>
           <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
           <title type="title-part" format="text/plain" language="en" script="Latn">Part 102: Mathematics — General concepts and linear algebra</title>
-          <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) – Part 102: Mathematics — General concepts and linear algebra</title>
+          <title type='main' format='text/plain' language='en' script='Latn'>International Electrotechnical Vocabulary (IEV) — Part 102: Mathematics — General concepts and linear algebra</title>
           <uri type="src">https://webstore.iec.ch/publication/160</uri>
           <uri type="obp">/preview/info_iec60050-102%7Bed1.0%7Db.pdf</uri>
           <docidentifier type="IEC">IEC 60050-102:2007</docidentifier>
@@ -1193,7 +1222,7 @@ end
           <edition>1.0</edition>
           <language>en</language>
           <script>Latn</script>
-          <abstract format="text/plain" language="en" script="Latn">This part of IEC 60050 gives the general mathematical terminology used in the fields of electricity, electronics and telecommunications, together with basic concepts in linear algebra. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Another part will deal with functions. It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
+          <abstract format="text/plain" language="en" script="Latn">This part of IEC 60050 gives the general mathematical terminology used in the fields of electricity, electronics and telecommunications, together with basic concepts in linear algebra. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Another part will deal with functions.&#13; It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
           <status>
             <stage>60</stage>
             <substage>60</substage>
@@ -1213,7 +1242,7 @@ end
           <fetched>#{Date.today}</fetched>
           <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
           <title type="title-part" format="text/plain" language="en" script="Latn">Part 103: Mathematics — Functions</title>
-          <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) – Part 103: Mathematics — Functions</title>
+          <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) — Part 103: Mathematics — Functions</title>
           <uri type="src">https://webstore.iec.ch/publication/161</uri>
           <uri type="obp">/preview/info_iec60050-103%7Bed1.0%7Db.pdf</uri>
           <docidentifier type="IEC">IEC 60050-103:2009</docidentifier>
@@ -1815,6 +1844,57 @@ it "moves inherit macros to correct location" do
     </clause>
   </sections>
 </standard-document>
+OUTPUT
+end
+
+it "moves %beforeclause admonitions to right position" do
+  expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+  #{ASCIIDOC_BLANK_HDR}
+  
+  .Foreword
+  Foreword
+
+  [NOTE,beforeclauses=true]
+  ====
+  Note which is very important
+  ====
+
+  == Introduction
+  Introduction
+
+  == Scope
+  Scope statement
+
+  [IMPORTANT,beforeclauses=true]
+  ====
+  Notice which is very important
+  ====
+INPUT
+  #{BLANK_HDR}
+  <preface>
+    <foreword id='_' obligation='informative'>
+      <title>Foreword</title>
+      <p id='_'>Foreword</p>
+    </foreword>
+    <introduction id='_' obligation='informative'>
+      <title>Introduction</title>
+      <p id='_'>Introduction</p>
+    </introduction>
+  </preface>
+  <sections>
+    <note id='_'>
+      <p id='_'>Note which is very important</p>
+    </note>
+    <admonition id='_' type='important'>
+      <p id='_'>Notice which is very important</p>
+    </admonition>
+    <clause id='_' inline-header='false' obligation='normative'>
+      <title>Scope</title>
+      <p id='_'>Scope statement</p>
+    </clause>
+  </sections>
+</standard-document>
+
 OUTPUT
 end
 

data/spec/asciidoctor-standoc/datamodel/attributes_table_preprocessor_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor do
+  describe '#process' do
+    context 'when simple models without relations' do
+      let(:datamodel_file) do
+        examples_path('datamodel/address_class_profile.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/address_class_profile.xml')
+      end
+      let(:output) do
+        [
+          BLANK_HDR,
+          File.read(fixtures_path('macros_datamodel/address_class_profile.xml'))
+        ]
+          .join
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path("datamodel/address_class_profile.#{extention}")
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("address_class_profile.#{extention}")
+        end
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_guid(File.read(result_file))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+
+    context 'when complex relations' do
+      let(:datamodel_file) do
+        examples_path('datamodel/address_component_profile.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/address_component_profile.xml')
+      end
+      let(:output) do
+        path = fixtures_path('macros_datamodel/address_component_profile.xml')
+        [
+          BLANK_HDR,
+          File.read(path)
+        ]
+          .join("\n")
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path(
+            "datamodel/address_component_profile.#{extention}"
+          )
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("address_component_profile.#{extention}")
+        end
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_guid(File.read(result_file))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+
+    context 'when missing definition' do
+      let(:datamodel_file) do
+        examples_path('datamodel/blank_definition_profile.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/blank_definition_profile.xml')
+      end
+      let(:output) do
+        path = fixtures_path('macros_datamodel/blank_definition_profile.xml')
+        [
+          BLANK_HDR,
+          File.read(path)
+        ].join("\n")
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path(
+            "datamodel/blank_definition_profile.#{extention}"
+          )
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("blank_definition_profile.#{extention}")
+        end
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_guid(File.read(result_file))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+  end
+end