metanorma-standoc 1.10.5 → 1.11.0

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true.
+require "asciidoctor/standoc/utils"
+
 
 module Asciidoctor
   module Standoc
@@ -13,7 +15,7 @@ module Asciidoctor
       def initialize(xmldoc, log)
         @xmldoc = xmldoc
         @log = log
-        @termlookup = { term: {}, symbol: {} }
+        @termlookup = { term: {}, symbol: {}, secondary2primary: {} }
         @idhash = {}
       end
 
@@ -22,6 +24,7 @@ module Asciidoctor
         @termlookup = replace_automatic_generated_ids_terms
         set_termxref_tags_target
         concept_cleanup
+        related_cleanup
       end
 
       private
@@ -29,6 +32,19 @@ module Asciidoctor
       def concept_cleanup
         xmldoc.xpath("//concept").each do |n|
           n.delete("type")
+          refterm = n.at("./refterm") or next
+          p = @termlookup[:secondary2primary][refterm.text] and
+            refterm.children = p
+        end
+      end
+
+      def related_cleanup
+        xmldoc.xpath("//related").each do |n|
+          refterm = n.at("./refterm") or next
+          p = @termlookup[:secondary2primary][refterm.text] and
+            refterm.children = p
+          refterm.replace("<preferred><expression><name>#{refterm.children.to_xml}"\
+                          "</name></expression></preferred>")
         end
       end
 
@@ -47,8 +63,7 @@ module Asciidoctor
             remove_missing_ref(node, target)
             next
           end
-          x = node.at("../xrefrender")
-          modify_ref_node(x, target)
+          x = node.at("../xrefrender") and modify_ref_node(x, target)
           node.name = "refterm"
         end
       end
@@ -66,12 +81,12 @@ module Asciidoctor
                 %(Error: Term reference in `term[#{target}]` missing: \
                 "#{target}" is not defined in document))
         node.name = "strong"
-        node.at("../xrefrender").remove
+        node&.at("../xrefrender")&.remove
         display = node&.at("../renderterm")&.remove&.children
         display = [] if display.nil? || display&.to_xml == node.text
         d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
         node.children = "term <tt>#{node.text}</tt>#{d} "\
-          "not resolved via ID <tt>#{target}</tt>"
+                        "not resolved via ID <tt>#{target}</tt>"
       end
 
       def remove_missing_ref_symbol(node, target)
@@ -79,12 +94,12 @@ module Asciidoctor
                 %(Error: Symbol reference in `symbol[#{target}]` missing: \
                 "#{target}" is not defined in document))
         node.name = "strong"
-        node.at("../xrefrender").remove
+        node&.at("../xrefrender")&.remove
         display = node&.at("../renderterm")&.remove&.children
         display = [] if display.nil? || display&.to_xml == node.text
         d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
         node.children = "symbol <tt>#{node.text}</tt>#{d} "\
-          "not resolved via ID <tt>#{target}</tt>"
+                        "not resolved via ID <tt>#{target}</tt>"
       end
 
       def modify_ref_node(node, target)
@@ -92,24 +107,40 @@ module Asciidoctor
         s = termlookup[:symbol][target]
         t = termlookup[:term][target]
         type = node.parent["type"]
-        if type == "term" || !type && t
+        if type == "term" || ((!type || node.parent.name == "related") && t)
           node["target"] = t
-        elsif type == "symbol" || !type && s
+        elsif type == "symbol" ||
+          ((!type || node.parent.name == "related") && s)
           node["target"] = s
         end
       end
 
       def replace_automatic_generated_ids_terms
         r = xmldoc.xpath("//term").each.with_object({}) do |n, res|
-          normalize_id_and_memorize(n, res, "./preferred", "term")
+          normalize_id_and_memorize(n, res, "./preferred//name",
+                                    "term")
         end
         s = xmldoc.xpath("//definitions//dt").each.with_object({}) do |n, res|
           normalize_id_and_memorize(n, res, ".", "symbol")
         end
-        { term: r, symbol: s }
+        { term: r, symbol: s, secondary2primary: pref_secondary2primary }
+      end
+
+      def pref_secondary2primary
+        xmldoc.xpath("//term").each.with_object({}) do |n, res|
+          n.xpath("./preferred//name").each_with_index do |p, i|
+            i.zero? and term = p.text
+            i.positive? and res[p.text] = term
+          end
+        end
       end
 
       def normalize_id_and_memorize(node, res_table, text_selector, prefix)
+        normalize_id_and_memorize_init(node, res_table, text_selector, prefix)
+        memorize_other_pref_terms(node, res_table, text_selector)
+      end
+
+      def normalize_id_and_memorize_init(node, res_table, text_selector, prefix)
         term_text = normalize_ref_id(node.at(text_selector).text)
         unless AUTOMATIC_GENERATED_ID_REGEXP.match(node["id"]).nil? &&
             !node["id"].nil?
@@ -120,6 +151,14 @@ module Asciidoctor
         res_table[term_text] = node["id"]
       end
 
+      def memorize_other_pref_terms(node, res_table, text_selector)
+        node.xpath(text_selector).each_with_index do |p, i|
+          next unless i.positive?
+
+          res_table[normalize_ref_id(p.text)] = node["id"]
+        end
+      end
+
       def normalize_ref_id(text)
         Metanorma::Utils::to_ncname(text.downcase.gsub(/[[:space:]]/, "-"))
       end

data/lib/asciidoctor/standoc/terms.rb

@@ -69,7 +69,7 @@ module Asciidoctor
 
       def term_def_subclause_parse1(attrs, xml, node)
         xml.term **attr_code(attrs) do |xml_section|
-          xml_section.preferred { |name| name << node.title }
+          term_designation(xml_section, node, "preferred", node.title)
           xml_section << node.content
         end
       end
@@ -77,13 +77,21 @@ module Asciidoctor
       def term_def_parse(attrs, xml, node, _toplevel)
         xml.terms **attr_code(attrs) do |section|
           section.title { |t| t << node.title }
-          (s = node.attr("source")) && s.split(/,/).each do |s1|
+          (s = node.attr("source")) && s.split(",").each do |s1|
             section.termdocsource(nil, **attr_code(bibitemid: s1))
           end
           section << node.content
         end
       end
 
+      def term_designation(xml, _node, tag, text)
+        xml.send tag do |p|
+          p.expression do |e|
+            e.name { |name| name << text }
+          end
+        end
+      end
+
       def term_source_attrs(_node, seen_xref)
         { case: seen_xref.children[0]["case"],
           droploc: seen_xref.children[0]["droploc"],
@@ -124,13 +132,23 @@ module Asciidoctor
       def termsource(node)
         matched = extract_termsource_refs(node.content, node) || return
         noko do |xml|
-          attrs = { status: matched[:text] ? "modified" : "identical" }
+          status = node.attr("status") ||
+            (matched[:text] ? "modified" : "identical")
+          attrs = { status: status, type: node.attr("type") || "authoritative" }
           xml.termsource **attrs do |xml_t|
             seen_xref = Nokogiri::XML.fragment(matched[:xref])
             add_term_source(node, xml_t, seen_xref, matched)
           end
         end.join("\n")
       end
+
+      def termdefinition(node)
+        noko do |xml|
+          xml.definition do |d|
+            d << node.content
+          end
+        end.join("\n")
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/utils.rb

@@ -40,10 +40,9 @@ module Asciidoctor
       end
 
       def attr_code(attributes)
-        attributes = attributes.reject { |_, val| val.nil? }.map
-        attributes.map do |k, v|
-          [k, (v.is_a? String) ? HTMLEntities.new.decode(v) : v]
-        end.to_h
+        attributes.compact.transform_values do |v|
+          v.is_a?(String) ? HTMLEntities.new.decode(v) : v
+        end
       end
 
       # if the contents of node are blocks, output them to out;
@@ -56,7 +55,7 @@ module Asciidoctor
       end
 
       SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
-        "[not(ancestor::boilerplate)]".freeze
+                        "[not(ancestor::boilerplate)]".freeze
 
       def isodoc(lang, script, i18nyaml = nil)
         conv = html_converter(EmptyAttr.new)
@@ -67,29 +66,43 @@ module Asciidoctor
 
       def default_script(lang)
         case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
+        when "ar", "fa" then "Arab"
+        when "ur" then "Aran"
+        when "ru", "bg" then "Cyrl"
+        when "hi" then "Deva"
+        when "el" then "Grek"
+        when "zh" then "Hans"
+        when "ko" then "Kore"
+        when "he" then "Hebr"
+        when "ja" then "Jpan"
         else
           "Latn"
         end
       end
 
+      def dl_to_attrs(elem, dlist, name)
+        e = dlist.at("./dt[text()='#{name}']") or return
+        val = e.at("./following::dd/p") || e.at("./following::dd") or return
+        elem[name] = val.text
+      end
+
+      def dl_to_elems(ins, elem, dlist, name)
+        a = elem.at("./#{name}[last()]")
+        ins = a if a
+        dlist.xpath("./dt[text()='#{name}']").each do |e|
+          v = e.at("./following::dd")
+          e = v.elements and e.size == 1 && e.first.name == "p" and v = e.first
+          v.name = name
+          ins.next = v
+          ins = ins.next
+        end
+        ins
+      end
+
+      def term_expr(elem)
+        "<expression><name>#{elem}</name></expression>"
+      end
+
       class EmptyAttr
         def attr(_any_attribute)
           nil

data/lib/asciidoctor/standoc/validate.rb

@@ -7,8 +7,8 @@ require "iev"
 module Asciidoctor
   module Standoc
     module Validate
-      SOURCELOCALITY = "./termsource/origin//locality[@type = 'clause']/"\
-        "referenceFrom".freeze
+      SOURCELOCALITY = "./origin//locality[@type = 'clause']/"\
+                       "referenceFrom".freeze
 
       def init_iev
         return nil if @no_isobib
@@ -21,24 +21,35 @@ module Asciidoctor
       def iev_validate(xmldoc)
         @iev = init_iev or return
         xmldoc.xpath("//term").each do |t|
-          /^IEC 60050-/.match(t&.at("./termsource/origin/@citeas")&.text) &&
-            loc = t.xpath(SOURCELOCALITY)&.text or next
-          iev = @iev.fetch(loc, xmldoc&.at("//language")&.text || "en") or next
-          pref = t.xpath("./preferred").inject([]) do |m, x|
-            m << x&.text&.downcase
+          t.xpath(".//termsource").each do |src|
+            (/^IEC 60050-/.match(src&.at("./origin/@citeas")&.text) &&
+          loc = src.xpath(SOURCELOCALITY)&.text) or next
+            iev_validate1(t, loc, xmldoc)
           end
-          pref.include?(iev.downcase) or
-            @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match ) +
-                     %(IEV #{loc} "#{iev}"))
         end
       end
 
+      def iev_validate1(term, loc, xmldoc)
+        iev = @iev.fetch(loc,
+                         xmldoc&.at("//language")&.text || "en") or return
+        pref = term.xpath("./preferred//name").inject([]) do |m, x|
+          m << x&.text&.downcase
+        end
+        pref.include?(iev.downcase) or
+          @log.add("Bibliography", term, %(Term "#{pref[0]}" does not match ) +
+                   %(IEV #{loc} "#{iev}"))
+      end
+
       def content_validate(doc)
+        @fatalerror = []
+        xref_validate(doc)
         section_validate(doc)
         norm_ref_validate(doc)
         repeat_id_validate(doc.root)
         iev_validate(doc.root)
-        concept_validate(doc)
+        concept_validate(doc, "concept", "refterm")
+        concept_validate(doc, "related", "preferred//name")
+        @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
       end
 
       def norm_ref_validate(doc)
@@ -51,30 +62,30 @@ module Asciidoctor
                    "Numeric reference in normative references")
           found = true
         end
-        found and
-          clean_abort("Numeric reference in normative references", doc.to_xml)
+        found and @fatalerror << "Numeric reference in normative references"
       end
 
-      def concept_validate(doc)
+      def concept_validate(doc, tag, refterm)
         found = false
-        doc.xpath("//concept/xref").each do |x|
+        doc.xpath("//#{tag}/xref").each do |x|
           next if doc.at("//term[@id = '#{x['target']}']")
           next if doc.at("//definitions//dt[@id = '#{x['target']}']")
 
-          ref = x&.at("../refterm")&.text
-          @log.add("Anchors", x, "Concept #{ref} is pointing to "\
+          ref = x&.at("../#{refterm}")&.text
+          @log.add("Anchors", x,
+                   "#{tag.capitalize} #{ref} is pointing to "\
                    "#{x['target']}, which is not a term or symbol")
           found = true
         end
-        found and clean_abort("Concept not cross-referencing term or symbol",
-                              doc.to_xml)
+        found and
+          @fatalerror << "#{tag.capitalize} not cross-referencing term or symbol"
       end
 
       def repeat_id_validate1(ids, elem)
         if ids[elem["id"]]
           @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\
-                   "used at line #{ids[elem['id']]}")
-          raise StandardError.new "Error: multiple instances of same ID"
+                                    "used at line #{ids[elem['id']]}")
+          @fatalerror << "Multiple instances of same ID: #{elem['id']}"
         else
           ids[elem["id"]] = elem.line
         end
@@ -83,12 +94,8 @@ module Asciidoctor
 
       def repeat_id_validate(doc)
         ids = {}
-        begin
-          doc.xpath("//*[@id]").each do |x|
-            ids = repeat_id_validate1(ids, x)
-          end
-        rescue StandardError => e
-          clean_abort(e.message, doc.to_xml)
+        doc.xpath("//*[@id]").each do |x|
+          ids = repeat_id_validate1(ids, x)
         end
       end
 
@@ -130,6 +137,17 @@ module Asciidoctor
         doc
       end
 
+      # manually check for xref/@target, xref/@to integrity
+      def xref_validate(doc)
+        ids = doc.xpath("//*/@id").each_with_object({}) { |x, m| m[x.text] = 1 }
+        doc.xpath("//xref/@target | //xref/@to").each do |x|
+          next if ids[x.text]
+
+          @log.add("Anchors", x.parent,
+                   "Crossreference target #{x.text} is undefined")
+        end
+      end
+
       def validate(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),

data/lib/asciidoctor/standoc/validate_section.rb

@@ -14,7 +14,8 @@ module Asciidoctor
           callouts = x.elements.select { |e| e.name == "callout" }
           annotations = x.elements.select { |e| e.name == "annotation" }
           if callouts.size != annotations.size
-        @log.add("AsciiDoc Input", x, "mismatch of callouts and annotations")
+            @log.add("AsciiDoc Input", x,
+                     "mismatch of callouts and annotations")
           end
         end
       end
@@ -42,7 +43,9 @@ module Asciidoctor
         root.xpath("//clause | //annex | //foreword | //introduction | "\
                    "//acknowledgements").each do |c|
           next unless c.at("./clause")
-          next if c.elements.reject { |n| %w(clause title).include? n.name }.empty?
+          next if c.elements.reject do |n|
+                    %w(clause title).include? n.name
+                  end.empty?
 
           style_warning(c, "Hanging paragraph in clause")
         end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.5".freeze
+    VERSION = "1.11.0".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "isodoc", "~> 1.7.0"
+  spec.add_dependency "isodoc", "~> 1.8.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"

data/spec/asciidoctor/base_spec.rb

@@ -6,39 +6,6 @@ RSpec.describe Asciidoctor::Standoc do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
 
-  it "processes a blank document" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "converts a blank document" do
-    FileUtils.rm_f "test.doc"
-    input = <<~INPUT
-      = Document title
-      Author
-      :docfile: test.adoc
-      :novalid:
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-    expect(File.exist?("test.doc")).to be true
-    expect(File.exist?("test.pdf")).to be true
-    expect(File.exist?("htmlstyle.css")).to be false
-  end
-
   it "assigns default scripts to major languages" do
     FileUtils.rm_f "test.doc"
     input = <<~INPUT
@@ -992,14 +959,15 @@ QU1FOiB0ZXN0Cgo=
 
   it "process mn2pdf attributes" do
     node = Nokogiri::XML("<fake/>").at("fake")
-    node["mn2pdf-font-manifest-file"] = "passed/as/font/manifest/to/mn2pdf.jar"
+    node[Asciidoctor::Standoc::Base::FONTS_MANIFEST] =
+      "passed/as/font/manifest/to/mn2pdf.jar"
 
     options = Asciidoctor::Standoc::Converter
       .new(:standoc, header_footer: true)
       .doc_extract_attributes(node)
 
-    expect(options.dig(:mn2pdf, :font_manifest_file))
-      .to eq(node["mn2pdf-font-manifest-file"])
+    expect(options.dig(:mn2pdf, :font_manifest))
+      .to eq(node[Asciidoctor::Standoc::Base::FONTS_MANIFEST])
   end
 
   private

data/spec/asciidoctor/blank_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::Standoc do
+  it "processes a blank document" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "converts a blank document" do
+    FileUtils.rm_f "test.doc"
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :novalid:
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+    expect(File.exist?("test.doc")).to be true
+    expect(File.exist?("test.pdf")).to be true
+    expect(File.exist?("htmlstyle.css")).to be false
+  end
+end