metanorma-standoc 1.9.3 → 1.10.2

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,22 +1,22 @@
 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(xml, s)
+      def make_preface(xml, sect)
         if xml.at("//foreword | //introduction | //acknowledgements | "\
             "//*[@preface]")
-          preface = s.add_previous_sibling("<preface/>").first
+          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(xml, s)
+        make_abstract(xml, sect)
       end
 
       def move_clauses_into_preface(xml, preface)
@@ -26,10 +26,10 @@ module Asciidoctor
         end
       end
 
-      def make_abstract(xml, s)
+      def make_abstract(xml, sect)
         if xml.at("//abstract[not(ancestor::bibitem)]")
-          preface = s.at("//preface") ||
-            s.add_previous_sibling("<preface/>").first
+          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(xml)
@@ -53,17 +53,19 @@ module Asciidoctor
           xml.at("//bibdata/title[not(following-sibling::title)]")
       end
 
-      def make_bibliography(xml, s)
+      def make_bibliography(xml, sect)
         if xml.at("//sections/references")
-          biblio = s.add_next_sibling("<bibliography/>").first
+          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(xml, s)
-        xml.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(xml)
@@ -177,76 +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(&: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_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

data/lib/asciidoctor/standoc/converter.rb

@@ -37,6 +37,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::VariantInlineMacro
         inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
+        inline_macro Asciidoctor::Standoc::SymbolRefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         inline_macro Asciidoctor::Standoc::AddMacro

data/lib/asciidoctor/standoc/front.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require_relative "./front_contributor"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require "csv"
 
 module Asciidoctor
@@ -10,13 +9,13 @@ module Asciidoctor
     module Front
       def committee_component(compname, node, out)
         out.send compname.gsub(/-/, "_"), node.attr(compname),
-          **attr_code(number: node.attr("#{compname}-number"),
-                      type: node.attr("#{compname}-type"))
+                 **attr_code(number: node.attr("#{compname}-number"),
+                             type: node.attr("#{compname}-type"))
         i = 2
-        while node.attr(compname+"_#{i}") do
-          out.send compname.gsub(/-/, "_"), node.attr(compname+"_#{i}"),
-            **attr_code(number: node.attr("#{compname}-number_#{i}"),
-                        type: node.attr("#{compname}-type_#{i}"))
+        while node.attr(compname + "_#{i}")
+          out.send compname.gsub(/-/, "_"), node.attr(compname + "_#{i}"),
+                   **attr_code(number: node.attr("#{compname}-number_#{i}"),
+                               type: node.attr("#{compname}-type_#{i}"))
           i += 1
         end
       end
@@ -32,34 +31,36 @@ module Asciidoctor
         is_pub && node and org_address(node, org)
       end
 
-      def org_address(node, p)
-        node.attr("pub-address") and p.address do |ad|
+      def org_address(node, person)
+        node.attr("pub-address") and person.address do |ad|
           ad.formattedAddress do |f|
             f << node.attr("pub-address").gsub(/ \+\n/, "<br/>")
           end
         end
-        node.attr("pub-phone") and p.phone node.attr("pub-phone")
-        node.attr("pub-fax") and p.phone node.attr("pub-fax"), **{type: "fax"}
-        node.attr("pub-email") and p.email node.attr("pub-email")
-        node.attr("pub-uri") and p.uri node.attr("pub-uri")
+        node.attr("pub-phone") and person.phone node.attr("pub-phone")
+        node.attr("pub-fax") and
+          person.phone node.attr("pub-fax"), **{ type: "fax" }
+        node.attr("pub-email") and person.email node.attr("pub-email")
+        node.attr("pub-uri") and person.uri node.attr("pub-uri")
       end
 
       # , " => ," : CSV definition does not deal with space followed by quote
       # at start of field
-      def csv_split(s, delim = ";")
-        return if s.nil?
-        CSV.parse_line(s&.gsub(/#{delim} "(?!")/, "#{delim}\""),
+      def csv_split(text, delim = ";")
+        return if text.nil?
+
+        CSV.parse_line(text&.gsub(/#{delim} "(?!")/, "#{delim}\""),
                        liberal_parsing: true,
-                       col_sep: delim)&.compact&.map { |x| x.strip }
+                       col_sep: delim)&.compact&.map(&:strip)
       end
 
       def metadata_author(node, xml)
-        csv_split(node.attr("publisher") || default_publisher || "")&.
-          each do |p|
+        csv_split(node.attr("publisher") || default_publisher || "")
+          &.each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
             c.organization do |a|
-              organization(a, p, false, node, !node.attr("publisher"))  
+              organization(a, p, false, node, !node.attr("publisher"))
             end
           end
         end
@@ -76,17 +77,18 @@ module Asciidoctor
         end
       end
 
-      def personal_role(node, c, suffix)
-        c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
+      def personal_role(node, contrib, suffix)
+        type = node.attr("role#{suffix}")&.downcase || "author"
+        contrib.role **{ type: type }
       end
 
-      def personal_contact(node, suffix, p)
-        node.attr("phone#{suffix}") and p.phone node.attr("phone#{suffix}")
+      def personal_contact(node, suffix, person)
+        node.attr("phone#{suffix}") and person.phone node.attr("phone#{suffix}")
         node.attr("fax#{suffix}") and
-          p.phone node.attr("fax#{suffix}"), **{type: "fax"}
-        node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
+          person.phone node.attr("fax#{suffix}"), **{ type: "fax" }
+        node.attr("email#{suffix}") and person.email node.attr("email#{suffix}")
         node.attr("contributor-uri#{suffix}") and
-          p.uri node.attr("contributor-uri#{suffix}")
+          person.uri node.attr("contributor-uri#{suffix}")
       end
 
       def personal_author1(node, xml, suffix)
@@ -100,8 +102,8 @@ module Asciidoctor
         end
       end
 
-      def person_name(node, xml, suffix, p)
-        p.name do |n|
+      def person_name(node, _xml, suffix, person)
+        person.name do |n|
           if node.attr("fullname#{suffix}")
             n.completename node.attr("fullname#{suffix}")
           else
@@ -112,21 +114,43 @@ module Asciidoctor
         end
       end
 
-      def person_affiliation(node, xml, suffix, p)
-        node.attr("affiliation#{suffix}") and p.affiliation do |a|
+      def person_affiliation(node, _xml, suffix, person)
+        node.attr("affiliation#{suffix}") and person.affiliation do |a|
           a.organization do |o|
-            o.name node.attr("affiliation#{suffix}")
-            a = node.attr("affiliation_subdiv#{suffix}")
-            abbr = node.attr("affiliation_abbrev#{suffix}") and o.abbreviation abbr
-            csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
-              o.subdivision s
-            end
-            node.attr("address#{suffix}") and o.address do |ad|
-              ad.formattedAddress do |f|
-                f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
-              end
+            person_organization(node, suffix, o)
+          end
+        end
+      end
+
+      def person_organization(node, suffix, xml)
+        xml.name node.attr("affiliation#{suffix}")
+        abbr = node.attr("affiliation_abbrev#{suffix}") and
+          xml.abbreviation abbr
+        csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
+          xml.subdivision s
+        end
+        person_address(node, suffix, xml)
+      end
+
+      def person_address(node, suffix, xml)
+        if node.attr("address#{suffix}")
+          xml.address do |ad|
+            ad.formattedAddress do |f|
+              f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
             end
           end
+        elsif node.attr("country#{suffix}") || node.attr("city#{suffix}")
+          person_address_components(node, suffix, xml)
+        end
+      end
+
+      def person_address_components(node, suffix, xml)
+        xml.address do |ad|
+          s = node.attr("street#{suffix}") and ad.street s
+          s = node.attr("city#{suffix}") and ad.city s
+          s = node.attr("state#{suffix}") and ad.state s
+          s = node.attr("country#{suffix}") and ad.country s
+          s = node.attr("postcode#{suffix}") and ad.postcode s
         end
       end
 
@@ -135,7 +159,7 @@ module Asciidoctor
       end
 
       def org_abbrev
-        { }
+        {}
       end
 
       def metadata_publisher(node, xml)