metanorma-standoc 3.1.10 → 3.2.1

data/lib/metanorma/standoc/validate.rb

@@ -57,8 +57,7 @@ module Metanorma
         orig = ""
         a and orig += "\n\tAsciimath original: #{@c.decode(a.children.to_xml)}"
         l and orig += "\n\tLatexmath original: #{@c.decode(l.children.to_xml)}"
-        @log.add("Maths", elem,
-                 "Invalid MathML: #{math}\n #{error}#{orig}", severity: 0)
+        @log.add("STANDOC_33", elem, params: [math, error, orig])
       end
 
       def nested_asset_validate(doc)
@@ -85,20 +84,17 @@ module Metanorma
 
       def nested_asset_report(outer, inner, doc)
         outer.name == "figure" && inner.name == "figure" and return
-        err =
-          "There is an instance of #{inner.name} nested within #{outer.name}"
-        @log.add("Style", inner, err)
+        @log.add("STANDOC_34", inner, params: [inner.name, outer.name])
         nested_asset_xref_report(outer, inner, doc)
       end
 
       def nested_asset_xref_report(outer, inner, _doc)
         i = @doc_xrefs[inner["anchor"]] or return
-        err2 = "There is a crossreference to an instance of #{inner.name} " \
-               "nested within #{outer.name}: #{i.to_xml}"
-        @log.add("Style", i, err2)
+        @log.add("STANDOC_35", i, params: [inner.name, outer.name, i.to_xml])
       end
 
       def validate(doc)
+        @log.add_error_ranges(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup), schema_location)
       end
@@ -107,9 +103,7 @@ module Metanorma
       # since consequences are so catastrophic
       def repeat_id_validate1(elem)
         if @doc_ids[elem["id"]]
-          @log.add("Anchors", elem,
-                   "ID #{elem['id']} has already been " \
-                   "used at line #{@doc_ids[elem['id']][:line]}", severity: 0)
+          @log.add("STANDOC_36", elem, params: [elem['id'], @doc_ids[elem['id']][:line]])
         else
           @doc_ids[elem["id"]] =
             { line: elem.line, anchor: elem["anchor"] }.compact
@@ -118,9 +112,7 @@ module Metanorma
 
       def repeat_anchor_validate1(elem)
         if @doc_anchors[elem["anchor"]]
-          @log.add("Anchors", elem,
-                   "Anchor #{elem['anchor']} has already been used at line " \
-                   "#{@doc_anchors[elem['anchor']][:line]}", severity: 0)
+          @log.add("STANDOC_36", elem, params: [elem['anchor'], @doc_anchors[elem['anchor']][:line]])
         else
           @doc_anchors[elem["anchor"]] = { line: elem.line, id: elem["id"] }
           @doc_anchor_seq << elem["anchor"]
@@ -174,8 +166,7 @@ module Metanorma
           doc.xpath("//#{a[0]}/@#{a[1]}").each do |x|
             @doc_xrefs[x.text] = x.parent
             @doc_anchors[x.text] and next
-            @log.add("Anchors", x.parent,
-                     "Crossreference target #{x} is undefined", severity: 1)
+            @log.add("STANDOC_38", x.parent, params: [x.text])
           end
         end
       end
@@ -217,11 +208,12 @@ module Metanorma
         doc.xpath(tag).each do |t|
           body and t = t.at("./#{body}")
           empty_block?(t) or next
-          @log.add("Blocks", t, "#{tag.sub(/^\/\//, '')} is empty", severity: 1)
+          @log.add("STANDOC_39", t, params: [tag.sub(/^\/\//, '')])
         end
       end
 
       def empty_block?(block)
+        block.nil? and return
         content = block.children.reject { |n| n.name == "name" }
         content.map do |n|
           %w(image xref eref).include?(n.name) ? n.name : n

data/lib/metanorma/standoc/validate_image.rb

@@ -1,4 +1,5 @@
 require "pngcheck"
+require "svg_conform"
 
 module Metanorma
   module Standoc
@@ -7,6 +8,7 @@ module Metanorma
         image_exists(doc)
         image_toobig(doc)
         png_validate(doc)
+        svg_validate(doc)
       end
 
       def image_exists(doc)
@@ -14,8 +16,7 @@ module Metanorma
           Vectory::Utils::url?(i["src"]) and next
           Vectory::Utils::datauri?(i["src"]) and next
           expand_path(i["src"]) and next
-          @log.add("Images", i.parent,
-                   "Image not found: #{i['src']}", severity: 0)
+          @log.add("STANDOC_44", i.parent, params: [i["src"]])
         end
       end
 
@@ -42,19 +43,61 @@ module Metanorma
       def png_validate1(img, buffer)
         PngCheck.check_buffer(buffer)
       rescue PngCheck::CorruptPngError => e
-        @log.add("Images", img.parent,
-                 "Corrupt PNG image detected: #{e.message}")
+        @log.add("STANDOC_45", img.parent, params: [e.message])
       end
 
-      TOO_BIG_IMG_ERR = <<~ERR.freeze
-        Image too large for Data URI encoding: disable Data URI encoding (`:data-uri-image: false`), or set `:data-uri-maxsize: 0`
-      ERR
-
       def image_toobig(doc)
         @dataurimaxsize.zero? and return
         doc.xpath("//image").each do |i|
           i["src"].size > @dataurimaxsize and
-            @log.add("Images", i.parent, TOO_BIG_IMG_ERR, severity: 0)
+            @log.add("STANDOC_46", i.parent)
+        end
+      end
+
+      def svg_validate(doc)
+        profile = SvgConform::Profiles.get(@svg_conform_profile)
+        remediatable = profile.remediation_count.positive?
+        engine = SvgConform::RemediationEngine.new(profile)
+        doc.xpath("//m:svg", "m" => SVG_NS).each do |s|
+          d, result = svg_validate1(profile, s)
+          remediatable && !result.valid? and
+            svg_validate_fix(profile, engine, d, s, result)
+        end
+      end
+
+      def svg_validate1(profile, svg)
+        d = SvgConform::Document.from_content(svg.to_xml)
+        r = profile.validate(d)
+        svg_error("STANDOC_55", svg, r.errors)
+        svg_error("STANDOC_57", svg, r.warnings)
+        [d, r]
+      end
+
+      def svg_validate_fix(profile, engine, doc, svg, result)
+        remeds = engine.apply_remediations(doc, result)
+        svg_remed_log(remeds, svg)
+        result = profile.validate(doc)
+        svg_error("STANDOC_56", svg, result.errors) # we still have errors
+        svg.replace(doc.to_xml)
+      end
+
+      def svg_remed_log(remeds, svg)
+        remeds.each do |e|
+          e.changes_made.each do |c|
+            @log.add("STANDOC_58", svg,
+                     params: [e.remediation_id, e.message,
+                              c[:type], c[:message], c[:node]])
+          end
+        end
+      end
+
+      def svg_error(id, svg, errors)
+        errors.each do |err|
+          err.respond_to?(:element) && err.element and
+            elem = " Element: #{err.element}"
+          err.respond_to?(:location) && err.location and
+            loc = " Location: #{err.location}"
+          @log.add(id, svg, params: [err.rule&.id, err.message, elem, loc])
         end
       end
     end

data/lib/metanorma/standoc/validate_schema.rb

@@ -30,8 +30,9 @@ module Metanorma
         errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
         warn "Syntax Valid!" if errors.none?
         errors.each do |e|
-          @log.add("Metanorma XML Syntax",
-                   "XML Line #{'%06d' % e[:line]}:#{e[:column]}", e[:message])
+          @log.add("STANDOC_7",
+                   "XML Line #{'%06d' % e[:line]}:#{e[:column]}",
+                   params: [e[:message]])
         end
       end
 

data/lib/metanorma/standoc/validate_section.rb

@@ -19,16 +19,14 @@ module Metanorma
 
       def callouts_error(elem, callouts, annotations)
         if callouts.size != annotations.size && !annotations.empty?
-          err = "mismatch of callouts (#{callouts.size}) and annotations " \
-                "(#{annotations.size})"
-          @log.add("Crossreferences", elem, err, severity: 0)
+          @log.add("STANDOC_47", elem, params: [callouts.size, annotations.size])
         end
       end
 
       def style_warning(node, msg, text = nil)
         w = msg
         w += ": #{text}" if text
-        @log.add("Style", node, w)
+        @log.add("STANDOC_48", node, params: [w])
       end
 
       def reject_metanorma_extension
@@ -69,8 +67,7 @@ module Metanorma
         doc.xpath("//references[@normative = 'true']/bibitem").each do |b|
           docid = b.at("./docidentifier[@type = 'metanorma']") or next
           /^\[\d+\]$/.match?(docid.text) or next
-          @log.add("Bibliography", b,
-                   "Numeric reference in normative references", severity: 1)
+          @log.add("STANDOC_49", b)
         end
       end
     end

data/lib/metanorma/standoc/validate_table.rb

@@ -17,7 +17,7 @@ module Metanorma
       def empty_table_validate(doc)
         doc.xpath("//table[not(.//tr)]").reject(&reject_metanorma_extension)
           .each do |t|
-          @log.add("Table", t, "Empty table", severity: 0)
+          @log.add("STANDOC_2", t)
         end
       end
 
@@ -79,17 +79,15 @@ module Metanorma
       def maxrows_validate(table, cells2d, tablechild, mode)
         err = "are inconsistent"
         mode == "thead_row" and err = "cannot go outside #{tablechild}"
-        err = "Table rows in table #{err}: check rowspan"
         if cells2d.any? { |x| x.size != cells2d.first.size }
-          @log.add("Table", table, err, severity: 0)
+          @log.add("STANDOC_4", table, params: [err])
         end
       end
 
       # if maxcols or maxrows negative, do not check them
       def maxcols_check(col, maxcols, tcell)
         if maxcols.positive? && col > maxcols
-          @log.add("Table", tcell, "Table exceeds maximum number of columns "\
-                                   "defined (#{maxcols})", severity: 0)
+          @log.add("STANDOC_5", tcell, params: [maxcols])
         end
       end
     end

data/lib/metanorma/standoc/validate_term.rb

@@ -31,16 +31,14 @@ module Metanorma
           m << x.text&.downcase
         end
         pref.include?(iev.downcase) or
-          @log.add("Bibliography", term, %(Term "#{pref[0]}" does not match ) +
-                   %(IEV #{loc} "#{iev}"), severity: 1)
+          @log.add("STANDOC_22", term, params: [pref[0], loc, iev])
       end
 
       def concept_validate(doc, tag, refterm)
         concept_validate_ids(doc)
         doc.xpath("//#{tag}/xref").each do |x|
           @concept_ids[x["target"]] and next
-          @log.add("Anchors", x, concept_validate_msg(doc, tag, refterm, x),
-                   severity: 0)
+          @log.add("STANDOC_23", x, params: [concept_validate_msg(doc, tag, refterm, x)])
         end
       end
 
@@ -81,8 +79,7 @@ module Metanorma
         terms.each do |k, v|
           v.size > 1 or next
           loc = v.map { |x| x["anchor"] }.join(", ")
-          err = "Term #{k} occurs twice as preferred designation: #{loc}"
-          @log.add("Terms", v.first, err, severity: 1)
+          @log.add("STANDOC_24", v.first, params: [k, loc])
         end
       end
 
@@ -105,14 +102,7 @@ module Metanorma
           desgns = v[:designations].map do |x|
             @c.encode(x.text.strip,  :basic, :hexadecimal)
           end.join(", ")
-          err = <<~ERROR
-            Clause not recognised as a term clause, but contains designation markup
-             (<code>preferred:[], admitted:[], alt:[], deprecated:[]</code>):<br/>
-            #{desgns}</br>
-            Ensure the parent clause is recognised as a terms clause by inserting <code>[heading=terms and definitions]</code> above the title,
-            in case the heading is not automatically recognised. See also <a href="https://www.metanorma.org/author/topics/sections/concepts/#clause-title">Metanorma documentation</a>.
-          ERROR
-          @log.add("Terms", v[:clause], err, severity: 0)
+          @log.add("STANDOC_25", v[:clause], params: [desgns])
         end
       end
     end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.1.10".freeze
+    VERSION = "3.2.1".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -32,23 +32,26 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "crass", "~> 1.0.0"
   spec.add_dependency "iev", "~> 0.3.5"
-  spec.add_dependency "isodoc", "~> 3.3.0"
+  spec.add_dependency "isodoc", "~> 3.4.0"
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.3"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.7.31"
   spec.add_dependency "metanorma-plugin-plantuml", "~> 1.0.0"
-  spec.add_dependency "metanorma-utils", "~> 1.11.0"
+  spec.add_dependency "metanorma-utils", "~> 2.0.1"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.20.0"
   spec.add_dependency "relaton-iev", "~> 1.2.0"
+  spec.add_dependency "svg_conform", "~> 0.1.0"
 
+  spec.add_development_dependency "canon", "= 0.1.3"
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "openssl"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1"
@@ -58,6 +61,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "canon"
   # spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.1.10
+  version: 3.2.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: svg_conform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: canon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +304,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -402,20 +444,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: canon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |
   metanorma-standoc realises standards following the Metanorma standoc model
 
@@ -538,6 +566,7 @@ files:
 - lib/metanorma/standoc/isolated_converter.rb
 - lib/metanorma/standoc/lists.rb
 - lib/metanorma/standoc/localbib.rb
+- lib/metanorma/standoc/log.rb
 - lib/metanorma/standoc/macros.rb
 - lib/metanorma/standoc/macros_embed.rb
 - lib/metanorma/standoc/macros_form.rb