metanorma-standoc 1.7.3 → 1.8.5

data/lib/asciidoctor/standoc/validate.rb

@@ -35,10 +35,25 @@ module Asciidoctor
 
       def content_validate(doc)
         section_validate(doc)
+        norm_ref_validate(doc)
         repeat_id_validate(doc.root)
         iev_validate(doc.root)
       end
 
+      def norm_ref_validate(doc)
+        found = false
+        doc.xpath("//references[@normative = 'true']/bibitem").each do |b|
+          next unless docid = b.at("./docidentifier[@type = 'metanorma']")
+          next unless  /^\[\d+\]$/.match(docid.text)
+          @log.add("Bibliography", b, "Numeric reference in normative references")
+          found = true
+        end
+        if found
+          clean_exit
+          abort("Numeric reference in normative references")
+        end
+      end
+
       def repeat_id_validate1(ids, x)
         if ids[x["id"]]
           @log.add("Anchors", x, "Anchor #{x['id']} has already been used "\
@@ -89,7 +104,7 @@ module Asciidoctor
       def formattedstr_strip(doc)
         doc.xpath("//*[@format] | //stem | //bibdata//description | "\
                   "//formattedref | //bibdata//note | //bibdata/abstract | "\
-                  "//bibitem/abstract | //bibitem/note").each do |n|
+                  "//bibitem/abstract | //bibitem/note | //misc-container").each do |n|
           n.elements.each do |e|
             e.traverse do |e1|
               e1.element? and e1.each { |k, _v| e1.delete(k) }

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.7.3".freeze
+    VERSION= "1.8.5".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,26 +28,26 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.4.2"
+  spec.add_dependency "isodoc", "~> 1.5.0"
   spec.add_dependency "iev", "~> 0.2.1"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.2.1"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
   spec.add_dependency "relaton-cli", "~> 1.7.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
-  spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
-  spec.add_dependency "mimemagic"
+  spec.add_dependency "metanorma-utils", "~> 1.0.2"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "latexmath"
+  spec.add_dependency "asciimath2unitsml", "~> 0.2.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "sassc", "2.4.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "= 0.54.0"
   spec.add_development_dependency "simplecov", "~> 0.15"

data/spec/{asciidoctor-standoc → asciidoctor}/base_spec.rb

@@ -32,7 +32,36 @@ RSpec.describe Asciidoctor::Standoc do
     expect(File.exist?("htmlstyle.css")).to be false
   end
 
-    it "processes publisher abbreviations" do
+    it "assigns default scripts to major languages" do
+    FileUtils.rm_f "test.doc"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :novalid:
+      :language: ar
+    INPUT
+    <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>ar</language>
+           <script>Arab</script>
+           <status>
+             <stage>published</stage>
+           </status>
+           <copyright>
+             <from>2021</from>
+           </copyright>
+           <ext>
+             <doctype>article</doctype>
+           </ext>
+         </bibdata>
+         <sections> </sections>
+       </standard-document>
+    OUTPUT
+  end
+
+  it "processes publisher abbreviations" do
     mock_org_abbrevs
     expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title

data/spec/{asciidoctor-standoc → asciidoctor}/cleanup_spec.rb

@@ -3,6 +3,170 @@ require "relaton_iec"
 require "fileutils"
 
 RSpec.describe Asciidoctor::Standoc do
+ it "processes svgmap" do
+   FileUtils.cp "spec/fixtures/action_schemaexpg1.svg", "action_schemaexpg1.svg"
+   FileUtils.cp "spec/fixtures/action_schemaexpg1.svg", "action_schemaexpg2.svg"
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+#{ASCIIDOC_BLANK_HDR}
+
+[svgmap]
+====
+* <<ref1,Computer>>; http://www.example.com
+====
+
+[[ref1]]
+[.svgmap]
+====
+image::action_schemaexpg1.svg[]  
+
+* <<ref1,Computer>>; mn://action_schema
+* http://www.example.com[Phone]; http://www.example.com
+====
+      
+[svgmap]
+====
+[alt=Workmap]
+image::action_schemaexpg2.svg[]  
+
+* <<ref1,Computer>>; href1.htm
+* http://www.example.com[Phone]; mn://basic_attribute_schema
+* <<express:action_schema:action_schema.basic,Coffee>>; mn://support_resource_schema
+====
+INPUT
+       #{BLANK_HDR}
+       <sections>
+  <svgmap id='_'>
+    <target href='http://www.example.com'>
+      <xref target='ref1'>Computer</xref>
+    </target>
+  </svgmap>
+  <figure id='_'>
+  <image src='action_schemaexpg1.svg' id='_' mimetype='image/svg+xml' height='auto' width='auto'/>
+</figure>
+<svgmap id='_'>
+  <figure id='_'>
+    <image src='action_schemaexpg2.svg' id='_' mimetype='image/svg+xml' height='auto' width='auto' alt='Workmap'/>
+  </figure>
+    <target href='mn://support_resource_schema'>
+      <eref bibitemid='express_action_schema' citeas=''>
+        <localityStack>
+          <locality type='anchor'>
+            <referenceFrom>action_schema.basic</referenceFrom>
+          </locality>
+        </localityStack>
+        Coffee
+      </eref>
+    </target>
+  </svgmap>
+</sections>
+<bibliography>
+  <references hidden='true' normative='false'>
+    <bibitem id='express_action_schema' type='internal'>
+      <docidentifier type='repository'>express/action_schema</docidentifier>
+    </bibitem>
+  </references>
+</bibliography>
+       </standard-document>
+OUTPUT
+expect(xmlpp(File.read("action_schemaexpg1.svg", encoding: "utf-8").sub(%r{<image .*</image>}m, ""))).to be_equivalent_to <<~OUTPUT
+<?xml version='1.0' encoding='UTF-8'?>
+       <!-- Generator: Adobe Illustrator 25.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+       <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' version='1.1' id='Layer_1' x='0px' y='0px' viewBox='0 0 595.28 841.89' style='enable-background:new 0 0 595.28 841.89;' xml:space='preserve'>
+         <style type='text/css'> .st0{fill:none;stroke:#000000;stroke-miterlimit:10;} </style>
+         <a xlink:href='#ref1'>
+           <rect x='123.28' y='273.93' class='st0' width='88.05' height='41.84'/>
+         </a>
+         <a xlink:href='mn://basic_attribute_schema'>
+           <rect x='324.69' y='450.52' class='st0' width='132.62' height='40.75'/>
+         </a>
+         <a xlink:href='mn://support_resource_schema'>
+           <rect x='324.69' y='528.36' class='st0' width='148.16' height='40.75'/>
+         </a>
+       </svg>
+OUTPUT
+expect(xmlpp(File.read("action_schemaexpg2.svg", encoding: "utf-8").sub(%r{<image .*</image>}m, ""))).to be_equivalent_to <<~OUTPUT
+<?xml version='1.0' encoding='UTF-8'?>
+       <!-- Generator: Adobe Illustrator 25.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+       <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' version='1.1' id='Layer_1' x='0px' y='0px' viewBox='0 0 595.28 841.89' style='enable-background:new 0 0 595.28 841.89;' xml:space='preserve'>
+         <style type='text/css'> .st0{fill:none;stroke:#000000;stroke-miterlimit:10;} </style>
+         <a xlink:href='mn://action_schema'>
+           <rect x='123.28' y='273.93' class='st0' width='88.05' height='41.84'/>
+         </a>
+         <a xlink:href='http://www.example.com'>
+           <rect x='324.69' y='450.52' class='st0' width='132.62' height='40.75'/>
+         </a>
+         <a xlink:href='mn://support_resource_schema'>
+           <rect x='324.69' y='528.36' class='st0' width='148.16' height='40.75'/>
+         </a>
+       </svg>
+OUTPUT
+ end
+
+    it "processes markup in sourcecode" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      
+      [source]
+      ----
+      <tag/>
+      ----
+
+      [[A]]
+      [source]
+      ----
+      var {{{*x*}}} : {{{<<A,recursive>>}}} <tag/>
+      ----
+
+
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+  <sourcecode id='_'>&lt;tag/&gt;</sourcecode>
+  <sourcecode id='A'>
+    var
+    <strong>x</strong>
+     :
+    <xref target='A'>recursive</xref>
+     &lt;tag/&gt;
+  </sourcecode>
+</sections>
+       </standard-document>
+    OUTPUT
+  end
+
+       it "processes markup in sourcecode with custom delimiters" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :sourcecode-markup-start: [[[
+      :sourcecode-markup-end: ]]]
+
+      [[A]]
+      [source]
+      ----
+      var [[[*x*]]] : [[[<<A,recursive>>]]]
+      ----
+
+
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+  <sourcecode id='A'>
+    var
+    <strong>x</strong>
+     :
+    <xref target='A'>recursive</xref>
+  </sourcecode>
+</sections>
+       </standard-document>
+    OUTPUT
+  end
+
+
   it "applies smartquotes by default" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -1597,7 +1761,7 @@ it "sorts symbols lists" do
   == Symbols and abbreviated terms
 
   α:: Definition 1
-  xa:: Definition 2
+  Xa:: Definition 2
   x_1_:: Definition 3
   x_m_:: Definition 4
   x:: Definition 5
@@ -1635,7 +1799,7 @@ it "sorts symbols lists" do
         <dd>
           <p id='_'>Definition 3</p>
         </dd>
-        <dt>xa</dt>
+        <dt>Xa</dt>
         <dd>
           <p id='_'>Definition 2</p>
         </dd>
@@ -1867,6 +2031,8 @@ input = <<~INPUT
 <<1:>>
 <<1#b>>
 <<:a#b:>>
+<</%ab>>
+<<1!>>
 
 INPUT
 expect(xmlpp(Asciidoctor.convert(input, backend: :standoc, header_footer: true).gsub(/<p id="_[^"]+">/, "").gsub('</p>', ""))).to be_equivalent_to (<<~"OUTPUT")
@@ -1888,18 +2054,27 @@ expect(xmlpp(Asciidoctor.convert(input, backend: :standoc, header_footer: true).
   <sections>
   <clause id='a_b' inline-header='false' obligation='normative'>
              <title>A</title>
-             <xref target='__ab'/>
+             <eref bibitemid='__ab' citeas=''/>
              <xref target='_'/>
              <xref target='_1'/>
              <xref target='_1_'/>
              <xref target='1#b'/>
              <xref target='_a#b_'/>
+             <xref target='_%ab'/>
+             <xref target='_1_'/>
            </clause>
   </sections>
+  <bibliography>
+  <references hidden='true' normative='false'>
+    <bibitem id='__ab' type='internal'>
+      <docidentifier type='repository'>//ab</docidentifier>
+    </bibitem>
+  </references>
+</bibliography>
 </standard-document>
 OUTPUT
 expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <clause id="a_b" inline-header="false" obligation="normative"/> from a:b}).to_stderr
-expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <xref target="__ab"/> from /:ab}).to_stderr
+expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <eref bibitemid="__ab" citeas=""/> from /_ab}).to_stderr
 expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <xref target="_"/> from :}).to_stderr
 expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <xref target="_1"/> from 1}).to_stderr
 expect{Asciidoctor.convert(input, backend: :standoc, header_footer: true)}.to output(%r{normalised identifier in <xref target="_1_"/> from 1:}).to_stderr
@@ -1943,6 +2118,123 @@ expect(xmlpp(Asciidoctor.convert(input, backend: :standoc, header_footer: true))
 OUTPUT
 
 end
+
+it "converts UnitsML to MathML" do
+  expect(xmlpp(strip_guid(Asciidoctor.convert(<<~INPUT, backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+= Document title
+Author
+:stem:
+
+[stem]
+++++
+<math xmlns='http://www.w3.org/1998/Math/MathML'>
+  <mrow>
+  <mn>7</mn>
+  <mtext>unitsml(m*kg^-2)</mtext>
+  <mo>+</mo>
+  <mn>8</mn>
+  <mtext>unitsml(m*kg^-2)</mtext>
+  </mrow>
+</math>
+++++
+INPUT
+#{BLANK_HDR}
+<misc-container>
+           <UnitsML xmlns='http://unitsml.nist.gov/2005'>
+             <UnitSet>
+               <Unit xml:id='U_m.kg-2' dimensionURL='#D_LM-2'>
+                 <UnitSystem name='SI' type='SI_derived' xml:lang='en-US'/>
+                 <UnitName xml:lang='en'>m*kg^-2</UnitName>
+                 <UnitSymbol type='HTML'>
+                   m&#160;kg
+                   <sup>&#8722;2</sup>
+                 </UnitSymbol>
+                 <UnitSymbol type='MathML'>
+                   <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                     <mrow>
+                       <mi mathvariant='normal'>m</mi>
+                       <mo rspace='thickmathspace'>&#8290;</mo>
+                       <msup>
+                         <mrow>
+                           <mi mathvariant='normal'>kg</mi>
+                         </mrow>
+                         <mrow>
+                           <mo>&#8722;</mo>
+                           <mn>2</mn>
+                         </mrow>
+                       </msup>
+                     </mrow>
+                   </math>
+                 </UnitSymbol>
+                 <RootUnits>
+                   <EnumeratedRootUnit unit='meter'/>
+                   <EnumeratedRootUnit unit='gram' prefix='k' powerNumerator='-2'/>
+                 </RootUnits>
+               </Unit>
+             </UnitSet>
+             <DimensionSet>
+               <Dimension xml:id='D_LM-2'>
+                 <Length symbol='L' powerNumerator='1'/>
+                 <Mass symbol='M' powerNumerator='-2'/>
+               </Dimension>
+             </DimensionSet>
+             <PrefixSet>
+               <Prefix prefixBase='10' prefixPower='3' xml:id='NISTp10_3'>
+                 <PrefixName xml:lang='en'>kilo</PrefixName>
+                 <PrefixSymbol type='ASCII'>k</PrefixSymbol>
+                 <PrefixSymbol type='unicode'>k</PrefixSymbol>
+                 <PrefixSymbol type='LaTeX'>k</PrefixSymbol>
+                 <PrefixSymbol type='HTML'>k</PrefixSymbol>
+               </Prefix>
+             </PrefixSet>
+           </UnitsML>
+         </misc-container>
+         <sections>
+           <formula id='_'>
+             <stem type='MathML'>
+               <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                 <mrow>
+                   <mn>7</mn>
+                   <mo rspace='thickmathspace'>&#8290;</mo>
+                   <mrow xref='U_m.kg-2'>
+                     <mi mathvariant='normal'>m</mi>
+                     <mo rspace='thickmathspace'>&#8290;</mo>
+                     <msup>
+                       <mrow>
+                         <mi mathvariant='normal'>kg</mi>
+                       </mrow>
+                       <mrow>
+                         <mo>&#8722;</mo>
+                         <mn>2</mn>
+                       </mrow>
+                     </msup>
+                   </mrow>
+                   <mo>+</mo>
+                   <mn>8</mn>
+                   <mo rspace='thickmathspace'>&#8290;</mo>
+                   <mrow xref='U_m.kg-2'>
+                     <mi mathvariant='normal'>m</mi>
+                     <mo rspace='thickmathspace'>&#8290;</mo>
+                     <msup>
+                       <mrow>
+                         <mi mathvariant='normal'>kg</mi>
+                       </mrow>
+                       <mrow>
+                         <mo>&#8722;</mo>
+                         <mn>2</mn>
+                       </mrow>
+                     </msup>
+                   </mrow>
+                 </mrow>
+               </math>
+             </stem>
+           </formula>
+         </sections>
+       </standard-document>
+OUTPUT
+
+end
+
 it "customises italicisation of MathML" do
 input = <<~INPUT
 = Document title
@@ -2109,6 +2401,118 @@ mock_mathml_italicise({ uppergreek: true, upperroman: true, lowergreek: true, lo
 
 end
 
+  it "process express_ref macro with existing bibliography" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true, agree_to_terms: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      == Clause
+
+      <<uml:A:A.B.C,C>>
+      <<uml:A>>
+      <<express-schema:action:action.AA,AA>>
+      <<express-schema:action:action.AB>>
+
+      [[action]]
+      [type="express-schema"]
+      == Action
+
+      [[action.AA]]
+      === AA
+
+      [bibliography]
+      == Bibliography
+      * [[[D,E]]] F
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+             <p id='_'>
+               <eref bibitemid='uml_A' citeas="">
+               <localityStack>
+                 <locality type='anchor'><referenceFrom>A.B.C</referenceFrom></locality>
+               </localityStack>
+                 C
+               </eref>
+               <eref bibitemid='uml_A' citeas=""/>
+               <xref target='action.AA'>AA</xref>
+<xref target='action'>** Missing target action.AB</xref>
+             </p>
+           </clause>
+           <clause id='action' type='express-schema' inline-header='false' obligation='normative'>
+  <title>Action</title>
+  <clause id='action.AA' inline-header='false' obligation='normative'>
+    <title>AA</title>
+  </clause>
+</clause>
+         </sections>
+         <bibliography>
+           <references id='_' normative='false' obligation='informative'>
+             <title>Bibliography</title>
+             <bibitem id='D'>
+               <formattedref format='application/x-isodoc+xml'>F</formattedref>
+               <docidentifier>E</docidentifier>
+             </bibitem>
+           </references>
+           <references hidden='true' normative='false'>
+             <bibitem id='uml_A' type='internal'>
+               <docidentifier type='repository'>uml/A</docidentifier>
+             </bibitem>
+           </references>
+         </bibliography>
+</standard-document>
+    OUTPUT
+  end
+
+
+  it "process express_ref macro with no existing bibliography" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true, agree_to_terms: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      [[B]]
+      [type="express-schema"]
+      == Clause
+
+      [[B1]]
+      NOTE: X
+
+      <<express-schema:A:A.B.C,C>>
+      <<express-schema:A>>
+      <<express-schema:B>>
+      <<express-schema:B1>>
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+       <clause id='B' type='express-schema' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+             <note id='B1'>
+               <p id='_'>X</p>
+             </note>
+             <p id='_'>
+               <eref bibitemid='express-schema_A' citeas=''>
+                 <localityStack>
+                   <locality type='anchor'>
+                     <referenceFrom>A.B.C</referenceFrom>
+                   </locality>
+                 </localityStack>
+                 C
+               </eref>
+               <eref bibitemid='express-schema_A' citeas=''/>
+               <xref target='B'/>
+               <xref target='B1'/>
+             </p>
+           </clause>
+         </sections>
+         <bibliography>
+           <references hidden='true' normative='false'>
+             <bibitem id='express-schema_A' type='internal'>
+               <docidentifier type='repository'>express-schema/A</docidentifier>
+             </bibitem>
+           </references>
+         </bibliography>
+</standard-document>
+    OUTPUT
+  end
+
+
   private
 
   def mock_mathml_italicise(x)
@@ -2230,6 +2634,4 @@ OUTPUT
     end.at_least :once
 end
 
-
-
 end