metanorma-standoc 1.8.4 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d069ef191d60dfccff15d8a39e2c961c343f1e19928e06645c78833be951f052
-  data.tar.gz: 61dff9a129459b4f2b0c4cb426dabd84a822285c8cce41cd88ce20cc4706d3a5
+  metadata.gz: 5cd6e66873fc1d0b703e0fee76f1ed3a56de06684135f142e3be3865bb7c21fa
+  data.tar.gz: ec666e930ce8ad73f39563050aaf052ddc0ed31a1778dec88cd1bf7308ddef12
 SHA512:
-  metadata.gz: 9a5991f1f7b0262f7b2e3069572d4221f0f944be86a869e9a6bb5bdabe26441305882898788840ef373dfb1671d7c2a8d9d59e1d5942e8d2df6ccc17eee1c114
-  data.tar.gz: 7e9c4dbf9f8d28970756ed8d516df46d5a4c2710754065818c2966de478ed32e1d189d0eec12de1ca5b0b23de5e077f9c4254e738442a7d4a1005e62d6a304d1
+  metadata.gz: 65062d39f1c2bd1c33ceaf3bc0d55f5be7c34728c4b9027c7b7192c5ddf8a4b3cc3e37705070b471aac7c20117946a6dae150a5e31613d36afff59bb3ab5aa39
+  data.tar.gz: e1ca0ba1c31ad442c6359d30ca338fecb840dd86839d01cf697e314b365f72da424a6f93eecb1906eafdc34e2f489f2afd9f264ce1762cd1bc2e7524711ac653

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
@@ -35,49 +35,19 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - name: install plantuml ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        uses: nick-invision/retry@v1
-        with:
-          polling_interval_seconds: 5
-          timeout_minutes: 5
-          max_attempts: 3
-          command: >
-            sudo apt-get update -y && sudo bash -c 
-            "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install plantuml
-
-      - if: matrix.os == 'windows-latest'
-        run: cinst -y plantuml
+      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
 
       - run: bundle exec rake
 
   tests-passed:
     needs: rake
     runs-on: ubuntu-latest
-    continue-on-error: true
     steps:
-      - name: Trigger tests passed event
-        uses: Sibz/github-status-action@v1
+      - uses: peter-evans/repository-dispatch@v1
         with:
-          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          context: 'tests-passed-successfully'
-          description: 'Tests passed successfully'
-          state: 'success'
-          sha: ${{ github.event.pull_request.head.sha || github.sha }}
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.gitignore

@@ -10,3 +10,5 @@ spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
 Gemfile.lock
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # 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.
-
 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

data/lib/asciidoctor/standoc/base.rb

@@ -8,6 +8,7 @@ require "isodoc"
 require "relaton"
 require "fileutils"
 require "metanorma-utils"
+require "isodoc/xslfo_convert"
 
 module Asciidoctor
   module Standoc
@@ -43,6 +44,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           htmlstylesheet: node.attr("htmlstylesheet"),
+          htmlstylesheet_override: node.attr("htmlstylesheet-override"),
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
@@ -51,6 +53,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"),
+          sectionsplit: node.attr("sectionsplit"),
         }
       end
 
@@ -59,7 +62,7 @@ module Asciidoctor
       end
 
       def doc_extract_attributes(node)
-        {
+        attrs = {
           script: node.attr("script"),
           bodyfont: node.attr("body-font"),
           headerfont: node.attr("header-font"),
@@ -67,6 +70,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           wordstylesheet: node.attr("wordstylesheet"),
+          wordstylesheet_override: node.attr("wordstylesheet-override"),
           standardstylesheet: node.attr("standardstylesheet"),
           header: node.attr("header"),
           wordcoverpage: node.attr("wordcoverpage"),
@@ -77,6 +81,14 @@ module Asciidoctor
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
         }
+
+        if font_manifest_file = node.attr("mn2pdf-font-manifest-file")
+          attrs[IsoDoc::XslfoPdfConvert::MN2PDF_OPTIONS] = {
+            IsoDoc::XslfoPdfConvert::MN2PDF_FONT_MANIFEST => font_manifest_file,
+          }
+        end
+
+        attrs
       end
 
       def doc_converter(node)

data/lib/asciidoctor/standoc/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/standoc/blocks.rb

@@ -45,8 +45,9 @@ module Asciidoctor
         noko do |xml|
           xml.figure **literal_attrs(node) do |f|
             figure_title(node, f)
-            f.pre node.lines.join("\n"), **attr_code(id: Metanorma::Utils::anchor_or_uuid,
-                                                     alt: node.attr("alt"))
+            f.pre node.lines.join("\n"),
+              **attr_code(id: Metanorma::Utils::anchor_or_uuid,
+                          alt: node.attr("alt"))
           end
         end
       end
@@ -78,9 +79,19 @@ module Asciidoctor
         example_proper(node)
       end
 
+      def svgmap_attrs(node)
+        attr_code( { id: node.id,
+                     unnumbered: node.option?("unnumbered") ? "true" : nil,
+                     number: node.attr("number"),
+                     subsequence: node.attr("subsequence") }.
+        merge(keep_attrs(node)))
+      end
+
       def svgmap_example(node)
         noko do |xml|
-          xml.svgmap **attr_code(example_attrs(node).merge(src: node.attr("src"), alt: node.attr("alt"))) do |ex|
+          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
         end.join("\n")
@@ -129,8 +140,9 @@ 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)
@@ -143,8 +155,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)
@@ -168,11 +181,12 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(keep_attrs(node).merge(lang: node.attr("language"),
-                                         id: Metanorma::Utils::anchor_or_uuid(node),
-                                         unnumbered: node.option?("unnumbered") ? "true" : nil,
-                                         number: node.attr("number"),
-                                         filename: node.attr("filename")))
+        attr_code(keep_attrs(node).
+                  merge(lang: node.attr("language"),
+                        id: Metanorma::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

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -29,7 +29,7 @@ module Asciidoctor
       def dl2_table_cleanup(xmldoc)
         q = "//table/following-sibling::*[1][self::p]"
         xmldoc.xpath(q).each do |s|
-          if s.text =~ /^\s*key[^a-z]*$/i && !s.next_element.nil? && s.next_element.name == "dl"
+          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -95,7 +95,7 @@ module Asciidoctor
       def formula_cleanup_where2(x)
         q = "//formula/following-sibling::*[1][self::p]"
         x.xpath(q).each do |s|
-          if s.text =~ /^\s*where[^a-z]*$/i && !s.next_element.nil? && s.next_element.name == "dl"
+          if s.text =~ /^\s*where[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -114,7 +114,7 @@ module Asciidoctor
       def figure_dl_cleanup2(xmldoc)
         q = "//figure/following-sibling::*[self::p]"
         xmldoc.xpath(q).each do |s|
-          if s.text =~ /^\s*key[^a-z]*$/i && !s.next_element.nil? && s.next_element.name == "dl"
+          if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
             s.next_element["key"] = "true"
             s.previous_element << s.next_element.remove
             s.remove
@@ -125,7 +125,9 @@ module Asciidoctor
       # examples containing only figures become subfigures of figures
       def subfigure_cleanup(xmldoc)
         xmldoc.xpath("//example[figure]").each do |e|
-          next unless e.elements.map { |m| m.name }.reject { |m| %w(name figure).include? m }.empty?
+          next unless e.elements.map { |m| m.name }.reject do |m|
+            %w(name figure).include? m
+          end.empty?
           e.name = "figure"
         end
       end
@@ -140,7 +142,8 @@ module Asciidoctor
       ELEMS_ALLOW_NOTES = %w[p formula ul ol dl figure].freeze
 
       # if a note is at the end of a section, it is left alone
-      # if a note is followed by a non-note block, it is moved inside its preceding block if it is not delimited
+      # if a note is followed by a non-note block, 
+      # it is moved inside its preceding block if it is not delimited
       # (so there was no way of making that block include the note)
       def note_cleanup(xmldoc)
         q = "//note[following-sibling::*[not(local-name() = 'note')]]"
@@ -150,8 +153,10 @@ module Asciidoctor
           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") }
+        xmldoc.xpath("//note[@keep-separate] | "\
+                     "//termnote[@keep-separate]").each do |n|
+          n.delete("keep-separate")
+        end
       end
 
       def requirement_cleanup(x)
@@ -184,18 +189,50 @@ module Asciidoctor
       end
 
       def requirement_cleanup1(r)
-        while d = r.at("./description[following-sibling::*[1][self::description]]")
+        while d = r.at("./description[following-sibling::*[1]"\
+            "[self::description]]")
           n = d.next.remove
           d << n.children
         end
-        r.xpath("./description[normalize-space(.)='']").each { |d| d.replace("\n") }
+        r.xpath("./description[normalize-space(.)='']").each do |d|
+          d.replace("\n")
+        end
       end
 
       def svgmap_cleanup(xmldoc)
+        svgmap_moveattrs(xmldoc)
         svgmap_populate(xmldoc)
         Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
       end
 
+      def guid?(x)
+        /^_[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i.
+          match(x)
+      end
+
+      def svgmap_moveattrs(xmldoc)
+        xmldoc.xpath("//svgmap").each do |s|
+          f = s.at(".//figure") or next
+          if t = s.at("./name") and !f.at("./name")
+            f.children.first.previous = t.remove
+          end
+          if s["id"] && guid?(f["id"])
+            f["id"] = s["id"]
+            s.delete("id")
+          end
+          svgmap_moveattrs1(s, f)
+        end
+      end
+
+      def svgmap_moveattrs1(s, f)
+        %w(unnumbered number subsequence keep-with-next
+          keep-lines-together).each do |a|
+            next if f[a] || !s[a]
+            f[a] = s[a]
+            s.delete(a)
+          end
+      end
+
       def svgmap_populate(xmldoc)
         xmldoc.xpath("//svgmap").each do |s|
           s1 = s.dup
@@ -204,8 +241,8 @@ module Asciidoctor
           s1.xpath(".//li").each do |li|
             t = li&.at(".//eref | .//link | .//xref") or next
             href = t.xpath("./following-sibling::node()")
-            next if href.empty?
-            s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
+            href.empty? or
+              s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
           end
         end
       end
@@ -215,7 +252,7 @@ module Asciidoctor
           next unless n.name == "link"
           n.children = n["target"]
         end
-        nodeset.text.sub(/^[,;]/, "").strip
+        nodeset.text.sub(/^[,; ]/, "").strip
       end
     end
   end

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -3,21 +3,26 @@ module Asciidoctor
     module Cleanup
       def external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"), @lang, @script)
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
+          @lang, @script
+        )
       end
 
       def internal_external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"), @lang, @script)
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+          @lang, @script
+        )
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
         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")
+            @log.add("Crossreferences", nil,
+                     "term source #{s['bibitemid']} not referenced")
         end
-        a = (source.empty? && term.nil?) ?  @i18n.no_terms_boilerplate :
+        a = source.empty? && term.nil? ?  @i18n.no_terms_boilerplate :
           term_defs_boilerplate_cont(source, term, isodoc)
         a and div.next = a
       end
@@ -55,7 +60,7 @@ module Asciidoctor
       end
 
       def termdef_boilerplate_cleanup(xmldoc)
-        #termdef_remove_initial_paras(xmldoc)
+        # termdef_remove_initial_paras(xmldoc)
       end
 
       def termdef_remove_initial_paras(xmldoc)
@@ -76,6 +81,7 @@ module Asciidoctor
         termdef_boilerplate_cleanup(xmldoc)
         xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
           next if f.at("./clause[@type = 'boilerplate']")
+
           term_defs_boilerplate(f.at("./title"), xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
         end
@@ -84,15 +90,16 @@ module Asciidoctor
         initial_boilerplate(xmldoc, isodoc)
       end
 
-      def initial_boilerplate(x, isodoc)
-        return if x.at("//boilerplate")
-        preface = x.at("//preface") || x.at("//sections") || x.at("//annex") ||
-          x.at("//references") || return
-        b = boilerplate(x, isodoc) or return
+      def initial_boilerplate(xml, isodoc)
+        return if xml.at("//boilerplate")
+
+        preface = xml.at("//preface") || xml.at("//sections") ||
+          xml.at("//annex") || xml.at("//references") || return
+        b = boilerplate(xml, isodoc) or return
         preface.previous = b
       end
 
-      def boilerplate_file(xmldoc)
+      def boilerplate_file(_xmldoc)
         File.join(@libdir, "boilerplate.xml")
       end
 
@@ -100,7 +107,7 @@ module Asciidoctor
         file = boilerplate_file(xml)
         file = File.join(@localdir, @boilerplateauthority) if @boilerplateauthority
         !file.nil? and File.exists?(file) or return
-        conv.populate_template((File.read(file, encoding: "UTF-8")), nil)
+        conv.populate_template(File.read(file, encoding: "UTF-8"), nil)
       end
 
       def bibdata_cleanup(xmldoc)
@@ -118,14 +125,16 @@ module Asciidoctor
       def bibdata_docidentifier_cleanup(xmldoc)
         ins = xmldoc.at("//bibdata/docidentifier")
         xmldoc.xpath("//bibdata/docidentifier").each_with_index do |b, i|
-          next if i == 0
+          next if i.zero?
+
           ins.next = b.remove
           ins = ins.next
         end
       end
 
       def gather_indirect_erefs(xmldoc, prefix)
-        xmldoc.xpath("//eref[@type = '#{prefix}']").each_with_object({}) do |e, m|
+        xmldoc.xpath("//eref[@type = '#{prefix}']")
+          .each_with_object({}) do |e, m|
           e.delete("type")
           m[e["bibitemid"]] = true
         end.keys
@@ -160,7 +169,7 @@ module Asciidoctor
       def resolve_local_indirect_erefs(xmldoc, refs, prefix)
         refs.each_with_object([]) do |r, m|
           id = r.sub(/^#{prefix}_/, "")
-          if xmldoc.at("//*[@id = '#{id}'][@type = '#{prefix}']")
+          if n = xmldoc.at("//*[@id = '#{id}']") and n.at("./ancestor-or-self::*[@type = '#{prefix}']")
             xmldoc.xpath("//eref[@bibitemid = '#{r}']").each do |e|
               indirect_eref_to_xref(e, id)
             end