metanorma-standoc 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cd6e66873fc1d0b703e0fee76f1ed3a56de06684135f142e3be3865bb7c21fa
-  data.tar.gz: ec666e930ce8ad73f39563050aaf052ddc0ed31a1778dec88cd1bf7308ddef12
+  metadata.gz: f802ef3bf91b1b1af85aa22ca72569b6a6d74b29ed4389373e6b42e7d364b016
+  data.tar.gz: 55bd7031c2f7a2623955c9d1778b48a5a1666d15a0fe160a8058b544ffe60f92
 SHA512:
-  metadata.gz: 65062d39f1c2bd1c33ceaf3bc0d55f5be7c34728c4b9027c7b7192c5ddf8a4b3cc3e37705070b471aac7c20117946a6dae150a5e31613d36afff59bb3ab5aa39
-  data.tar.gz: e1ca0ba1c31ad442c6359d30ca338fecb840dd86839d01cf697e314b365f72da424a6f93eecb1906eafdc34e2f489f2afd9f264ce1762cd1bc2e7524711ac653
+  metadata.gz: 59462520c525758884fdeac23103756b75908daf58707c25ed1420c3e7184e6c3cfaaa7ecd3770619cb3f5d7d9eedc9778b96980b5a33fcdedbea015da9e2684
+  data.tar.gz: ad562abbf62b1217ab40c933a1f32fe7dbbc474561c47ff0ed91c7de9e9262e3b0612393d8354eccacf30b034316635f5c84aa80f24cc2d5e6e5650bd918e485

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-Rails:
-  Enabled: true
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/standoc/base.rb

@@ -48,11 +48,13 @@ module Asciidoctor
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
+          scripts_override: node.attr("scripts-override"),
           scripts_pdf: node.attr("scripts-pdf"),
           datauriimage: node.attr("data-uri-image"),
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
           sectionsplit: node.attr("sectionsplit"),
         }
       end
@@ -80,6 +82,7 @@ module Asciidoctor
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
         }
 
         if font_manifest_file = node.attr("mn2pdf-font-manifest-file")
@@ -108,10 +111,15 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") && node.attr("mn-keep-asciimath") != "false"
+        @keepasciimath = node.attr("mn-keep-asciimath") &&
+          node.attr("mn-keep-asciimath") != "false"
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        @filename = node.attr("docfile") ?  File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
+        if node.attr("docfile")
+          @filename = File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+        else
+          @filename = ""
+        end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -143,10 +151,12 @@ module Asciidoctor
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml",
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert("#{@filename}.presentation.xml",
+                                    nil, false, "#{@filename}.doc")
       end
 
       def document(node)
@@ -163,12 +173,21 @@ module Asciidoctor
       end
 
       def clean_exit
-        @log.write(@output_dir + @filename + ".err") unless @novalid
+        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
+
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
+      def clean_abort(msg, file = nil)
+        file and
+          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
+        clean_exit
+        abort(msg)
+      end
+
       def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>", "<#{xml_root_tag} type='semantic' version='#{version}'>"]
+        result = ["<?xml version='1.0' encoding='UTF-8'?>",
+                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -203,36 +222,13 @@ module Asciidoctor
         end
       end
 
-      def default_script(lang)
-        case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
-        else
-          "Latn"
-        end
-      end
-
       private
 
       def outputdir(node)
-        if node.attr("output_dir").nil_or_empty? then Metanorma::Utils::localdir(node)
-        else File.join(node.attr("output_dir"), "")
+        if node.attr("output_dir").nil_or_empty?
+          Metanorma::Utils::localdir(node)
+        else
+          File.join(node.attr("output_dir"), "")
         end
       end
     end

data/lib/asciidoctor/standoc/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/standoc/blocks.rb

@@ -30,6 +30,7 @@ module Asciidoctor
       def open(node)
         role = node.role || node.attr("style")
         reqt_subpart(role) and return requirement_subpart(node)
+        role == "form" and return form(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -37,6 +38,17 @@ module Asciidoctor
         result
       end
 
+      def form(node)
+        noko do |xml|
+          xml.form **attr_code(
+            id: Metanorma::Utils::anchor_or_uuid,
+            name: node.attr("name"), action: node.attr("action")
+          ) do |f|
+            f << node.content
+          end
+        end
+      end
+
       def literal_attrs(node)
         attr_code(id_attr(node).merge(keep_attrs(node)))
       end
@@ -71,11 +83,14 @@ module Asciidoctor
 
       def example(node)
         return term_example(node) if in_terms?
+
         role = node.role || node.attr("style")
         %w(recommendation requirement permission).include?(role) and
           return requirement(node, role)
         return pseudocode_example(node) if role == "pseudocode"
         return svgmap_example(node) if role == "svgmap"
+        return form(node) if role == "form"
+
         example_proper(node)
       end
 
@@ -91,9 +106,9 @@ module Asciidoctor
         noko do |xml|
           xml.svgmap **attr_code(svgmap_attrs(node).merge(
             src: node.attr("src"), alt: node.attr("alt"))) do |ex|
-            figure_title(node, ex)
-            ex << node.content
-          end
+              figure_title(node, ex)
+              ex << node.content
+            end
         end.join("\n")
       end
 
@@ -140,13 +155,14 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(align: node.attr("align"), 
-                        id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node)
+          .merge(align: node.attr("align"), 
+        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
         return termsource(node) if node.role == "source"
+
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content
@@ -155,9 +171,9 @@ module Asciidoctor
       end
 
       def quote_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(align: node.attr("align"), 
-                        id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node)
+          .merge(align: node.attr("align"), 
+        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -2,30 +2,41 @@ module Asciidoctor
   module Standoc
     module Blocks
       def termnote_attrs(node)
-        attr_code(id_attr(node).merge(
-          unnumbered: node.attr("unnumbered"),
-          number: node.attr("number"),
-          subsequence: node.attr("subsequence"),
-          "keep-with-next": node.attr("keep-with-next"),
-          "keep-lines-together": node.attr("keep-with-next"),
-          "keep-separate": node.attr("keep-separate")))
+        attr_code(
+          id_attr(node).merge(
+            unnumbered: node.attr("unnumbered"),
+            number: node.attr("number"),
+            subsequence: node.attr("subsequence"),
+            "keep-with-next": node.attr("keep-with-next"),
+            "keep-lines-together": node.attr("keep-with-next"),
+            "keep-separate": node.attr("keep-separate")
+          )
+        )
       end
 
       def note_attrs(node)
-        attr_code(termnote_attrs(node).merge(
-          type: node.attr("type"),
-          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(
+          termnote_attrs(node).merge(
+            type: node.attr("type"),
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+          )
+        )
       end
 
       def sidebar_attrs(node)
-        todo_attrs(node).merge(attr_code(
-          from: node.attr("from"), to: node.attr("to") || node.attr("from") ))
+        todo_attrs(node).merge(
+          attr_code(
+            from: node.attr("from"),
+            to: node.attr("to") || node.attr("from")
+          )
+        )
       end
 
       def sidebar(node)
         return unless draft?
+
         noko do |xml|
-          xml.review **(sidebar_attrs(node)) do |r|
+          xml.review **sidebar_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
@@ -33,33 +44,34 @@ module Asciidoctor
 
       def todo_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match date
+        date += "T00:00:00Z" unless /T/.match? date
         attr_code(
           id: ::Metanorma::Utils::anchor_or_uuid(node),
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
-          date: date )
+          date: date
+        )
       end
 
       def todo(node)
         noko do |xml|
-          xml.review **(todo_attrs(node)) do |r|
+          xml.review **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
       end
 
-      def termnote(n)
+      def termnote(node)
         noko do |xml|
-          xml.termnote **termnote_attrs(n) do |ex|
-            wrap_in_para(n, ex)
+          xml.termnote **termnote_attrs(node) do |ex|
+            wrap_in_para(node, ex)
           end
         end.join("\n")
       end
 
-      def note(n)
+      def note(node)
         noko do |xml|
-          xml.note **note_attrs(n) do |c|
-            wrap_in_para(n, c)
+          xml.note **note_attrs(node) do |c|
+            wrap_in_para(node, c)
           end
         end.join("\n")
       end
@@ -69,14 +81,19 @@ module Asciidoctor
         a = node.attr("type") and ["danger", "safety precautions"].each do |t|
           name = t if a.casecmp(t).zero?
         end
-        attr_code(keep_attrs(node).merge(id: Metanorma::Utils::anchor_or_uuid(node), type: name,
-                  beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(
+          keep_attrs(node).merge(
+            id: Metanorma::Utils::anchor_or_uuid(node), type: name,
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+          )
+        )
       end
 
       def admonition(node)
         return termnote(node) if in_terms?
         return note(node) if node.attr("name") == "note"
         return todo(node) if node.attr("name") == "todo"
+
         noko do |xml|
           xml.admonition **admonition_attrs(node) do |a|
             node.title.nil? or a.name { |name| name << node.title }

data/lib/asciidoctor/standoc/cleanup.rb

@@ -2,27 +2,29 @@ require "nokogiri"
 require "pathname"
 require "open-uri"
 require "html2doc"
-require_relative "./cleanup_block.rb"
-require_relative "./cleanup_footnotes.rb"
-require_relative "./cleanup_ref.rb"
-require_relative "./cleanup_ref_dl.rb"
-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_relative "./cleanup_maths.rb"
+require_relative "./cleanup_block"
+require_relative "./cleanup_footnotes"
+require_relative "./cleanup_ref"
+require_relative "./cleanup_ref_dl"
+require_relative "./cleanup_boilerplate"
+require_relative "./cleanup_section"
+require_relative "./cleanup_terms"
+require_relative "./cleanup_inline"
+require_relative "./cleanup_amend"
+require_relative "./cleanup_maths"
+require_relative "./cleanup_image"
+require_relative "./cleanup_reqt"
 require "relaton_iev"
 
 module Asciidoctor
   module Standoc
     module Cleanup
       def textcleanup(result)
-        text = result.flatten.map { |l| l.sub(/\s*$/, "") }  * "\n"
+        text = result.flatten.map { |l| l.sub(/\s*$/, "") } * "\n"
         !@keepasciimath and text = asciimath2mathml(text)
         text = text.gsub(/\s+<fn /, "<fn ")
         text.gsub(%r{<passthrough\s+formats="metanorma">([^<]*)
-                  </passthrough>}mx) { |m| HTMLEntities.new.decode($1) }
+                  </passthrough>}mx) { HTMLEntities.new.decode($1) }
       end
 
       def cleanup(xmldoc)
@@ -31,6 +33,7 @@ module Asciidoctor
         obligations_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
+        form_cleanup(xmldoc)
         sourcecode_cleanup(xmldoc)
         figure_cleanup(xmldoc)
         element_name_cleanup(xmldoc)
@@ -69,26 +72,43 @@ module Asciidoctor
         xmldoc
       end
 
+      IGNORE_DUMBQUOTES = "//pre | //pre//* | //tt | //tt//* | "\
+        "//sourcecode | //sourcecode//* | //bibdata//* | //stem | "\
+        "//stem//* | //figure[@class = 'pseudocode'] | "\
+        "//figure[@class = 'pseudocode']//*".freeze
+
       def smartquotes_cleanup(xmldoc)
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
-        xmldoc.traverse do |n|
-          next unless n.text?
-          if @smartquotes
+        if @smartquotes then smartquotes_cleanup1(xmldoc)
+        else dumbquote_cleanup(xmldoc)
+        end
+      end
+
+      def smartquotes_cleanup1(xmldoc)
+        (xmldoc.xpath("//*[child::text()]") - xmldoc.xpath(IGNORE_DUMBQUOTES))
+          .each do |x|
+          x.children.each do |n|
+            next unless n.text?
+
             /[-'"(<>]|\.\.|\dx/.match(n) or next
-            n.ancestors("pre, tt, sourcecode, bibdata, on, stem, figure[@class = 'pseudocode']").empty? or next
+
             n.replace(Metanorma::Utils::smartformat(n.text))
-          else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))#.
-            #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
 
-      def docidentifier_cleanup(xmldoc)
+      def dumbquote_cleanup(xmldoc)
+        xmldoc.traverse do |n|
+          next unless n.text?
+
+          n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
+        end
       end
 
+      def docidentifier_cleanup(xmldoc); end
+
       TEXT_ELEMS =
-        %w{status language script version author name callout phone email 
+        %w{status language script version author name callout phone email
            street city state country postcode identifier referenceFrom surname
            referenceTo docidentifier docnumber prefix initial addition forename
            title draft secretariat title-main title-intro title-part}.freeze
@@ -110,57 +130,6 @@ module Asciidoctor
         xmldoc.traverse { |n| n.name = n.name.gsub(/_/, "-") }
       end
 
-      def link_callouts_to_annotations(callouts, annotations)
-        callouts.each_with_index do |c, i|
-          c["target"] = "_" + UUIDTools::UUID.random_create
-          annotations[i]["id"] = c["target"]
-        end
-      end
-
-      def align_callouts_to_annotations(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
-          callouts.size == annotations.size and
-            link_callouts_to_annotations(callouts, annotations)
-        end
-      end
-
-      def merge_annotations_into_sourcecode(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          while x&.next_element&.name == "annotation"
-            x.next_element.parent = x
-          end
-        end
-      end
-
-      def callout_cleanup(xmldoc)
-        merge_annotations_into_sourcecode(xmldoc)
-        align_callouts_to_annotations(xmldoc)
-      end
-
-      def sourcecode_cleanup(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          x.traverse do |n|
-            next unless n.text?
-            next unless /#{Regexp.escape(@sourcecode_markup_start)}/.match(n.text)
-            n.replace(sourcecode_markup(n))
-          end
-        end
-      end
-
-      def sourcecode_markup(n)
-        acc = []
-        n.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|#{Regexp.escape(@sourcecode_markup_end)})/).
-          each_slice(4).map do |a|
-          acc << Nokogiri::XML::Text.new(a[0], n.document).
-            to_xml(encoding: "US-ASCII", save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
-          next unless a.size == 4
-          acc << Asciidoctor.convert(a[2], backend: (self&.backend&.to_sym || :standoc), doctype: :inline)
-        end
-        acc.join
-      end
-
       # allows us to deal with doc relation localities,
       # temporarily stashed to "bpart"
       def bpart_cleanup(xmldoc)
@@ -170,28 +139,34 @@ module Asciidoctor
         end
       end
 
-      def img_cleanup(xmldoc)
-        return xmldoc unless @datauriimage
-        xmldoc.xpath("//image").each { |i| i["src"] = Metanorma::Utils::datauri(i["src"], @localdir) }
-      end
-
       def variant_cleanup(xmldoc)
+        variant_space_cleanup(xmldoc)
         xmldoc.xpath("//*[variant]").each do |c|
-          c&.next&.text? && c&.next&.next&.name == "variant" && c.next.text.gsub(/\s/, "").empty? and
-            c.next.remove
-        end
-        xmldoc.xpath("//*[variant]").each do |c|
-          next unless c.children.any? { |n| n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?) }
+          next unless c.children.any? do |n|
+            n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
+          end
+
           c.xpath("./variant").each do |n|
-            if n.at_xpath('preceding-sibling::node()[not(self::text()[not(normalize-space())])][1][self::variantwrap]')
+            if n.at_xpath("preceding-sibling::node()"\
+                "[not(self::text()[not(normalize-space())])][1]"\
+                "[self::variantwrap]")
               n.previous_element << n
             else
-              n.replace('<variantwrap/>').first << n
+              n.replace("<variantwrap/>").first << n
             end
           end
         end
         xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
       end
+
+      def variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[variant]").each do |c|
+          if c&.next&.text? && c&.next&.next&.name == "variant"
+            c.next.text.gsub(/\s/, "").empty? and
+              c.next.remove
+          end
+        end
+      end
     end
   end
 end