metanorma-standoc 1.5.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7503bfc7dd68c2d6a6b2ded8f08611e92067a15aa4088c02f1e5408ff8e027e6
-  data.tar.gz: 65cd5d4d3648788113fd30437fe8d649c6e498b9ebdab8d5b41d2fadb7439056
+  metadata.gz: e30bd97d527914e60d6dfcd537620ba7d2d5ae82d9d9c07e24d5a535dd9ec8ee
+  data.tar.gz: b8774965fcb7e698288f1793460fd67b982085e8d0951b35cfa6c4f102157e9a
 SHA512:
-  metadata.gz: 73510f7d926c6acf395377794a753cef6bb0f0658fb66c606df07e23548c17f010c7120b77765b388fb363a4309051fcf03a601d6ea95cf20aca6e4645b1c674
-  data.tar.gz: bae732755cc47dcae17e0d8ef01bcd35173c8941807b2d5844cf45f008f57c199977756d4fd15b0e3c8c558e73432dd9ba88be2b01f61b32cff180308adcd83d
+  metadata.gz: 74e250a48b25dd82c3174b78b515e57fe11bc3f4f8767d6942048bb3ef01ddf6937a6c2ff24ddb5e17d8f747eeb582b77248b28bdf50bc120a3fcfafd6f78221
+  data.tar.gz: a0fe35b39a730d18afe1cc7463b166377adb2137c4cfd9c650844e3a593e1a2312fa8242a8991a1508aaed44b7b7525a54cad7f747a177ea2848b27720cf644d

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

@@ -143,6 +143,11 @@ module Asciidoctor
         ret
       end
 
+      def version
+        flavour = self.class.name.sub(/::Converter$/, "").sub(/^.+::/, "")
+        Metanorma.versioned(Metanorma, flavour)[-1]::VERSION
+      end
+
       def clean_exit
         @log.write(@output_dir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
@@ -150,7 +155,7 @@ module Asciidoctor
 
       def makexml1(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>",
-                  "<#{xml_root_tag}>"]
+                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -158,17 +158,7 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <choice>
-          <ref name="formula"/>
-          <ref name="ul"/>
-          <ref name="ol"/>
-          <ref name="dl"/>
-          <ref name="quote"/>
-          <ref name="sourcecode"/>
-          <ref name="paragraph"/>
-          <ref name="table"/>
-          <ref name="figure"/>
-        </choice>
+        <ref name="paragraph"/>
       </oneOrMore>
     </element>
   </define>
@@ -1028,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

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)
@@ -81,12 +82,13 @@ module Asciidoctor
         xmldoc.traverse do |n|
           next unless n.text?
           if @smartquotes
-            next unless /[-'"(<>]|\.\.|\dx/.match(n)
-            next unless n.ancestors("pre, tt, sourcecode, bibdata, on, "\
-                                    "stem, figure[@class = 'pseudocode']").empty?
+            /[-'"(<>]|\.\.|\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))
           else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))
+            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))#.
+            #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
@@ -146,16 +148,59 @@ module Asciidoctor
         align_callouts_to_annotations(xmldoc)
       end
 
+      def xml_unescape_mathml(x)
+        return if x.children.any? { |y| y.element? }
+        math = x.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">").gsub(/&quot;/, '"').
+          gsub(/&apos;/, "'").gsub(/&amp;/, "&").
+          gsub(/<[^: \r\n\t\/]+:/, "<").gsub(/<\/[^ \r\n\t:]+:/, "</")
+        x.children = math
+      end
+
+      MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze
+
+      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;")
+        end
+      end
+
+      def mathml_namespace(stem)
+        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", "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
+
       def mathml_cleanup(xmldoc)
         xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
-          next if x.children.any? { |y| y.element? }
-          math = x.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">").gsub(/&quot;/, '"').
-            gsub(/&apos;/, "'").gsub(/&amp;/, "&").
-            gsub(/<[^: \r\n\t\/]+:/, "<").gsub(/<\/[^ \r\n\t:]+:/, "</").
-            gsub(/ xmlns[^>"']+/, "").
-            gsub(/<math /, '<math xmlns="http://www.w3.org/1998/Math/MathML" ').
-            gsub(/<math>/, '<math xmlns="http://www.w3.org/1998/Math/MathML">')
-          x.children = math
+          xml_unescape_mathml(x)
+          mathml_namespace(x)
+          mathml_preserve_space(x)
+          mathml_italicise(x)
         end
       end
 
@@ -174,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

@@ -91,10 +91,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

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -72,7 +72,32 @@ module Asciidoctor
         end
       end
 
+      def title_footnote_move(xmldoc)
+        ins = xmldoc.at("//bibdata/language")
+        xmldoc.xpath("//bibdata/title//fn").each do |f|
+          f.name = "note"
+          f["type"] = "title-footnote"
+          f.delete("reference")
+          ins.previous = f.remove
+        end
+      end
+
+      def footnote_block_cleanup(xmldoc)
+        xmldoc.xpath("//footnoteblock").each do |f|
+          f.name = 'fn'
+          if id = xmldoc.at("//*[@id = '#{f.text}']")
+            f.children = id.remove.children
+          else
+            @log.add("Crossreferences", f,
+                     "Could not resolve footnoteblock:[#{f.text}]")
+            f.children = "[ERROR]"
+          end
+        end
+      end
+
       def footnote_cleanup(xmldoc)
+        footnote_block_cleanup(xmldoc)
+        title_footnote_move(xmldoc)
         table_footnote_renumber(xmldoc)
         other_footnote_renumber(xmldoc)
         xmldoc.xpath("//fn").each do |fn|

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -49,8 +49,12 @@ module Asciidoctor
       end
 
       def extract_localities(x)
-        text = x&.children&.first&.remove&.text
-        extract_localities1(x, text)
+        f = x&.children&.first or return
+        f.text? or return
+        head = f.remove.text
+        tail = x&.children&.remove
+        extract_localities1(x, head)
+        tail and x << tail
       end
 
       def extract_localities1(x, text)

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -49,9 +49,8 @@ module Asciidoctor
       # consecutively, but that standards codes are preserved as is:
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
-        r = xmldoc.at("//references[@normative = 'false'] | "\
-                      "//clause[.//references[@normative = 'false']] | "\
-                      "//annex[.//references[@normative = 'false']]") or return
+        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)
@@ -127,7 +126,7 @@ module Asciidoctor
           bibitemxml = RelatonBib::BibliographicItem.new(
             RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
-          bibitem["id"] = c["id"] if c["id"]
+          bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
           c.replace(bibitem.root)
         end
       end