metanorma-standoc 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31a7d2190d00f77453583314cf1fd4169b2a7d54c8a9c875c1aee18c0036c83
-  data.tar.gz: 7d827880dc836092ed06347a2b008597645416dbd50ecee20000e06f3b245b53
+  metadata.gz: 10660a42ed7862e1985812db06bfba17b763ff8e2d1e30f61d09eb5739c1a0b9
+  data.tar.gz: 9e90a193f69f066f3d63650abb39abb3943f55cd2fe14474b72866dcf75e791b
 SHA512:
-  metadata.gz: 667dae14d6d8fa22c20d531cfbadf6a5df8678b6180edcadc021dad25b1b63fdffe71d89d24ba5ed3af90f82f3661b12fcd943b31e611f76e211458c95db4235
-  data.tar.gz: b4eb5852322aab31ba5afe54508c9f3fdcdb6664718667124de3e2031902b2d27511f8459ad64b43267f13f9cb74efb9d3284acec2566a930a4acff5819443bd
+  metadata.gz: 70e5255195aba9303da9db4c2088997f59bc00bef4f4358548c77780a575a652a217519d05f6f37884f4f89c1f7601a19d88f6943bb2f2ec5f5ab75485368ac1
+  data.tar.gz: a5092f7c6848a6038e98aa9aafcee2170650d7f0b9160a796b807bf6ca85f607eedbfffaedf6d88eca797f56ca9509f0abada15f192f70c0e8b691d383b548c3

data/lib/metanorma/standoc/anchor.rb

@@ -34,7 +34,7 @@ module Metanorma
         t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
         attrs, text = inline_anchor_xref_match(text)
         attrs.empty? and
-          return { target: t, type: "inline", text:, style: @xrefstyle }
+          return { target: t, type: "inline", text:, defaultstyle: @xrefstyle }
         inline_anchor_xref_attrs1(attrs, t, text)
       end
 
@@ -50,7 +50,8 @@ module Metanorma
           type: attrs.key?("fn") ? "footnote" : "inline",
           case: %w(capital lowercase).detect { |x| attrs.key?(x) },
           label: attrs["label"],
-          style: attrs["style"] || @xrefstyle,
+          style: attrs["style"],
+          defaultstyle: @xrefstyle,
           droploc: attrs.key?("droploc") || nil,
           text: }.compact
       end

data/lib/metanorma/standoc/biblio.rng

@@ -690,7 +690,7 @@ Examples include GRID, LEI, CrossRef, and Ringgold</a:documentation>
   <define name="CitationType">
     <attribute name="bibitemid">
       <a:documentation>Bibliographic item that the citation applies to, referenced as the anchor of a bibliographic description</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <choice>
       <zeroOrMore>
@@ -1296,17 +1296,17 @@ for which this claim of validity is made, if applicable</a:documentation>
   </define>
   <define name="validityBegins">
     <element name="validityBegins">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="validityEnds">
     <element name="validityEnds">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="validityRevision">
     <element name="revision">
-      <ref name="ISO8601Date"/>
+      <ref name="ISO8601DateTime"/>
     </element>
   </define>
   <define name="TypedTitleString">

data/lib/metanorma/standoc/blocks.rb

@@ -48,9 +48,7 @@ module Metanorma
 
       def block_title(node, out)
         node.title.nil? and return
-        out.name **attr_code(id_attr(nil)) do |name|
-          name << node.title
-        end
+        add_noko_elem(out, "name", node.title, id_attr(nil))
       end
 
       def form_attrs(node)
@@ -180,11 +178,10 @@ module Metanorma
         if node.attr("citetitle")
           m = /^(?<cite>[^,]+)(?:,(?<text>.*$))?$/m.match node.attr("citetitle")
           out.source **attr_code(target: m[:cite], type: "inline") do |s|
-            s <<  m[:text]
+            s << m[:text]
           end
         end
-        node.attr("attribution") and
-          out.author { |a| a << node.attr("attribution") }
+        add_noko_elem(out, "author", node.attr("attribution"))
       end
 
       def quote(node)

data/lib/metanorma/standoc/cleanup.rb

@@ -31,6 +31,7 @@ module Metanorma
         element_name_cleanup(xmldoc)
         source_include_cleanup(xmldoc) # feeds: misccontainer_cleanup
         passthrough_cleanup(xmldoc) # feeds: smartquotes_cleanup
+        annotation_cleanup(xmldoc)
         unnumbered_blocks_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc) # feeds: metadata_cleanup
         metadata_cleanup(xmldoc) # feeds: boilerplate_cleanup, bibdata_cleanup,
@@ -119,11 +120,21 @@ module Metanorma
         @relaton_log.rewind
         @relaton_log.string.split(/(?<=})\n(?={)/).each do |l|
           e = JSON.parse(l)
-          @log.add(RELATON_SEVERITIES[e["severity"].to_sym], e["key"],
-                   params: [e["message"]])
+          relaton_log_add?(e) and
+            @log.add(RELATON_SEVERITIES[e["severity"].to_sym], e["key"],
+                     params: [e["message"]])
         end
       end
 
+      def relaton_log_add?(entry)
+        entry["message"].include?("Fetching from") and return false
+        entry["message"].include?("Downloaded index from") and return false
+        entry["message"].start_with?("Found:") or return true
+        id = /^Found: `(.+)`$/.match(entry["message"]) or return true
+        entry["key"].end_with?(id[1]) and return false
+        true
+      end
+
       def docidentifier_cleanup(xmldoc); end
 
       TEXT_ELEMS =
@@ -142,9 +153,8 @@ module Metanorma
 
       def empty_element_cleanup(xmldoc)
         xmldoc.xpath("//#{TEXT_ELEMS.join(' | //')}").each do |x|
-          next if x.name == "name" && x.parent.name == "expression"
-
-          x.remove if x.children.empty?
+          x.name == "name" && x.parent.name == "expression" and next
+          x.children.empty? and x.remove
         end
       end
 
@@ -152,58 +162,6 @@ module Metanorma
         xmldoc.traverse { |n| n.name = n.name.tr("_", "-") }
       end
 
-      # allows us to deal with doc relation localities,
-      # temporarily stashed to "bpart"
-      def bpart_cleanup(xmldoc)
-        xmldoc.xpath("//relation/bpart").each do |x|
-          extract_localities(x)
-          x.replace(x.children)
-        end
-      end
-
-      def variant_cleanup(xmldoc)
-        variant_space_cleanup(xmldoc)
-        xmldoc.xpath("//*[lang-variant]").each do |c|
-          if only_langvariant_children?(c)
-            duplicate_langvariants(c, c.xpath("./lang-variant"))
-          else
-            c.xpath(".//lang-variant").each { |x| x.name = "span" }
-          end
-        end
-      end
-
-      def only_langvariant_children?(node)
-        node.children.none? do |n|
-          n.name != "lang-variant" && (!n.text? || !n.text.strip.empty?)
-        end
-      end
-
-      def duplicate_langvariants(container, variants)
-        lang_variant_to_node(variants.first, container)
-        variants[1..].reverse.each do |node|
-          new = container.dup
-          lang_variant_to_node(node, new)
-          container.next = new
-        end
-      end
-
-      def lang_variant_to_node(variant, node)
-        node.children = variant.children
-        node["lang"] = variant["lang"]
-        node.delete("script")
-        variant["script"] and node["script"] = variant["script"]
-      end
-
-      def variant_space_cleanup(xmldoc)
-        xmldoc.xpath("//*[lang-variant]").each do |c|
-          c.next.nil? || c.next.next.nil? and next
-          if c.next.text? && c.next.next.name == "lang-variant"
-            c.next.text.gsub(/\s/, "").empty? and
-              c.next.remove
-          end
-        end
-      end
-
       def metadata_cleanup(xmldoc)
         bibdata_published(xmldoc) # feeds: bibdata_cleanup,
         # docidentifier_cleanup (in generic: template)
@@ -221,6 +179,18 @@ module Metanorma
           x.children = @isodoc.populate_template(to_xml(x.children), nil)
         end
       end
+
+      def annotation_cleanup(xmldoc)
+        ret = xmldoc.xpath("//annotation[@type = 'ignore-log']")
+          .each_with_object([]) do |ann, m|
+          error_ids = Array(csv_split(ann.text || "", ","))
+          m << { from: ann["from"], to: ann["to"], error_ids: error_ids }
+          ann
+        end
+        config = @log.suppress_log
+        config[:locations] += ret
+        @log.suppress_log = config
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_bibdata.rb

@@ -196,6 +196,15 @@ module Metanorma
       def published?(stage, _xmldoc)
         stage.casecmp("published").zero?
       end
+
+      # allows us to deal with doc relation localities,
+      # temporarily stashed to "bpart"
+      def bpart_cleanup(xmldoc)
+        xmldoc.xpath("//relation/bpart").each do |x|
+          extract_localities(x)
+          x.replace(x.children)
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -18,8 +18,7 @@ module Metanorma
         a.text? or return
         if /\S/.match?(a.text)
           a.content = a.text.lstrip
-        else
-          a.remove
+        else a.remove
         end
       end
 
@@ -189,6 +188,48 @@ module Metanorma
         end
       end
 
+      def variant_cleanup(xmldoc)
+        variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[lang-variant]").each do |c|
+          if only_langvariant_children?(c)
+            duplicate_langvariants(c, c.xpath("./lang-variant"))
+          else
+            c.xpath(".//lang-variant").each { |x| x.name = "span" }
+          end
+        end
+      end
+
+      def only_langvariant_children?(node)
+        node.children.none? do |n|
+          n.name != "lang-variant" && (!n.text? || !n.text.strip.empty?)
+        end
+      end
+
+      def duplicate_langvariants(container, variants)
+        lang_variant_to_node(variants.first, container)
+        variants[1..].reverse.each do |node|
+          new = container.dup
+          lang_variant_to_node(node, new)
+          container.next = new
+        end
+      end
+
+      def lang_variant_to_node(variant, node)
+        node.children = variant.children
+        node["lang"] = variant["lang"]
+        node.delete("script")
+        variant["script"] and node["script"] = variant["script"]
+      end
+
+      def variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[lang-variant]").each do |c|
+          c.next.nil? || c.next.next.nil? and next
+          c.next.text? && c.next.next.name == "lang-variant" &&
+            c.next.text.gsub(/\s/, "").empty? and
+            c.next.remove
+        end
+      end
+
       private
 
       # skip ZWNJ inserted to prevent regexes operating in asciidoctor

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -147,6 +147,7 @@ module Metanorma
           p.name = "variant-title"
           p.delete("variant_title")
           p.xpath("(#{path})[last()]").each do |sect|
+            p.remove
             (ins = sect.at("./title") and ins.next = p) or
               sect.add_first_child(p)
           end

data/lib/metanorma/standoc/cleanup_xref.rb

@@ -85,6 +85,7 @@ module Metanorma
         else xref_to_eref1(elem)
         end
         elem.delete("target")
+        elem.delete("defaultstyle") # xrefstyle default
         extract_localities(elem)
       end
 
@@ -179,10 +180,11 @@ module Metanorma
         xmldoc.xpath("//xref").each do |x|
           %r{:(?!//)}.match?(x["target"]) and xref_to_internal_eref(x)
           x.name == "xref" or next
-          if refid? x["target"]
-            xref_to_eref(x, "eref")
+          if refid? x["target"] then xref_to_eref(x, "eref")
           elsif @anchor_alias[x["target"]] then xref_alias(x)
-          else x.delete("type")
+          else
+            x.delete("type")
+            xref_default_style(x)
           end
         end
       end
@@ -203,6 +205,12 @@ module Metanorma
         elem["style"] == "id" && elem.text.strip.empty? and
           elem << elem["target"]
         elem["target"] = @anchor_alias[elem["target"]]
+        xref_default_style(elem)
+      end
+
+      def xref_default_style(elem)
+        elem["defaultstyle"] and elem["style"] ||= elem["defaultstyle"]
+        elem.delete("defaultstyle")
       end
 
       def quotesource_cleanup(xmldoc)

data/lib/metanorma/standoc/front.rb

@@ -9,7 +9,7 @@ module Metanorma
     module Front
       def metadata_id(node, xml)
         id = node.attr("docidentifier") || metadata_id_build(node)
-        xml.docidentifier id, primary: "true"
+        add_noko_elem(xml, "docidentifier", id, primary: "true")
       end
 
       def metadata_id_build(node)
@@ -21,21 +21,23 @@ module Metanorma
       end
 
       def metadata_other_id(node, xml)
-        a = node.attr("isbn") and xml.docidentifier a, type: "ISBN"
-        a = node.attr("isbn10") and xml.docidentifier a, type: "ISBN10"
+        a = node.attr("isbn") and
+          add_noko_elem(xml, "docidentifier", a, type: "ISBN")
+        a = node.attr("isbn10") and
+          add_noko_elem(xml, "docidentifier", a, type: "ISBN10")
         csv_split(node.attr("docidentifier-additional"), ",")&.each do |n|
           t, v = n.split(":", 2)
-          xml.docidentifier v, type: t
+          add_noko_elem(xml, "docidentifier", v, type: t)
         end
-        xml.docnumber node.attr("docnumber")
+        add_noko_elem(xml, "docnumber", node.attr("docnumber"))
       end
 
       def metadata_version(node, xml)
         draft = metadata_version_value(node)
-        xml.edition node.attr("edition") if node.attr("edition")
+        add_noko_elem(xml, "edition", node.attr("edition"))
         xml.version do |v|
-          v.revision_date node.attr("revdate") if node.attr("revdate")
-          v.draft draft if draft
+          add_noko_elem(v, "revision_date", node.attr("revdate"))
+          add_noko_elem(v, "draft", draft)
         end
       end
 
@@ -48,23 +50,24 @@ module Metanorma
 
       def metadata_status(node, xml)
         xml.status do |s|
-          s.stage (node.attr("status") || node.attr("docstage") || "published")
-          node.attr("docsubstage") and s.substage node.attr("docsubstage")
-          node.attr("iteration") and s.iteration node.attr("iteration")
+          add_noko_elem(s, "stage",
+                        node.attr("status") || node.attr("docstage") || "published")
+          add_noko_elem(s, "substage", node.attr("docsubstage"))
+          add_noko_elem(s, "iteration", node.attr("iteration"))
         end
       end
 
       def metadata_source(node, xml)
-        node.attr("uri") && xml.uri(node.attr("uri"))
+        add_noko_elem(xml, "uri", node.attr("uri"))
         %w(xml html pdf doc relaton).each do |t|
-          node.attr("#{t}-uri") && xml.uri(node.attr("#{t}-uri"), type: t)
+          add_noko_elem(xml, "uri", node.attr("#{t}-uri"), type: t)
         end
       end
 
       def metadata_date1(node, xml, type)
         date = node.attr("#{type}-date")
         date and xml.date(type:) do |d|
-          d.on date
+          add_noko_elem(d, "on", date)
         end
       end
 
@@ -80,17 +83,17 @@ module Metanorma
           a == "date" || /^date_\d+$/.match(a) or next
           type, date = node.attr(a).split(/ /, 2)
           type or next
-          xml.date(type:) { |d| d.on date }
+          xml.date(type:) { |d| add_noko_elem(d, "on", date) }
         end
       end
 
       def metadata_language(node, xml)
-        xml.language (node.attr("language") || "en")
-        l = node.attr("locale") and xml.locale l
+        add_noko_elem(xml, "language", node.attr("language") || "en")
+        add_noko_elem(xml, "locale", node.attr("locale"))
       end
 
       def metadata_script(node, xml)
-        xml.script (node.attr("script") ||
+        add_noko_elem(xml, "script", node.attr("script") ||
                     Metanorma::Utils.default_script(node.attr("language")))
       end
 
@@ -128,8 +131,8 @@ module Metanorma
         xml.relation type: relation_normalise(type) do |r|
           desc.nil? or r.description desc.tr("-", " ")
           fetch_ref(r, doc, nil, **{}) or r.bibitem do |b|
-            b.title id[1] || "--"
-            b.docidentifier id[0]
+            add_noko_elem(b, "title", id[1] || "--")
+            add_noko_elem(b, "docidentifier", id[0])
           end
         end
       end
@@ -137,7 +140,7 @@ module Metanorma
       def metadata_keywords(node, xml)
         node.attr("keywords") or return
         node.attr("keywords").split(/,\s*/).each do |kw|
-          xml.keyword kw
+          add_noko_elem(xml, "keyword", kw)
         end
       end
 
@@ -145,7 +148,7 @@ module Metanorma
         csv_split(node.attr("classification"), ",")&.each do |c|
           vals = c.split(/:/, 2)
           vals.size == 1 and vals = ["default", vals[0]]
-          xml.classification vals[1], type: vals[0]
+          add_noko_elem(xml, "classification", vals[1], type: vals[0])
         end
       end
 
@@ -204,9 +207,8 @@ module Metanorma
       end
 
       def add_title_xml(xml, content, language, type)
-        xml.title **attr_code(language: language, type: type) do |t|
-          t << Metanorma::Utils::asciidoc_sub(content)
-        end
+        add_noko_elem(xml, "title", Metanorma::Utils::asciidoc_sub(content),
+                      language: language, type: type)
       end
 
       def title_fallback(node, xml)

data/lib/metanorma/standoc/front_committee.rb

@@ -46,13 +46,13 @@ module Metanorma
           committee[:agency_abbrev] = agency
           agency = name
         end
-        xml.name agency
+        add_noko_elem(xml, "name", agency)
         s = committee
         loop do
           contrib_committee_subdiv(xml, s)
           s = s[:subdiv] or break
         end
-        abbr = committee[:agency_abbrev] and xml.abbreviation abbr
+        add_noko_elem(xml, "abbreviation", committee[:agency_abbrev])
         full_committee_id(xml.parent)
       end
 
@@ -60,9 +60,9 @@ module Metanorma
         contributors_committees_filter_empty?(committee) and return
         xml.subdivision **attr_code(type: committee[:subdivtype],
                                     subtype: committee[:type]) do |o|
-          o.name committee[:name]
-          committee[:abbr] and o.abbreviation committee[:abbr]
-          committee[:ident] and o.identifier committee[:ident]
+          add_noko_elem(o, "name", committee[:name])
+          add_noko_elem(o, "abbreviation", committee[:abbr])
+          add_noko_elem(o, "identifier", committee[:ident])
         end
       end
 

data/lib/metanorma/standoc/front_contributor.rb

@@ -37,19 +37,19 @@ module Metanorma
         type = node.attr("role#{suffix}")&.downcase || "author"
         desc = node.attr("role-description#{suffix}")
         contrib.role type: type do |r|
-          desc and r.description do |d|
-            d << desc
-          end
+          add_noko_elem(r, "description", desc)
         end
       end
 
       def personal_contact(node, suffix, person)
-        node.attr("phone#{suffix}") and person.phone node.attr("phone#{suffix}")
+        node.attr("phone#{suffix}") and
+          add_noko_elem(person, "phone", node.attr("phone#{suffix}"))
         node.attr("fax#{suffix}") and
-          person.phone node.attr("fax#{suffix}"), type: "fax"
-        node.attr("email#{suffix}") and person.email node.attr("email#{suffix}")
+          add_noko_elem(person, "phone", node.attr("fax#{suffix}"), type: "fax")
+        node.attr("email#{suffix}") and
+          add_noko_elem(person, "email", node.attr("email#{suffix}"))
         node.attr("contributor-uri#{suffix}") and
-          person.uri node.attr("contributor-uri#{suffix}")
+          add_noko_elem(person, "uri", node.attr("contributor-uri#{suffix}"))
       end
 
       def personal_author1(node, xml, suffix)
@@ -67,25 +67,25 @@ module Metanorma
       def person_name(node, _xml, suffix, person)
         person.name do |n|
           if node.attr("fullname#{suffix}")
-            n.completename node.attr("fullname#{suffix}")
+            add_noko_elem(n, "completename", node.attr("fullname#{suffix}"))
           else
-            n.forename node.attr("givenname#{suffix}")
-            n.initial node.attr("initials#{suffix}")
-            n.surname node.attr("surname#{suffix}")
+            add_noko_elem(n, "forename", node.attr("givenname#{suffix}"))
+            add_noko_elem(n, "initial", node.attr("initials#{suffix}"))
+            add_noko_elem(n, "surname", node.attr("surname#{suffix}"))
           end
         end
       end
 
       def person_credentials(node, _xml, suffix, person)
-        c = node.attr("contributor-credentials#{suffix}") and
-          person.credentials c
+        add_noko_elem(person, "credentials",
+                      node.attr("contributor-credentials#{suffix}"))
       end
 
       def person_affiliation(node, _xml, suffix, person)
         aff = node.attr("affiliation#{suffix}")
         pos = node.attr("contributor-position#{suffix}")
         (aff || pos) and person.affiliation do |a|
-          pos and a.name { |n| n << pos }
+          add_noko_elem(a, "name", pos)
           aff and a.organization do |o|
             person_organization(node, suffix, o)
           end

data/lib/metanorma/standoc/front_ext.rb

@@ -5,7 +5,7 @@ module Metanorma
         ics = node.attr("library-ics")
         ics&.split(/,\s*/)&.each do |i|
           xml.ics do |elem|
-            elem.code i
+            add_noko_elem(elem, "code", i)
             icsdata = Isoics.fetch i
             elem.text_ icsdata.description
           end
@@ -24,15 +24,15 @@ module Metanorma
       def structured_id(node, xml); end
 
       def metadata_doctype(node, xml)
-        xml.doctype doctype(node)
+        add_noko_elem(xml, "doctype", doctype(node))
       end
 
       def metadata_subdoctype(node, xml)
-        s = node.attr("docsubtype") and xml.subdoctype s
+        add_noko_elem(xml, "subdoctype", node.attr("docsubtype"))
       end
 
       def metadata_flavor(_node, ext)
-        ext.flavor processor.new.asciidoctor_backend
+        add_noko_elem(ext, "flavor", processor.new.asciidoctor_backend.to_s)
       end
 
       def metadata_coverpage_images(node, xml)
@@ -40,7 +40,9 @@ module Metanorma
            backpage-image).each do |n|
           if a = node.attr(n)
             xml.send n do |c|
-              a.split(",").each { |x| c.image src: x }
+              a.split(",").each do |x|
+                c.image src: x
+              end
             end
           end
         end