metanorma-standoc 2.9.6 → 2.9.8

data/lib/metanorma/standoc/macros_embed.rb

@@ -66,8 +66,8 @@ module Metanorma
       # -- but it won't: https://github.com/metanorma/metanorma-standoc/issues/802
       def read_flattened_embeds(ret, doc)
         reader = ::Asciidoctor::PreprocessorReader.new doc
-        b = Pathname.new doc.base_dir
-        ret.reverse.each do |l|
+        Pathname.new doc.base_dir
+        ret.reverse_each do |l|
           # if l[:file]
           # new = Pathname.new(l[:path]).relative_path_from(b).to_s
           # reader.push_include l[:lines], new, l[:path]

data/lib/metanorma/standoc/macros_inline.rb

@@ -160,24 +160,26 @@ module Metanorma
         str.sub(/^(["'])(.+)\1$/, "\\2")
       end
 
-      def format(attrs)
+      def format(attrs, number)
         # a="," => "a=,"
-        quoted_csv_split(attrs || "", ",").map do |x|
-          m = /^(.+?)=(.+)?$/.match(x) or next
+        out = quoted_csv_split(attrs || "", ",").map do |x|
+          m = /^(.+?)=(.+)?$/.match(HTMLEntities.new.decode(x)) or next
           "#{m[1]}='#{m[2]}'"
-        end.join(",")
+        end
+        /^\+/.match?(number.strip) and out << "number_sign='plus'"
+        out.join(",")
       end
 
       def number(text)
         n = BigDecimal(text)
         trailing_zeroes = 0
         m = /\.[1-9]*(0+)/.match(text) and trailing_zeroes += m[1].size
-        n.to_s("E").sub("e", "0" * trailing_zeroes + "e")
+        n.to_s("E").sub("e", "0" * trailing_zeroes + "e") # rubocop:disable Style/StringConcatenation
       end
 
       def process(parent, target, attrs)
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        fmt = format(out)
+        fmt = format(out, target)
         fmt.empty? and fmt = "default"
         fmt = %( number-format="#{fmt}")
         <<~OUTPUT

data/lib/metanorma/standoc/render.rb

@@ -93,7 +93,7 @@ module Metanorma
                          pdf-allow-print pdf-allow-print-hq
                          pdf-allow-access-content pdf-encrypt-metadata fonts
                          font-license-agreement).each_with_object({}) do |x, m|
-          m[x.gsub("-", "").to_i] = node.attr(x)
+          m[x.delete("-").to_i] = node.attr(x)
         end
 
         pdf_options.merge(fonts_manifest_option(node) || {})

data/lib/metanorma/standoc/reqt.rng

@@ -1,20 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar 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">
   <!--
     Presupposes isodoc.rnc, is included in it
     include "isodoc.rnc" { }
+    
+    This is the Metanorma default provisions model; it is overridden by other provisions models,
+    such as Modspec
   -->
   <define name="requirement">
+    <a:documentation>Specification of an attribute of a subject that is required.
+NOTE: A requirement can contain other requirements</a:documentation>
     <element name="requirement">
       <ref name="RequirementType"/>
     </element>
   </define>
   <define name="recommendation">
+    <a:documentation>Specification of an attribute of a subject that is recommended</a:documentation>
     <element name="recommendation">
       <ref name="RequirementType"/>
     </element>
   </define>
   <define name="permission">
+    <a:documentation>Specification of an attribute of a subject that is permitted</a:documentation>
     <element name="permission">
       <ref name="RequirementType"/>
     </element>
@@ -22,83 +29,101 @@
   <define name="RequirementType">
     <optional>
       <attribute name="obligation">
-        <ref name="ObligationType"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="unnumbered">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="number"/>
-    </optional>
-    <optional>
-      <attribute name="subsequence"/>
-    </optional>
-    <optional>
-      <attribute name="keep-with-next">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="keep-lines-together">
-        <data type="boolean"/>
+        <a:documentation>An attribute that may be used to override the obligation represented in
+the tag name of the top level containers</a:documentation>
+        <ref name="ReqtObligationType"/>
       </attribute>
     </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
+    <ref name="NumberingAttributes"/>
+    <ref name="BlockAttributes"/>
     <optional>
-      <attribute name="filename"/>
-    </optional>
-    <optional>
-      <attribute name="model"/>
-    </optional>
-    <optional>
-      <attribute name="type"/>
+      <attribute name="filename">
+        <a:documentation>File name of the requirement model when exported</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <attribute name="tag"/>
+      <attribute name="model">
+        <a:documentation>Model of requirements realised by this requirement, e.g. "ogc" for Modspec</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <attribute name="multilingual-rendering">
-        <ref name="MultilingualRenderingType"/>
+      <attribute name="type">
+        <a:documentation>Type of requirement; does not override labelling, unlike `class`</a:documentation>
       </attribute>
     </optional>
     <optional>
-      <attribute name="class"/>
+      <attribute name="class">
+        <a:documentation>Class of provision, used to sequence and label that class separately.
+By default, provisions are sequenced and labelled as requirements, recommendations, or
+permissions, by obligation; the class overrides that</a:documentation>
+      </attribute>
     </optional>
     <optional>
-      <ref name="reqtitle"/>
+      <ref name="reqtitle">
+        <a:documentation>Human-readable title of the requirement</a:documentation>
+      </ref>
     </optional>
     <optional>
-      <ref name="label"/>
+      <ref name="reqtlabel">
+        <a:documentation>Formal identifier with which the requirement is referenced</a:documentation>
+      </ref>
     </optional>
     <zeroOrMore>
-      <ref name="subject"/>
+      <ref name="subject">
+        <a:documentation>The party subject to the obligation stated in the requirement</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
-      <ref name="reqinherit"/>
+      <ref name="reqinherit">
+        <a:documentation>Reference to the identifier of another requirement, of which this requirement
+is a subclass, and from which it inherits attributes</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
-      <ref name="classification"/>
+      <ref name="classification">
+        <a:documentation>Key/Value pairs of metadata used to describe the requirement.
+A key can be associated with multiple values</a:documentation>
+      </ref>
     </zeroOrMore>
     <zeroOrMore>
       <choice>
-        <ref name="measurementtarget"/>
-        <ref name="specification"/>
-        <ref name="verification"/>
-        <ref name="import"/>
-        <ref name="description"/>
-        <ref name="component"/>
+        <ref name="measurementtarget">
+          <a:documentation>Quantitative statement of metrics that the requirement realises</a:documentation>
+        </ref>
+        <ref name="specification">
+          <a:documentation>Formal specification of the requirement. Expected to be machine-readable</a:documentation>
+        </ref>
+        <ref name="verification">
+          <a:documentation>Processes or code used to verify that the requirement is being complied
+with. Can be a test (including test code), or a compliance statement</a:documentation>
+        </ref>
+        <ref name="import">
+          <a:documentation>A reference to source code or a statement of prerequisites which is defined elsewhere</a:documentation>
+        </ref>
+        <ref name="description">
+          <a:documentation>Descriptive statement of the content of the requirement. Is expected to
+be human-readable, and to contain formatting markup following Metanorma
+conventions. Is expected to be discursive, and be resumed after
+interruption by other sub-containers</a:documentation>
+        </ref>
+        <ref name="component">
+          <a:documentation>Provisions nested within this provision, which cannot be referenced autonomously and have
+subclasses specific to the parent provision. Not expressed with provision metadata</a:documentation>
+        </ref>
       </choice>
     </zeroOrMore>
     <optional>
-      <ref name="reqt_references"/>
+      <ref name="reqt_references">
+        <a:documentation>A list of references for the requirement, following the Relaton model</a:documentation>
+      </ref>
     </optional>
     <zeroOrMore>
       <choice>
+        <a:documentation>Provisions nested within this provision, which are self-standing and do not have
+subclasses specific to the parent provision</a:documentation>
         <ref name="requirement"/>
         <ref name="recommendation"/>
         <ref name="permission"/>
@@ -107,10 +132,10 @@
   </define>
   <define name="reqtitle">
     <element name="title">
-      <ref name="FormattedString"/>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
-  <define name="label">
+  <define name="reqtlabel">
     <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
@@ -158,7 +183,9 @@
   </define>
   <define name="component">
     <element name="component">
-      <attribute name="class"/>
+      <attribute name="class">
+        <a:documentation>Class of component</a:documentation>
+      </attribute>
       <ref name="RequirementSubpart"/>
     </element>
   </define>
@@ -170,44 +197,36 @@
     </element>
   </define>
   <define name="RequirementSubpart">
-    <optional>
-      <attribute name="type"/>
-    </optional>
-    <optional>
-      <attribute name="exclude">
-        <data type="boolean"/>
+    <a:documentation>A subcontainer can be either machine-readable or human-readable, or a
+mixture of the two.
+A machine-readable component can be included as source code with
+nomination of the language</a:documentation>
+    <optional>
+      <attribute name="type">
+        <a:documentation>Type of sub-container.
+For example a `verification[@type = "unit-test"]` contains a unit test of a single
+feature, and is to be treated differently from
+`verification[@type = "comprehensive"]`, which represents a comprehensive test suite</a:documentation>
       </attribute>
     </optional>
     <optional>
-      <attribute name="keep-with-next">
-        <data type="boolean"/>
-      </attribute>
-    </optional>
-    <optional>
-      <attribute name="keep-lines-together">
+      <attribute name="exclude">
+        <a:documentation>Indicates that the current sub-container is only intended to be
+machine-readable, and is not to be rendered as document output</a:documentation>
         <data type="boolean"/>
       </attribute>
     </optional>
-    <optional>
-      <attribute name="tag"/>
-    </optional>
-    <optional>
-      <attribute name="multilingual-rendering">
-        <ref name="MultilingualRenderingType"/>
-      </attribute>
-    </optional>
+    <ref name="BlockAttributes"/>
     <oneOrMore>
       <choice>
+        <a:documentation>Content of subpart: blocks, rather than provisions</a:documentation>
         <ref name="BasicBlock"/>
         <ref name="component"/>
       </choice>
     </oneOrMore>
   </define>
-  <define name="ObligationType">
-    <choice>
-      <value>requirement</value>
-      <value>recommendation</value>
-      <value>permission</value>
-    </choice>
+  <define name="ReqtObligationType">
+    <a:documentation>Values are "requirement", "recommendation", "permission"; multiple values can be comma-delimited</a:documentation>
+    <text/>
   </define>
 </grammar>

data/lib/metanorma/standoc/spans_to_bibitem.rb

@@ -38,10 +38,17 @@ module Metanorma
           ret += spans_to_bibitem_docid(spans)
           ret += spans_to_contribs(spans)
           ret += spans_to_bibitem_edn(spans)
+          spans[:abstract] and ret += "<abstract>#{spans[:abstract]}</abstract>"
           ret += spans_to_series(spans)
           spans[:pubplace] and ret += "<place>#{spans[:pubplace]}</place>"
           ret += spans_to_bibitem_host(spans)
           ret += spans_to_bibitem_extent(spans[:extent])
+          spans[:classification]&.each do |s|
+            ret += span_to_docid(s, "classification")
+          end
+          spans[:image]&.each do |s|
+            ret += "<depiction>#{s[:val]}</depiction>"
+          end
           ret
         end
 

data/lib/metanorma/standoc/spans_to_bibitem_preprocessing.rb

@@ -3,10 +3,15 @@ module Metanorma
     module Cleanup
       class SpansToBibitem
         def extract_spans(bib)
-          bib.xpath("./formattedref//span").each_with_object([]) do |s, m|
+          ret = bib.xpath("./formattedref//span").each_with_object([]) do |s, m|
             s.at("./ancestor::span") and next
             extract_spans1(s, m)
           end
+          bib.xpath("./formattedref//image").each do |i|
+            i.delete("id")
+            ret << { key: "image", type: nil, val: i.remove.to_xml }
+          end
+          ret
         end
 
         def extract_spans1(span, acc)
@@ -25,7 +30,8 @@ module Metanorma
         end
 
         def empty_span_hash
-          { contrib: [], docid: [], uri: [], date: [], extent: {}, in: {} }
+          { contrib: [], docid: [], uri: [], date: [], classification: [],
+            image: [], extent: {}, in: {} }
         end
 
         def spans_preprocess(spans)
@@ -36,7 +42,7 @@ module Metanorma
 
         def span_preprocess1(span, ret)
           case span[:key]
-          when "uri", "docid"
+          when "uri", "docid", "classification"
             val = link_unwrap(Nokogiri::XML.fragment(span[:val])).to_xml
             ret[span[:key].to_sym] << { type: span[:type], val: }
           when "date"
@@ -45,8 +51,11 @@ module Metanorma
           when "pages", "volume", "issue"
             ret[:extent][span[:key].to_sym] ||= []
             ret[:extent][span[:key].to_sym] << span[:val]
-          when "pubplace", "title", "type", "series", "edition", "version"
+          when "pubplace", "title", "type", "series", "edition", "version",
+            "abstract"
             ret[span[:key].to_sym] = span[:val]
+          when "image"
+            ret[span[:key].to_sym] << { type: span[:type], val: span[:val] }
           when "note"
             ret[span[:key].to_sym] = { type: span[:type], val: span[:val] }
           when "in_title"

data/lib/metanorma/standoc/utils.rb

@@ -13,6 +13,16 @@ module Metanorma
         opts.empty? ? (send transform, node) : (send transform, node, opts)
       end
 
+      def processor
+        parent_type = self.class.name.split("::")[0...-1]
+        parent_type << "Processor"
+        begin
+          Object.const_get(parent_type.join("::"))
+        rescue NameError
+          nil
+        end
+      end
+
       def document_ns_attributes(_doc)
         nil
       end
@@ -37,7 +47,8 @@ module Metanorma
                                    %("\\1#{eql}\\3"))
         Metanorma::Utils::csv_split(text, delim)
           .map do |x|
-            c.encode(x.sub(/^(["'])(.+)\1$/, "\\2"), :basic, :hexadecimal)
+            c.encode(x.sub(/^(["'])(.+)\1$/, "\\2"),
+                     :basic, :hexadecimal)
           end
       end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.9.6".freeze
+    VERSION = "2.9.8".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.9.6
+  version: 2.9.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable