isodoc 1.5.5 → 1.6.4

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,44 +5,47 @@ 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
 
     def load_yaml1(lang, script)
-      if lang == "en"
-        YAML.load_file(File.join(File.dirname(__FILE__),
-                                 "../isodoc-yaml/i18n-en.yaml"))
-      elsif lang == "fr"
-        YAML.load_file(File.join(File.dirname(__FILE__),
-                                 "../isodoc-yaml/i18n-fr.yaml"))
-      elsif lang == "zh" && script == "Hans"
-        YAML.load_file(File.join(File.dirname(__FILE__),
-                                 "../isodoc-yaml/i18n-zh-Hans.yaml"))
+      case lang
+      when "en", "fr", "ru", "de", "es", "ar"
+        load_yaml2(lang)
+      when "zh"
+        if script == "Hans" then load_yaml2("zh-Hans")
+        else load_yaml2("en")
+        end
       else
-        YAML.load_file(File.join(File.dirname(__FILE__),
-                                 "../isodoc-yaml/i18n-en.yaml"))
+        load_yaml2("en")
       end
     end
 
+    def load_yaml2(str)
+      YAML.load_file(File.join(File.dirname(__FILE__),
+                               "../isodoc-yaml/i18n-#{str}.yaml"))
+    end
+
     def get
       @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 +60,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/pdf_convert.rb

@@ -1,11 +1,10 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
 require "metanorma"
 
 module IsoDoc
   class PdfConvert < ::IsoDoc::Convert
-
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
     include HtmlFunction::Html
@@ -13,6 +12,8 @@ module IsoDoc
     def initialize(options)
       @standardstylesheet = nil
       super
+      @format = :pdf
+      @suffix = "pdf"
       @scripts = @scripts_pdf if @scripts_pdf
       @maxwidth = 500
       @maxheight = 800
@@ -22,29 +23,24 @@ module IsoDoc
       "_pdfimages"
     end
 
-    def initialize(options)
-      @format = :pdf
-      @suffix = "pdf"
-      super
-    end
-
     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)
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename + ".tmp.html", dir)
+
+      postprocess(result, "#{filename}.tmp.html", dir)
       FileUtils.rm_rf dir
-      ::Metanorma::Output::Pdf.new.convert("#{filename}.tmp.html",
-                                           output_filename || "#{filename}.#{@suffix}")
+      ::Metanorma::Output::Pdf.new.convert(
+        "#{filename}.tmp.html",
+        output_filename || "#{filename}.#{@suffix}",
+      )
       FileUtils.rm_rf ["#{filename}.tmp.html", tmpimagedir]
     end
 
     def xref_parse(node, out)
-      target = /#/.match(node["target"]) ? node["target"].sub(/#/, ".pdf#") :
-        "##{node["target"]}"
-      out.a(**{ "href": target }) { |l| l << get_linkend(node) }
+      out.a(**{ "href": target_pdf(node) }) { |l| l << get_linkend(node) }
     end
   end
 end

data/lib/isodoc/presentation_function/bibdata.rb

@@ -2,12 +2,32 @@ module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def bibdata(docxml)
       a = bibdata_current(docxml) or return
+      address_precompose(a)
       bibdata_i18n(a)
       a.next =
-        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), "").join("")}"\
+        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join('')}"\
         "</localized-strings>"
     end
 
+    def address_precompose(bib)
+      bib.xpath(ns("//bibdata//address")).each do |b|
+        next if b.at(ns("./formattedAddress"))
+
+        x = address_precompose1(b)
+        b.children = "<formattedAddress>#{x}</formattedAddress>"
+      end
+    end
+
+    def address_precompose1(addr)
+      ret = []
+      addr.xpath(ns("./street")).each { |s| ret << s.children.to_xml }
+      a = addr.at(ns("./city")) and ret << a.children.to_xml
+      addr.xpath(ns("./state")).each { |s| ret << s.children.to_xml }
+      a = addr.at(ns("./country")) and ret << a.children.to_xml
+      a = addr.at(ns("./postcode")) and ret[-1] += " #{a.children.to_xml}"
+      ret.join("<br/>")
+    end
+
     def bibdata_current(docxml)
       a = docxml.at(ns("//bibdata")) or return
       a.xpath(ns("./language")).each do |l|
@@ -19,10 +39,10 @@ module IsoDoc
       a
     end
 
-    def bibdata_i18n(b)
-      hash_translate(b, @i18n.get["doctype_dict"], "./ext/doctype")
-      hash_translate(b, @i18n.get["stage_dict"], "./status/stage")
-      hash_translate(b, @i18n.get["substage_dict"], "./status/substage")
+    def bibdata_i18n(bib)
+      hash_translate(bib, @i18n.get["doctype_dict"], "./ext/doctype")
+      hash_translate(bib, @i18n.get["stage_dict"], "./status/stage")
+      hash_translate(bib, @i18n.get["substage_dict"], "./status/substage")
     end
 
     def hash_translate(bibdata, hash, xpath, lang = @lang)
@@ -35,58 +55,62 @@ module IsoDoc
       x.next.children = hash[x.text]
     end
 
-    def i18n_tag(k, v)
-      "<localized-string key='#{k}' language='#{@lang}'>#{v}</localized-string>"
+    def i18n_tag(key, value)
+      "<localized-string key='#{key}' language='#{@lang}'>#{value}"\
+        "</localized-string>"
     end
 
-    def i18n_safe(k)
-      k.to_s.gsub(/\s|\./, "_")
+    def i18n_safe(key)
+      key.to_s.gsub(/\s|\./, "_")
     end
 
-    def i8n_name(h, pref)
-      if h.is_a? Hash then i8n_name1(h, pref)
-      elsif h.is_a? Array
-        h.reject { |a| blank?(a) }.each_with_object([]).
-          with_index do |(v1, g), i|
+    def i8n_name(hash, pref)
+      if hash.is_a? Hash then i8n_name1(hash, pref)
+      elsif hash.is_a? Array
+        hash.reject { |a| blank?(a) }.each_with_object([])
+          .with_index do |(v1, g), i|
           i8n_name(v1, "#{i18n_safe(k)}.#{i}").each { |x| g << x }
         end
-      else [i18n_tag(pref, h)]
+      else [i18n_tag(pref, hash)]
       end
     end
 
-    def i8n_name1(h, pref)
-      h.reject { |k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
+    def i8n_name1(hash, pref)
+      hash.reject { |_k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
         if v.is_a? Hash then i8n_name(v, i18n_safe(k)).each { |x| g << x }
         elsif v.is_a? Array
           v.reject { |a| blank?(a) }.each_with_index do |v1, i|
             i8n_name(v1, "#{i18n_safe(k)}.#{i}").each { |x| g << x }
           end
         else
-          g << i18n_tag("#{pref}#{pref.empty? ? "" : "."}#{i18n_safe(k)}", v)
+          g << i18n_tag("#{pref}#{pref.empty? ? '' : '.'}#{i18n_safe(k)}", v)
         end
       end
     end
 
-    #https://stackoverflow.com/a/31822406
-    def blank?(v)
-      v.nil? || v.respond_to?(:empty?) && v.empty?
+    # https://stackoverflow.com/a/31822406
+    def blank?(elem)
+      elem.nil? || elem.respond_to?(:empty?) && elem.empty?
     end
 
-    def trim_hash(h)
+    def trim_hash(hash)
       loop do
-        h_new = trim_hash1(h)
-        break h if h==h_new
-        h = h_new
+        h_new = trim_hash1(hash)
+        break hash if hash == h_new
+
+        hash = h_new
       end
     end
 
-    def trim_hash1(h)
-      return h unless h.is_a? Hash
-      h.each_with_object({}) do |(k,v), g|
+    def trim_hash1(hash)
+      return hash unless hash.is_a? Hash
+
+      hash.each_with_object({}) do |(k, v), g|
         next if blank?(v)
-        g[k] = if v.is_a? Hash then trim_hash1(h[k])
+
+        g[k] = if v.is_a? Hash then trim_hash1(hash[k])
                elsif v.is_a? Array
-                 h[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
+                 hash[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
                else
                  v
                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)