metanorma-standoc 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28995a48904029f160e1da3411c440ac27e3b4f84405e8fc1f8680214bc79c42
-  data.tar.gz: bfce935749b5da318ebfe12c458210db5bc884ce7fa37126de4c3eff0e22e9d4
+  metadata.gz: 90c09f71739f8d485363ce3a4f950b143c0264f5b4657fd0891df83a00c44f72
+  data.tar.gz: cb0c51236e8c1780aa2a89b7a0c53efeabc2a4af3ef68e6c08aa8936efdea47d
 SHA512:
-  metadata.gz: b3839c128f0b278364e7a91f64529cbe2709c504e52aa82c31d284986b45f8ffc8a55a8c2871a7eee481bdbe8c5bdedb58c7b459b3a5aab0d64d7baf7d46f859
-  data.tar.gz: d26bfe3ca6146c2d6d7bf68d3a1112a8afde89f88a9713dbafb40a304f002b76d6e225d5fda3dd71eaa2f6c603cd4a362d1735cc4e83e822f0545efb86665adf
+  metadata.gz: 96533136bca911c4f886e6d0aeaa0e86ce94cf754d721af5537c835b744980fef11555e494d5d485a348c1ea911d1394cfb215f9f02cbf095a90bd652cae2916
+  data.tar.gz: 80bd100da6d8d05fdc69f8f52d20e9af182bd3196c42074663241dc8e35bee952eb8bf7ef95fbf444dbcd25f1bd45ac7d864f70c394df372f8d24b1e26a385d7

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)

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)
@@ -83,8 +74,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 +138,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 +171,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"] = datauri(i["src"]) }
       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

@@ -32,8 +32,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
@@ -101,8 +100,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.nil? && s.next_element.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -0,0 +1,86 @@
+require "nokogiri"
+require "pathname"
+require "open-uri"
+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"
+require_relative "./cleanup_inline.rb"
+require_relative "./cleanup_amend.rb"
+require "relaton_iev"
+
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      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 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
+        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)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION= "1.8.1".freeze
+    VERSION= "1.8.2".freeze
   end
 end

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -3,6 +3,71 @@ require "relaton_iec"
 require "fileutils"
 
 RSpec.describe Asciidoctor::Standoc do
+    it "processes markup in sourcecode" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      
+      [source]
+      ----
+      <tag/>
+      ----
+
+      [[A]]
+      [source]
+      ----
+      var {{{*x*}}} : {{{<<A,recursive>>}}} <tag/>
+      ----
+
+
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+  <sourcecode id='_'>&lt;tag/&gt;</sourcecode>
+  <sourcecode id='A'>
+    var
+    <strong>x</strong>
+     :
+    <xref target='A'>recursive</xref>
+     &lt;tag/&gt;
+  </sourcecode>
+</sections>
+       </standard-document>
+    OUTPUT
+  end
+
+       it "processes markup in sourcecode with custom delimiters" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :sourcecode-markup-start: [[[
+      :sourcecode-markup-end: ]]]
+
+      [[A]]
+      [source]
+      ----
+      var [[[*x*]]] : [[[<<A,recursive>>]]]
+      ----
+
+
+    INPUT
+       #{BLANK_HDR}
+       <sections>
+  <sourcecode id='A'>
+    var
+    <strong>x</strong>
+     :
+    <xref target='A'>recursive</xref>
+  </sourcecode>
+</sections>
+       </standard-document>
+    OUTPUT
+  end
+
+
   it "applies smartquotes by default" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Ribose Inc.
@@ -412,6 +412,7 @@ files:
 - lib/asciidoctor/standoc/cleanup_boilerplate.rb
 - lib/asciidoctor/standoc/cleanup_footnotes.rb
 - lib/asciidoctor/standoc/cleanup_inline.rb
+- lib/asciidoctor/standoc/cleanup_maths.rb
 - lib/asciidoctor/standoc/cleanup_ref.rb
 - lib/asciidoctor/standoc/cleanup_ref_dl.rb
 - lib/asciidoctor/standoc/cleanup_section.rb