metanorma-standoc 1.9.4 → 1.10.3

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "pathname"
-require "open-uri"
 require "html2doc"
 require "asciimath2unitsml"
 require_relative "./cleanup_block"

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -149,7 +149,14 @@ module Asciidoctor
         end
       end
 
+      def bibitem_nested_id(xmldoc)
+        xmldoc.xpath("//bibitem//bibitem").each do |b|
+          b.delete("id")
+        end
+      end
+
       def bibitem_cleanup(xmldoc)
+        bibitem_nested_id(xmldoc)
         ref_dl_cleanup(xmldoc)
         fetch_local_bibitem(xmldoc)
       end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -1,7 +1,6 @@
 require "date"
 require "htmlentities"
 require "json"
-require "open-uri"
 require "mathml2asciimath"
 require_relative "cleanup_section_names"
 

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -60,15 +60,15 @@ module Asciidoctor
 
       def term_children_cleanup(xmldoc)
         xmldoc.xpath("//term").each do |t|
-          t.xpath("./termnote").each { |n| t << n.remove }
-          t.xpath("./termexample").each { |n| t << n.remove }
-          t.xpath("./termsource").each { |n| t << n.remove }
+          %w(termnote termexample termsource).each do |w|
+            t.xpath("./#{w}").each { |n| t << n.remove }
+          end
         end
-      end 
+      end
 
       def termdef_from_termbase(xmldoc)
         xmldoc.xpath("//term").each do |x|
-          if c = x.at("./origin/termref") and !x.at("./definition")
+          if (c = x.at("./origin/termref")) && !x.at("./definition")
             x.at("./origin").previous = fetch_termbase(c["base"], c.text)
           end
         end
@@ -93,33 +93,34 @@ module Asciidoctor
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
-        term_children_cleanup(xmldoc) 
+        term_children_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
-      end   
+      end
 
       # Indices sort after letter but before any following
       # letter (x, x_m, x_1, xa); we use colon to force that sort order.
       # Numbers sort *after* letters; we use thorn to force that sort order.
-      def symbol_key(x)
-        key = x.dup
+      def symbol_key(sym)
+        key = sym.dup
         key.traverse do |n|
           next unless n.name == "math"
+
           n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
         end
         ret = Nokogiri::XML(key.to_xml)
-        HTMLEntities.new.decode(ret.text.downcase).
-          gsub(/[\[\]\{\}<>\(\)]/, "").gsub(/\s/m, "").
-          gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "").
-          gsub(/[0-9]+/, "þ\\0")
+        HTMLEntities.new.decode(ret.text.downcase)
+          .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
+          .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "")
+          .gsub(/[0-9]+/, "þ\\0")
       end
-        
+
       def grkletters(x)
         x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
       end
 
-      def extract_symbols_list(dl)
+      def extract_symbols_list(dlist)
         dl_out = []
-        dl.xpath("./dt | ./dd").each do |dtd|
+        dlist.xpath("./dt | ./dd").each do |dtd|
           if dtd.name == "dt"
             dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
           else
@@ -128,7 +129,7 @@ module Asciidoctor
         end
         dl_out
       end
-          
+
       def symbols_cleanup(docxml)
         docxml.xpath("//definitions/dl").each do |dl|
           dl_out = extract_symbols_list(dl)
@@ -136,7 +137,7 @@ module Asciidoctor
           dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
         end
         docxml
-      end 
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/converter.rb

@@ -37,6 +37,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::VariantInlineMacro
         inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
+        inline_macro Asciidoctor::Standoc::SymbolRefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         inline_macro Asciidoctor::Standoc::AddMacro
@@ -46,6 +47,8 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::FormTextareaMacro
         inline_macro Asciidoctor::Standoc::FormSelectMacro
         inline_macro Asciidoctor::Standoc::FormOptionMacro
+        inline_macro Asciidoctor::Standoc::ToCInlineMacro
+        block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro

data/lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'erb'
-require 'asciidoctor/standoc/datamodel/plantuml_renderer'
+require "erb"
+require "asciidoctor/standoc/datamodel/plantuml_renderer"
 
 module Asciidoctor
   module Standoc
     module Datamodel
       class DiagramPreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/
-        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/
-        TEMPLATES_PATH = File.expand_path('../views/datamodel', __dir__).freeze
+        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
+        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
+        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/.freeze
+        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
         # search document for block `datamodel_diagram`
         #  read include derectives that goes after that in block and transform
         #  into plantuml block
@@ -33,7 +33,7 @@ module Asciidoctor
         end
 
         def parse_datamodel_marco(yaml_path, include_path, document)
-          include_path ||= File.join(File.dirname(yaml_path), '..', 'models')
+          include_path ||= File.join(File.dirname(yaml_path), "..", "models")
           include_path = yaml_relative_path(include_path, document)
           yaml_relative_to_doc_path = yaml_relative_path(yaml_path, document)
           view_hash = YAML.safe_load(File.read(yaml_relative_to_doc_path))
@@ -43,7 +43,7 @@ module Asciidoctor
         end
 
         def yaml_relative_path(file_path, document)
-          docfile = document.attributes['docfile'] || '.'
+          docfile = document.attributes["docfile"] || "."
           docfile_directory = File.dirname(docfile)
           document.path_resolver.system_path(file_path, docfile_directory)
         end
@@ -51,11 +51,11 @@ module Asciidoctor
         def import_format(include_path, import_name, values)
           include_content = File.read(File.join(
                                         include_path,
-                                        "#{import_name}.yml"
-          ))
+                                        "#{import_name}.yml",
+                                      ))
           content = YAML.safe_load(include_content)
           if values
-            content['skipSection'] = values['skipSection']
+            content["skipSection"] = values["skipSection"]
           end
           content
         end
@@ -63,36 +63,37 @@ module Asciidoctor
         def format_import_directives(imports, include_path)
           imports
             .each_with_object({}) do |(import_name, values), res|
-              full_model_name = import_name.split('/').join
+              full_model_name = import_name.split("/").join
               content = import_format(include_path, import_name, values)
-              res[content['name'] || full_model_name] = content
+              res[content["name"] || full_model_name] = content
             end.compact
         end
 
         def prepare_view_hash(view_hash, all_imports)
           view_hash.merge!(
-            'classes' => model_type(all_imports, 'class'),
-            'enums' => model_type(all_imports, 'enum'),
-            'relations' => view_hash['relations'] || [],
-            'fidelity' => (view_hash['fidelity'] || {})
-                          .merge!('classes' => model_type(all_imports, 'class'))
+            "classes" => model_type(all_imports, "class"),
+            "enums" => model_type(all_imports, "enum"),
+            "relations" => view_hash["relations"] || [],
+            "fidelity" => (view_hash["fidelity"] || {})
+                          .merge!("classes" => model_type(all_imports,
+                                                          "class")),
           )
         end
 
         def model_type(imports, type)
           imports
             .select do |_name, elem|
-              elem['modelType'] == type
+              elem["modelType"] == type
             end
         end
 
         def plantuml_representations(view_hash, view_path, include_path)
           yaml_directory = File.dirname(view_path)
-          all_imports = format_import_directives(view_hash['imports'],
+          all_imports = format_import_directives(view_hash["imports"],
                                                  include_path)
           prepare_view_hash(view_hash, all_imports)
           Asciidoctor::Datamodel::PlantumlRenderer
-            .new(view_hash, File.join(yaml_directory, '..'))
+            .new(view_hash, File.join(yaml_directory, ".."))
             .render
             .split("\n")
         end

data/lib/asciidoctor/standoc/front.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require_relative "./front_contributor"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require "csv"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/inline.rb

@@ -46,13 +46,13 @@ 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)
@@ -115,12 +115,12 @@ module Asciidoctor
 
       def xml_encode(text)
         HTMLEntities.new.encode(text, :basic, :hexadecimal)
-          .gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&")
+          .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
@@ -134,16 +134,19 @@ module Asciidoctor
           <([^:>&]+:)?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 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
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -204,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">
@@ -899,7 +911,7 @@
   </include>
   <!-- end overrides -->
   <define name="docsubtype">
-    <element name="docsubtype">
+    <element name="subdoctype">
       <ref name="DocumentSubtype"/>
     </element>
   </define>
@@ -955,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"/>
@@ -981,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1212,6 +1254,12 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
     <text/>
   </define>
   <define name="ics">
@@ -1473,26 +1521,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

@@ -2,6 +2,7 @@ require "asciidoctor/extensions"
 require "fileutils"
 require "uuidtools"
 require "yaml"
+require "csv"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
@@ -75,7 +76,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 +108,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 +144,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 +169,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
 
@@ -209,5 +212,22 @@ module Asciidoctor
         %{<del>#{out}</del>}
       end
     end
+
+    class ToCInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :toc
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        content = CSV.parse_line(out).map do |x|
+          x.sub!(/^(["'])(.+)\1/, "\\2")
+          m = /^(.*?)(:\d+)?$/.match(x)
+          %{<toc-xpath depth='#{m[2]&.sub(/:/, '') || 1}'>#{m[1]}</toc-xpath>}
+        end.join
+        "<toc>#{content}</toc>"
+      end
+    end
   end
 end