metanorma-iso 3.1.3 → 3.1.5

data/lib/metanorma/iso/validate_style.rb

@@ -94,17 +94,6 @@ module Metanorma
         style_problem_words(node, text)
       end
 
-      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-quantity
-      def style_subscript(node)
-        warning = "may contain nested subscripts (max 3 levels allowed)"
-        node.xpath(".//sub[.//sub]").each do |x|
-          style_warning(node, warning, x.to_xml)
-        end
-        node.xpath(".//m:msub[.//m:msub]", "m" => MATHML_NS).each do |x|
-          style_warning(node, warning, x.to_xml)
-        end
-      end
-
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-need
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-might
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-family
@@ -120,44 +109,6 @@ module Metanorma
         style_regex(/\b(?<num>billions?)\b/i, "ambiguous number", node, text)
       end
 
-      # ISO/IEC DIR 2, 9.1
-      # ISO/IEC DIR 2, Table B.1
-      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-n-numbers
-      def style_number(node, text)
-        style_number_grouping(node, text)
-        style_regex(/(?:^|\p{Zs})(?<num>[0-9]+\.[0-9]+)(?!\.[0-9])/i,
-                    "possible decimal point: mark up numbers with stem:[]", node, text)
-        @lang == "en" and style_regex(/\b(?<num>billions?)\b/i,
-                                      "ambiguous number", node, text)
-        style_regex(/(?:^|\p{Zs})(?<num>-[0-9][0-9,.]*)/i,
-                    "hyphen instead of minus sign U+2212", node, text)
-        @novalid_number = true
-      end
-
-      def style_number_grouping(node, text)
-        if @validate_years
-          style_two_regex_not_prev(
-            node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)\Z/,
-            %r{\b(ISO|IEC|IEEE|(in|January|February|March|April|May|June|August|September|October|November|December)\b)\Z},
-            "number not broken up in threes: mark up numbers with stem:[]"
-          )
-        else
-          style_two_regex_not_prev(
-            node, text, /^(?<num>-?(?:[0-9]{5,}[,0-9]*|[03-9]\d\d\d|1[0-8]\d\d|2[1-9]\d\d|20[5-9]\d))\Z/,
-            %r{\b(ISO|IEC|IEEE|\b)\Z},
-            "number not broken up in threes: mark up numbers with stem:[]"
-          )
-        end
-      end
-
-      # ISO/IEC DIR 2, 9.2.1
-      def style_percent(node, text)
-        style_regex(/\b(?<num>[0-9.,]+%)/,
-                    "no space before percent sign", node, text)
-        style_regex(/\b(?<num>[0-9.,]+ \u00b1 [0-9,.]+ %)/,
-                    "unbracketed tolerance before percent sign", node, text)
-      end
-
       # ISO/IEC DIR 2, 8.4
       # ISO/IEC DIR 2, 9.3
       def style_abbrev(node, text)
@@ -168,34 +119,6 @@ module Metanorma
                     "language-specific abbreviation", node, text)
       end
 
-      # leaving out as problematic: N J K C S T H h d B o E
-      SI_UNIT = "(m|cm|mm|km|μm|nm|g|kg|mgmol|cd|rad|sr|Hz|Hz|MHz|Pa|hPa|kJ|" \
-                "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|" \
-                "bit|kB|MB|Hart|nat|Sh|var)".freeze
-
-      # ISO/IEC DIR 2, 9.3
-      def style_units(node, text)
-        style_regex(/\b(?<num>[0-9][0-9,]*\p{Zs}+[\u00b0\u2032\u2033])/,
-                    "space between number and degrees/minutes/seconds",
-                    node, text)
-        style_regex(/\b(?<num>[0-9][0-9,]*#{SI_UNIT})\b/o,
-                    "no space between number and SI unit", node, text)
-        style_non_std_units(node, text)
-      end
-
-      NONSTD_UNITS = {
-        sec: "s", mins: "min", hrs: "h", hr: "h", cc: "cm^3",
-        lit: "l", amp: "A", amps: "A", rpm: "r/min"
-      }.freeze
-
-      # ISO/IEC DIR 2, 9.3
-      def style_non_std_units(node, text)
-        NONSTD_UNITS.each do |k, v|
-          style_regex(/\b(?<num>[0-9][0-9,]*\p{Zs}+#{k})\b/,
-                      "non-standard unit (should be #{v})", node, text)
-        end
-      end
-
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-and
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-andor
       def style_punct(node, text)

data/lib/metanorma/iso/validate_xref.rb

@@ -0,0 +1,130 @@
+module Metanorma
+  module Iso
+    class Converter < Standoc::Converter
+      # ISO/IEC DIR 2, 15.5.3, 20.2
+      # does not deal with preceding text marked up
+      def see_xrefs_validate(root)
+        @lang == "en" or return
+        anchors = extract_anchor_norm(root)
+        root.xpath("//xref").each do |t|
+          preceding = t.at("./preceding-sibling::text()[last()]")
+          !preceding.nil? &&
+            /\b(see| refer to)\p{Zs}*\Z/mi.match(preceding) or next
+          anchors[t["target"]] and
+            @log.add("Style", t,
+                     "'see #{t['target']}' is pointing to a normative section")
+        end
+      end
+
+      def extract_anchor_norm(root)
+        nodes = root.xpath("//annex[@obligation = 'normative'] | " \
+          "//references[@obligation = 'normative']")
+        ret = nodes.each_with_object({}) do |n, m|
+          n["anchor"] and m[n["anchor"]] = true
+        end
+        nodes.each do |n|
+          n.xpath(".//*[@anchor]").each { |n1| ret[n1["anchor"]] = true }
+        end
+        ret
+      end
+
+      # ISO/IEC DIR 2, 15.5.3
+      def see_erefs_validate(root)
+        @lang == "en" or return
+        bibitemids = extract_bibitem_anchors(root)
+        root.xpath("//eref").each do |t|
+          prec = t.at("./preceding-sibling::text()[last()]")
+          !prec.nil? && /\b(see|refer to)\p{Zs}*\Z/mi.match(prec) or next
+          unless target = bibitemids[t["bibitemid"]]
+            # unless target = root.at("//bibitem[@anchor = '#{t['bibitemid']}']")
+            @log.add("Bibliography", t,
+                     "'#{t} is not pointing to a real reference")
+            next
+          end
+          target[:norm] and
+            @log.add("Style", t,
+                     "'see #{t}' is pointing to a normative reference")
+        end
+      end
+
+      def extract_bibitem_anchors(root)
+        ret = root.xpath("//references[@normative = 'true']//bibitem")
+          .each_with_object({}) do |b, m|
+          m[b["anchor"]] = { bib: b, norm: true }
+        end
+        root.xpath("//references[not(@normative = 'true')]//bibitem")
+          .each do |b|
+          ret[b["anchor"]] = { bib: b, norm: false }
+        end
+        ret
+      end
+
+      # ISO/IEC DIR 2, 10.4
+      def locality_erefs_validate(root)
+        root.xpath("//eref[descendant::locality]").each do |t|
+          if /^(ISO|IEC)/.match?(t["citeas"]) &&
+              !/: ?(\d+{4}|–)$/.match?(t["citeas"])
+            @log.add("Style", t,
+                     "undated reference #{t['citeas']} should not contain " \
+                     "specific elements")
+          end
+        end
+      end
+
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-r-ref_clause3
+      def term_xrefs_validate(xmldoc)
+        termids = xmldoc
+          .xpath("//sections/terms | //sections/clause[.//terms] | " \
+                 "//annex[.//terms]").each_with_object({}) do |t, m|
+          t.xpath(".//*/@anchor").each { |a| m[a.text] = true }
+          t.xpath(".//*/@id").each { |a| m[a.text] = true }
+          t.name == "terms" and m[t["anchor"] || t["id"]] = true
+        end
+        xmldoc.xpath(".//xref").each do |x|
+          term_xrefs_validate1(x, termids)
+        end
+      end
+
+      def term_xrefs_validate1(xref, termids)
+        closest_id = xref.xpath("./ancestor::*[@id]")&.last or return
+        termids[xref["target"]] && !termids[closest_id["id"]] and
+          @log.add("Style", xref,
+                   "only terms clauses can cross-reference terms clause " \
+                   "(#{xref['target']})")
+        !termids[xref["target"]] && termids[closest_id["id"]] and
+          @log.add("Style", xref,
+                   "non-terms clauses cannot cross-reference terms clause " \
+                   "(#{xref['target']})")
+      end
+
+      # require that all assets of a particular type be cross-referenced
+      # within the document
+      def xrefs_mandate_validate(xmldoc)
+        xrefs_mandate_validate1(xmldoc, "//annex", "Annex")
+        xrefs_mandate_validate1(xmldoc, "//table", "Table")
+        xrefs_mandate_validate1(xmldoc, "//figure", "Figure")
+        xrefs_mandate_validate1(xmldoc, "//formula", "Formula")
+      end
+
+      def xrefs_mandate_validate1(xmldoc, xpath, name)
+        exc = %w(table note example figure).map { |x| "//#{x}#{xpath}" }
+          .join(" | ")
+        (xmldoc.xpath(xpath) - xmldoc.xpath(exc)).each do |x|
+          x["unnumbered"] == "true" and next
+          @doc_xrefs[x["anchor"]] or
+            @log.add("Style", x, "#{name} #{x['anchor']} has not been " \
+                                 "cross-referenced within document",
+                     severity: xpath == "//formula" ? 2 : 1)
+        end
+      end
+
+      def iso_xref_validate(doc)
+        see_xrefs_validate(doc)
+        term_xrefs_validate(doc)
+        xrefs_mandate_validate(doc)
+        see_erefs_validate(doc)
+        locality_erefs_validate(doc)
+      end
+    end
+  end
+end

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Iso
-    VERSION = "3.1.3".freeze
+    VERSION = "3.1.5".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -376,12 +376,13 @@ files:
 - lib/metanorma/iso/reqt.rng
 - lib/metanorma/iso/section.rb
 - lib/metanorma/iso/validate.rb
-- lib/metanorma/iso/validate_image.rb
 - lib/metanorma/iso/validate_list.rb
+- lib/metanorma/iso/validate_numeric.rb
 - lib/metanorma/iso/validate_requirements.rb
 - lib/metanorma/iso/validate_section.rb
 - lib/metanorma/iso/validate_style.rb
 - lib/metanorma/iso/validate_title.rb
+- lib/metanorma/iso/validate_xref.rb
 - lib/metanorma/iso/version.rb
 - lib/metanorma/requirements/modspec.rb
 - lib/metanorma/requirements/requirements.rb

data/lib/metanorma/iso/validate_image.rb

@@ -1,97 +0,0 @@
-module Metanorma
-  module Iso
-    class Converter < Standoc::Converter
-      # DRG directives 3.7; but anticipated by standoc
-      def subfigure_validate(xmldoc)
-        elems = { footnote: "fn", note: "note", key: "dl" }
-        xmldoc.xpath("//figure//figure").each do |f|
-          elems.each do |k, v|
-            f.xpath(".//#{v}").each do |n|
-              @log.add("Style", n, "#{k} is not permitted in a subfigure")
-            end
-          end
-        end
-      end
-
-      def image_name_prefix(xmldoc)
-        std = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") or
-          return
-        num = xmldoc.at("//bibdata/docnumber")&.text or return
-        ed = xmldoc.at("//bibdata/edition")&.text || "1"
-        prefix = num
-        std["part"] and prefix += "-#{std['part']}"
-        prefix += "_ed#{ed}"
-        amd = std["amendment"] and prefix += "amd#{amd}"
-        prefix
-      end
-
-      def image_name_suffix(xmldoc)
-        case xmldoc.at("//bibdata/language")&.text
-        when "fr" then "_f"
-        when "de" then "_d"
-        when "ru" then "_r"
-        when "es" then "_s"
-        when "ar" then "_a"
-        # when "en" then "_e"
-        else
-          "_e"
-        end
-      end
-
-      def disjunct_error(img, cond1, cond2, msg1, msg2)
-        cond1 && !cond2 and
-          @log.add("Style", img, "image name #{img['src']} #{msg1}")
-        !cond1 && cond2 and
-          @log.add("Style", img, "image name #{img['src']} #{msg2}")
-      end
-
-      def image_name_parse(img, prefix)
-        m = %r[(SL)?#{prefix}fig(?<tab>Tab)?(?<annex>[A-Z])?(Text)?(?<num>\d+)
-            (?<subfig>[a-z])?(?<key>_key\d+)?(?<lang>_[a-z])?$]x
-          .match(File.basename(img["src"], ".*"))
-        m.nil? and
-          @log.add("Style", img,
-                   "image name #{img['src']} does not match DRG requirements")
-        m
-      end
-
-      def image_name_validate1(i, prefix)
-        m = image_name_parse(i, prefix) or return
-        warn i["src"]
-        disjunct_error(i, i.at("./ancestor::table"), !m[:tab].nil?,
-                       "is under a table but is not so labelled",
-                       "is labelled as under a table but is not")
-        disjunct_error(i, i.at("./ancestor::annex"), !m[:annex].nil?,
-                       "is under an annex but is not so labelled",
-                       "is labelled as under an annex but is not")
-        disjunct_error(i, i.xpath("./ancestor::figure").size > 1, !m[:subfig].nil?,
-                       "does not have a subfigure letter but is a subfigure",
-                       "has a subfigure letter but is not a subfigure")
-        lang = image_name_suffix(i.document.root)
-        (m[:lang] || "_e") == lang or
-          @log.add("Style", i,
-                   "image name #{i['src']} expected to have suffix #{lang}")
-      end
-
-      # DRG directives 3.2
-      def image_name_validate(xmldoc)
-        prefix = image_name_prefix(xmldoc) or return
-        xmldoc.xpath("//image").each do |i|
-          i["src"].start_with?("data:") and next
-          case File.basename(i["src"])
-          when /^ISO_\d+_/
-          when /^(SL)?#{prefix}fig/ then image_name_validate1(i, prefix)
-          else
-            @log.add("Style", i,
-                     "image name #{i['src']} does not match DRG requirements: expect #{prefix}fig")
-          end
-        end
-      end
-
-      def figure_validate(xmldoc)
-        image_name_validate(xmldoc)
-        subfigure_validate(xmldoc)
-      end
-    end
-  end
-end