metanorma-standoc 1.3.25 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 500052e6d1bd5c05e37f8bb82ef9a6169e5d172d6a72216436995611d398d3b2
-  data.tar.gz: 32bfbcaa5e44d661c9ca28a5b6abf38e2cdc772751cd74b90c959decfd7e6df5
+  metadata.gz: 1e86d9135fffb1f112db82f9d052632aa36f134a76b03ff48e65dcb841c7cbb4
+  data.tar.gz: ea05dff988ebaf6b51c029d99cbadd195300c3c524acd301157a335257436c01
 SHA512:
-  metadata.gz: 0d5d15e5456577b3178c875adce471b9e68debea793ce50d347fe16652ebbcc89a346267826846fb979c255ea24d166f8c5c79b0eb42a276dd070328f360e4a0
-  data.tar.gz: f496a942f64052abae15c8ea1864f8f977a40dc57c8264140b5d6f9b07626489998f85a1e30fdfcac9cda4049cd9131110f6642451c4e57f53375f5020161f9f
+  metadata.gz: beead161e217dba5841732200aa8cb897900ea90b1a449f092fe63ffe40ca59a6b904b098affd1a475723ac4663ba5dadd09fdab48b661376c4fe659360c79a4
+  data.tar.gz: 43b697f04165938864eab22a1d4d49613adef7ae1703995a5541018fe438f09ff21dd43e37e25ebeab9a0d514b50f64b64d2a8a47c8836b924d4578b9f076d19

data/.github/workflows/macos.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby

data/.github/workflows/ubuntu.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby

data/.github/workflows/windows.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby

data/.gitignore

@@ -9,3 +9,4 @@ spec/examples/rice.doc
 spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
+Gemfile.lock

data/lib/asciidoctor/standoc/base.rb

@@ -15,6 +15,8 @@ module Asciidoctor
       XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
 
       Asciidoctor::Extensions.register do
+        preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
+        preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
@@ -43,7 +45,7 @@ module Asciidoctor
       def skip(node, name = nil)
         name = name || node.node_name
         w = "converter missing for #{name} node in Metanorma backend"
-        @log.add("Asciidoctor Input", node, w)
+        @log.add("AsciiDoc Input", node, w)
         nil
       end
 
@@ -109,7 +111,7 @@ module Asciidoctor
         @fontheader = default_fonts(node)
         @files_to_delete = []
         @filename = node.attr("docfile") ?
-          node.attr("docfile").gsub(/\.adoc$/, "").gsub(%r{^.*/}, "") : ""
+          File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
         @localdir = Utils::localdir(node)
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
@@ -125,31 +127,6 @@ module Asciidoctor
         i18n_init(lang, script)
       end
 
-      def init_bib_caches(node)
-        return if @no_isobib
-        global = !@no_isobib_cache && !node.attr("local-cache-only")
-        local = node.attr("local-cache") || node.attr("local-cache-only")
-        local = nil if @no_isobib_cache
-        @bibdb = Relaton::DbCache.init_bib_caches(
-          local_cache: local,
-          flush_caches: node.attr("flush-caches"),
-          global_cache: global)
-      end
-
-      def init_iev_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
-          node.attr("local-cache-only") or
-            @iev_globalname = global_ievcache_name
-          @iev_localname = local_ievcache_name(node.attr("local-cache") ||
-                                               node.attr("local-cache-only"))
-          if node.attr("flush-caches")
-            FileUtils.rm_f @iev_globalname unless @iev_globalname.nil?
-            FileUtils.rm_f @iev_localname unless @iev_localname.nil?
-          end
-        end
-        #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
-      end
-
       def default_fonts(node)
         b = node.attr("body-font") ||
           (node.attr("script") == "Hans" ? '"SimSun",serif' :
@@ -169,9 +146,13 @@ module Asciidoctor
           html_converter(node).convert(@filename + ".xml")
           doc_converter(node).convert(@filename + ".xml")
         end
+        clean_exit
+        ret
+      end
+
+      def clean_exit
         @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
-        ret
       end
 
       def makexml1(node)
@@ -241,7 +222,7 @@ module Asciidoctor
       def extract_termsource_refs(text, node)
         matched = TERM_REFERENCE_RE.match text
         matched.nil? and
-          @log.add("Asciidoctor Input", node, "term reference not in expected format: #{text}")
+          @log.add("AsciiDoc Input", node, "term reference not in expected format: #{text}")
         matched
       end
 

data/lib/asciidoctor/standoc/biblio.rng

@@ -88,7 +88,7 @@
       <text/>
     </element>
   </define>
-  <define name="LocalizedString">
+  <define name="LocalizedString1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -98,6 +98,16 @@
     </optional>
     <text/>
   </define>
+  <define name="LocalizedString">
+    <choice>
+      <ref name="LocalizedString1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedString1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <!--
     Unlike UML, change type to format: type is overloaded
     Would be need if plain were default value and could omit the attribute
@@ -121,7 +131,7 @@
     </optional>
     <ref name="LocalizedStringOrXsAny"/>
   </define>
-  <define name="LocalizedStringOrXsAny">
+  <define name="LocalizedStringOrXsAny1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -136,6 +146,16 @@
       </choice>
     </oneOrMore>
   </define>
+  <define name="LocalizedStringOrXsAny">
+    <choice>
+      <ref name="LocalizedStringOrXsAny1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedStringOrXsAny1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <define name="contributor">
     <element name="contributor">
       <zeroOrMore>
@@ -641,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -1001,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">

data/lib/asciidoctor/standoc/blocks.rb

@@ -21,11 +21,21 @@ module Asciidoctor
                   subsequence: node.attr("subsequence") )
       end
 
+      def termnote_attr(node)
+        attr_code(id_attr(node).merge(
+          "keep-separate": node.attr("keep-separate")))
+      end
+
+      def note_attr(node)
+        attr_code(id_attr(node).merge(
+          "keep-separate": node.attr("keep-separate"),
+          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+      end
+
       # We append each contained block to its parent
       def open(node)
         role = node.role || node.attr("style")
-        Utils::reqt_subpart(role) and
-          return requirement_subpart(node)
+        Utils::reqt_subpart(role) and return requirement_subpart(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -49,18 +59,16 @@ module Asciidoctor
 
       # NOTE: html escaping is performed by Nokogiri
       def stem(node)
-        stem_content = node.lines.join("\n")
         noko do |xml|
           xml.formula **formula_attr(node) do |s|
-            stem_parse(stem_content, s, node.style.to_sym)
+            stem_parse(node.lines.join("\n"), s, node.style.to_sym)
           end
         end
       end
 
       def sidebar_attrs(node)
         todo_attrs(node).merge(attr_code(
-          from: node.attr("from"),
-          to: node.attr("to") || node.attr("from") ))
+          from: node.attr("from"), to: node.attr("to") || node.attr("from") ))
       end
 
       def sidebar(node)
@@ -91,7 +99,7 @@ module Asciidoctor
 
       def termnote(n)
         noko do |xml|
-          xml.termnote **id_attr(n) do |ex|
+          xml.termnote **termnote_attr(n) do |ex|
             wrap_in_para(n, ex)
           end
         end.join("\n")
@@ -99,7 +107,7 @@ module Asciidoctor
 
       def note(n)
         noko do |xml|
-          xml.note **id_attr(n) do |c|
+          xml.note **note_attr(n) do |c|
             wrap_in_para(n, c)
           end
         end.join("\n")
@@ -107,12 +115,11 @@ module Asciidoctor
 
       def admonition_attrs(node)
         name = node.attr("name")
-        if type = node.attr("type")
-          ["danger", "safety precautions"].each do |t|
-            name = t if type.casecmp(t).zero?
-          end
+        a = node.attr("type") and ["danger", "safety precautions"].each do |t|
+          name = t if a.casecmp(t).zero?
         end
-        attr_code(id: Utils::anchor_or_uuid(node), type: name)
+        attr_code(id: Utils::anchor_or_uuid(node), type: name,
+                  beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil)
       end
 
       def admonition(node)
@@ -145,9 +152,10 @@ module Asciidoctor
       end
 
       def pseudocode_example(node)
+        # prevent A's and other subs inappropriate for pseudocode
+        node.blocks.each { |b| b.remove_sub(:replacements) }
         noko do |xml|
-          xml.figure **{id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
-                        class: "pseudocode"} do |ex|
+          xml.figure **id_unnum_attr(node).merge(class: "pseudocode") do |ex|
             figure_title(node, ex)
             wrap_in_para(node, ex)
           end
@@ -186,8 +194,7 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(align: node.attr("align"),
-                  id: Utils::anchor_or_uuid(node))
+        attr_code(align: node.attr("align"), id: Utils::anchor_or_uuid(node))
       end
 
       def paragraph(node)
@@ -210,9 +217,8 @@ module Asciidoctor
             s <<  m[:text]
           end
         end
-        if node.attr("attribution")
+        node.attr("attribution") and
           out.author { |a| a << node.attr("attribution") }
-        end
       end
 
       def quote(node)
@@ -244,7 +250,11 @@ module Asciidoctor
       end
 
       def pass(node)
-        node.content
+        noko do |xml|
+          xml.passthrough **attr_code(formats: node.attr("format")) do |p|
+            p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
+          end
+        end
       end
     end
   end

data/lib/asciidoctor/standoc/cleanup.rb

@@ -7,6 +7,7 @@ require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
 require_relative "./cleanup_boilerplate.rb"
 require_relative "./cleanup_section.rb"
+require_relative "./cleanup_terms.rb"
 require_relative "./cleanup_inline.rb"
 require "relaton_iev"
 
@@ -39,6 +40,7 @@ module Asciidoctor
         figure_cleanup(xmldoc)
         ref_cleanup(xmldoc)
         note_cleanup(xmldoc)
+        clausebefore_cleanup(xmldoc)
         ref_dl_cleanup(xmldoc)
         normref_cleanup(xmldoc)
         biblio_cleanup(xmldoc)
@@ -54,7 +56,6 @@ module Asciidoctor
         quotesource_cleanup(xmldoc)
         callout_cleanup(xmldoc)
         footnote_cleanup(xmldoc)
-        empty_element_cleanup(xmldoc)
         mathml_cleanup(xmldoc)
         script_cleanup(xmldoc)
         docidentifier_cleanup(xmldoc)
@@ -64,6 +65,8 @@ module Asciidoctor
         boilerplate_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
         para_cleanup(xmldoc)
+        empty_element_cleanup(xmldoc)
+        img_cleanup(xmldoc)
         xmldoc
       end
 
@@ -158,6 +161,13 @@ module Asciidoctor
           x.replace(x.children)
         end
       end
+
+      def img_cleanup(xmldoc)
+        return xmldoc unless @datauriimage
+        xmldoc.xpath("//image").each do |i|
+          i["src"] = datauri(i["src"])
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -131,10 +131,13 @@ module Asciidoctor
       def note_cleanup(xmldoc)
         q = "//note[following-sibling::*[not(local-name() = 'note')]]"
         xmldoc.xpath(q).each do |n|
+          next if n["keep-separate"] == "true"
           next unless n.ancestors("table").empty?
           prev = n.previous_element || next
           n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
         end
+        xmldoc.xpath("//note[@keep-separate]").each { |n| n.delete("keep-separate") }
+        xmldoc.xpath("//termnote[@keep-separate]").each { |n| n.delete("keep-separate") }
       end
 
       def requirement_cleanup(x)
@@ -144,7 +147,7 @@ module Asciidoctor
 
       def requirement_inherit(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
-          ins = r.at("./classification") || 
+          ins = r.at("./classification") ||
             r.at("./description | ./measurementtarget | ./specification | "\
                  "./verification | ./import | ./description | ./requirement | "\
                  "./recommendation | ./permission")
@@ -155,7 +158,7 @@ module Asciidoctor
       def requirement_descriptions(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
           r.children.each do |e|
-            unless e.element? && (Utils::reqt_subpart(e.name) || 
+            unless e.element? && (Utils::reqt_subpart(e.name) ||
                 %w(requirement recommendation permission).include?(e.name))
               t = Nokogiri::XML::Element.new("description", x)
               e.before(t)