metanorma-standoc 1.9.2 → 1.10.1

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

data/lib/asciidoctor/standoc/section.rb

@@ -12,7 +12,7 @@ module Asciidoctor
       def sectiontype1(node)
         node&.attr("heading")&.downcase ||
           node.title.gsub(%r{<index>.*?</index>}m, "").gsub(/<[^>]+>/, "")
-          .strip.downcase
+            .strip.downcase
       end
 
       def sectiontype(node, level = true)
@@ -21,6 +21,7 @@ module Asciidoctor
         return ret1 if "symbols and abbreviated terms" == ret1
         return nil unless !level || node.level == 1
         return nil if @seen_headers.include? ret
+
         @seen_headers << ret
         ret1
       end
@@ -48,11 +49,14 @@ module Asciidoctor
                 script: node.attributes["script"],
                 number: node.attributes["number"],
                 type: node.attributes["type"],
-                annex: ( ((node.attr("style") == "appendix" || node.role == "appendix") && 
-                          node.level == 1) ? true : nil),
-                         preface: (
-                           (node.role == "preface" || node.attr("style") == "preface") ?  true : nil) }
+                annex: (if (node.attr("style") == "appendix" || node.role == "appendix") &&
+                          node.level == 1
+                          true
+                        end),
+                preface: (
+                           node.role == "preface" || node.attr("style") == "preface" ? true : nil) }
         return ret unless node.attributes["change"]
+
         ret.merge(change: node.attributes["change"],
                   path: node.attributes["path"],
                   path_end: node.attributes["path_end"],
@@ -75,7 +79,7 @@ module Asciidoctor
             symbols_parse(symbols_attrs(node, a), xml, node)
           when "acknowledgements"
             acknowledgements_parse(a, xml, node)
-          when "bibliography" 
+          when "bibliography"
             bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
@@ -88,9 +92,9 @@ module Asciidoctor
               bibliography_parse(a, xml, node)
             elsif node.attr("style") == "bibliography"
               bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "abstract" 
+            elsif node.attr("style") == "abstract"
               abstract_parse(a, xml, node)
-            elsif node.attr("style") == "index" 
+            elsif node.attr("style") == "index"
               indexsect_parse(a, xml, node)
             elsif node.attr("style") == "appendix" && node.level == 1
               annex_parse(a, xml, node)
@@ -102,10 +106,13 @@ module Asciidoctor
       end
 
       def set_obligation(attrs, node)
-        attrs[:obligation] = node.attributes.has_key?("obligation") ?
-          node.attr("obligation") :
-          node.parent.attributes.has_key?("obligation") ?
-          node.parent.attr("obligation") : "normative"
+        attrs[:obligation] = if node.attributes.has_key?("obligation")
+                               node.attr("obligation")
+                             elsif node.parent.attributes.has_key?("obligation")
+                               node.parent.attr("obligation")
+                             else
+                               "normative"
+                             end
       end
 
       def preamble(node)

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -3,81 +3,135 @@
 module Asciidoctor
   module Standoc
     # Intelligent term lookup xml modifier
-    # Lookup all `term` and `calause` tags and replace `termxref` tags with
-    # `xref`:target tag
     class TermLookupCleanup
-      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/
-      EXISTING_TERM_REGEXP = /\Aterm-/
+      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/.freeze
+      EXISTING_TERM_REGEXP = /\Aterm-/.freeze
+      EXISTING_SYMBOL_REGEXP = /\Asymbol-/.freeze
 
       attr_reader :xmldoc, :termlookup, :log
 
       def initialize(xmldoc, log)
         @xmldoc = xmldoc
         @log = log
-        @termlookup = {}
+        @termlookup = { term: {}, symbol: {} }
+        @idhash = {}
       end
 
       def call
+        @idhash = populate_idhash
         @termlookup = replace_automatic_generated_ids_terms
         set_termxref_tags_target
+        concept_cleanup
       end
 
       private
 
+      def concept_cleanup
+        xmldoc.xpath("//concept").each do |n|
+          n.delete("type")
+        end
+      end
+
+      def populate_idhash
+        xmldoc.xpath("//*[@id]").each_with_object({}) do |n, mem|
+          next unless /^(term|symbol)-/.match?(n["id"])
+
+          mem[n["id"]] = true
+        end
+      end
+
       def set_termxref_tags_target
-        xmldoc.xpath('//termxref').each do |node|
+        xmldoc.xpath("//termxref").each do |node|
           target = normalize_ref_id(node.text)
-          if termlookup[target].nil?
+          if termlookup[:term][target].nil? && termlookup[:symbol][target].nil?
             remove_missing_ref(node, target)
             next
           end
-          modify_ref_node(node, target)
+          x = node.at("../xrefrender")
+          modify_ref_node(x, target)
+          node.name = "refterm"
         end
       end
 
       def remove_missing_ref(node, target)
-        log.add('AsciiDoc Input', node,
+        if node.at("../concept[@type = 'symbol']")
+          remove_missing_ref_symbol(node, target)
+        else
+          remove_missing_ref_term(node, target)
+        end
+      end
+
+      def remove_missing_ref_term(node, target)
+        log.add("AsciiDoc Input", node,
                 %(Error: Term reference in `term[#{target}]` missing: \
                 "#{target}" is not defined in document))
-        term_name_node = node.previous.previous
-        term_name_node.remove
-        term_name_node.name = "strong"
-        term_name_node.children.first.content =
-          %(term "#{term_name_node.text}" not resolved)
-        node.add_previous_sibling(term_name_node)
-        node.remove
+        node.name = "strong"
+        node.at("../xrefrender").remove
+        display = node&.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display&.to_xml == node.text
+        d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
+        node.children = "term <tt>#{node.text}</tt>#{d} "\
+          "not resolved via ID <tt>#{target}</tt>"
+      end
+
+      def remove_missing_ref_symbol(node, target)
+        log.add("AsciiDoc Input", node,
+                %(Error: Symbol reference in `symbol[#{target}]` missing: \
+                "#{target}" is not defined in document))
+        node.name = "strong"
+        node.at("../xrefrender").remove
+        display = node&.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display&.to_xml == node.text
+        d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
+        node.children = "symbol <tt>#{node.text}</tt>#{d} "\
+          "not resolved via ID <tt>#{target}</tt>"
       end
 
       def modify_ref_node(node, target)
-        node.name = 'xref'
-        node['target'] = termlookup[target]
-        node.children.remove
-        node.remove_attribute('defaultref')
+        node.name = "xref"
+        s = termlookup[:symbol][target]
+        t = termlookup[:term][target]
+        type = node.parent["type"]
+        if type == "term" || !type && t
+          node["target"] = t
+        elsif type == "symbol" || !type && s
+          node["target"] = s
+        end
       end
 
       def replace_automatic_generated_ids_terms
-        xmldoc.xpath('//term').each.with_object({}) do |term_node, res|
-          normalize_id_and_memorize(term_node, res, './preferred')
+        r = xmldoc.xpath("//term").each.with_object({}) do |n, res|
+          normalize_id_and_memorize(n, res, "./preferred", "term")
         end
+        s = xmldoc.xpath("//definitions//dt").each.with_object({}) do |n, res|
+          normalize_id_and_memorize(n, res, ".", "symbol")
+        end
+        { term: r, symbol: s }
       end
 
-      def normalize_id_and_memorize(term_node, res_table, text_selector)
-        term_text = normalize_ref_id(term_node.at(text_selector).text)
-                  unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
-        term_node['id'] = unique_text_id(term_text)
-                  end
-        res_table[term_text] = term_node['id']
+      def normalize_id_and_memorize(node, res_table, text_selector, prefix)
+        term_text = normalize_ref_id(node.at(text_selector).text)
+        unless AUTOMATIC_GENERATED_ID_REGEXP.match(node["id"]).nil? &&
+            !node["id"].nil?
+          id = unique_text_id(term_text, prefix)
+          node["id"] = id
+          @idhash[id] = true
+        end
+        res_table[term_text] = node["id"]
       end
 
       def normalize_ref_id(text)
-        text.downcase.gsub(/[[:space:]]/, '-')
+        text.downcase.gsub(/[[:space:]]/, "-")
       end
 
-      def unique_text_id(text)
-        return "term-#{text}" if xmldoc.at("//*[@id = 'term-#{text}']").nil?
+      def unique_text_id(text, prefix)
+        unless @idhash["#{prefix}-#{text}"]
+          return "#{prefix}-#{text}"
+        end
+
         (1..Float::INFINITY).lazy.each do |index|
-          if xmldoc.at("//*[@id = 'term-#{text}-#{index}']").nil?
-            break("term-#{text}-#{index}")
+          unless @idhash["#{prefix}-#{text}-#{index}"]
+            break("#{prefix}-#{text}-#{index}")
           end
         end
       end