metanorma-standoc 1.11.1 → 1.11.2

data/lib/asciidoctor/standoc/ref.rb

@@ -22,37 +22,44 @@ module Asciidoctor
         { id: match[:anchor], type: "standard" }
       end
 
-      def isorefrender1(bib, match, yr, allp = "")
+      def isorefrender1(bib, match, year, allp = "")
         bib.title(**plaintxt) { |i| i << ref_normalise(match[:text]) }
         docid(bib, match[:usrlbl]) if match[:usrlbl]
-        docid(bib, id_and_year(match[:code], yr) + allp)
+        docid(bib, id_and_year(match[:code], year) + allp)
         docnumber(bib, match[:code])
       end
 
-      def isorefmatches(xml, match)
+      def isorefmatchescode(match)
         yr = norm_year(match[:year])
-        ref = fetch_ref xml, match[:code], yr,
-                        title: match[:text], usrlbl: match[:usrlbl],
-                        lang: (@lang || :all)
-        return use_my_anchor(ref, match[:anchor]) if ref
-
-        xml.bibitem **attr_code(ref_attributes(match)) do |t|
-          isorefrender1(t, match, yr)
-          yr and t.date **{ type: "published" } do |d|
-            set_date_range(d, yr)
+        { code: match[:code], year: yr, match: match,
+          title: match[:text], usrlbl: match[:usrlbl],
+          lang: (@lang || :all) }
+      end
+
+      def isorefmatchesout(item, xml)
+        if item[:doc] then use_retrieved_relaton(item, xml)
+        else
+          xml.bibitem **attr_code(ref_attributes(item[:ref][:match])) do |t|
+            isorefrender1(t, item[:ref][:match], item[:ref][:year])
+            item[:ref][:year] and t.date **{ type: "published" } do |d|
+              set_date_range(d, item[:ref][:year])
+            end
+            iso_publisher(t, item[:ref][:match][:code])
           end
-          iso_publisher(t, match[:code])
         end
       end
 
-      def isorefmatches2(xml, match)
-        ref = fetch_ref xml, match[:code], nil,
-                        no_year: true, note: match[:fn],
-                        title: match[:text], usrlbl: match[:usrlbl],
-                        lang: (@lang || :all)
-        return use_my_anchor(ref, match[:anchor]) if ref
+      def isorefmatches2code(match)
+        { code: match[:code], no_year: true,
+          note: match[:fn], year: nil, match: match,
+          title: match[:text], usrlbl: match[:usrlbl],
+          lang: (@lang || :all) }
+      end
 
-        isorefmatches2_1(xml, match)
+      def isorefmatches2out(item, xml)
+        if item[:doc] then use_retrieved_relaton(item, xml)
+        else isorefmatches2_1(xml, item[:ref][:match])
+        end
       end
 
       def isorefmatches2_1(xml, match)
@@ -70,16 +77,22 @@ module Asciidoctor
         end
       end
 
-      def isorefmatches3(xml, match)
+      def isorefmatches3code(match)
         yr = norm_year(match[:year])
         hasyr = !yr.nil? && yr != "--"
-        ref = fetch_ref(xml, match[:code], hasyr ? yr : nil,
-                        all_parts: true, no_year: yr == "--",
-                        text: match[:text], usrlbl: match[:usrlbl],
-                        lang: (@lang || :all))
-        return use_my_anchor(ref, match[:anchor]) if ref
-
-        isorefmatches3_1(xml, match, yr, hasyr, ref)
+        { code: match[:code], match: match, yr: yr, hasyr: hasyr,
+          year: hasyr ? yr : nil,
+          all_parts: true, no_year: yr == "--",
+          text: match[:text], usrlbl: match[:usrlbl],
+          lang: (@lang || :all) }
+      end
+
+      def isorefmatches3out(item, xml)
+        if item[:doc] then use_retrieved_relaton(item, xml)
+        else
+          isorefmatches3_1(xml, item[:ref][:match], item[:ref][:yr],
+                           item[:ref][:hasyr], item[:doc])
+        end
       end
 
       def isorefmatches3_1(xml, match, yr, _hasyr, _ref)
@@ -120,56 +133,34 @@ module Asciidoctor
       end
 
       MALFORMED_REF = "no anchor on reference, markup may be malformed: see "\
-        "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
-        "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
-
-      def analyse_ref_nofetch(ret)
-        return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
-
-        ret.merge(id: m[:id], nofetch: true)
-      end
-
-      def analyse_ref_repo_path(ret)
-        return ret unless m =
-                            /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/.match(ret[:id])
-
-        id = m[:id].empty? ? m[:key].sub(%r{^[^/]+/}, "") : m[:id]
-        ret.merge(id: id, type: m[:type], key: m[:key], nofetch: true)
-      end
-
-      def analyse_ref_numeric(ret)
-        return ret unless /^\d+$/.match?(ret[:id])
-
-        ret.merge(numeric: true)
-      end
-
-      # ref id = (usrlbl)code[:-]year
-      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | ident
-      def analyse_ref_code(code)
-        ret = { id: code }
-        return ret if code.blank?
-
-        analyse_ref_nofetch(analyse_ref_repo_path(analyse_ref_numeric(ret)))
-      end
+                      "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
+                      "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       # TODO: alternative where only title is available
-      def refitem(xml, item, node)
-        m = NON_ISO_REF.match(item) and return refitem1(xml, item, m)
+      def refitemcode(item, node)
+        m = NON_ISO_REF.match(item) and return refitem1code(item, m)
         @log.add("AsciiDoc Input", node, "#{MALFORMED_REF}: #{item}")
-        nil
+        {}
       end
 
-      def refitem1(xml, _item, match)
+      def refitem1code(_item, match)
         code = analyse_ref_code(match[:code])
-        unless (code[:id] && code[:numeric]) || code[:nofetch]
-          ref = fetch_ref(xml, code[:id],
-                          match.names.include?("year") ? match[:year] : nil,
-                          title: match[:text],
-                          usrlbl: match[:usrlbl], lang: (@lang || :all)) and
-            return use_my_anchor(ref, match[:anchor])
+        if (code[:id] && code[:numeric]) || code[:nofetch]
+          { code: nil, match: match, analyse_code: code }
+        else
+          { code: code[:id], analyse_code: code,
+            year: match.names.include?("year") ? match[:year] : nil,
+            title: match[:text], match: match,
+            usrlbl: match[:usrlbl], lang: (@lang || :all) }
         end
+      end
+
+      def refitemout(item, xml)
+        return nil if item[:ref][:match].nil?
 
-        refitem_render(xml, match, code)
+        item[:doc] or return refitem_render(xml, item[:ref][:match],
+                                            item[:ref][:analyse_code])
+        use_retrieved_relaton(item, xml)
       end
 
       def ref_normalise(ref)
@@ -211,15 +202,50 @@ module Asciidoctor
         [matched, matched2, matched3]
       end
 
-      def reference1(node, item, xml)
+      def reference1code(item, node)
         matched, matched2, matched3 = reference1_matches(item)
         if matched3.nil? && matched2.nil? && matched.nil?
-          refitem(xml, item, node)
-        elsif !matched.nil? then isorefmatches(xml, matched)
-        elsif !matched2.nil? then isorefmatches2(xml, matched2)
-        elsif !matched3.nil? then isorefmatches3(xml, matched3)
+          refitemcode(item, node).merge(process: 0)
+        elsif !matched.nil? then isorefmatchescode(matched).merge(process: 1)
+        elsif !matched2.nil? then isorefmatches2code(matched2).merge(process: 2)
+        elsif !matched3.nil? then isorefmatches3code(matched3).merge(process: 3)
         end
       end
+
+      def reference1out(item, xml)
+        case item[:ref][:process]
+        when 0 then refitemout(item, xml)
+        when 1 then isorefmatchesout(item, xml)
+        when 2 then isorefmatches2out(item, xml)
+        when 3 then isorefmatches3out(item, xml)
+        end
+      end
+
+      def reference_preproc(node)
+        refs = node.items.each_with_object([]) do |b, m|
+          m << reference1code(b.text, node)
+        end
+        results = refs.each_with_index.with_object(Queue.new) do |(ref, i), res|
+          fetch_ref_async(ref.merge(ord: i), i, res)
+        end
+        [refs, results]
+      end
+
+      def reference(node)
+        refs, results = reference_preproc(node)
+        noko do |xml|
+          ret = refs.each.with_object([]) do |_, m|
+            ref, i, doc = results.pop
+            m[i.to_i] = { ref: ref }
+            if doc.is_a?(RelatonBib::RequestError)
+              @log.add("Bibliography", nil, "Could not retrieve #{ref[:code]}: "\
+                                            "no access to online site")
+            else m[i.to_i][:doc] = doc
+            end
+          end
+          ret.each { |b| reference1out(b, xml) }
+        end.join
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/ref_date_id.rb

@@ -26,7 +26,7 @@ module Asciidoctor
       def conditional_date(bib, match, noyr)
         if match.names.include?("year") && !match[:year].nil?
           bib.date(**{ type: "published" }) do |d|
-            noyr and d.on "--" or set_date_range(d, norm_year(match[:year]))
+            (noyr and d.on "--") or set_date_range(d, norm_year(match[:year]))
           end
         end
       end
@@ -57,6 +57,35 @@ module Asciidoctor
       def mn_code(code)
         code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
       end
+
+      def analyse_ref_nofetch(ret)
+        return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
+
+        ret.merge(id: m[:id], nofetch: true)
+      end
+
+      def analyse_ref_repo_path(ret)
+        return ret unless m =
+                            /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/.match(ret[:id])
+
+        id = m[:id].empty? ? m[:key].sub(%r{^[^/]+/}, "") : m[:id]
+        ret.merge(id: id, type: m[:type], key: m[:key], nofetch: true)
+      end
+
+      def analyse_ref_numeric(ret)
+        return ret unless /^\d+$/.match?(ret[:id])
+
+        ret.merge(numeric: true)
+      end
+
+      # ref id = (usrlbl)code[:-]year
+      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | ident
+      def analyse_ref_code(code)
+        ret = { id: code }
+        return ret if code.blank?
+
+        analyse_ref_nofetch(analyse_ref_repo_path(analyse_ref_numeric(ret)))
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -9,12 +9,6 @@ module Asciidoctor
         @norm_ref
       end
 
-      def reference(node)
-        noko do |xml|
-          node.items.each { |item| reference1(node, item.text, xml) }
-        end.join
-      end
-
       def bibliography_parse(attrs, xml, node)
         x = biblio_prep(attrs, xml, node) and return x
         @biblio = true
@@ -86,6 +80,16 @@ module Asciidoctor
         nil
       end
 
+      def fetch_ref_async(ref, idx, res)
+        if ref[:code].nil? || ref[:no_year] || @bibdb.nil?
+          res << [ref, idx, nil]
+        else
+          @bibdb.fetch_async(ref[:code], ref[:year], ref) do |doc|
+            res << [ref, idx, doc]
+          end
+        end
+      end
+
       def emend_biblio(xml, code, title, usrlbl)
         unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")
           @log.add("Bibliography", nil,
@@ -112,6 +116,12 @@ module Asciidoctor
         xml.to_xml.sub(/<\?[^>]+>/, "")
       end
 
+      def use_retrieved_relaton(item, xml)
+        xml.parent.add_child(smart_render_xml(item[:doc], item[:ref][:code],
+                                              item[:ref]))
+        use_my_anchor(xml, item[:ref][:match][:anchor])
+      end
+
       def init_bib_caches(node)
         return if @no_isobib
 

data/lib/asciidoctor/standoc/reqt.rb

@@ -1,5 +1,5 @@
 require "htmlentities"
-require "uri"
+require "uri" if /^2\./.match?(RUBY_VERSION)
 require "mime/types"
 require "base64"
 

data/lib/asciidoctor/standoc/section.rb

@@ -1,4 +1,4 @@
-require "uri"
+require "uri" if /^2\./.match?(RUBY_VERSION)
 require_relative "ref_sect"
 require_relative "terms"
 

data/lib/asciidoctor/standoc/validate.rb

@@ -112,7 +112,7 @@ module Asciidoctor
       def schema_validate1(file, doc, schema)
         file.write(doc.to_xml)
         file.close
-        errors = Jing.new(schema).validate(file.path)
+        errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
         warn "Syntax Valid!" if errors.none?
         errors.each do |e|
           @log.add("Metanorma XML Syntax",

data/lib/isodoc/html/htmlstyle.css

@@ -492,7 +492,7 @@ h3 {
   font-size: 1.1em;
   font-weight: 100; }
 
-.TermNum, .Terms, .AltTerms {
+.TermNum {
   color: #C70039;
   font-weight: 100; }
 

data/lib/isodoc/html/htmlstyle.scss

@@ -185,7 +185,7 @@ p.document-stage {
     font-weight: 100;
   }
 
-  .TermNum, .Terms, .AltTerms {
+  .TermNum {
     color: #C70039;
     font-weight: 100;
   }

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.11.1".freeze
+    VERSION = "1.11.2".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -27,7 +27,7 @@ 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 "iev", "~> 0.3.0"
   spec.add_dependency "isodoc", "~> 1.8.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   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/blocks_spec.rb

@@ -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'/>

data/spec/asciidoctor/cleanup_sections_spec.rb

@@ -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/cleanup_spec.rb

@@ -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>