metanorma-standoc 2.4.1 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a338b7e2acb906be1a2f9fb958fec1281991d934cae8f33279605d4c7296e7
-  data.tar.gz: 104dfd478b186a14b6a7acd276c28785ada074ce3f747839ee30a4620269b74e
+  metadata.gz: d0ade5d859084779fe2f7357438926e03e0359adbf528d4db67a1851200f7e45
+  data.tar.gz: d17ee40a8d465764b0d7577a0ab69db5d96ab1c4e5c923b77059326d2e52e45c
 SHA512:
-  metadata.gz: 94ef91339b3743becae21df403eeb7b9af5910257ba97756c72111ddababda0523d9e6b961aa6eab9737af6c460f4c3c89aecf0af3ecbacbb391aa9e10493af3
-  data.tar.gz: 0ef86c13ca5bea907b55aa9e9ce98b1447e9c887e388db737855f9d8f55f3db39d20cf34aa526e2c2f0ccf140792cfd6f396b4ba117a1d50f67f28a0dd027442
+  metadata.gz: 794db303464ba57e25b5ccb240b794524842fe99a42cf136f7f0ff3d0e77f82eb017676b3a0b9ef491b655ffe42b50d9332d880c4a10c9ca7a705252e62c5199
+  data.tar.gz: 6f9f27b816283a7cf27fc3b441cfd9d04a72c7a26da7d66264f3984e391e4ab3f3be384e167e1a813d8bfabcc070d98f162908a5f1a9dd5670dca3614e002873

data/Gemfile

@@ -10,3 +10,4 @@ if File.exist? 'Gemfile.devel'
   eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
 end
 
+

data/lib/metanorma/standoc/base.rb

@@ -168,9 +168,14 @@ module Metanorma
         Metanorma.versioned(Metanorma, flavour)[-1]::VERSION
       end
 
-      def clean_exit
-        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
+      def schema_version
+        f = File.read(File.join(File.dirname(__FILE__), "isodoc.rng"))
+        m = / VERSION (v\S+)/.match(f)
+        m[1]
+      end
 
+      def clean_exit
+        @novalid or @log.write("#{@output_dir}#{@filename}.err")
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
@@ -185,7 +190,8 @@ module Metanorma
 
       def makexml1(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>",
-                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
+                  "<#{xml_root_tag} type='semantic' version='#{version}' " \
+                  "schema-version='#{schema_version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -225,8 +231,7 @@ module Metanorma
       def metadata_attrs(node)
         node.attributes.each_with_object([]) do |(k, v), ret|
           %w(presentation semantic).each do |t|
-            next unless /^#{t}-metadata-/.match?(k)
-
+            /^#{t}-metadata-/.match?(k) or next
             k = k.sub(/^#{t}-metadata-/, "")
             csv_split(v, ",")&.each do |c|
               ret << "<#{t}-metadata><#{k}>#{c}</#{k}></#{t}-metadata>"

data/lib/metanorma/standoc/cleanup.rb

@@ -31,11 +31,12 @@ module Metanorma
         obligations_cleanup(xmldoc)
         para_index_cleanup(xmldoc)
         block_index_cleanup(xmldoc)
-        table_cleanup(xmldoc)
+        table_cleanup(xmldoc) # feeds: blocksource_cleanup
         formula_cleanup(xmldoc)
         form_cleanup(xmldoc)
         sourcecode_cleanup(xmldoc) # feeds: callout_cleanup
         figure_cleanup(xmldoc)
+        blocksource_cleanup(xmldoc)
         requirement_cleanup(xmldoc) # feeds: xref_cleanup
         element_name_cleanup(xmldoc)
         ref_cleanup(xmldoc) # feeds: bibitem_cleanup

data/lib/metanorma/standoc/cleanup_block.rb

@@ -79,8 +79,7 @@ module Metanorma
       def single_subfigure_cleanup(xmldoc)
         xmldoc.xpath("//figure[figure]").each do |e|
           s = e.xpath("./figure")
-          return unless s.size == 1
-
+          s.size == 1 or next
           s[0].replace(s[0].children)
         end
       end
@@ -228,6 +227,13 @@ module Metanorma
                    "Style override set for ordered list")
         end
       end
+
+      def blocksource_cleanup(xmldoc)
+        xmldoc.xpath("//figure//termsource | //table//termsource").each do |s|
+          s.name = "source"
+          s.delete("type")
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -42,11 +42,15 @@ module Metanorma
           outnum = idx
           seen[content] = outnum
         end
-        fnote["reference"] = (outnum - 1 + "a".ord).chr
+        fnote["reference"] = table_footnote_number(outnum)
         fnote["table"] = true
         [idx, seen]
       end
 
+      def table_footnote_number(outnum)
+        (outnum - 1 + "a".ord).chr
+      end
+
       def table_footnote_renumber(xmldoc)
         xmldoc.xpath("//table | //figure").each do |t|
           seen = {}
@@ -90,16 +94,28 @@ module Metanorma
       end
 
       def footnote_block_cleanup(xmldoc)
-        xmldoc.xpath("//footnoteblock").each do |f|
+        ids = xmldoc.xpath("//footnoteblock").each_with_object([]) do |f, m|
           f.name = "fn"
+          m << f.text
           if id = xmldoc.at("//*[@id = '#{f.text}']")
-            f.children = id.remove.children
-          else
-            @log.add("Crossreferences", f,
-                     "Could not resolve footnoteblock:[#{f.text}]")
-            f.children = "[ERROR]"
+            f.children = id.dup.children
+          else footnote_block_error(f)
           end
         end
+        footnote_block_remove(xmldoc, ids)
+      end
+
+      def footnote_block_remove(xmldoc, ids)
+        ids.each do |id|
+          n = xmldoc.at("//*[@id = '#{id}']") and
+            n.remove
+        end
+      end
+
+      def footnote_block_error(fnote)
+        @log.add("Crossreferences", fnote,
+                 "Could not resolve footnoteblock:[#{fnote.text}]")
+        fnote.children = "[ERROR]"
       end
 
       def footnote_cleanup(xmldoc)

data/lib/metanorma/standoc/cleanup_symbols.rb

@@ -17,9 +17,9 @@ module Metanorma
       def asciimath_key(sym)
         key = sym.dup
         key.traverse do |n|
-          if n.name == "math"
+          if n.name == "stem" && a = n.at(".//asciimath")
             n.children = @c.encode(
-              @c.decode(grkletters(MathML2AsciiMath.m2a(n.to_xml))), :basic
+              @c.decode(grkletters(a.text)), :basic
             )
           end
         end

data/lib/metanorma/standoc/cleanup_table.rb

@@ -46,16 +46,30 @@ module Metanorma
       def table_cleanup(xmldoc)
         dl1_table_cleanup(xmldoc)
         dl2_table_cleanup(xmldoc)
+        sources_table_cleanup(xmldoc)
         notes_table_cleanup(xmldoc)
         header_rows_cleanup(xmldoc)
       end
 
+      def sources_table_cleanup(xmldoc)
+        nomatches = false
+        until nomatches
+          nomatches = true
+          xmldoc.xpath("//table/following-sibling::*[1]" \
+                       "[self::termsource]").each do |n|
+            n.previous_element << n.remove
+            nomatches = false
+            # will be renamed source from termsource later
+          end
+        end
+      end
+
       # move notes into table
       def notes_table_cleanup(xmldoc)
         nomatches = false
         until nomatches
           nomatches = true
-          xmldoc.xpath("//table/following-sibling::*[1]"\
+          xmldoc.xpath("//table/following-sibling::*[1]" \
                        "[self::note[not(@keep-separate = 'true')]]").each do |n|
             n.delete("keep-separate")
             n.previous_element << n.remove

data/lib/metanorma/standoc/cleanup_terms.rb

@@ -27,7 +27,7 @@ module Metanorma
       end
 
       TERMDEF_BLOCKS =
-        "./p | ./ol | ./dl[not(@metadata = 'true')] | ./ul | ./figure | "\
+        "./p | ./ol | ./dl[not(@metadata = 'true')] | ./ul | ./figure | " \
         "./formula | ./table".freeze
 
       def generate_termdefinitions(xmldoc)
@@ -47,7 +47,7 @@ module Metanorma
           if d.at("./p | ./ol | ./dl | ./ul")
             d.children = "<verbal-definition>#{d.children}</verbal-definition>"
           else
-            d.children = "<non-verbal-representation>"\
+            d.children = "<non-verbal-representation>" \
                          "#{d.children}</non-verbal-representation>"
           end
         end

data/lib/metanorma/standoc/cleanup_terms_designations.rb

@@ -2,7 +2,6 @@ module Metanorma
   module Standoc
     module Cleanup
       def termdef_stem_cleanup(xmldoc)
-        termdef_stem2admitted(xmldoc)
         xmldoc.xpath("//term//expression/name[stem]").each do |n|
           test = n.dup
           test.at("./stem").remove
@@ -12,25 +11,6 @@ module Metanorma
         end
       end
 
-      def termdef_stem2admitted(xmldoc)
-        xmldoc.xpath("//term/p/stem").each do |a|
-          if initial_formula(a.parent)
-            parent = a.parent
-            parent.replace("<admitted>#{term_expr(a.to_xml)}</admitted>")
-          end
-        end
-        xmldoc.xpath("//term/formula").each do |a|
-          initial_formula(a) and
-            a.replace("<admitted>#{term_expr(a.children.to_xml)}</admitted>")
-        end
-      end
-
-      def initial_formula(elem)
-        elem.elements.size == 1 && # para contains just stem expression
-          !elem.at("./preceding-sibling::p | ./preceding-sibling::dl | "\
-                   "./preceding-sibling::ol | ./preceding-sibling::ul")
-      end
-
       # release termdef tags from surrounding paras
       def termdef_unnest_cleanup(xmldoc)
         desgn = "//p/admitted | //p/deprecates | //p/preferred | //p//related"
@@ -136,7 +116,7 @@ module Metanorma
       def dl_to_designation(dlist)
         prev = dlist.previous_element
         unless %w(preferred admitted deprecates related).include? prev&.name
-          @log.add("AsciiDoc Input", dlist, "Metadata definition list does "\
+          @log.add("AsciiDoc Input", dlist, "Metadata definition list does " \
                                             "not follow a term designation")
           return nil
         end

data/lib/metanorma/standoc/converter.rb

@@ -86,7 +86,7 @@ module Metanorma
         basebackend "html"
         outfilesuffix ".xml"
         @libdir = File.dirname(self.class::_file || __FILE__)
-                @c = HTMLEntities.new
+        @c = HTMLEntities.new
       end
 
       class << self

data/lib/metanorma/standoc/isodoc.rng

@@ -17,6 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
+<!-- VERSION v1.2.1 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -382,6 +383,9 @@
         <optional>
           <ref name="dl"/>
         </optional>
+        <optional>
+          <ref name="source"/>
+        </optional>
       </element>
     </define>
     <define name="figure">
@@ -404,9 +408,6 @@
           <attribute name="class"/>
         </optional>
         <ref name="BlockAttributes"/>
-        <optional>
-          <ref name="source"/>
-        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -431,6 +432,20 @@
         <zeroOrMore>
           <ref name="note"/>
         </zeroOrMore>
+        <optional>
+          <ref name="source"/>
+        </optional>
+      </element>
+    </define>
+    <define name="source">
+      <element name="source">
+        <attribute name="status">
+          <ref name="SourceStatusType"/>
+        </attribute>
+        <ref name="origin"/>
+        <optional>
+          <ref name="modification"/>
+        </optional>
       </element>
     </define>
     <define name="sourcecode">
@@ -1335,15 +1350,19 @@
       </choice>
     </element>
   </define>
+  <define name="Root-Attributes">
+    <attribute name="version"/>
+    <attribute name="schema-version"/>
+    <attribute name="type">
+      <choice>
+        <value>semantic</value>
+        <value>presentation</value>
+      </choice>
+    </attribute>
+  </define>
   <define name="standard-document">
     <element name="standard-document">
-      <attribute name="version"/>
-      <attribute name="type">
-        <choice>
-          <value>semantic</value>
-          <value>presentation</value>
-        </choice>
-      </attribute>
+      <ref name="Root-Attributes"/>
       <ref name="bibdata"/>
       <optional>
         <ref name="misccontainer"/>
@@ -2099,10 +2118,7 @@
   <define name="termsource">
     <element name="termsource">
       <attribute name="status">
-        <choice>
-          <value>identical</value>
-          <value>modified</value>
-        </choice>
+        <ref name="SourceStatusType"/>
       </attribute>
       <attribute name="type">
         <choice>
@@ -2116,6 +2132,17 @@
       </optional>
     </element>
   </define>
+  <define name="SourceStatusType">
+    <choice>
+      <value>identical</value>
+      <value>modified</value>
+      <value>restyled</value>
+      <value>context-added</value>
+      <value>generalisation</value>
+      <value>specialisation</value>
+      <value>unspecified</value>
+    </choice>
+  </define>
   <define name="origin">
     <element name="origin">
       <choice>

data/lib/metanorma/standoc/ref.rb

@@ -122,7 +122,7 @@ module Metanorma
           t.formattedref format: "application/x-isodoc+xml" do |i|
             i << ref_normalise_no_format(match[:text])
           end
-          yr_match = /[:-](?<year>(?:19|20)[0-9][0-9])\b/.match(code[:id])
+          yr_match = refitem1yr(code[:id])
           refitem_render1(match, code, t)
           /^\d+$|^\(.+\)$/.match?(code[:id]) or
             docnumber(t, code[:id].sub(/[:-](19|20)[0-9][0-9]$/, ""))
@@ -143,16 +143,17 @@ module Metanorma
         ((code[:id] && code[:numeric]) || code[:nofetch]) and
           return { code: nil, match: match, analyse_code: code,
                    hidden: code[:hidden] }
-        year = refitem1yr(code[:id])
         { code: code[:id], analyse_code: code, localfile: code[:localfile],
-          year: year,
+          year: (m = refitem1yr(code[:id])) ? m[:year] : nil,
           title: match[:text], match: match, hidden: code[:hidden],
           usrlbl: match[:usrlbl], lang: (@lang || :all) }
       end
 
       def refitem1yr(code)
-        yr_match = /[:-](?<year>(?:19|20)[0-9][0-9])\b/.match(code)
-        yr_match ? yr_match[:year] : nil
+        yr_match = /[:-](?<year>(?:19|20)[0-9][0-9])$/.match(code)
+        /[:-](?:19|20)[0-9][0-9].*?[:-](?:19|20)[0-9][0-9]$/.match(code) and
+          yr_match = nil
+        yr_match
       end
 
       def refitemout(item, xml)

data/lib/metanorma/standoc/validate.rb

@@ -1,6 +1,7 @@
 require "metanorma/standoc/utils"
 require_relative "./validate_section"
 require_relative "./validate_table"
+require_relative "./validate_xref"
 require "nokogiri"
 require "jing"
 require "iev"
@@ -155,22 +156,6 @@ module Metanorma
         ret
       end
 
-      def repeat_id_validate1(elem)
-        if @doc_ids[elem["id"]]
-          @log.add("Anchors", elem, "Anchor #{elem['id']} has already been " \
-                                    "used at line #{@doc_ids[elem['id']]}")
-          @fatalerror << "Multiple instances of same ID: #{elem['id']}"
-        end
-        @doc_ids[elem["id"]] = elem.line
-      end
-
-      def repeat_id_validate(doc)
-        @doc_ids = {}
-        doc.xpath("//*[@id]").each do |x|
-          repeat_id_validate1(x)
-        end
-      end
-
       def schema_validate(doc, schema)
         Tempfile.open(["tmp", ".xml"], encoding: "UTF-8") do |f|
           schema_validate1(f, doc, schema)
@@ -214,17 +199,6 @@ module Metanorma
         doc
       end
 
-      # manually check for xref/@target, xref/@to integrity
-      def xref_validate(doc)
-        @doc_xrefs = doc.xpath("//xref/@target | //xref/@to")
-          .each_with_object({}) do |x, m|
-          m[x.text] = x
-          @doc_ids[x.text] and next
-          @log.add("Anchors", x.parent,
-                   "Crossreference target #{x} is undefined")
-        end
-      end
-
       def image_validate(doc)
         image_exists(doc)
         png_validate(doc)

data/lib/metanorma/standoc/validate_section.rb

@@ -13,10 +13,16 @@ module Metanorma
         root.xpath("//sourcecode").each do |x|
           callouts = x.elements.select { |e| e.name == "callout" }
           annotations = x.elements.select { |e| e.name == "annotation" }
-          if callouts.size != annotations.size
-            @log.add("AsciiDoc Input", x,
-                     "mismatch of callouts and annotations")
-          end
+          callouts_error(x, callouts, annotations)
+        end
+      end
+
+      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("AsciiDoc Input", elem, err)
+          @fatalerror << err
         end
       end
 

data/lib/metanorma/standoc/validate_xref.rb

@@ -0,0 +1,32 @@
+module Metanorma
+  module Standoc
+    module Validate
+      def repeat_id_validate1(elem)
+        if @doc_ids[elem["id"]]
+          @log.add("Anchors", elem, "Anchor #{elem['id']} has already been " \
+                                    "used at line #{@doc_ids[elem['id']]}")
+          @fatalerror << "Multiple instances of same ID: #{elem['id']}"
+        end
+        @doc_ids[elem["id"]] = elem.line
+      end
+
+      def repeat_id_validate(doc)
+        @doc_ids = {}
+        doc.xpath("//*[@id]").each do |x|
+          repeat_id_validate1(x)
+        end
+      end
+
+      # manually check for xref/@target, xref/@to integrity
+      def xref_validate(doc)
+        @doc_xrefs = doc.xpath("//xref/@target | //xref/@to")
+          .each_with_object({}) do |x, m|
+          m[x.text] = x
+          @doc_ids[x.text] and next
+          @log.add("Anchors", x.parent,
+                   "Crossreference target #{x} is undefined")
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.4.1".freeze
+    VERSION = "2.4.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.5.0"
-  spec.add_dependency "metanorma"
+  spec.add_dependency "isodoc", "~> 2.5.4"
+  spec.add_dependency "metanorma", ">= 1.5.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "plurimath"
   spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.15.0"
-  spec.add_dependency "relaton-iev", "~> 1.1.0"
+  spec.add_dependency "relaton-iev", "~> 1.1.5"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 
   spec.add_development_dependency "debug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.5.4
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: metanorma-plugin-datastruct
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.5
 - !ruby/object:Gem::Dependency
   name: unicode2latex
   requirement: !ruby/object:Gem::Requirement
@@ -514,6 +514,7 @@ files:
 - lib/metanorma/standoc/validate.rb
 - lib/metanorma/standoc/validate_section.rb
 - lib/metanorma/standoc/validate_table.rb
+- lib/metanorma/standoc/validate_xref.rb
 - lib/metanorma/standoc/version.rb
 - lib/metanorma/standoc/views/datamodel/model_representation.adoc.erb
 - lib/metanorma/standoc/views/datamodel/plantuml_representation.adoc.erb