metanorma-standoc 1.6.4 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e30bd97d527914e60d6dfcd537620ba7d2d5ae82d9d9c07e24d5a535dd9ec8ee
-  data.tar.gz: b8774965fcb7e698288f1793460fd67b982085e8d0951b35cfa6c4f102157e9a
+  metadata.gz: cf94c8165f552d893fafcd889f4a87497cf9d3cacf47aa9b1ea840da7d95b1c6
+  data.tar.gz: 0a7aa11f804bf0cb450252c9183353f11571dddf9f3ca15d279aca27483510ac
 SHA512:
-  metadata.gz: 74e250a48b25dd82c3174b78b515e57fe11bc3f4f8767d6942048bb3ef01ddf6937a6c2ff24ddb5e17d8f747eeb582b77248b28bdf50bc120a3fcfafd6f78221
-  data.tar.gz: a0fe35b39a730d18afe1cc7463b166377adb2137c4cfd9c650844e3a593e1a2312fa8242a8991a1508aaed44b7b7525a54cad7f747a177ea2848b27720cf644d
+  metadata.gz: 89c736fe574b64de2b97a244435f3a851d667d99e952ec6d5ba5e0d4f0c40986cb87958e1ed99d68e6d6bdd6ae89dccdba104855cd12738e0801b8657e3b3adf
+  data.tar.gz: fb9b3000f186215a782eb1d65114c86108e48742336337ae365320344cc6f0c23e5bbd2a20ab7cfa0534ff55140baa23a21870a0af14e40b3dd8589f02db32d5

data/.github/workflows/rake.yml

@@ -36,6 +36,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
       - uses: actions/cache@v2
         with:
           path: vendor/bundle
@@ -64,3 +67,17 @@ jobs:
         run: cinst -y plantuml
 
       - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/lib/asciidoctor/standoc/base.rb

@@ -94,12 +94,10 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") &&
-          node.attr("mn-keep-asciimath") != "false"
+        @keepasciimath = node.attr("mn-keep-asciimath") && node.attr("mn-keep-asciimath") != "false"
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        @filename = node.attr("docfile") ?
-          File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
+        @filename = node.attr("docfile") ?  File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
         @localdir = Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -119,11 +117,9 @@ module Asciidoctor
 
       def default_fonts(node)
         b = node.attr("body-font") ||
-          (node.attr("script") == "Hans" ? '"SimSun",serif' :
-           '"Cambria",serif')
+          (node.attr("script") == "Hans" ? '"SimSun",serif' : '"Cambria",serif')
         h = node.attr("header-font") ||
-          (node.attr("script") == "Hans" ? '"SimHei",sans-serif' :
-           '"Cambria",serif')
+          (node.attr("script") == "Hans" ? '"SimHei",sans-serif' : '"Cambria",serif')
         m = node.attr("monospace-font") || '"Courier New",monospace'
         "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
       end
@@ -154,8 +150,7 @@ module Asciidoctor
       end
 
       def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>",
-                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
+        result = ["<?xml version='1.0' encoding='UTF-8'?>", "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -192,16 +187,14 @@ module Asciidoctor
 
       def term_source_attrs(seen_xref)
         { bibitemid: seen_xref.children[0]["target"],
-          format: seen_xref.children[0]["format"],
-          type: "inline" }
+          format: seen_xref.children[0]["format"], type: "inline" }
       end
 
       def add_term_source(xml_t, seen_xref, m)
         if seen_xref.children[0].name == "concept"
           xml_t.origin { |o| o << seen_xref.children[0].to_xml }
         else
-          xml_t.origin seen_xref.children[0].content,
-            **attr_code(term_source_attrs(seen_xref))
+          xml_t.origin seen_xref.children[0].content, **attr_code(term_source_attrs(seen_xref))
         end
         m[:text] && xml_t.modification do |mod|
           mod.p { |p| p << m[:text].sub(/^\s+/, "") }
@@ -219,8 +212,7 @@ module Asciidoctor
 
       def extract_termsource_refs(text, node)
         matched = TERM_REFERENCE_RE.match text
-        matched.nil? and
-          @log.add("AsciiDoc Input", node, "term reference not in expected format: #{text}")
+        matched.nil? and @log.add("AsciiDoc Input", node, "term reference not in expected format: #{text}")
         matched
       end
 

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
     </element>
   </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/standoc/cleanup.rb

@@ -176,7 +176,7 @@ module Asciidoctor
 
       # presuppose multichar mi upright, singlechar mi MathML default italic
       def mathml_italicise(x)
-        x.xpath(".//m:mi", "m" => MATHML_NS).each do |i|
+        x.xpath(".//m:mi[not(ancestor::*[@mathvariant])]", "m" => MATHML_NS).each do |i|
           char = HTMLEntities.new.decode(i.text)
           i["mathvariant"] = "normal" if mi_italicise?(char)
         end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -133,14 +133,6 @@ module Asciidoctor
       end
 
       # examples containing only figures become subfigures of figures
-      def subfigure_cleanup(xmldoc)
-        nodes = xmldoc.xpath("//example/figure")
-        while !nodes.empty?
-          nodes[0].parent.name = "figure"
-          nodes = xmldoc.xpath("//example/figure")
-        end
-      end
-
       def subfigure_cleanup(xmldoc)
         xmldoc.xpath("//example[figure]").each do |e|
           next unless e.elements.map { |m| m.name }.

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -3,14 +3,12 @@ module Asciidoctor
     module Cleanup
       def external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
-          @lang, @script)
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"), @lang, @script)
       end
 
       def internal_external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
-          @lang, @script)
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"), @lang, @script)
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
@@ -19,11 +17,9 @@ module Asciidoctor
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
         end
-        if source.empty? && term.nil?
-          div.next = @i18n.no_terms_boilerplate
-        else
-          div.next = term_defs_boilerplate_cont(source, term, isodoc)
-        end
+        a = (source.empty? && term.nil?) ?  @i18n.no_terms_boilerplate :
+          term_defs_boilerplate_cont(source, term, isodoc)
+        a and div.next = a
       end
 
       def term_defs_boilerplate_cont(src, term, isodoc)
@@ -38,15 +34,14 @@ module Asciidoctor
       end
 
       def norm_ref_preface(f)
-      refs = f.elements.select do |e|
-        ["reference", "bibitem"].include? e.name
+        refs = f.elements.select do |e|
+          ["reference", "bibitem"].include? e.name
+        end
+        f.at("./title").next =
+          "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
       end
-      f.at("./title").next =
-        "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
-    end
 
-      TERM_CLAUSE = "//sections/terms | "\
-        "//sections/clause[descendant::terms]".freeze
+      TERM_CLAUSE = "//sections/terms | //sections/clause[descendant::terms]".freeze
 
       NORM_REF = "//bibliography/references[@normative = 'true']".freeze
 
@@ -59,15 +54,33 @@ module Asciidoctor
         @isodoc
       end
 
+      def termdef_boilerplate_cleanup(xmldoc)
+        #termdef_remove_initial_paras(xmldoc)
+      end
+
+      def termdef_remove_initial_paras(xmldoc)
+        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
+      end
+
+      def termdef_unwrap_boilerplate_clauses(xmldoc)
+        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
+          f.xpath(".//clause[@type = 'boilerplate']").each do |c|
+            c&.at("./title")&.remove
+            c.replace(c.children)
+          end
+        end
+      end
+
       def boilerplate_cleanup(xmldoc)
         isodoc = boilerplate_isodoc(xmldoc)
+        termdef_boilerplate_cleanup(xmldoc)
         xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
-          term_defs_boilerplate(f.at("./title"),
-                                xmldoc.xpath(".//termdocsource"),
+          next if f.at("./clause[@type = 'boilerplate']")
+          term_defs_boilerplate(f.at("./title"), xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
         end
-        f = xmldoc.at(self.class::NORM_REF) and
-          norm_ref_preface(f)
+        termdef_unwrap_boilerplate_clauses(xmldoc)
+        f = xmldoc.at(self.class::NORM_REF) and norm_ref_preface(f)
         initial_boilerplate(xmldoc, isodoc)
       end
 

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -125,7 +125,7 @@ module Asciidoctor
       def concept_termbase_cleanup(x)
         text = x&.children&.first&.remove&.text
         termbase, key = x["key"].split(/:/, 2)
-        x.add_child(%(<termref base="#{termbase}" target="#{key}">) + 
+        x.add_child(%(<termref base="#{termbase}" target="#{key}">) +
                     "#{text}</termref>")
       end
 
@@ -155,6 +155,8 @@ module Asciidoctor
         ret
       end
 
+      module_function :to_ncname
+
       def to_xreftarget(s)
         return to_ncname(s) unless /^[^#]+#.+$/.match(s)
           /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ s

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -16,8 +16,7 @@ module Asciidoctor
         insert = refs&.at("./bibitem")&.previous_element
         refs.xpath("./bibitem").each { |b| b.remove }
         bib.reverse.each do |b|
-          insert and insert.next = b.to_xml or
-            refs.children.first.add_previous_sibling b.to_xml
+          insert and insert.next = b.to_xml or refs.children.first.add_previous_sibling b.to_xml
         end
         extract_notes_from_biblio(refs)
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
@@ -49,12 +48,14 @@ module Asciidoctor
       # consecutively, but that standards codes are preserved as is:
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
-        r = xmldoc.at("//references | //clause[.//references] | "\
-                      "//annex[.//references]") or return
-        r.xpath(".//bibitem[not(ancestor::bibitem)]").each_with_index do |b, i|
-          next unless docid = b.at("./docidentifier[@type = 'metanorma']")
-          next unless  /^\[\d+\]$/.match(docid.text)
-          docid.children = "[#{i + 1}]"
+        i = 0
+        xmldoc.xpath("//bibliography//references | //clause//references | //annex//references").each do |r|
+          r.xpath("./bibitem").each do |b|
+            i += 1
+            next unless docid = b.at("./docidentifier[@type = 'metanorma']")
+            next unless  /^\[\d+\]$/.match(docid.text)
+            docid.children = "[#{i}]"
+          end
         end
       end
 
@@ -123,8 +124,7 @@ module Asciidoctor
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
           validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.new(
-            RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
+          bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
           bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
           c.replace(bibitem.root)
@@ -135,14 +135,11 @@ module Asciidoctor
         id = bib["id"]
         id ||= c["id"] unless /^_/.match(c["id"]) # do not accept implicit id
         unless id
-          @log.add("Anchors", c, "The following reference is missing "\
-                   "an anchor:\n" + c.to_xml)
+          @log.add("Anchors", c, "The following reference is missing an anchor:\n" + c.to_xml)
           return
         end
-        bib["title"] or @log.add("Bibliography", c, "Reference #{id} "\
-                                 "is missing a title")
-        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} "\
-                                 "is missing a document identifier (docid)")
+        bib["title"] or @log.add("Bibliography", c, "Reference #{id} is missing a title")
+        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} is missing a document identifier (docid)")
       end
 
       def extract_from_p(tag, bib, key)
@@ -173,8 +170,7 @@ module Asciidoctor
         return nil if dtd.children.empty?
         dtd.at("./dl") and return dl_bib_extract(dtd)
         elems = dtd.remove.elements
-        return p_unwrap(dtd) unless elems.size == 1 &&
-          %w(ol ul).include?(elems[0].name)
+        return p_unwrap(dtd) unless elems.size == 1 && %w(ol ul).include?(elems[0].name)
         ret = []
         elems[0].xpath("./li").each do |li|
           ret << p_unwrap(li)
@@ -192,8 +188,7 @@ module Asciidoctor
         bib = {}
         key = ""
         dl.xpath("./dt | ./dd").each do |dtd|
-          dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or
-            add_to_hash(bib, key, dd_bib_extract(dtd))
+          dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or add_to_hash(bib, key, dd_bib_extract(dtd))
         end
         c.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip
@@ -221,8 +216,7 @@ module Asciidoctor
         File.file?(file) or return nil
         xml = Nokogiri::XML(File.read(file, encoding: "utf-8"))
         ret = xml.at("//*[local-name() = 'bibdata']") or return nil
-        ret = Nokogiri::XML(ret.to_xml.sub(
-          %r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
+        ret = Nokogiri::XML(ret.to_xml.sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
         ret.name = "bibitem"
         ins = ret.at("./*[local-name() = 'docidentifier']") or return nil
         ins.previous = %{<uri type="citation">#{uri}</uri>}
@@ -232,8 +226,7 @@ module Asciidoctor
 
       # if citation uri points to local file, get bibitem from it
       def fetch_local_bibitem(xmldoc)
-        xmldoc.xpath("//bibitem[formattedref]"\
-                     "[uri[@type = 'citation']]").each do |b|
+        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]").each do |b|
           uri = b&.at("./uri[@type = 'citation']")&.text
           bibitem = read_local_bibitem(uri) or next
           bibitem["id"] = b["id"]

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -1,3 +1,5 @@
+require_relative "term_lookup_cleanup"
+
 module Asciidoctor
   module Standoc
     module Cleanup
@@ -45,10 +47,6 @@ module Asciidoctor
         end
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
-      end
-
       def termdef_subclause_cleanup(xmldoc)
         xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
       end
@@ -81,11 +79,12 @@ module Asciidoctor
           x.name = "note"
         end
         xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
-          x.name = "note"
+          x.name = "example"
         end
       end
 
       def termdef_cleanup(xmldoc)
+        Asciidoctor::Standoc::TermLookupCleanup.new(xmldoc, @log).call
         termdef_from_termbase(xmldoc)
         termdef_unnest_cleanup(xmldoc)
         termdef_stem_cleanup(xmldoc)
@@ -93,7 +92,6 @@ module Asciidoctor
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
-        termdef_boilerplate_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
         term_children_cleanup(xmldoc) 
         termdocsource_cleanup(xmldoc)