metanorma-standoc 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3748002995cc12380c79d05bfb5d21f87359c56bf179fb901aa8f80e3739e809
-  data.tar.gz: ea4ce688c6534bf7deb120601341382564026fa145982603fcd0ae31d64c1c3f
+  metadata.gz: da7d2f716300883df02cd6bcb01d5cfbb36390d6dfa355be0a41e55c9eeb10aa
+  data.tar.gz: 341e8403521c9bf5709593425e29317dd80c73f2c078afa2df481b9656c5b7d2
 SHA512:
-  metadata.gz: 1616db5be543da655641feef272f4c56ba139a5fe9098ffe5f7d3ecf5fbe30526af0c6a715cf9f96ce06e9690f42c016b017b5011027e5955069e1172dd90c4e
-  data.tar.gz: c2c4f6e0113dcf0b42e2236ff29e095060f48cc9871144660dc63009112038b3a46f45a56220a126d3ba709ef63468f73a7ff6a34e64d2f708afccf9adc19b2f
+  metadata.gz: cfbbce08097ed466ff9e0253f1c07769acd6384fca6688394495e488a14cf20ca239e668c03c106e969cf60afbccd88f0e197052dad9a5a32962f5b816e558cc
+  data.tar.gz: 889e1eabbe45186cd1814c99fe0b6f97317beedcb26c676c4a637ec3242b25d3b9f4e353238cbf1bd2bde8a3d18416e6774a674051c210465f36e34b729cfa81

data/Gemfile.devel

@@ -0,0 +1 @@
+gem "html2doc", git: "https://github.com/metanorma/html2doc", branch: "main"

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -118,9 +118,21 @@ module Metanorma
         fnote.children = "[ERROR]"
       end
 
+      def process_hidden_footnotes(xmldoc)
+        xmldoc.xpath("//fn").each do |fn|
+          first_text = fn.xpath(".//text()")
+            .find { |node| !node.text.strip.empty? } or return
+          if first_text.text.strip.start_with?("hiddenref%")
+            first_text.content = first_text.text.sub(/^hiddenref%/, "")
+            fn["hiddenref"] = true
+          end
+        end
+      end
+
       def footnote_cleanup(xmldoc)
         footnote_block_cleanup(xmldoc)
         title_footnote_move(xmldoc)
+        process_hidden_footnotes(xmldoc)
         table_footnote_renumber(xmldoc)
         other_footnote_renumber(xmldoc)
         xmldoc.xpath("//fn").each do |fn|

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -1,4 +1,3 @@
-require "asciimath2unitsml"
 require_relative "cleanup_mathvariant"
 
 module Metanorma
@@ -39,9 +38,12 @@ module Metanorma
             <math xmlns='#{MATHML_NS}'><mstyle displaystyle='false'><mn>#{expr}</mn></mstyle></math>
           MATH
         else
+          unitsml = if expr.include?("unitsml")
+                      { unitsml: { xml: true,
+                                   multiplier: :space } }
+                    else {} end
           Plurimath::Math.parse(expr, "asciimath")
-            .to_mathml(display_style: elem["block"],
-                       unitsml_xml: expr.include?("unitsml"))
+            .to_mathml(**{ display_style: elem["block"] }.merge(unitsml))
         end
       end
 
@@ -115,7 +117,7 @@ module Metanorma
       def gather_unitsml(unitsml, xmldoc, tag)
         tags = xmldoc.xpath(".//m:#{tag}", "m" => UNITSML_NS)
           .each_with_object({}) do |x, m|
-          m[x["xml:id"]] = x.remove
+          m[x["id"]] = x.remove
         end
         tags.empty? and return
         set = unitsml.add_child("<#{tag}Set/>").first
@@ -180,11 +182,9 @@ module Metanorma
       end
 
       def mathml_cleanup(xmldoc)
-        a2u = Asciimath2UnitsML::Conv.new(asciimath2unitsml_options)
         xmldoc.xpath("//stem[@type = 'MathML'][not(@validate = 'false')]")
           .each do |x|
           mathml_xml_cleanup(x)
-          a2u.MathML2UnitsML(x)
           mathml_mathvariant(x)
         end
         xmldoc.xpath("//stem[@type = 'MathML']")

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -144,12 +144,8 @@ module Metanorma
         sym and m[sym] += 1
       end
 
-      SECTION_CONTAINERS = %w(foreword introduction acknowledgements abstract
-                              clause clause references terms definitions annex
-                              appendix).freeze
-
       def sections_variant_title_cleanup(xml)
-        path = SECTION_CONTAINERS.map { |x| "./ancestor::#{x}" }.join(" | ")
+        path = section_containers.map { |x| "./ancestor::#{x}" }.join(" | ")
         xml.xpath("//p[@variant_title]").each do |p|
           p.name = "variant-title"
           p.delete("id")

data/lib/metanorma/standoc/inline.rb

@@ -1,4 +1,3 @@
-require "unicode2latex"
 require "mime/types"
 require "base64"
 require "English"
@@ -27,7 +26,8 @@ module Metanorma
       end
 
       def latex_parse1(text, block)
-        lxm_input = Unicode2LaTeX.unicode2latex(@c.decode(text))
+        #lxm_input = Unicode2LaTeX.unicode2latex(@c.decode(text))
+        lxm_input = @c.decode(text)
         results = Plurimath::Math.parse(lxm_input, "latex")
           .to_mathml(display_style: block)
         if results.nil?

data/lib/metanorma/standoc/isodoc.rng

@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <optional>
+        <attribute name="hiddenref">
+          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -34,24 +34,27 @@ module Metanorma
       # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
       # This is why we need to copy and then unlink.
       def self.generate_file(parent, reader)
-        localdir = Metanorma::Utils::localdir(parent.document)
+        ldir = localdir(parent)
         imagesdir = parent.document.attr("imagesdir")
-        umlfile, outfile = save_plantuml parent, reader, localdir
+        umlfile, outfile = save_plantuml parent, reader, ldir
         run(umlfile, outfile) or
           raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
-
-        path = path_prep(localdir, imagesdir)
+        path = path_prep(ldir, imagesdir)
         filename = File.basename(outfile.to_s)
         FileUtils.cp(outfile, path) and outfile.unlink
-
         imagesdir ? filename : File.join(path, filename)
       end
 
+      def self.localdir(parent)
+        ret = Metanorma::Utils::localdir(parent.document)
+        File.writable?(ret) or
+          raise "Destination directory #{ret} not writable for PlantUML!"
+        ret
+      end
+
       def self.path_prep(localdir, imagesdir)
         path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        File.writable?(localdir) or
-          raise "Destination path #{path} not writable for PlantUML!"
         path.mkpath
         File.writable?(path) or
           raise "Destination path #{path} not writable for PlantUML!"

data/lib/metanorma/standoc/utils.rb

@@ -108,6 +108,15 @@ module Metanorma
           .gsub("'", "'")
       end
 
+      SECTION_CONTAINERS =
+        %w(foreword introduction acknowledgements abstract
+           clause references terms definitions annex appendix indexsect 
+           executivesummary).freeze
+
+      def section_containers
+        SECTION_CONTAINERS
+      end
+
       # wrapped in <sections>
       def adoc2xml(text, flavour)
         Nokogiri::XML(text).root and return text

data/lib/metanorma/standoc/validate.rb

@@ -21,13 +21,14 @@ module Metanorma
         concept_validate(doc, "concept", "refterm")
         concept_validate(doc, "related", "preferred//name")
         preferred_validate(doc)
+        termsect_validate(doc)
         table_validate(doc)
         requirement_validate(doc)
         image_validate(doc)
         math_validate(doc)
         fatalerrors = @log.abort_messages
         fatalerrors.empty? or
-          clean_abort(fatalerrors.join("\n"), doc)
+          clean_abort("\n\nFATAL ERRROS:\n\n#{fatalerrors.join("\n\n")}", doc)
       end
 
       MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze

data/lib/metanorma/standoc/validate_term.rb

@@ -1,3 +1,5 @@
+require "iev"
+
 module Metanorma
   module Standoc
     module Validate
@@ -7,7 +9,7 @@ module Metanorma
       def init_iev
         @no_isobib and return nil
         @iev and return @iev
-        @iev = Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
+        @iev = ::Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
         @iev
       end
 
@@ -82,6 +84,36 @@ module Metanorma
           @log.add("Terms", v.first, err, severity: 1)
         end
       end
+
+      def find_illegal_designations(xmldoc)
+        xmldoc.xpath("//preferred | //admitted | //deprecates")
+          .each_with_object({}) do |d, m|
+          d.ancestors.detect { |x| x.name == "terms" } and next
+          c = d.ancestors.detect do |x|
+            section_containers.include?(x.name)
+          end
+          c["id"] ||= "_#{UUIDTools::UUID.random_create}"
+          m[c["id"]] ||= { clause: c, designations: [] }
+          m[c["id"]][:designations] << d
+        end
+      end
+
+      def termsect_validate(xmldoc)
+        errors = find_illegal_designations(xmldoc)
+        errors.each_value do |v|
+          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
+             (preferred:[], admitted:[], alt:[], deprecated:[]):<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)
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.0.2".freeze
+    VERSION = "3.0.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -40,12 +40,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "metanorma-utils", "~> 1.10.0"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
-  spec.add_dependency "asciimath2unitsml", "~> 0.4.0"
   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 "unicode2latex", "~> 0.0.1"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
@@ -53,7 +51,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 1.5.2"
+  spec.add_development_dependency "rubocop", "~> 1"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -164,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: asciimath2unitsml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -234,20 +220,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: unicode2latex
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -338,14 +310,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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: sassc-embedded
   requirement: !ruby/object:Gem::Requirement
@@ -448,6 +434,7 @@ files:
 - ".tex"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.devel
 - LICENSE
 - Makefile
 - README.adoc