metanorma-standoc 2.1.0 → 2.1.3

data/lib/metanorma/standoc/macros_note.rb

@@ -18,15 +18,10 @@ module Metanorma
         (document.find_by context: :paragraph).each do |para|
           next unless /^TODO: /.match? para.lines[0]
 
-          parent = para.parent
           para.set_attr("name", "todo")
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
-          todo = Asciidoctor::Block
-            .new(parent, :admonition, attributes: para.attributes,
-                                      source: para.lines,
-                                      content_model: :compound)
-          parent.blocks[parent.blocks.index(para)] = todo
+          para.context = :admonition
         end
       end
     end

data/lib/metanorma/standoc/ref_sect.rb

@@ -84,7 +84,8 @@ module Metanorma
         if ref[:code].nil? || ref[:no_year] || @bibdb.nil?
           res << [ref, idx, nil]
         else
-          @bibdb.fetch_async(ref[:code], ref[:year], ref) do |doc|
+          @bibdb.fetch_async(HTMLEntities.new.decode(ref[:code]),
+                             ref[:year], ref) do |doc|
             res << [ref, idx, doc]
           end
         end

data/lib/metanorma/standoc/reqt.rb

@@ -64,14 +64,16 @@ module Metanorma
       def requirement_elems(node, out)
         node.title and out.title { |t| t << node.title }
         a = node.attr("label") and out.label do |l|
-          l << a
+          l << out.text(a)
         end
         a = node.attr("subject") and csv_split(a)&.each do |subj|
-          out.subject { |s| s << subj }
+          out.subject { |s| s << out.text(subj) }
         end
         a = HTMLEntities.new.decode(node.attr("inherit")) and
           csv_split(a)&.each do |i|
-            out.inherit { |inh| inh << i }
+            out.inherit do |inh|
+              inh << HTMLEntities.new.encode(i, :hexadecimal)
+            end
           end
         classif = node.attr("classification") and
           requirement_classification(classif, out)

data/lib/metanorma/standoc/section.rb

@@ -152,7 +152,7 @@ module Metanorma
         attrs[:bibitem] = true if node.option? "bibitem"
         attrs[:level] = node.attr("level")
         set_obligation(attrs, node)
-        xml.send "clause", **attr_code(attrs) do |xml_section|
+        xml.send :clause, **attr_code(attrs) do |xml_section|
           xml_section.title { |n| n << node.title } unless node.title.nil?
           xml_section << node.content
         end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.1.0".freeze
+    VERSION = "2.1.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-utils", "~> 1.2.8"
-  spec.add_dependency "relaton-cli", "~> 1.9.0"
+  spec.add_dependency "relaton-cli", "~> 1.11.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 
@@ -46,7 +46,7 @@ Gem::Specification.new do |spec|
   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 "metanorma-iso"
+  spec.add_development_dependency "metanorma-iso", "~>2.1.2"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"

data/spec/metanorma/base_spec.rb

@@ -6,6 +6,42 @@ RSpec.describe Metanorma::Standoc do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
 
+  it "processes named entities" do
+    FileUtils.rm_f "test.doc"
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :novalid:
+      :no-pdf:
+
+      Text &times; text
+    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>standard</doctype>
+          </ext>
+        </bibdata>
+        <sections>
+        <p id='_'>Text × text</p>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "assigns default scripts to major languages" do
     FileUtils.rm_f "test.doc"
     input = <<~INPUT
@@ -29,7 +65,7 @@ RSpec.describe Metanorma::Standoc do
                <from>#{Time.now.year}</from>
              </copyright>
              <ext>
-               <doctype>article</doctype>
+               <doctype>standard</doctype>
              </ext>
            </bibdata>
            <sections> </sections>
@@ -125,7 +161,7 @@ RSpec.describe Metanorma::Standoc do
             </owner>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
         <sections> </sections>
@@ -468,7 +504,7 @@ RSpec.describe Metanorma::Standoc do
            <keyword>b</keyword>
            <keyword>c</keyword>
            <ext>
-           <doctype>article</doctype>
+           <doctype>standard</doctype>
              <editorialgroup>
                <technical-committee number="1" type="A">TC</technical-committee>
                <technical-committee number="11" type="A1">TC1</technical-committee>
@@ -789,7 +825,7 @@ RSpec.describe Metanorma::Standoc do
             <from>#{Time.now.year}</from>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
         <sections> </sections>
@@ -924,7 +960,7 @@ RSpec.describe Metanorma::Standoc do
           </bibitem>
         </relation>
         <ext>
-          <doctype>article</doctype>
+          <doctype>standard</doctype>
         </ext>
       </bibdata>
       <sections> </sections>

data/spec/metanorma/blocks_spec.rb

@@ -304,7 +304,7 @@ RSpec.describe Metanorma::Standoc do
            <from>#{Date.today.year}</from>
          </copyright>
          <ext>
-         <doctype>article</doctype>
+         <doctype>standard</doctype>
          </ext>
        </bibdata>
        <sections><p id="foreword">Foreword</p>
@@ -440,6 +440,32 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes term notes outside of terms sections" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Clause
+
+      [NOTE%termnote]
+      ====
+      XYZ
+      ====
+    INPUT
+    output = <<~OUTPUT
+                   #{BLANK_HDR}
+            <sections>
+                <clause id='_' inline-header='false' obligation='normative'>
+      <title>Clause</title>
+      <termnote id='_'>
+        <p id='_'>XYZ</p>
+      </termnote>
+    </clause>
+            </sections>
+            </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes term notes as plain notes in nonterm clauses" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -722,6 +748,32 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes term examples outside of terms sections" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Clause
+
+      [%termexample]
+      ====
+      XYZ
+      ====
+    INPUT
+    output = <<~OUTPUT
+                   #{BLANK_HDR}
+            <sections>
+                <clause id='_' inline-header='false' obligation='normative'>
+      <title>Clause</title>
+      <termexample id='_'>
+        <p id='_'>XYZ</p>
+      </termexample>
+    </clause>
+            </sections>
+            </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes term examples as plain examples in nonterm clauses" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/metanorma/cleanup_sections_spec.rb

@@ -467,7 +467,7 @@ RSpec.describe Metanorma::Standoc do
                    <from>#{Time.now.year}</from>
                  </copyright>
                  <ext>
-                   <doctype>article</doctype>
+                   <doctype>standard</doctype>
                  </ext>
                </bibdata>
                <preface>
@@ -762,7 +762,7 @@ RSpec.describe Metanorma::Standoc do
                     <from>#{Time.now.year}</from>
                   </copyright>
                   <ext>
-                    <doctype>article</doctype>
+                    <doctype>standard</doctype>
                   </ext>
                 </bibdata>
                 <preface>
@@ -996,7 +996,7 @@ RSpec.describe Metanorma::Standoc do
                     <from>#{Time.now.year}</from>
                   </copyright>
                   <ext>
-                    <doctype>article</doctype>
+                    <doctype>standard</doctype>
                   </ext>
                 </bibdata>
                 <preface>
@@ -1233,7 +1233,7 @@ RSpec.describe Metanorma::Standoc do
                     <from>#{Time.now.year}</from>
                   </copyright>
                   <ext>
-                    <doctype>article</doctype>
+                    <doctype>standard</doctype>
                   </ext>
                 </bibdata>
                 <preface>
@@ -1467,7 +1467,7 @@ RSpec.describe Metanorma::Standoc do
                     <from>#{Time.now.year}</from>
                   </copyright>
                   <ext>
-                    <doctype>article</doctype>
+                    <doctype>standard</doctype>
                   </ext>
                 </bibdata>
                 <preface>

data/spec/metanorma/cleanup_spec.rb

@@ -1042,7 +1042,7 @@ RSpec.describe Metanorma::Standoc do
             </bibitem>
           </relation>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
         <sections> </sections>
@@ -1085,7 +1085,7 @@ RSpec.describe Metanorma::Standoc do
             <from>#{Date.today.year}</from>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
         <boilerplate>
@@ -1281,7 +1281,7 @@ RSpec.describe Metanorma::Standoc do
             <from>#{Time.now.year}</from>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
                  <sections>
@@ -1299,7 +1299,7 @@ RSpec.describe Metanorma::Standoc do
              <sourcecode id='L__xf6_we'>
                <name>
                  See
-                 <eref type='inline' bibitemid='L__xf6_wner2016' citeas='L&amp;#xf6;wner et al. 2016'/>
+                 <eref type='inline' bibitemid='L__xf6_wner2016' citeas='Löwner et al. 2016'/>
                </name>
                ABC
              </sourcecode>
@@ -1382,7 +1382,7 @@ RSpec.describe Metanorma::Standoc do
                    <from>#{Time.now.year}</from>
                  </copyright>
                  <ext>
-                   <doctype>article</doctype>
+                   <doctype>standard</doctype>
                  </ext>
                </bibdata>
                <sections> </sections>
@@ -1836,7 +1836,7 @@ RSpec.describe Metanorma::Standoc do
              <from>#{Time.now.year}</from>
            </copyright>
            <ext>
-             <doctype>article</doctype>
+             <doctype>standard</doctype>
            </ext>
          </bibdata>
          <preface>

data/spec/metanorma/cleanup_terms_spec.rb

@@ -1430,7 +1430,7 @@ RSpec.describe Metanorma::Standoc do
             <from>#{Time.now.year}</from>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
         </bibdata>
         <sections>

data/spec/metanorma/inline_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Metanorma::Standoc do
       <from>#{Date.today.year}</from>
       </copyright>
       <ext>
-      <doctype>article</doctype>
+      <doctype>standard</doctype>
       </ext>
       </bibdata>
       <sections>
@@ -685,13 +685,13 @@ RSpec.describe Metanorma::Standoc do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
-      pass-format:rfc,html[<abc>X &gt; Y</abc>]
+      pass-format:rfc,html[<abc>X &gt; Y</abc> http://www.example.com (c)]
     INPUT
     output = <<~OUTPUT
        #{BLANK_HDR}
       <sections>
       <p id='_'>
-      <passthrough formats='rfc,html'>&lt;abc&gt;X &gt; Y&lt;/abc&gt;</passthrough>
+      <passthrough formats='rfc,html'>&lt;abc&gt;X &gt; Y&lt;/abc&gt; http://www.example.com (c)</passthrough>
       </p>
       </sections>
       </standard-document>

data/spec/metanorma/lists_spec.rb

@@ -4,6 +4,7 @@ RSpec.describe Metanorma::Standoc do
   it "processes simple lists" do
     output = Asciidoctor.convert(<<~"INPUT", *OPTIONS)
       #{ASCIIDOC_BLANK_HDR}
+      .Unordered list
       * List 1
       * List 2
       * List 3
@@ -12,10 +13,12 @@ RSpec.describe Metanorma::Standoc do
       * [x] also checked
       * [ ] not checked
 
+      .Ordered list
       . List A
       . List B
       . List C
 
+      .Definition list
       List D:: List E
       List F:: List G
 
@@ -24,6 +27,7 @@ RSpec.describe Metanorma::Standoc do
         #{BLANK_HDR}
         <sections>
           <ul id='_'>
+            <name>Unordered list</name>
             <li>
               <p id='_'>List 1</p>
             </li>
@@ -41,7 +45,10 @@ RSpec.describe Metanorma::Standoc do
             </li>
             <li uncheckedcheckbox='true' checkedcheckbox='false'>
               <p id='_'>not checked</p>
+              </li>
+              </ul>
               <ol id='_' type='arabic'>
+                <name>Ordered list</name>
                 <li>
                   <p id='_'>List A</p>
                 </li>
@@ -50,7 +57,10 @@ RSpec.describe Metanorma::Standoc do
                 </li>
                 <li>
                   <p id='_'>List C</p>
+                  </li>
+                  </ol>
                   <dl id='_'>
+                    <name>Definition list</name>
                     <dt>List D</dt>
                     <dd>
                       <p id='_'>List E</p>
@@ -60,10 +70,6 @@ RSpec.describe Metanorma::Standoc do
                       <p id='_'>List G</p>
                     </dd>
                   </dl>
-                </li>
-              </ol>
-            </li>
-          </ul>
         </sections>
       </standard-document>
     OUTPUT

data/spec/metanorma/macros_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe Metanorma::Standoc do
       inherit:[<<ref1>>]
       autonumber:table[3]
       add:[a <<clause>>] del:[B]
+      identifier:[a http://example.com]
 
       [bibliography]
       == Bibliography
@@ -36,6 +37,7 @@ RSpec.describe Metanorma::Standoc do
                       <xref target='clause'/>
                     </add>
                     <del>B</del>
+                    <identifier>a http://example.com</identifier>
         </foreword>
       </preface>
       <sections> </sections>
@@ -818,7 +820,7 @@ RSpec.describe Metanorma::Standoc do
     output = <<~OUTPUT
            #{BLANK_HDR}
            <sections><review reviewer="(Unknown)" id="_" date="#{Date.today}T00:00:00Z">
-        <p id="_"/>
+        <p id="_">Note1</p>
       </review>
       <review reviewer="(Unknown)" id="_" date="#{Date.today}T00:00:00Z">
         <p id="_">Note2</p>
@@ -1326,7 +1328,7 @@ RSpec.describe Metanorma::Standoc do
            <from>2022</from>
          </copyright>
          <ext>
-           <doctype>article</doctype>
+           <doctype>standard</doctype>
          </ext>
          <relation type='derivedFrom'>
            <bibitem>
@@ -1340,7 +1342,7 @@ RSpec.describe Metanorma::Standoc do
                <from>2022</from>
              </copyright>
              <ext>
-               <doctype>article</doctype>
+               <doctype>standard</doctype>
              </ext>
            </bibitem>
          </relation>
@@ -1384,7 +1386,7 @@ RSpec.describe Metanorma::Standoc do
             <from>2022</from>
           </copyright>
           <ext>
-            <doctype>article</doctype>
+            <doctype>standard</doctype>
           </ext>
           <relation type='derivedFrom'>
             <bibitem>
@@ -1398,7 +1400,7 @@ RSpec.describe Metanorma::Standoc do
                 <from>2022</from>
               </copyright>
               <ext>
-                <doctype>article</doctype>
+                <doctype>standard</doctype>
               </ext>
             </bibitem>
           </relation>
@@ -1436,7 +1438,7 @@ RSpec.describe Metanorma::Standoc do
              <from>2022</from>
            </copyright>
            <ext>
-             <doctype>article</doctype>
+             <doctype>standard</doctype>
            </ext>
            <relation type='derivedFrom'>
              <bibitem>
@@ -1450,7 +1452,7 @@ RSpec.describe Metanorma::Standoc do
                  <from>2022</from>
                </copyright>
                <ext>
-                 <doctype>article</doctype>
+                 <doctype>standard</doctype>
                </ext>
                <relation type='derivedFrom'>
                  <bibitem>
@@ -1464,7 +1466,7 @@ RSpec.describe Metanorma::Standoc do
                      <from>2022</from>
                    </copyright>
                    <ext>
-                     <doctype>article</doctype>
+                     <doctype>standard</doctype>
                    </ext>
                    <relation type='derivedFrom'>
                       <bibitem>
@@ -1478,7 +1480,7 @@ RSpec.describe Metanorma::Standoc do
                           <from>2022</from>
                         </copyright>
                         <ext>
-                          <doctype>article</doctype>
+                          <doctype>standard</doctype>
                         </ext>
                       </bibitem>
                     </relation>
@@ -1494,7 +1496,7 @@ RSpec.describe Metanorma::Standoc do
                           <from>2022</from>
                         </copyright>
                         <ext>
-                          <doctype>article</doctype>
+                          <doctype>standard</doctype>
                         </ext>
                       </bibitem>
                     </relation>
@@ -1557,7 +1559,7 @@ RSpec.describe Metanorma::Standoc do
            <from>2022</from>
          </copyright>
          <ext>
-           <doctype>article</doctype>
+           <doctype>standard</doctype>
          </ext>
                     <relation type='derivedFrom'>
              <bibitem>
@@ -1607,12 +1609,19 @@ RSpec.describe Metanorma::Standoc do
                  </owner>
                </copyright>
                <ext>
-                 <doctype>article</doctype>
+                 <doctype>standard</doctype>
                  <editorialgroup>
+                   <agency>ISO</agency>
                    <technical-committee/>
                    <subcommittee/>
                    <workgroup/>
                  </editorialgroup>
+                 <approvalgroup>
+           <agency>ISO</agency>
+           <technical-committee/>
+           <subcommittee/>
+           <workgroup/>
+         </approvalgroup>
                  <stagename>International standard</stagename>
                </ext>
              </bibitem>