metanorma-standoc 1.3.24 → 1.3.25

data/lib/asciidoctor/standoc/macros_yaml2text.rb

@@ -0,0 +1,142 @@
+require 'ostruct'
+
+module Asciidoctor
+  module Standoc
+    class YamlBlockStruct < OpenStruct
+      def to_a
+        @table.to_h.keys
+      end
+
+      def values
+        @table.to_h.values
+      end
+
+      def each
+        return to_a.each unless block_given?
+
+        to_a.each do |key|
+          yield(key)
+        end
+      end
+    end
+
+    class YamlContextRenderer
+      attr_reader :context_object, :context_name
+
+      def initialize(context_object:, context_name:)
+        @context_object = context_object
+        @context_name = context_name
+      end
+
+      def respond_to_missing?(name)
+        respond_to?(name)
+      end
+
+      def method_missing(name, *_args)
+        return context_object if name.to_s == context_name
+
+        super
+      end
+
+      def render(template)
+        ERB.new(template).result(binding)
+      end
+    end
+
+    class Yaml2TextPreprocessor < Asciidoctor::Extensions::Preprocessor
+      BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
+      BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
+      # 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 meal
+      #
+      #   will produce:
+      #     === spaghetti
+      #     wheat noodles of 9mm diameter
+      #
+      #     SPAG:: the situation is message like spaghetti at a kid's meal
+      def process(document, reader)
+        input_lines = reader.readlines.to_enum
+        Reader.new(processed_lines(document, input_lines))
+      end
+
+      private
+
+      def processed_lines(document, input_lines)
+        result = []
+        loop do
+          line = input_lines.next
+          if yaml_block_match = line.match(/^\[yaml2text,(.+?),(.+?)\]/)
+            mark = input_lines.next
+            current_yaml_block = []
+            while (yaml_block_line = input_lines.next) != mark
+              current_yaml_block.push(yaml_block_line)
+            end
+            content = nested_open_struct_from_yaml(yaml_block_match[1], document)
+            result.push(*
+              parse_blocks_recursively(lines: current_yaml_block,
+                                       attributes: content,
+                                       context_name: yaml_block_match[2]))
+          else
+            result.push(line)
+          end
+        end
+        result
+      end
+
+      def nested_open_struct_from_yaml(file_path, document)
+        docfile_directory = File.dirname(document.attributes['docfile'] || '.')
+        yaml_file_path = document.path_resolver.system_path(file_path, docfile_directory)
+        content = YAML.safe_load(File.read(yaml_file_path))
+        # Load content as json, then parse with JSON as nested open_struct
+        JSON.parse(content.to_json, object_class: YamlBlockStruct)
+      end
+
+      def parse_blocks_recursively(lines:,
+                                   attributes:,
+                                   context_name:,
+                                   parent_context: nil)
+        lines = lines.to_enum
+        result = []
+        loop do
+          line = lines.next
+          if line.match(BLOCK_START_REGEXP)
+            line.gsub!(BLOCK_START_REGEXP, '<% \1.each.with_index do |\2,index| %>')
+          end
+
+          if line.match(BLOCK_END_REGEXP)
+            line.gsub!(BLOCK_END_REGEXP, '<% end %>')
+          end
+          line = line.gsub(/{(.+?[^}]*)}/, '<%= \1 %>').gsub(/[a-z\.]+\#/, 'index')
+          result.push(line)
+        end
+        result = parse_context_block(context_lines: result,
+                                     context_items: attributes,
+                                     context_name: context_name,
+                                     parent_context: parent_context)
+        result
+      end
+
+      def parse_context_block(context_lines:,
+                              context_items:,
+                              context_name:,
+                              parent_context: nil)
+        renderer = YamlContextRenderer.new(context_object: context_items, context_name: context_name)
+        renderer.render(context_lines.join('\n')).split('\n')
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/ref.rb

@@ -62,6 +62,7 @@ module Asciidoctor
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           docid(t, m[:usrlbl]) if m[:usrlbl]
           docid(t, id_and_year(m[:code], yr))
+          t.docnumber m[:code].sub(/^[^\d]*/, "")
           yr and t.date **{ type: "published" } do |d|
             set_date_range(d, yr)
           end
@@ -78,6 +79,7 @@ module Asciidoctor
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           docid(t, m[:usrlbl]) if m[:usrlbl]
           docid(t, id_and_year(m[:code], "--"))
+          t.docnumber m[:code].sub(/^[^\d]*/, "")
           t.date **{ type: "published" } do |d|
             d.on "--"
           end
@@ -108,6 +110,7 @@ module Asciidoctor
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           docid(t, m[:usrlbl]) if m[:usrlbl]
           docid(t, id_and_year(m[:code], yr) + " (all parts)")
+          t.docnumber m[:code].sub(/^[^\d]*/, "")
           conditional_date(t, m, noyr)
           iso_publisher(t, m[:code])
           m.names.include?("fn") && m[:fn] and
@@ -139,6 +142,7 @@ module Asciidoctor
           end
           docid(t, m[:usrlbl]) if m[:usrlbl]
           docid(t, /^\d+$/.match(m[:code]) ? "[#{m[:code]}]" : m[:code])
+          t.docnumber m[:code].sub(/^[^\d]*/, "") unless /^\d+$/.match(m[:code])
         end
       end
 
@@ -206,9 +210,7 @@ module Asciidoctor
 
         def reference(node)
           noko do |xml|
-            node.items.each do |item|
-              reference1(node, item.text, xml)
-            end
+            node.items.each { |item| reference1(node, item.text, xml) }
           end.join
         end
 

data/lib/asciidoctor/standoc/section.rb

@@ -204,6 +204,11 @@ module Asciidoctor
           SYMBOLS_TITLES.include? s.title.downcase
         end
         return "Terms and definitions" if sub.empty?
+        sym = /symbol/i.match(node.title)
+        abbrev = /abbreviat/i.match(node.title)
+        sym && abbrev and return "Terms, definitions, symbols and abbreviated terms"
+        sym and return "Terms, definitions and symbols"
+        abbrev and return "Terms, definitions and abbreviated terms"
         "Terms, definitions, symbols and abbreviated terms"
       end
 

data/lib/asciidoctor/standoc/utils.rb

@@ -20,7 +20,8 @@ module Asciidoctor
         def asciidoc_sub(x)
           return nil if x.nil?
           return "" if x.empty?
-          d = Asciidoctor::Document.new(x.lines.entries, {header_footer: false})
+          d = Asciidoctor::Document.new(x.lines.entries, { header_footer: false,
+                                                           backend: :standoc })
           b = d.parse.blocks.first
           b.apply_subs(b.source)
         end
@@ -66,16 +67,6 @@ module Asciidoctor
           end
         end
 
-=begin
-        def warning(node, msg, text)
-          return if @novalid
-          warntext = "asciidoctor: WARNING"\
-            "(#{current_location(node)}): #{msg}"
-          warntext += ": #{text}" if text
-          warn warntext
-        end
-=end
-
         def flatten_rawtext_lines(node, result)
           node.lines.each do |x|
             if node.respond_to?(:context) && (node.context == :literal ||

data/lib/metanorma/standoc/latexml_requirement.rb

@@ -11,31 +11,33 @@ module Metanorma
         version = version_output&.match(%r{\d+(.\d+)*})
 
         if version.to_s.empty?
-          @error_message = "LaTeXML not installed (or don't works properly)."\
-              " You must upgrade/install LaTeXML to #{@recommended_version} version"
+          @error_message = "LaTeXML is not available. (Or is PATH not setup properly?)"\
+            " You must upgrade/install LaTeXML to a version higher than `#{@recommended_version}`"
 
         elsif Gem::Version.new(version) < Gem::Version.new(@minimal_version)
-          @error_message = "Minimal supported LaTeXML version is #{@minimal_version} "\
-              "found #{version}, recommended version is #{@recommended_version}"
+          @error_message = "Minimal supported LaTeXML version is `#{@minimal_version}` "\
+              "Version `#{version}` found; recommended version is `#{@recommended_version}`"
 
         elsif Gem::Version.new(version) < Gem::Version.new(@recommended_version)
           version = "unknown" if version.to_s.empty?
-          header_msg = "latexmlmath version #{version} below #{@recommended_version}!"
+          header_msg = "latexmlmath version `#{version}` below `#{@recommended_version}`!"
           suggestion = if Gem.win_platform?
                          "cmd encoding is set to UTF-8 with `chcp 65001`"
                        else
                          "terminal encoding is set to UTF-8 with `export LANG=en_US.UTF-8`"
                        end
 
-          @error_message = "WARNING #{header_msg} Please sure that #{suggestion} command"
+          @error_message = "WARNING #{header_msg} Please sure that #{suggestion} command."
 
-          @cmd = "latexmlmath --preload=amsmath -- -"
+          @cmd = 'latexmlmath --strict --preload=amsmath -- -'
+          @cmd2 = 'latexmlmath --strict -- -'
         else
-          @cmd = "latexmlmath --preload=amsmath --inputencoding=UTF-8 -- -"
+          @cmd = 'latexmlmath --strict --preload=amsmath --inputencoding=UTF-8 -- -'
+          @cmd2 = 'latexmlmath --strict --inputencoding=UTF-8 -- -'
         end
       rescue
-        @error_message = "LaTeXML not installed (or don't works properly)."\
-            " You must upgrade/install LaTeXML to #{@recommended_version} version"
+        @error_message = "LaTeXML is not available. (Or is PATH not setup properly?)"\
+            " You must upgrade/install LaTeXML to a version higher than `#{@recommended_version}`"
       end
 
       def satisfied(abort = false)
@@ -53,8 +55,8 @@ module Metanorma
       def cmd
         abort @error_message unless @error_message.nil?
 
-        @cmd
+        [@cmd, @cmd2]
       end
     end
   end
-end
+end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.24".freeze
+   VERSION = "1.3.25".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 1.0.20"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 0.11.0"
-  spec.add_dependency "relaton-iev", "~> 0.1.0"
+  spec.add_dependency "relaton", "~> 1.0.0"
+  spec.add_dependency "relaton-iev", "~> 1.0.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "unicode2latex", "~> 0.0.1"

data/spec/asciidoctor-standoc/base_spec.rb

@@ -53,6 +53,8 @@ RSpec.describe Asciidoctor::Standoc do
       :issued-date: 1007-01-01
       :circulated-date: 1008-01-01
       :unchanged-date: 1009-01-01
+      :vote-started-date: 1011-01-01
+      :vote-ended-date: 1012-01-01
       :date: Fred 1010-01-01
       :date_2: Jack 1010-01-01
       :draft: 3.4
@@ -141,6 +143,12 @@ RSpec.describe Asciidoctor::Standoc do
 <date type="unchanged">
   <on>1009-01-01</on>
 </date>
+ <date type='vote-started'>
+   <on>1011-01-01</on>
+ </date>
+ <date type='vote-ended'>
+   <on>1012-01-01</on>
+ </date>
 <date type="Fred">
   <on>1010-01-01</on>
 </date>

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -75,7 +75,7 @@ RSpec.describe Asciidoctor::Standoc do
        </formula>
               <formula id="_" subsequence="A">
          <stem type="MathML">
-       <math xmlns="http://www.w3.org/1998/Math/MathML" alttext="M=\\begin{bmatrix}-\\sin\\lambda_{0}&amp;\\cos\\lambda_{0}&amp;0\\\\&#10;-\\sin\\varphi_{0}\\cos\\lambda_{0}&amp;-\\sin\\varphi_{0}\\sin\\lambda_{0}&amp;\\cos\\varphi_{0%&#10;}\\\\&#10;\\cos\\varphi_{0}\\cos\\lambda_{0}&amp;\\cos\\varphi_{0}\\sin\\lambda_{0}&amp;\\sin\\varphi_{0}%&#10;\\end{bmatrix}" display="block">
+       <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
          <mrow>
            <mi>M</mi>
            <mo>=</mo>
@@ -924,6 +924,19 @@ RSpec.describe Asciidoctor::Standoc do
 
       [.source]
       <<ISO2191,section=1>>
+
+      === Term2
+
+      Definition
+
+      [.source]
+      {{IEV:xyz}}
+
+      [.source]
+      {{IEV:xyz,t1}}
+
+      [.source]
+      {{IEV:xyz,t1,t2}}
       INPUT
       #{BLANK_HDR}
        <sections>
@@ -940,6 +953,27 @@ RSpec.describe Asciidoctor::Standoc do
         </origin>
        </termsource>
        </term>
+       <term id='_'>
+  <preferred>Term2</preferred>
+  <definition>
+    <p id='_'>Definition</p>
+  </definition>
+  <termsource status='identical'>
+    <origin citeas=''>
+      <termref base='IEV' target='xyz'/>
+    </origin>
+  </termsource>
+  <termsource status='identical'>
+    <origin citeas=''>
+      <termref base='IEV' target='xyz'>t1</termref>
+    </origin>
+  </termsource>
+  <termsource status='identical'>
+    <origin citeas=''>
+      <termref base='IEV' target='xyz'>t1</termref>
+    </origin>
+  </termsource>
+</term>
        </terms>
        </sections>
        </standard-document>
@@ -955,6 +989,13 @@ RSpec.describe Asciidoctor::Standoc do
 
       [.source]
       <<ISO2191,section=1>>, with adjustments
+
+      === Term2
+
+      Definition
+
+      [.source]
+      {{IEV:xyz}}, with adjustments
       INPUT
       #{BLANK_HDR}
             <sections>
@@ -975,6 +1016,20 @@ RSpec.describe Asciidoctor::Standoc do
          </modification>
        </termsource>
        </term>
+       <term id='_'>
+  <preferred>Term2</preferred>
+  <definition>
+    <p id='_'>Definition</p>
+  </definition>
+  <termsource status='modified'>
+    <origin citeas=''>
+      <termref base='IEV' target='xyz'/>
+    </origin>
+    <modification>
+      <p id='_'>with adjustments</p>
+    </modification>
+  </termsource>
+</term>
        </terms>
        </sections>
        </standard-document>

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -336,6 +336,7 @@ RSpec.describe Asciidoctor::Standoc do
         <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
          <docidentifier>ISO 216:2001</docidentifier>
+         <docnumber>216</docnumber>
          <date type="published">
            <on>2001</on>
          </date>
@@ -413,6 +414,7 @@ RSpec.describe Asciidoctor::Standoc do
         <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
          <docidentifier>ISO 216</docidentifier>
+         <docnumber>216</docnumber>
          <contributor>
            <role type="publisher"/>
            <organization>
@@ -449,6 +451,7 @@ RSpec.describe Asciidoctor::Standoc do
   <bibitem id="iso216" type="standard">
   <title format="text/plain">Reference</title>
   <docidentifier>ISO 216</docidentifier>
+         <docnumber>216</docnumber>
   <contributor>
     <role type="publisher"/>
     <organization>
@@ -511,6 +514,7 @@ RSpec.describe Asciidoctor::Standoc do
              <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
          <docidentifier>ISO 216</docidentifier>
+         <docnumber>216</docnumber>
          <contributor>
            <role type="publisher"/>
            <organization>
@@ -558,6 +562,7 @@ RSpec.describe Asciidoctor::Standoc do
              <bibitem id='iso216' type='standard'>
                <title format='text/plain'>Reference</title>
                <docidentifier>ISO 216</docidentifier>
+               <docnumber>216</docnumber>
                <contributor>
                  <role type='publisher'/>
                  <organization>
@@ -574,6 +579,7 @@ RSpec.describe Asciidoctor::Standoc do
              <bibitem id='iso216' type='standard'>
                <title format='text/plain'>Reference</title>
                <docidentifier>ISO 215</docidentifier>
+               <docnumber>215</docnumber>
                <contributor>
                  <role type='publisher'/>
                  <organization>
@@ -937,6 +943,7 @@ end
         <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
          <docidentifier>ISO 123:—</docidentifier>
+         <docnumber>123</docnumber>
          <date type="published">
            <on>–</on>
          </date>
@@ -1378,6 +1385,7 @@ end
   <bibitem id="iso124" type="standard">
   <title format="text/plain">Standard 124</title>
   <docidentifier>ISO 124</docidentifier>
+  <docnumber>124</docnumber>
   <contributor>
     <role type="publisher"/>
     <organization>
@@ -1433,6 +1441,7 @@ OUTPUT
          <bibitem id="iso124" type="standard">
          <title format="text/plain">Standard 124</title>
          <docidentifier>ISO 124</docidentifier>
+         <docnumber>124</docnumber>
          <contributor>
            <role type="publisher"/>
            <organization>
@@ -1452,6 +1461,7 @@ OUTPUT
          <bibitem id="iso125" type="standard">
          <title format="text/plain">Standard 124</title>
          <docidentifier>ISO 125</docidentifier>
+         <docnumber>125</docnumber>
          <contributor>
            <role type="publisher"/>
            <organization>
@@ -1691,11 +1701,25 @@ it "sorts symbols lists" do
         <dd>
           <p id='_'>Definition 5</p>
         </dd>
-        <dt><stem type='MathML'>x_m</stem></dt>
+        <dt><stem type='MathML'>
+        <math xmlns='http://www.w3.org/1998/Math/MathML'>
+  <msub>
+    <mi>x</mi>
+    <mi>m</mi>
+  </msub>
+</math>
+        </stem></dt>
         <dd>
           <p id='_'>Definition 4</p>
         </dd>
-        <dt><stem type='MathML'>x_1</stem></dt>
+        <dt><stem type='MathML'>
+         <math xmlns='http://www.w3.org/1998/Math/MathML'>
+   <msub>
+     <mi>x</mi>
+     <mn>1</mn>
+   </msub>
+ </math>
+        </stem></dt>
         <dd>
           <p id='_'>Definition 3</p>
         </dd>

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -88,7 +88,7 @@ text, including <strong><em>nest</em></strong>ed markup.</p>
       <sections>
       <p id="_">
           <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>n</mi><mo>&lt;</mo><mn>1</mn></math></stem><br/>
-          <stem type="MathML"> <math xmlns="http://www.w3.org/1998/Math/MathML" alttext="n&lt;1" display="block">   <mrow>     <mi>n</mi>     <mo>&lt;</mo>     <mn>1</mn>   </mrow> </math></stem>
+          <stem type="MathML"> <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">   <mrow>     <mi>n</mi>     <mo>&lt;</mo>     <mn>1</mn>   </mrow> </math></stem>
         </p>
       </sections>
        </standard-document>
@@ -106,7 +106,7 @@ text, including <strong><em>nest</em></strong>ed markup.</p>
       <sections>
       <p id="_">
           <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mi>n</mi><mo>&lt;</mo><mn>1</mn></math></stem>
-          <stem type="MathML"> <math xmlns="http://www.w3.org/1998/Math/MathML" alttext="n&lt;1" display="block">   <mrow>     <mi>n</mi>     <mo>&lt;</mo>     <mn>1</mn>   </mrow> </math></stem>
+          <stem type="MathML"> <math xmlns="http://www.w3.org/1998/Math/MathML" display="block">   <mrow>     <mi>n</mi>     <mo>&lt;</mo>     <mn>1</mn>   </mrow> </math></stem>
         </p>
       </sections>
        </standard-document>
@@ -237,6 +237,7 @@ text, including <strong><em>nest</em></strong>ed markup.</p>
          <bibitem id="ISO713">
          <formattedref format="application/x-isodoc+xml">Reference</formattedref>
          <docidentifier>ISO713</docidentifier>
+         <docnumber>713</docnumber>
        </bibitem>
        </references>
        </bibliography>

data/spec/asciidoctor-standoc/macros_spec.rb

@@ -34,6 +34,7 @@ RSpec.describe Asciidoctor::Standoc do
         <em>Title</em>
       </formattedref>
       <docidentifier>XYZ 123</docidentifier>
+      <docnumber>123</docnumber>
     </bibitem>
   </references>
 </bibliography>
@@ -287,7 +288,7 @@ OUTPUT
        </standard-document>
     OUTPUT
   end
-  
+
   it "processes the PlantUML macro" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{plantuml/plantuml[^./]+\.}, "plantuml/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -462,7 +463,6 @@ Alice &lt;-- Bob: another authentication Response
     OUTPUT
   end
 
-
   private
 
   def mock_plantuml_disabled
@@ -471,13 +471,13 @@ Alice &lt;-- Bob: another authentication Response
       false
     end
   end
-  
+
   def mock_localdir_unwritable
     expect(Asciidoctor::Standoc::Utils).to receive(:localdir) do
       "/"
     end.exactly(2).times
   end
-  
+
   def mock_localdir_unwritable
     expect(File).to receive(:writable?) do
       false