metanorma-standoc 1.7.3 → 1.8.1

data/lib/asciidoctor/standoc/utils.rb

@@ -5,105 +5,11 @@ require "json"
 require "pathname"
 require "open-uri"
 require "uuidtools"
-require "sterile"
 require "mimemagic"
 
 module Asciidoctor
   module Standoc
     module Utils
-      class << self
-        def anchor_or_uuid(node = nil)
-          uuid = UUIDTools::UUID.random_create
-          node.nil? || node.id.nil? || node.id.empty? ? "_" + uuid : node.id
-        end
-
-        def asciidoc_sub(x)
-          return nil if x.nil?
-          return "" if x.empty?
-          d = Asciidoctor::Document.new(x.lines.entries, { header_footer: false,
-                                                           backend: :standoc })
-          b = d.parse.blocks.first
-          b.apply_subs(b.source)
-        end
-
-        def localdir(node)
-          docfile = node.attr("docfile")
-          docfile.nil? ? './' : Pathname.new(docfile).parent.to_s + '/'
-        end
-
-        # TODO needs internationalisation
-        def smartformat(n)
-          n.gsub(/ --? /, "&#8201;&#8212;&#8201;").
-            gsub(/\'(\d\d)(?=[^\u2019\'\s<]+[’\'][\p{P}\p{Z}])([\p{P}\p{Z}])/, "\u2018\\1\\2").
-            gsub(/--/, "&#8212;").smart_format.gsub(/</, "&lt;").gsub(/>/, "&gt;")
-        end
-
-        def endash_date(elem)
-          elem.traverse do |n|
-            n.text? and n.replace(n.text.gsub(/\s+--?\s+/, "&#8211;").gsub(/--/, "&#8211;"))
-          end
-        end
-
-        # Set hash value using keys path
-        # mod from https://stackoverflow.com/a/42425884
-        def set_nested_value(hash, keys, new_val)
-          key = keys[0]
-          if keys.length == 1
-            hash[key] = hash[key].is_a?(Array) ?  (hash[key] << new_val) :
-              hash[key].nil? ?  new_val : [hash[key], new_val]
-            return hash
-          end
-          if hash[key].is_a?(Array)
-            hash[key][-1] = {} if hash[key][-1].nil?
-            set_nested_value(hash[key][-1], keys[1..-1], new_val)
-          elsif hash[key].nil? || hash[key].empty?
-            hash[key] = {}
-            set_nested_value(hash[key], keys[1..-1], new_val)
-          elsif hash[key].is_a?(Hash) && !hash[key][keys[1]]
-            set_nested_value(hash[key], keys[1..-1], new_val)
-          elsif !hash[key][keys[1]]
-            hash[key] = [hash[key], {}]
-            set_nested_value(hash[key][-1], keys[1..-1], new_val)
-          else
-            set_nested_value(hash[key], keys[1..-1], new_val)
-          end
-        end
-
-        def flatten_rawtext_lines(node, result)
-          node.lines.each do |x|
-            if node.respond_to?(:context) && (node.context == :literal ||
-                node.context == :listing)
-              result << x.gsub(/</, "&lt;").gsub(/>/, "&gt;")
-            else
-              # strip not only HTML <tag>, and Asciidoc xrefs <<xref>>
-              result << x.gsub(/<[^>]*>+/, "")
-            end
-          end
-          result
-        end
-
-        # if node contains blocks, flatten them into a single line;
-        # and extract only raw text
-        def flatten_rawtext(node)
-          result = []
-          if node.respond_to?(:blocks) && node.blocks?
-            node.blocks.each { |b| result << flatten_rawtext(b) }
-          elsif node.respond_to?(:lines)
-            result = flatten_rawtext_lines(node, result)
-          elsif node.respond_to?(:text)
-            result << node.text.gsub(/<[^>]*>+/, "")
-          else
-            result << node.content.gsub(/<[^>]*>+/, "")
-          end
-          result.reject(&:empty?)
-        end
-
-        def reqt_subpart(x)
-          %w(specification measurement-target verification import label
-             subject inherit classification title).include? x
-        end
-      end
-
       def convert(node, transform = nil, opts = {})
         transform ||= node.node_name
         opts.empty? ? (send transform, node) : (send transform, node, opts)
@@ -177,14 +83,14 @@ module Asciidoctor
       SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
         "[not(ancestor::boilerplate)]".freeze
 
-       def isodoc(lang, script, i18nyaml = nil)
+      def isodoc(lang, script, i18nyaml = nil)
         conv = html_converter(EmptyAttr.new)
         i18n = conv.i18n_init(lang, script, i18nyaml)
         conv.metadata_init(lang, script, i18n)
         conv
       end
 
-       class EmptyAttr
+      class EmptyAttr
         def attr(_x)
           nil
         end

data/lib/metanorma/standoc/version.rb

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

data/metanorma-standoc.gemspec

@@ -28,16 +28,16 @@ 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 "metanorma-utils", "~> 1"
   spec.add_dependency "mimemagic"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "latexmath"

data/spec/asciidoctor-standoc/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/cleanup_spec.rb

@@ -1867,6 +1867,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 +1890,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
@@ -2109,6 +2120,104 @@ 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}
+      == Clause
+
+      <<express-schema:A:A.B.C,C>>
+      <<express-schema:A>>
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+             <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=""/>
+             </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)

data/spec/asciidoctor-standoc/isobib_cache_spec.rb

@@ -127,7 +127,7 @@ EOS
          <script>Latn</script>
          <status>
            <stage>90</stage>
-           <substage>93</substage>
+           <substage>20</substage>
          </status>
          <copyright>
            <from>2001</from>
@@ -168,7 +168,7 @@ EOS
              <script>Latn</script>
              <status>
                <stage>90</stage>
-               <substage>93</substage>
+               <substage>20</substage>
              </status>
              <copyright>
                <from>2001</from>
@@ -211,7 +211,7 @@ EOS
          <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
          <uri type="rss">https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
          <docidentifier type="ISO">ISO 123:2001</docidentifier>
-         <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:en</docidentifier>
+         <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.20:ed-3:en</docidentifier>
          <docnumber>123</docnumber>
          <date type="published">
            <on>2001-05</on>
@@ -236,7 +236,7 @@ EOS
 </abstract>
          <status>
            <stage>90</stage>
-           <substage>93</substage>
+           <substage>20</substage>
          </status>
          <copyright>
            <from>2001</from>

data/spec/asciidoctor-standoc/refs_dl_spec.rb

@@ -74,6 +74,11 @@ RSpec.describe Asciidoctor::Standoc do
 it "processes complex dl reference" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
 #{ASCIIDOC_BLANK_HDR}
+
+== Clause
+
+<<ISOTC211>>
+
 [bibliography]
 == Normative References
 
@@ -288,7 +293,14 @@ formattedref::
     INPUT
       #{BLANK_HDR}
       <sections>
-      </sections><bibliography><references id="_" obligation="informative" normative="true">
+  <clause id='_' inline-header='false' obligation='normative'>
+    <title>Clause</title>
+    <p id='_'>
+      <eref type='inline' bibitemid='ISOTC211' citeas='TC211'/>
+    </p>
+  </clause>
+      </sections>
+<bibliography><references id="_" obligation="informative" normative="true">
         <title>Normative references</title>
         #{NORM_REF_BOILERPLATE}
         <bibitem id="ISOTC211" type="standard">

data/spec/asciidoctor-standoc/refs_spec.rb

@@ -264,7 +264,7 @@ RSpec.describe Asciidoctor::Standoc do
                <script>Latn</script>
                <status>
                  <stage>90</stage>
-                 <substage>93</substage>
+                 <substage>20</substage>
                </status>
                <copyright>
                  <from>2001</from>
@@ -289,7 +289,7 @@ RSpec.describe Asciidoctor::Standoc do
                    <uri type='obp'>https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
                    <uri type='rss'>https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
                    <docidentifier type='ISO'>ISO 123:2001</docidentifier>
-                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:en</docidentifier>
+                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.20:ed-3:en</docidentifier>
                    <docnumber>123</docnumber>
                    <date type='published'>
                      <on>2001-05</on>
@@ -314,7 +314,7 @@ RSpec.describe Asciidoctor::Standoc do
  </abstract>
                    <status>
                      <stage>90</stage>
-                     <substage>93</substage>
+                     <substage>20</substage>
                    </status>
                    <copyright>
                      <from>2001</from>
@@ -372,7 +372,7 @@ RSpec.describe Asciidoctor::Standoc do
                <script>Latn</script>
                <status>
                  <stage>90</stage>
-                 <substage>93</substage>
+                 <substage>20</substage>
                </status>
                <copyright>
                  <from>2001</from>
@@ -397,7 +397,7 @@ RSpec.describe Asciidoctor::Standoc do
                    <uri type='obp'>https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
                    <uri type='rss'>https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
                    <docidentifier type='ISO'>ISO 123:2001</docidentifier>
-                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:en</docidentifier>
+                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.20:ed-3:en</docidentifier>
                    <docnumber>123</docnumber>
                    <date type='published'>
                      <on>2001-05</on>
@@ -422,7 +422,7 @@ RSpec.describe Asciidoctor::Standoc do
  </abstract>
                    <status>
                      <stage>90</stage>
-                     <substage>93</substage>
+                     <substage>20</substage>
                    </status>
                    <copyright>
                      <from>2001</from>
@@ -517,7 +517,7 @@ compris les éventuels amendements).
                <script>Latn</script>
                <status>
                  <stage>90</stage>
-                 <substage>93</substage>
+                 <substage>20</substage>
                </status>
                <copyright>
                  <from>2001</from>
@@ -542,7 +542,7 @@ compris les éventuels amendements).
                    <uri type='obp'>https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
                    <uri type='rss'>https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
                    <docidentifier type='ISO'>ISO 123:2001</docidentifier>
-                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:fr</docidentifier>
+                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.20:ed-3:fr</docidentifier>
                    <docnumber>123</docnumber>
                    <date type='published'>
                      <on>2001-05</on>
@@ -570,7 +570,7 @@ compris les éventuels amendements).
 </abstract>
                    <status>
                      <stage>90</stage>
-                     <substage>93</substage>
+                     <substage>20</substage>
                    </status>
                    <copyright>
                      <from>2001</from>
@@ -629,7 +629,7 @@ compris les éventuels amendements).
                <script>Latn</script>
                <status>
                  <stage>90</stage>
-                 <substage>93</substage>
+                 <substage>20</substage>
                </status>
                <copyright>
                  <from>2001</from>
@@ -654,7 +654,7 @@ compris les éventuels amendements).
                    <uri type='obp'>https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
                    <uri type='rss'>https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
                    <docidentifier type='ISO'>ISO 123:2001</docidentifier>
-                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:fr</docidentifier>
+                   <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.20:ed-3:fr</docidentifier>
                    <docnumber>123</docnumber>
                    <date type='published'>
                      <on>2001-05</on>
@@ -682,7 +682,7 @@ compris les éventuels amendements).
 </abstract>
                    <status>
                      <stage>90</stage>
-                     <substage>93</substage>
+                     <substage>20</substage>
                    </status>
                    <copyright>
                      <from>2001</from>