metanorma-standoc 1.11.1 → 2.0.0

data/metanorma-standoc.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
-  spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "isodoc", "~> 1.8.0"
+  spec.add_dependency "iev", "~> 0.3.0"
+  spec.add_dependency "isodoc", "~> 2.0.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
@@ -37,12 +37,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "metanorma-utils", "~> 1.2.0"
+  spec.add_dependency "metanorma-utils", "~> 1.2.8"
   spec.add_dependency "relaton-cli", "~> 1.9.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

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

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Standoc do
+RSpec.describe Metanorma::Standoc do
   it "has a version number" do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
@@ -26,7 +26,7 @@ RSpec.describe Asciidoctor::Standoc do
                <stage>published</stage>
              </status>
              <copyright>
-               <from>2021</from>
+               <from>#{Time.now.year}</from>
              </copyright>
              <ext>
                <doctype>article</doctype>
@@ -222,6 +222,9 @@ RSpec.describe Asciidoctor::Standoc do
       :isbn: ISBN-13
       :isbn10: ISBN-10
       :classification: a:b, c
+      :toclevels: 2
+      :doctoclevels: 3
+      :htmltoclevels: 4
     INPUT
     output = <<~OUTPUT
           <?xml version="1.0" encoding="UTF-8"?>
@@ -481,6 +484,20 @@ RSpec.describe Asciidoctor::Standoc do
         </ics>
         </ext>
       </bibdata>
+       <misc-container>
+   <presentation-metadata>
+     <name>TOC Heading Levels</name>
+     <value>2</value>
+   </presentation-metadata>
+   <presentation-metadata>
+     <name>TOC Heading Levels</name>
+     <value>2</value>
+   </presentation-metadata>
+   <presentation-metadata>
+     <name>TOC Heading Levels</name>
+     <value>2</value>
+   </presentation-metadata>
+ </misc-container>
       <sections/>
       </standard-document>
     OUTPUT
@@ -742,7 +759,7 @@ RSpec.describe Asciidoctor::Standoc do
             <stage>published</stage>
           </status>
           <copyright>
-            <from>2021</from>
+            <from>#{Time.now.year}</from>
           </copyright>
           <ext>
             <doctype>article</doctype>
@@ -849,6 +866,47 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes document relations by description" do
+    mock_relaton_relation_descriptions
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :normatively-cited-in: ABC
+
+    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>
+        <relation type='isCitedIn'>
+          <description>normatively cited in</description>
+          <bibitem>
+            <title>--</title>
+            <docidentifier>ABC</docidentifier>
+          </bibitem>
+        </relation>
+        <ext>
+          <doctype>article</doctype>
+        </ext>
+      </bibdata>
+      <sections> </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "reads scripts into blank HTML document" do
     FileUtils.rm_f "test.html"
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
@@ -959,21 +1017,21 @@ QU1FOiB0ZXN0Cgo=
 
   it "process mn2pdf attributes" do
     node = Nokogiri::XML("<fake/>").at("fake")
-    node[Asciidoctor::Standoc::Base::FONTS_MANIFEST] =
+    node[Metanorma::Standoc::Base::FONTS_MANIFEST] =
       "passed/as/font/manifest/to/mn2pdf.jar"
 
-    options = Asciidoctor::Standoc::Converter
+    options = Metanorma::Standoc::Converter
       .new(:standoc, header_footer: true)
       .doc_extract_attributes(node)
 
     expect(options.dig(:mn2pdf, :font_manifest))
-      .to eq(node[Asciidoctor::Standoc::Base::FONTS_MANIFEST])
+      .to eq(node[Metanorma::Standoc::Base::FONTS_MANIFEST])
   end
 
   private
 
   def mock_org_abbrevs
-    allow_any_instance_of(::Asciidoctor::Standoc::Front)
+    allow_any_instance_of(::Metanorma::Standoc::Front)
       .to receive(:org_abbrev).and_return(
         { "International Standards Organization" => "ISO",
           "International Electrotechnical Commission" => "IEC" },
@@ -981,9 +1039,16 @@ QU1FOiB0ZXN0Cgo=
   end
 
   def mock_default_publisher
-    allow_any_instance_of(::Asciidoctor::Standoc::Front)
+    allow_any_instance_of(::Metanorma::Standoc::Front)
       .to receive(:default_publisher).and_return(
         "International Standards Organization",
       )
   end
+
+  def mock_relaton_relation_descriptions
+    allow_any_instance_of(::Metanorma::Standoc::Front)
+      .to receive(:relaton_relation_descriptions).and_return(
+        "normatively-cited-in" => "isCitedIn",
+      )
+  end
 end

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}
@@ -355,7 +355,7 @@ RSpec.describe Asciidoctor::Standoc do
              <term id='term-term1'>
                <preferred><expression><name>Term1</name></expression></preferred>
                <definition>
-                 <verbaldefinition>
+                 <verbal-definition>
                  <p id='_'>first definition</p>
                  <termsource status='identical' type="authoritative">
                    <origin bibitemid='ISO2191' type='inline' citeas=''>
@@ -366,10 +366,10 @@ RSpec.describe Asciidoctor::Standoc do
                      </localityStack>
                    </origin>
                  </termsource>
-                 </verbaldefinition>
+                 </verbal-definition>
                </definition>
                <definition>
-               <verbaldefinition>
+               <verbal-definition>
                  <p id='_'>second definition</p>
                  <termsource status='identical' type="authoritative">
                    <origin bibitemid='ISO2191' type='inline' citeas=''>
@@ -380,7 +380,7 @@ RSpec.describe Asciidoctor::Standoc do
                      </localityStack>
                    </origin>
                  </termsource>
-                 </verbaldefinition>
+                 </verbal-definition>
                </definition>
                <termnote id='_'>
                  <p id='_'>This is a note</p>
@@ -550,9 +550,9 @@ RSpec.describe Asciidoctor::Standoc do
                    </expression>
                  </preferred>
                  <definition>
-                   <verbaldefinition>
+                   <verbal-definition>
                      <p id='_'>definition2</p>
-                   </verbaldefinition>
+                   </verbal-definition>
                  </definition>
                  <termnote id='_'>
                    <p id='_'>Note 2</p>
@@ -1254,7 +1254,7 @@ RSpec.describe Asciidoctor::Standoc do
              the following terms and definitions apply.</p>
                <term id="term-term1">
                <preferred><expression><name>Term1</name></expression></preferred>
-               <definition><verbaldefinition><p id='_'>Definition 0</p></verbaldefinition></definition>
+               <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
                <termsource status="identical" type="authoritative">
                <origin bibitemid="ISO2191" type="inline" citeas="">
                <localityStack>
@@ -1273,9 +1273,9 @@ RSpec.describe Asciidoctor::Standoc do
              <term id='term-term2'>
         <preferred><expression><name>Term2</name></expression></preferred>
         <definition>
-        <verbaldefinition>
+        <verbal-definition>
           <p id='_'>Definition</p>
-          </verbaldefinition>
+          </verbal-definition>
         </definition>
         <termsource status='identical' type="authoritative">
           <origin citeas=''>
@@ -1329,7 +1329,7 @@ RSpec.describe Asciidoctor::Standoc do
              the following terms and definitions apply.</p>
                <term id="term-term1">
                <preferred><expression><name>Term1</name></expression></preferred>
-               <definition><verbaldefinition><p id='_'>Definition 0</p></verbaldefinition></definition>
+               <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
                <termsource status="modified" type="authoritative">
                <origin bibitemid="ISO2191" type="inline" citeas="">
                <localityStack>
@@ -1343,9 +1343,9 @@ RSpec.describe Asciidoctor::Standoc do
              </term>
              <term id='term-term2'>
         <preferred><expression><name>Term2</name></expression></preferred>
-        <definition><verbaldefinition>
+        <definition><verbal-definition>
           <p id='_'>Definition</p>
-        </verbaldefinition></definition>
+        </verbal-definition></definition>
         <termsource status='modified' type="authoritative">
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
@@ -1395,7 +1395,7 @@ RSpec.describe Asciidoctor::Standoc do
             <name>Term1</name>
           </expression>
         </preferred>
-        <definition><verbaldefinition><p id='_'>Definition 0</p></verbaldefinition></definition>
+        <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
         <termsource status='generalisation' type='authoritative'>
           <origin bibitemid='ISO2191' type='inline' citeas=''>
             <localityStack>
@@ -1415,9 +1415,9 @@ RSpec.describe Asciidoctor::Standoc do
             <name>Term2</name>
           </expression>
         </preferred>
-        <definition><verbaldefinition>
+        <definition><verbal-definition>
           <p id='_'>Definition</p>
-        </verbaldefinition></definition>
+        </verbal-definition></definition>
         <termsource status='modified' type='lineage'>
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
@@ -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}
@@ -29,7 +29,7 @@ RSpec.describe Asciidoctor::Standoc do
       </ul>
              <term id="term-time">
              <preferred><expression><name>Time</name></expression></preferred>
-               <definition><verbaldefinition><p id="_">This paragraph is extraneous</p></verbaldefinition></definition>
+               <definition><verbal-definition><p id="_">This paragraph is extraneous</p></verbal-definition></definition>
              </term></terms>
              </sections>
              </standard-document>

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}
@@ -426,7 +426,7 @@ RSpec.describe Asciidoctor::Standoc do
         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
         <term id="term-term1">
         <preferred><expression><name>Term1</name></expression></preferred>
-        <definition><verbaldefinition><p id='_'>Definition 0</p></verbaldefinition></definition>
+        <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
         <termsource status="identical" type="authoritative">
         <origin bibitemid="ISO2191" type="inline" citeas="">
         <localityStack>
@@ -545,7 +545,7 @@ RSpec.describe Asciidoctor::Standoc do
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="term-automation1">
           <preferred><expression><name>Automation1</name></expression></preferred>
-          <definition><verbaldefinition><p id='_'>Definition 1</p></verbaldefinition></definition>
+          <definition><verbal-definition><p id='_'>Definition 1</p></verbal-definition></definition>
           <termsource status="identical" type="authoritative">
           <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009">
           <localityStack>
@@ -556,7 +556,7 @@ RSpec.describe Asciidoctor::Standoc do
         </term>
         <term id="term-automation2">
           <preferred><expression><name>Automation2</name></expression></preferred>
-          <definition><verbaldefinition><p id='_'>Definition 2</p></verbaldefinition></definition>
+          <definition><verbal-definition><p id='_'>Definition 2</p></verbal-definition></definition>
           <termsource status="identical" type="authoritative">
           <origin bibitemid="IEC60050-102" type="inline" citeas="IEC 60050-102:2007">
           <localityStack>
@@ -567,7 +567,7 @@ RSpec.describe Asciidoctor::Standoc do
         </term>
         <term id="term-automation3">
           <preferred><expression><name>Automation3</name></expression></preferred>
-          <definition><verbaldefinition><p id='_'>Definition 3</p></verbaldefinition></definition>
+          <definition><verbal-definition><p id='_'>Definition 3</p></verbal-definition></definition>
           <termsource status="identical" type="authoritative">
           <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009">
           <localityStack>
@@ -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