metanorma-standoc 1.3.28 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ee3fb2a341c932aff7e68ccb8c048151741abcb0faaaeacc7397ec9f2b2d57e
-  data.tar.gz: d61e8f1944322c8f2d8a43dff3f0dc9fb6f3c74caffd3ce17998e1b7e25ff7a6
+  metadata.gz: ac225a257c1a5c42ce296ee87ef1d95e378111a82875211969771f7d1756bcf2
+  data.tar.gz: 30ff55c905559089be61b2752cb84c8274a121b4e5359a8cdf547528296a09be
 SHA512:
-  metadata.gz: 88eccb85c42a5a580f6a56a43ebd86122583fda463ceb4d1599671f482e5a6341ab4299f88d40a07aa639953c701a846101bbe3453dbf44a66947c7641d0cda2
-  data.tar.gz: f4cfbe3757116cb13eda00da0f01fb97b9548ae4eb5b9c5c56b3463ffcd3ab1dcbdddf182799b280ab430e7dbd4ee30179764c332c326238e98a5c1b3ef8a899
+  metadata.gz: e66997f17221a04e57e213a66e16ce0061060c5ffd0708bc9196b2b75ec8081673475890b8745086341196bb30a7832ca7f3c1d5615bd80063e31f6f9e243534
+  data.tar.gz: 1a1e23d189dbb0ef46552e5953cd8568c83b6380d239a68cfab95e8a1cb975583e7697bc6d11babb509ca5a21f9f3c7d4d06e225f8faef39f2c7f3d9d8087f9c

data/.github/workflows/macos.yml

@@ -6,25 +6,29 @@ 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
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Install LaTeXML
         run: |
           brew install libxml2 cpanminus
@@ -33,9 +37,6 @@ jobs:
       - name: Install PlantUML
         run: |
           brew install plantuml
-      - name: Install puppeteer
-        run: |
-          npm -g i puppeteer
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -6,25 +6,29 @@ 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
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Update gems
         run: |
           gem install bundler
@@ -34,13 +38,12 @@ jobs:
           sudo snap install latexml --edge
           echo "::add-path::/snap/bin"
       - name: Install PlantUML
-        run: |
-          curl -L https://raw.githubusercontent.com/metanorma/plantuml-install/master/ubuntu.sh | sudo bash
-      - name: Install puppeteer
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libgbm1
-          npm install -g puppeteer@3.0.1
+        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"
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/windows.yml

@@ -6,25 +6,29 @@ 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
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Install MN Windows dependencies
         shell: pwsh
         run: |
@@ -42,10 +46,6 @@ jobs:
           refreshenv
           set PATH=C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;%PATH%
           where latexmlmath
-      - name: Install puppeteer
-        shell: pwsh
-        run: |
-          npm -g i puppeteer
       - name: Run specs
         shell: pwsh
         run: |

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

@@ -14,20 +14,6 @@ module Asciidoctor
       XML_ROOT_TAG = "standard-document".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
 
-      Asciidoctor::Extensions.register do
-        preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
-        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
-        block Asciidoctor::Standoc::ToDoAdmonitionBlock
-        treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
-        block Asciidoctor::Standoc::PlantUMLBlockMacro
-        block Asciidoctor::Standoc::PseudocodeBlockMacro
-      end
-
       def xml_root_tag
         self.class::XML_ROOT_TAG
       end
@@ -96,6 +82,10 @@ module Asciidoctor
         IsoDoc::WordConvert.new(doc_extract_attributes(node))
       end
 
+      def presentation_xml_converter(node)
+        IsoDoc::PresentationXMLConvert.new(html_extract_attributes(node))
+      end
+
       def init(node)
         @fn_number ||= 0
         @draft = false
@@ -111,6 +101,7 @@ module Asciidoctor
         @filename = node.attr("docfile") ?
           File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
         @localdir = Utils::localdir(node)
+        @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
         @bibdb = nil
@@ -125,31 +116,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' :
@@ -161,19 +127,26 @@ module Asciidoctor
         "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
       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")
+      end
+
       def document(node)
         init(node)
         ret = makexml(node).to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-          html_converter(node).convert(@filename + ".xml")
-          doc_converter(node).convert(@filename + ".xml")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
+        outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
+        clean_exit
         ret
       end
 
+      def clean_exit
+        @log.write(@output_dir + @filename + ".err") unless @novalid
+        @files_to_delete.each { |f| FileUtils.rm f }
+      end
+
       def makexml1(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>",
                   "<#{xml_root_tag}>"]
@@ -211,7 +184,7 @@ module Asciidoctor
         end
       end
 
-      def term_source_attr(seen_xref)
+      def term_source_attrs(seen_xref)
         { bibitemid: seen_xref.children[0]["target"],
           format: seen_xref.children[0]["format"],
           type: "inline" }
@@ -222,7 +195,7 @@ module Asciidoctor
           xml_t.origin { |o| o << seen_xref.children[0].to_xml }
         else
           xml_t.origin seen_xref.children[0].content,
-            **attr_code(term_source_attr(seen_xref))
+            **attr_code(term_source_attrs(seen_xref))
         end
         m[:text] && xml_t.modification do |mod|
           mod.p { |p| p << m[:text].sub(/^\s+/, "") }
@@ -255,6 +228,14 @@ module Asciidoctor
           end
         end.join("\n")
       end
+
+      private
+
+      def outputdir(node)
+        if node.attr("output_dir").nil_or_empty? then Utils::localdir(node)
+        else File.join(node.attr("output_dir"), "")
+        end
+      end
     end
   end
 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>
@@ -512,7 +532,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -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

@@ -1,5 +1,6 @@
 require "htmlentities"
 require "uri"
+require_relative "./blocks_notes"
 
 module Asciidoctor
   module Standoc
@@ -8,24 +9,27 @@ module Asciidoctor
         { id: Utils::anchor_or_uuid(node) }
       end
 
-      def id_unnum_attr(node)
+      def id_unnum_attrs(node)
         attr_code( id: Utils::anchor_or_uuid(node),
                   unnumbered: node.option?("unnumbered") ? "true" : nil,
+                  number: node.attr("number"),
                   subsequence: node.attr("subsequence") )
       end
 
-      def formula_attr(node)
-        attr_code( id: Utils::anchor_or_uuid(node),
-                  inequality: node.option?("inequality") ? "true" : nil,
-                  unnumbered: node.option?("unnumbered") ? "true" : nil,
-                  subsequence: node.attr("subsequence") )
+      def formula_attrs(node)
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node).merge(
+          inequality: node.option?("inequality") ? "true" : nil)))
+      end
+
+      def keep_attrs(node)
+        { "keep-with-next": node.attr("keep-with-next"),
+          "keep-lines-together": node.attr("keep-lines-together") }
       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)
@@ -34,7 +38,7 @@ module Asciidoctor
       end
 
       def literal_attrs(node)
-        attr_code(id_attr(node))
+        attr_code(id_attr(node).merge(keep_attrs(node)))
       end
 
       def literal(node)
@@ -49,82 +53,11 @@ 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)
-          end
-        end
-      end
-
-      def sidebar_attrs(node)
-        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|
-            wrap_in_para(node, r)
-          end
-        end
-      end
-
-      def todo_attrs(node)
-        date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match date
-        attr_code(
-          id: Utils::anchor_or_uuid(node),
-          reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
-          date: date )
-      end
-
-      def todo(node)
-        noko do |xml|
-          xml.review **(todo_attrs(node)) do |r|
-            wrap_in_para(node, r)
-          end
-        end
-      end
-
-      def termnote(n)
-        noko do |xml|
-          xml.termnote **id_attr(n) do |ex|
-            wrap_in_para(n, ex)
-          end
-        end.join("\n")
-      end
-
-      def note(n)
         noko do |xml|
-          xml.note **id_attr(n) do |c|
-            wrap_in_para(n, c)
-          end
-        end.join("\n")
-      end
-
-      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?
+          xml.formula **formula_attrs(node) do |s|
+            stem_parse(node.lines.join("\n"), s, node.style.to_sym)
           end
         end
-        attr_code(id: Utils::anchor_or_uuid(node), type: name)
-      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 }
-            wrap_in_para(node, a)
-          end
-        end.join("\n")
       end
 
       def term_example(node)
@@ -145,9 +78,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 **example_attrs(node).merge(class: "pseudocode") do |ex|
             figure_title(node, ex)
             wrap_in_para(node, ex)
           end
@@ -155,7 +89,7 @@ module Asciidoctor
       end
 
       def example_attrs(node)
-        attr_code(id_unnum_attr(node))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
       end
 
       def example_proper(node)
@@ -173,7 +107,7 @@ module Asciidoctor
       end
 
       def figure_attrs(node)
-        attr_code(id_unnum_attr(node))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
       end
 
       def image(node)
@@ -186,8 +120,8 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(align: node.attr("align"),
-                  id: Utils::anchor_or_uuid(node))
+        attr_code(keep_attrs(node).merge(align: node.attr("align"), 
+                                        id: Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
@@ -200,7 +134,8 @@ module Asciidoctor
       end
 
       def quote_attrs(node)
-        attr_code(id: Utils::anchor_or_uuid(node), align: node.attr("align"))
+        attr_code(keep_attrs(node).merge(align: node.attr("align"), 
+                                        id: Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -210,9 +145,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)
@@ -225,10 +159,11 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(lang: node.attr("language"),
-                  id: Utils::anchor_or_uuid(node),
-                  unnumbered: node.option?("unnumbered") ? "true" : nil,
-                  filename: node.attr("filename"))
+        attr_code(keep_attrs(node).merge(lang: node.attr("language"),
+                                        id: Utils::anchor_or_uuid(node),
+                                        unnumbered: node.option?("unnumbered") ? "true" : nil,
+                                        number: node.attr("number"),
+                                        filename: node.attr("filename")))
       end
 
       # NOTE: html escaping is performed by Nokogiri
@@ -245,7 +180,8 @@ module Asciidoctor
 
       def pass(node)
         noko do |xml|
-          xml.passthrough **attr_code(formats: node.attr("format")) do |p|
+          xml.passthrough **attr_code(formats: 
+                                      node.attr("format") || "metanorma") do |p|
             p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
           end
         end