metanorma-standoc 1.4.4 → 1.6.0

data/lib/asciidoctor/standoc/inline.rb

@@ -3,7 +3,8 @@ require "htmlentities"
 require "unicode2latex"
 require "mime/types"
 require "base64"
-require 'English'
+require "English"
+require "latexmath"
 
 module Asciidoctor
   module Standoc
@@ -32,18 +33,28 @@ module Asciidoctor
       end
 
       def inline_anchor_xref(node)
-        m = /^(?<case>capital%|lowercase%)?(?<fn>fn(:\s*(?<text>.*))?)?$/.match node.text
-        casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
-        f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"
-        c = (!m.nil? && (!m[:fn].nil? || !m[:case].nil?)) ? m[:text] : node.text
-        t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
         noko do |xml|
-          xml.xref **attr_code(target: t, type: f, case: casing) do |x|
+          attrs = inline_anchor_xref_attrs(node)
+          c = attrs[:text]
+          attrs.delete(:text) unless c.nil?
+          xml.xref **attr_code(attrs) do |x|
             x << c
           end
         end.join
       end
 
+      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 }
+      end
+
       def inline_anchor_link(node)
         contents = node.text
         contents = "" if node.target.gsub(%r{^mailto:}, "") == node.text
@@ -105,33 +116,12 @@ module Asciidoctor
         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")
-      end
-
-      def latex_run1(lxm_input, cmd)
-        IO.popen(cmd, "r+", external_encoding: "UTF-8") do |io|
-          io.write(lxm_input)
-          io.close_write
-          io.read
-        end
-      end
-
-      def latex_run(lxm_input)
-        results = nil
-        Metanorma::Standoc::Requirements[:latexml].cmd.each_with_index do |cmd, i|
-          warn "Retrying with #{cmd}" if i > 0
-          results = latex_run1(lxm_input, cmd)
-          if $CHILD_STATUS.to_i.zero?
-            warn "Success!" if i > 0
-            break
-          end
-        end
-        $CHILD_STATUS.to_i.zero? ? results : nil
+          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
       end
 
       def latex_parse(text)
         lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
-        results = latex_run(lxm_input)
+        results = Latexmath.parse(lxm_input).to_mathml
         results.nil? and
           @log.add('Math', nil,
                    "latexmlmath failed to process equation:\n#{lxm_input}")
@@ -151,7 +141,7 @@ module Asciidoctor
             s.parent.children = math
           end
         else
-          xml.stem text, **{ type: "AsciiMath" }
+          xml.stem text&.gsub(/\&amp;#/, "&#"), **{ type: "AsciiMath" }
         end
       end
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +717,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +864,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +892,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +959,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1001,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1029,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1051,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1079,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1223,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1493,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1542,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/standoc/json2_text_preprocessor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "asciidoctor/standoc/base_structured_text_preprocessor"
+
+module Asciidoctor
+  module Standoc
+    class Json2TextPreprocessor < BaseStructuredTextPreprocessor
+      # search document for block `yaml2text`
+      #   after that take template from block and read file into this template
+      #   example:
+      #     [yaml2text,foobar.yaml]
+      #     ----
+      #     === {item.name}
+      #     {item.desc}
+      #
+      #     {item.symbol}:: {item.symbol_def}
+      #     ----
+      #
+      #   with content of `foobar.yaml` file equal to:
+      #     - name: spaghetti
+      #       desc: wheat noodles of 9mm diameter
+      #       symbol: SPAG
+      #       symbol_def: the situation is message like spaghetti at a kid's
+      #
+      #   will produce:
+      #     === spaghetti
+      #     wheat noodles of 9mm diameter
+      #
+      #     SPAG:: the situation is message like spaghetti at a kid's meal
+
+      def initialize(config = {})
+        super
+        @config[:block_name] = "json2text"
+      end
+
+      protected
+
+      def content_from_file(document, file_path)
+        JSON.parse(File.read(relative_file_path(document, file_path),
+          encoding: "UTF-8"))
+      end
+    end
+  end
+end

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,12 @@
 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_relative "./yaml2_text_preprocessor.rb"
+require_relative "./json2_text_preprocessor.rb"
 
 module Asciidoctor
   module Standoc
@@ -61,17 +62,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 +95,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 +129,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 +154,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 +171,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