metanorma-standoc 1.8.6 → 1.9.2

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -20,6 +20,7 @@ module Asciidoctor
           nomatches = true
           xmldoc.xpath(q).each do |s|
             next if s.children.map { |c| c.text? && /[[:alpha:]]/.match(c.text) }.any?
+
             s.previous_element << s.first_element_child.remove
             s.remove
             nomatches = false

data/lib/asciidoctor/standoc/cleanup_image.rb

@@ -0,0 +1,71 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def svgmap_cleanup(xmldoc)
+        svgmap_moveattrs(xmldoc)
+        svgmap_populate(xmldoc)
+        Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
+      end
+
+      def guid?(str)
+        /^_[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i
+          .match(str)
+      end
+
+      def svgmap_moveattrs(xmldoc)
+        xmldoc.xpath("//svgmap").each do |s|
+          f = s.at(".//figure") or next
+          if (t = s.at("./name")) && !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
+          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 svgmap_target(nodeset)
+        nodeset.each do |n|
+          next unless n.name == "link"
+
+          n.children = n["target"]
+        end
+        nodeset.text.sub(/^[,; ]/, "").strip
+      end
+
+      def img_cleanup(xmldoc)
+        return xmldoc unless @datauriimage
+
+        xmldoc.xpath("//image").each do |i|
+          i["src"] = Metanorma::Utils::datauri(i["src"], @localdir)
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -3,36 +3,39 @@ require "pathname"
 require "open-uri"
 require "html2doc"
 require "asciimath2unitsml"
-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_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 "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
+        text = text.gsub(%r{<stem type="AsciiMath">(.+?)</stem>}m) do
+          "<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:]+:/, "</")
+
+        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
 
@@ -40,12 +43,13 @@ module Asciidoctor
 
       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;")
+          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 }
+        stem.xpath("./math").each { |x| x.default_namespace = MATHML_NS }
       end
 
       def mathml_mi_italics
@@ -55,7 +59,8 @@ module Asciidoctor
 
       # 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|
+        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
@@ -63,10 +68,11 @@ module Asciidoctor
 
       def mi_italicise?(c)
         return false if c.length > 1
-        if /\p{Greek}/.match(c)
+
+        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)
+        elsif /\p{Latin}/.match?(c)
           /\p{Lower}/.match(c) && !mathml_mi_italics[:lowerroman] ||
             /\p{Upper}/.match(c) && !mathml_mi_italics[:upperroman]
         else
@@ -74,7 +80,7 @@ module Asciidoctor
         end
       end
 
-      UNITSML_NS = "http://unitsml.nist.gov/2005".freeze
+      UNITSML_NS = "https://schema.unitsml.org/unitsml/1.0".freeze
 
       def add_misc_container(xmldoc)
         unless ins = xmldoc.at("//misc-container")
@@ -87,6 +93,7 @@ module Asciidoctor
 
       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|
@@ -95,12 +102,14 @@ module Asciidoctor
       end
 
       def gather_unitsml(unitsml, xmldoc, t)
-        tags = xmldoc.xpath(".//m:#{t}", "m" => UNITSML_NS).each_with_object({}) do |x, m|
+        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 }
+        tags.each_value { |v| set << v }
       end
 
       def asciimath2unitsml_options

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -14,9 +14,10 @@ module Asciidoctor
         fold_notes_into_biblio(refs)
         bib = sort_biblio(refs.xpath("./bibitem"))
         insert = refs&.at("./bibitem")&.previous_element
-        refs.xpath("./bibitem").each { |b| b.remove }
+        refs.xpath("./bibitem").each(&:remove)
         bib.reverse.each do |b|
-          insert and insert.next = b.to_xml or refs.children.first.add_previous_sibling b.to_xml
+          insert and insert.next = b.to_xml or
+            refs.children.first.add_previous_sibling b.to_xml
         end
         extract_notes_from_biblio(refs)
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
@@ -24,7 +25,7 @@ module Asciidoctor
 
       def fold_notes_into_biblio(refs)
         refs.xpath("./bibitem").each do |r|
-          while r&.next_element&.name == "note" do
+          while r&.next_element&.name == "note"
             r.next_element["appended"] = true
             r << r.next_element.remove
           end
@@ -49,12 +50,15 @@ module Asciidoctor
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
         i = 0
-        xmldoc.xpath("//bibliography//references | //clause//references | //annex//references").each do |r|
+        xmldoc.xpath("//bibliography//references | //clause//references | "\
+                     "//annex//references").each do |r|
           next if r["normative"] == "true"
+
           r.xpath("./bibitem").each do |b|
             i += 1
             next unless docid = b.at("./docidentifier[@type = 'metanorma']")
-            next unless  /^\[\d+\]$/.match(docid.text)
+            next unless /^\[\d+\]$/.match?(docid.text)
+
             docid.children = "[#{i}]"
           end
         end
@@ -70,9 +74,10 @@ module Asciidoctor
 
       def normref_cleanup(xmldoc)
         r = xmldoc.at(self.class::NORM_REF) || return
-        preface = r.xpath("./title/following-sibling::*") & # intersection
-          r.xpath("./bibitem[1]/preceding-sibling::*")
-        preface.each { |n| n.remove }
+        preface = ((r.xpath("./title/following-sibling::*") & # intersection
+                    r.xpath("./bibitem[1]/preceding-sibling::*")) -
+        r.xpath("./note[@type = 'boilerplate']/descendant-or-self::*"))
+        preface.each(&:remove)
       end
 
       def biblio_cleanup(xmldoc)
@@ -92,6 +97,7 @@ module Asciidoctor
       def format_ref(ref, type)
         return @isodoc.docid_prefix(type, ref) if type != "metanorma"
         return "[#{ref}]" if /^\d+$/.match(ref) && !/^\[.*\]$/.match(ref)
+
         ref
       end
 
@@ -103,7 +109,7 @@ module Asciidoctor
 
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
-          isopub = ref.at(ISO_PUBLISHER_XPATH)
+          # isopub = ref.at(ISO_PUBLISHER_XPATH)
           docid = ref.at("./docidentifier[@type = 'metanorma']") ||
             ref.at("./docidentifier[not(@type = 'DOI')]") or next
           reference = format_ref(docid.text, docid["type"])
@@ -111,18 +117,20 @@ module Asciidoctor
         end
       end
 
-      def fetch_termbase(termbase, id)
+      def fetch_termbase(_termbase, _id)
         ""
       end
 
       def read_local_bibitem(uri)
-        return nil if %r{^http[s]?://}.match(uri)
-        file = @localdir + uri + ".rxl"
-        File.file?(file) or file = @localdir + uri + ".xml"
+        return nil if %r{^https?://}.match?(uri)
+
+        file = "#{@localdir}#{uri}.rxl"
+        File.file?(file) or file = "#{@localdir}#{uri}.xml"
         File.file?(file) or return nil
         xml = Nokogiri::XML(File.read(file, encoding: "utf-8"))
         ret = xml.at("//*[local-name() = 'bibdata']") or return nil
-        ret = Nokogiri::XML(ret.to_xml.sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
+        ret = Nokogiri::XML(ret.to_xml
+          .sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
         ret.name = "bibitem"
         ins = ret.at("./*[local-name() = 'docidentifier']") or return nil
         ins.previous = %{<uri type="citation">#{uri}</uri>}
@@ -132,7 +140,8 @@ module Asciidoctor
 
       # if citation uri points to local file, get bibitem from it
       def fetch_local_bibitem(xmldoc)
-        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]").each do |b|
+        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]")
+          .each do |b|
           uri = b&.at("./uri[@type = 'citation']")&.text
           bibitem = read_local_bibitem(uri) or next
           bibitem["id"] = b["id"]

data/lib/asciidoctor/standoc/cleanup_ref_dl.rb

@@ -8,7 +8,7 @@ module Asciidoctor
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
           validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
+          bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
           bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
           c.replace(bibitem.root)

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -0,0 +1,47 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def requirement_cleanup(reqt)
+        requirement_descriptions(reqt)
+        requirement_inherit(reqt)
+      end
+
+      def requirement_inherit(reqt)
+        reqt.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 }
+        end
+      end
+
+      def requirement_descriptions(reqt)
+        reqt.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", reqt)
+              e.before(t)
+              t.children = e.remove
+            end
+          end
+          requirement_cleanup1(r)
+        end
+      end
+
+      def requirement_cleanup1(reqt)
+        while d = reqt.at("./description[following-sibling::*[1]"\
+            "[self::description]]")
+          n = d.next.remove
+          d << n.children
+        end
+        reqt.xpath("./description[normalize-space(.)='']").each do |r|
+          r.replace("\n")
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -43,7 +43,7 @@ module Asciidoctor
       end
 
       def bibabstract_location(x)
-        bibabstract = x.at("//bibdata/script") || x.at("//bibdata/language") ||
+        x.at("//bibdata/script") || x.at("//bibdata/language") ||
           x.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
           x.at("//bibdata/date[not(following-sibling::date)]") ||
           x.at("//docnumber") ||
@@ -74,11 +74,11 @@ module Asciidoctor
         make_bibliography(x, s)
         x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
-      
       def make_annexes(x)
         x.xpath("//*[@annex]").each do |y|
           y.delete("annex")
           next if y.name == "annex" || !y.ancestors("annex").empty?
+
           y.wrap("<annex/>")
           y.parent["id"] = "_#{UUIDTools::UUID.random_create}"
           y.parent["obligation"] = y["obligation"]
@@ -98,6 +98,7 @@ module Asciidoctor
       def sections_level_cleanup(x)
         m = maxlevel(x)
         return if m < 6
+
         m.downto(6).each do |l|
           x.xpath("//clause[@level = '#{l}']").each do |c|
             c.delete("level")
@@ -151,6 +152,7 @@ module Asciidoctor
 
        def preface_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//preface")
+
         unless ins = xmldoc.at("//preface").children.first
           xmldoc.at("//preface") << " "
           ins = xmldoc.at("//preface").children.first
@@ -163,6 +165,7 @@ module Asciidoctor
 
       def sections_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//sections")
+
         unless ins = xmldoc.at("//sections").children.first
           xmldoc.at("//sections") << " "
           ins = xmldoc.at("//sections").children.first
@@ -186,8 +189,10 @@ module Asciidoctor
 
       def replace_title(doc, xpath, text, first = false)
         return unless text
+
         doc.xpath(xpath).each_with_index do |node, i|
           next if first && !i.zero?
+
           title = get_or_make_title(node)
           fn = title.xpath("./fn")
           fn.each { |n| n.remove }
@@ -196,24 +201,24 @@ module Asciidoctor
         end
       end
 
-      def sections_names_cleanup(x)
-        replace_title(x, "//clause[@type = 'scope']", @i18n&.scope)
-        replace_title(x, "//preface//abstract", @i18n&.abstract)
-        replace_title(x, "//foreword", @i18n&.foreword)
-        replace_title(x, "//introduction", @i18n&.introduction)
-        replace_title(x, "//acknowledgements", @i18n&.acknowledgements)
-        section_names_refs_cleanup(x)
-        section_names_terms_cleanup(x)
+      def sections_names_cleanup(xml)
+        replace_title(xml, "//clause[@type = 'scope']", @i18n&.scope)
+        replace_title(xml, "//preface//abstract", @i18n&.abstract)
+        replace_title(xml, "//foreword", @i18n&.foreword)
+        replace_title(xml, "//introduction", @i18n&.introduction)
+        replace_title(xml, "//acknowledgements", @i18n&.acknowledgements)
+        section_names_refs_cleanup(xml)
+        section_names_terms_cleanup(xml)
       end
 
-      def section_names_refs_cleanup(x)
-        replace_title(x, "//references[@normative = 'true']",
+      def section_names_refs_cleanup(xml)
+        replace_title(xml, "//references[@normative = 'true']",
                       @i18n&.normref, true)
-        replace_title(x, "//references[@normative = 'false']",
+        replace_title(xml, "//references[@normative = 'false']",
                       @i18n&.bibliography, true)
       end
 
-      NO_SYMABBR = "[.//definitions[not(@type)]]"
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
       SYMABBR = "[.//definitions[@type = 'symbols']"\
         "[@type = 'abbreviated_terms']]".freeze
       SYMnoABBR = "[.//definitions[@type = 'symbols']"\
@@ -223,7 +228,8 @@ module Asciidoctor
 
       def section_names_terms_cleanup(x)
         replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
-        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
         replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
         replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
                       @i18n&.termsdefsymbols, true)