metanorma-standoc 1.9.2 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b789e06df237e881bdd055cfe9b90e191d781e71e82dd6a80c098f23b08934
-  data.tar.gz: 27f1499d7f7adccf29c2b9c9ac731e6ff1988a008530a4aa13e63adb4fbef490
+  metadata.gz: fb0657fc8f9c086fa560b509e2e7e5829b9ab5d902e727ce221c040f2aad3ec4
+  data.tar.gz: eac14431d7f0317023a49993dee40a440fbc47d32136091cd4adfea5a5d36823
 SHA512:
-  metadata.gz: c72e91aac553b2e9d3151a59fde54b02ae5cb6340aeb0781dd4326d5a6bce3166e20fd2ece37d909c3e8b7f72d6d26892bd279d4256b190cf28dbe41e1bdbf3e
-  data.tar.gz: 8314c96a3af15b47d56c42cd040e369455616b40dafb37a3d2ee32d0ba46976293eee36f3b9ab99d3b2d94002df3f3bf0a319e98f262e0d5eb3049fb90c30d4f
+  metadata.gz: 72d1aece1ed13421fa2fdcd87f8d4468cae148cc415b3a982fc9fea236cbf5f01113e87b11fc88b0aa68ce52f057d5dcdc1441b37c028798cd66458146d0b540
+  data.tar.gz: b736bd6de43ace4da0c31f14b1f7f28349eb7272baf073e5b68558f68cd88e68b84fb72c76d578f0a69c8b56ae8021b5dfe75792dde64fae1a121eeaa156cfc6

data/lib/asciidoctor/standoc/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/standoc/cleanup.rb

@@ -72,24 +72,39 @@ module Asciidoctor
         xmldoc
       end
 
+      IGNORE_DUMBQUOTES = "//pre | //pre//* | //tt | //tt//* | "\
+        "//sourcecode | //sourcecode//* | //bibdata//* | //stem | "\
+        "//stem//* | //figure[@class = 'pseudocode'] | "\
+        "//figure[@class = 'pseudocode']//*".freeze
+
       def smartquotes_cleanup(xmldoc)
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
-        xmldoc.traverse do |n|
-          next unless n.text?
+        if @smartquotes then smartquotes_cleanup1(xmldoc)
+        else dumbquote_cleanup(xmldoc)
+        end
+      end
+
+      def smartquotes_cleanup1(xmldoc)
+        (xmldoc.xpath("//*[child::text()]") - xmldoc.xpath(IGNORE_DUMBQUOTES))
+          .each do |x|
+          x.children.each 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.replace(Metanorma::Utils::smartformat(n.text))
-          else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
-            # gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
 
+      def dumbquote_cleanup(xmldoc)
+        xmldoc.traverse do |n|
+          next unless n.text?
+
+          n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
+        end
+      end
+
       def docidentifier_cleanup(xmldoc); end
 
       TEXT_ELEMS =
@@ -125,11 +140,7 @@ module Asciidoctor
       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
-        end
+        variant_space_cleanup(xmldoc)
         xmldoc.xpath("//*[variant]").each do |c|
           next unless c.children.any? do |n|
             n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
@@ -147,6 +158,15 @@ module Asciidoctor
         end
         xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
       end
+
+      def variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[variant]").each do |c|
+          if c&.next&.text? && c&.next&.next&.name == "variant"
+            c.next.text.gsub(/\s/, "").empty? and
+              c.next.remove
+          end
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -7,32 +7,32 @@ require "mathml2asciimath"
 module Asciidoctor
   module Standoc
     module Cleanup
-      def make_preface(x, s)
-        if x.at("//foreword | //introduction | //acknowledgements | "\
+      def make_preface(xml, s)
+        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
+          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, s)
       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)]")
+      def make_abstract(xml, s)
+        if xml.at("//abstract[not(ancestor::bibitem)]")
           preface = s.at("//preface") ||
             s.add_previous_sibling("<preface/>").first
-          abstract = x.at("//abstract[not(ancestor::bibitem)]").remove
+          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,41 @@ 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")
+      def make_bibliography(xml, s)
+        if xml.at("//sections/references")
           biblio = s.add_next_sibling("<bibliography/>").first
-          x.xpath("//sections/references").each do |r|
+          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, s)
+        xml.xpath("//sections/indexsect").reverse_each { |r| s.next = r.remove }
       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 +88,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 +152,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
@@ -177,14 +179,14 @@ module Asciidoctor
       end
 
       def get_or_make_title(node)
-          unless node.at("./title")
-            if node.children.empty?
-              node << "<title/>"
-            else
-              node.children.first.previous = "<title/>"
-            end
+        unless node.at("./title")
+          if node.children.empty?
+            node << "<title/>"
+          else
+            node.children.first.previous = "<title/>"
           end
-          node.at("./title")
+        end
+        node.at("./title")
       end
 
       def replace_title(doc, xpath, text, first = false)
@@ -195,7 +197,7 @@ module Asciidoctor
 
           title = get_or_make_title(node)
           fn = title.xpath("./fn")
-          fn.each { |n| n.remove }
+          fn.each(&:remove)
           title.content = text
           fn.each { |n| title << n }
         end
@@ -219,12 +221,12 @@ module Asciidoctor
       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
+      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)
@@ -240,8 +242,10 @@ module Asciidoctor
         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)
+          x,
+          "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true
+        )
       end
     end
   end

data/lib/asciidoctor/standoc/front.rb

@@ -73,7 +73,7 @@ module Asciidoctor
       def datetypes
         %w{ published accessed created implemented obsoleted
             confirmed updated issued circulated unchanged received
-            vote-started vote-ended }
+            vote-started vote-ended announced }
       end
 
       def metadata_date(node, xml)

data/lib/asciidoctor/standoc/isodoc.rng

@@ -1191,9 +1191,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -6,8 +6,8 @@ module Asciidoctor
     # Lookup all `term` and `calause` tags and replace `termxref` tags with
     # `xref`:target tag
     class TermLookupCleanup
-      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/
-      EXISTING_TERM_REGEXP = /\Aterm-/
+      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/.freeze
+      EXISTING_TERM_REGEXP = /\Aterm-/.freeze
 
       attr_reader :xmldoc, :termlookup, :log
 
@@ -15,17 +15,27 @@ module Asciidoctor
         @xmldoc = xmldoc
         @log = log
         @termlookup = {}
+        @idhash = {}
       end
 
       def call
+        @idhash = populate_idhash
         @termlookup = replace_automatic_generated_ids_terms
         set_termxref_tags_target
       end
 
       private
 
+      def populate_idhash
+        xmldoc.xpath("//*[@id]").each_with_object({}) do |n, mem|
+          next unless /^term-/.match?(n["id"])
+
+          mem[n["id"]] = true
+        end
+      end
+
       def set_termxref_tags_target
-        xmldoc.xpath('//termxref').each do |node|
+        xmldoc.xpath("//termxref").each do |node|
           target = normalize_ref_id(node.text)
           if termlookup[target].nil?
             remove_missing_ref(node, target)
@@ -36,7 +46,7 @@ module Asciidoctor
       end
 
       def remove_missing_ref(node, target)
-        log.add('AsciiDoc Input', node,
+        log.add("AsciiDoc Input", node,
                 %(Error: Term reference in `term[#{target}]` missing: \
                 "#{target}" is not defined in document))
         term_name_node = node.previous.previous
@@ -49,34 +59,39 @@ module Asciidoctor
       end
 
       def modify_ref_node(node, target)
-        node.name = 'xref'
-        node['target'] = termlookup[target]
+        node.name = "xref"
+        node["target"] = termlookup[target]
         node.children.remove
-        node.remove_attribute('defaultref')
+        node.remove_attribute("defaultref")
       end
 
       def replace_automatic_generated_ids_terms
-        xmldoc.xpath('//term').each.with_object({}) do |term_node, res|
-          normalize_id_and_memorize(term_node, res, './preferred')
+        xmldoc.xpath("//term").each.with_object({}) do |term_node, res|
+          normalize_id_and_memorize(term_node, res, "./preferred")
         end
       end
 
       def normalize_id_and_memorize(term_node, res_table, text_selector)
         term_text = normalize_ref_id(term_node.at(text_selector).text)
-                  unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
-        term_node['id'] = unique_text_id(term_text)
-                  end
-        res_table[term_text] = term_node['id']
+        unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node["id"]).nil?
+          id = unique_text_id(term_text)
+          term_node["id"] = id
+          @idhash[id] = true
+        end
+        res_table[term_text] = term_node["id"]
       end
 
       def normalize_ref_id(text)
-        text.downcase.gsub(/[[:space:]]/, '-')
+        text.downcase.gsub(/[[:space:]]/, "-")
       end
 
       def unique_text_id(text)
-        return "term-#{text}" if xmldoc.at("//*[@id = 'term-#{text}']").nil?
+        unless @idhash["term-#{text}"]
+          return "term-#{text}"
+        end
+
         (1..Float::INFINITY).lazy.each do |index|
-          if xmldoc.at("//*[@id = 'term-#{text}-#{index}']").nil?
+          unless @idhash["term-#{text}-#{index}"]
             break("term-#{text}-#{index}")
           end
         end