isodoc 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d5c91b697c02cdac2a8221f2995d29f812804b48039967bd94c8aef7ce10c0
-  data.tar.gz: cf66a1f8d4eb41297360341e0da8d16a9ddf0af2679f072d758a259186a291bd
+  metadata.gz: c36b5db70dc3eb379ad1f903a8707b7c9403474e55f0fe99b9218536d0651c9a
+  data.tar.gz: 33e3a3e805b97042ac336754d43c47162e0d3e8851649514c20e4d5ede0301c0
 SHA512:
-  metadata.gz: 4cfa5637d6c22e73dd2a6c5bc32841183691a5db4121102787fad3caddd61815541e7128b624f03d20bf00d1e94fed81e43aaa19d1b84260e7bde5cfc69d924e
-  data.tar.gz: 7015f57396172858edb4b8499e6c4706894ef540f6b96c95d5c9bf445580003a8e68d4930204e5731ec57dafa460c2cfbcf4da5572e82713070fd214bef5974e
+  metadata.gz: 7ec36b6afb9cdb96291f75a78740d5cd555d898fa9bce309904a7ac54408c8ad90f2f4dcb5fe5e97aeb08526f6659d317a42537466801f9abbc4735b8fa23a39
+  data.tar.gz: ffb1143efd27cf641cc9b336b9ff538bb6c6c5153cdc351f0e9edb8f4c7f029793267b47caa5682e9ce886ac9e30ea7c0601d1b91eca88a62f92ccb675294fc5

data/.github/workflows/rake.yml

@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,12 +1,10 @@
-# 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.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 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

data/isodoc.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "liquid", "~> 4"
   spec.add_dependency "metanorma", ">= 1.2.0"
-  spec.add_dependency "nokogiri", "~> 1.10.4"
+  spec.add_dependency "nokogiri", "~> 1.11.0"
   spec.add_dependency "relaton-cli"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "thread_safe"

data/lib/isodoc.rb

@@ -8,7 +8,6 @@ require "mime/types"
 require "image_size"
 require "set"
 require "pp"
-require "uuidtools"
 require "html2doc"
 require "liquid"
 require "htmlentities"
@@ -26,5 +25,4 @@ require "isodoc/xref"
 require "isodoc/i18n"
 
 module IsoDoc
-
 end

data/lib/isodoc/convert.rb

@@ -32,10 +32,12 @@ module IsoDoc
     # monospace: font to use for monospace text
     # suppressheadingnumbers: suppress heading numbers for clauses
     # scripts: Scripts file for HTML
+    # scripts_override: Override scripts file for HTML
     # scripts_pdf: Scripts file for PDF (not used in XSLT PDF)
     # datauriimage: Encode images in HTML output as data URIs
     # break_up_urls_in_tables: whether to insert spaces in URLs in tables
     #   every 40-odd chars
+    # bare: do not insert any prefatory material (coverpage, boilerplate)
     def initialize(options)
       @libdir ||= File.dirname(__FILE__) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
       options.merge!(default_fonts(options)) do |_, old, new|
@@ -64,12 +66,14 @@ module IsoDoc
       @scripts = options[:scripts] ||
         File.join(File.dirname(__FILE__), "base_style", "scripts.html")
       @scripts_pdf = options[:scripts_pdf]
+      @scripts_override = options[:scripts_override]
       @i18nyaml = options[:i18nyaml]
       @ulstyle = options[:ulstyle]
       @olstyle = options[:olstyle]
       @datauriimage = options[:datauriimage]
       @suppressheadingnumbers = options[:suppressheadingnumbers]
       @break_up_urls_in_tables = options[:break_up_urls_in_tables] == "true"
+      @bare = options[:bare]
       @termdomain = ""
       @termexample = false
       @note = false

data/lib/isodoc/function/cleanup.rb

@@ -1,16 +1,17 @@
 module IsoDoc::Function
   module Cleanup
     def textcleanup(docxml)
-      docxml = termref_cleanup(passthrough_cleanup(docxml))
+      termref_cleanup(passthrough_cleanup(docxml))
     end
 
     def termref_cleanup(docxml)
-      docxml.
-        gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@i18n.modified} [/TERMREF]")).
-        gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ").
-        gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: ")).
-        gsub(%r{\s*\[\/TERMREF\]\s*}, l10n("]")).
-        gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
+      docxml
+        .gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/,
+              l10n(", #{@i18n.modified} [/TERMREF]"))
+        .gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ")
+        .gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: "))
+        .gsub(%r{\s*\[/TERMREF\]\s*}, l10n("]"))
+        .gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
     end
 
     def passthrough_cleanup(docxml)
@@ -21,7 +22,7 @@ module IsoDoc::Function
     end
 
     def cleanup(docxml)
-      @i18n ||= i18n_init(@lang, @script) 
+      @i18n ||= i18n_init(@lang, @script)
       comment_cleanup(docxml)
       footnote_cleanup(docxml)
       inline_header_cleanup(docxml)
@@ -34,30 +35,36 @@ module IsoDoc::Function
 
     def table_long_strings_cleanup(docxml)
       return unless @break_up_urls_in_tables == true
+
       docxml.xpath("//td | //th").each do |d|
         d.traverse do |n|
           next unless n.text?
+
           n.replace(HTMLEntities.new.encode(
-            break_up_long_strings(n.text)))
+                      break_up_long_strings(n.text),
+                    ))
         end
       end
     end
 
-    def break_up_long_strings(t)
-      return t if t.match(/^\s*$/)
-      t.split(/(?=\s)/).map do |w|
-        (/^\s*$/.match(t) or w.size < 30) ? w :
+    def break_up_long_strings(text)
+      return text if /^\s*$/.match?(text)
+
+      text.split(/(?=\s)/).map do |w|
+        if /^\s*$/.match(text) || (w.size < 30) then w
+        else
           w.scan(/.{,30}/).map do |w1|
-          (w1.size < 30) ? w1 : break_up_long_strings1(w1)
-        end.join
+            w1.size < 30 ? w1 : break_up_long_strings1(w1)
+          end.join
+        end
       end.join
     end
 
-    def break_up_long_strings1(w1)
-      s = w1.split(%r{(?<=[,.?+;/=])})
-      if s.size == 1 then w1 + " "
+    def break_up_long_strings1(text)
+      s = text.split(%r{(?<=[,.?+;/=])})
+      if s.size == 1 then "#{text} "
       else
-        s[-1] = " " + s[-1]
+        s[-1] = " #{s[-1]}"
         s.join
       end
     end
@@ -78,11 +85,11 @@ module IsoDoc::Function
       docxml
     end
 
-    def figure_get_or_make_dl(t)
-      dl = t.at(".//dl")
+    def figure_get_or_make_dl(elem)
+      dl = elem.at(".//dl")
       if dl.nil?
-        t.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
-        dl = t.at(".//dl")
+        elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
+        dl = elem.at(".//dl")
       end
       dl
     end
@@ -91,10 +98,10 @@ module IsoDoc::Function
       "//div[@class = 'figure'][descendant::aside]"\
       "[not(descendant::div[@class = 'figure'])]".freeze
 
-    def figure_aside_process(f, aside, key)
+    def figure_aside_process(elem, aside, key)
       # get rid of footnote link, it is in diagram
-      f&.at("./a[@class='TableFootnoteRef']")&.remove
-      fnref = f.at(".//span[@class='TableFootnoteRef']/..")
+      elem&.at("./a[@class='TableFootnoteRef']")&.remove
+      fnref = elem.at(".//span[@class='TableFootnoteRef']/..")
       dt = key.add_child("<dt></dt>").first
       dd = key.add_child("<dd></dd>").first
       fnref.parent = dt
@@ -109,6 +116,7 @@ module IsoDoc::Function
     def figure_cleanup(docxml)
       docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
         next unless f.at(".//aside[not(ancestor::p[@class = 'FigureTitle'])]")
+
         key = figure_get_or_make_dl(f)
         f.xpath(".//aside").each do |aside|
           figure_aside_process(f, aside, key)
@@ -137,12 +145,13 @@ module IsoDoc::Function
       docxml
     end
 
-    def merge_fnref_into_fn_text(a)
-      fn = a.at('.//span[@class="TableFootnoteRef"]/..')
+    def merge_fnref_into_fn_text(elem)
+      fn = elem.at('.//span[@class="TableFootnoteRef"]/..')
       n = fn.next_element
       n&.children&.first&.add_previous_sibling(fn.remove)
     end
 
+    # preempt html2doc putting MsoNormal under TableFootnote class
     def table_footnote_cleanup(docxml)
       docxml.xpath("//table[descendant::aside]").each do |t|
         t.xpath(".//aside").each do |a|
@@ -152,36 +161,36 @@ module IsoDoc::Function
           t << a.remove
         end
       end
-      # preempt html2doc putting MsoNormal there
       docxml.xpath("//p[not(self::*[@class])]"\
                    "[ancestor::*[@class = 'TableFootnote']]").each do |p|
         p["class"] = "TableFootnote"
       end
     end
 
-    def remove_bottom_border(td)
-      td["style"] =
-        td["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
+    def remove_bottom_border(cell)
+      cell["style"] =
+        cell["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
     end
 
-    def table_get_or_make_tfoot(t)
-      tfoot = t.at(".//tfoot")
+    def table_get_or_make_tfoot(table)
+      tfoot = table.at(".//tfoot")
       if tfoot.nil?
-        t.add_child("<tfoot></tfoot>")
-        tfoot = t.at(".//tfoot")
+        table.add_child("<tfoot></tfoot>")
+        tfoot = table.at(".//tfoot")
       else
         tfoot.xpath(".//td | .//th").each { |td| remove_bottom_border(td) }
       end
       tfoot
     end
 
-    def new_fullcolspan_row(t, tfoot)
+    def new_fullcolspan_row(table, tfoot)
       # how many columns in the table?
       cols = 0
-      t.at(".//tr").xpath("./td | ./th").each do |td|
+      table.at(".//tr").xpath("./td | ./th").each do |td|
         cols += (td["colspan"] ? td["colspan"].to_i : 1)
       end
-      style = %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
+      style =
+        %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
       tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
       tfoot.xpath(".//td").last
     end
@@ -206,12 +215,12 @@ module IsoDoc::Function
 
     def symbols_cleanup(docxml); end
 
-    def table_footnote_reference_format(a)
-      a
+    def table_footnote_reference_format(link)
+      link
     end
 
-    def footnote_reference_format(a)
-      a
+    def footnote_reference_format(link)
+      link
     end
   end
 end

data/lib/isodoc/function/inline.rb

@@ -3,11 +3,12 @@ require_relative "inline_simple"
 module IsoDoc::Function
   module Inline
     def link_parse(node, out)
-      out.a **attr_code(href: node["target"], title: node["alt"]) do |l|
+      url = node["target"]
+      node["updatetype"] == "true" and url = suffix_url(url)
+      out.a **attr_code(href: url, title: node["alt"]) do |l|
         if node.text.empty?
           l << node["target"].sub(/^mailto:/, "")
-        else
-          node.children.each { |n| parse(n, l) }
+        else node.children.each { |n| parse(n, l) }
         end
       end
     end
@@ -79,8 +80,7 @@ module IsoDoc::Function
                "#{@openmathdelim}#{HTMLEntities.new.encode(node.text)}"\
                  "#{@closemathdelim}"
              when "MathML" then node.first_element_child.to_s
-             else
-               HTMLEntities.new.encode(node.text)
+             else HTMLEntities.new.encode(node.text)
              end
       out.span **{ class: "stem" } do |span|
         span.parent.add_child ooml
@@ -123,13 +123,13 @@ module IsoDoc::Function
     end
 
     def add_parse(node, out)
-      out.span **{class: "addition"} do |e|
+      out.span **{ class: "addition" } do |e|
         node.children.each { |n| parse(n, e) }
       end
     end
 
     def del_parse(node, out)
-      out.span **{class: "deletion"} do |e|
+      out.span **{ class: "deletion" } do |e|
         node.children.each { |n| parse(n, e) }
       end
     end

data/lib/isodoc/function/section.rb

@@ -8,11 +8,11 @@ module IsoDoc::Function
       insert_tab(out, 1)
     end
 
-    def inline_header_title(out, node, title)
+    def inline_header_title(out, _node, title)
       out.span **{ class: "zzMoveToFollowing" } do |s|
         s.b do |b|
           title&.children&.each { |c2| parse(c2, b) }
-          clausedelimspace(out) if /\S/.match(title&.text)
+          clausedelimspace(out) if /\S/.match?(title&.text)
         end
       end
     end
@@ -20,12 +20,14 @@ module IsoDoc::Function
     # used for subclauses
     def clause_parse_title(node, div, title, out, header_class = {})
       return if title.nil?
+
       if node["inline-header"] == "true"
         inline_header_title(out, node, title)
       else
-        depth = (title && title["depth"]) ? title["depth"] :
-          node.ancestors("clause, annex, terms, references, definitions, "\
-                        "acknowledgements, introduction, foreword").size + 1
+        depth = if title && title["depth"] then title["depth"]
+                else node.ancestors("clause, annex, terms, references, definitions, "\
+                                    "acknowledgements, introduction, foreword").size + 1
+                end
         div.send "h#{depth}", **attr_code(header_class) do |h|
           title&.children&.each { |c2| parse(c2, h) }
         end
@@ -49,8 +51,11 @@ module IsoDoc::Function
     def clause_name(_num, title, div, header_class)
       header_class = {} if header_class.nil?
       div.h1 **attr_code(header_class) do |h1|
-        title.is_a?(String) ? h1 << title :
+        if title.is_a?(String)
+          h1 << title
+        else
           title&.children&.each { |c2| parse(c2, h1) }
+        end
       end
       div.parent.at(".//h1")
     end
@@ -66,8 +71,9 @@ module IsoDoc::Function
       end
     end
 
-    def annex_name(annex, name, div)
+    def annex_name(_annex, name, div)
       return if name.nil?
+
       div.h1 **{ class: "Annex" } do |t|
         name.children.each { |c2| parse(c2, t) }
       end
@@ -144,7 +150,6 @@ module IsoDoc::Function
 
     def introduction(isoxml, out)
       f = isoxml.at(ns("//introduction")) || return
-      title_attr = { class: "IntroTitle" }
       page_break(out)
       out.div **{ class: "Section3", id: f["id"] } do |div|
         clause_name(nil, f.at(ns("./title")), div, { class: "IntroTitle" })
@@ -160,7 +165,7 @@ module IsoDoc::Function
       out.div **attr_code(id: f["id"]) do |s|
         clause_name(nil, f.at(ns("./title")) || @i18n.foreword, s,
                     { class: "ForewordTitle" })
-        #s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @i18n.foreword }
+        # s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @i18n.foreword }
         f.elements.each { |e| parse(e, s) unless e.name == "title" }
       end
     end
@@ -187,12 +192,11 @@ module IsoDoc::Function
     end
 
     def preface(isoxml, out)
-      title_attr = { class: "IntroTitle" }
       isoxml.xpath(ns("//preface/clause | //preface/references | "\
                       "//preface/definitions | //preface/terms")).each do |f|
         page_break(out)
         out.div **{ class: "Section3", id: f["id"] } do |div|
-          clause_name(nil, f&.at(ns("./title")), div, title_attr)
+          clause_name(nil, f&.at(ns("./title")), div, { class: "IntroTitle" })
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -202,37 +206,46 @@ module IsoDoc::Function
 
     def is_clause?(name)
       %w(clause references definitions terms foreword introduction abstract
-      acknowledgements).include? name
+         acknowledgements).include? name
     end
 
     def preface_block(isoxml, out)
       p = isoxml.at(ns("//preface")) or return
       p.elements.each do |e|
         next if is_clause?(e.name)
+
         parse(e, out)
       end
     end
 
     def copyright_parse(node, out)
-      out.div **{class: "boilerplate-copyright"} do |div|
+      return if @bare
+
+      out.div **{ class: "boilerplate-copyright" } do |div|
         node.children.each { |n| parse(n, div) }
       end
     end
 
     def license_parse(node, out)
-      out.div **{class: "boilerplate-license"} do |div|
+      return if @bare
+
+      out.div **{ class: "boilerplate-license" } do |div|
         node.children.each { |n| parse(n, div) }
       end
     end
 
     def legal_parse(node, out)
-      out.div **{class: "boilerplate-legal"} do |div|
+      return if @bare
+
+      out.div **{ class: "boilerplate-legal" } do |div|
         node.children.each { |n| parse(n, div) }
       end
     end
 
     def feedback_parse(node, out)
-      out.div **{class: "boilerplate-feedback"} do |div|
+      return if @bare
+
+      out.div **{ class: "boilerplate-feedback" } do |div|
         node.children.each { |n| parse(n, div) }
       end
     end