metanorma-standoc 3.2.0 → 3.2.2

data/lib/metanorma/standoc/front_organisation.rb

@@ -3,11 +3,11 @@ module Metanorma
     module Front
       def organization(org, orgname, node = nil, default_org = nil, attrs = {})
         orgname, abbr = org_name_and_abbrev(attrs, orgname)
-        org.name orgname
+        add_noko_elem(org, "name", orgname)
         default_org && (a = node&.attr("subdivision")) && !attrs[:subdiv] and
           subdivision(a, node&.attr("subdivision-abbr"), org)
         a = attrs[:subdiv] and subdivision(a, nil, org)
-        abbr and org.abbreviation abbr
+        add_noko_elem(org, "abbreviation", abbr)
       end
 
       def org_name_and_abbrev(org, orgname)
@@ -45,32 +45,30 @@ module Metanorma
       def subdiv_build(list, org)
         list.empty? and return
         org.subdivision **attr_code(type: list[0][:type]) do |s|
-          s.name { |n| n << list[0][:value] }
+          add_noko_elem(s, "name", list[0][:value])
           subdiv_build(list[1..], s)
-          a = list[0][:abbr] and s.abbreviation { |n| n << a }
+          add_noko_elem(s, "abbreviation", list[0][:abbr])
         end
       end
 
       def org_address(org, xml)
         p = org[:address] and xml.address do |ad|
-          ad.formattedAddress do |f|
-            f << p.gsub(/ \+\n/, "<br/>")
-          end
+          add_noko_elem(ad, "formattedAddress", p.gsub(/ \+\n/, "<br/>"))
         end
         org_contact(org, xml)
       end
 
       def org_contact(org, xml)
-        p = org[:phone] and xml.phone p
-        p = org[:fax] and xml.phone p, type: "fax"
-        p = org[:email] and xml.email p
-        p = org[:uri] and xml.uri p
+        add_noko_elem(xml, "phone", org[:phone])
+        add_noko_elem(xml, "phone", org[:fax], type: "fax")
+        add_noko_elem(xml, "email", org[:email])
+        add_noko_elem(xml, "uri", org[:uri])
       end
 
       def person_organization(node, suffix, xml)
-        xml.name node.attr("affiliation#{suffix}")
-        abbr = node.attr("affiliation_abbrev#{suffix}") and
-          xml.abbreviation abbr
+        add_noko_elem(xml, "name", node.attr("affiliation#{suffix}"))
+        add_noko_elem(xml, "abbreviation",
+                      node.attr("affiliation_abbrev#{suffix}"))
         a = node.attr("affiliation_subdiv#{suffix}") and
           subdivision(a, nil, xml)
         person_address(node, suffix, xml)
@@ -80,9 +78,8 @@ module Metanorma
       def person_address(node, suffix, xml)
         if node.attr("address#{suffix}")
           xml.address do |ad|
-            ad.formattedAddress do |f|
-              f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
-            end
+            add_noko_elem(ad, "formattedAddress",
+                          node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>"))
           end
         elsif node.attr("country#{suffix}") || node.attr("city#{suffix}")
           person_address_components(node, suffix, xml)
@@ -92,7 +89,7 @@ module Metanorma
       def person_address_components(node, suffix, xml)
         xml.address do |ad|
           %w(street city state country postcode).each do |k|
-            s = node.attr("#{k}#{suffix}") and ad.send k, s
+            add_noko_elem(ad, k, node.attr("#{k}#{suffix}"))
           end
         end
       end
@@ -128,9 +125,7 @@ module Metanorma
 
       def org_contributor_role(xml, org)
         xml.role type: org[:role] do |r|
-          org[:desc] and r.description do |d|
-            d << org[:desc]
-          end
+          add_noko_elem(r, "description", org[:desc])
         end
       end
 

data/lib/metanorma/standoc/init.rb

@@ -1,5 +1,6 @@
 require_relative "utils"
 require_relative "regex"
+require "json"
 
 module Metanorma
   module Standoc
@@ -41,6 +42,7 @@ module Metanorma
         @embed_id = node.attr("embed_id")
         @document_scheme = document_scheme(node)
         @source_linenums = node.attr("source-linenums-option") == "true"
+        # feeds log
         @semantic_headless = node.attr("semantic-metadata-headless") == "true"
         @default_doctype = "standard"
       end
@@ -53,22 +55,46 @@ module Metanorma
         @smartquotes = node.attr("smartquotes") != "false"
         @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
         @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
-        @blockunnumbered = (node.attr("block-unnumbered") || "").split(",")
-          .map(&:strip)
+        @blockunnumbered = csv_split(node.attr("block-unnumbered"), ",")
       end
 
       def init_log(node)
         @log or return
+        @semantic_headless and return
         severity = node.attr("log-filter-severity")&.to_i || 4
-        category = node.attr("log-filter-category") || ""
-        category = category.split(",").map(&:strip)
-        @log.suppress_log = { severity:, category: }
+        category = csv_split(node.attr("log-filter-category"), ",")
+        error_ids = csv_split(node.attr("log-filter-error-ids"), ",")
+        locations = cleanup_log_filter_error_log(
+          extract_log_filter_error_loc(node),
+        )
+        @log.suppress_log = { severity:, category:, error_ids:, locations: }
+      end
+
+      def extract_log_filter_error_loc(node)
+        locations = JSON.parse(node.attr("log-filter-error-loc") || "[]")
+        locations = [locations] unless locations.is_a?(Array)
+        locations.map { |loc| loc.transform_keys(&:to_sym) }
+      end
+
+      def cleanup_log_filter_error_log(locations)
+        locations.each do |loc|
+          loc[:to] ||= loc[:from]
+          loc[:error_ids] ||= []
+          loc[:error_ids] &&= Array(loc[:error_ids])
+        end
       end
 
       def init_image(node)
         @datauriimage = node.attr("data-uri-image") != "false"
         @datauriattachment = node.attr("data-uri-attachment") != "false"
         @dataurimaxsize = node.attr("data-uri-maxsize")&.to_i || 13981013
+        @svg_conform_profile =
+          node.attr("svg-conform-profile")&.sub(/^:/, "") ||
+          default_svg_conform_profile
+      end
+
+      def default_svg_conform_profile
+        :metanorma
       end
 
       def init_reqt(node)

data/lib/metanorma/standoc/inline.rb

@@ -49,7 +49,8 @@ module Metanorma
           end
         elsif style == :latexmath then latex_parse(text, xml, attrs)
         else
-          xml.stem text&.gsub("&#", "&#"), **attrs.merge(type: "AsciiMath")
+          xml.stem text&.gsub("&#", "&#") || "",
+                   **attrs.merge(type: "AsciiMath")
         end
       end
 
@@ -79,9 +80,7 @@ module Metanorma
       end
 
       def highlight_parse(text, xml)
-        xml.span **{ class: "fmt-hi" } do |s|
-          s << text
-        end
+        add_noko_elem(xml, "span", text, class: "fmt-hi")
       end
 
       def inline_quoted(node)
@@ -179,16 +178,38 @@ module Metanorma
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
-          inline_indexterm1(xml, terms)
+          terms, see, also = inline_indexterm_extract(node)
+          (see || also) or inline_indexterm1(xml, terms)
+          also and
+            inline_indexterm_see(xml, terms, also, true)
+          see and
+            inline_indexterm_see(xml, terms, [see], false)
         end
       end
 
+      def inline_indexterm_extract(node)
+        terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+        see = node.attr("see")
+        also = node.attr("see-also")
+        [terms, see, also]
+      end
+
       def inline_indexterm1(xml, terms)
         xml.index do |i|
-          i.primary { |x| x << terms[0] }
-          a = terms[1] and i.secondary { |x| x << a }
-          a = terms[2] and i.tertiary { |x| x << a }
+          add_noko_elem(i, "primary", terms[0])
+          add_noko_elem(i, "secondary", terms[1])
+          add_noko_elem(i, "tertiary", terms[2])
+        end
+      end
+
+      def inline_indexterm_see(xml, terms, ref, also)
+        ref.each do |r|
+          xml.index_xref also: also do |i|
+            add_noko_elem(i, "primary", terms[0])
+            add_noko_elem(i, "secondary", terms[1])
+            add_noko_elem(i, "tertiary", terms[2])
+            add_noko_elem(i, "target", r)
+          end
         end
       end
     end

data/lib/metanorma/standoc/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.1.3 -->
+<!-- VERSION v2.1.4 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -905,15 +905,32 @@ titlecase, or lowercase</a:documentation>
     </element>
   </define>
   <define name="image" combine="choice">
-    <element name="svg">
-      <a:documentation>Add svg mark up to image</a:documentation>
-      <oneOrMore>
-        <choice>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
-    </element>
+    <choice>
+      <element name="image">
+        <ref name="RequiredId"/>
+        <ref name="ImageAttributes"/>
+        <optional>
+          <element name="svg">
+            <a:documentation>Allow svg in image/svg, for consistency</a:documentation>
+            <oneOrMore>
+              <choice>
+                <text/>
+                <ref name="AnyElement"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+      <element name="svg">
+        <a:documentation>Add svg mark up to image</a:documentation>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="AnyElement"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </choice>
   </define>
   <define name="ParagraphFnBody" combine="interleave">
     <ref name="BlockSource">

data/lib/metanorma/standoc/lists.rb

@@ -7,7 +7,7 @@ module Metanorma
             xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
             xml_li << item.content
           else
-            xml_li.p(**attr_code(id_attr(item))) { |p| p << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
           end
         end
       end

data/lib/metanorma/standoc/log.rb

@@ -168,6 +168,18 @@ module Metanorma
         "STANDOC_54": { category: "Bibliography",
                         error: "Cannot process file %s for local Relaton data source %s",
                         severity: 0 },
+        "STANDOC_55": { category: "Images",
+                        error: "Corrupt SVG image detected, error found: %s %s%s%s",
+                        severity: 2 },
+        "STANDOC_56": { category: "Images",
+                        error: "Corrupt SVG image detected, could not be fixed: %s %s%s%s",
+                        severity: 1 },
+        "STANDOC_57": { category: "Images",
+                        error: "SVG image warning: %s %s%s%s",
+                        severity: 3 },
+        "STANDOC_58": { category: "Images",
+                        error: "Corrupt SVG image detected, fix attempted: %s %s: %s %s, Node: %s",
+                        severity: 2 },
         "RELATON_1": { category: "Relaton",
                        error: "(Error from Relaton) %s",
                        severity: 0 },

data/lib/metanorma/standoc/macros_terms.rb

@@ -71,6 +71,7 @@ module Metanorma
       named :term
       name_positional_attributes "name", "termxref"
       using_format :short
+      match /\\?(?<!\w)term:(){0}\[(|[^\]\\]*(?:\\.[^\]\\]*)*)\]/
 
       def process(_parent, _target, attrs)
         termref = attrs["termxref"] || attrs["name"]
@@ -84,6 +85,7 @@ module Metanorma
       named :symbol
       name_positional_attributes "name", "termxref"
       using_format :short
+      match /\\?(?<!\w)symbol:(){0}\[(|[^\]\\]*(?:\\.[^\]\\]*)*)\]/
 
       def process(_parent, _target, attrs)
         termref = attrs["termxref"] || attrs["name"]

data/lib/metanorma/standoc/ref.rb

@@ -60,9 +60,8 @@ module Metanorma
 
       def ref_fn(match, xml)
         if match.names.include?("fn") && match[:fn]
-          xml.note(**plaintxt.merge(type: "Unpublished-Status")) do |p|
-            p << match[:fn].to_s
-          end
+          add_noko_elem(xml, "note", match[:fn].to_s,
+                        **plaintxt.merge(type: "Unpublished-Status"))
         end
       end
 
@@ -115,17 +114,19 @@ module Metanorma
         i = code[:id] and
           docid(bib, /^\d+$/.match?(i) ? "[#{i}]" : i, code[:type])
         code[:type] == "repo" and
-          bib.docidentifier code[:key], type: "repository"
+          add_noko_elem(bib, "docidentifier", code[:key], type: "repository")
       end
 
       def refitem_uri(code, bib)
         if code[:type] == "path"
-          bib.uri code[:key].sub(/\.[a-zA-Z0-9]+$/, ""), type: "URI"
-          bib.uri code[:key].sub(/\.[a-zA-Z0-9]+$/, ""), type: "citation"
+          add_noko_elem(bib, "uri", code[:key].sub(/\.[a-zA-Z0-9]+$/, ""),
+                        type: "URI")
+          add_noko_elem(bib, "uri", code[:key].sub(/\.[a-zA-Z0-9]+$/, ""),
+                        type: "citation")
         end
         if code[:type] == "attachment"
-          bib.uri code[:key], type: "attachment"
-          bib.uri code[:key], type: "citation"
+          add_noko_elem(bib, "uri", code[:key], type: "attachment")
+          add_noko_elem(bib, "uri", code[:key], type: "citation")
         end
       end
 
@@ -149,9 +150,8 @@ module Metanorma
 
       def refitem_render_formattedref(bibitem, title)
         (title.nil? || title.empty?) and title = @i18n.no_information_available
-        bibitem.formattedref format: "application/x-isodoc+xml" do |i|
-          i << ref_normalise_no_format(title)
-        end
+        add_noko_elem(bibitem, "formattedref", ref_normalise_no_format(title),
+                      format: "application/x-isodoc+xml")
       end
 
       # TODO: alternative where only title is available

data/lib/metanorma/standoc/ref_utility.rb

@@ -49,16 +49,12 @@ module Metanorma
                       else @bibdb&.docid_type(code) || [nil, code]
                       end
         code1.sub!(/^nofetch\((.+)\)$/, "\\1")
-        bib.docidentifier **attr_code(type:) do |d|
-          d << code1
-        end
+        add_noko_elem(bib, "docidentifier", code1, type: type)
       end
 
       def docnumber(bib, code)
         code or return
-        bib.docnumber do |d|
-          d << @c.decode(code).sub(/^[^\d]*/, "")
-        end
+        add_noko_elem(bib, "docnumber", @c.decode(code).sub(/^[^\d]*/, ""))
       end
 
       def mn_code(code)

data/lib/metanorma/standoc/section.rb

@@ -87,9 +87,7 @@ module Metanorma
 
       def section_title(xml, title)
         title.nil? and return
-        xml.title **attr_code(id_attr(nil)) do |t|
-          t << title
-        end
+        add_noko_elem(xml, "title", title, id_attr(nil))
       end
 
       def preamble(node)
@@ -102,9 +100,7 @@ module Metanorma
       end
 
       def metanorma_extension_parse(_attrs, xml, node)
-        xml.send :"metanorma-extension-clause" do |xml_section|
-          xml_section << node.content
-        end
+        add_noko_elem(xml, "metanorma-extension-clause", node.content)
       end
 
       def indexsect_parse(attrs, xml, node)
@@ -115,9 +111,7 @@ module Metanorma
       end
 
       def abstract_parse(attrs, xml, node)
-        xml.abstract **attr_code(attrs) do |xml_section|
-          xml_section << node.content
-        end
+        add_noko_elem(xml, "abstract", node.content, **attr_code(attrs))
       end
 
       def scope_parse(attrs, xml, node)

data/lib/metanorma/standoc/table.rb

@@ -57,7 +57,7 @@ module Metanorma
         cell_tag = "td"
         cell_tag = "th" if tblsec == :head || node.style == :header
         xml_tr.send cell_tag, **attr_code(cell_attributes) do |thd|
-          thd << table_cell1(node)
+          thd << table_cell1(node) # preserve empty cells
         end
       end
 

data/lib/metanorma/standoc/terms.rb

@@ -109,7 +109,7 @@ module Metanorma
       def term_designation(xml, _node, tag, text)
         xml.send tag do |p|
           p.expression do |e|
-            e.name { |name| name << text }
+            add_noko_elem(e, "name", text)
           end
         end
       end

data/lib/metanorma/standoc/utils.rb

@@ -5,6 +5,22 @@ require "json"
 require "pathname"
 require "uuidtools"
 
+module Nokogiri
+  module XML
+    class Builder
+      class NodeBuilder
+        def add_noko_elem(name, val, attrs = {})
+          val and !val.empty? or return
+          # require "debug"; binding.b
+          send name, **Metanorma::Utils::attr_code(attrs) do |n|
+            n << val
+          end
+        end
+      end
+    end
+  end
+end
+
 module Metanorma
   module Standoc
     module Utils
@@ -44,9 +60,10 @@ module Metanorma
       end
 
       def csv_split(text, delim = ";", encode: true)
+        text ||= ""
         ret = Metanorma::Utils::csv_split(@c.decode(text), delim)
         encode and
-          ret.map! { |x| @c.encode(x, :basic, :hexadecimal) }
+          ret.map! { |x| @c.encode(x.strip, :basic, :hexadecimal) }
         ret
       end
 
@@ -155,7 +172,8 @@ module Metanorma
 
           #{text}
         ADOC
-        c = isolated_asciidoctor_convert(doc, backend: flavour, header_footer: true)
+        c = isolated_asciidoctor_convert(doc, backend: flavour,
+                                              header_footer: true)
         ret = Nokogiri::XML(c).at("//xmlns:sections")
         separate_numbering_footnotes(ret)
       end
@@ -192,6 +210,13 @@ module Metanorma
         @refids.include? ref
       end
 
+      def add_noko_elem(node, name, val, attrs = {})
+        val and !val.empty? or return
+        node.send name, **attr_code(attrs) do |n|
+          n << val
+        end
+      end
+
       module_function :adoc2xml
 
       class EmptyAttr

data/lib/metanorma/standoc/validate.rb

@@ -94,6 +94,7 @@ module Metanorma
       end
 
       def validate(doc)
+        @log.add_error_ranges(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup), schema_location)
       end
@@ -212,6 +213,7 @@ module Metanorma
       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)
@@ -51,6 +53,53 @@ module Metanorma
             @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
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.2.0".freeze
+    VERSION = "3.2.2".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -37,18 +37,21 @@ Gem::Specification.new do |spec|
   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", "~> 2.0.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,7 +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 "openssl"
-  spec.add_development_dependency "canon", "= 0.1.3"
   # spec.metadata["rubygems_mfa_required"] = "true"
 end