metanorma-standoc 1.11.2 → 2.0.1

data/spec/{asciidoctor → metanorma}/blank_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "processes a blank document" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/{asciidoctor → metanorma}/blocks_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "open3"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "processes format-specific pass blocks" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -1444,7 +1444,7 @@ OUTPUT
       ====
     INPUT
     output = <<~"OUTPUT"
-                  #{BLANK_HDR}
+     #{BLANK_HDR}
              <sections>
         <recommendation id="_" unnumbered="true" type="verification" model="ogc" tag='X' multilingual-rendering='common'>
         <label>/ogc/recommendation/wfs/2</label>
@@ -1452,7 +1452,8 @@ OUTPUT
       <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>
+        <description><p id="_">I recommend this</p>
+      </description>
       </recommendation>
              </sections>
              </standard-document>
@@ -1470,6 +1471,9 @@ OUTPUT
       .Title
       ====
       I recommend this
+
+      . http://www.example.com[]
+      . <<ABC>>
       ====
     INPUT
     output = <<~OUTPUT
@@ -1478,7 +1482,20 @@ OUTPUT
         <requirement id="ABC" subsequence="A" number="3" keep-with-next="true" keep-lines-together="true" tag='X' multilingual-rendering='common'>
               <title>Title</title>
         <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
-        <description><p id="_">I recommend this</p></description>
+        <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>
@@ -1526,6 +1543,9 @@ OUTPUT
       [.permission]
       =====
       I also permit this
+
+      . List
+      . List
       =====
 
       [requirement,type="general",label="/req/core/quantities-uom"]
@@ -1541,7 +1561,16 @@ OUTPUT
         <p id="_">Example 2</p>
       </example></description>
       <permission id="_">
-        <description><p id="_">I also permit this</p></description>
+        <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'>
       <label>/req/core/quantities-uom</label>

data/spec/{asciidoctor → metanorma}/cleanup_blocks_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "processes svgmap" do
     FileUtils.cp "spec/fixtures/action_schemaexpg1.svg",
                  "action_schemaexpg1.svg"
@@ -1015,4 +1015,28 @@ RSpec.describe Asciidoctor::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
   end
+
+  it "updates anchor reference along with anchor to match content" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      [[samplecode]]
+      .Sample Code
+      ====
+
+      [source,ruby]
+      --
+      puts "Hello, world."
+      %w{a b c}.each do |x| <1>
+        puts x
+      end
+      --
+      <1> This is an annotation
+      ====
+    INPUT
+    output = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
+    callout_id = output.at("//xmlns:callout/@target").text
+    annotation_id = output.at("//xmlns:annotation/@id").text
+    expect(callout_id).to eq(annotation_id)
+  end
 end

data/spec/{asciidoctor → metanorma}/cleanup_sections_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "relaton_iec"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "appends any initial user-supplied text to boilerplate in terms and definitions" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/{asciidoctor → metanorma}/cleanup_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "relaton_iec"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "applies smartquotes by default" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -778,7 +778,7 @@ RSpec.describe Asciidoctor::Standoc do
       </sections>
       </standard-document>
     OUTPUT
-    expect(Asciidoctor::Standoc::Converter.new(nil, *OPTIONS)
+    expect(Metanorma::Standoc::Converter.new(nil, *OPTIONS)
       .cleanup(Nokogiri::XML(input)).to_xml)
       .to be_equivalent_to xmlpp(output)
   end
@@ -836,7 +836,7 @@ RSpec.describe Asciidoctor::Standoc do
       </bibliography>
       </standard-document>
     OUTPUT
-    expect(Asciidoctor::Standoc::Converter.new(nil, *OPTIONS)
+    expect(Metanorma::Standoc::Converter.new(nil, *OPTIONS)
       .cleanup(Nokogiri::XML(input)).to_xml)
       .to be_equivalent_to xmlpp(output)
   end
@@ -1822,7 +1822,7 @@ RSpec.describe Asciidoctor::Standoc do
              <stage>published</stage>
            </status>
            <copyright>
-             <from>2021</from>
+             <from>#{Time.now.year}</from>
            </copyright>
            <ext>
              <doctype>article</doctype>
@@ -1865,7 +1865,7 @@ RSpec.describe Asciidoctor::Standoc do
   private
 
   def mock_mathml_italicise(string)
-    allow_any_instance_of(::Asciidoctor::Standoc::Cleanup)
+    allow_any_instance_of(::Metanorma::Standoc::Cleanup)
       .to receive(:mathml_mi_italics).and_return(string)
   end
 

data/spec/{asciidoctor → metanorma}/cleanup_terms_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "relaton_iec"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "processes term and designation metadata and term sources" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -88,8 +88,8 @@ RSpec.describe Asciidoctor::Standoc do
             <title>Terms and definitions</title>
             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
             <term id='term-first-designation'>
-              <preferred language='fr' script='Latn' type='prefix' isInternational="true">
-                <expression>
+              <preferred>
+                <expression language='fr' script='Latn' type='prefix' isInternational="true">
                   <name>First Designation</name>
             <abbreviation-type>acronym</abbreviation-type>
             <pronunciation>f&#601;&#633;st</pronunciation>
@@ -106,14 +106,14 @@ RSpec.describe Asciidoctor::Standoc do
           </origin>
         </termsource>
               </preferred>
-              <admitted language='he' script='Hebr' type='suffix' absent="true">
-                <expression>
+              <admitted absent="true">
+                <expression language='he' script='Hebr' type='suffix'>
                   <name>Third Designation</name>
                 </expression>
                 <usage-info>This is usage 1.</usage-info>
               </admitted>
-              <deprecates language='jp' script='Japn' type='full' geographic-area="AUS">
-                <expression>
+              <deprecates geographic-area="AUS">
+                <expression language='jp' script='Japn' type='full'>
                   <name>Fourth Designation</name>
             <grammar>
               <gender>masculine</gender>
@@ -127,9 +127,9 @@ RSpec.describe Asciidoctor::Standoc do
                 </expression>
                 <field-of-application>Field</field-of-application>
               </deprecates>
-                      <related type='abbreviation'>
+                      <related type='see'>
           <preferred geographic-area="GRC">
-            <expression>
+            <expression type="abbreviation">
               <name>Fifth Designation</name>
               <grammar>
                 <gender>neuter</gender>
@@ -409,8 +409,8 @@ RSpec.describe Asciidoctor::Standoc do
             <title>Terms and definitions</title>
             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
             <term id='second'>
-              <preferred isInternational='true'>
-                <expression>
+              <preferred>
+                <expression isInternational='true'>
                   <name/>
                 </expression>
               </preferred>
@@ -502,8 +502,8 @@ RSpec.describe Asciidoctor::Standoc do
             <title>Terms and definitions</title>
             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
              <term id='second'>
-               <preferred isInternational='true'>
-                 <graphical-symbol>
+               <preferred>
+                 <graphical-symbol isInternational='true'>
                    <figure id='_'>
                      <pre id='_'>&lt;LITERAL&gt; FIGURATIVE</pre>
                    </figure>
@@ -556,6 +556,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{ASCIIDOC_BLANK_HDR}
       == Terms and Definitions
 
+      [[des1]]
       === First Designation
 
       [%metadata]
@@ -569,7 +570,7 @@ RSpec.describe Asciidoctor::Standoc do
       subject:: pipes
       usage-info:: This is usage.
 
-      related:see[Fifth Designation]
+      related:see[<<des1>>,Fifth Designation]
 
       [%metadata]
       grammar::
@@ -612,28 +613,28 @@ RSpec.describe Asciidoctor::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-first-designation'>
-              <preferred language='fr' script='Latn' type='prefix' isInternational="true">
-                <expression>
+            <term id='des1'>
+              <preferred>
+                <expression language='fr' script='Latn' type='prefix' isInternational="true">
                   <name>First Designation</name>
                   <abbreviation-type>acronym</abbreviation-type>
                   <pronunciation>f&#601;&#633;st</pronunciation>
                 </expression>
                 <usage-info>This is usage.</usage-info>
               </preferred>
-              <preferred type='abbreviation'>
-                <expression>
+              <preferred>
+                <expression type='abbreviation'>
                   <name>Second Designation</name>
                 </expression>
               </preferred>
-              <admitted language='he' script='Hebr' type='suffix'>
-                <expression>
+              <admitted>
+                <expression language='he' script='Hebr' type='suffix'>
                   <name>Third Designation</name>
                 </expression>
                 <usage-info>This is usage 1.</usage-info>
               </admitted>
-              <deprecates language='jp' script='Japn' type='full'>
-                <expression>
+              <deprecates>
+                <expression language='jp' script='Japn' type='full'>
                   <name>Fourth Designation</name>
                   <grammar>
                     <gender>masculine</gender>
@@ -645,12 +646,8 @@ RSpec.describe Asciidoctor::Standoc do
                 </expression>
               </deprecates>
               <related type='see'>
-                <strong>
-                  term
-                  <tt>Fifth Designation</tt>
-                   not resolved via ID
-                  <tt>fifth-designation</tt>
-                </strong>
+              <preferred><expression><name>Fifth Designation</name><grammar><gender>neuter</gender></grammar></expression>
+              </preferred><xref target='des1'/>
               </related>
               <domain>Hydraulics</domain>
               <subject>pipes</subject>
@@ -708,6 +705,114 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "differentiates stem-only and mixed terms" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      === stem:[t_90]
+
+      Time
+
+      === stem:[t_90]-sensitivity
+
+      Sensitivity
+
+      === sensitivity to stem:[t_90]
+
+      Sensitivity #2
+    INPUT
+    output = <<~OUTPUT
+            #{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-_-t90-'>
+              <preferred>
+                <letter-symbol>
+                  <name>
+                    <stem type='MathML'>
+                      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                        <msub>
+                          <mrow>
+                            <mi>t</mi>
+                          </mrow>
+                          <mrow>
+                            <mn>90</mn>
+                          </mrow>
+                        </msub>
+                      </math>
+                    </stem>
+                  </name>
+                </letter-symbol>
+              </preferred>
+              <definition>
+                <verbal-definition>
+                  <p id='_'>Time</p>
+                </verbal-definition>
+              </definition>
+            </term>
+            <term id='term-t90-sensitivity'>
+              <preferred>
+                <expression>
+                  <name>
+                    <stem type='MathML'>
+                      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                        <msub>
+                          <mrow>
+                            <mi>t</mi>
+                          </mrow>
+                          <mrow>
+                            <mn>90</mn>
+                          </mrow>
+                        </msub>
+                      </math>
+                    </stem>
+                    -sensitivity
+                  </name>
+                </expression>
+              </preferred>
+              <definition>
+                <verbal-definition>
+                  <p id='_'>Sensitivity</p>
+                </verbal-definition>
+              </definition>
+            </term>
+            <term id='term-sensitivity-to-t90'>
+              <preferred>
+                <expression>
+                  <name>
+                    sensitivity to#{' '}
+                    <stem type='MathML'>
+                      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                        <msub>
+                          <mrow>
+                            <mi>t</mi>
+                          </mrow>
+                          <mrow>
+                            <mn>90</mn>
+                          </mrow>
+                        </msub>
+                      </math>
+                    </stem>
+                  </name>
+                </expression>
+              </preferred>
+              <definition>
+                <verbal-definition>
+                  <p id='_'>Sensitivity #2</p>
+                </verbal-definition>
+              </definition>
+            </term>
+          </terms>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "moves term domains out of the term definition paragraph" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -1202,4 +1307,151 @@ RSpec.describe Asciidoctor::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
   end
+
+  it "automatically indexes term indexes" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR.sub(/:nodoc:\n/, ":nodoc:\n:index-terms:\n")}
+
+      == Terms and definitions
+
+      === Term
+
+      [stem]
+      ++++
+      lambda
+      ++++
+
+      admitted:[x]
+
+      === Term2
+
+      preferred:[stem:[mu_0 // 2]]
+
+      == Symbols and Abbreviated Terms
+
+      x^2^:: Definition
+    INPUT
+    output = <<~OUTPUT
+          <standard-document xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Standoc::VERSION}'>
+        <bibdata type='standard'>
+          <title language='en' format='text/plain'>Document title</title>
+          <language>en</language>
+          <script>Latn</script>
+          <status>
+            <stage>published</stage>
+          </status>
+          <copyright>
+            <from>#{Time.now.year}</from>
+          </copyright>
+          <ext>
+            <doctype>article</doctype>
+          </ext>
+        </bibdata>
+        <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-term'>
+              <preferred>
+                <expression>
+                  <name>
+                    Term
+                    <index>
+                      <primary>Term</primary>
+                    </index>
+                  </name>
+                </expression>
+              </preferred>
+              <admitted>
+              <expression>
+          <name>x</name>
+        </expression>
+        </admitted>
+              <admitted>
+                <letter-symbol>
+                  <name>
+                    <stem type='MathML'>
+                      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                        <mi>&#955;</mi>
+                      </math>
+                    </stem>
+                  </name>
+                </letter-symbol>
+              </admitted>
+            </term>
+            <term id='term-term2'>
+              <preferred>
+                <expression>
+                  <name>
+                    Term2
+                    <index>
+                      <primary>Term2</primary>
+                    </index>
+                  </name>
+                </expression>
+              </preferred>
+              <preferred>
+                <letter-symbol>
+                  <name>
+                    <stem type='MathML'>
+                      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                        <msub>
+                          <mrow>
+                            <mi>&#956;</mi>
+                          </mrow>
+                          <mrow>
+                            <mn>0</mn>
+                          </mrow>
+                        </msub>
+                        <mo>/</mo>
+                        <mn>2</mn>
+                      </math>
+                    </stem>
+                    <index>
+                      <primary>
+                        <stem type='MathML'>
+                          <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                            <msub>
+                              <mrow>
+                                <mi>&#956;</mi>
+                              </mrow>
+                              <mrow>
+                                <mn>0</mn>
+                              </mrow>
+                            </msub>
+                            <mo>/</mo>
+                            <mn>2</mn>
+                          </math>
+                        </stem>
+                      </primary>
+                    </index>
+                  </name>
+                </letter-symbol>
+              </preferred>
+            </term>
+          </terms>
+          <definitions id='_' obligation='normative'>
+            <title>Symbols and abbreviated terms</title>
+            <dl id='_'>
+              <dt id='symbol-x2'>
+                x
+                <sup>2</sup>
+                <index>
+                  <primary>
+                    x
+                    <sup>2</sup>
+                  </primary>
+                </index>
+              </dt>
+              <dd>
+                <p id='_'>Definition</p>
+              </dd>
+            </dl>
+          </definitions>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
 end

data/spec/{asciidoctor → metanorma}/datamodel/attributes_table_preprocessor_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-RSpec.describe Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor do
+RSpec.describe Metanorma::Standoc::Datamodel::AttributesTablePreprocessor do
   describe "#process" do
     context "when simple models without relations" do
       let(:datamodel_file) do

data/spec/{asciidoctor → metanorma}/datamodel/diagram_preprocessor_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-RSpec.describe Asciidoctor::Standoc::Datamodel::DiagramPreprocessor do
+RSpec.describe Metanorma::Standoc::Datamodel::DiagramPreprocessor do
   describe "#process" do
     context "when simple models without relations" do
       let(:datamodel_file) do