metanorma-standoc 2.2.4 → 2.2.6

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -53,11 +53,11 @@ module Metanorma
         end
       end
 
-      TERM_CLAUSE = "//sections/terms | "\
+      TERM_CLAUSE = "//sections/terms | " \
                     "//sections/clause[descendant::terms]".freeze
 
       NORM_REF =
-        "//bibliography/references[@normative = 'true'][not(@hidden)] | "\
+        "//bibliography/references[@normative = 'true'][not(@hidden)] | " \
         "//bibliography/clause[.//references[@normative = 'true']]".freeze
 
       def boilerplate_isodoc(xmldoc)
@@ -79,7 +79,7 @@ module Metanorma
 
       def unwrap_boilerplate_clauses(xmldoc, xpath)
         xmldoc.xpath(xpath).each do |f|
-          f.xpath(".//clause[@type = 'boilerplate'] | "\
+          f.xpath(".//clause[@type = 'boilerplate'] | " \
                   ".//note[@type = 'boilerplate']").each do |c|
             c&.at("./title")&.remove
             c.replace(c.children)
@@ -175,9 +175,9 @@ module Metanorma
       end
 
       def indirect_eref_to_xref(eref, ident)
-        loc = eref&.at("./localityStack[locality[@type = 'anchor']]")
+        loc = eref.at("./localityStack[locality[@type = 'anchor']]")
           &.remove&.text ||
-          eref&.at("./locality[@type = 'anchor']")&.remove&.text || ident
+          eref.at("./locality[@type = 'anchor']")&.remove&.text || ident
         eref.name = "xref"
         eref.delete("bibitemid")
         eref.delete("citeas")
@@ -213,7 +213,7 @@ module Metanorma
       def bibdata_embed_hdr_cleanup(xmldoc)
         return if @embed_hdr.nil? || @embed_hdr.empty?
 
-        xmldoc.at("//bibdata") << "<relation type='derivedFrom'>"\
+        xmldoc.at("//bibdata") << "<relation type='derivedFrom'>" \
                                   "#{hdr2bibitem(@embed_hdr.first)}</relation>"
       end
 

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -35,7 +35,7 @@ module Metanorma
 
       def li_bookmark_cleanup(xmldoc)
         xmldoc.xpath("//li[descendant::bookmark]").each do |x|
-          if x.at("./*[1][local-name() = 'p']/"\
+          if x.at("./*[1][local-name() = 'p']/" \
                   "*[1][local-name() = 'bookmark']") &&
               empty_text_before_first_element(x.elements[0])
             bookmark_to_id(x, x.elements[0].elements[0])
@@ -45,7 +45,7 @@ module Metanorma
 
       def dt_bookmark_cleanup(xmldoc)
         xmldoc.xpath("//dt[descendant::bookmark]").each do |x|
-          if x.at("./*[1][local-name() = 'p']/"\
+          if x.at("./*[1][local-name() = 'p']/" \
                   "*[1][local-name() = 'bookmark']") &&
               empty_text_before_first_element(x.elements[0])
             bookmark_to_id(x, x.elements[0].elements[0])

data/lib/metanorma/standoc/cleanup_text.rb

@@ -43,7 +43,7 @@ module Metanorma
           .intersection(IGNORE_QUOTES_ELEMENTS).empty? &&
           ((elem.previous.text.strip.empty? &&
             !empty_tag_with_text_content?(elem.previous)) ||
-           elem.previous.name == "index"))
+           ignoretext?(elem.previous)))
       end
 
       def uninterrupt_quotes_around_xml1(elem)
@@ -56,13 +56,20 @@ module Metanorma
         prev.content = "#{prev.text}#{m[1]}"
       end
 
+      IGNORE_TEXT_ELEMENTS =
+        %w(index fn).freeze
+
+      def ignoretext?(elem)
+        IGNORE_TEXT_ELEMENTS.include? elem.name
+      end
+
       def block?(elem)
         %w(title name variant-title clause figure annex example introduction
            foreword acknowledgements note li th td dt dd p quote label
            abstract preferred admitted related deprecates field-of-application
            usage-info expression pronunciation grammar-value domain
            definition termnote termexample modification description
-           newcontent floating-title).include? elem.name
+           newcontent floating-title tab).include? elem.name
       end
 
       def empty_tag_with_text_content?(elem)
@@ -79,7 +86,7 @@ module Metanorma
           ancestors = x.path.split(%r{/})[1..-2]
           ancestors.intersection(IGNORE_QUOTES_ELEMENTS).empty? and
             dumb2smart_quotes1(x, prev)
-          prev = x.text unless ancestors.include?("index")
+          prev = x.text if ancestors.intersection(IGNORE_TEXT_ELEMENTS).empty?
         end
       end
 

data/lib/metanorma/standoc/inline.rb

@@ -45,6 +45,7 @@ module Metanorma
         m.nil? and return { target: t, type: "inline", text: node.text }
         { target: t, type: m[:fn].nil? ? "inline" : "footnote",
           case: m[:case]&.sub(/%$/, ""),
+          style: m[:style]&.sub(/^style=/, "")&.sub(/%$/, "") || @xrefstyle,
           droploc: m[:drop].nil? && m[:drop2].nil? ? nil : true,
           text: inline_anchor_xref_text(m, node),
           hidden: m[:hidden] }
@@ -52,12 +53,13 @@ module Metanorma
 
       def inline_anchor_xref_match(node)
         /^(?:hidden%(?<hidden>[^,]+),?)?
+          (?<style>style=[^%]+%)?
           (?<drop>droploc%)?(?<case>capital%|lowercase%)?(?<drop2>droploc%)?
           (?<fn>fn:?\s*)?(?<text>.*)$/x.match node.text
       end
 
       def inline_anchor_xref_text(match, node)
-        if %i[case fn drop drop2 hidden].any? do |x|
+        if %i[case fn drop drop2 hidden style].any? do |x|
              !match[x].nil?
            end
           match[:text]

data/lib/metanorma/standoc/isodoc-compile.rng

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0">
+  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
+  <include href="biblio-standoc.rng"/>
+  <include href="isodoc.rng"/>
+</grammar>
+<!-- end overrides -->

data/lib/metanorma/standoc/isodoc.rng

@@ -17,21 +17,9 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<grammar ns="https://www.metanorma.org/ns/standoc" 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">
+<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 "biblio.rnc" { } -->
   <include href="basicdoc.rng">
-    <start>
-      <ref name="standard-document"/>
-    </start>
-    <define name="doctype">
-      <element name="doctype">
-        <optional>
-          <attribute name="abbreviation"/>
-        </optional>
-        <ref name="DocumentType"/>
-      </element>
-    </define>
     <define name="admonition">
       <element name="admonition">
         <attribute name="type">
@@ -117,24 +105,6 @@
         </optional>
       </element>
     </define>
-    <define name="bibitem">
-      <element name="bibitem">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <attribute name="hidden">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="suppress_identifier">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <ref name="BibliographicItem"/>
-      </element>
-    </define>
     <define name="section-title">
       <element name="title">
         <zeroOrMore>
@@ -205,6 +175,15 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="style">
+            <choice>
+              <value>basic</value>
+              <value>full</value>
+              <value>short</value>
+            </choice>
+          </attribute>
+        </optional>
         <ref name="XrefBody"/>
       </element>
     </define>
@@ -239,42 +218,6 @@
         <ref name="PureTextElement"/>
       </oneOrMore>
     </define>
-    <define name="localityStack">
-      <element name="localityStack">
-        <optional>
-          <attribute name="connective">
-            <choice>
-              <value>and</value>
-              <value>or</value>
-              <value>from</value>
-              <value>to</value>
-              <value/>
-            </choice>
-          </attribute>
-        </optional>
-        <zeroOrMore>
-          <ref name="locality"/>
-        </zeroOrMore>
-      </element>
-    </define>
-    <define name="sourceLocalityStack">
-      <element name="sourceLocalityStack">
-        <optional>
-          <attribute name="connective">
-            <choice>
-              <value>and</value>
-              <value>or</value>
-              <value>from</value>
-              <value>to</value>
-              <value/>
-            </choice>
-          </attribute>
-        </optional>
-        <zeroOrMore>
-          <ref name="sourceLocality"/>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -818,21 +761,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <define name="BibDataExtensionType">
-      <ref name="doctype"/>
-      <optional>
-        <ref name="docsubtype"/>
-      </optional>
-      <optional>
-        <ref name="editorialgroup"/>
-      </optional>
-      <zeroOrMore>
-        <ref name="ics"/>
-      </zeroOrMore>
-      <zeroOrMore>
-        <ref name="structuredidentifier"/>
-      </zeroOrMore>
-    </define>
     <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
@@ -872,7 +800,7 @@
           <ref name="BasicBlock"/>
         </zeroOrMore>
         <zeroOrMore>
-          <ref name="bibitem"/>
+          <ref name="doc_bibitem"/>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>
@@ -1210,6 +1138,24 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="doc_bibitem">
+    <element name="bibitem">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <optional>
+        <attribute name="hidden">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="suppress_identifier">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="BibliographicItem"/>
+    </element>
+  </define>
   <define name="image" combine="choice">
     <element name="svg">
       <oneOrMore>
@@ -1228,14 +1174,6 @@
       <value>tag</value>
     </choice>
   </define>
-  <define name="docsubtype">
-    <element name="subdoctype">
-      <ref name="DocumentSubtype"/>
-    </element>
-  </define>
-  <define name="DocumentSubtype">
-    <text/>
-  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -1597,45 +1535,6 @@
       </choice>
     </element>
   </define>
-  <define name="editorialgroup">
-    <element name="editorialgroup">
-      <oneOrMore>
-        <ref name="technical-committee"/>
-      </oneOrMore>
-    </element>
-  </define>
-  <define name="technical-committee">
-    <element name="technical-committee">
-      <ref name="IsoWorkgroup"/>
-    </element>
-  </define>
-  <define name="IsoWorkgroup">
-    <optional>
-      <attribute name="number"/>
-    </optional>
-    <optional>
-      <attribute name="type"/>
-    </optional>
-    <optional>
-      <attribute name="identifier"/>
-    </optional>
-    <optional>
-      <attribute name="prefix"/>
-    </optional>
-    <text/>
-  </define>
-  <define name="ics">
-    <element name="ics">
-      <element name="code">
-        <text/>
-      </element>
-      <optional>
-        <element name="text">
-          <text/>
-        </element>
-      </optional>
-    </element>
-  </define>
   <define name="standard-document">
     <element name="standard-document">
       <attribute name="version"/>
@@ -2466,71 +2365,6 @@
       </optional>
     </element>
   </define>
-  <define name="structuredidentifier">
-    <element name="structuredidentifier">
-      <optional>
-        <attribute name="type"/>
-      </optional>
-      <oneOrMore>
-        <element name="agency">
-          <text/>
-        </element>
-      </oneOrMore>
-      <optional>
-        <element name="class">
-          <text/>
-        </element>
-      </optional>
-      <element name="docnumber">
-        <text/>
-      </element>
-      <optional>
-        <element name="partnumber">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="edition">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="version">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="supplementtype">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="supplementnumber">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="amendment">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="corrigendum">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="language">
-          <text/>
-        </element>
-      </optional>
-      <optional>
-        <element name="year">
-          <text/>
-        </element>
-      </optional>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -2804,4 +2638,7 @@
       </attribute>
     </element>
   </define>
+  <start>
+    <ref name="standard-document"/>
+  </start>
 </grammar>

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -1,21 +1,22 @@
 module Metanorma
   module Standoc
     class PlantUMLBlockMacroBackend
-      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
       def self.plantuml_installed?
-        cmd = "plantuml"
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
-        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
+        unless which("plantuml")
+          raise "PlantUML not installed"
+        end
+      end
+
+      def self.plantuml_bin
+        if Gem.win_platform? || which("plantumlc")
+          "plantumlc"
+        else
+          "plantuml"
         end
-        raise "PlantUML not installed"
       end
 
       def self.run(umlfile, outfile)
-        system "plantuml #{umlfile.path}" or (warn $? and return false)
+        system "#{plantuml_bin} #{umlfile.path}" or (warn $? and return false)
         i = 0
         until !Gem.win_platform? || File.exist?(outfile) || i == 15
           sleep(1)
@@ -84,6 +85,18 @@ module Metanorma
           memo
         end
       end
+
+      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+      def self.which(cmd)
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
+        end
+        nil
+      end
     end
 
     class PlantUMLBlockMacro < Asciidoctor::Extensions::BlockProcessor

data/lib/metanorma/standoc/validate.rb

@@ -9,7 +9,7 @@ require "pngcheck"
 module Metanorma
   module Standoc
     module Validate
-      SOURCELOCALITY = "./origin//locality[@type = 'clause']/"\
+      SOURCELOCALITY = "./origin//locality[@type = 'clause']/" \
                        "referenceFrom".freeze
 
       def init_iev
@@ -24,7 +24,7 @@ module Metanorma
         @iev = init_iev or return
         xmldoc.xpath("//term").each do |t|
           t.xpath(".//termsource").each do |src|
-            (/^IEC 60050-/.match(src&.at("./origin/@citeas")&.text) &&
+            (/^IEC 60050-/.match(src.at("./origin/@citeas")&.text) &&
           loc = src.xpath(SOURCELOCALITY)&.text) or next
             iev_validate1(t, loc, xmldoc)
           end
@@ -33,9 +33,9 @@ module Metanorma
 
       def iev_validate1(term, loc, xmldoc)
         iev = @iev.fetch(loc,
-                         xmldoc&.at("//language")&.text || "en") or return
+                         xmldoc.at("//language")&.text || "en") or return
         pref = term.xpath("./preferred//name").inject([]) do |m, x|
-          m << x&.text&.downcase
+          m << x.text&.downcase
         end
         pref.include?(iev.downcase) or
           @log.add("Bibliography", term, %(Term "#{pref[0]}" does not match ) +
@@ -97,7 +97,7 @@ module Metanorma
 
       def repeat_id_validate1(ids, elem)
         if ids[elem["id"]]
-          @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\
+          @log.add("Anchors", elem, "Anchor #{elem['id']} has already been " \
                                     "used at line #{ids[elem['id']]}")
           @fatalerror << "Multiple instances of same ID: #{elem['id']}"
         else
@@ -137,8 +137,8 @@ module Metanorma
       SVG_NS = "http://www.w3.org/2000/svg".freeze
 
       WILDCARD_ATTRS =
-        "//*[@format] | //stem | //bibdata//description | "\
-        "//formattedref | //bibdata//note | //bibdata/abstract | "\
+        "//*[@format] | //stem | //bibdata//description | " \
+        "//formattedref | //bibdata//note | //bibdata/abstract | " \
         "//bibitem/abstract | //bibitem/note | //misc-container".freeze
 
       # RelaxNG cannot cope well with wildcard attributes. So we strip
@@ -213,7 +213,7 @@ module Metanorma
       def validate(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "isodoc.rng"))
+                        File.join(File.dirname(__FILE__), "isodoc-compile.rng"))
       end
     end
   end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.2.4".freeze
+    VERSION = "2.2.6".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "mn-requirements", "~> 0.1.4"
   spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.13.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"