metanorma-standoc 1.10.5 → 1.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd98ba81df1c144552167e677b04d6152d838de0ea2d539a6bc7bde2a4b7f235
-  data.tar.gz: 68d9afff164047bf12f97ac23735cc1d61503172ae8656795393314d127223b6
+  metadata.gz: 5982aeb8f67b56ccf4da3cf8589b3855fda38e646650074f8804d8e94de9a791
+  data.tar.gz: 6efa1a3eb9fce06dfcce893c835152a2ee642418cd35f06981d4a3d7e4408832
 SHA512:
-  metadata.gz: 611ba153c4160486b0ea51eb1564e09cd81d02f6ca6d5a075e3f38cf321321f2e019ba538341786bd4fe01eac9ef53e71ddc5cc19fdccb4e69189d9e7a720955
-  data.tar.gz: 0acb358132209888abe3a276c16abcfdf142570fd271712960e64e02db487df9bb39081a1f4e08da7347777a71240b57b2d8f6dda7d980523981efe5a838495c
+  metadata.gz: 4d4cd2f1c480899fe9221482e53bff2702d96cc1688937b15b993eddcddbca80cb7c5d931913ceaa5e06f9c0b6a70723fc3a84c275a259c5a9bb21fb8b3d42fe
+  data.tar.gz: 61cf1ff021b2f6365ad83311478732ed431dc2f3328e11ec1a96ebfa264c463ded7198779a86928bb3a82ce4153f4934b96aeccccff5d136d3018cd9b6025173

data/lib/asciidoctor/standoc/base.rb

@@ -174,6 +174,10 @@ module Asciidoctor
         outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
         clean_exit
         ret
+      rescue StandardError => e
+        @log.add("Fatal Error", nil, e.message)
+        clean_exit
+        raise e
       end
 
       def version

data/lib/asciidoctor/standoc/blocks.rb

@@ -33,6 +33,7 @@ module Asciidoctor
         role = node.role || node.attr("style")
         reqt_subpart(role) and return requirement_subpart(node)
         role == "form" and return form(node)
+        role == "definition" and return termdefinition(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -92,7 +93,9 @@ module Asciidoctor
         return pseudocode_example(node) if role == "pseudocode"
         return svgmap_example(node) if role == "svgmap"
         return form(node) if role == "form"
+        return termdefinition(node) if role == "definition"
 
+        reqt_subpart(role) and return requirement_subpart(node)
         example_proper(node)
       end
 

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -7,7 +7,8 @@ module Asciidoctor
       def para_cleanup(xmldoc)
         ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
          "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
-         "//note[not(ancestor::bibitem or ancestor::table or ancestor::bibdata)]"].each do |w|
+         "//note[not(ancestor::bibitem or "\
+         "ancestor::table or ancestor::bibdata)]"].each do |w|
           inject_id(
             xmldoc, w
           )
@@ -73,9 +74,11 @@ module Asciidoctor
       def notes_table_cleanup(xmldoc)
         nomatches = false
         until nomatches
-          q = "//table/following-sibling::*[1][self::note]"
+          q = "//table/following-sibling::*[1]"\
+              "[self::note[not(@keep-separate = 'true')]]"
           nomatches = true
           xmldoc.xpath(q).each do |n|
+            n.delete("keep-separate")
             n.previous_element << n.remove
             nomatches = false
           end

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -86,14 +86,19 @@ module Asciidoctor
         while (m = LOCALITY_RE.match text)
           ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
           refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
-          loc = m[:locality]&.downcase || m[:locality2]&.downcase
-          b.add_child("<locality type='#{loc}'>#{ref}#{refto}</locality>")
+          b.add_child("<locality type='#{locality_label(m)}'>#{ref}#{refto}"\
+                      "</locality>")
           text = m[:text]
           b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
         end
         elem.add_child(text) if text
       end
 
+      def locality_label(match)
+        loc = match[:locality] || match[:locality2]
+        /^locality:/.match?(loc) ? loc : loc&.downcase
+      end
+
       def xref_to_eref(elem)
         elem["bibitemid"] = elem["target"]
         unless elem["citeas"] = @anchors&.dig(elem["target"], :xref)
@@ -203,7 +208,8 @@ module Asciidoctor
       end
 
       IDREF = "//*/@id | //review/@from | //review/@to | "\
-        "//callout/@target | //citation/@bibitemid | //eref/@bibitemid".freeze
+              "//callout/@target | //citation/@bibitemid | "\
+              "//eref/@bibitemid".freeze
 
       def anchor_cleanup(elem)
         anchor_cleanup1(elem)

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -3,37 +3,61 @@ module Asciidoctor
     module Cleanup
       def requirement_cleanup(xmldoc)
         requirement_metadata(xmldoc)
-        requirement_descriptions(xmldoc)
         requirement_inherit(xmldoc)
+        requirement_descriptions(xmldoc)
       end
 
       REQRECPER = "//requirement | //recommendation | //permission".freeze
 
       def requirement_inherit(xmldoc)
         xmldoc.xpath(REQRECPER).each do |r|
-          ins = r.at("./classification") ||
-            r.at("./description | ./measurementtarget | ./specification | "\
-                 "./verification | ./import | ./description | ./requirement | "\
-                 "./recommendation | ./permission | ./component")
+          ins = requirement_inherit_insert(r)
           r.xpath("./*//inherit").each { |i| ins.previous = i }
         end
       end
 
+      def requirement_inherit_insert(reqt)
+        ins = reqt.at("./classification") || reqt.at(
+          "./description | ./measurementtarget | ./specification | "\
+          "./verification | ./import | ./description | ./component | "\
+          "./requirement | ./recommendation | ./permission",
+        ) and return ins
+        requirement_inherit_insert1(reqt)
+      end
+
+      def requirement_inherit_insert1(reqt)
+        if t = reqt.at("./title")
+          t.next = " "
+          t.next
+        else
+          if reqt.children.empty? then reqt.add_child(" ")
+          else reqt.children.first.previous = " "
+          end
+          reqt.children.first
+        end
+      end
+
       def requirement_descriptions(xmldoc)
         xmldoc.xpath(REQRECPER).each do |r|
+          r.xpath(".//p[not(./*)][normalize-space(.)='']").each(&:remove)
           r.children.each do |e|
-            unless e.element? && (reqt_subpart(e.name) ||
-                %w(requirement recommendation permission).include?(e.name))
-              next if e.text.strip.empty?
-              t = Nokogiri::XML::Element.new("description", r)
-              e.before(t)
-              t.children = e.remove
-            end
+            requirement_description_wrap(r, e)
           end
           requirement_description_cleanup1(r)
         end
       end
 
+      def requirement_description_wrap(reqt, text)
+        return if text.element? && (reqt_subpart(text.name) ||
+                %w(requirement recommendation
+                   permission).include?(text.name)) ||
+          text.text.strip.empty?
+
+        t = Nokogiri::XML::Element.new("description", reqt)
+        text.before(t)
+        t.children = text.remove
+      end
+
       def requirement_description_cleanup1(reqt)
         while d = reqt.at("./description[following-sibling::*[1]"\
                           "[self::description]]")
@@ -52,17 +76,30 @@ module Asciidoctor
         end
       end
 
+      def requirement_metadata1_tags
+        %w(label subject inherit)
+      end
+
       def requirement_metadata1(reqt, dlist)
         unless ins = reqt.at("./title")
           reqt.children.first.previous = " "
           ins = reqt.children.first
         end
-        %w(label subject inherit).each do |a|
+        %w(obligation model type).each do |a|
+          reqt_dl_to_attrs(reqt, dlist, a)
+        end
+        requirement_metadata1_tags.each do |a|
           ins = reqt_dl_to_elems(ins, reqt, dlist, a)
         end
         reqt_dl_to_classif(ins, reqt, dlist)
       end
 
+      def reqt_dl_to_attrs(reqt, dlist, name)
+        e = dlist.at("./dt[text()='#{name}']") or return
+        val = e.at("./following::dd/p") || e.at("./following::dd") or return
+        reqt[name] = val.text
+      end
+
       def reqt_dl_to_elems(ins, reqt, dlist, name)
         if a = reqt.at("./#{name}[last()]")
           ins = a
@@ -77,16 +114,16 @@ module Asciidoctor
       end
 
       def reqt_dl_to_classif(ins, reqt, dlist)
-        if a = reqt.at("./classification[last()]")
-          ins = a
-        end
+        if a = reqt.at("./classification[last()]") then ins = a end
         dlist.xpath("./dt[text()='classification']").each do |e|
           val = e.at("./following::dd/p") || e.at("./following::dd")
           req_classif_parse(val.text).each do |r|
             ins.next = "<classification><tag>#{r[0]}</tag>"\
                        "<value>#{r[1]}</value></classification>"
+            ins = ins.next
           end
         end
+        ins
       end
     end
   end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -29,7 +29,7 @@ module Asciidoctor
       end
 
       def termdefinition_cleanup(xmldoc)
-        xmldoc.xpath("//term").each do |d|
+        xmldoc.xpath("//term[not(definition)]").each do |d|
           first_child = d.at("./p | ./figure | ./formula") || next
           t = Nokogiri::XML::Element.new("definition", xmldoc)
           first_child.replace(t)

data/lib/asciidoctor/standoc/converter.rb

@@ -50,6 +50,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::FormOptionMacro
         inline_macro Asciidoctor::Standoc::ToCInlineMacro
         inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
+        inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock

data/lib/asciidoctor/standoc/isodoc.rng

@@ -990,6 +990,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="linkmention">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="linkref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -1700,7 +1710,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1763,7 +1775,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1772,6 +1784,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -81,15 +81,24 @@ module Asciidoctor
       def preprocess_attrs(target)
         m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
         ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
-        if m2 = /^(?<rest>.*?)(?<opt>,option=.+)$/.match(m[:rest].sub(/^,/, ""))
-          ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,option=/, "")
+        if m2 = /^(?<rest>.*?)(?<opt>,opt(ion)?s=.+)$/
+            .match(m[:rest].sub(/^,/, ""))
+          ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,opt(ion)?s=/, "")
             .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
-          attrs = CSV.parse_line(m2[:rest]) || []
+          begin
+            attrs = CSV.parse_line(m2[:rest]) || []
+          rescue StandardError
+            raise "error processing #{m2[:rest]} as CSV"
+          end
         else
-          attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+          begin
+            attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+          rescue StandardError
+            raise "error processing #{m[:rest]} as CSV"
+          end
         end
         ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
-                  xrefrender: attrs[2])
+                  render: attrs[2])
       end
 
       def generate_attrs(opts)
@@ -98,21 +107,27 @@ module Asciidoctor
         opts.include?("noref") and ret += " ref='false'"
         opts.include?("ital") and ret += " ital='true'"
         opts.include?("ref") and ret += " ref='true'"
+        opts.include?("nolinkmention") and ret += " linkmention='false'"
+        opts.include?("linkmention") and ret += " linkmention='true'"
+        opts.include?("nolinkref") and ret += " linkref='false'"
+        opts.include?("linkref") and ret += " linkref='true'"
         ret
       end
 
       def process(parent, target, _attrs)
         attrs = preprocess_attrs(target)
-        termout = Asciidoctor::Inline.new(parent, :quoted, attrs[:term]).convert
-        wordout = Asciidoctor::Inline.new(parent, :quoted, attrs[:word]).convert
-        xrefout = Asciidoctor::Inline.new(parent, :quoted,
-                                          attrs[:xrefrender]).convert
-        optout = generate_attrs(attrs[:opt] || [])
-        attrs[:id] and return "<concept#{optout} key='#{attrs[:id]}'><refterm>"\
-          "#{termout}</refterm><renderterm>#{wordout}</renderterm>"\
-          "<xrefrender>#{xrefout}</xrefrender></concept>"
-        "<concept#{optout}><termxref>#{termout}</termxref><renderterm>"\
-          "#{wordout}</renderterm><xrefrender>#{xrefout}</xrefrender></concept>"
+        term = Asciidoctor::Inline.new(parent, :quoted, attrs[:term]).convert
+        word = Asciidoctor::Inline.new(parent, :quoted, attrs[:word]).convert
+        xref = Asciidoctor::Inline.new(parent, :quoted, attrs[:render]).convert
+        opt = generate_attrs(attrs[:opt] || [])
+        if attrs[:id] then "<concept#{opt} key='#{attrs[:id]}'><refterm>"\
+          "#{term}</refterm><renderterm>#{word}</renderterm>"\
+          "<xrefrender>#{xref}</xrefrender></concept>"
+        else "<concept#{opt}><termxref>#{term}</termxref><renderterm>"\
+          "#{word}</renderterm><xrefrender>#{xref}</xrefrender></concept>"
+        end
+      rescue StandardError => e
+        raise("processing {{#{target}}}: #{e.message}")
       end
     end
   end

data/lib/asciidoctor/standoc/reqt.rb

@@ -7,8 +7,8 @@ module Asciidoctor
   module Standoc
     module Blocks
       def reqt_subpart(name)
-        %w(specification measurement-target verification import label
-           component subject inherit classification title).include? name
+        %w(specification measurement-target verification import label title
+           description component subject inherit classification).include? name
       end
 
       def reqt_subpart_attrs(node, name)

data/lib/asciidoctor/standoc/terms.rb

@@ -77,7 +77,7 @@ module Asciidoctor
       def term_def_parse(attrs, xml, node, _toplevel)
         xml.terms **attr_code(attrs) do |section|
           section.title { |t| t << node.title }
-          (s = node.attr("source")) && s.split(/,/).each do |s1|
+          (s = node.attr("source")) && s.split(",").each do |s1|
             section.termdocsource(nil, **attr_code(bibitemid: s1))
           end
           section << node.content
@@ -131,6 +131,14 @@ module Asciidoctor
           end
         end.join("\n")
       end
+
+      def termdefinition(node)
+        noko do |xml|
+          xml.definition do |d|
+            d << node.content
+          end
+        end.join("\n")
+      end
     end
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.5".freeze
+    VERSION = "1.10.6".freeze
   end
 end

data/spec/asciidoctor/blocks_spec.rb

@@ -317,6 +317,88 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes multiple term definitions" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      === Term1
+
+      [.definition]
+      --
+      first definition
+
+      [.source]
+      <<ISO2191,section=1>>
+      --
+
+      [.definition]
+      --
+      second definition
+
+      [.source]
+      <<ISO2191,section=2>>
+      --
+
+      NOTE: This is a note
+
+      [.source]
+      <<ISO2191,section=3>>
+
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+         <sections>
+           <terms id='_' obligation='normative'>
+             <title>Terms and definitions</title>
+             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+             <term id='term-term1'>
+               <preferred>Term1</preferred>
+               <definition>
+                 <p id='_'>first definition</p>
+                 <termsource status='identical'>
+                   <origin bibitemid='ISO2191' type='inline' citeas=''>
+                     <localityStack>
+                       <locality type='section'>
+                         <referenceFrom>1</referenceFrom>
+                       </locality>
+                     </localityStack>
+                   </origin>
+                 </termsource>
+               </definition>
+               <definition>
+                 <p id='_'>second definition</p>
+                 <termsource status='identical'>
+                   <origin bibitemid='ISO2191' type='inline' citeas=''>
+                     <localityStack>
+                       <locality type='section'>
+                         <referenceFrom>2</referenceFrom>
+                       </locality>
+                     </localityStack>
+                   </origin>
+                 </termsource>
+               </definition>
+               <termnote id='_'>
+                 <p id='_'>This is a note</p>
+               </termnote>
+               <termsource status='identical'>
+                 <origin bibitemid='ISO2191' type='inline' citeas=''>
+                   <localityStack>
+                     <locality type='section'>
+                       <referenceFrom>3</referenceFrom>
+                     </locality>
+                   </localityStack>
+                 </origin>
+               </termsource>
+             </term>
+           </terms>
+         </sections>
+       </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes term notes" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -1264,10 +1346,14 @@ RSpec.describe Asciidoctor::Standoc do
       =====
       I also permit this
       =====
+
+      [requirement,type="general",label="/req/core/quantities-uom"]
+      ======
+      ======
       ====
     INPUT
     output = <<~"OUTPUT"
-                  #{BLANK_HDR}
+      #{BLANK_HDR}
              <sections>
                <permission id="_"><description><p id="_">I permit this</p>
       <example id="_">
@@ -1275,7 +1361,11 @@ RSpec.describe Asciidoctor::Standoc do
       </example></description>
       <permission id="_">
         <description><p id="_">I also permit this</p></description>
-      </permission></permission>
+      </permission>
+      <requirement id='_' type='general'>
+      <label>/req/core/quantities-uom</label>
+      </requirement>
+      </permission>
       </sections>
       </standard-document>
     OUTPUT