metanorma-standoc 1.8.5 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65dcd1f22a2224fb908c38f21bec75287e1568269b080f2b53ae9eda9963c2d9
-  data.tar.gz: d9912320a4f7319c2bd132e169dc315d52f3ee48a724b046f1c1c36f510ae079
+  metadata.gz: 03a2df03031208cf9cd54413c1dc342f748c3978a2e189f9cf4ae369fcc1820c
+  data.tar.gz: fc94c4cc2a0e117c06f41d709d8e5d6a6f3f0ba6e1ffc8a6ccdfb60b91ed3ffd
 SHA512:
-  metadata.gz: 6f2af97c651cd815e92dc61df5e81dbbfe4509abb82ba491674f72b722fadd7ba3f580870e7444e41e15357b4290f29ae99b6222b88115e45a571eae17f14836
-  data.tar.gz: 75dec696a85df288ea1b94c36e6608408c2c53bc5e8c163f8a7b817d8a43d50f10a4d0ae2a098fed331224cb322cdd6ba35509f7504fb3ea4d322819fa829e65
+  metadata.gz: 32bac104b6523e30e510ada3e1e25861139b62c66c8d7bbcb782284648622b5f1da48acd8a6e97f511ead0baca45c7903ac7f31c1023596becc473d08deea87f
+  data.tar.gz: 4c0ee4e816c81ca1e98d5bbbb47ad2c755feca016c0b5ddae5283688291813e0d1d511444835d7bee1979dc49ef3d664a7d1966938b46b3a5ad0f2dd9a0da6d2

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)
@@ -96,10 +108,15 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") && node.attr("mn-keep-asciimath") != "false"
+        @keepasciimath = node.attr("mn-keep-asciimath") &&
+          node.attr("mn-keep-asciimath") != "false"
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        @filename = node.attr("docfile") ?  File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
+        if node.attr("docfile")
+          @filename = File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+        else
+          @filename = ""
+        end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -131,10 +148,12 @@ module Asciidoctor
       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")
+        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)
@@ -151,12 +170,21 @@ module Asciidoctor
       end
 
       def clean_exit
-        @log.write(@output_dir + @filename + ".err") unless @novalid
+        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
+
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
+      def clean_abort(msg, file = nil)
+        file and
+          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
+        clean_exit
+        abort(msg)
+      end
+
       def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>", "<#{xml_root_tag} type='semantic' version='#{version}'>"]
+        result = ["<?xml version='1.0' encoding='UTF-8'?>",
+                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -191,36 +219,13 @@ module Asciidoctor
         end
       end
 
-      def default_script(lang)
-        case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
-        else
-          "Latn"
-        end
-      end
-
       private
 
       def outputdir(node)
-        if node.attr("output_dir").nil_or_empty? then Metanorma::Utils::localdir(node)
-        else File.join(node.attr("output_dir"), "")
+        if node.attr("output_dir").nil_or_empty?
+          Metanorma::Utils::localdir(node)
+        else
+          File.join(node.attr("output_dir"), "")
         end
       end
     end

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,12 +140,14 @@ 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)
         return termsource(node) if node.role == "source"
+
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content
@@ -143,8 +156,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 +182,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/blocks_notes.rb

@@ -12,9 +12,11 @@ module Asciidoctor
       end
 
       def note_attrs(node)
-        attr_code(termnote_attrs(node).merge(
-          type: node.attr("type"),
-          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(termnote_attrs(node)
+          .merge(
+        type: node.attr("type"),
+        beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+        ))
       end
 
       def sidebar_attrs(node)
@@ -24,6 +26,7 @@ module Asciidoctor
 
       def sidebar(node)
         return unless draft?
+
         noko do |xml|
           xml.review **(sidebar_attrs(node)) do |r|
             wrap_in_para(node, r)
@@ -33,33 +36,34 @@ module Asciidoctor
 
       def todo_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match date
+        date += "T00:00:00Z" unless /T/.match? date
         attr_code(
           id: ::Metanorma::Utils::anchor_or_uuid(node),
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
-          date: date )
+          date: date
+        )
       end
 
       def todo(node)
         noko do |xml|
-          xml.review **(todo_attrs(node)) do |r|
+          xml.review **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
       end
 
-      def termnote(n)
+      def termnote(node)
         noko do |xml|
-          xml.termnote **termnote_attrs(n) do |ex|
-            wrap_in_para(n, ex)
+          xml.termnote **termnote_attrs(node) do |ex|
+            wrap_in_para(node, ex)
           end
         end.join("\n")
       end
 
-      def note(n)
+      def note(node)
         noko do |xml|
-          xml.note **note_attrs(n) do |c|
-            wrap_in_para(n, c)
+          xml.note **note_attrs(node) do |c|
+            wrap_in_para(node, c)
           end
         end.join("\n")
       end
@@ -69,14 +73,16 @@ module Asciidoctor
         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: Metanorma::Utils::anchor_or_uuid(node), type: name,
-                  beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(keep_attrs(node)
+          .merge(id: Metanorma::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 }

data/lib/asciidoctor/standoc/cleanup.rb

@@ -2,27 +2,29 @@ require "nokogiri"
 require "pathname"
 require "open-uri"
 require "html2doc"
-require_relative "./cleanup_block.rb"
-require_relative "./cleanup_footnotes.rb"
-require_relative "./cleanup_ref.rb"
-require_relative "./cleanup_ref_dl.rb"
-require_relative "./cleanup_boilerplate.rb"
-require_relative "./cleanup_section.rb"
-require_relative "./cleanup_terms.rb"
-require_relative "./cleanup_inline.rb"
-require_relative "./cleanup_amend.rb"
-require_relative "./cleanup_maths.rb"
+require_relative "./cleanup_block"
+require_relative "./cleanup_footnotes"
+require_relative "./cleanup_ref"
+require_relative "./cleanup_ref_dl"
+require_relative "./cleanup_boilerplate"
+require_relative "./cleanup_section"
+require_relative "./cleanup_terms"
+require_relative "./cleanup_inline"
+require_relative "./cleanup_amend"
+require_relative "./cleanup_maths"
+require_relative "./cleanup_image"
+require_relative "./cleanup_reqt"
 require "relaton_iev"
 
 module Asciidoctor
   module Standoc
     module Cleanup
       def textcleanup(result)
-        text = result.flatten.map { |l| l.sub(/\s*$/, "") }  * "\n"
+        text = result.flatten.map { |l| l.sub(/\s*$/, "") } * "\n"
         !@keepasciimath and text = asciimath2mathml(text)
         text = text.gsub(/\s+<fn /, "<fn ")
         text.gsub(%r{<passthrough\s+formats="metanorma">([^<]*)
-                  </passthrough>}mx) { |m| HTMLEntities.new.decode($1) }
+                  </passthrough>}mx) { HTMLEntities.new.decode($1) }
       end
 
       def cleanup(xmldoc)
@@ -73,22 +75,24 @@ module Asciidoctor
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         xmldoc.traverse do |n|
           next unless n.text?
+
           if @smartquotes
             /[-'"(<>]|\.\.|\dx/.match(n) or next
-            n.ancestors("pre, tt, sourcecode, bibdata, on, stem, figure[@class = 'pseudocode']").empty? or next
+
+            n.ancestors("pre, tt, sourcecode, bibdata, on, "\
+                        "stem, figure[@class = 'pseudocode']").empty? or next
             n.replace(Metanorma::Utils::smartformat(n.text))
           else
-            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'"))#.
-            #gsub(/</, "&lt;").gsub(/>/, "&gt;"))
+            n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
+            # gsub(/</, "&lt;").gsub(/>/, "&gt;"))
           end
         end
       end
 
-      def docidentifier_cleanup(xmldoc)
-      end
+      def docidentifier_cleanup(xmldoc); end
 
       TEXT_ELEMS =
-        %w{status language script version author name callout phone email 
+        %w{status language script version author name callout phone email
            street city state country postcode identifier referenceFrom surname
            referenceTo docidentifier docnumber prefix initial addition forename
            title draft secretariat title-main title-intro title-part}.freeze
@@ -110,57 +114,6 @@ module Asciidoctor
         xmldoc.traverse { |n| n.name = n.name.gsub(/_/, "-") }
       end
 
-      def link_callouts_to_annotations(callouts, annotations)
-        callouts.each_with_index do |c, i|
-          c["target"] = "_" + UUIDTools::UUID.random_create
-          annotations[i]["id"] = c["target"]
-        end
-      end
-
-      def align_callouts_to_annotations(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
-          callouts.size == annotations.size and
-            link_callouts_to_annotations(callouts, annotations)
-        end
-      end
-
-      def merge_annotations_into_sourcecode(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          while x&.next_element&.name == "annotation"
-            x.next_element.parent = x
-          end
-        end
-      end
-
-      def callout_cleanup(xmldoc)
-        merge_annotations_into_sourcecode(xmldoc)
-        align_callouts_to_annotations(xmldoc)
-      end
-
-      def sourcecode_cleanup(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          x.traverse do |n|
-            next unless n.text?
-            next unless /#{Regexp.escape(@sourcecode_markup_start)}/.match(n.text)
-            n.replace(sourcecode_markup(n))
-          end
-        end
-      end
-
-      def sourcecode_markup(n)
-        acc = []
-        n.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|#{Regexp.escape(@sourcecode_markup_end)})/).
-          each_slice(4).map do |a|
-          acc << Nokogiri::XML::Text.new(a[0], n.document).
-            to_xml(encoding: "US-ASCII", save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
-          next unless a.size == 4
-          acc << Asciidoctor.convert(a[2], backend: (self&.backend&.to_sym || :standoc), doctype: :inline)
-        end
-        acc.join
-      end
-
       # allows us to deal with doc relation localities,
       # temporarily stashed to "bpart"
       def bpart_cleanup(xmldoc)
@@ -170,23 +123,24 @@ module Asciidoctor
         end
       end
 
-      def img_cleanup(xmldoc)
-        return xmldoc unless @datauriimage
-        xmldoc.xpath("//image").each { |i| i["src"] = Metanorma::Utils::datauri(i["src"], @localdir) }
-      end
-
       def variant_cleanup(xmldoc)
         xmldoc.xpath("//*[variant]").each do |c|
-          c&.next&.text? && c&.next&.next&.name == "variant" && c.next.text.gsub(/\s/, "").empty? and
+          c&.next&.text? && c&.next&.next&.name == "variant" &&
+            c.next.text.gsub(/\s/, "").empty? and
             c.next.remove
         end
         xmldoc.xpath("//*[variant]").each do |c|
-          next unless c.children.any? { |n| n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?) }
+          next unless c.children.any? do |n|
+            n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
+          end
+
           c.xpath("./variant").each do |n|
-            if n.at_xpath('preceding-sibling::node()[not(self::text()[not(normalize-space())])][1][self::variantwrap]')
+            if n.at_xpath("preceding-sibling::node()"\
+                "[not(self::text()[not(normalize-space())])][1]"\
+                "[self::variantwrap]")
               n.previous_element << n
             else
-              n.replace('<variantwrap/>').first << n
+              n.replace("<variantwrap/>").first << n
             end
           end
         end