metanorma-standoc 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 910ada4e6d4f62c6106391e3ec0de46a7ba4a9d5362bb103cd80ee0b2acef9dc
-  data.tar.gz: de8546c035da0236faa4a6ca5df9b0f54f16806d09386793f359e55b69884212
+  metadata.gz: 7503bfc7dd68c2d6a6b2ded8f08611e92067a15aa4088c02f1e5408ff8e027e6
+  data.tar.gz: 65cd5d4d3648788113fd30437fe8d649c6e498b9ebdab8d5b41d2fadb7439056
 SHA512:
-  metadata.gz: 422e64b66f95fa4c49727687c446bd3f79bc09aa0609b352bd68cc659ff06bf57243ed410e4baa8f0cb501f101212d305a756b41548fcee7e877135aea22e1f3
-  data.tar.gz: 97d6e164975997ecc396376abdaf2edad43c1f4fbfa601dbbc5f2f4d465747164350f500aaadc05f9fd6ed1e499925df7d74626fcde21a0578feeb50d607b84e
+  metadata.gz: 73510f7d926c6acf395377794a753cef6bb0f0658fb66c606df07e23548c17f010c7120b77765b388fb363a4309051fcf03a601d6ea95cf20aca6e4645b1c674
+  data.tar.gz: bae732755cc47dcae17e0d8ef01bcd35173c8941807b2d5844cf45f008f57c199977756d4fd15b0e3c8c558e73432dd9ba88be2b01f61b32cff180308adcd83d

data/lib/asciidoctor/standoc/base_structured_text_preprocessor.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "liquid/custom_blocks/key_iterator"
+require "liquid/custom_filters/values"
+
+Liquid::Template.register_tag("keyiterator", Liquid::CustomBlocks::KeyIterator)
+Liquid::Template.register_filter(Liquid::CustomFilters)
+
+module Asciidoctor
+  module Standoc
+    # Base class for processing structured data blocks(yaml, json)
+    class BaseStructuredTextPreprocessor < Asciidoctor::Extensions::Preprocessor
+      BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/
+      BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/
+
+      def process(document, reader)
+        input_lines = reader.readlines.to_enum
+        Reader.new(processed_lines(document, input_lines))
+      end
+
+      protected
+
+      def content_from_file(_document, _file_path)
+        raise ArgumentError, "Implement `content_from_file` in your class"
+      end
+
+      private
+
+      def processed_lines(document, input_lines)
+        result = []
+        loop do
+          result.push(*process_text_blocks(document, input_lines))
+        end
+        result
+      end
+
+      def relative_file_path(document, file_path)
+        docfile_directory = File.dirname(document.attributes["docfile"] || ".")
+        document
+          .path_resolver
+          .system_path(file_path, docfile_directory)
+      end
+
+      def process_text_blocks(document, input_lines)
+        line = input_lines.next
+        block_match = line.match(/^\[#{config[:block_name]},(.+?),(.+?)\]/)
+        return [line] if block_match.nil?
+
+        mark = input_lines.next
+        current_block = []
+        while (block_line = input_lines.next) != mark
+          current_block.push(block_line)
+        end
+        read_content_and_parse_template(document,
+                                        current_block,
+                                        block_match)
+      end
+
+      def read_content_and_parse_template(document, current_block, block_match)
+        transformed_liquid_lines = current_block
+          .map(&method(:transform_line_liquid))
+        context_items = content_from_file(document, block_match[1])
+        parse_context_block(document: document,
+                            context_lines: transformed_liquid_lines,
+                            context_items: context_items,
+                            context_name: block_match[2])
+      rescue StandardError => exception
+        document.logger
+          .warn("Failed to parse #{config[:block_name]} \
+            block: #{exception.message}")
+        []
+      end
+
+      def transform_line_liquid(line)
+        if line.match?(BLOCK_START_REGEXP)
+          line.gsub!(BLOCK_START_REGEXP,
+                     '{% keyiterator \1, \2 %}')
+        end
+
+        if line.strip.match?(BLOCK_END_REGEXP)
+          line.gsub!(BLOCK_END_REGEXP, "{% endkeyiterator %}")
+        end
+        line
+          .gsub(/(?<!{){(?!%)([^{}]+)(?<!%)}(?!})/, '{{\1}}')
+          .gsub(/[a-z\.]+\#/, "index")
+          .gsub(/{{(.+)\s+\+\s+(\d+)\s*?}}/, '{{ \1 | plus: \2 }}')
+          .gsub(/{{(.+)\s+\-\s+(\d+)\s*?}}/, '{{ \1 | minus: \2 }}')
+          .gsub(/{{(.+).values(.*?)}}/,
+                '{% assign custom_value = \1 | values %}{{custom_value\2}}')
+      end
+
+      def parse_context_block(context_lines:,
+                              context_items:,
+                              context_name:,
+                              document:)
+        render_result, errors = render_liquid_string(
+          template_string: context_lines.join("\n"),
+          context_items: context_items,
+          context_name: context_name
+        )
+        notify_render_errors(document, errors)
+        render_result.split("\n")
+      end
+
+      def render_liquid_string(template_string:, context_items:, context_name:)
+        liquid_template = Liquid::Template.parse(template_string)
+        rendered_string = liquid_template
+          .render(context_name => context_items,
+                  strict_variables: true,
+                  error_mode: :warn)
+        [rendered_string, liquid_template.errors]
+      end
+
+      def notify_render_errors(document, errors)
+        errors.each do |error_obj|
+          document
+            .logger
+            .warn("Liquid render error: #{error_obj.message}")
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -158,7 +158,17 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <ref name="paragraph"/>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="table"/>
+          <ref name="figure"/>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -402,6 +412,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>
           <ref name="TextElement"/>
@@ -429,6 +449,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>
           <ref name="TextElement"/>

data/lib/asciidoctor/standoc/cleanup.rb

@@ -9,6 +9,7 @@ require_relative "./cleanup_boilerplate.rb"
 require_relative "./cleanup_section.rb"
 require_relative "./cleanup_terms.rb"
 require_relative "./cleanup_inline.rb"
+require_relative "./cleanup_amend.rb"
 require "relaton_iev"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/cleanup_amend.rb

@@ -0,0 +1,54 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def change_clauses(x)
+        x.xpath("//clause[@change]").each do |c|
+          a = create_amend(c)
+        end
+      end
+
+      def create_amend(c)
+        a = c.add_child("<amend id='_#{UUIDTools::UUID.random_create}'/>").first
+        c.elements.each do |e|
+          e.parent = a unless %w(amend title).include? e.name
+        end
+        create_amend1(c, a)
+      end
+
+      def create_amend1(c, a)
+        create_amend2(c, a)
+        d = a.at("./description")
+        d.xpath(".//autonumber").each { |e| d.previous = e }
+        d.xpath(".//p[normalize-space(.)='']").each { |e| e.remove }
+        move_attrs_to_amend(c, a)
+        a
+      end
+
+      def create_amend2(c, a)
+        q = a.at("./quote") and q.name = "newcontent"
+        if q.nil?
+          a.children = "<description>#{a.children.to_xml}</description>"
+        else
+          pre = q&.xpath("./preceding-sibling::*")&.remove
+          post = q&.xpath("./following-sibling::*")&.remove
+          pre.empty? or a << "<description>#{pre.to_xml}</description>"
+          a << q.remove
+          post.empty? or a << "<description>#{post.to_xml}</description>"
+        end
+      end
+
+      def move_attrs_to_amend(c, a)
+        %w(change path path_end title).each do |e|
+          next unless c[e]
+          a[e] = c[e]
+          c.delete(e)
+        end
+        return unless a["locality"]
+        loc = a.children.add_previous_sibling("<location/>")
+        extract_localities1(loc, a["locality"])
+        loc1 = loc.at("./localityStack") and loc.replace(loc1.elements)
+        a.delete("locality")
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,8 +1,6 @@
 require "date"
-require "nokogiri"
 require "htmlentities"
 require "json"
-require "pathname"
 require "open-uri"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -1,10 +1,7 @@
 require "date"
-require "nokogiri"
 require "htmlentities"
 require "json"
-require "pathname"
 require "open-uri"
-require "pp"
 
 module Asciidoctor
   module Standoc

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -50,6 +50,10 @@ module Asciidoctor
 
       def extract_localities(x)
         text = x&.children&.first&.remove&.text
+        extract_localities1(x, text)
+      end
+
+      def extract_localities1(x, text)
         b = x.add_child("<localityStack/>").first if LOCALITY_RE.match text
         while (m = LOCALITY_RE.match text)
           ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
@@ -142,7 +146,8 @@ module Asciidoctor
         start = s[0]
         ret1 = %r([#{NAMECHAR}#]).match(start) ? "_" :
           (%r([#{NAMESTARTCHAR}#]).match(start) ? "_#{start}" : start)
-        ret = ret1 + s[1..-1].gsub(%r([#{NAMECHAR}#]), "_")
+        ret2 = s[1..-1] || ""
+        ret = (ret1 || "") + ret2.gsub(%r([#{NAMECHAR}#]), "_")
         ret
       end
 

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -1,8 +1,6 @@
 require "date"
-require "nokogiri"
 require "htmlentities"
 require "json"
-require "pathname"
 require "open-uri"
 require "mathml2asciimath"
 
@@ -107,6 +105,7 @@ module Asciidoctor
         sections_order_cleanup(x)
         sections_level_cleanup(x)
         sections_names_cleanup(x)
+        change_clauses(x)
       end
 
       def obligations_cleanup(x)

data/lib/asciidoctor/standoc/converter.rb

@@ -24,12 +24,14 @@ module Asciidoctor
         preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
         preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
+        preprocessor Asciidoctor::Standoc::Json2TextPreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
         inline_macro Asciidoctor::Standoc::InheritInlineMacro
         inline_macro Asciidoctor::Standoc::HTML5RubyMacro
         inline_macro Asciidoctor::Standoc::ConceptInlineMacro
+        inline_macro Asciidoctor::Standoc::AutonumberInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro
@@ -65,7 +67,7 @@ module Asciidoctor
         attr_accessor :_file
       end
 
-      def self.inherited( k )
+      def self.inherited(k)
         k._file = caller_locations.first.absolute_path
       end
 

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -52,18 +52,26 @@ module Asciidoctor
         end
       end
 
+      def personal_role(node, c, suffix)
+        c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
+      end
+
+      def personal_contact(node, suffix, p)
+        node.attr("phone#{suffix}") and p.phone node.attr("phone#{suffix}")
+        node.attr("fax#{suffix}") and
+          p.phone node.attr("fax#{suffix}"), **{type: "fax"}
+        node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
+        node.attr("contributor-uri#{suffix}") and
+          p.uri node.attr("contributor-uri#{suffix}")
+      end
+
       def personal_author1(node, xml, suffix)
         xml.contributor do |c|
-          c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
+          personal_role(node, c, suffix)
           c.person do |p|
             person_name(node, xml, suffix, p)
             person_affiliation(node, xml, suffix, p)
-            node.attr("phone#{suffix}") and p.phone node.attr("phone#{suffix}")
-            node.attr("fax#{suffix}") and
-              p.phone node.attr("fax#{suffix}"), **{type: "fax"}
-            node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
-            node.attr("contributor-uri#{suffix}") and
-              p.uri node.attr("contributor-uri#{suffix}")
+            personal_contact(node, suffix, p)
           end
         end
       end

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
@@ -108,6 +109,7 @@ module Asciidoctor
           gsub(/"/, '"').gsub(/
/, "\n")
       end
 
+=begin
       def latex_run1(lxm_input, cmd)
         IO.popen(cmd, "r+", external_encoding: "UTF-8") do |io|
           io.write(lxm_input)
@@ -137,6 +139,16 @@ module Asciidoctor
                    "latexmlmath failed to process equation:\n#{lxm_input}")
         results&.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
       end
+=end
+
+      def latex_parse(text)
+        lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
+        results = Latexmath.parse(lxm_input).to_mathml
+        results.nil? and
+          @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; |

data/lib/asciidoctor/standoc/isodoc.rng

@@ -581,6 +581,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -664,6 +666,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>
@@ -700,6 +712,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>
@@ -1052,14 +1074,17 @@
       <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"/>
@@ -1510,4 +1535,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>