metanorma-standoc 1.9.2 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b789e06df237e881bdd055cfe9b90e191d781e71e82dd6a80c098f23b08934
-  data.tar.gz: 27f1499d7f7adccf29c2b9c9ac731e6ff1988a008530a4aa13e63adb4fbef490
+  metadata.gz: f5a985aefd39dadc19549ad39c23e0849bac873ea5883e50762ca911c8bd3aad
+  data.tar.gz: b7560f906a1e50fc4032f3261a44d1edcb2e691872b3e85d14a0363d7668b575
 SHA512:
-  metadata.gz: c72e91aac553b2e9d3151a59fde54b02ae5cb6340aeb0781dd4326d5a6bce3166e20fd2ece37d909c3e8b7f72d6d26892bd279d4256b190cf28dbe41e1bdbf3e
-  data.tar.gz: 8314c96a3af15b47d56c42cd040e369455616b40dafb37a3d2ee32d0ba46976293eee36f3b9ab99d3b2d94002df3f3bf0a319e98f262e0d5eb3049fb90c30d4f
+  metadata.gz: 437c04558d97c828a200ca21668a0e74e7e9fe5b5581ab759955f9ada241a0a87ccfddf114b7bd616430107e5869ce785c547715d627a08b87e35a30237b0516
+  data.tar.gz: 11d70602d2bd7733e9daab869ec22e3bf58ff6397378b38734711d46cb8f6e04b25e5b5fbcd3b5cd1e36b8e58a1061c92a87502fab945ea8a8c573205e25b126

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,12 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/standoc/base.rb

@@ -3,7 +3,6 @@ require "nokogiri"
 require "htmlentities"
 require "json"
 require "pathname"
-require "open-uri"
 require "isodoc"
 require "relaton"
 require "fileutils"
@@ -48,11 +47,13 @@ module Asciidoctor
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
+          scripts_override: node.attr("scripts-override"),
           scripts_pdf: node.attr("scripts-pdf"),
           datauriimage: node.attr("data-uri-image"),
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
           sectionsplit: node.attr("sectionsplit"),
         }
       end
@@ -80,6 +81,7 @@ module Asciidoctor
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
         }
 
         if font_manifest_file = node.attr("mn2pdf-font-manifest-file")

data/lib/asciidoctor/standoc/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/standoc/blocks.rb

@@ -41,7 +41,7 @@ module Asciidoctor
       def form(node)
         noko do |xml|
           xml.form **attr_code(
-            id: Metanorma::Utils::anchor_or_uuid,
+            id: Metanorma::Utils::anchor_or_uuid, class: node.attr("class"),
             name: node.attr("name"), action: node.attr("action")
           ) do |f|
             f << node.content

data/lib/asciidoctor/standoc/cleanup.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "pathname"
-require "open-uri"
 require "html2doc"
 require_relative "./cleanup_block"
 require_relative "./cleanup_footnotes"
@@ -48,6 +47,7 @@ module Asciidoctor
         xref_cleanup(xmldoc)
         concept_cleanup(xmldoc)
         origin_cleanup(xmldoc)
+        bookmark_cleanup(xmldoc)
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
@@ -58,7 +58,6 @@ module Asciidoctor
         mathml_cleanup(xmldoc)
         script_cleanup(xmldoc)
         docidentifier_cleanup(xmldoc)
-        bookmark_cleanup(xmldoc)
         requirement_cleanup(xmldoc)
         bibdata_cleanup(xmldoc)
         svgmap_cleanup(xmldoc)
@@ -72,24 +71,39 @@ module Asciidoctor
         xmldoc
       end
 
+      IGNORE_DUMBQUOTES = "//pre | //pre//* | //tt | //tt//* | "\
+        "//sourcecode | //sourcecode//* | //bibdata//* | //stem | "\
+        "//stem//* | //figure[@class = 'pseudocode'] | "\
+        "//figure[@class = 'pseudocode']//*".freeze
+
       def smartquotes_cleanup(xmldoc)
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
-        xmldoc.traverse do |n|
-          next unless n.text?
+        if @smartquotes then smartquotes_cleanup1(xmldoc)
+        else dumbquote_cleanup(xmldoc)
+        end
+      end
+
+      def smartquotes_cleanup1(xmldoc)
+        (xmldoc.xpath("//*[child::text()]") - xmldoc.xpath(IGNORE_DUMBQUOTES))
+          .each do |x|
+          x.children.each do |n|
+            next unless n.text?
 
-          if @smartquotes
             /[-'"(<>]|\.\.|\dx/.match(n) or next
 
-            n.ancestors("pre, tt, sourcecode, bibdata, on, "\
-                        "stem, figure[@class = 'pseudocode']").empty? or next
             n.replace(Metanorma::Utils::smartformat(n.text))
-          else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
-            # gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
 
+      def dumbquote_cleanup(xmldoc)
+        xmldoc.traverse do |n|
+          next unless n.text?
+
+          n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
+        end
+      end
+
       def docidentifier_cleanup(xmldoc); end
 
       TEXT_ELEMS =
@@ -125,11 +139,7 @@ module Asciidoctor
       end
 
       def variant_cleanup(xmldoc)
-        xmldoc.xpath("//*[variant]").each do |c|
-          c&.next&.text? && c&.next&.next&.name == "variant" &&
-            c.next.text.gsub(/\s/, "").empty? and
-            c.next.remove
-        end
+        variant_space_cleanup(xmldoc)
         xmldoc.xpath("//*[variant]").each do |c|
           next unless c.children.any? do |n|
             n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
@@ -147,6 +157,15 @@ module Asciidoctor
         end
         xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
       end
+
+      def variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[variant]").each do |c|
+          if c&.next&.text? && c&.next&.next&.name == "variant"
+            c.next.text.gsub(/\s/, "").empty? and
+              c.next.remove
+          end
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,6 +1,5 @@
 require "date"
 require "htmlentities"
-require "open-uri"
 
 module Asciidoctor
   module Standoc

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -158,11 +158,11 @@ module Asciidoctor
           xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
         ins = ins.add_child("<references hidden='true' normative='false'/>").first
         refs.each do |x|
-          ins << <<~END
+          ins << <<~BIB
             <bibitem id="#{x}" type="internal">
             <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
             </bibitem>
-          END
+          BIB
         end
       end
 

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -1,7 +1,6 @@
 require "date"
 require "htmlentities"
 require "json"
-require "open-uri"
 
 module Asciidoctor
   module Standoc

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -3,32 +3,54 @@ require "metanorma-utils"
 module Asciidoctor
   module Standoc
     module Cleanup
-      def empty_text_before_first_element(x)
-        x.children.each do |c|
-          return false if c.text? and /\S/.match(c.text)
+      def empty_text_before_first_element(elem)
+        elem.children.each do |c|
+          return false if c.text? && /\S/.match(c.text)
           return true if c.element?
         end
         true
       end
 
-      def strip_initial_space(x)
-        if x.children[0].text?
-          if !/\S/.match(x.children[0].text)
-            x.children[0].remove
-          else
-            x.children[0].content = x.children[0].text.gsub(/^ /, "")
-          end
+      def strip_initial_space(elem)
+        return unless elem.children[0].text?
+
+        if /\S/.match?(elem.children[0].text)
+          elem.children[0].content = elem.children[0].text.gsub(/^ /, "")
+        else
+          elem.children[0].remove
         end
       end
 
       def bookmark_cleanup(xmldoc)
+        li_bookmark_cleanup(xmldoc)
+        dt_bookmark_cleanup(xmldoc)
+      end
+
+      def bookmark_to_id(elem, bookmark)
+        parent = bookmark.parent
+        elem["id"] = bookmark.remove["id"]
+        strip_initial_space(parent)
+      end
+
+      def li_bookmark_cleanup(xmldoc)
         xmldoc.xpath("//li[descendant::bookmark]").each do |x|
-          if x&.elements&.first&.name == "p" &&
-              x&.elements&.first&.elements&.first&.name == "bookmark"
-            if empty_text_before_first_element(x.elements[0])
-              x["id"] = x.elements[0].elements[0].remove["id"]
-              strip_initial_space(x.elements[0])
-            end
+          if x.at("./*[1][local-name() = 'p']/"\
+                  "*[1][local-name() = 'bookmark']") &&
+              empty_text_before_first_element(x.elements[0])
+            bookmark_to_id(x, x.elements[0].elements[0])
+          end
+        end
+      end
+
+      def dt_bookmark_cleanup(xmldoc)
+        xmldoc.xpath("//dt[descendant::bookmark]").each do |x|
+          if x.at("./*[1][local-name() = 'p']/"\
+                  "*[1][local-name() = 'bookmark']") &&
+              empty_text_before_first_element(x.elements[0])
+            bookmark_to_id(x, x.elements[0].elements[0])
+          elsif x.at("./*[1][local-name() = 'bookmark']") &&
+              empty_text_before_first_element(x)
+            bookmark_to_id(x, x.elements[0])
           end
         end
       end
@@ -46,65 +68,67 @@ module Asciidoctor
       LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
                                Regexp::IGNORECASE | Regexp::MULTILINE)
 
-      def tq(x)
-        x.sub(/^"/, "").sub(/"$/, "")
+      def tq(text)
+        text.sub(/^"/, "").sub(/"$/, "")
       end
 
-      def extract_localities(x)
-        f = x&.children&.first or return
+      def extract_localities(elem)
+        f = elem&.children&.first or return
         f.text? or return
         head = f.remove.text
-        tail = x&.children&.remove
-        extract_localities1(x, head)
-        tail and x << tail
+        tail = elem&.children&.remove
+        extract_localities1(elem, head)
+        tail and elem << tail
       end
 
-      def extract_localities1(x, text)
-        b = x.add_child("<localityStack/>").first if LOCALITY_RE.match text
+      def extract_localities1(elem, text)
+        b = elem.add_child("<localityStack/>").first if LOCALITY_RE.match text
         while (m = LOCALITY_RE.match text)
           ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
           refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
           loc = m[:locality]&.downcase || m[:locality2]&.downcase
           b.add_child("<locality type='#{loc}'>#{ref}#{refto}</locality>")
           text = m[:text]
-          b = x.add_child("<localityStack/>").first if m[:punct] == ";"
+          b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
         end
-        x.add_child(text) if text
+        elem.add_child(text) if text
       end
 
-      def xref_to_eref(x)
-        x["bibitemid"] = x["target"]
-        unless x["citeas"] = @anchors&.dig(x["target"], :xref)
-          @internal_eref_namespaces.include?(x["type"]) or
-          @log.add("Crossreferences", x,
-                   "#{x['target']} does not have a corresponding anchor ID in the bibliography!")
+      def xref_to_eref(elem)
+        elem["bibitemid"] = elem["target"]
+        unless elem["citeas"] = @anchors&.dig(elem["target"], :xref)
+          @internal_eref_namespaces.include?(elem["type"]) or
+            @log.add("Crossreferences", elem,
+                     "#{elem['target']} does not have a corresponding "\
+                     "anchor ID in the bibliography!")
         end
-        x.delete("target")
-        extract_localities(x) unless x.children.empty?
+        elem.delete("target")
+        extract_localities(elem) unless elem.children.empty?
       end
 
       def xref_cleanup(xmldoc)
         xmldoc.xpath("//xref").each do |x|
           /:/.match(x["target"]) and xref_to_internal_eref(x)
           next unless x.name == "xref"
+
           if refid? x["target"]
             x.name = "eref"
             xref_to_eref(x)
-          else
-            x.delete("type")
+          else x.delete("type")
           end
         end
       end
 
-      def xref_to_internal_eref(x)
-        a = x["target"].split(":", 3)
-        unless  a.size < 2 || a[0].empty? || a[1].empty?
-          x["target"] = "#{a[0]}_#{a[1]}"
-          a.size > 2 and x.children = %{anchor="#{a[2..-1].join("")}",#{x&.children&.text}}
-          x["type"] = a[0]
+      def xref_to_internal_eref(elem)
+        a = elem["target"].split(":", 3)
+        unless a.size < 2 || a[0].empty? || a[1].empty?
+          elem["target"] = "#{a[0]}_#{a[1]}"
+          a.size > 2 and
+            elem.children = %{anchor="#{a[2..-1].join}",#{elem&.children&.text}}
+          elem["type"] = a[0]
           @internal_eref_namespaces << a[0]
-          x.name = "eref"
-          xref_to_eref(x)
+          elem.name = "eref"
+          xref_to_eref(elem)
         end
       end
 
@@ -116,10 +140,11 @@ module Asciidoctor
 
       def origin_cleanup(xmldoc)
         xmldoc.xpath("//origin/concept[termref]").each do |x|
-          x.replace(x.children)
+          t = x.at("./termref")
+          x.replace(t)
         end
         xmldoc.xpath("//origin").each do |x|
-          x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) ||
+          x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) or
             @log.add("Crossreferences", x,
                      "#{x['bibitemid']} does not have a corresponding anchor "\
                      "ID in the bibliography!")
@@ -128,68 +153,83 @@ module Asciidoctor
       end
 
       def concept_cleanup(xmldoc)
-        xmldoc.xpath("//concept").each do |x|
-          x.delete("term") if x["term"].empty?
-          if /:/.match(x["key"]) then concept_termbase_cleanup(x)
+        xmldoc.xpath("//concept[not(termxref)]").each do |x|
+          term = x.at("./refterm")
+          term&.remove if term&.text&.empty?
+          x.children.remove if x&.children&.text&.strip&.empty?
+          key_extract_locality(x)
+          if /:/.match?(x["key"]) then concept_termbase_cleanup(x)
           elsif refid? x["key"] then concept_eref_cleanup(x)
-          else
-            concept_xref_cleanup(x)
+          else concept_xref_cleanup(x)
           end
           x.delete("key")
         end
       end
 
-      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}">) +
-                    "#{text}</termref>")
+      def key_extract_locality(elem)
+        return unless /,/.match?(elem["key"])
+
+        elem.add_child("<locality>#{elem['key'].sub(/^[^,]+,/, '')}</locality>")
+        elem["key"] = elem["key"].sub(/,.*$/, "")
+      end
+
+      def concept_termbase_cleanup(elem)
+        t = elem&.at("./xrefrender")&.remove&.children
+        termbase, key = elem["key"].split(/:/, 2)
+        elem.add_child(%(<termref base="#{termbase}" target="#{key}">) +
+                       "#{t&.to_xml}</termref>")
       end
 
-      def concept_xref_cleanup(x)
-        text = x&.children&.first&.remove&.text
-        x.add_child(%(<xref target="#{x['key']}">#{text}</xref>))
+      def concept_xref_cleanup(elem)
+        t = elem&.at("./xrefrender")&.remove&.children
+        elem.add_child(%(<xref target="#{elem['key']}">#{t&.to_xml}</xref>))
       end
 
-      def concept_eref_cleanup(x)
-        x.children = "<eref>#{x.children.to_xml}</eref>"
-        extract_localities(x.first_element_child)
+      def concept_eref_cleanup(elem)
+        t = elem&.at("./xrefrender")&.remove&.children&.to_xml
+        l = elem&.at("./locality")&.remove&.children&.to_xml
+        elem.add_child "<eref bibitemid='#{elem['key']}'>#{l}</eref>"
+        extract_localities(elem.elements[-1])
+        elem.elements[-1].add_child(t) if t
       end
 
-      def to_xreftarget(s)
-        return Metanorma::Utils::to_ncname(s) unless /^[^#]+#.+$/.match(s)
-          /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ s
-        pref = pref.gsub(%r([#{Metanorma::Utils::NAMECHAR}]), "_")
-        suff = suff.gsub(%r([#{Metanorma::Utils::NAMECHAR}]), "_")
+      def to_xreftarget(str)
+        return Metanorma::Utils::to_ncname(str) unless /^[^#]+#.+$/.match?(str)
+
+        /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ str
+        pref = pref.gsub(%r([#{Metanorma::Utils::NAMECHAR}])o, "_")
+        suff = suff.gsub(%r([#{Metanorma::Utils::NAMECHAR}])o, "_")
         "#{pref}##{suff}"
       end
 
       IDREF = "//*/@id | //review/@from | //review/@to | "\
         "//callout/@target | //citation/@bibitemid | //eref/@bibitemid".freeze
 
-      def anchor_cleanup(x)
-        anchor_cleanup1(x)
-        xreftarget_cleanup(x)
+      def anchor_cleanup(elem)
+        anchor_cleanup1(elem)
+        xreftarget_cleanup(elem)
       end
 
-      def anchor_cleanup1(x)
-        x.xpath(IDREF).each do |s|
+      def anchor_cleanup1(elem)
+        elem.xpath(IDREF).each do |s|
           if (ret = Metanorma::Utils::to_ncname(s.value)) != (orig = s.value)
             s.value = ret
             output = s.parent.dup
             output.children.remove
-            @log.add("Anchors", s.parent, "normalised identifier in #{output} from #{orig}")
+            @log.add("Anchors", s.parent,
+                     "normalised identifier in #{output} from #{orig}")
           end
         end
       end
 
-      def xreftarget_cleanup(x)
-        x.xpath("//xref/@target").each do |s|
+      def xreftarget_cleanup(elem)
+        elem.xpath("//xref/@target").each do |s|
           if (ret = to_xreftarget(s.value)) != (orig = s.value)
             s.value = ret
             output = s.parent.dup
             output.children.remove
-            @log.add("Anchors", s.parent, "normalised identifier in #{output} from #{orig}")
+            @log.add("Anchors", s.parent,
+                     "normalised identifier in #{output} from #{orig}")
           end
         end
       end