metanorma-standoc 1.8.1 → 1.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28995a48904029f160e1da3411c440ac27e3b4f84405e8fc1f8680214bc79c42
-  data.tar.gz: bfce935749b5da318ebfe12c458210db5bc884ce7fa37126de4c3eff0e22e9d4
+  metadata.gz: d29f898d11836b1b9ae020605081f35a144ed06406a24776b93841d05cafac62
+  data.tar.gz: 5f47fb98bf9189ab80a18fe9f32150e0cf840f6860ec2317147122583748f162
 SHA512:
-  metadata.gz: b3839c128f0b278364e7a91f64529cbe2709c504e52aa82c31d284986b45f8ffc8a55a8c2871a7eee481bdbe8c5bdedb58c7b459b3a5aab0d64d7baf7d46f859
-  data.tar.gz: d26bfe3ca6146c2d6d7bf68d3a1112a8afde89f88a9713dbafb40a304f002b76d6e225d5fda3dd71eaa2f6c603cd4a362d1735cc4e83e822f0545efb86665adf
+  metadata.gz: 92cf686a035d48f5b0507d0fffa91b2b207f741cc14a939b498330065e204b6a194bab1b7796115ff790ae0f29e046d7bf429da1dd51b554b5251febd9b350eb
+  data.tar.gz: 91a13d5900acf6099186c51e294dd6f441bd298fdafa958bc53d8a0ef95dbfad4427cfad1464cffb1ced2ae840158cb9364c00249a25595b4cfea9a65d4f2136

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/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -104,12 +104,14 @@ module Asciidoctor
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
+        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
+        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
         @bibdb = nil
         @seen_headers = []
         @datauriimage = node.attr("data-uri-image")
         @boilerplateauthority = node.attr("boilerplate-authority")
         @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
-        @sourcecode_markup_end = node.attr("sourcecode-markup-start") || "}}}"
+        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
         @log = Metanorma::Utils::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
@@ -137,7 +139,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/blocks.rb

@@ -74,11 +74,20 @@ module Asciidoctor
         %w(recommendation requirement permission).include?(role) and
           return requirement(node, role)
         return pseudocode_example(node) if role == "pseudocode"
+        return svgmap_example(node) if role == "svgmap"
         example_proper(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|
+            ex << node.content
+          end
+        end.join("\n")
+      end
+
+      # prevent A's and other subs inappropriate for pseudocode
       def pseudocode_example(node)
-        # prevent A's and other subs inappropriate for pseudocode
         node.blocks.each { |b| b.remove_sub(:replacements) }
         noko do |xml|
           xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
@@ -121,7 +130,7 @@ module Asciidoctor
 
       def para_attrs(node)
         attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                        id: Metanorma::Utils::anchor_or_uuid(node)))
+                                         id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
@@ -135,7 +144,7 @@ module Asciidoctor
 
       def quote_attrs(node)
         attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                        id: Metanorma::Utils::anchor_or_uuid(node)))
+                                         id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -160,10 +169,10 @@ module Asciidoctor
 
       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")))
+                                         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

@@ -11,6 +11,7 @@ require_relative "./cleanup_section.rb"
 require_relative "./cleanup_terms.rb"
 require_relative "./cleanup_inline.rb"
 require_relative "./cleanup_amend.rb"
+require_relative "./cleanup_maths.rb"
 require "relaton_iev"
 
 module Asciidoctor
@@ -24,25 +25,15 @@ module Asciidoctor
                   </passthrough>}mx) { |m| HTMLEntities.new.decode($1) }
       end
 
-      def asciimath2mathml(text)
-        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>"])
-          x =  Nokogiri::XML(text)
-          x.xpath("//*[local-name() = 'math'][not(parent::stem)]").each do |y|
-            y.wrap("<stem type='MathML'></stem>")
-          end
-          x.to_xml
-      end
-
       def cleanup(xmldoc)
         element_name_cleanup(xmldoc)
         sections_cleanup(xmldoc)
         obligations_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
+        sourcecode_cleanup(xmldoc)
         figure_cleanup(xmldoc)
+        element_name_cleanup(xmldoc)
         ref_cleanup(xmldoc)
         note_cleanup(xmldoc)
         clausebefore_cleanup(xmldoc)
@@ -67,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)
@@ -83,8 +75,7 @@ module Asciidoctor
           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.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})/, "'"))#.
@@ -148,59 +139,26 @@ 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[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
+      def sourcecode_cleanup(xmldoc)
+        xmldoc.xpath("//sourcecode").each do |x|
+          x.traverse do |n|
+            next unless n.text?
+            next unless /#{Regexp.escape(@sourcecode_markup_start)}/.match(n.text)
+            n.replace(sourcecode_markup(n))
+          end
         end
       end
 
-      def mathml_cleanup(xmldoc)
-        xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
-          xml_unescape_mathml(x)
-          mathml_namespace(x)
-          mathml_preserve_space(x)
-          mathml_italicise(x)
+      def sourcecode_markup(n)
+        acc = []
+        n.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|#{Regexp.escape(@sourcecode_markup_end)})/).
+          each_slice(4).map do |a|
+          acc << Nokogiri::XML::Text.new(a[0], n.document).
+            to_xml(encoding: "US-ASCII", save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+          next unless a.size == 4
+          acc << Asciidoctor.convert(a[2], backend: (self&.backend&.to_sym || :standoc), doctype: :inline)
         end
+        acc.join
       end
 
       # allows us to deal with doc relation localities,
@@ -214,23 +172,18 @@ module Asciidoctor
 
       def img_cleanup(xmldoc)
         return xmldoc unless @datauriimage
-        xmldoc.xpath("//image").each do |i|
-          i["src"] = datauri(i["src"])
-        end
+        xmldoc.xpath("//image").each { |i| i["src"] = Metanorma::Utils::datauri(i["src"], @localdir) }
       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
+          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
+          next unless c.children.any? { |n| n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?) }
           c.xpath("./variant").each do |n|
-            if n.at_xpath('preceding-sibling::node()[not(self::text()'\
-                '[not(normalize-space())])][1][self::variantwrap]')
+            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

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,6 +1,5 @@
 require "date"
 require "htmlentities"
-require "json"
 require "open-uri"
 
 module Asciidoctor
@@ -22,9 +21,7 @@ module Asciidoctor
       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
+          s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
@@ -32,8 +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.nil? && s.next_element.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -92,17 +88,14 @@ module Asciidoctor
       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
+          s["key"] == "true" and s.previous_element << s.remove
         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"
+          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
@@ -113,9 +106,7 @@ module Asciidoctor
       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
+          s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
@@ -123,8 +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.nil? && s.next_element.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -135,8 +125,7 @@ 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 { |m| %w(name figure).include? m }.empty?
           e.name = "figure"
         end
       end
@@ -148,12 +137,10 @@ module Asciidoctor
         subfigure_cleanup(xmldoc)
       end
 
-      ELEMS_ALLOW_NOTES =
-        %w[p formula ul ol dl figure].freeze
+      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')]]"
@@ -201,9 +188,34 @@ module Asciidoctor
           n = d.next.remove
           d << n.children
         end
-        r.xpath("./description[normalize-space(.)='']").each do |d|
-          d.replace("\n")
+        r.xpath("./description[normalize-space(.)='']").each { |d| d.replace("\n") }
+      end
+
+      def svgmap_cleanup(xmldoc)
+        svgmap_populate(xmldoc)
+        Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
+      end
+
+      def svgmap_populate(xmldoc)
+        xmldoc.xpath("//svgmap").each do |s|
+          s1 = s.dup
+          s.children.remove
+          f = s1.at(".//figure") and s << f
+          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>]
+          end
+        end
+      end
+
+      def svgmap_target(nodeset)
+        nodeset.each do |n|
+          next unless n.name == "link"
+          n.children = n["target"]
         end
+        nodeset.text.sub(/^[,; ]/, "").strip
       end
     end
   end