metanorma-standoc 1.8.3 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a0e8bdc48a2fa268df4c2d2342787a3c1312eb349c0a8a37306c2674c4440e
-  data.tar.gz: e063188d68034654d5edf0d45b51b22b7018371dfeef1b252576b6d3d8fe57b9
+  metadata.gz: 4c6a59c6f6a5cfd1b0f6515cf768e060cf846f239b2336a6db7bfb8fef1b75ec
+  data.tar.gz: f88ef657e463750bdad1f01389f8fc9f30fb881ec4f517010a58ca8676c74e04
 SHA512:
-  metadata.gz: fd3fe9734d21153f7955dbd3b3eeade50bee97403a6bc53c18ef97cb72345970c7951f9d96b51916f4ce7a89ff56d6c8e6d9cf5b6d67482ed598c2c6ae8090e8
-  data.tar.gz: dbc628d7b0df786191086a908b0f849bb9f75dc23881030748313ed78350d9722675371483232bc52ebd38404ec1da79ee1e985484ae648212479a0b66ac346d
+  metadata.gz: 21a8546de21b8a31a98dc6b2a48a7afed919e847c4e25d54094b60e9ac5fe6489a42b7b0a99b42577f505232b5d2cbd8099c27a3a811db092cb305dfeeb396fe
+  data.tar.gz: 7bbe4985fcf8e3ffe2190552d16d3ece90cd462c4f5ab841241821ea527a00242cd1b17622f07cd6e9900b4875cbefbf0e84d21f7aae0a39ad7be571392ab007

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
@@ -35,49 +35,19 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - 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
+      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
 
       - 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
+      - uses: peter-evans/repository-dispatch@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 }}
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.gitignore

@@ -10,3 +10,5 @@ spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
 Gemfile.lock
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # 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.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
-  TargetRubyVersion: 2.6
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -43,6 +43,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           htmlstylesheet: node.attr("htmlstylesheet"),
+          htmlstylesheet_override: node.attr("htmlstylesheet-override"),
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
@@ -67,6 +68,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           wordstylesheet: node.attr("wordstylesheet"),
+          wordstylesheet_override: node.attr("wordstylesheet-override"),
           standardstylesheet: node.attr("standardstylesheet"),
           header: node.attr("header"),
           wordcoverpage: node.attr("wordcoverpage"),
@@ -139,7 +141,7 @@ module Asciidoctor
 
       def document(node)
         init(node)
-        ret = makexml(node).to_xml(indent: 2)
+        ret = makexml(node).to_xml(encoding: "US-ASCII", indent: 2)
         outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
         clean_exit
         ret

data/lib/asciidoctor/standoc/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/standoc/blocks.rb

@@ -45,8 +45,9 @@ 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: Metanorma::Utils::anchor_or_uuid,
-                                                     alt: node.attr("alt"))
+            f.pre node.lines.join("\n"),
+              **attr_code(id: Metanorma::Utils::anchor_or_uuid,
+                          alt: node.attr("alt"))
           end
         end
       end
@@ -78,9 +79,19 @@ module Asciidoctor
         example_proper(node)
       end
 
+      def svgmap_attrs(node)
+        attr_code( { id: node.id,
+                     unnumbered: node.option?("unnumbered") ? "true" : nil,
+                     number: node.attr("number"),
+                     subsequence: node.attr("subsequence") }.
+        merge(keep_attrs(node)))
+      end
+
       def svgmap_example(node)
         noko do |xml|
-          xml.svgmap **attr_code(example_attrs(node).merge(src: node.attr("src"), alt: node.attr("alt"))) do |ex|
+          xml.svgmap **attr_code(svgmap_attrs(node).merge(
+            src: node.attr("src"), alt: node.attr("alt"))) do |ex|
+            figure_title(node, ex)
             ex << node.content
           end
         end.join("\n")
@@ -129,8 +140,9 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                         id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node).
+                  merge(align: node.attr("align"), 
+                        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
@@ -143,8 +155,9 @@ module Asciidoctor
       end
 
       def quote_attrs(node)
-        attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                         id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node).
+                  merge(align: node.attr("align"), 
+                        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -168,11 +181,12 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(keep_attrs(node).merge(lang: node.attr("language"),
-                                         id: Metanorma::Utils::anchor_or_uuid(node),
-                                         unnumbered: node.option?("unnumbered") ? "true" : nil,
-                                         number: node.attr("number"),
-                                         filename: node.attr("filename")))
+        attr_code(keep_attrs(node).
+                  merge(lang: node.attr("language"),
+                        id: Metanorma::Utils::anchor_or_uuid(node),
+                        unnumbered: node.option?("unnumbered") ? "true" : nil,
+                        number: node.attr("number"),
+                        filename: node.attr("filename")))
       end
 
       # NOTE: html escaping is performed by Nokogiri

data/lib/asciidoctor/standoc/cleanup.rb

@@ -45,7 +45,6 @@ module Asciidoctor
         xref_cleanup(xmldoc)
         concept_cleanup(xmldoc)
         origin_cleanup(xmldoc)
-        svgmap_cleanup(xmldoc)
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
@@ -59,6 +58,7 @@ module Asciidoctor
         bookmark_cleanup(xmldoc)
         requirement_cleanup(xmldoc)
         bibdata_cleanup(xmldoc)
+        svgmap_cleanup(xmldoc)
         boilerplate_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
         variant_cleanup(xmldoc)
@@ -172,7 +172,7 @@ module Asciidoctor
 
       def img_cleanup(xmldoc)
         return xmldoc unless @datauriimage
-        xmldoc.xpath("//image").each { |i| i["src"] = datauri(i["src"]) }
+        xmldoc.xpath("//image").each { |i| i["src"] = Metanorma::Utils::datauri(i["src"], @localdir) }
       end
 
       def variant_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -29,7 +29,7 @@ module Asciidoctor
       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"
+          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -95,7 +95,7 @@ module Asciidoctor
       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"
+          if s.text =~ /^\s*where[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -114,7 +114,7 @@ module Asciidoctor
       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"
+          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -125,7 +125,9 @@ module Asciidoctor
       # examples containing only figures become subfigures of figures
       def subfigure_cleanup(xmldoc)
         xmldoc.xpath("//example[figure]").each do |e|
-          next unless e.elements.map { |m| m.name }.reject { |m| %w(name figure).include? m }.empty?
+          next unless e.elements.map { |m| m.name }.reject do |m|
+            %w(name figure).include? m
+          end.empty?
           e.name = "figure"
         end
       end
@@ -140,7 +142,8 @@ module Asciidoctor
       ELEMS_ALLOW_NOTES = %w[p formula ul ol dl figure].freeze
 
       # if a note is at the end of a section, it is left alone
-      # if a note is followed by a non-note block, it is moved inside its preceding block if it is not delimited
+      # if a note is followed by a non-note block, 
+      # it is moved inside its preceding block if it is not delimited
       # (so there was no way of making that block include the note)
       def note_cleanup(xmldoc)
         q = "//note[following-sibling::*[not(local-name() = 'note')]]"
@@ -150,8 +153,10 @@ module Asciidoctor
           prev = n.previous_element || next
           n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
         end
-        xmldoc.xpath("//note[@keep-separate]").each { |n| n.delete("keep-separate") }
-        xmldoc.xpath("//termnote[@keep-separate]").each { |n| n.delete("keep-separate") }
+        xmldoc.xpath("//note[@keep-separate] | "\
+                     "//termnote[@keep-separate]").each do |n|
+          n.delete("keep-separate")
+        end
       end
 
       def requirement_cleanup(x)
@@ -184,18 +189,50 @@ module Asciidoctor
       end
 
       def requirement_cleanup1(r)
-        while d = r.at("./description[following-sibling::*[1][self::description]]")
+        while d = r.at("./description[following-sibling::*[1]"\
+            "[self::description]]")
           n = d.next.remove
           d << n.children
         end
-        r.xpath("./description[normalize-space(.)='']").each { |d| d.replace("\n") }
+        r.xpath("./description[normalize-space(.)='']").each do |d|
+          d.replace("\n")
+        end
       end
 
       def svgmap_cleanup(xmldoc)
+        svgmap_moveattrs(xmldoc)
         svgmap_populate(xmldoc)
         Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
       end
 
+      def guid?(x)
+        /^_[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i.
+          match(x)
+      end
+
+      def svgmap_moveattrs(xmldoc)
+        xmldoc.xpath("//svgmap").each do |s|
+          f = s.at(".//figure") or next
+          if t = s.at("./name") and !f.at("./name")
+            f.children.first.previous = t.remove
+          end
+          if s["id"] && guid?(f["id"])
+            f["id"] = s["id"]
+            s.delete("id")
+          end
+          svgmap_moveattrs1(s, f)
+        end
+      end
+
+      def svgmap_moveattrs1(s, f)
+        %w(unnumbered number subsequence keep-with-next
+          keep-lines-together).each do |a|
+            next if f[a] || !s[a]
+            f[a] = s[a]
+            s.delete(a)
+          end
+      end
+
       def svgmap_populate(xmldoc)
         xmldoc.xpath("//svgmap").each do |s|
           s1 = s.dup
@@ -204,8 +241,8 @@ module Asciidoctor
           s1.xpath(".//li").each do |li|
             t = li&.at(".//eref | .//link | .//xref") or next
             href = t.xpath("./following-sibling::node()")
-            next if href.empty?
-            s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
+            href.empty? or
+              s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
           end
         end
       end
@@ -215,7 +252,7 @@ module Asciidoctor
           next unless n.name == "link"
           n.children = n["target"]
         end
-        nodeset.text.sub(/^[,;]/, "").strip
+        nodeset.text.sub(/^[,; ]/, "").strip
       end
     end
   end

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -106,7 +106,7 @@ module Asciidoctor
       def bibdata_cleanup(xmldoc)
         bibdata_anchor_cleanup(xmldoc)
         bibdata_docidentifier_cleanup(xmldoc)
-                biblio_indirect_erefs(xmldoc, @internal_eref_namespaces&.uniq)
+        biblio_indirect_erefs(xmldoc, @internal_eref_namespaces&.uniq)
       end
 
       def bibdata_anchor_cleanup(xmldoc)
@@ -124,7 +124,7 @@ module Asciidoctor
         end
       end
 
-       def gather_indirect_erefs(xmldoc, prefix)
+      def gather_indirect_erefs(xmldoc, prefix)
         xmldoc.xpath("//eref[@type = '#{prefix}']").each_with_object({}) do |e, m|
           e.delete("type")
           m[e["bibitemid"]] = true
@@ -160,7 +160,7 @@ module Asciidoctor
       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}']")
+          if n = xmldoc.at("//*[@id = '#{id}']") and n.at("./ancestor-or-self::*[@type = '#{prefix}']")
             xmldoc.xpath("//eref[@bibitemid = '#{r}']").each do |e|
               indirect_eref_to_xref(e, id)
             end

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -2,6 +2,7 @@ require "nokogiri"
 require "pathname"
 require "open-uri"
 require "html2doc"
+require "asciimath2unitsml"
 require_relative "./cleanup_block.rb"
 require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
@@ -73,13 +74,49 @@ module Asciidoctor
         end
       end
 
+      UNITSML_NS = "https://schema.unitsml.org/unitsml/1.0".freeze
+
+      def add_misc_container(xmldoc)
+        unless ins = xmldoc.at("//misc-container")
+          a = xmldoc.at("//termdocsource") || xmldoc.at("//bibdata")
+          a.next = "<misc-container/>"
+          ins = xmldoc.at("//misc-container")
+        end
+        ins
+      end
+
+      def mathml_unitsML(xmldoc)
+        return unless xmldoc.at(".//m:*", "m" => UNITSML_NS)
+        misc = add_misc_container(xmldoc)
+        unitsml = misc.add_child("<UnitsML xmlns='#{UNITSML_NS}'/>").first
+        %w(Unit CountedItem Quantity Dimension Prefix).each do |t|
+          gather_unitsml(unitsml, xmldoc, t)
+        end
+      end
+
+      def gather_unitsml(unitsml, xmldoc, t)
+        tags = xmldoc.xpath(".//m:#{t}", "m" => UNITSML_NS).each_with_object({}) do |x, m|
+          m[x["id"]] = x.remove
+        end
+        return if tags.empty?
+        set = unitsml.add_child("<#{t}Set/>").first
+        tags.values.each { |v| set << v }
+      end
+
+      def asciimath2unitsml_options
+        { multiplier: :space }
+      end
+
       def mathml_cleanup(xmldoc)
+        unitsml = Asciimath2UnitsML::Conv.new(asciimath2unitsml_options)
         xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
           xml_unescape_mathml(x)
           mathml_namespace(x)
           mathml_preserve_space(x)
           mathml_italicise(x)
+          unitsml.MathML2UnitsML(x)
         end
+        mathml_unitsML(xmldoc)
       end
     end
   end