metanorma-standoc 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e86d9135fffb1f112db82f9d052632aa36f134a76b03ff48e65dcb841c7cbb4
-  data.tar.gz: ea05dff988ebaf6b51c029d99cbadd195300c3c524acd301157a335257436c01
+  metadata.gz: 76c3b117ea592275339f9ee8103f17645d9675f45635abfbc8e5333fc512af1c
+  data.tar.gz: a345b19a2657f356225f2087e17a7dba7bd4720389cf44487892d3f1e1bc5345
 SHA512:
-  metadata.gz: beead161e217dba5841732200aa8cb897900ea90b1a449f092fe63ffe40ca59a6b904b098affd1a475723ac4663ba5dadd09fdab48b661376c4fe659360c79a4
-  data.tar.gz: 43b697f04165938864eab22a1d4d49613adef7ae1703995a5541018fe438f09ff21dd43e37e25ebeab9a0d514b50f64b64d2a8a47c8836b924d4578b9f076d19
+  metadata.gz: 630d1159cc78920d3bab3e73a2577b54d00bb966b0faa15166ff1af832656ab985e55f8fa830d40a2fbec96a8cf8555880f89f0e73d749dc73540e6cd8303469
+  data.tar.gz: f3c46604bb69f1e34eb8b2af182e198e99a6f2cae3bce808a9547e096b1852b4868c00a8522370a52c92ad5f263ab2f7e5ee348196fffbe1084ef1c666900080

data/.github/workflows/macos.yml

@@ -29,10 +29,6 @@ jobs:
         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
@@ -41,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

@@ -29,10 +29,6 @@ jobs:
         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
@@ -42,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

@@ -29,10 +29,6 @@ jobs:
         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: |
@@ -50,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/.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/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/lib/asciidoctor/standoc/base.rb

@@ -14,22 +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::Datamodel::AttributesTablePreprocessor
-        preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
-        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
@@ -98,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
@@ -113,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
@@ -122,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)
@@ -138,20 +128,23 @@ 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
+        outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
         clean_exit
         ret
       end
 
       def clean_exit
-        @log.write(@localdir + @filename + ".err") unless @novalid
+        @log.write(@output_dir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
@@ -192,7 +185,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" }
@@ -203,7 +196,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+/, "") }
@@ -236,6 +229,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

@@ -532,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">

data/lib/asciidoctor/standoc/blocks.rb

@@ -1,5 +1,6 @@
 require "htmlentities"
 require "uri"
+require_relative "./blocks_notes"
 
 module Asciidoctor
   module Standoc
@@ -8,28 +9,21 @@ 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") )
-      end
-
-      def termnote_attr(node)
-        attr_code(id_attr(node).merge(
-          "keep-separate": node.attr("keep-separate")))
+      def formula_attrs(node)
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node).merge(
+          inequality: node.option?("inequality") ? "true" : nil)))
       end
 
-      def note_attr(node)
-        attr_code(id_attr(node).merge(
-          "keep-separate": node.attr("keep-separate"),
-          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+      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
@@ -44,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)
@@ -60,80 +54,12 @@ module Asciidoctor
       # NOTE: html escaping is performed by Nokogiri
       def stem(node)
         noko do |xml|
-          xml.formula **formula_attr(node) do |s|
+          xml.formula **formula_attrs(node) do |s|
             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") ))
-      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 **termnote_attr(n) do |ex|
-            wrap_in_para(n, ex)
-          end
-        end.join("\n")
-      end
-
-      def note(n)
-        noko do |xml|
-          xml.note **note_attr(n) do |c|
-            wrap_in_para(n, c)
-          end
-        end.join("\n")
-      end
-
-      def admonition_attrs(node)
-        name = node.attr("name")
-        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,
-                  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 }
-            wrap_in_para(node, a)
-          end
-        end.join("\n")
-      end
-
       def term_example(node)
         noko do |xml|
           xml.termexample **id_attr(node) do |ex|
@@ -155,7 +81,7 @@ module Asciidoctor
         # prevent A's and other subs inappropriate for pseudocode
         node.blocks.each { |b| b.remove_sub(:replacements) }
         noko do |xml|
-          xml.figure **id_unnum_attr(node).merge(class: "pseudocode") do |ex|
+          xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
             figure_title(node, ex)
             wrap_in_para(node, ex)
           end
@@ -163,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)
@@ -181,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)
@@ -194,7 +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)
@@ -207,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)
@@ -231,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
@@ -251,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

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -0,0 +1,89 @@
+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")))
+      end
+
+      def note_attrs(node)
+        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") ))
+      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 **termnote_attrs(n) do |ex|
+            wrap_in_para(n, ex)
+          end
+        end.join("\n")
+      end
+
+      def note(n)
+        noko do |xml|
+          xml.note **note_attrs(n) do |c|
+            wrap_in_para(n, c)
+          end
+        end.join("\n")
+      end
+
+      def admonition_attrs(node)
+        name = node.attr("name")
+        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: 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 }
+            wrap_in_para(node, a)
+          end
+        end.join("\n")
+      end
+    end
+  end
+end