isodoc 1.6.2 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d6934377164c2124ffca74e9ac663f4761d9a2cd98724d3214282d92afd086
-  data.tar.gz: b4ee6a1da7b45282dc01c025495b0071a3dcd382a5d76d31d4caeb299c3bf1f9
+  metadata.gz: ffc474474290bb4fbd16f4e488e94366bd18e22d19c8041fbc5a01858fefb346
+  data.tar.gz: 753d8c7b604eb1afe6eaea153e58d1eec4a249676eec23b480181566a9f37557
 SHA512:
-  metadata.gz: f49d1f973ae0ee52d01c5d608057c04c44afe180427215a880158d13d322fb87fb0d8ee4d486dcdb35cf652645044194ac5bf322987fcbdc73aca3aae4966766
-  data.tar.gz: 190b64f33fff0f3455ed7efbbb22f3f917b1249253f745ee61c9314a3638ad904cf005c8916c7734da7c962765e458d25ded2712bdf155d2f0a221d60ee7e789
+  metadata.gz: 68977dc8fe66bc0d62cce9676dc55479a0789bcf68e6d5e0f12f2e7d586c777b1d37be754385fb71856ba80fa9aca60d2d3dbadeeee6f9ecbb7b47660c2fb57f
+  data.tar.gz: 54a4312fb6b6b353146e28a7844e7e0daaf77a19d5754c34e520d0514f8c73610be103986b61140b3605fa3d7bd6851f2c27eefe6c3101723e624fd87fead776

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' ]
         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
+  TargetRubyVersion: 2.5

data/Rakefile

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

data/isodoc.gemspec

@@ -26,14 +26,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciimath"
   spec.add_dependency "html2doc", "~> 1.1.1"
   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"
@@ -50,5 +50,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "sassc", "~> 2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "metanorma-iso"
   spec.add_development_dependency "timecop", "~> 0.9"
 end

data/lib/isodoc-yaml/i18n-en.yaml

@@ -14,6 +14,7 @@ termsdefsymbols: Terms, definitions and symbols
 termsdefabbrev: Terms, definitions and abbreviated terms
 normref: Normative references
 bibliography: Bibliography
+preface: Preface
 clause: Clause
 annex: Annex
 appendix: Appendix

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -14,6 +14,7 @@ termsdefsymbols: Terms, définitions et symboles
 termsdefabbrev: Terms, définitions et termes abrégés
 normref: Références normatives
 bibliography: Bibliographie
+preface: Préface
 clause: Article
 annex: Annexe
 appendix: Appendice

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -14,6 +14,7 @@ termsdefsymbols: 术语、定义、符号和代号
 termsdefabbrev: 术语、定义、符号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
+preface: 序言
 clause: 条
 annex: 附件
 appendix: 附录

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,13 @@ 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
+    # sectionsplit: split up HTML output on sections
+    # 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 +67,15 @@ 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"
+      @sectionsplit = options[:sectionsplit] == "true"
+      @bare = options[:bare]
       @termdomain = ""
       @termexample = false
       @note = false
@@ -150,7 +156,7 @@ module IsoDoc
       [docxml, filename, dir]
     end
 
-    def convert(input_filename, file = nil, debug = false, 
+    def convert(input_filename, file = nil, debug = false,
                 output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)

data/lib/isodoc/function/blocks.rb

@@ -14,10 +14,11 @@ module IsoDoc::Function
       end
     end
 
-    def figure_name_parse(node, div, name)
-      return if name.nil? 
+    def figure_name_parse(_node, div, name)
+      return if name.nil?
+
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-        name.children.each { |n| parse(n, div) }
+        name.children.each { |n| parse(n, p) }
       end
     end
 
@@ -61,7 +62,7 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      return if name.nil? 
+      return if name.nil?
 
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
         name.children.each { |n| parse(n, p) }

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