metanorma-standoc 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11adce8b2fe42f3e2b4db51088b5818f5cff207a62cc19e33b27cf5a53160c47
-  data.tar.gz: 17967efeb1bc5c518a9498ec8329d7ae0fb6c77cb19bb911527aa15efd2f0881
+  metadata.gz: d6af6d01c6514c3fbfe4a1bbe33b088f15eb78c7243db92fb36694d050a84635
+  data.tar.gz: 4dc1bdc07d11ce753ff4a26482cf5adba8f81153da808a9eb68a6b4cdda13a89
 SHA512:
-  metadata.gz: 6bef6b7fb5db91fd23d039a2e01d69685ba049b3ef34ebb2c4eaafa2e144b54c6c948b1c0a91796b700c2c18494c048d79d71b21fe58e1437f994a296d950785
-  data.tar.gz: 6c4d35c69f213280a58dd8b5e53da18c4947cc5de3210397f35f19726dbcceb2a3ea4f26066f86ee2fca2e0d0a37d9941e6cb092a7625d557dfba25eb4367812
+  metadata.gz: dc0064271a3104f6e26cecdd33228befe52771b31aff7aa18e44325851ebaeb5d2bda60aca28fe5113d87097df945153723553526357e7d6225176a9dbc1067f
+  data.tar.gz: b5f306f4fbab92edefee5887fb3acaa22d31583d37d0de0ddb8d8c469a17ced57d8300ab6254e0c860e3aa7c6519e0ce5f77eaa7986e49bfb497672997c7c743

data/.github/workflows/rake.yml

@@ -0,0 +1,66 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main  ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - name: install plantuml ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        uses: nick-invision/retry@v1
+        with:
+          polling_interval_seconds: 5
+          timeout_minutes: 5
+          max_attempts: 3
+          command: >
+            sudo apt-get update -y && sudo bash -c 
+            "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
+
+      - if: matrix.os == 'macos-latest'
+        run: brew install plantuml
+
+      - if: matrix.os == 'windows-latest'
+        run: cinst -y plantuml
+
+      - run: bundle exec rake

data/README.adoc

@@ -1,9 +1,7 @@
 = Metanorma-standoc
 
 image:https://img.shields.io/gem/v/metanorma-standoc.svg["Gem Version", link="https://rubygems.org/gems/metanorma-standoc"]
-image:https://github.com/metanorma/metanorma-standoc/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-standoc/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-standoc/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-standoc/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-standoc/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-standoc/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-standoc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-standoc/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-standoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-standoc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-standoc.svg["Pull Requests", link="https://github.com/metanorma/metanorma-standoc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-standoc/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-standoc/releases"]

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

@@ -69,6 +69,7 @@ module Asciidoctor
         bibdata_cleanup(xmldoc)
         boilerplate_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
+        variant_cleanup(xmldoc)
         para_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
         img_cleanup(xmldoc)
@@ -155,17 +156,42 @@ module Asciidoctor
         x.children = math
       end
 
+      MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze
+
       def mathml_preserve_space(m)
-        m.xpath(".//m:mtext",
-                "m" => "http://www.w3.org/1998/Math/MathML").each do |x|
+        m.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
           x.children = x.children.to_xml.gsub(/^\s/, " ").
             gsub(/\s$/, " ")
         end
       end
 
       def mathml_namespace(stem)
-        stem.xpath("./math", ).each do |x|
-          x.default_namespace = "http://www.w3.org/1998/Math/MathML"
+        stem.xpath("./math", ).each { |x| x.default_namespace = MATHML_NS }
+      end
+
+      def mathml_mi_italics
+        { uppergreek: true, upperroman: true,
+          lowergreek: true, lowerroman: true }
+      end
+
+      # presuppose multichar mi upright, singlechar mi MathML default italic
+      def mathml_italicise(x)
+        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
+      end
+
+      def mi_italicise?(c)
+        return false if c.length > 1
+        if /\p{Greek}/.match(c)
+          /\p{Lower}/.match(c) && !mathml_mi_italics[:lowergreek] ||
+            /\p{Upper}/.match(c) && !mathml_mi_italics[:uppergreek]
+        elsif /\p{Latin}/.match(c)
+          /\p{Lower}/.match(c) && !mathml_mi_italics[:lowerroman] ||
+            /\p{Upper}/.match(c) && !mathml_mi_italics[:upperroman]
+        else
+          false
         end
       end
 
@@ -174,6 +200,7 @@ module Asciidoctor
           xml_unescape_mathml(x)
           mathml_namespace(x)
           mathml_preserve_space(x)
+          mathml_italicise(x)
         end
       end
 
@@ -192,6 +219,27 @@ module Asciidoctor
           i["src"] = datauri(i["src"])
         end
       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
+        xmldoc.xpath("//*[variant]").each do |c|
+          next unless c.children.any? do |n|
+            n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
+          end
+          c.xpath("./variant").each do |n|
+            if n.at_xpath('preceding-sibling::node()[not(self::text()'\
+                '[not(normalize-space())])][1][self::variantwrap]')
+              n.previous_element << n
+            else
+              n.replace('<variantwrap/>').first << n
+            end
+          end
+        end
+        xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -19,12 +19,22 @@ module Asciidoctor
         end
       end
 
+      def dl1_table_cleanup(xmldoc)
+        q = "//table/following-sibling::*[1][self::dl]"
+        xmldoc.xpath(q).each do |s|
+          if s["key"] == "true"
+            s.previous_element << s.remove
+          end
+        end
+      end
+
       # move Key dl after table footer
-      def dl_table_cleanup(xmldoc)
+      def dl2_table_cleanup(xmldoc)
         q = "//table/following-sibling::*[1][self::p]"
         xmldoc.xpath(q).each do |s|
           if s.text =~ /^\s*key[^a-z]*$/i && !s.next_element.nil? &&
               s.next_element.name == "dl"
+            s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
           end
@@ -54,7 +64,8 @@ module Asciidoctor
       end
 
       def table_cleanup(xmldoc)
-        dl_table_cleanup(xmldoc)
+        dl1_table_cleanup(xmldoc)
+        dl2_table_cleanup(xmldoc)
         notes_table_cleanup(xmldoc)
         header_rows_cleanup(xmldoc)
       end
@@ -74,22 +85,47 @@ module Asciidoctor
 
       # include where definition list inside stem block
       def formula_cleanup(x)
+        formula_cleanup_where1(x)
+        formula_cleanup_where2(x)
+      end
+
+      def formula_cleanup_where1(x)
+        q = "//formula/following-sibling::*[1][self::dl]"
+        x.xpath(q).each do |s|
+          if s["key"] == "true"
+            s.previous_element << s.remove
+          end
+        end
+      end
+
+      def formula_cleanup_where2(x)
         q = "//formula/following-sibling::*[1][self::p]"
         x.xpath(q).each do |s|
           if s.text =~ /^\s*where[^a-z]*$/i && !s.next_element.nil? &&
               s.next_element.name == "dl"
+            s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
           end
         end
       end
 
+      def figure_dl_cleanup1(xmldoc)
+        q = "//figure/following-sibling::*[self::dl]"
+        xmldoc.xpath(q).each do |s|
+          if s["key"] == "true"
+            s.previous_element << s.remove
+          end
+        end
+      end
+
       # include key definition list inside figure
-      def figure_dl_cleanup(xmldoc)
+      def figure_dl_cleanup2(xmldoc)
         q = "//figure/following-sibling::*[self::p]"
         xmldoc.xpath(q).each do |s|
           if s.text =~ /^\s*key[^a-z]*$/i && !s.next_element.nil? &&
               s.next_element.name == "dl"
+            s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
           end
@@ -115,7 +151,8 @@ module Asciidoctor
 
       def figure_cleanup(xmldoc)
         figure_footnote_cleanup(xmldoc)
-        figure_dl_cleanup(xmldoc)
+        figure_dl_cleanup1(xmldoc)
+        figure_dl_cleanup2(xmldoc)
         subfigure_cleanup(xmldoc)
       end
 

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
 
@@ -91,10 +104,24 @@ module Asciidoctor
       end
 
       def bibdata_cleanup(xmldoc)
+        bibdata_anchor_cleanup(xmldoc)
+        bibdata_docidentifier_cleanup(xmldoc)
+      end
+
+      def bibdata_anchor_cleanup(xmldoc)
         xmldoc.xpath("//bibdata//bibitem | //bibdata//note").each do |b|
           b.delete("id")
         end
       end
+
+      def bibdata_docidentifier_cleanup(xmldoc)
+        ins = xmldoc.at("//bibdata/docidentifier")
+        xmldoc.xpath("//bibdata/docidentifier").each_with_index do |b, i|
+          next if i == 0
+          ins.next = b.remove
+          ins = ins.next
+        end
+      end
     end
   end
 end