metanorma-standoc 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cd6e66873fc1d0b703e0fee76f1ed3a56de06684135f142e3be3865bb7c21fa
-  data.tar.gz: ec666e930ce8ad73f39563050aaf052ddc0ed31a1778dec88cd1bf7308ddef12
+  metadata.gz: 03a2df03031208cf9cd54413c1dc342f748c3978a2e189f9cf4ae369fcc1820c
+  data.tar.gz: fc94c4cc2a0e117c06f41d709d8e5d6a6f3f0ba6e1ffc8a6ccdfb60b91ed3ffd
 SHA512:
-  metadata.gz: 65062d39f1c2bd1c33ceaf3bc0d55f5be7c34728c4b9027c7b7192c5ddf8a4b3cc3e37705070b471aac7c20117946a6dae150a5e31613d36afff59bb3ab5aa39
-  data.tar.gz: e1ca0ba1c31ad442c6359d30ca338fecb840dd86839d01cf697e314b365f72da424a6f93eecb1906eafdc34e2f489f2afd9f264ce1762cd1bc2e7524711ac653
+  metadata.gz: 32bac104b6523e30e510ada3e1e25861139b62c66c8d7bbcb782284648622b5f1da48acd8a6e97f511ead0baca45c7903ac7f31c1023596becc473d08deea87f
+  data.tar.gz: 4c0ee4e816c81ca1e98d5bbbb47ad2c755feca016c0b5ddae5283688291813e0d1d511444835d7bee1979dc49ef3d664a7d1966938b46b3a5ad0f2dd9a0da6d2

data/lib/asciidoctor/standoc/base.rb

@@ -108,10 +108,15 @@ 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$/, "") : ""
+        if node.attr("docfile")
+          @filename = File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+        else
+          @filename = ""
+        end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -143,10 +148,12 @@ module Asciidoctor
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml",
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert("#{@filename}.presentation.xml",
+                                    nil, false, "#{@filename}.doc")
       end
 
       def document(node)
@@ -163,12 +170,21 @@ module Asciidoctor
       end
 
       def clean_exit
-        @log.write(@output_dir + @filename + ".err") unless @novalid
+        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
+
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
+      def clean_abort(msg, file = nil)
+        file and
+          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
+        clean_exit
+        abort(msg)
+      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}>"
@@ -203,36 +219,13 @@ module Asciidoctor
         end
       end
 
-      def default_script(lang)
-        case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
-        else
-          "Latn"
-        end
-      end
-
       private
 
       def outputdir(node)
-        if node.attr("output_dir").nil_or_empty? then Metanorma::Utils::localdir(node)
-        else File.join(node.attr("output_dir"), "")
+        if node.attr("output_dir").nil_or_empty?
+          Metanorma::Utils::localdir(node)
+        else
+          File.join(node.attr("output_dir"), "")
         end
       end
     end

data/lib/asciidoctor/standoc/blocks.rb

@@ -140,13 +140,14 @@ 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)
         return termsource(node) if node.role == "source"
+
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content
@@ -155,9 +156,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)

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -12,9 +12,11 @@ module Asciidoctor
       end
 
       def note_attrs(node)
-        attr_code(termnote_attrs(node).merge(
-          type: node.attr("type"),
-          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(termnote_attrs(node)
+          .merge(
+        type: node.attr("type"),
+        beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+        ))
       end
 
       def sidebar_attrs(node)
@@ -24,6 +26,7 @@ module Asciidoctor
 
       def sidebar(node)
         return unless draft?
+
         noko do |xml|
           xml.review **(sidebar_attrs(node)) do |r|
             wrap_in_para(node, r)
@@ -33,33 +36,34 @@ module Asciidoctor
 
       def todo_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match date
+        date += "T00:00:00Z" unless /T/.match? date
         attr_code(
           id: ::Metanorma::Utils::anchor_or_uuid(node),
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
-          date: date )
+          date: date
+        )
       end
 
       def todo(node)
         noko do |xml|
-          xml.review **(todo_attrs(node)) do |r|
+          xml.review **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
       end
 
-      def termnote(n)
+      def termnote(node)
         noko do |xml|
-          xml.termnote **termnote_attrs(n) do |ex|
-            wrap_in_para(n, ex)
+          xml.termnote **termnote_attrs(node) do |ex|
+            wrap_in_para(node, ex)
           end
         end.join("\n")
       end
 
-      def note(n)
+      def note(node)
         noko do |xml|
-          xml.note **note_attrs(n) do |c|
-            wrap_in_para(n, c)
+          xml.note **note_attrs(node) do |c|
+            wrap_in_para(node, c)
           end
         end.join("\n")
       end
@@ -69,14 +73,16 @@ module Asciidoctor
         a = node.attr("type") and ["danger", "safety precautions"].each do |t|
           name = t if a.casecmp(t).zero?
         end
-        attr_code(keep_attrs(node).merge(id: Metanorma::Utils::anchor_or_uuid(node), type: name,
-                  beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(keep_attrs(node)
+          .merge(id: Metanorma::Utils::anchor_or_uuid(node), type: name,
+        beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
       end
 
       def admonition(node)
         return termnote(node) if in_terms?
         return note(node) if node.attr("name") == "note"
         return todo(node) if node.attr("name") == "todo"
+
         noko do |xml|
           xml.admonition **admonition_attrs(node) do |a|
             node.title.nil? or a.name { |name| name << node.title }

data/lib/asciidoctor/standoc/cleanup.rb

@@ -2,27 +2,29 @@ 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_relative "./cleanup_maths.rb"
+require_relative "./cleanup_block"
+require_relative "./cleanup_footnotes"
+require_relative "./cleanup_ref"
+require_relative "./cleanup_ref_dl"
+require_relative "./cleanup_boilerplate"
+require_relative "./cleanup_section"
+require_relative "./cleanup_terms"
+require_relative "./cleanup_inline"
+require_relative "./cleanup_amend"
+require_relative "./cleanup_maths"
+require_relative "./cleanup_image"
+require_relative "./cleanup_reqt"
 require "relaton_iev"
 
 module Asciidoctor
   module Standoc
     module Cleanup
       def textcleanup(result)
-        text = result.flatten.map { |l| l.sub(/\s*$/, "") }  * "\n"
+        text = result.flatten.map { |l| l.sub(/\s*$/, "") } * "\n"
         !@keepasciimath and text = asciimath2mathml(text)
         text = text.gsub(/\s+<fn /, "<fn ")
         text.gsub(%r{<passthrough\s+formats="metanorma">([^<]*)
-                  </passthrough>}mx) { |m| HTMLEntities.new.decode($1) }
+                  </passthrough>}mx) { HTMLEntities.new.decode($1) }
       end
 
       def cleanup(xmldoc)
@@ -73,22 +75,24 @@ module Asciidoctor
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         xmldoc.traverse do |n|
           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})/, "'"))#.
-            #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
+            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
+            # gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
 
-      def docidentifier_cleanup(xmldoc)
-      end
+      def docidentifier_cleanup(xmldoc); end
 
       TEXT_ELEMS =
-        %w{status language script version author name callout phone email 
+        %w{status language script version author name callout phone email
            street city state country postcode identifier referenceFrom surname
            referenceTo docidentifier docnumber prefix initial addition forename
            title draft secretariat title-main title-intro title-part}.freeze
@@ -110,57 +114,6 @@ module Asciidoctor
         xmldoc.traverse { |n| n.name = n.name.gsub(/_/, "-") }
       end
 
-      def link_callouts_to_annotations(callouts, annotations)
-        callouts.each_with_index do |c, i|
-          c["target"] = "_" + UUIDTools::UUID.random_create
-          annotations[i]["id"] = c["target"]
-        end
-      end
-
-      def align_callouts_to_annotations(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
-          callouts.size == annotations.size and
-            link_callouts_to_annotations(callouts, annotations)
-        end
-      end
-
-      def merge_annotations_into_sourcecode(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          while x&.next_element&.name == "annotation"
-            x.next_element.parent = x
-          end
-        end
-      end
-
-      def callout_cleanup(xmldoc)
-        merge_annotations_into_sourcecode(xmldoc)
-        align_callouts_to_annotations(xmldoc)
-      end
-
-      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 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,
       # temporarily stashed to "bpart"
       def bpart_cleanup(xmldoc)
@@ -170,23 +123,24 @@ module Asciidoctor
         end
       end
 
-      def img_cleanup(xmldoc)
-        return xmldoc unless @datauriimage
-        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&.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? { |n| n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?) }
+          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]')
+            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
+              n.replace("<variantwrap/>").first << n
             end
           end
         end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -40,6 +40,7 @@ module Asciidoctor
       def insert_thead(s)
         thead = s.at("./thead")
         return thead unless thead.nil?
+
         if tname = s.at("./name")
           thead = tname.add_next_sibling("<thead/>").first
           return thead
@@ -80,21 +81,21 @@ module Asciidoctor
       end
 
       # include where definition list inside stem block
-      def formula_cleanup(x)
-        formula_cleanup_where1(x)
-        formula_cleanup_where2(x)
+      def formula_cleanup(formula)
+        formula_cleanup_where1(formula)
+        formula_cleanup_where2(formula)
       end
 
-      def formula_cleanup_where1(x)
+      def formula_cleanup_where1(formula)
         q = "//formula/following-sibling::*[1][self::dl]"
-        x.xpath(q).each do |s|
+        formula.xpath(q).each do |s|
           s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
-      def formula_cleanup_where2(x)
+      def formula_cleanup_where2(formula)
         q = "//formula/following-sibling::*[1][self::p]"
-        x.xpath(q).each do |s|
+        formula.xpath(q).each do |s|
           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
@@ -125,9 +126,10 @@ 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 do |m|
+          next unless e.elements.map(&:name).reject do |m|
             %w(name figure).include? m
           end.empty?
+
           e.name = "figure"
         end
       end
@@ -150,6 +152,7 @@ module Asciidoctor
         xmldoc.xpath(q).each do |n|
           next if n["keep-separate"] == "true"
           next unless n.ancestors("table").empty?
+
           prev = n.previous_element || next
           n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
         end
@@ -159,100 +162,57 @@ module Asciidoctor
         end
       end
 
-      def requirement_cleanup(x)
-        requirement_descriptions(x)
-        requirement_inherit(x)
-      end
-
-      def requirement_inherit(x)
-        x.xpath("//requirement | //recommendation | //permission").each do |r|
-          ins = r.at("./classification") ||
-            r.at("./description | ./measurementtarget | ./specification | "\
-                 "./verification | ./import | ./description | ./requirement | "\
-                 "./recommendation | ./permission")
-          r.xpath("./*//inherit").each { |i| ins.previous = i }
+      def link_callouts_to_annotations(callouts, annotations)
+        callouts.each_with_index do |c, i|
+          c["target"] = "_" + UUIDTools::UUID.random_create
+          annotations[i]["id"] = c["target"]
         end
       end
 
-      def requirement_descriptions(x)
-        x.xpath("//requirement | //recommendation | //permission").each do |r|
-          r.children.each do |e|
-            unless e.element? && (reqt_subpart(e.name) ||
-                %w(requirement recommendation permission).include?(e.name))
-              t = Nokogiri::XML::Element.new("description", x)
-              e.before(t)
-              t.children = e.remove
-            end
-          end
-          requirement_cleanup1(r)
+      def align_callouts_to_annotations(xmldoc)
+        xmldoc.xpath("//sourcecode").each do |x|
+          callouts = x.elements.select { |e| e.name == "callout" }
+          annotations = x.elements.select { |e| e.name == "annotation" }
+          callouts.size == annotations.size and
+            link_callouts_to_annotations(callouts, annotations)
         end
       end
 
-      def requirement_cleanup1(r)
-        while d = r.at("./description[following-sibling::*[1]"\
-            "[self::description]]")
-          n = d.next.remove
-          d << n.children
-        end
-        r.xpath("./description[normalize-space(.)='']").each do |d|
-          d.replace("\n")
+      def merge_annotations_into_sourcecode(xmldoc)
+        xmldoc.xpath("//sourcecode").each do |x|
+          while x&.next_element&.name == "annotation"
+            x.next_element.parent = x
+          end
         end
       end
 
-      def svgmap_cleanup(xmldoc)
-        svgmap_moveattrs(xmldoc)
-        svgmap_populate(xmldoc)
-        Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
+      def callout_cleanup(xmldoc)
+        merge_annotations_into_sourcecode(xmldoc)
+        align_callouts_to_annotations(xmldoc)
       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 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)
 
-      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")
+            n.replace(sourcecode_markup(n))
           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
-          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()")
-            href.empty? or
-              s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
-          end
-        end
-      end
+      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
 
-      def svgmap_target(nodeset)
-        nodeset.each do |n|
-          next unless n.name == "link"
-          n.children = n["target"]
+          acc << Asciidoctor.convert(a[2], backend: (self&.backend&.to_sym || :standoc), doctype: :inline)
         end
-        nodeset.text.sub(/^[,; ]/, "").strip
+        acc.join
       end
     end
   end