metanorma-standoc 1.4.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 841be88451455a61d53e89d5c557c57f1769372d878c5200826136dae8d62cfd
-  data.tar.gz: b922c30fbd44544dda7ee63a4090d672030f2af570861b500dcd3e8f205497d3
+  metadata.gz: 0a619338025bf24d56d382fde0bfcd3d7c5f2e5ecf5520d995d8c7d4986cb67d
+  data.tar.gz: 1f8c10a80a5ada1b94c6216568eb11851fd081c9ae63bae2d8b9e3e080673b17
 SHA512:
-  metadata.gz: cd2d8b314061fb9c108b6e7568ee9dc65ce81180e955961d593bcaf17081b0e8e7c3e22c8d132ce57c0f5c698869347ff35fd7b56b62d0d1ee34b6c8877a462c
-  data.tar.gz: 7e501083f23311f0b8a8b22eeaf8ec2990d39bc442fe76882b9172bb9bfafc44d273f1485ae0a9117006ba508beff735857194fdf0a49d8eb80deaf902b3a433
+  metadata.gz: 5d9fea4687d265c36099b30faa69893c10ec011e7d1a8b7e32b4e0df4ef9d892e5efe90bb8bd0767f51f3ec74f91b05dc3613532eeff247f1a2039b6094f15dc
+  data.tar.gz: 2ccb181da62a4ca659c2f3915ffdbebbc88b501c97938244d65d780b241e05bd2f61870ac32cc8a3cef739ac7a36b8c714f2cc5027d9269e78c7e6f6bcabb12c

data/.github/workflows/macos.yml

@@ -29,18 +29,13 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install LaTeXML
-        run: |
-          brew install libxml2 cpanminus
-          env PATH=$(brew --prefix libxml2)/bin:$PATH \
-            cpanm --notest XML::LibXSLT@1.96 git://github.com/brucemiller/LaTeXML.git@9a0e7dc5
-      - name: Install PlantUML
-        run: |
-          brew install plantuml
       - name: Update gems
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
+      - name: Install PlantUML
+        run: |
+          brew install plantuml
       - name: Run specs
         run: |
-          env PATH=$(brew --prefix perl)/bin:$PATH bundle exec rake
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -33,17 +33,13 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-      - name: Install LaTeXML
-        run: |
-          sudo snap install latexml --edge
-          echo "::add-path::/snap/bin"
       - name: Install PlantUML
         uses: nick-invision/retry@v1
         with:
           polling_interval_seconds: 5
           timeout_minutes: 5
           max_attempts: 3
-          command: sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
+          command: sudo apt-get update -y && sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/windows.yml

@@ -29,25 +29,15 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install MN Windows dependencies
-        shell: pwsh
-        run: |
-          choco install --no-progress plantuml make sed gnuwin32-coreutils.install grep
       - name: Update gems
         shell: pwsh
         run: |
           gem install bundler
           bundle config --local path vendor/bundle
           bundle install --jobs 4 --retry 3
-      - name: Install LaTeXML
-        shell: cmd
+      - name: Install PlantUML
         run: |
-          cinst -y latexml
-          refreshenv
-          set PATH=C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;%PATH%
-          where latexmlmath
+          cinst -y plantuml
       - name: Run specs
-        shell: pwsh
         run: |
-          $env:Path = "C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;$env:Path"
           bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 Rails:
   Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -111,9 +111,10 @@ module Asciidoctor
         @log = Asciidoctor::Standoc::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
-        lang = (node.attr("language") || "en")
-        script = (node.attr("script") || "en")
-        i18n_init(lang, script)
+        @lang = (node.attr("language") || "en")
+        @script = (node.attr("script") || "Latn")
+        @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
+        @i18n = @isodoc.i18n
       end
 
       def default_fonts(node)
@@ -142,6 +143,11 @@ module Asciidoctor
         ret
       end
 
+      def version
+        flavour = self.class.name.sub(/::Converter$/, "").sub(/^.+::/, "")
+        Metanorma.versioned(Metanorma, flavour)[-1]::VERSION
+      end
+
       def clean_exit
         @log.write(@output_dir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
@@ -149,7 +155,7 @@ module Asciidoctor
 
       def makexml1(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>",
-                  "<#{xml_root_tag}>"]
+                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -169,7 +175,7 @@ module Asciidoctor
       end
 
       def doctype(node)
-        node.attr("doctype")
+        node.attr("doctype")&.gsub(/\s+/, "-")&.downcase
       end
 
       def front(node, xml)

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

@@ -402,6 +402,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 +439,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"/>
@@ -998,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

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
@@ -71,6 +72,7 @@ module Asciidoctor
         para_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
         img_cleanup(xmldoc)
+        anchor_cleanup(xmldoc)
         xmldoc
       end
 
@@ -79,12 +81,13 @@ module Asciidoctor
         xmldoc.traverse do |n|
           next unless n.text?
           if @smartquotes
-            next unless /[-'"(<>]|\.\.|\dx/.match(n)
-            next unless n.ancestors("pre, tt, sourcecode, bibdata, on, "\
-                                    "stem, figure[@class = 'pseudocode']").empty?
+            /[-'"(<>]|\.\.|\dx/.match(n) or next
+            n.ancestors("pre, tt, sourcecode, bibdata, on, "\
+                        "stem, figure[@class = 'pseudocode']").empty? or next
             n.replace(Utils::smartformat(n.text))
           else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))
+            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))#.
+            #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
@@ -144,16 +147,33 @@ module Asciidoctor
         align_callouts_to_annotations(xmldoc)
       end
 
+      def xml_unescape_mathml(x)
+        return if x.children.any? { |y| y.element? }
+        math = x.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">").gsub(/&quot;/, '"').
+          gsub(/&apos;/, "'").gsub(/&amp;/, "&").
+          gsub(/<[^: \r\n\t\/]+:/, "<").gsub(/<\/[^ \r\n\t:]+:/, "</")
+        x.children = math
+      end
+
+      def mathml_preserve_space(m)
+        m.xpath(".//m:mtext",
+                "m" => "http://www.w3.org/1998/Math/MathML").each do |x|
+          x.children = x.children.to_xml.gsub(/^\s/, "&#xA0;").
+            gsub(/\s$/, "&#xA0;")
+        end
+      end
+
+      def mathml_namespace(stem)
+        stem.xpath("./math", ).each do |x|
+          x.default_namespace = "http://www.w3.org/1998/Math/MathML"
+        end
+      end
+
       def mathml_cleanup(xmldoc)
         xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
-          next if x.children.any? { |y| y.element? }
-          math = x.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">").gsub(/&quot;/, '"').
-            gsub(/&apos;/, "'").gsub(/&amp;/, "&").
-            gsub(/<[^: \r\n\t\/]+:/, "<").gsub(/<\/[^ \r\n\t:]+:/, "</").
-            gsub(/ xmlns[^>"']+/, "").
-            gsub(/<math /, '<math xmlns="http://www.w3.org/1998/Math/MathML" ').
-            gsub(/<math>/, '<math xmlns="http://www.w3.org/1998/Math/MathML">')
-          x.children = math
+          xml_unescape_mathml(x)
+          mathml_namespace(x)
+          mathml_preserve_space(x)
         end
       end
 

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_boilerplate.rb

@@ -2,25 +2,25 @@ module Asciidoctor
   module Standoc
     module Cleanup
       def external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @external_terms_boilerplate.gsub(/%/, sources || "???"),
+        @i18n.l10n(
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
           @lang, @script)
       end
 
       def internal_external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+        @i18n.l10n(
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
           @lang, @script)
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
-        div.next = @term_def_boilerplate
+        a = @i18n.term_def_boilerplate and div.next = a
         source.each do |s|
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
         end
         if source.empty? && term.nil?
-          div.next = @no_terms_boilerplate
+          div.next = @i18n.no_terms_boilerplate
         else
           div.next = term_defs_boilerplate_cont(source, term, isodoc)
         end
@@ -30,7 +30,7 @@ module Asciidoctor
         sources = isodoc.sentence_join(src.map do |s|
           %{<eref bibitemid="#{s['bibitemid']}"/>}
         end)
-        if src.empty? then @internal_terms_boilerplate
+        if src.empty? then @i18n.internal_terms_boilerplate
         elsif term.nil? then external_terms_boilerplate(sources)
         else
           internal_external_terms_boilerplate(sources)
@@ -42,7 +42,7 @@ module Asciidoctor
         ["reference", "bibitem"].include? e.name
       end
       f.at("./title").next =
-        "<p>#{(refs.empty? ? @norm_empty_pref : @norm_with_refs_pref)}</p>"
+        "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
     end
 
       TERM_CLAUSE = "//sections/terms | "\
@@ -54,13 +54,9 @@ module Asciidoctor
         x = xmldoc.dup
         x.root.add_namespace(nil, self.class::XML_NAMESPACE)
         xml = Nokogiri::XML(x.to_xml)
-        conv = html_converter(EmptyAttr.new)
-        @lang = xmldoc&.at("//bibdata/language")&.text
-        @script = xmldoc&.at("//bibdata/script")&.text
-        conv.i18n_init(@lang, @script)
-        conv.metadata_init(@lang, @script, conv.labels)
-        conv.info(xml, nil)
-        conv
+        @isodoc ||= isodoc(@lang, @script)
+        @isodoc.info(xml, nil)
+        @isodoc
       end
 
       def boilerplate_cleanup(xmldoc)
@@ -83,15 +79,6 @@ module Asciidoctor
         preface.previous = b
       end
 
-      class EmptyAttr
-        def attr(_x)
-          nil
-        end
-        def attributes
-          {}
-        end
-      end
-
       def boilerplate_file(xmldoc)
         File.join(@libdir, "boilerplate.xml")
       end