metanorma-standoc 1.6.5 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f510c7d84985eb301f3bfe71f4ebe89f39961a6b9ec113a9e019537056e3933
-  data.tar.gz: a0844efae9739bfd19ab8263dd9a5b1edff6883b443f5c7fb399a056cd528bfa
+  metadata.gz: 28995a48904029f160e1da3411c440ac27e3b4f84405e8fc1f8680214bc79c42
+  data.tar.gz: bfce935749b5da318ebfe12c458210db5bc884ce7fa37126de4c3eff0e22e9d4
 SHA512:
-  metadata.gz: f9fa2f578c9b742860c5464141a2efbe1d565061148e0aa701520cfe8cfe0ef0828c46ffa21883d893190af37efc7c31a792d4a11a6c8775a43ca6bae6b08aa9
-  data.tar.gz: 63a79d788f62977472a2ff3c21d1926dfb52b43722092f82f721cbcfb8748caba1adec96fb3062c02dab8fb7d74b9dc691bcb70dca9f91121d778122444158bc
+  metadata.gz: b3839c128f0b278364e7a91f64529cbe2709c504e52aa82c31d284986b45f8ffc8a55a8c2871a7eee481bdbe8c5bdedb58c7b459b3a5aab0d64d7baf7d46f859
+  data.tar.gz: d26bfe3ca6146c2d6d7bf68d3a1112a8afde89f88a9713dbafb40a304f002b76d6e225d5fda3dd71eaa2f6c603cd4a362d1735cc4e83e822f0545efb86665adf

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

@@ -7,6 +7,7 @@ require "open-uri"
 require "isodoc"
 require "relaton"
 require "fileutils"
+require "metanorma-utils"
 
 module Asciidoctor
   module Standoc
@@ -91,6 +92,7 @@ module Asciidoctor
         @draft = false
         @refids = Set.new
         @anchors = {}
+        @internal_eref_namespaces = []
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @smartquotes = node.attr("smartquotes") != "false"
@@ -98,7 +100,7 @@ module Asciidoctor
         @fontheader = default_fonts(node)
         @files_to_delete = []
         @filename = node.attr("docfile") ?  File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
-        @localdir = Utils::localdir(node)
+        @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
@@ -106,20 +108,22 @@ module Asciidoctor
         @seen_headers = []
         @datauriimage = node.attr("data-uri-image")
         @boilerplateauthority = node.attr("boilerplate-authority")
-        @log = Asciidoctor::Standoc::Log.new
+        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
+        @sourcecode_markup_end = node.attr("sourcecode-markup-start") || "}}}"
+        @log = Metanorma::Utils::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
         @lang = (node.attr("language") || "en")
-        @script = (node.attr("script") || "Latn")
+        @script = (node.attr("script") || default_script(node.attr("language")))
         @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
         @i18n = @isodoc.i18n
       end
 
       def default_fonts(node)
         b = node.attr("body-font") ||
-          (node.attr("script") == "Hans" ? '"SimSun",serif' : '"Cambria",serif')
+          (node.attr("script") == "Hans" ? '"Source Han Sans",serif' : '"Cambria",serif')
         h = node.attr("header-font") ||
-          (node.attr("script") == "Hans" ? '"SimHei",sans-serif' : '"Cambria",serif')
+          (node.attr("script") == "Hans" ? '"Source Han Sans",sans-serif' : '"Cambria",serif')
         m = node.attr("monospace-font") || '"Courier New",monospace'
         "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
       end
@@ -185,52 +189,35 @@ module Asciidoctor
         end
       end
 
-      def term_source_attrs(seen_xref)
-        { bibitemid: seen_xref.children[0]["target"],
-          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 }
+      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"
         else
-          xml_t.origin seen_xref.children[0].content, **attr_code(term_source_attrs(seen_xref))
+          "Latn"
         end
-        m[:text] && xml_t.modification do |mod|
-          mod.p { |p| p << m[:text].sub(/^\s+/, "") }
-        end
-      end
-
-      TERM_REFERENCE_RE_STR = <<~REGEXP.freeze
-        ^(?<xref><(xref|concept)[^>]+>([^<]*</(xref|concept)>)?)
-               (,\s(?<text>.*))?
-        $
-      REGEXP
-      TERM_REFERENCE_RE =
-        Regexp.new(TERM_REFERENCE_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
-                   Regexp::IGNORECASE | Regexp::MULTILINE)
-
-      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
-      end
-
-      def termsource(node)
-        matched = extract_termsource_refs(node.content, node) || return
-        noko do |xml|
-          attrs = { status: matched[:text] ? "modified" : "identical" }
-          xml.termsource **attrs do |xml_t|
-            seen_xref = Nokogiri::XML.fragment(matched[:xref])
-            add_term_source(xml_t, seen_xref, matched)
-          end
-        end.join("\n")
       end
 
       private
 
       def outputdir(node)
-        if node.attr("output_dir").nil_or_empty? then Utils::localdir(node)
+        if node.attr("output_dir").nil_or_empty? then Metanorma::Utils::localdir(node)
         else File.join(node.attr("output_dir"), "")
         end
       end

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -729,12 +729,29 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
       <optional>
-        <attribute name="secondary"/>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <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>

data/lib/asciidoctor/standoc/blocks.rb

@@ -6,11 +6,11 @@ module Asciidoctor
   module Standoc
     module Blocks
       def id_attr(node = nil)
-        { id: Utils::anchor_or_uuid(node) }
+        { id: Metanorma::Utils::anchor_or_uuid(node) }
       end
 
       def id_unnum_attrs(node)
-        attr_code( id: Utils::anchor_or_uuid(node),
+        attr_code( id: Metanorma::Utils::anchor_or_uuid(node),
                   unnumbered: node.option?("unnumbered") ? "true" : nil,
                   number: node.attr("number"),
                   subsequence: node.attr("subsequence") )
@@ -29,7 +29,7 @@ module Asciidoctor
       # We append each contained block to its parent
       def open(node)
         role = node.role || node.attr("style")
-        Utils::reqt_subpart(role) and return requirement_subpart(node)
+        reqt_subpart(role) and return requirement_subpart(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -45,7 +45,7 @@ module Asciidoctor
         noko do |xml|
           xml.figure **literal_attrs(node) do |f|
             figure_title(node, f)
-            f.pre node.lines.join("\n"), **attr_code(id: Utils::anchor_or_uuid,
+            f.pre node.lines.join("\n"), **attr_code(id: Metanorma::Utils::anchor_or_uuid,
                                                      alt: node.attr("alt"))
           end
         end
@@ -121,7 +121,7 @@ module Asciidoctor
 
       def para_attrs(node)
         attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                        id: Utils::anchor_or_uuid(node)))
+                                        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
@@ -135,7 +135,7 @@ module Asciidoctor
 
       def quote_attrs(node)
         attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                        id: Utils::anchor_or_uuid(node)))
+                                        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -160,7 +160,7 @@ module Asciidoctor
 
       def listing_attrs(node)
         attr_code(keep_attrs(node).merge(lang: node.attr("language"),
-                                        id: Utils::anchor_or_uuid(node),
+                                        id: Metanorma::Utils::anchor_or_uuid(node),
                                         unnumbered: node.option?("unnumbered") ? "true" : nil,
                                         number: node.attr("number"),
                                         filename: node.attr("filename")))

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -35,7 +35,7 @@ module Asciidoctor
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
         date += "T00:00:00Z" unless /T/.match date
         attr_code(
-          id: Utils::anchor_or_uuid(node),
+          id: ::Metanorma::Utils::anchor_or_uuid(node),
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
           date: date )
       end
@@ -69,7 +69,7 @@ module Asciidoctor
         a = node.attr("type") and ["danger", "safety precautions"].each do |t|
           name = t if a.casecmp(t).zero?
         end
-        attr_code(keep_attrs(node).merge(id: Utils::anchor_or_uuid(node), type: name,
+        attr_code(keep_attrs(node).merge(id: Metanorma::Utils::anchor_or_uuid(node), type: name,
                   beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
       end
 

data/lib/asciidoctor/standoc/cleanup.rb

@@ -5,6 +5,7 @@ require "html2doc"
 require_relative "./cleanup_block.rb"
 require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
+require_relative "./cleanup_ref_dl.rb"
 require_relative "./cleanup_boilerplate.rb"
 require_relative "./cleanup_section.rb"
 require_relative "./cleanup_terms.rb"
@@ -27,8 +28,7 @@ module Asciidoctor
         text = text.gsub(%r{<stem type="AsciiMath">(.+?)</stem>}m) do |m|
             "<amathstem>#{HTMLEntities.new.decode($1)}</amathstem>"
           end
-          text = Html2Doc.
-            asciimath_to_mathml(text, ["<amathstem>", "</amathstem>"])
+          text = Html2Doc.asciimath_to_mathml(text, ["<amathstem>", "</amathstem>"])
           x =  Nokogiri::XML(text)
           x.xpath("//*[local-name() = 'math'][not(parent::stem)]").each do |y|
             y.wrap("<stem type='MathML'></stem>")
@@ -78,14 +78,14 @@ module Asciidoctor
       end
 
       def smartquotes_cleanup(xmldoc)
-        xmldoc.xpath("//date").each { |d| Utils::endash_date(d) }
+        xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         xmldoc.traverse 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(Utils::smartformat(n.text))
+            n.replace(Metanorma::Utils::smartformat(n.text))
           else
             n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))#.
             #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
@@ -160,8 +160,7 @@ module Asciidoctor
 
       def mathml_preserve_space(m)
         m.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
-          x.children = x.children.to_xml.gsub(/^\s/, "&#xA0;").
-            gsub(/\s$/, "&#xA0;")
+          x.children = x.children.to_xml.gsub(/^\s/, "&#xA0;").gsub(/\s$/, "&#xA0;")
         end
       end
 

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -8,14 +8,14 @@ module Asciidoctor
     module Cleanup
       def para_cleanup(xmldoc)
         ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
-         "//ul[not(ancestor::bibdata)]",
+         "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
          "//note[not(ancestor::bibitem or ancestor::table or ancestor::bibdata)]"
         ].each { |w| inject_id(xmldoc, w) }
       end
 
       def inject_id(xmldoc, path)
         xmldoc.xpath(path).each do |x|
-          x["id"] ||= Utils::anchor_or_uuid
+          x["id"] ||= Metanorma::Utils::anchor_or_uuid
         end
       end
 
@@ -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 }.
@@ -193,7 +185,7 @@ module Asciidoctor
       def requirement_descriptions(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
           r.children.each do |e|
-            unless e.element? && (Utils::reqt_subpart(e.name) ||
+            unless e.element? && (reqt_subpart(e.name) ||
                 %w(requirement recommendation permission).include?(e.name))
               t = Nokogiri::XML::Element.new("description", x)
               e.before(t)

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
 
@@ -93,6 +106,7 @@ module Asciidoctor
       def bibdata_cleanup(xmldoc)
         bibdata_anchor_cleanup(xmldoc)
         bibdata_docidentifier_cleanup(xmldoc)
+                biblio_indirect_erefs(xmldoc, @internal_eref_namespaces&.uniq)
       end
 
       def bibdata_anchor_cleanup(xmldoc)
@@ -109,6 +123,61 @@ module Asciidoctor
           ins = ins.next
         end
       end
+
+       def gather_indirect_erefs(xmldoc, prefix)
+        xmldoc.xpath("//eref[@type = '#{prefix}']").each_with_object({}) do |e, m|
+          e.delete("type")
+          m[e["bibitemid"]] = true
+        end.keys
+      end
+
+      def insert_indirect_biblio(xmldoc, refs, prefix)
+        ins = xmldoc.at("bibliography") or
+          xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
+        ins = ins.add_child("<references hidden='true' normative='false'/>").first
+        refs.each do |x|
+          ins << <<~END
+            <bibitem id="#{x}" type="internal">
+            <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
+            </bibitem>
+          END
+        end
+      end
+
+      def indirect_eref_to_xref(e, id)
+        loc = e&.at("./localityStack[locality[@type = 'anchor']]")&.remove&.text ||
+          e&.at("./locality[@type = 'anchor']")&.remove&.text || id
+        e.name = "xref"
+        e.delete("bibitemid")
+        e.delete("citeas")
+        e["target"] = loc
+        unless e.document.at("//*[@id = '#{loc}']")
+          e.children = %(** Missing target #{loc})
+          e["target"] = id
+        end
+      end
+
+      def resolve_local_indirect_erefs(xmldoc, refs, prefix)
+        refs.each_with_object([]) do |r, m|
+          id = r.sub(/^#{prefix}_/, "")
+          if xmldoc.at("//*[@id = '#{id}'][@type = '#{prefix}']")
+            xmldoc.xpath("//eref[@bibitemid = '#{r}']").each do |e|
+              indirect_eref_to_xref(e, id)
+            end
+          else
+            m << r
+          end
+        end
+      end
+
+      def biblio_indirect_erefs(xmldoc, prefixes)
+        prefixes&.each do |prefix|
+          refs = gather_indirect_erefs(xmldoc, prefix)
+          refs = resolve_local_indirect_erefs(xmldoc, refs, prefix)
+          refs.empty? and next
+          insert_indirect_biblio(xmldoc, refs, prefix)
+        end
+      end
     end
   end
 end