metanorma-standoc 1.8.2 → 1.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c09f71739f8d485363ce3a4f950b143c0264f5b4657fd0891df83a00c44f72
-  data.tar.gz: cb0c51236e8c1780aa2a89b7a0c53efeabc2a4af3ef68e6c08aa8936efdea47d
+  metadata.gz: df453526eab7a001b67712f6f0bd885a9242d5e489e8a0d8f138bb3a2f653f1e
+  data.tar.gz: e632b1a38bff75199ae1047188702e28275ebb3563c921e2a5bc545a5c4ec43f
 SHA512:
-  metadata.gz: 96533136bca911c4f886e6d0aeaa0e86ce94cf754d721af5537c835b744980fef11555e494d5d485a348c1ea911d1394cfb215f9f02cbf095a90bd652cae2916
-  data.tar.gz: 80bd100da6d8d05fdc69f8f52d20e9af182bd3196c42074663241dc8e35bee952eb8bf7ef95fbf444dbcd25f1bd45ac7d864f70c394df372f8d24b1e26a385d7
+  metadata.gz: 44bba71bdd21993acfd38de5d3ae020df5bf569a31c0bd208b223a2bef628093f476ae9bf18e3f8e1f716b898238648a9f14ffe24446148e38e0719340b826ff
+  data.tar.gz: 40a66dea77906193f52dd4fd99023963a1e0ed1f6e584832bef19022e5278933ba28c85e7624feb0282f94f1e95471a13340a189dbd61835129c3f5f8d10f0b4

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:
-  TargetRubyVersion: 2.6
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -43,6 +43,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"),
@@ -67,6 +68,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"),
@@ -139,7 +141,7 @@ module Asciidoctor
 
       def document(node)
         init(node)
-        ret = makexml(node).to_xml(indent: 2)
+        ret = makexml(node).to_xml(encoding: "US-ASCII", indent: 2)
         outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
         clean_exit
         ret

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
@@ -74,11 +75,30 @@ module Asciidoctor
         %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"
         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(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")
+      end
+
+      # prevent A's and other subs inappropriate for pseudocode
       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 **example_attrs(node).merge(class: "pseudocode") do |ex|
@@ -120,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)
@@ -134,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)
@@ -159,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.rb

@@ -58,6 +58,7 @@ module Asciidoctor
         bookmark_cleanup(xmldoc)
         requirement_cleanup(xmldoc)
         bibdata_cleanup(xmldoc)
+        svgmap_cleanup(xmldoc)
         boilerplate_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
         variant_cleanup(xmldoc)
@@ -171,7 +172,7 @@ module Asciidoctor
 
       def img_cleanup(xmldoc)
         return xmldoc unless @datauriimage
-        xmldoc.xpath("//image").each { |i| i["src"] = datauri(i["src"]) }
+        xmldoc.xpath("//image").each { |i| i["src"] = Metanorma::Utils::datauri(i["src"], @localdir) }
       end
 
       def variant_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,6 +1,5 @@
 require "date"
 require "htmlentities"
-require "json"
 require "open-uri"
 
 module Asciidoctor
@@ -22,9 +21,7 @@ module Asciidoctor
       def dl1_table_cleanup(xmldoc)
         q = "//table/following-sibling::*[1][self::dl]"
         xmldoc.xpath(q).each do |s|
-          if s["key"] == "true"
-            s.previous_element << s.remove
-          end
+          s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
@@ -32,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
@@ -91,16 +88,14 @@ module Asciidoctor
       def formula_cleanup_where1(x)
         q = "//formula/following-sibling::*[1][self::dl]"
         x.xpath(q).each do |s|
-          if s["key"] == "true"
-            s.previous_element << s.remove
-          end
+          s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
       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
@@ -111,9 +106,7 @@ module Asciidoctor
       def figure_dl_cleanup1(xmldoc)
         q = "//figure/following-sibling::*[self::dl]"
         xmldoc.xpath(q).each do |s|
-          if s["key"] == "true"
-            s.previous_element << s.remove
-          end
+          s["key"] == "true" and s.previous_element << s.remove
         end
       end
 
@@ -121,8 +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
@@ -133,8 +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
@@ -146,11 +139,10 @@ module Asciidoctor
         subfigure_cleanup(xmldoc)
       end
 
-      ELEMS_ALLOW_NOTES =
-        %w[p formula ul ol dl figure].freeze
+      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,
+      # 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)
@@ -161,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)
@@ -195,7 +189,8 @@ 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
@@ -203,6 +198,62 @@ module Asciidoctor
           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
+          s.children.remove
+          f = s1.at(".//figure") and s << f
+          s1.xpath(".//li").each do |li|
+            t = li&.at(".//eref | .//link | .//xref") or next
+            href = t.xpath("./following-sibling::node()")
+            href.empty? or
+              s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
+          end
+        end
+      end
+
+      def svgmap_target(nodeset)
+        nodeset.each do |n|
+          next unless n.name == "link"
+          n.children = n["target"]
+        end
+        nodeset.text.sub(/^[,; ]/, "").strip
+      end
     end
   end
 end