metanorma-standoc 1.9.2 → 1.10.1

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "pathname"
-require "open-uri"
 require "html2doc"
 require "asciimath2unitsml"
 require_relative "./cleanup_block"

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -149,7 +149,14 @@ module Asciidoctor
         end
       end
 
+      def bibitem_nested_id(xmldoc)
+        xmldoc.xpath("//bibitem//bibitem").each do |b|
+          b.delete("id")
+        end
+      end
+
       def bibitem_cleanup(xmldoc)
+        bibitem_nested_id(xmldoc)
         ref_dl_cleanup(xmldoc)
         fetch_local_bibitem(xmldoc)
       end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -1,38 +1,38 @@
 require "date"
 require "htmlentities"
 require "json"
-require "open-uri"
 require "mathml2asciimath"
+require_relative "cleanup_section_names"
 
 module Asciidoctor
   module Standoc
     module Cleanup
-      def make_preface(x, s)
-        if x.at("//foreword | //introduction | //acknowledgements | "\
+      def make_preface(xml, sect)
+        if xml.at("//foreword | //introduction | //acknowledgements | "\
             "//*[@preface]")
-          preface = s.add_previous_sibling("<preface/>").first
-          f = x.at("//foreword") and preface.add_child f.remove
-          f = x.at("//introduction") and preface.add_child f.remove
-          move_clauses_into_preface(x, preface)
-          f = x.at("//acknowledgements") and preface.add_child f.remove
+          preface = sect.add_previous_sibling("<preface/>").first
+          f = xml.at("//foreword") and preface.add_child f.remove
+          f = xml.at("//introduction") and preface.add_child f.remove
+          move_clauses_into_preface(xml, preface)
+          f = xml.at("//acknowledgements") and preface.add_child f.remove
         end
-        make_abstract(x, s)
+        make_abstract(xml, sect)
       end
 
-      def move_clauses_into_preface(x, preface)
-        x.xpath("//*[@preface]").each do |c|
+      def move_clauses_into_preface(xml, preface)
+        xml.xpath("//*[@preface]").each do |c|
           c.delete("preface")
           preface.add_child c.remove
         end
       end
 
-      def make_abstract(x, s)
-        if x.at("//abstract[not(ancestor::bibitem)]")
-          preface = s.at("//preface") ||
-            s.add_previous_sibling("<preface/>").first
-          abstract = x.at("//abstract[not(ancestor::bibitem)]").remove
+      def make_abstract(xml, sect)
+        if xml.at("//abstract[not(ancestor::bibitem)]")
+          preface = sect.at("//preface") ||
+            sect.add_previous_sibling("<preface/>").first
+          abstract = xml.at("//abstract[not(ancestor::bibitem)]").remove
           preface.prepend_child abstract.remove
-          bibabstract = bibabstract_location(x)
+          bibabstract = bibabstract_location(xml)
           dupabstract = abstract.dup
           dupabstract.traverse { |n| n.remove_attribute("id") }
           dupabstract.remove_attribute("language")
@@ -42,40 +42,43 @@ module Asciidoctor
         end
       end
 
-      def bibabstract_location(x)
-        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") ||
-          x.at("//bibdata/docidentifier"\
-               "[not(following-sibling::docidentifier)]") ||
-        x.at("//bibdata/uri[not(following-sibling::uri)]") ||
-        x.at("//bibdata/title[not(following-sibling::title)]")
+      def bibabstract_location(xml)
+        xml.at("//bibdata/script") || xml.at("//bibdata/language") ||
+          xml.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
+          xml.at("//bibdata/date[not(following-sibling::date)]") ||
+          xml.at("//docnumber") ||
+          xml.at("//bibdata/docidentifier"\
+                 "[not(following-sibling::docidentifier)]") ||
+          xml.at("//bibdata/uri[not(following-sibling::uri)]") ||
+          xml.at("//bibdata/title[not(following-sibling::title)]")
       end
 
-      def make_bibliography(x, s)
-        if x.at("//sections/references")
-          biblio = s.add_next_sibling("<bibliography/>").first
-          x.xpath("//sections/references").each do |r|
+      def make_bibliography(xml, sect)
+        if xml.at("//sections/references")
+          biblio = sect.add_next_sibling("<bibliography/>").first
+          xml.xpath("//sections/references").each do |r|
             biblio.add_child r.remove
           end
         end
       end
 
-      def make_indexsect(x, s)
-        x.xpath("//sections/indexsect").reverse_each { |r| s.next = r.remove }
+      def make_indexsect(xml, sect)
+        xml.xpath("//sections/indexsect").reverse_each do |r|
+          sect.next = r.remove
+        end
       end
 
-      def sections_order_cleanup(x)
-        s = x.at("//sections")
-        make_preface(x, s)
-        make_annexes(x)
-        make_indexsect(x, s)
-        make_bibliography(x, s)
-        x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
+      def sections_order_cleanup(xml)
+        s = xml.at("//sections")
+        make_preface(xml, s)
+        make_annexes(xml)
+        make_indexsect(xml, s)
+        make_bibliography(xml, s)
+        xml.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
-      def make_annexes(x)
-        x.xpath("//*[@annex]").each do |y|
+
+      def make_annexes(xml)
+        xml.xpath("//*[@annex]").each do |y|
           y.delete("annex")
           next if y.name == "annex" || !y.ancestors("annex").empty?
 
@@ -87,60 +90,61 @@ module Asciidoctor
         end
       end
 
-      def maxlevel(x)
+      def maxlevel(xml)
         max = 5
-        x.xpath("//clause[@level]").each do |c|
+        xml.xpath("//clause[@level]").each do |c|
           max = c["level"].to_i if max < c["level"].to_i
         end
         max
       end
 
-      def sections_level_cleanup(x)
-        m = maxlevel(x)
+      def sections_level_cleanup(xml)
+        m = maxlevel(xml)
         return if m < 6
 
         m.downto(6).each do |l|
-          x.xpath("//clause[@level = '#{l}']").each do |c|
+          xml.xpath("//clause[@level = '#{l}']").each do |c|
             c.delete("level")
             c.previous_element << c.remove
           end
         end
       end
 
-      def sections_cleanup(x)
-        sections_order_cleanup(x)
-        sections_level_cleanup(x)
-        sections_names_cleanup(x)
-        change_clauses(x)
+      def sections_cleanup(xml)
+        sections_order_cleanup(xml)
+        sections_level_cleanup(xml)
+        sections_names_cleanup(xml)
+        change_clauses(xml)
       end
 
-      def obligations_cleanup(x)
-        obligations_cleanup_info(x)
-        obligations_cleanup_norm(x)
-        obligations_cleanup_inherit(x)
+      def obligations_cleanup(xml)
+        obligations_cleanup_info(xml)
+        obligations_cleanup_norm(xml)
+        obligations_cleanup_inherit(xml)
       end
 
-      def obligations_cleanup_info(x)
-        (s = x.at("//foreword")) && s["obligation"] = "informative"
-        (s = x.at("//introduction")) && s["obligation"] = "informative"
-        (s = x.at("//acknowledgements")) && s["obligation"] = "informative"
-        x.xpath("//references").each { |r| r["obligation"] = "informative" }
-        x.xpath("//preface//clause").each do |r|
+      def obligations_cleanup_info(xml)
+        s = xml.at("//foreword") and s["obligation"] = "informative"
+        s = xml.at("//introduction") and s["obligation"] = "informative"
+        s = xml.at("//acknowledgements") and s["obligation"] = "informative"
+        xml.xpath("//references").each { |r| r["obligation"] = "informative" }
+        xml.xpath("//preface//clause").each do |r|
           r["obligation"] = "informative"
         end
       end
 
-      def obligations_cleanup_norm(x)
-        (s = x.at("//clause[@type = 'scope']")) && s["obligation"] = "normative"
-        x.xpath("//terms").each { |r| r["obligation"] = "normative" }
-        x.xpath("//definitions").each { |r| r["obligation"] = "normative" }
+      def obligations_cleanup_norm(xml)
+        s = xml.at("//clause[@type = 'scope']") and
+          s["obligation"] = "normative"
+        xml.xpath("//terms").each { |r| r["obligation"] = "normative" }
+        xml.xpath("//definitions").each { |r| r["obligation"] = "normative" }
       end
 
-      def obligations_cleanup_inherit(x)
-        x.xpath("//annex | //clause[not(ancestor::boilerplate)]").each do |r|
+      def obligations_cleanup_inherit(xml)
+        xml.xpath("//annex | //clause[not(ancestor::boilerplate)]").each do |r|
           r["obligation"] = "normative" unless r["obligation"]
         end
-        x.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
+        xml.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
           o = r&.at("./ancestor::*/@obligation")&.text and r["obligation"] = o
         end
       end
@@ -150,7 +154,7 @@ module Asciidoctor
         sections_clausebefore_cleanup(xmldoc)
       end
 
-       def preface_clausebefore_cleanup(xmldoc)
+      def preface_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//preface")
 
         unless ins = xmldoc.at("//preface").children.first
@@ -175,74 +179,6 @@ module Asciidoctor
           ins.previous = x.remove
         end
       end
-
-      def get_or_make_title(node)
-          unless node.at("./title")
-            if node.children.empty?
-              node << "<title/>"
-            else
-              node.children.first.previous = "<title/>"
-            end
-          end
-          node.at("./title")
-      end
-
-      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 }
-          title.content = text
-          fn.each { |n| title << n }
-        end
-      end
-
-      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(xml)
-        replace_title(xml, "//references[@normative = 'true']",
-                      @i18n&.normref, true)
-        replace_title(xml, "//references[@normative = 'false']",
-                      @i18n&.bibliography, true)
-      end
-
-      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
-      SYMABBR = "[.//definitions[@type = 'symbols']"\
-        "[@type = 'abbreviated_terms']]".freeze
-      SYMnoABBR = "[.//definitions[@type = 'symbols']"\
-        "[not(@type = 'abbreviated_terms')]]".freeze
-      ABBRnoSYM = "[.//definitions[not(@type = 'symbols')]"\
-        "[@type = 'abbreviated_terms']]".freeze
-
-      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[not(@type)]", @i18n&.symbolsabbrev)
-        replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
-                      @i18n&.termsdefsymbols, true)
-        replace_title(x, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
-                      @i18n&.termsdefabbrev, true)
-        replace_title(x, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
-                      @i18n&.termsdefsymbolsabbrev, true)
-        replace_title(x, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
-                      @i18n&.termsdefsymbolsabbrev, true)
-        replace_title(
-          x, "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
-          @i18n&.termsdef, true)
-      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_section_names.rb

@@ -0,0 +1,75 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def get_or_make_title(node)
+        unless node.at("./title")
+          if node.children.empty?
+            node << "<title/>"
+          else
+            node.children.first.previous = "<title/>"
+          end
+        end
+        node.at("./title")
+      end
+
+      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(&:remove)
+          title.content = text
+          fn.each { |n| title << n }
+        end
+      end
+
+      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(xml)
+        replace_title(xml, "//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(xml, "//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
+      SYMABBR = "[.//definitions[@type = 'symbols']]"\
+        "[.//definitions[@type = 'abbreviated_terms']]".freeze
+      SYMnoABBR = "[.//definitions[@type = 'symbols']]"\
+        "[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
+      ABBRnoSYM = "[.//definitions[@type = 'abbreviated_terms']]"\
+        "[not(.//definitions[@type = 'symbols'])]".freeze
+
+      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[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x,
+          "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true
+        )
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -60,15 +60,15 @@ module Asciidoctor
 
       def term_children_cleanup(xmldoc)
         xmldoc.xpath("//term").each do |t|
-          t.xpath("./termnote").each { |n| t << n.remove }
-          t.xpath("./termexample").each { |n| t << n.remove }
-          t.xpath("./termsource").each { |n| t << n.remove }
+          %w(termnote termexample termsource).each do |w|
+            t.xpath("./#{w}").each { |n| t << n.remove }
+          end
         end
-      end 
+      end
 
       def termdef_from_termbase(xmldoc)
         xmldoc.xpath("//term").each do |x|
-          if c = x.at("./origin/termref") and !x.at("./definition")
+          if (c = x.at("./origin/termref")) && !x.at("./definition")
             x.at("./origin").previous = fetch_termbase(c["base"], c.text)
           end
         end
@@ -93,33 +93,34 @@ module Asciidoctor
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
-        term_children_cleanup(xmldoc) 
+        term_children_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
-      end   
+      end
 
       # Indices sort after letter but before any following
       # letter (x, x_m, x_1, xa); we use colon to force that sort order.
       # Numbers sort *after* letters; we use thorn to force that sort order.
-      def symbol_key(x)
-        key = x.dup
+      def symbol_key(sym)
+        key = sym.dup
         key.traverse do |n|
           next unless n.name == "math"
+
           n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
         end
         ret = Nokogiri::XML(key.to_xml)
-        HTMLEntities.new.decode(ret.text.downcase).
-          gsub(/[\[\]\{\}<>\(\)]/, "").gsub(/\s/m, "").
-          gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "").
-          gsub(/[0-9]+/, "þ\\0")
+        HTMLEntities.new.decode(ret.text.downcase)
+          .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
+          .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "")
+          .gsub(/[0-9]+/, "þ\\0")
       end
-        
+
       def grkletters(x)
         x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
       end
 
-      def extract_symbols_list(dl)
+      def extract_symbols_list(dlist)
         dl_out = []
-        dl.xpath("./dt | ./dd").each do |dtd|
+        dlist.xpath("./dt | ./dd").each do |dtd|
           if dtd.name == "dt"
             dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
           else
@@ -128,7 +129,7 @@ module Asciidoctor
         end
         dl_out
       end
-          
+
       def symbols_cleanup(docxml)
         docxml.xpath("//definitions/dl").each do |dl|
           dl_out = extract_symbols_list(dl)
@@ -136,7 +137,7 @@ module Asciidoctor
           dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
         end
         docxml
-      end 
+      end
     end
   end
 end