metanorma-standoc 1.6.5 → 1.8.1

data/lib/asciidoctor/standoc/utils.rb

@@ -5,103 +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
-
-        def smartformat(n)
-          n.gsub(/ --? /, "&#8201;&#8212;&#8201;").
-            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)
@@ -175,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.6.5".freeze
+    VERSION= "1.8.1".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,20 +28,19 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.3.0"
+  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"
-  spec.add_dependency "fontist", "~> 1.5.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "sassc", "2.4.0"

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
@@ -40,7 +69,7 @@ RSpec.describe Asciidoctor::Standoc do
       :docfile: test.adoc
       :nodoc:
       :novalid:
-      :publisher: International Electrotechnical Commission,IETF,ISO
+      :publisher: International Electrotechnical Commission;IETF;ISO
 INPUT
 <standard-document xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Standoc::VERSION}'>
   <bibdata type='standard'>
@@ -91,7 +120,7 @@ INPUT
       <stage>published</stage>
     </status>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Electrotechnical Commission</name>
@@ -100,7 +129,7 @@ INPUT
       </owner>
     </copyright>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>IETF</name>
@@ -108,7 +137,7 @@ INPUT
       </owner>
     </copyright>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Standards Organization</name>
@@ -181,6 +210,7 @@ OUTPUT
       :role: author
       :affiliation: Slate Rock and Gravel Company
       :affiliation_abbrev: SRG
+      :affiliation_subdiv: Hermeneutics Unit; Exegetical Subunit
       :address: 6 Rubble Way, Bedrock
       :contributor-uri: http://slate.example.com
       :phone: 123
@@ -191,13 +221,14 @@ OUTPUT
       :role_2: editor
       :affiliation_2: Rockhead and Quarry Cave Construction Company
       :affiliation_abbrev_2: RQCCC
+      :affiliation_subdiv_2: Hermeneutics Unit; Exegetical Subunit
       :address_2: 6A Rubble Way, + \\
       Bedrock
       :email_2: barney@rockhead.example.com
       :phone_2: 789
       :fax_2: 012
-      :publisher: "Hanna Barbera", "Cartoon Network", "Ribose, Inc."
-      :copyright-holder: "Ribose, Inc.", Hanna Barbera
+      :publisher: "Hanna Barbera"; "Cartoon Network"; "Ribose, Inc."
+      :copyright-holder: "Ribose, Inc."; Hanna Barbera
       :part-of: ABC
       :translated-from: DEF,GHI;JKL MNO,PQR
       :keywords: a, b, c
@@ -288,6 +319,8 @@ OUTPUT
    <organization>
      <name>Slate Rock and Gravel Company</name>
      <abbreviation>SRG</abbreviation>
+     <subdivision>Hermeneutics Unit</subdivision>
+<subdivision>Exegetical Subunit</subdivision>
   <address>
   <formattedAddress>
   6 Rubble Way, Bedrock
@@ -312,6 +345,8 @@ OUTPUT
   <organization>
     <name>Rockhead and Quarry Cave Construction Company</name>
     <abbreviation>RQCCC</abbreviation>
+    <subdivision>Hermeneutics Unit</subdivision>
+<subdivision>Exegetical Subunit</subdivision>
   <address>
     <formattedAddress>6A Rubble Way, <br/>Bedrock</formattedAddress>
   </address>
@@ -425,7 +460,7 @@ OUTPUT
       :tc-docnumber: 2000
       :language: el
       :script: Grek
-      :publisher: IEC,IETF,ISO
+      :publisher: IEC;IETF;ISO
       :uri: A
       :xml-uri: B
       :html-uri: C
@@ -623,7 +658,7 @@ OUTPUT
       <stage>published</stage>
     </status>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Standards Organization</name>

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -340,7 +340,9 @@ RSpec.describe Asciidoctor::Standoc do
 
       NOTE: This is not a termnote
 
-      EXAMPLE: This is not a termexample
+      ====
+      This is not a termexample
+      ====
 
       [.nonterm]
       === Term1
@@ -355,6 +357,9 @@ RSpec.describe Asciidoctor::Standoc do
          <note id='_'>
   <p id='_'>This is not a termnote</p>
 </note>
+  <example id='_'>
+  <p id='_'>This is not a termexample</p>
+</example>
   <clause id="_" inline-header="false" obligation="normative">
   <title>Term1</title>
   <note id="_">

data/spec/asciidoctor-standoc/cleanup_sections_spec.rb

@@ -3,7 +3,7 @@ require "relaton_iec"
 require "fileutils"
 
 RSpec.describe Asciidoctor::Standoc do
-  it "strips any initial boilerplate from terms and definitions" do
+  it "appends any initial user-supplied text to boilerplate in terms and definitions" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
       == Terms and Definitions
@@ -20,7 +20,12 @@ RSpec.describe Asciidoctor::Standoc do
               <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>
-
+<p id='_'>I am boilerplate</p>
+<ul id='_'>
+  <li>
+    <p id='_'>So am I</p>
+  </li>
+</ul>
        <term id="term-time">
        <preferred>Time</preferred>
          <definition><p id="_">This paragraph is extraneous</p></definition>
@@ -400,7 +405,7 @@ INPUT
              <stage>published</stage>
            </status>
            <copyright>
-             <from>2020</from>
+             <from>#{Time.now.year}</from>
            </copyright>
            <ext>
              <doctype>article</doctype>
@@ -692,7 +697,7 @@ INPUT
               <stage>published</stage>
             </status>
             <copyright>
-              <from>2020</from>
+              <from>#{Time.now.year}</from>
             </copyright>
             <ext>
               <doctype>article</doctype>
@@ -923,7 +928,7 @@ INPUT
               <stage>published</stage>
             </status>
             <copyright>
-              <from>2020</from>
+              <from>#{Time.now.year}</from>
             </copyright>
             <ext>
               <doctype>article</doctype>
@@ -1157,7 +1162,7 @@ INPUT
               <stage>published</stage>
             </status>
             <copyright>
-              <from>2020</from>
+              <from>#{Time.now.year}</from>
             </copyright>
             <ext>
               <doctype>article</doctype>
@@ -1388,7 +1393,7 @@ INPUT
               <stage>published</stage>
             </status>
             <copyright>
-              <from>2020</from>
+              <from>#{Time.now.year}</from>
             </copyright>
             <ext>
               <doctype>article</doctype>

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -7,11 +7,14 @@ RSpec.describe Asciidoctor::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
       == "Quotation" A's
+
+      '24:00:00'.
     INPUT
        #{BLANK_HDR}
               <sections>
   <clause id="_" inline-header="false" obligation="normative">
   <title>“Quotation” A’s</title>
+  <p id='_'>‘24:00:00’.</p>
 </clause>
        </sections>
        </standard-document>
@@ -1864,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")
@@ -1876,7 +1881,7 @@ expect(xmlpp(Asciidoctor.convert(input, backend: :standoc, header_footer: true).
       <stage>published</stage>
     </status>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
     </copyright>
     <ext>
       <doctype>article</doctype>
@@ -1885,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
@@ -1929,7 +1943,7 @@ expect(xmlpp(Asciidoctor.convert(input, backend: :standoc, header_footer: true))
              <stage>published</stage>
            </status>
            <copyright>
-             <from>2020</from>
+             <from>#{Time.now.year}</from>
            </copyright>
            <ext>
              <doctype>article</doctype>
@@ -2106,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)