isodoc 1.6.0 → 1.6.1

data/lib/isodoc/html_convert.rb

@@ -1,7 +1,7 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
-require_relative "html_function/postprocess.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
+require_relative "html_function/postprocess"
 
 module IsoDoc
   class HtmlConvert < ::IsoDoc::Convert

data/lib/isodoc/html_function/postprocess.rb

@@ -1,4 +1,5 @@
 require "isodoc/html_function/mathvariant_to_plain"
+require_relative "postprocess_footnotes"
 
 module IsoDoc::HtmlFunction
   module Html
@@ -46,6 +47,7 @@ module IsoDoc::HtmlFunction
 
     def htmlstylesheet(file)
       return if file.nil?
+
       file.open if file.is_a?(Tempfile)
       stylesheet = file.read
       xml = Nokogiri::XML("<style/>")
@@ -57,6 +59,7 @@ module IsoDoc::HtmlFunction
 
     def htmlstyle(docxml)
       return docxml unless @htmlstylesheet
+
       title = docxml.at("//*[local-name() = 'head']/*[local-name() = 'title']")
       head = docxml.at("//*[local-name() = 'head']")
       head << htmlstylesheet(@htmlstylesheet)
@@ -77,7 +80,7 @@ module IsoDoc::HtmlFunction
     def authority_cleanup1(docxml, klass)
       dest = docxml.at("//div[@id = 'boilerplate-#{klass}-destination']")
       auth = docxml.at("//div[@id = 'boilerplate-#{klass}' or @class = 'boilerplate-#{klass}']")
-      auth&.xpath(".//h1[not(text())] | .//h2[not(text())]")&.each { |h| h.remove }
+      auth&.xpath(".//h1[not(text())] | .//h2[not(text())]")&.each(&:remove)
       auth&.xpath(".//h1 | .//h2")&.each { |h| h["class"] = "IntroTitle" }
       dest and auth and dest.replace(auth.remove)
     end
@@ -92,14 +95,18 @@ module IsoDoc::HtmlFunction
       doc = to_xhtml_fragment(File.read(@htmlcoverpage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="title-section"]')
       # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
-      d.children.first.add_previous_sibling populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+      d.children.first.add_previous_sibling(
+        populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+      )
     end
 
     def html_intro(docxml)
       doc = to_xhtml_fragment(File.read(@htmlintropage, encoding: "UTF-8"))
       d = docxml.at('//div[@class="prefatory-section"]')
       # d.children.first.add_previous_sibling doc.to_xml(encoding: "US-ASCII")
-      d.children.first.add_previous_sibling populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+      d.children.first.add_previous_sibling(
+        populate_template(doc.to_xml(encoding: "US-ASCII"), :html)
+      )
     end
 
     def html_toc_entry(level, header)
@@ -112,7 +119,9 @@ module IsoDoc::HtmlFunction
     end
 
     def toclevel
-      ret = toclevel_classes.map { |l| "#{l}:not(:empty):not(.TermNum):not(.noTOC)" }
+      ret = toclevel_classes.map do |l|
+        "#{l}:not(:empty):not(.TermNum):not(.noTOC)"
+      end
       <<~HEAD.freeze
         function toclevel() { return "#{ret.join(',')}";}
       HEAD
@@ -141,100 +150,47 @@ module IsoDoc::HtmlFunction
         i["width"], i["height"] = Html2Doc.image_resize(i, image_localfile(i),
                                                         @maxheight, @maxwidth)
         next if /^data:/.match i["src"]
+
         @datauriimage ? datauri(i) : move_image1(i)
       end
       docxml
     end
 
-    def datauri(i)
-      type = i["src"].split(".")[-1]
+    def datauri(img)
+      type = img["src"].split(".")[-1]
       supertype = type == "xml" ? "application" : "image"
-      bin = IO.binread(image_localfile(i))
+      bin = IO.binread(image_localfile(img))
       data = Base64.strict_encode64(bin)
-      i["src"] = "data:#{supertype}/#{type};base64,#{data}"
+      img["src"] = "data:#{supertype}/#{type};base64,#{data}"
     end
 
-    def image_suffix(i)
-      type = i["mimetype"]&.sub(%r{^[^/*]+/}, "")
-      matched = /\.(?<suffix>[^. \r\n\t]+)$/.match i["src"]
+    def image_suffix(img)
+      type = img["mimetype"]&.sub(%r{^[^/*]+/}, "")
+      matched = /\.(?<suffix>[^. \r\n\t]+)$/.match img["src"]
       type and !type.empty? and return type
+
       !matched.nil? and matched[:suffix] and return matched[:suffix]
       "png"
     end
 
-    def move_image1(i)
-      suffix = image_suffix(i)
+    def move_image1(img)
+      suffix = image_suffix(img)
       uuid = UUIDTools::UUID.random_create.to_s
       fname = "#{uuid}.#{suffix}"
       new_full_filename = File.join(tmpimagedir, fname)
-      local_filename = image_localfile(i)
+      local_filename = image_localfile(img)
       FileUtils.cp local_filename, new_full_filename
-      i["src"] = File.join(rel_tmpimagedir, fname)
+      img["src"] = File.join(rel_tmpimagedir, fname)
     end
 
     def inject_script(doc)
       return doc unless @scripts
+
       scripts = File.read(@scripts, encoding: "UTF-8")
       a = doc.split(%r{</body>})
       a[0] + scripts + "</body>" + a[1]
     end
 
-    def update_footnote_filter(fn, x, i, seen)
-      if seen[fn.text]
-        x.at("./sup").content = seen[fn.text][:num].to_s
-        fn.remove unless x["href"] == seen[fn.text][:href]
-        x["href"] = seen[fn.text][:href]
-      else
-        seen[fn.text] = { num: i, href: x["href"] }
-        x.at("./sup").content = i.to_s
-        i += 1
-      end
-      [i, seen]
-    end
-
-    def html_footnote_filter(docxml)
-      seen = {}
-      i = 1
-      docxml.xpath('//a[@class = "FootnoteRef"]').each do |x|
-        fn = docxml.at(%<//*[@id = '#{x['href'].sub(/^#/, '')}']>) || next
-        i, seen = update_footnote_filter(fn, x, i, seen)
-      end
-      docxml
-    end
-
-    def footnote_backlinks1(x, fn)
-      xdup = x.dup
-      xdup.remove["id"]
-      if fn.elements.empty?
-        fn.children.first.previous = xdup
-      else
-        fn.elements.first.children.first.previous = xdup
-      end
-    end
-
-    def footnote_backlinks(docxml)
-      seen = {}
-      docxml.xpath('//a[@class = "FootnoteRef"]').each_with_index do |x, i|
-        seen[x["href"]] and next or seen[x["href"]] = true
-        fn = docxml.at(%<//*[@id = '#{x['href'].sub(/^#/, '')}']>) || next
-        footnote_backlinks1(x, fn)
-        x["id"] ||= "fnref:#{i + 1}"
-        fn.add_child "<a href='##{x['id']}'>&#x21A9;</a>"
-      end
-      docxml
-    end
-
-    def footnote_format(docxml)
-      docxml.xpath("//a[@class = 'FootnoteRef']/sup").each do |x|
-        footnote_reference_format(x)
-      end
-      docxml.xpath("//a[@class = 'TableFootnoteRef'] | "\
-                   "//span[@class = 'TableFootnoteRef']").each do |x|
-        table_footnote_reference_format(x)
-      end
-      docxml
-    end
-
     def sourcecode_highlighter
       '<script src="https://cdn.rawgit.com/google/code-prettify/master/'\
         'loader/run_prettify.js"></script>'

data/lib/isodoc/html_function/postprocess_footnotes.rb

@@ -0,0 +1,59 @@
+module IsoDoc::HtmlFunction
+  module Html
+    def update_footnote_filter(fn, x, i, seen)
+      if seen[fn.text]
+        x.at("./sup").content = seen[fn.text][:num].to_s
+        fn.remove unless x["href"] == seen[fn.text][:href]
+        x["href"] = seen[fn.text][:href]
+      else
+        seen[fn.text] = { num: i, href: x["href"] }
+        x.at("./sup").content = i.to_s
+        i += 1
+      end
+      [i, seen]
+    end
+
+    def html_footnote_filter(docxml)
+      seen = {}
+      i = 1
+      docxml.xpath('//a[@class = "FootnoteRef"]').each do |x|
+        fn = docxml.at(%<//*[@id = '#{x['href'].sub(/^#/, '')}']>) || next
+        i, seen = update_footnote_filter(fn, x, i, seen)
+      end
+      docxml
+    end
+
+    def footnote_backlinks1(x, fn)
+      xdup = x.dup
+      xdup.remove["id"]
+      if fn.elements.empty?
+        fn.children.first.previous = xdup
+      else
+        fn.elements.first.children.first.previous = xdup
+      end
+    end
+
+    def footnote_backlinks(docxml)
+      seen = {}
+      docxml.xpath('//a[@class = "FootnoteRef"]').each_with_index do |x, i|
+        seen[x["href"]] and next or seen[x["href"]] = true
+        fn = docxml.at(%<//*[@id = '#{x['href'].sub(/^#/, '')}']>) || next
+        footnote_backlinks1(x, fn)
+        x["id"] ||= "fnref:#{i + 1}"
+        fn.add_child "<a href='##{x['id']}'>&#x21A9;</a>"
+      end
+      docxml
+    end
+
+    def footnote_format(docxml)
+      docxml.xpath("//a[@class = 'FootnoteRef']/sup").each do |x|
+        footnote_reference_format(x)
+      end
+      docxml.xpath("//a[@class = 'TableFootnoteRef'] | "\
+                   "//span[@class = 'TableFootnoteRef']").each do |x|
+        table_footnote_reference_format(x)
+      end
+      docxml
+    end
+  end
+end

data/lib/isodoc/i18n.rb

@@ -5,19 +5,20 @@ module IsoDoc
     def load_yaml(lang, script, i18nyaml = nil)
       ret = load_yaml1(lang, script)
       return normalise_hash(ret.merge(YAML.load_file(i18nyaml))) if i18nyaml
+
       normalise_hash(ret)
     end
 
     def normalise_hash(ret)
-      if ret.is_a? Hash 
+      case ret
+      when Hash
         ret.each do |k, v|
           ret[k] = normalise_hash(v)
         end
         ret
-      elsif ret.is_a? Array then ret.map { |n| normalise_hash(n) }
-      elsif ret.is_a? String then ret.unicode_normalize(:nfc) 
-      else
-        ret
+      when Array then ret.map { |n| normalise_hash(n) }
+      when String then ret.unicode_normalize(:nfc)
+      else ret
       end
     end
 
@@ -41,8 +42,8 @@ module IsoDoc
       @labels
     end
 
-    def set(x, y)
-      @labels[x] = y
+    def set(key, val)
+      @labels[key] = val
     end
 
     def initialize(lang, script, i18nyaml = nil)
@@ -57,37 +58,36 @@ module IsoDoc
       end
     end
 
-    def self.l10n(x, lang = @lang, script = @script)
-      l10n(x, lang, script)
+    def self.l10n(text, lang = @lang, script = @script)
+      l10n(text, lang, script)
     end
 
     # TODO: move to localization file
     # function localising spaces and punctuation.
     # Not clear if period needs to be localised for zh
-    def l10n(x, lang = @lang, script = @script)
+    def l10n(text, lang = @lang, script = @script)
       if lang == "zh" && script == "Hans"
-        xml = Nokogiri::HTML::DocumentFragment.parse(x)
+        xml = Nokogiri::HTML::DocumentFragment.parse(text)
         xml.traverse do |n|
           next unless n.text?
-          n.replace(n.text.gsub(/ /, "").gsub(/:/, "：").gsub(/,/, "、").
-                    gsub(/\(/, "（").gsub(/\)/, "）").
-                    gsub(/\[/, "【").gsub(/\]/, "】"))
+
+          n.replace(n.text.gsub(/ /, "").gsub(/:/, "：").gsub(/,/, "、")
+            .gsub(/\(/, "（").gsub(/\)/, "）").gsub(/\[/, "【").gsub(/\]/, "】"))
         end
         xml.to_xml.gsub(/<b>/, "").gsub("</b>", "").gsub(/<\?[^>]+>/, "")
-      else
-        x
+      else text
       end
     end
 
     def multiple_and(names, andword)
-      return '' if names.empty?
+      return "" if names.empty?
       return names[0] if names.length == 1
+
       (names.length == 2) &&
         (return l10n("#{names[0]} #{andword} #{names[1]}", @lang, @script))
-      l10n(names[0..-2].join(', ') + " #{andword} #{names[-1]}", @lang, @script)
+      l10n(names[0..-2].join(", ") + " #{andword} #{names[-1]}", @lang, @script)
     end
 
-    #module_function :l10n
-
+    # module_function :l10n
   end
 end

data/lib/isodoc/presentation_function/block.rb

@@ -3,7 +3,8 @@ require "base64"
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def lower2cap(s)
-      return s if /^[[:upper:]][[:upper:]]/.match(s)
+      return s if /^[[:upper:]][[:upper:]]/.match?(s)
+
       s.capitalize
     end
 
@@ -19,8 +20,10 @@ module IsoDoc
     end
 
     def svg_extract(f)
-      return unless %r{^data:image/svg\+xml;base64,}.match(f["src"])
-      svg = Base64.strict_decode64(f["src"].sub(%r{^data:image/svg\+xml;base64,}, ""))
+      return unless %r{^data:image/svg\+xml;base64,}.match?(f["src"])
+
+      svg = Base64.strict_decode64(f["src"]
+        .sub(%r{^data:image/svg\+xml;base64,}, ""))
       f.replace(svg.sub(/<\?xml[^>]*>/, ""))
     end
 
@@ -28,12 +31,15 @@ module IsoDoc
       return sourcecode1(f) if f["class"] == "pseudocode" || f["type"] == "pseudocode"
       return if labelled_ancestor(f) && f.ancestors("figure").empty?
       return if f.at(ns("./figure")) and !f.at(ns("./name"))
+
       lbl = @xrefs.anchor(f['id'], :label, false) or return
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
+      prefix_name(f, "&nbsp;&mdash; ",
+                  l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
     def prefix_name(f, delim, number, elem)
       return if number.nil? || number.empty?
+
       unless name = f.at(ns("./#{elem}"))
         f.children.empty? and f.add_child("<#{elem}></#{elem}>") or
           f.children.first.previous = "<#{elem}></#{elem}>"
@@ -52,6 +58,7 @@ module IsoDoc
     def sourcecode1(f)
       return if labelled_ancestor(f)
       return unless f.ancestors("example").empty?
+
       lbl = @xrefs.anchor(f['id'], :label, false) or return
       prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
@@ -96,6 +103,7 @@ module IsoDoc
     # introduce name element
     def note1(f)
       return if f.parent.name == "bibitem"
+
       n = @xrefs.get[f["id"]]
       lbl = (@i18n.note if n.nil? || n[:label].nil? || n[:label].empty?) ?
         @i18n.note: l10n("#{@i18n.note} #{n[:label]}")
@@ -110,7 +118,7 @@ module IsoDoc
 
     # introduce name element
     def termnote1(f)
-      lbl = l10n(@xrefs.anchor(f['id'], :label) || '???')
+      lbl = l10n(@xrefs.anchor(f["id"], :label) || "???")
       prefix_name(f, "", lower2cap(lbl), "name")
     end
 
@@ -134,7 +142,7 @@ module IsoDoc
 
     # introduce name element
     def recommendation1(f, type)
-      n = @xrefs.anchor(f['id'], :label, false)
+      n = @xrefs.anchor(f["id"], :label, false)
       lbl = (n.nil? ? type : l10n("#{type} #{n}"))
       prefix_name(f, "", lbl, "name")
     end
@@ -148,7 +156,8 @@ module IsoDoc
     def table1(f)
       return if labelled_ancestor(f)
       return if f["unnumbered"] && !f.at(ns("./name"))
-      n = @xrefs.anchor(f['id'], :label, false)
+
+      n = @xrefs.anchor(f["id"], :label, false)
       prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.table} #{n}"), "name")
     end
 
@@ -160,7 +169,7 @@ module IsoDoc
     end
 
     def amend1(f)
-      f.xpath(ns("./autonumber")).each { |a| a.remove }
+      f.xpath(ns("./autonumber")).each(&:remove)
       f.xpath(ns("./newcontent")).each { |a| a.name = "quote" }
       f.xpath(ns("./description")).each { |a| a.replace(a.children) }
       f.replace(f.children)

data/lib/isodoc/presentation_function/inline.rb

@@ -243,6 +243,8 @@ module IsoDoc
       end
     end
 
+    private
+
     def found_matching_variant_sibling(node)
       prev = node.xpath("./preceding-sibling::xmlns:variant")
       foll = node.xpath("./following-sibling::xmlns:variant")

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.6.0".freeze
+  VERSION = "1.6.1".freeze
 end

data/lib/isodoc/word_function/footnotes.rb

@@ -2,7 +2,7 @@ module IsoDoc::WordFunction
   module Footnotes
     def bookmarkid
       ret = "X"
-      until !@bookmarks_allocated[ret] do
+      until !@bookmarks_allocated[ret]
         ret = Random.rand(1000000000)
       end
       @bookmarks_allocated[ret] = true
@@ -11,6 +11,7 @@ module IsoDoc::WordFunction
 
     def footnotes(div)
       return if @footnotes.empty?
+
       @footnotes.each { |fn| div.parent << fn }
     end
 
@@ -52,6 +53,7 @@ module IsoDoc::WordFunction
     def get_table_ancestor_id(node)
       table = node.ancestors("table") || node.ancestors("figure")
       return UUIDTools::UUID.random_create.to_s if table.empty?
+
       table.last["id"]
     end
 
@@ -61,30 +63,34 @@ module IsoDoc::WordFunction
       make_table_footnote_link(out, tid + fn, fn)
       # do not output footnote text if we have already seen it for this table
       return if @seen_footnote.include?(tid + fn)
+
       @in_footnote = true
       out.aside { |a| a << make_table_footnote_text(node, tid + fn, fn) }
       @in_footnote = false
       @seen_footnote << (tid + fn)
     end
 
-    def seen_footnote_parse(node, out, fn)
-      out.span **{style: "mso-element:field-begin"}
-      out << " NOTEREF _Ref#{@fn_bookmarks[fn]} \\f \\h"
-      out.span **{style: "mso-element:field-separator"}
-      out.span **{class: "MsoFootnoteReference"} do |s|
-        s << fn
+    def seen_footnote_parse(_node, out, footnote)
+      out.span **{ style: "mso-element:field-begin" }
+      out << " NOTEREF _Ref#{@fn_bookmarks[footnote]} \\f \\h"
+      out.span **{ style: "mso-element:field-separator" }
+      out.span **{ class: "MsoFootnoteReference" } do |s|
+        s << footnote
       end
-      out.span **{style: "mso-element:field-end"}
+      out.span **{ style: "mso-element:field-end" }
     end
 
     def footnote_parse(node, out)
       return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-        !node.ancestors.map {|m| m.name }.include?("name")
+        !node.ancestors.map { |m| m.name }.include?("name")
+
       fn = node["reference"] || UUIDTools::UUID.random_create.to_s
       return seen_footnote_parse(node, out, fn) if @seen_footnote.include?(fn)
+
       @fn_bookmarks[fn] = bookmarkid
-      out.span **{style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}"} do |s|
-        s.a **{ "class": "FootnoteRef", "epub:type": "footnote", href: "#ftn#{fn}" } do |a|
+      out.span **{ style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}" } do |s|
+        s.a **{ "class": "FootnoteRef", "epub:type": "footnote",
+                href: "#ftn#{fn}" } do |a|
           a.sup { |sup| sup << fn }
         end
       end
@@ -94,12 +100,13 @@ module IsoDoc::WordFunction
       @seen_footnote << fn
     end
 
-    def make_footnote(node, fn)
-      return if @seen_footnote.include?(fn)
+    def make_footnote(node, footnote)
+      return if @seen_footnote.include?(footnote)
+
       @in_footnote = true
-      @footnotes << make_generic_footnote_text(node, fn)
+      @footnotes << make_generic_footnote_text(node, footnote)
       @in_footnote = false
-      @seen_footnote << fn
+      @seen_footnote << footnote
     end
   end
 end