metanorma-standoc 1.5.1 → 1.6.2

data/lib/asciidoctor/standoc/log.rb

@@ -8,7 +8,8 @@ module Asciidoctor
       def add(category, loc, msg)
         return if @novalid
         @log[category] = [] unless @log[category]
-        @log[category] << { location: current_location(loc), message: msg }
+        @log[category] << { location: current_location(loc), message: msg,
+                            context: context(loc) }
         loc = loc.nil? ? "" : "(#{current_location(loc)}): "
         warn "#{category}: #{loc}#{msg}" 
       end
@@ -31,6 +32,13 @@ module Asciidoctor
         "??"
       end
 
+      def context(n)
+        return nil if n.is_a? String
+        n.respond_to?(:to_xml) and return n.to_xml
+        n.respond_to?(:to_s) and return n.to_s
+        nil
+      end
+
       def write(file)
         File.open(file, "w:UTF-8") do |f|
           f.puts "#{file} errors"
@@ -41,6 +49,7 @@ module Asciidoctor
             end.each do |n|
               loc = n[:location] ? "(#{n[:location]}): " : ""
               f.puts "#{loc}#{n[:message]}" 
+              n[:context]&.split(/\n/)&.first(5)&.each { |l| f.puts "\t#{l}" }
             end
           end
         end

data/lib/asciidoctor/standoc/macros.rb

@@ -1,11 +1,11 @@
 require "asciidoctor/extensions"
 require "fileutils"
 require "uuidtools"
-require 'yaml'
-require_relative './macros_plantuml.rb'
-require_relative './datamodel/attributes_table_preprocessor.rb'
-require_relative './datamodel/diagram_preprocessor.rb'
-require_relative './macros_yaml2text.rb'
+require "yaml"
+require_relative "./macros_plantuml.rb"
+require_relative "./datamodel/attributes_table_preprocessor.rb"
+require_relative "./datamodel/diagram_preprocessor.rb"
+require "metanorma-plugin-datastruct"
 
 module Asciidoctor
   module Standoc
@@ -61,17 +61,17 @@ module Asciidoctor
       use_dsl
       named :concept
       name_positional_attributes "id", "word", "term"
-      #match %r{concept:(?<target>[^\[]*)\[(?<content>|.*?[^\\])\]$}
+      # 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"] and !attrs["word"]
+        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 or [1, 2].include? k }
-        attrs["word"] ||= attrs[a[0]] if a.length() > 0
-        attrs["term"] ||= attrs[a[1]] if a.length() > 1
+        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
       end
 
@@ -94,30 +94,30 @@ module Asciidoctor
 
       def init_indent(s)
         /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
-        prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0").
-          gsub(/ /, "\u00a0")
+        prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0")
+          .gsub(/ /, "\u00a0")
         prefix + suffix
       end
 
       def supply_br(lines)
         ignore = false
         lines.each_with_index do |l, i|
-          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/.match(l) and
-            ignore = !ignore
+          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/.match(l) &&
+            (ignore = !ignore)
           next if l.empty? || l.match(/ \+$/)
           next if /^\[.*\]$/.match(l)
           next if ignore
-          next if i == lines.size - 1 || i < lines.size - 1 && lines[i+1].empty?
+          next if i == lines.size - 1 || i < lines.size - 1 && lines[i + 1].empty?
           lines[i] += " +"
         end
         lines
       end
 
-      def process parent, reader, attrs
-        attrs['role'] = 'pseudocode'
+      def process(parent, reader, attrs)
+        attrs["role"] = "pseudocode"
         lines = reader.lines.map { |m| init_indent(m) }
         ret = create_block(parent, :example, supply_br(lines),
-                     attrs, content_model: :compound)
+                           attrs, content_model: :compound)
         ret
       end
     end
@@ -128,19 +128,19 @@ module Asciidoctor
       parse_content_as :text
       option :pos_attrs, %w(rpbegin rt rpend)
 
-      def process(parent, target, attributes)
-        rpbegin = '('
-        rpend = ')'
-        if attributes.size == 1 and attributes.key?("text")
+      def process(_parent, target, attributes)
+        rpbegin = "("
+        rpend = ")"
+        if (attributes.size == 1) && attributes.key?("text")
           rt = attributes["text"]
-        elsif attributes.size == 2 and attributes.key?(1) and
-          attributes.key?("rpbegin")
+        elsif (attributes.size == 2) && attributes.key?(1) &&
+            attributes.key?("rpbegin")
           # for example, html5ruby:楽聖少女[がくせいしょうじょ]
           rt = attributes[1] || ""
         else
-          rpbegin = attributes['rpbegin']
-          rt = attributes['rt']
-          rpend = attributes['rpend']
+          rpbegin = attributes["rpbegin"]
+          rt = attributes["rt"]
+          rpend = attributes["rpend"]
         end
 
         "<ruby>#{target}<rp>#{rpbegin}</rp><rt>#{rt}</rt>"\
@@ -153,16 +153,16 @@ module Asciidoctor
       named :TODO
       on_contexts :example, :paragraph
 
-      def process parent, reader, attrs
-        attrs['name'] = 'todo'
-        attrs['caption'] = 'TODO'
+      def process(parent, reader, attrs)
+        attrs["name"] = "todo"
+        attrs["caption"] = "TODO"
         create_block parent, :admonition, reader.lines, attrs,
-          content_model: :compound
+                     content_model: :compound
       end
     end
 
     class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
-      def process document
+      def process(document)
         (document.find_by context: :paragraph).each do |para|
           next unless /^TODO: /.match para.lines[0]
           parent = para.parent
@@ -170,10 +170,21 @@ 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
     end
+
+    class AutonumberInlineMacro < Extensions::InlineMacroProcessor
+      use_dsl
+      named :autonumber
+      parse_content_as :text
+
+      def process(parent, target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<autonumber type=#{target}>#{out}</autonumber>}
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/ref.rb

@@ -42,8 +42,7 @@ module Asciidoctor
 
       def docid(t, code)
         type, code1 = /^\[\d+\]$|^\([^)]+\).*$/.match(code) ?
-          ["metanorma", mn_code(code)] :
-          @bibdb&.docid_type(code) || [nil, code]
+          ["metanorma", mn_code(code)] : @bibdb&.docid_type(code) || [nil, code]
         code1.sub!(/^nofetch\((.+)\)$/, "\\1")
         t.docidentifier **attr_code(type: type) do |d|
           d << code1
@@ -69,7 +68,8 @@ module Asciidoctor
 
       def isorefmatches(xml, m)
         yr = norm_year(m[:year])
-        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl]
+        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl],
+          lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           isorefrender1(t, m, yr)
@@ -82,8 +82,12 @@ module Asciidoctor
 
       def isorefmatches2(xml, m)
         ref = fetch_ref xml, m[:code], nil, no_year: true, note: m[:fn],
-          title: m[:text], usrlbl: m[:usrlbl]
+          title: m[:text], usrlbl: m[:usrlbl], lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
+        isorefmatches2_1(xml, m)
+      end
+
+      def isorefmatches2_1(xml, m)
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           isorefrender1(t, m, "--")
           t.date **{ type: "published" } do |d|
@@ -106,13 +110,15 @@ module Asciidoctor
 
       def isorefmatches3(xml, m)
         yr = norm_year(m[:year])
-        #hasyr =  m.names.include?("year") && yr != "--"
         hasyr = !yr.nil? && yr != "--"
-        #noyr =  m.names.include?("year") && yr == "--"
         ref = fetch_ref xml, m[:code], hasyr ? yr : nil, all_parts: true, 
-          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl]
+          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl],
+          lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
+        isorefmatches3_1(xml, m, yr, hasyr, ref)
+      end
 
+      def isorefmatches3_1(xml, m, yr, hasyr, ref)
         xml.bibitem(**attr_code(ref_attributes(m))) do |t|
           isorefrender1(t, m, yr, " (all parts)")
           conditional_date(t, m, yr == "--")
@@ -147,30 +153,24 @@ module Asciidoctor
       end
 
       MALFORMED_REF = "no anchor on reference, markup may be malformed: see "\
-        "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
-        "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
+        "https://www.metanorma.com/author/topics/document-format/"\
+        "bibliography/ , https://www.metanorma.com/author/iso/topics/markup/"\
+        "#bibliographies".freeze
 
       def analyse_ref_nofetch(ret)
         return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
-        ret[:id] = m[:id]
-        ret[:nofetch] = true
-        ret
+        ret.merge(id: m[:id], nofetch: true)
       end
 
       def analyse_ref_repo_path(ret)
         return ret unless m =
           /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
-        ret[:id] = m[:id]
-        ret[:type] = m[:type]
-        ret[:key] = m[:key]
-        ret[:nofetch] = true
-        ret
+        ret.merge(id: m[:id], type: m[:type], key: m[:key], nofetch: true)
       end
 
       def analyse_ref_numeric(ret)
         return ret unless /^\d+$/.match(ret[:id])
-        ret[:numeric] = true
-        ret
+        ret.merge(numeric: true)
       end
 
       # ref id = (usrlbl)code[:-]year
@@ -178,23 +178,22 @@ module Asciidoctor
       def analyse_ref_code(code)
         ret = {id: code}
         return ret if code.nil? || code.empty?
-        ret = analyse_ref_nofetch(ret)
-        ret = analyse_ref_repo_path(ret)
-        ret = analyse_ref_numeric(ret)
-        ret
+        analyse_ref_nofetch(analyse_ref_repo_path(analyse_ref_numeric(ret)))
       end
 
       # TODO: alternative where only title is available
       def refitem(xml, item, node)
-        unless m = NON_ISO_REF.match(item)
-          @log.add("AsciiDoc Input", node, "#{MALFORMED_REF}: #{item}")
-          return
-        end
+        m = NON_ISO_REF.match(item) and return refitem1(xml, item, m)
+        @log.add("AsciiDoc Input", node, "#{MALFORMED_REF}: #{item}")
+        nil
+      end
+
+      def refitem1(xml, item, m)
         code = analyse_ref_code(m[:code])
         unless code[:id] && code[:numeric] || code[:nofetch]
           ref = fetch_ref xml, code[:id],
             m.names.include?("year") ? m[:year] : nil, title: m[:text],
-            usrlbl: m[:usrlbl]
+            usrlbl: m[:usrlbl], lang: (@lang || :all)
           return use_my_anchor(ref, m[:anchor]) if ref
         end
         refitem_render(xml, m, code)
@@ -214,23 +213,25 @@ module Asciidoctor
         (?<text>.*)$}xm
 
         ISO_REF_NO_YEAR = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+):(--|\&\#821[12]\;)\]</ref>,?\s*
+      \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+):
+      (--|\&\#821[12]\;)\]</ref>,?\s*
         (<fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>)?,?\s?(?<text>.*)$}xm
 
         ISO_REF_ALL_PARTS = %r{^<ref\sid="(?<anchor>[^"]+)">
-        \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9]+)(:(?<year>--|\&\#821[12]\;|[0-9][0-9-]+))?\s
+        \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9]+)
+        (:(?<year>--|\&\#821[12]\;|[0-9][0-9-]+))?\s
         \(all\sparts\)\]</ref>,?\s*
           (<fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>,?\s?)?(?<text>.*)$}xm
 
           NON_ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
-        \[(?<usrlbl>\([^)]+\))?(?<code>[^\]]+?)([:-](?<year>(19|20)[0-9][0-9]))?\]</ref>,?\s*
-          (?<text>.*)$}xm
-
-          def reference1_matches(item)
-            matched = ISO_REF.match item
-            matched2 = ISO_REF_NO_YEAR.match item
-            matched3 = ISO_REF_ALL_PARTS.match item
-            [matched, matched2, matched3]
+        \[(?<usrlbl>\([^)]+\))?(?<code>[^\]]+?)
+        ([:-](?<year>(19|20)[0-9][0-9]))?\]</ref>,?\s*(?<text>.*)$}xm
+
+        def reference1_matches(item)
+          matched = ISO_REF.match item
+          matched2 = ISO_REF_NO_YEAR.match item
+          matched3 = ISO_REF_ALL_PARTS.match item
+          [matched, matched2, matched3]
         end
 
         def reference1(node, item, xml)
@@ -243,12 +244,6 @@ module Asciidoctor
           end
         end
 
-        def reference(node)
-          noko do |xml|
-            node.items.each { |item| reference1(node, item.text, xml) }
-          end.join
-        end
-
         def mn_code(code)
           code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
         end

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -9,6 +9,12 @@ module Asciidoctor
         @norm_ref
       end
 
+      def reference(node)
+          noko do |xml|
+            node.items.each { |item| reference1(node, item.text, xml) }
+          end.join
+        end
+
       def bibliography_parse(attrs, xml, node)
         node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
         node.attr("style") == "bibliography" or
@@ -58,10 +64,10 @@ module Asciidoctor
       def fetch_ref(xml, code, year, **opts)
         return nil if opts[:no_year]
         code = code.sub(/^\([^)]+\)/, "")
+        #require "byebug"; byebug if opts[:lang] == "fr"
         hit = @bibdb&.fetch(code, year, opts)
         return nil if hit.nil?
-        xml.parent.add_child(smart_render_xml(hit, code, opts[:title],
-                                              opts[:usrlbl]))
+        xml.parent.add_child(smart_render_xml(hit, code, opts))
         xml
       rescue RelatonBib::RequestError
         @log.add("Bibliography", nil, "Could not retrieve #{code}: "\
@@ -84,10 +90,11 @@ module Asciidoctor
           "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
       end
 
-      def smart_render_xml(x, code, title, usrlbl)
-        xstr = x.to_xml if x.respond_to? :to_xml
+      def smart_render_xml(x, code, opts)
+        x.respond_to? :to_xml or return nil
+        xstr = x.to_xml(lang: opts[:lang])
         xml = Nokogiri::XML(xstr)
-        emend_biblio(xml, code, title, usrlbl)
+        emend_biblio(xml, code, opts[:title], opts[:usrlbl])
         xml.xpath("//date").each { |d| Utils::endash_date(d) }
         xml.traverse do |n|
           n.text? and n.replace(Utils::smartformat(n.text))

data/lib/asciidoctor/standoc/section.rb

@@ -46,7 +46,7 @@ module Asciidoctor
       end
 
       def section_attributes(node)
-        { id: Utils::anchor_or_uuid(node),
+        ret = { id: Utils::anchor_or_uuid(node),
           language: node.attributes["language"],
           script: node.attributes["script"],
           annex: (
@@ -55,8 +55,12 @@ module Asciidoctor
           ),
           preface: (
             (node.role == "preface" || node.attr("style") == "preface") ?
-            true : nil),
-        }
+            true : nil) }
+        return ret unless node.attributes["change"]
+        ret.merge(change: node.attributes["change"],
+                  path: node.attributes["path"],
+                  path_end: node.attributes["path_end"],
+                  title: node.attributes["title"])
       end
 
       def section(node)
@@ -100,13 +104,10 @@ module Asciidoctor
       end
 
       def set_obligation(attrs, node)
-        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
+        attrs[:obligation] = node.attributes.has_key?("obligation") ?
+                               node.attr("obligation") :
+                             node.parent.attributes.has_key?("obligation") ?
+                               node.parent.attr("obligation") : "normative"
       end
 
       def preamble(node)

data/lib/asciidoctor/standoc/table.rb

@@ -45,8 +45,9 @@ module Asciidoctor
       end
 
       def table_cell(c, xml_tr, tblsec)
-        cell_attributes = { id: c.id, colspan: c.colspan,
-                            rowspan: c.rowspan, align: c.attr("halign") }
+        cell_attributes =
+          { id: c.id, colspan: c.colspan, valign: c.attr("valign"),
+            rowspan: c.rowspan, align: c.attr("halign") }
         cell_tag = "td"
         cell_tag = "th" if tblsec == :head || c.style == :header
         xml_tr.send cell_tag, **attr_code(cell_attributes) do |thd|

data/lib/asciidoctor/standoc/utils.rb

@@ -128,7 +128,8 @@ module Asciidoctor
         ::Nokogiri::XML::Builder.with fragment, &block
         fragment.to_xml(encoding: "US-ASCII", indent: 0).lines.map do |l|
           l.gsub(/>\n$/, ">").gsub(/\s*\n$/m, " ").gsub("–", "\u0096").
-            gsub("—", "\u0097")
+            gsub("—", "\u0097").gsub("–", "\u0096").
+            gsub("—", "\u0097")
         end
       end