metanorma-standoc 1.6.1 → 1.7.0

data/spec/asciidoctor-standoc/macros_spec.rb

@@ -44,6 +44,109 @@ RSpec.describe Asciidoctor::Standoc do
     OUTPUT
   end
 
+  it "processes the Asciidoctor::Standoc index macros" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      index:also[]
+      index:see[A]
+      index:also[B,C~x~]
+      index:see[D,_E_,F]
+      index:also[G,H,I,J]
+      index:see[K,L,M,N,O]
+      index-range:id2[P]
+      index-range:id3[((_P_))]
+      index-range:id3[(((Q, R, S)))]
+
+      Text [[id2]]
+
+      Text [[id3]]
+    INPUT
+            #{BLANK_HDR}
+  <sections>
+    <p id='_'>
+      <index-xref also='true'>
+        <primary>B</primary>
+        <target>
+          C
+          <sub>x</sub>
+        </target>
+      </index-xref>
+      <index-xref also='false'>
+        <primary>D</primary>
+        <secondary>
+          <em>E</em>
+        </secondary>
+        <target>F</target>
+      </index-xref>
+      <index-xref also='true'>
+        <primary>G</primary>
+        <secondary>H</secondary>
+        <tertiary>I</tertiary>
+        <target>J</target>
+      </index-xref>
+       P
+<index to="id2">
+  <primary>P</primary>
+</index>
+<em>P</em>
+<index to="id3">
+  <primary>
+    <em>P</em>
+  </primary>
+</index>
+<index to="id3">
+  <primary>Q</primary>
+  <secondary>R</secondary>
+  <tertiary>S</tertiary>
+</index>
+    </p>
+    <p id='_'>
+             Text
+             <bookmark id='id2'/>
+           </p>
+           <p id='_'>
+             Text
+             <bookmark id='id3'/>
+           </p>
+  </sections>
+</standard-document>
+    OUTPUT
+  end
+
+  it "processes the Asciidoctor::Standoc variant macros" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      == lang:en[English] lang:fr-Latn[Français]
+
+      this lang:en[English] lang:fr-Latn[Français] section is lang:en[silly]  lang:fr[fou]
+
+    INPUT
+            #{BLANK_HDR}
+            <sections>
+  <clause id='_' inline-header='false' obligation='normative'>
+    <title>
+      <variant lang='en'>English</variant>
+      <variant lang='fr' script='Latn'>Français</variant>
+    </title>
+    <p id='_'>
+      this
+      <variant>
+        <variant lang='en'>English</variant>
+        <variant lang='fr' script='Latn'>Français</variant>
+      </variant>
+       section is
+      <variant>
+        <variant lang='en'>silly</variant>
+        <variant lang='fr'>fou</variant>
+      </variant>
+    </p>
+  </clause>
+</sections>
+       </standard-document>
+    OUTPUT
+  end
+
+
     it "processes the Asciidoctor::Standoc concept macros" do
           expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -295,13 +398,11 @@ OUTPUT
  <formula id='_'>
    <stem type='MathML'>
      <math xmlns='http://www.w3.org/1998/Math/MathML'>
-     <mover>
+     <mover accent="true">
                      <mrow>
                        <mi>X</mi>
                      </mrow>
-                     <mrow>
                        <mo>¯</mo>
-                     </mrow>
                    </mover>
                    <mo>′</mo>
                    <mo>=</mo>
@@ -361,198 +462,336 @@ OUTPUT
     OUTPUT
   end
 
-  it "processes the PlantUML macro" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{plantuml/plantuml[^./]+\.}, "plantuml/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+  it "processes the footnoteblock macro" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
 
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
-
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-
-      [plantuml]
-      ....
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
-
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      ....
-
-      [plantuml]
-      ....
-      @startuml filename
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
-
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-    INPUT
-       #{BLANK_HDR}
-       <sections><figure id="_">
-  <image src="plantuml/_.png" id="_" mimetype="image/png" height="auto" width="auto"/>
-</figure>
-<figure id="_">
-  <image src="plantuml/_.png" id="_" mimetype="image/png" height="auto" width="auto"/>
-</figure>
-<figure id="_">
-  <image src="plantuml/filename.png" id="_" mimetype="image/png" height="auto" width="auto"/>
-</figure>
-        </sections>
+      footnoteblock:[id1]
+
+      [[id1]]
+      [NOTE]
+      --
+      |===
+      |a |b
 
+      |c |d
+      |===
+
+      * A
+      * B
+      * C
+      --
+    INPUT
+            #{BLANK_HDR}
+            <sections>
+              <p id="_">
+              <fn reference='1'>
+  <table id='_'>
+    <thead>
+      <tr>
+        <th valign='top' align='left'>a</th>
+        <th valign='top' align='left'>b</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td valign='top' align='left'>c</td>
+        <td valign='top' align='left'>d</td>
+      </tr>
+    </tbody>
+  </table>
+  <ul id='_'>
+    <li>
+      <p id='_'>A</p>
+    </li>
+    <li>
+      <p id='_'>B</p>
+    </li>
+    <li>
+      <p id='_'>C</p>
+    </li>
+  </ul>
+</fn>
+            </p>
+            </sections>
        </standard-document>
     OUTPUT
   end
 
-  it "processes the PlantUML macro with imagesdir" do
-      expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{spec/assets/[^./]+\.}, "spec/assets/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-      = Document title
-      Author
-      :docfile: test.adoc
-      :nodoc:
-      :novalid:
-      :no-isobib:
-      :imagesdir: spec/assets
-
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
-
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-   INPUT
-          #{BLANK_HDR}
-          <sections>
-  <figure id="_">
-  <image src="spec/assets/_.png" id="_" mimetype="image/png" height="auto" width="auto"/>
-</figure>
-</sections>
-</standard-document>
-OUTPUT
-    end
-
-  it "processes the PlantUML macro with PlantUML disabled" do
-    mock_plantuml_disabled
-    expect { Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true) }.to output(%r{PlantUML not installed}).to_stderr
+    it "processes the footnoteblock macro with failed reference" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
 
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
-
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-    INPUT
+      footnoteblock:[id1]
 
-    mock_plantuml_disabled
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-      #{ASCIIDOC_BLANK_HDR}
+      [[id2]]
+      [NOTE]
+      --
+      |===
+      |a |b
 
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
+      |c |d
+      |===
 
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
+      * A
+      * B
+      * C
+      --
     INPUT
-       #{BLANK_HDR}
-       <sections>
-         <sourcecode id="_" lang="plantuml">@startuml
-Alice -&gt; Bob: Authentication Request
-Bob --&gt; Alice: Authentication Response
-
-Alice -&gt; Bob: Another authentication Request
-Alice &lt;-- Bob: another authentication Response
-@enduml</sourcecode>
-        </sections>
+            #{BLANK_HDR}
+        <sections>
+           <p id='_'>
+             <fn reference='1'>[ERROR]</fn>
+           </p>
+           <note id='id2'>
+             <table id='_'>
+               <thead>
+                 <tr>
+                   <th valign='top' align='left'>a</th>
+                   <th valign='top' align='left'>b</th>
+                 </tr>
+               </thead>
+               <tbody>
+                 <tr>
+                   <td valign='top' align='left'>c</td>
+                   <td valign='top' align='left'>d</td>
+                 </tr>
+               </tbody>
+             </table>
+             <ul id='_'>
+               <li>
+                 <p id='_'>A</p>
+               </li>
+               <li>
+                 <p id='_'>B</p>
+               </li>
+               <li>
+                 <p id='_'>C</p>
+               </li>
+             </ul>
+           </note>
+         </sections>
        </standard-document>
     OUTPUT
   end
 
-  it "processes the PlantUML macro with localdir unwritable" do
-    mock_localdir_unwritable
-    expect { Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true) }.to output(%r{not writable for PlantUML}).to_stderr
-      #{ASCIIDOC_BLANK_HDR}
+    describe 'term inline macros' do
+    subject(:convert) do
+      xmlpp(
+        strip_guid(
+          Asciidoctor.convert(
+            input, backend: :standoc, header_footer: true)))
+    end
+    let(:input) do
+      <<~XML
+        #{ASCIIDOC_BLANK_HDR}
+        == Terms and Definitions
 
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
+        === name2
 
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-    INPUT
+        == Main
 
-    mock_localdir_unwritable
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-      #{ASCIIDOC_BLANK_HDR}
+        term:[name,name2] is a term
+      XML
+    end
+    let(:output) do
+      <<~XML
+        #{BLANK_HDR}
+        <sections>
+          <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-name2'>
+              <preferred>name2</preferred>
+            </term>
+          </terms>
+          <clause id='_' inline-header='false' obligation='normative'>
+            <title>Main</title>
+            <p id='_'>
+              <em>name</em>
+              (
+              <xref target='term-name2'/>
+              ) is a term
+            </p>
+          </clause>
+        </sections>
+        </standard-document>
+      XML
+    end
 
-      [plantuml]
-      ....
-      @startuml
-      Alice -> Bob: Authentication Request
-      Bob --> Alice: Authentication Response
+    it 'converts macro into the correct xml' do
+      expect(convert).to(be_equivalent_to(xmlpp(output)))
+    end
 
-      Alice -> Bob: Another authentication Request
-      Alice <-- Bob: another authentication Response
-      @enduml
-      ....
-    INPUT
-       #{BLANK_HDR}
-       <sections>
-         <sourcecode id="_" lang="plantuml">@startuml
-Alice -&gt; Bob: Authentication Request
-Bob --&gt; Alice: Authentication Response
-
-Alice -&gt; Bob: Another authentication Request
-Alice &lt;-- Bob: another authentication Response
-@enduml</sourcecode>
-        </sections>
-       </standard-document>
-    OUTPUT
-  end
+    context 'default params' do
+      let(:input) do
+        <<~XML
+          #{ASCIIDOC_BLANK_HDR}
+
+          == Terms and Definitions
+
+          === name
 
-  private
+          == Main
 
-  def mock_plantuml_disabled
-    expect(Asciidoctor::Standoc::PlantUMLBlockMacroBackend).to receive(:plantuml_installed?) do
-      raise "PlantUML not installed"
-      false
+          term:[name] is a term
+        XML
+      end
+      let(:output) do
+        <<~XML
+          #{BLANK_HDR}
+          <sections>
+            <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-name'>
+                <preferred>name</preferred>
+              </term>
+            </terms>
+            <clause id='_' inline-header='false' obligation='normative'>
+              <title>Main</title>
+              <p id='_'>
+                <em>name</em>
+                (
+                <xref target='term-name' />
+                ) is a term
+              </p>
+            </clause>
+          </sections>
+          </standard-document>
+        XML
+      end
+
+      it 'uses `name` as termref name' do
+        expect(convert).to(be_equivalent_to(xmlpp(output)))
+      end
     end
-  end
 
-  def mock_localdir_unwritable
-    expect(Asciidoctor::Standoc::Utils).to receive(:localdir) do
-      "/"
-    end.exactly(2).times
-  end
+     context 'multiply exising ids in document' do
+      let(:input) do
+        <<~XML
+          #{ASCIIDOC_BLANK_HDR}
+
+          == Terms and Definitions
+
+          === name
+          === name2
+
+          [[term-name]]
+          == Main
 
-  def mock_localdir_unwritable
-    expect(File).to receive(:writable?) do
-      false
+          paragraph
+
+          [[term-name2]]
+          == Second
+
+          term:[name] is a term
+          term:[name2] is a term
+        XML
+      end
+      let(:output) do
+        <<~XML
+          #{BLANK_HDR}
+          <sections>
+            <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-name-1'>
+                 <preferred>name</preferred>
+              </term>
+              <term id='term-name2-1'>
+                <preferred>name2</preferred>
+              </term>
+            </terms>
+            <clause id='term-name' inline-header='false' obligation='normative'>
+              <title>Main</title>
+              <p id='_'>paragraph</p>
+            </clause>
+            <clause id='term-name2' inline-header='false' obligation='normative'>
+              <title>Second</title>
+              <p id='_'>
+                <em>name</em>
+                (
+                <xref target='term-name-1' />
+                ) is a term
+                <em>name2</em>
+                  (
+                <xref target='term-name2-1' />
+                ) is a term
+              </p>
+            </clause>
+          </sections>
+          </standard-document>
+        XML
+      end
+
+      it 'generates unique ids which do not match existing ids' do
+        expect(convert).to(be_equivalent_to(xmlpp(output)))
+      end
     end
-  end
+
+     context 'when missing actual ref' do
+      let(:input) do
+        <<~XML
+          #{ASCIIDOC_BLANK_HDR}
+
+          == Terms and Definitions
+
+          === name identity
+
+          [[name-check]]
+          === name check
+
+          paragraph
+
+          term:[name check] is a term
+
+          term:[name identity] is a term
+
+          Moreover, term:[missing] is a term
+        XML
+      end
+      let(:output) do
+        <<~XML
+          #{BLANK_HDR}
+            <sections>
+              <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-name-identity'>
+  <preferred>name identity</preferred>
+</term>
+                <term id='name-check'>
+                  <preferred>name check</preferred>
+                  <definition>
+                    <p id='_'>paragraph</p>
+                    <p id='_'>
+                      <em>name check</em>
+                       (
+                      <xref target='name-check'/>
+                      ) is a term
+                      </p>
+                      <p id='_'>
+                      <em>name identity</em>
+                       (
+                      <xref target='term-name-identity'/>
+                      ) is a term
+                      </p>
+                      <p id="_">Moreover, (<strong>term “missing” not resolved</strong>) is a term
+</p>
+                  </definition>
+                </term>
+              </terms>
+            </sections>
+          </standard-document>
+        XML
+      end
+
+      it 'generates unique ids which do not match existing ids' do
+        expect(convert).to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+
+    end
+
 end