metanorma-standoc 2.7.1 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97ecd18866405cdb9d6b66001a4e36d2fbd8a54fdbf1b3c9158ea86a0b9bb18
-  data.tar.gz: 91d500390673aee641a3f909e43f618c657c5441ce97e315f5cbcdbfd3e9b346
+  metadata.gz: 22383a78927c434e7f982f01118ce27f61d0f55d1a31b09b1b6af67602df204f
+  data.tar.gz: 7c9b2043c8c862dac50bac349fd432020c9e40d08cba1c1efa57519137a65d2a
 SHA512:
-  metadata.gz: 3747b45da1d18b643ac4a5475057543765333cfee4d2f9a840045c7f86125b8c687499ceebe2f6bc4c97c0d11cfa6c6852fc2a550b40244d69d1b5880c9163ac
-  data.tar.gz: 6ccc6bd35186eb717929cac051d85c1ac13bd42ddd97a22ee3cd6ac59259a8fbfaeff4e3e90a381f87ccf873b279c0cf2c27db3fdc88571805ca546d86068cfb
+  metadata.gz: cc525a7aea4c9efac2351a7b0983f82c62a3f19602a811ec80206fcb5855b9611a6e3b0aceb2c516e6ce450c182b88c4c477272e926f0dabb61e31bf72b4d327
+  data.tar.gz: aeef26d6f58f7f9d3d188b716d3bd4f8298e09fd9eaea3461aa3f74c3efd204d920bc7e86afe7a2d5073234e8675e1a38d66934c9e27b4fa67f244a36ed5bf37

data/lib/metanorma/standoc/base.rb

@@ -19,7 +19,7 @@ module Metanorma
       XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
       FONTS_MANIFEST = "fonts-manifest".freeze
 
-      attr_accessor :log, :fatalerror
+      attr_accessor :log
 
       def xml_root_tag
         self.class::XML_ROOT_TAG
@@ -110,7 +110,6 @@ module Metanorma
                     end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
-        @fatalerror = []
       end
 
       def init_i18n(node)
@@ -141,7 +140,7 @@ module Metanorma
         clean_exit
         ret
       rescue StandardError => e
-        @log.add("Fatal Error", nil, e.message)
+        @log.add("Fatal Error", nil, e.message, severity: 0)
         clean_exit
         raise e
       end

data/lib/metanorma/standoc/biblio.rng

@@ -374,6 +374,16 @@
       <ref name="image"/>
     </element>
   </define>
+  <define name="depiction">
+    <element name="depiction">
+      <optional>
+        <attribute name="scope"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="image"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="NameWithVariants">
     <element name="primary">
       <ref name="LocalizedString"/>
@@ -760,6 +770,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="ReducedBibliographicItem">
     <optional>

data/lib/metanorma/standoc/cleanup_asciibib.rb

@@ -22,7 +22,7 @@ module Metanorma
         unless id
           @log.add("Anchors", clause,
                    "The following reference is missing an anchor:\n" \
-                   "#{clause.to_xml}")
+                   "#{clause.to_xml}", severity: 1)
           return
         end
         @refids << id
@@ -31,10 +31,12 @@ module Metanorma
 
       def validate_ref_dl1(bib, id, clause)
         bib["title"] or
-          @log.add("Bibliography", clause, "Reference #{id} is missing a title")
+          @log.add("Bibliography", clause, "Reference #{id} is missing a title",
+                   severity: 1)
         bib["docid"] or
           @log.add("Bibliography", clause,
-                   "Reference #{id} is missing a document identifier (docid)")
+                   "Reference #{id} is missing a document identifier (docid)",
+                   severity: 1)
       end
 
       def extract_from_p(tag, bib, key)

data/lib/metanorma/standoc/cleanup_bibitem.rb

@@ -0,0 +1,144 @@
+module Metanorma
+  module Standoc
+    module Cleanup
+      def formattedref_spans(xmldoc)
+        xmldoc.xpath("//bibitem[formattedref//span]").each do |b|
+          ret = new_bibitem_from_formattedref_spans(b)
+          merge_bibitem_from_formattedref_spans(b, ret)
+        end
+      end
+
+      def new_bibitem_from_formattedref_spans(bib)
+        ret = SpansToBibitem.new(bib).convert
+        ret.err.each do |e|
+          @log.add("Bibliography", bib, e[:msg], severity: e[:fatal] ? 0 : 1)
+        end
+        ret.out
+      end
+
+      def merge_bibitem_from_formattedref_spans(bib, new)
+        new["type"] and bib["type"] = new["type"]
+        if bib.at("./title") # there already is a fetched record here: merge
+          bib.children = MergeBibitems
+            .new(bib.to_xml, new.to_xml).merge.to_noko.children
+        else bib << new.children.to_xml
+        end
+      end
+
+      def fold_notes_into_biblio(refs)
+        refs.xpath("./bibitem").each do |r|
+          while r&.next_element&.name == "note"
+            r.next_element["appended"] = true
+            r << r.next_element.remove
+          end
+        end
+      end
+
+      def extract_notes_from_biblio(refs)
+        refs.xpath("./bibitem").each do |r|
+          r.xpath("./note[@appended]").reverse.each do |n|
+            n.delete("appended")
+            r.next = n
+          end
+        end
+      end
+
+      def biblio_hidden_inherit(xmldoc)
+        xmldoc.xpath("//references[@hidden = 'true']").each do |r|
+          r.xpath("./bibitem").each { |b| b["hidden"] = true }
+        end
+      end
+
+      def biblio_no_ext(xmldoc)
+        xmldoc.xpath("//bibitem/ext").each(&:remove)
+      end
+
+      def format_ref(ref, type)
+        ret = Nokogiri::XML.fragment(ref)
+        ret.traverse { |x| x.remove if x.name == "fn" }
+        ref = to_xml(ret)
+        type != "metanorma" and return @isodoc.docid_prefix(type, ref)
+        /^\d+$/.match(ref) && !/^\[.*\]$/.match(ref) and return "[#{ref}]"
+        ref
+      end
+
+      def reference_names(xmldoc)
+        xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
+          @anchors[ref["id"]] =
+            if docid = select_docid(ref)
+              reference = format_ref(docid.children.to_xml, docid["type"])
+              { xref: reference, id: idtype2cit(ref) }
+            else { xref: ref["id"], id: { "" => ref["id"] } }
+            end
+        end
+      end
+
+      def idtype2cit(ref)
+        ref.xpath("./docidentifier/@type").each_with_object({}) do |t, m|
+          m[t.text] and next
+          docid = select_docid(ref, t.text) or next
+          m[t.text] = format_ref(docid.children.to_xml, docid["type"])
+        end
+      end
+
+      def select_docid(ref, type = nil)
+        type and t = "[@type = '#{type}']"
+        ref.at("./docidentifier[@type = 'metanorma']#{t}") ||
+          ref.at("./docidentifier[@primary = 'true'][@language = '#{@lang}']#{t}") ||
+          ref.at("./docidentifier[@primary = 'true'][not(@language)]#{t}") ||
+          ref.at("./docidentifier[@primary = 'true']#{t}") ||
+          ref.at("./docidentifier[not(@type = 'DOI')][@language = '#{@lang}']#{t}") ||
+          ref.at("./docidentifier[not(@type = 'DOI')][not(@language)]#{t}") ||
+          ref.at("./docidentifier[not(@type = 'DOI')]#{t}")
+      end
+
+      def fetch_termbase(_termbase, _id)
+        ""
+      end
+
+      def read_local_bibitem(uri)
+        xml = read_local_bibitem_file(uri) or return nil
+        ret = xml.at("//*[local-name() = 'bibdata']") or return nil
+        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>}
+        ret&.at("./*[local-name() = 'ext']")&.remove
+        ret
+      end
+
+      def read_local_bibitem_file(uri)
+        %r{^https?://}.match?(uri) and return nil
+        file = "#{@localdir}#{uri}.rxl"
+        File.file?(file) or file = "#{@localdir}#{uri}.xml"
+        File.file?(file) or return nil
+        Nokogiri::XML(File.read(file, encoding: "utf-8"))
+      end
+
+      # 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|
+          uri = b&.at("./uri[@type = 'citation']")&.text
+          bibitem = read_local_bibitem(uri) or next
+          bibitem["id"] = b["id"]
+          b.replace(bibitem)
+        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)
+        formattedref_spans(xmldoc)
+        fetch_local_bibitem(xmldoc)
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/cleanup_block.rb

@@ -218,7 +218,7 @@ module Metanorma
       def ol_cleanup(doc)
         doc.xpath("//ol[@explicit-type]").each do |x|
           x.delete("explicit-type")
-          @log.add("Bibliography", x,
+          @log.add("Style", x,
                    "Style override set for ordered list")
         end
       end

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -20,7 +20,7 @@ module Metanorma
         source.each do |s|
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil,
-                     "term source #{s['bibitemid']} not referenced")
+                     "term source #{s['bibitemid']} not referenced", severity: 1)
         end
         a = if source.empty? && term.nil? then @i18n.no_terms_boilerplate
             else term_defs_boilerplate_cont(source, term, isodoc)

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -114,7 +114,7 @@ module Metanorma
 
       def footnote_block_error(fnote)
         @log.add("Crossreferences", fnote,
-                 "Could not resolve footnoteblock:[#{fnote.text}]")
+                 "Could not resolve footnoteblock:[#{fnote.text}]", severity: 1)
         fnote.children = "[ERROR]"
       end
 

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -212,9 +212,7 @@ module Metanorma
           l["target"] = Addressable::URI.parse(l["target"]).to_s
         rescue Addressable::URI::InvalidURIError
           err = "Malformed URI: #{l['target']}"
-          @log.add("Anchors", l, err)
-          @fatalerror << err
-          warn err
+          @log.add("Anchors", l, err, severity: 0)
         end
       end
 

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -29,9 +29,7 @@ module Metanorma
 
       def asciimath2mathml_err(text, expr)
         err = "Malformed MathML: #{expr}\n#{text}"
-        @log.add("Maths", nil, err)
-        @fatalerror << err
-        warn err
+        @log.add("Maths", nil, err, severity: 0)
       end
 
       def asciimath2mathml_wrap(xml)

data/lib/metanorma/standoc/cleanup_ref.rb

@@ -2,35 +2,11 @@ require "set"
 require "relaton_bib"
 require_relative "merge_bibitems"
 require_relative "spans_to_bibitem"
+require_relative "cleanup_bibitem"
 
 module Metanorma
   module Standoc
     module Cleanup
-      def formattedref_spans(xmldoc)
-        xmldoc.xpath("//bibitem[formattedref//span]").each do |b|
-          ret = new_bibitem_from_formattedref_spans(b)
-          merge_bibitem_from_formattedref_spans(b, ret)
-        end
-      end
-
-      def new_bibitem_from_formattedref_spans(bib)
-        ret = SpansToBibitem.new(bib).convert
-        ret.err.each do |e|
-          @log.add("Bibliography", bib, e[:msg])
-          e[:fatal] and @fatalerror << e[:msg]
-        end
-        ret.out
-      end
-
-      def merge_bibitem_from_formattedref_spans(bib, new)
-        new["type"] and bib["type"] = new["type"]
-        if bib.at("./title") # there already is a fetched record here: merge
-          bib.children = MergeBibitems
-            .new(bib.to_xml, new.to_xml).merge.to_noko.children
-        else bib << new.children.to_xml
-        end
-      end
-
       def biblio_reorder(xmldoc)
         xmldoc.xpath("//references[@normative = 'false']").each do |r|
           biblio_reorder1(r)
@@ -40,7 +16,7 @@ module Metanorma
       def biblio_reorder1(refs)
         fold_notes_into_biblio(refs)
         bib = sort_biblio(refs.xpath("./bibitem"))
-        insert = refs&.at("./bibitem")&.previous_element
+        insert = refs.at("./bibitem")&.previous_element
         refs.xpath("./bibitem").each(&:remove)
         bib.reverse.each do |b|
           (insert and insert.next = b.to_xml) or
@@ -50,24 +26,6 @@ module Metanorma
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
       end
 
-      def fold_notes_into_biblio(refs)
-        refs.xpath("./bibitem").each do |r|
-          while r&.next_element&.name == "note"
-            r.next_element["appended"] = true
-            r << r.next_element.remove
-          end
-        end
-      end
-
-      def extract_notes_from_biblio(refs)
-        refs.xpath("./bibitem").each do |r|
-          r.xpath("./note[@appended]").reverse.each do |n|
-            n.delete("appended")
-            r.next = n
-          end
-        end
-      end
-
       def sort_biblio(bib)
         bib
       end
@@ -114,12 +72,6 @@ module Metanorma
         biblio_no_ext(xmldoc)
       end
 
-      def biblio_hidden_inherit(xmldoc)
-        xmldoc.xpath("//references[@hidden = 'true']").each do |r|
-          r.xpath("./bibitem").each { |b| b["hidden"] = true }
-        end
-      end
-
       def biblio_linkonly(xmldoc)
         xmldoc.at("//xref[@hidden]") or return
         ins = xmldoc.at("//bibliography")
@@ -139,10 +91,6 @@ module Metanorma
         reference_populate(refs)
       end
 
-      def biblio_no_ext(xmldoc)
-        xmldoc.xpath("//bibitem/ext").each(&:remove)
-      end
-
       def biblio_annex(xmldoc)
         xmldoc.xpath("//annex[references/references]").each do |t|
           t.xpath("./clause | ./references | ./terms").size == 1 or next
@@ -153,101 +101,29 @@ module Metanorma
       end
 
       def biblio_nested(xmldoc)
-        xmldoc.xpath("//references[references]").each do |t|
-          t.name = "clause"
-          t.xpath("./references").each { |r| r["normative"] = t["normative"] }
-          t.delete("normative")
-        end
-      end
-
-      def format_ref(ref, type)
-        ret = Nokogiri::XML.fragment(ref)
-        ret.traverse { |x| x.remove if x.name == "fn" }
-        ref = to_xml(ret)
-        return @isodoc.docid_prefix(type, ref) if type != "metanorma"
-        return "[#{ref}]" if /^\d+$/.match(ref) && !/^\[.*\]$/.match(ref)
-
-        ref
-      end
-
-      def reference_names(xmldoc)
-        xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
-          @anchors[ref["id"]] = if docid = select_docid(ref)
-                                  reference = format_ref(docid.children.to_xml,
-                                                         docid["type"])
-                                  { xref: reference, id: idtype2cit(ref) }
-                                else
-                                  { xref: ref["id"], id: { "" => ref["id"] } }
-                                end
-        end
-      end
-
-      def idtype2cit(ref)
-        ref.xpath("./docidentifier/@type").each_with_object({}) do |t, m|
-          m[t.text] and next
-          docid = select_docid(ref, t.text) or next
-          m[t.text] = format_ref(docid.children.to_xml, docid["type"])
-        end
-      end
-
-      def select_docid(ref, type = nil)
-        type and t = "[@type = '#{type}']"
-        ref.at("./docidentifier[@type = 'metanorma']#{t}") ||
-          ref.at("./docidentifier[@primary = 'true'][@language = '#{@lang}']#{t}") ||
-          ref.at("./docidentifier[@primary = 'true'][not(@language)]#{t}") ||
-          ref.at("./docidentifier[@primary = 'true']#{t}") ||
-          ref.at("./docidentifier[not(@type = 'DOI')][@language = '#{@lang}']#{t}") ||
-          ref.at("./docidentifier[not(@type = 'DOI')][not(@language)]#{t}") ||
-          ref.at("./docidentifier[not(@type = 'DOI')]#{t}")
-      end
-
-      def fetch_termbase(_termbase, _id)
-        ""
-      end
-
-      def read_local_bibitem(uri)
-        xml = read_local_bibitem_file(uri) or return nil
-        ret = xml.at("//*[local-name() = 'bibdata']") or return nil
-        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>}
-        ret&.at("./*[local-name() = 'ext']")&.remove
-        ret
+        biblio_nested_initial_items(xmldoc)
+        biblio_nested_sections(xmldoc)
       end
 
-      def read_local_bibitem_file(uri)
-        %r{^https?://}.match?(uri) and return nil
-        file = "#{@localdir}#{uri}.rxl"
-        File.file?(file) or file = "#{@localdir}#{uri}.xml"
-        File.file?(file) or return nil
-        Nokogiri::XML(File.read(file, encoding: "utf-8"))
-      end
-
-      # 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|
-          uri = b&.at("./uri[@type = 'citation']")&.text
-          bibitem = read_local_bibitem(uri) or next
-          bibitem["id"] = b["id"]
-          b.replace(bibitem)
+      def biblio_nested_initial_items(xmldoc)
+        xmldoc.xpath("//references[references][bibitem]").each do |t|
+          r = t.at("./references")
+          ref = t.at("./bibitem")
+            .before("<references unnumbered='true'></references>").previous
+          (ref.xpath("./following-sibling::*") &
+           r.xpath("./preceding-sibling::*")).each do |x|
+            ref << x
+          end
         end
       end
 
-      def bibitem_nested_id(xmldoc)
-        xmldoc.xpath("//bibitem//bibitem").each do |b|
-          b.delete("id")
+      def biblio_nested_sections(xmldoc)
+        xmldoc.xpath("//references[references]").each do |t|
+          t.name = "clause"
+          t.xpath("./references").each { |r| r["normative"] = t["normative"] }
+          t.delete("normative")
         end
       end
-
-      def bibitem_cleanup(xmldoc)
-        bibitem_nested_id(xmldoc)
-        ref_dl_cleanup(xmldoc)
-        formattedref_spans(xmldoc)
-        fetch_local_bibitem(xmldoc)
-      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_terms_designations.rb

@@ -5,8 +5,7 @@ module Metanorma
         xmldoc.xpath("//term//expression/name[stem]").each do |n|
           test = n.dup
           test.at("./stem").remove
-          next unless test.text.strip.empty?
-
+          test.text.strip.empty? or next
           n.parent.name = "letter-symbol"
         end
       end
@@ -107,10 +106,11 @@ module Metanorma
       end
 
       def term_to_letter_symbol(prev, dlist)
-        ls = dlist.at("./dt[text()='letter-symbol']/following::dd/p")
-        return unless ls&.text == "true"
-
-        prev.at(".//expression").name = "letter-symbol"
+        ls = dlist.at("./dt[text()='letter-symbol']/following::dd/p")&.text
+        !ls || ls == "false" and return
+        e = prev.at(".//expression")
+        e.name = "letter-symbol"
+        ls != "true" and e["type"] = ls
       end
 
       def dl_to_designation(dlist)

data/lib/metanorma/standoc/cleanup_text.rb

@@ -39,8 +39,8 @@ module Metanorma
 
       def uninterrupt_quotes_around_xml_skip(elem)
         !(/\A['"]/.match?(elem.text) &&
-          elem.previous.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2].
-          intersection(IGNORE_QUOTES_ELEMENTS).empty? &&
+          elem.previous.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2]
+          .intersection(IGNORE_QUOTES_ELEMENTS).empty? &&
           ((elem.previous.text.strip.empty? &&
             !empty_tag_with_text_content?(elem.previous)) ||
            ignoretext?(elem.previous)))
@@ -50,8 +50,8 @@ module Metanorma
         prev = elem.at(".//preceding::text()[1]") or return
         /\S\Z/.match?(prev.text) or return
         foll = elem.at(".//following::text()[1]")
-        m = /\A(["'][[:punct:]]*)(\s|\Z)/.
-          match(@c.decode(foll&.text)) or return
+        m = /\A(["'][[:punct:]]*)(\s|\Z)/
+          .match(@c.decode(foll&.text)) or return
         foll.content = foll.text.sub(/\A(["'][[:punct:]]*)/, "")
         prev.content = "#{prev.text}#{m[1]}"
       end
@@ -103,8 +103,8 @@ module Metanorma
           next unless n.text? && /\u2019/.match?(n.text)
 
           n.replace(@c.encode(
-                      @c.decode(n.text).
-            gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"),
+                      @c.decode(n.text)
+            .gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"),
                       :basic, :hexadecimal
                     ))
         end

data/lib/metanorma/standoc/converter.rb

@@ -114,7 +114,7 @@ module Metanorma
       def skip(node, name = nil)
         name = name || node.node_name
         w = "converter missing for #{name} node in Metanorma backend"
-        @log.add("AsciiDoc Input", node, w)
+        @log.add("AsciiDoc Input", node, w, severity: 1)
         nil
       end
 

data/lib/metanorma/standoc/front.rb

@@ -149,8 +149,7 @@ module Metanorma
       end
 
       def metadata_keywords(node, xml)
-        return unless node.attr("keywords")
-
+        node.attr("keywords") or return
         node.attr("keywords").split(/,\s*/).each do |kw|
           xml.keyword kw
         end
@@ -225,9 +224,8 @@ module Metanorma
 
       def title_otherlangs(node, xml)
         node.attributes.each do |k, v|
-          next unless /^title-(?<titlelang>.+)$/ =~ k
-          next if titlelang == "en"
-
+          /^title-(?<titlelang>.+)$/ =~ k or next
+          titlelang == "en" and next
           xml.title v, { language: titlelang, format: "text/plain" }
         end
       end