metanorma-standoc 1.10.4.1 → 1.10.8

data/lib/asciidoctor/standoc/macros.rb

@@ -6,6 +6,7 @@ require "csv"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
+require_relative "./macros_note"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
@@ -41,7 +42,7 @@ module Asciidoctor
       def process(_parent, target, attr)
         args = preprocess_attrs(attr) or return
         ret = "<index-xref also='#{target == 'also'}'>"\
-          "<primary>#{args[:primary]}</primary>"
+              "<primary>#{args[:primary]}</primary>"
         ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
         ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
         ret + "<target>#{args[:target]}</target></index-xref>"
@@ -50,7 +51,7 @@ module Asciidoctor
 
     class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named "index-range".to_sym
+      named :"index-range"
       parse_content_as :text
 
       def process(parent, target, attr)
@@ -121,35 +122,6 @@ module Asciidoctor
       end
     end
 
-    class ToDoAdmonitionBlock < Extensions::BlockProcessor
-      use_dsl
-      named :TODO
-      on_contexts :example, :paragraph
-
-      def process(parent, reader, attrs)
-        attrs["name"] = "todo"
-        attrs["caption"] = "TODO"
-        create_block(parent, :admonition, reader.lines, attrs,
-                     content_model: :compound)
-      end
-    end
-
-    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
-      def process(document)
-        (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match? para.lines[0]
-
-          parent = para.parent
-          para.set_attr("name", "todo")
-          para.set_attr("caption", "TODO")
-          para.lines[0].sub!(/^TODO: /, "")
-          todo = Block.new(parent, :admonition, attributes: para.attributes,
-                                                source: para.lines, content_model: :compound)
-          parent.blocks[parent.blocks.index(para)] = todo
-        end
-      end
-    end
-
     class AutonumberInlineMacro < Extensions::InlineMacroProcessor
       use_dsl
       named :autonumber
@@ -177,18 +149,6 @@ module Asciidoctor
       end
     end
 
-    class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :footnoteblock
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<footnoteblock>#{out}</footnoteblock>}
-      end
-    end
-
     class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :add
@@ -229,5 +189,16 @@ module Asciidoctor
         "<toc>#{content}</toc>"
       end
     end
+
+    class PassInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"pass-format"
+
+      def process(parent, target, attrs)
+        format = target || "metanorma"
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs[1]).convert
+        %{<passthrough formats="#{format}">#{out}</passthrough>}
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/macros_note.rb

@@ -0,0 +1,45 @@
+module Asciidoctor
+  module Standoc
+    class ToDoAdmonitionBlock < Extensions::BlockProcessor
+      use_dsl
+      named :TODO
+      on_contexts :example, :paragraph
+
+      def process(parent, reader, attrs)
+        attrs["name"] = "todo"
+        attrs["caption"] = "TODO"
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
+      end
+    end
+
+    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
+      def process(document)
+        (document.find_by context: :paragraph).each do |para|
+          next unless /^TODO: /.match? para.lines[0]
+
+          parent = para.parent
+          para.set_attr("name", "todo")
+          para.set_attr("caption", "TODO")
+          para.lines[0].sub!(/^TODO: /, "")
+          todo = Block.new(parent, :admonition, attributes: para.attributes,
+                                                source: para.lines,
+                                                content_model: :compound)
+          parent.blocks[parent.blocks.index(para)] = todo
+        end
+      end
+    end
+
+    class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :footnoteblock
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<footnoteblock>#{out}</footnoteblock>}
+      end
+    end
+  end
+end

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,30 @@ 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/reqt.rng

@@ -58,6 +58,14 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -101,7 +109,9 @@
   </define>
   <define name="label">
     <element name="label">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="subject">
@@ -175,8 +185,19 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
-      <ref name="BasicBlock"/>
+      <choice>
+        <ref name="BasicBlock"/>
+        <ref name="component"/>
+      </choice>
     </oneOrMore>
   </define>
   <define name="ObligationType">

data/lib/asciidoctor/standoc/table.rb

@@ -2,15 +2,15 @@ module Asciidoctor
   module Standoc
     module Table
       def table_attrs(node)
-        keep_attrs(node).merge( id: Metanorma::Utils::anchor_or_uuid(node),
-          headerrows: node.attr("headerrows"),
-          unnumbered: node.option?("unnumbered") ? "true" : nil,
-          number: node.attr("number"),
-          subsequence: node.attr("subsequence"),
-          alt: node.attr("alt"),
-          summary: node.attr("summary"),
-          width: node.attr("width"),
-        )
+        keep_attrs(node)
+          .merge(id: Metanorma::Utils::anchor_or_uuid(node),
+                 headerrows: node.attr("headerrows"),
+                 unnumbered: node.option?("unnumbered") ? "true" : nil,
+                 number: node.attr("number"),
+                 subsequence: node.attr("subsequence"),
+                 alt: node.attr("alt"),
+                 summary: node.attr("summary"),
+                 width: node.attr("width"))
       end
 
       def table(node)
@@ -31,8 +31,10 @@ module Asciidoctor
 
       def colgroup(node, xml_table)
         return if node.option? "autowidth"
+
         cols = node&.attr("cols")&.split(/,/) or return
-        return unless cols.size > 1 and cols.all? { |c| /\d/.match(c) }
+        return unless (cols.size > 1) && cols.all? { |c| /\d/.match(c) }
+
         xml_table.colgroup do |cg|
           node.columns.each do |col|
             cg.col **{ width: "#{col.attr 'colpcwidth'}%" }
@@ -49,21 +51,21 @@ module Asciidoctor
       end
 
       def table_cell1(cell, thd)
-        if cell.style == :asciidoc
-          thd << cell.content
-        else
-          thd << cell.text
-        end
+        thd << if cell.style == :asciidoc
+                 cell.content
+               else
+                 cell.text
+               end
       end
 
-      def table_cell(c, xml_tr, tblsec)
+      def table_cell(node, xml_tr, tblsec)
         cell_attributes =
-          { id: c.id, colspan: c.colspan, valign: c.attr("valign"),
-            rowspan: c.rowspan, align: c.attr("halign") }
+          { id: node.id, colspan: node.colspan, valign: node.attr("valign"),
+            rowspan: node.rowspan, align: node.attr("halign") }
         cell_tag = "td"
-        cell_tag = "th" if tblsec == :head || c.style == :header
+        cell_tag = "th" if tblsec == :head || node.style == :header
         xml_tr.send cell_tag, **attr_code(cell_attributes) do |thd|
-          table_cell1(c, thd)
+          table_cell1(node, thd)
         end
       end
 

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/asciidoctor/standoc/validate.rb

@@ -8,7 +8,7 @@ module Asciidoctor
   module Standoc
     module Validate
       SOURCELOCALITY = "./termsource/origin//locality[@type = 'clause']/"\
-        "referenceFrom".freeze
+                       "referenceFrom".freeze
 
       def init_iev
         return nil if @no_isobib
@@ -34,11 +34,14 @@ module Asciidoctor
       end
 
       def content_validate(doc)
+        @fatalerror = []
+        xref_validate(doc)
         section_validate(doc)
         norm_ref_validate(doc)
         repeat_id_validate(doc.root)
         iev_validate(doc.root)
         concept_validate(doc)
+        @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
       end
 
       def norm_ref_validate(doc)
@@ -51,8 +54,7 @@ module Asciidoctor
                    "Numeric reference in normative references")
           found = true
         end
-        found and
-          clean_abort("Numeric reference in normative references", doc.to_xml)
+        found and @fatalerror << "Numeric reference in normative references"
       end
 
       def concept_validate(doc)
@@ -62,19 +64,19 @@ module Asciidoctor
           next if doc.at("//definitions//dt[@id = '#{x['target']}']")
 
           ref = x&.at("../refterm")&.text
-          @log.add("Anchors", x, "Concept #{ref} is pointing to "\
+          @log.add("Anchors", x,
+                   "Concept #{ref} is pointing to "\
                    "#{x['target']}, which is not a term or symbol")
           found = true
         end
-        found and clean_abort("Concept not cross-referencing term or symbol",
-                              doc.to_xml)
+        found and @fatalerror << "Concept not cross-referencing term or symbol"
       end
 
       def repeat_id_validate1(ids, elem)
         if ids[elem["id"]]
           @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\
-                   "used at line #{ids[elem['id']]}")
-          raise StandardError.new "Error: multiple instances of same ID"
+                                    "used at line #{ids[elem['id']]}")
+          @fatalerror << "Multiple instances of same ID: #{elem['id']}"
         else
           ids[elem["id"]] = elem.line
         end
@@ -83,12 +85,8 @@ module Asciidoctor
 
       def repeat_id_validate(doc)
         ids = {}
-        begin
-          doc.xpath("//*[@id]").each do |x|
-            ids = repeat_id_validate1(ids, x)
-          end
-        rescue StandardError => e
-          clean_abort(e.message, doc.to_xml)
+        doc.xpath("//*[@id]").each do |x|
+          ids = repeat_id_validate1(ids, x)
         end
       end
 
@@ -130,6 +128,17 @@ module Asciidoctor
         doc
       end
 
+      # manually check for xref/@target, xref/@to integrity
+      def xref_validate(doc)
+        ids = doc.xpath("//*/@id").each_with_object({}) { |x, m| m[x.text] = 1 }
+        doc.xpath("//xref/@target | //xref/@to").each do |x|
+          next if ids[x.text]
+
+          @log.add("Anchors", x.parent,
+                   "Crossreference target #{x.text} is undefined")
+        end
+      end
+
       def validate(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),

data/lib/asciidoctor/standoc/validate_section.rb

@@ -14,7 +14,8 @@ module Asciidoctor
           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")
+            @log.add("AsciiDoc Input", x,
+                     "mismatch of callouts and annotations")
           end
         end
       end
@@ -42,7 +43,9 @@ module Asciidoctor
         root.xpath("//clause | //annex | //foreword | //introduction | "\
                    "//acknowledgements").each do |c|
           next unless c.at("./clause")
-          next if c.elements.reject { |n| %w(clause title).include? n.name }.empty?
+          next if c.elements.reject do |n|
+                    %w(clause title).include? n.name
+                  end.empty?
 
           style_warning(c, "Hanging paragraph in clause")
         end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.4.1".freeze
+    VERSION = "1.10.8".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-utils", "~> 1.2.0"
-  spec.add_dependency "relaton-cli", "~> 1.8.0"
+  spec.add_dependency "relaton-cli", "~> 1.9.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 

data/spec/asciidoctor/base_spec.rb

@@ -6,39 +6,6 @@ RSpec.describe Asciidoctor::Standoc do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
 
-  it "processes a blank document" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "converts a blank document" do
-    FileUtils.rm_f "test.doc"
-    input = <<~INPUT
-      = Document title
-      Author
-      :docfile: test.adoc
-      :novalid:
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-    expect(File.exist?("test.doc")).to be true
-    expect(File.exist?("test.pdf")).to be true
-    expect(File.exist?("htmlstyle.css")).to be false
-  end
-
   it "assigns default scripts to major languages" do
     FileUtils.rm_f "test.doc"
     input = <<~INPUT

data/spec/asciidoctor/blank_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::Standoc do
+  it "processes a blank document" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "converts a blank document" do
+    FileUtils.rm_f "test.doc"
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :novalid:
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+    expect(File.exist?("test.doc")).to be true
+    expect(File.exist?("test.pdf")).to be true
+    expect(File.exist?("htmlstyle.css")).to be false
+  end
+end