metanorma-standoc 1.6.1 → 1.7.0

data/spec/asciidoctor-standoc/converter_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+RSpec.describe Asciidoctor::Standoc do
+  it "flavor_name is standoc" do
+    converter = Asciidoctor::Standoc::Converter.new(nil, backend: :standoc)
+    expect(converter.flavor_name).to eql(:standoc)
+  end
+end

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -418,14 +418,11 @@ OUTPUT
   it "processes index terms" do 
           expect((strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to (<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
-      ((See)) Index ((_term_)) and(((A, B, C))).
+      ((See)) Index ((_term_)) and(((A~B~, stem:[alpha], &#x2c80;))).
    INPUT
    #{BLANK_HDR}
   <sections>
-    <p id='_'>
-      See
-      <index primary='See'/> Index <em>term</em> <index primary='term'/> and<index primary='A' secondary='B' tertiary='C'/>.
-    </p>
+      <p id="_">See<index><primary>See</primary></index> Index <em>term</em><index><primary><em>term</em></primary></index> and<index><primary>A<sub>B</sub></primary><secondary><stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>α</mi></math></stem></secondary><tertiary>Ⲁ</tertiary></index>.</p>
   </sections>
 </standard-document>
    OUTPUT

data/spec/asciidoctor-standoc/isobib_cache_spec.rb

@@ -55,7 +55,7 @@ EOS
          <docidentifier type='URN'>urn:iso:std:iso:124:stage-90.93:ed-7:en</docidentifier>
          <docnumber>124</docnumber>
          <date type="published">
-           <on>2014</on>
+           <on>2014-03</on>
          </date>
          <contributor>
            <role type="publisher"/>
@@ -214,7 +214,7 @@ EOS
          <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:en</docidentifier>
          <docnumber>123</docnumber>
          <date type="published">
-           <on>2001</on>
+           <on>2001-05</on>
          </date>
          <contributor>
            <role type="publisher"/>
@@ -227,6 +227,13 @@ EOS
          <edition>3</edition>
          <language>en</language>
          <script>Latn</script>
+         <abstract format='text/plain' language='en' script='Latn'>
+  This International Standard specifies procedures for sampling natural rubber
+  latex concentrate and for sampling syntheticrubber latices and artificial
+  latices. It is also suitable for sampling rubber latex contained in drums,
+  tank cars ortanks. The procedures may also be used for sampling plastics
+  dispersions.
+</abstract>
          <status>
            <stage>90</stage>
            <substage>93</substage>
@@ -326,7 +333,7 @@ EOS
     FileUtils.rm_rf File.expand_path("~/.iev/cache")
 
     # mock_isobib_get_123
-    VCR.use_cassette "isobib_get_123_2001", :re_record_interval => 25200 do
+    VCR.use_cassette "isobib_get_123_2001" do
       Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
         #{FLUSH_CACHE_ISOBIB_BLANK_HDR}
         [bibliography]
@@ -407,7 +414,7 @@ EOS
   it "activates global cache" do
     FileUtils.mv File.expand_path("~/.relaton/cache"), File.expand_path("~/.relaton-bib.pstore1"), force: true
     FileUtils.rm_rf "relaton/cache"
-        VCR.use_cassette "isobib_get_123_2001", :re_record_interval => 25200 do
+        VCR.use_cassette "isobib_get_123_2001" do
       Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
         #{CACHED_ISOBIB_BLANK_HDR}
         [bibliography]
@@ -527,7 +534,7 @@ EOS
       #)
 
     # mock_isobib_get_124
-    VCR.use_cassette "isobib_get_124", :re_record_interval => 25200 do
+    VCR.use_cassette "isobib_get_124" do
       Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
         #{CACHED_ISOBIB_BLANK_HDR}
         [bibliography]
@@ -566,7 +573,7 @@ EOS
       #)
 
     # mock_isobib_get_123_undated
-    VCR.use_cassette "isobib_get_123", :re_record_interval => 25200 do
+    VCR.use_cassette "isobib_get_123" do
       Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
         #{CACHED_ISOBIB_BLANK_HDR}
         [bibliography]
@@ -587,7 +594,7 @@ EOS
   end
 
   it "does not expire stale dated references" do
-        VCR.use_cassette "isobib_get_123_2001", :re_record_interval => 25200 do
+        VCR.use_cassette "isobib_get_123_2001" do
     FileUtils.rm_rf File.expand_path("~/.relaton-bib.pstore1")
     FileUtils.mv File.expand_path("~/.relaton/cache"), File.expand_path("~/.relaton-bib.pstore1"), force: true
 
@@ -621,8 +628,8 @@ EOS
   end
 
   it "prioritises local over global cache values" do
-        VCR.use_cassette "isobib_get_123_2001", :re_record_interval => 25200 do
-    VCR.use_cassette "isobib_get_124", :re_record_interval => 25200 do
+        VCR.use_cassette "isobib_get_123_2001" do
+    VCR.use_cassette "isobib_get_124" do
     FileUtils.rm_rf File.expand_path("~/.relaton-bib.pstore1")
     FileUtils.mv File.expand_path("~/.relaton/cache"), File.expand_path("~/.relaton-bib.pstore1"), force: true
     FileUtils.rm_rf "relaton/cache"

data/spec/asciidoctor-standoc/lists_spec.rb

@@ -111,6 +111,9 @@ RSpec.describe Asciidoctor::Standoc do
       +
       Note 3.
 
+      [%key]
+      a:: b
+
     INPUT
     expect(xmlpp(strip_guid(output))).to be_equivalent_to xmlpp(<<~"OUTPUT")
             #{BLANK_HDR}
@@ -174,7 +177,13 @@ RSpec.describe Asciidoctor::Standoc do
          </li>
        </ol>
          </li>
-       </ol></sections>
+       </ol><dl id='_' key='true'>
+  <dt>a</dt>
+  <dd>
+    <p id='_'>b</p>
+  </dd>
+</dl>
+</sections>
        </standard-document>
        OUTPUT
     end

data/spec/asciidoctor-standoc/macros_lutaml_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+RSpec.describe 'Lutaml macros' do
+  let(:example_file) { fixtures_path("test.exp") }
+
+  context "Array of hashes" do
+    let(:input) do
+      <<~TEXT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :nodoc:
+        :novalid:
+        :no-isobib:
+        :imagesdir: spec/assets
+
+        [lutaml,#{example_file},my_context]
+        ----
+
+        {% for schema in my_context.schemas %}
+        == {{schema.id}}
+
+        {% for entity in schema.entities %}
+        === {{entity.id}}
+        supertypes -> {{entity.supertypes.id}}
+        explicit -> {{entity.explicit.first.id}}
+
+        {% endfor %}
+
+        {% endfor %}
+        ----
+      TEXT
+    end
+    let(:output) do
+      <<~TEXT
+        #{BLANK_METANORMA_HDR}
+        <sections>
+        <clause id="_" inline-header="false" obligation="normative"><title>annotated_3d_model_data_quality_criteria_schema</title>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_data_quality_criteria_representation</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_data_quality_criterion</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_data_quality_criterion_specific_applied_value</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_data_quality_target_accuracy_association</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_detailed_report_request</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>a3m_summary_report_request_with_representative_value</title>
+        <p id="_">supertypes →
+        explicit → </p>
+        </clause></clause>
+        </sections>
+        </standard-document>
+        </body></html>
+      TEXT
+    end
+
+    it "correctly renders input" do
+      expect(xml_string_conent(metanorma_process(input)))
+        .to(be_equivalent_to(output))
+    end
+  end
+end

data/spec/asciidoctor-standoc/macros_plantuml_spec.rb

@@ -0,0 +1,307 @@
+require "spec_helper"
+
+RSpec.describe Asciidoctor::Standoc do
+  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")
+      #{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>
+
+       </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
+
+  context 'when lutaml_diagram' do
+    let(:input) do
+      <<~"OUTPUT"
+        = Document title
+        Author
+        :docfile: test.adoc
+        :nodoc:
+        :novalid:
+        :no-isobib:
+        :imagesdir: spec/assets
+
+        [lutaml_diagram]
+        ....
+        diagram MyView {
+          fontname "Arial"
+          title "my diagram"
+          class Foo {}
+        }
+        ....
+      OUTPUT
+    end
+    let(:output) do
+      <<~"OUTPUT"
+      #{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 lutaml_diagram" do
+      expect(
+        xmlpp(
+          strip_guid(Asciidoctor.convert(input, backend: :standoc, header_footer: true))
+                      .gsub(%r{".+spec\/assets\/lutaml\/[^.\/]+\.}, %q("spec/assets/_.))))
+        .to(be_equivalent_to xmlpp(output))
+    end
+  end
+
+  context 'when lutaml_uml_attributes_table' do
+    let(:example_file) { fixtures_path("diagram_definitions.lutaml") }
+    let(:input) do
+      <<~"OUTPUT"
+        = Document title
+        Author
+        :docfile: test.adoc
+        :nodoc:
+        :novalid:
+        :no-isobib:
+        :imagesdir: spec/assets
+
+        [lutaml_uml_attributes_table,#{example_file},AttributeProfile]
+      OUTPUT
+    end
+    let(:output) do
+      <<~"OUTPUT"
+      #{BLANK_HDR}
+        <sections>
+          <clause id='_' inline-header='false' obligation='normative'>
+            <title>AttributeProfile</title>
+            <table id='_'>
+              <name>AttributeProfile attributes</name>
+              <thead>
+                <tr>
+                  <th valign='top' align='left'>Name</th>
+                  <th valign='top' align='left'>Definition</th>
+                  <th valign='top' align='left'>Mandatory/ Optional/ Conditional</th>
+                  <th valign='top' align='left'>Max Occur</th>
+                  <th valign='top' align='left'>Data Type</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td valign='top' align='left'>addressClassProfile</td>
+                  <td valign='top' align='left'>TODO: enum ‘s definition</td>
+                  <td valign='top' align='left'>O</td>
+                  <td valign='top' align='left'>1</td>
+                  <td valign='top' align='left'>
+                    <tt>CharacterString</tt>
+                  </td>
+                </tr>
+                <tr>
+                  <td valign='top' align='left'>imlicistAttributeProfile</td>
+                  <td valign='top' align='left'>this is attribute definition with multiply lines</td>
+                  <td valign='top' align='left'>O</td>
+                  <td valign='top' align='left'>1</td>
+                  <td valign='top' align='left'>
+                    <tt>CharacterString</tt>
+                  </td>
+                </tr>
+              </tbody>
+            </table>
+          </clause>
+        </sections>
+        </standard-document>
+      OUTPUT
+    end
+
+    it "processes the lutaml_uml_attributes_table macro" do
+      expect(
+        xmlpp(
+          strip_guid(Asciidoctor.convert(input, backend: :standoc, header_footer: true))))
+        .to(be_equivalent_to(xmlpp(output)))
+    end
+  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
+      #{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
+
+    mock_plantuml_disabled
+    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
+       #{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
+
+  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}
+
+      [plantuml]
+      ....
+      @startuml
+      Alice -> Bob: Authentication Request
+      Bob --> Alice: Authentication Response
+
+      Alice -> Bob: Another authentication Request
+      Alice <-- Bob: another authentication Response
+      @enduml
+      ....
+    INPUT
+
+    mock_localdir_unwritable
+    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
+       #{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
+
+  private
+
+  def mock_plantuml_disabled
+    expect(Asciidoctor::Standoc::PlantUMLBlockMacroBackend).to receive(:plantuml_installed?) do
+      raise "PlantUML not installed"
+      false
+    end
+  end
+
+  def mock_localdir_unwritable
+    expect(Asciidoctor::Standoc::Utils).to receive(:localdir) do
+      "/"
+    end.exactly(2).times
+  end
+
+  def mock_localdir_unwritable
+    expect(File).to receive(:writable?) do
+      false
+    end
+  end
+end