metanorma-standoc 1.9.3 → 1.10.2

data/lib/asciidoctor/standoc/inline.rb

@@ -9,8 +9,8 @@ require "latexmath"
 module Asciidoctor
   module Standoc
     module Inline
-      def refid?(x)
-        @refids.include? x
+      def refid?(ref)
+        @refids.include? ref
       end
 
       def inline_anchor(node)
@@ -46,19 +46,20 @@ module Asciidoctor
       def inline_anchor_xref_attrs(node)
         m = /^(?<drop>droploc%)?(?<case>capital%|lowercase%)?(?<drop2>droploc%)?
           (?<fn>fn:?\s*)?(?<text>.*)$/x.match node.text
-        casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
-        droploc = m.nil? ? nil : ((m[:drop].nil? && m[:drop2].nil?) ? nil: true)
-        f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"
-        c = (!m.nil? && (%i[case fn drop drop2].any? { |x| !m[x].nil? })) ?
-          m[:text] : node.text
         t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
-        { target: t, type: f, case: casing, droploc: droploc, text: c }
+        m.nil? and return { target: t, type: "inline", text: node.text }
+        droploc = m[:drop].nil? && m[:drop2].nil? ? nil : true
+        f = m[:fn].nil? ? "inline" : "footnote"
+        c = %i[case fn drop drop2].any? { |x| !m[x].nil? } ? m[:text] : node.text
+        { target: t, type: f, case: m[:case]&.sub(/%$/, ""), droploc: droploc,
+          text: c }
       end
 
       def inline_anchor_link(node)
         contents = node.text
         contents = "" if node.target.gsub(%r{^mailto:}, "") == node.text
-        attributes = { "target": node.target, "alt": node.attr("title") }
+        attributes = { "target": node.target, "alt": node.attr("title"),
+                       "updatetype": node.attr("updatetype") }
         noko do |xml|
           xml.link **attr_code(attributes) do |l|
             l << contents
@@ -67,8 +68,8 @@ module Asciidoctor
       end
 
       def inline_anchor_bibref(node)
-        eref_contents = (node.text || node.target || node.id)&.
-          sub(/^\[?([^\[\]]+?)\]?$/, "[\\1]")
+        eref_contents = (node.text || node.target || node.id)
+          &.sub(/^\[?([^\[\]]+?)\]?$/, "[\\1]")
         eref_attributes = { id: node.target || node.id }
         @refids << (node.target || node.id)
         noko do |xml|
@@ -105,7 +106,7 @@ module Asciidoctor
         attrs = {}
         node.option?("landscape") and attrs[:orientation] = "landscape"
         node.option?("portrait") and attrs[:orientation] = "portrait"
-        noko { |xml| xml.pagebreak **attr_code(attrs)}.join
+        noko { |xml| xml.pagebreak **attr_code(attrs) }.join
       end
 
       def thematic_break(_node)
@@ -113,41 +114,45 @@ module Asciidoctor
       end
 
       def xml_encode(text)
-        HTMLEntities.new.encode(text, :basic, :hexadecimal).
-          gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&").
-          gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&").
-          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
+        HTMLEntities.new.encode(text, :basic, :hexadecimal)
+          .gsub(/&amp;gt;/, ">").gsub(/&amp;lt;/, "<").gsub(/&amp;amp;/, "&")
+          .gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&")
+          .gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
       end
 
-      def latex_parse(text)
+      def latex_parse1(text)
         lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
         results = Latexmath.parse(lxm_input).to_mathml
         results.nil? and
-          @log.add('Math', nil,
+          @log.add("Math", nil,
                    "latexmlmath failed to process equation:\n#{lxm_input}")
         results&.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
       end
 
       def stem_parse(text, xml, style)
         if /&lt;([^:>&]+:)?math(\s+[^>&]+)?&gt; |
-          <([^:>&]+:)?math(\s+[^>&]+)?>/x.match text
+          <([^:>&]+:)?math(\s+[^>&]+)?>/x.match? text
           math = xml_encode(text)
           xml.stem math, **{ type: "MathML" }
-        elsif style == :latexmath
-          latex = latex_parse(text) or return xml.stem **{ type: "MathML" }
-          xml.stem **{ type: "MathML" } do |s|
-            math = Nokogiri::XML.fragment(latex.sub(/<\?[^>]+>/, "")).elements[0]
-            math.delete("alttext")
-            s.parent.children = math
-          end
+        elsif style == :latexmath then latex_parse(text, xml)
         else
-          xml.stem text&.gsub(/\&amp;#/, "&#"), **{ type: "AsciiMath" }
+          xml.stem text&.gsub(/&amp;#/, "&#"), **{ type: "AsciiMath" }
         end
       end
 
-        def highlight_parse(text, xml)
-          xml << text
+      def latex_parse(text, xml)
+        latex = latex_parse1(text) or return xml.stem **{ type: "MathML" }
+        xml.stem **{ type: "MathML" } do |s|
+          math = Nokogiri::XML.fragment(latex.sub(/<\?[^>]+>/, ""))
+            .elements[0]
+          math.delete("alttext")
+          s.parent.children = math
         end
+      end
+
+      def highlight_parse(text, xml)
+        xml << text
+      end
 
       def inline_quoted(node)
         noko do |xml|
@@ -182,14 +187,20 @@ module Asciidoctor
 
       def image_attributes(node)
         uri = node.image_uri (node.attr("target") || node.target)
-        types = /^data:/.match(uri) ? Metanorma::Utils::datauri2mime(uri) : MIME::Types.type_for(uri)
+        types = if /^data:/.match?(uri) then Metanorma::Utils::datauri2mime(uri)
+                else MIME::Types.type_for(uri)
+                end
         type = types.first.to_s
         uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
-        attr_code(src: uri, 
+        image_attributes1(node, uri, type)
+      end
+
+      def image_attributes1(node, uri, type)
+        attr_code(src: uri,
                   id: Metanorma::Utils::anchor_or_uuid,
                   mimetype: type,
                   height: node.attr("height") || "auto",
-                  width: node.attr("width") || "auto" ,
+                  width: node.attr("width") || "auto",
                   filename: node.attr("filename"),
                   title: node.attr("titleattr"),
                   alt: node.alt == node.attr("default-alt") ? nil : node.alt)
@@ -197,14 +208,14 @@ module Asciidoctor
 
       def inline_image(node)
         noko do |xml|
-          xml.image **(image_attributes(node))
+          xml.image **image_attributes(node)
         end.join("")
       end
 
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-            terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
           xml.index do |i|
             i.primary { |x| x << terms[0] }
             a = terms.dig(1) and i.secondary { |x| x << a }

data/lib/asciidoctor/standoc/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -199,6 +204,18 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="dt">
+      <element name="dt">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -543,6 +560,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -890,6 +910,14 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="subdoctype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -939,7 +967,34 @@
   <define name="concept">
     <element name="concept">
       <optional>
-        <attribute name="term"/>
+        <attribute name="ital">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="ref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <element name="refterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="renderterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
       </optional>
       <choice>
         <ref name="eref"/>
@@ -965,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1457,26 +1515,26 @@
     <optional>
       <ref name="section-title"/>
     </optional>
-    <group>
+    <choice>
       <choice>
         <group>
-          <zeroOrMore>
+          <oneOrMore>
             <ref name="BasicBlock"/>
-          </zeroOrMore>
+          </oneOrMore>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>
         </group>
         <ref name="amend"/>
       </choice>
-      <zeroOrMore>
+      <oneOrMore>
         <choice>
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
         </choice>
-      </zeroOrMore>
-    </group>
+      </oneOrMore>
+    </choice>
   </define>
   <define name="Annex-Section">
     <optional>

data/lib/asciidoctor/standoc/macros.rb

@@ -75,7 +75,7 @@ module Asciidoctor
       def supply_br(lines)
         ignore = false
         lines.each_with_index do |l, i|
-          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/
+          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|````+|____\+)$/
             .match(l) && (ignore = !ignore)
           next if l.empty? || l.match(/ \+$/) || /^\[.*\]$/.match?(l) || ignore
           next if i == lines.size - 1 ||
@@ -107,7 +107,7 @@ module Asciidoctor
         if (attributes.size == 1) && attributes.key?("text")
           rt = attributes["text"]
         elsif (attributes.size == 2) && attributes.key?(1) &&
-          attributes.key?("rpbegin")
+            attributes.key?("rpbegin")
           rt = attributes[1] || ""
         else
           rpbegin = attributes["rpbegin"]
@@ -143,7 +143,7 @@ module Asciidoctor
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
           todo = Block.new(parent, :admonition, attributes: para.attributes,
-                           source: para.lines, content_model: :compound)
+                                                source: para.lines, content_model: :compound)
           parent.blocks[parent.blocks.index(para)] = todo
         end
       end
@@ -168,9 +168,11 @@ module Asciidoctor
       def process(parent, target, attrs)
         /^(?<lang>[^-]*)(-(?<script>.*))?$/ =~ target
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        script ?
-          %{<variant lang=#{lang} script=#{script}>#{out}</variant>} :
+        if script
+          %{<variant lang=#{lang} script=#{script}>#{out}</variant>}
+        else
           %{<variant lang=#{lang}>#{out}</variant>}
+        end
       end
     end
 

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -4,18 +4,17 @@ module Asciidoctor
       # 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 = 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
         raise "PlantUML not installed"
-        nil
       end
 
-      def self.run umlfile, outfile
+      def self.run(umlfile, outfile)
         system "plantuml #{umlfile.path}" or (warn $? and return false)
         i = 0
         until !Gem.win_platform? || File.exist?(outfile) || i == 15
@@ -29,9 +28,9 @@ module Asciidoctor
       # sleep need for windows because dot works in separate process and
       # plantuml process may finish earlier then dot, as result png file
       # maybe not created yet after plantuml finish
-      def self.generate_file parent, reader
+      def self.generate_file(parent, reader)
         localdir = Metanorma::Utils::localdir(parent.document)
-        imagesdir = parent.document.attr('imagesdir')
+        imagesdir = parent.document.attr("imagesdir")
         umlfile, outfile = save_plantuml parent, reader, localdir
         run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
@@ -40,7 +39,7 @@ module Asciidoctor
         File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
         path.mkpath
         File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
-        #File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
+        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
 
         # Warning: metanorma/metanorma-standoc#187
         # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
@@ -51,21 +50,21 @@ module Asciidoctor
         imagesdir ? filename : File.join(path, filename)
       end
 
-      def self.save_plantuml parent, reader, localdir
+      def self.save_plantuml(_parent, reader, _localdir)
         src = reader.source
         reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
           src = "@startuml\n#{src}\n@enduml\n"
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
-        Tempfile.open(["plantuml", ".pml"], :encoding => "utf-8") do |f|
+        Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
           f.write(src)
           [f, File.join(File.dirname(f.path),
-                        (fn || File.basename(f.path, ".pml")) + ".png")]
+                        "#{fn || File.basename(f.path, '.pml')}.png")]
         end
       end
 
-      def self.generate_attrs attrs
-        through_attrs = %w(id align float title role width height alt).
-          inject({}) do |memo, key|
+      def self.generate_attrs(attrs)
+        %w(id align float title role width height alt)
+          .inject({}) do |memo, key|
           memo[key] = attrs[key] if attrs.has_key? key
           memo
         end
@@ -81,19 +80,18 @@ module Asciidoctor
       def abort(parent, reader, attrs, msg)
         warn msg
         attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
+        create_listing_block parent, reader.source,
+                             (attrs.reject { |k, _v| k == 1 })
       end
 
       def process(parent, reader, attrs)
-        begin
-          PlantUMLBlockMacroBackend.plantuml_installed?
-          filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
-          through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
-          through_attrs["target"] = filename
-          create_image_block parent, through_attrs
-        rescue StandardError => e
-          abort(parent, reader, attrs, e.message)
-        end
+        PlantUMLBlockMacroBackend.plantuml_installed?
+        filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
+        through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
+        through_attrs["target"] = filename
+        create_image_block parent, through_attrs
+      rescue StandardError => e
+        abort(parent, reader, attrs, e.message)
       end
     end
   end

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -1,3 +1,5 @@
+require "csv"
+
 module Asciidoctor
   module Standoc
     class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
@@ -36,46 +38,81 @@ module Asciidoctor
       end
     end
 
-     # Macro to transform `term[X,Y]` into em, termxref xml
     class TermRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :term
-      name_positional_attributes 'name', 'termxref'
+      name_positional_attributes "name", "termxref"
+      using_format :short
+
+      def process(_parent, _target, attrs)
+        termref = attrs["termxref"] || attrs["name"]
+        "<concept type='term'><termxref>#{attrs['name']}</termxref>"\
+          "<renderterm>#{termref}</renderterm><xrefrender/></concept>"
+      end
+    end
+
+    class SymbolRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :symbol
+      name_positional_attributes "name", "termxref"
       using_format :short
 
       def process(_parent, _target, attrs)
-        termref = attrs['termxref'] || attrs['name']
-        "<em>#{attrs['name']}</em> (<termxref>#{termref}</termxref>)"
+        termref = attrs["termxref"] || attrs["name"]
+        "<concept type='symbol'><termxref>#{attrs['name']}</termxref>"\
+          "<renderterm>#{termref}</renderterm><xrefrender/></concept>"
       end
     end
 
+    # Possibilities:
+    # {{<<id>>, term}}
+    # {{<<id>>, term, text}}
+    # {{<<termbase:id>>, term}}
+    # {{<<termbase:id>>, term, text}}
+    # {{term}} equivalent to term:[term]
+    # {{term, text}} equivalent to term:[term, text]
+    # text may optionally be followed by crossreference-rendering, options=""
     class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :concept
-      name_positional_attributes "id", "word", "term"
-      # match %r{concept:(?<target>[^\[]*)\[(?<content>|.*?[^\\])\]$}
       match /\{\{(?<content>|.*?[^\\])\}\}/
       using_format :short
 
-      # deal with locality attrs and their disruption of positional attrs
-      def preprocess_attrs(attrs)
-        attrs.delete("term") if attrs["term"] && !attrs["word"]
-        attrs.delete(3) if attrs[3] == attrs["term"]
-        a = attrs.keys.reject { |k| k.is_a?(String) || [1, 2].include?(k) }
-        attrs["word"] ||= attrs[a[0]] if !a.empty?
-        attrs["term"] ||= attrs[a[1]] if a.length > 1
-        attrs
+      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=/, "")
+            .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
+          attrs = CSV.parse_line(m2[:rest]) || []
+        else
+          attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+        end
+        ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
+                  xrefrender: attrs[2])
+      end
+
+      def generate_attrs(opts)
+        ret = ""
+        opts.include?("noital") and ret += " ital='false'"
+        opts.include?("noref") and ret += " ref='false'"
+        opts.include?("ital") and ret += " ital='true'"
+        opts.include?("ref") and ret += " ref='true'"
+        ret
       end
 
-      def process(parent, _target, attr)
-        attr = preprocess_attrs(attr)
-        localities = attr.keys.reject { |k| %w(id word term).include? k }.
-          reject { |k| k.is_a? Numeric }.
-          map { |k| "#{k}=#{attr[k]}" }.join(",")
-        text = [localities, attr["word"]].reject{ |k| k.nil? || k.empty? }.
-          join(",")
-        out = Asciidoctor::Inline.new(parent, :quoted, text).convert
-        %{<concept key="#{attr['id']}" term="#{attr['term']}">#{out}</concept>}
+      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>"
       end
     end
   end