html2doc 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 878408b54af45f8693aade94aee06047dcd450a3
-  data.tar.gz: 66775cf77b38dc25490da74ac84a5dd5ade68650
+  metadata.gz: 4043ea8c7347a5a9b15846ef7c4a79a801fd8675
+  data.tar.gz: 7b3f967fe5380b2f20c0426d8c5d9abe5d5414d9
 SHA512:
-  metadata.gz: 04baa6214e38eb83f7bd687d42b4bc4db9a28ac80e9c78944dc0ec1150e8c3d9f3fb0ccbaf4df00040b17362405c7dc28765335c01a6d2e5a1e47314232c5b01
-  data.tar.gz: 0ad65befcc98b15e89bd6c94a8b18a54f709fbf01185b786dd1675a287473a4bb8ad05149647e383c130fcefaafc66048711a438eb557fe80fbd3fc08fded629
+  metadata.gz: b830fdb69fae58dd1e64c1c35e0119ba697eff978eeb257ed6017547709b9d1d43da51e6f68bbe3dda82c51af5b71d1312c7971c1ebf8dac535b3ca79d54eff7
+  data.tar.gz: ebdcc4112c857d8edc934389b2925671dfc7a16a51bf75646b606479570c9d0b88aafd16f6fcdb3853a9bba9c8d99d042d2dffbbc705026f65e555207afecbb7

data/README.adoc

@@ -1,5 +1,10 @@
 = Html2Doc
 
+
+image:https://img.shields.io/gem/v/html2doc.svg["Gem Version", link="https://rubygems.org/gems/html2doc"]
+image:https://img.shields.io/travis/riboseinc/html2doc/master.svg["Build Status", link="https://travis-ci.org/riboseinc/html2doc"]
+image:https://codeclimate.com/github/riboseinc/html2doc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/html2doc"]
+
 Gem to convert an HTML document into a Word document (.doc) format. This is intended for automated generation of Microsoft Word documents, given HTML documents, which are mmuch more readily crafted.
 
 This gem originated out of https://github.com/riboseinc/asciidoctor-iso, which creates a Word document from a Microsoft HTML document (created in turn by processing Asciidoc). The Microsoft HTML document is already quite close to Microsoft Word requirements, but future iterations of this gem will become more generic.
@@ -9,6 +14,7 @@ This work is driven by the Word document generation procedure documented in http
 The gem currently does the following:
 
 * Convert any AsciiMath and MathML to Word's native mathematical formatting language.
+* Identify any footnotes in the document (through hyperlinks with `class = "Footnote"` or `epub:type = "footnote"`), and render them as Microsoft Word footnotes.
 * Resize any images in the HTML file to fit within the maximum page size. (Word will otherwise crash on reading the document.)
 * Generate a filelist.xml listing of all files to be bundled into the Word document.
 * Assign the class `MsoNormal` to any paragraphs that do not have a class, so that they can be treated as Normal Style when editing the Word document.
@@ -17,9 +23,8 @@ The gem currently does the following:
 
 Future iterations will convert generic HTML to Microsoft-specific HTML. For a representative generator of Microsoft HTML, see https://github.com/riboseinc/asciidoctor-iso
 
-Work being tracked at https://github.com/riboseinc/asciidoctor-iso/issues/47:
+Work to be done:
 
-* Render footnotes
 * Render (editorial) comments
 
 == Constraints

data/lib/html2doc.rb

@@ -1,3 +1,4 @@
 require_relative "html2doc/version"
 require_relative "html2doc/base"
 require_relative "html2doc/mime"
+require_relative "html2doc/notes"

data/lib/html2doc/base.rb

@@ -33,6 +33,7 @@ module Html2Doc
   def self.cleanup(docxml, dir)
     image_cleanup(docxml, dir)
     mathml_to_ooml(docxml)
+    footnotes(docxml)
     msonormal(docxml)
     docxml
   end
@@ -79,18 +80,19 @@ module Html2Doc
     r
   end
 
-  def self.image_resize(orig_filename)
-    image_size = ImageSize.path(orig_filename).size
+  def self.image_resize(i)
+    size = [i["width"].to_i, i["height"].to_i]
+    size = ImageSize.path(i["src"]).size unless size[0] && size[1]
     # max width for Word document is 400, max height is 680
-    if image_size[0] > 400
-      image_size[1] = (image_size[1] * 400 / image_size[0]).ceil
-      image_size[0] = 400
+    if size[0] > 400
+      size[1] = (size[1] * 400 / size[0]).ceil
+      size[0] = 400
     end
-    if image_size[1] > 680
-      image_size[0] = (image_size[0] * 680 / image_size[1]).ceil
-      image_size[1] = 680
+    if size[1] > 680
+      size[0] = (size[0] * 680 / size[1]).ceil
+      size[1] = 680
     end
-    image_size
+    size
   end
 
   def self.image_cleanup(docxml, dir)
@@ -100,7 +102,7 @@ module Html2Doc
       new_full_filename = File.join(dir, "#{uuid}.#{matched[:suffix]}")
       # presupposes that the image source is local
       system "cp #{i['src']} #{new_full_filename}"
-      i["width"], i["height"] = image_resize(i["src"])
+      i["width"], i["height"] = image_resize(i)
       i["src"] = new_full_filename
     end
     docxml

data/lib/html2doc/notes.rb

@@ -0,0 +1,97 @@
+require "uuidtools"
+require "nokogiri"
+
+module Html2Doc
+
+  def self.footnotes(docxml)
+    i, fn = 1, []
+    docxml.xpath("//a").each do |a|
+      next unless process_footnote_link(docxml, a, i, fn)
+      i += 1
+    end
+    process_footnote_texts(docxml, fn)
+  end
+
+  def self.process_footnote_texts(docxml, footnotes)
+    body = docxml.at("//body")
+    list = body.add_child("<div style='mso-element:footnote-list'/>")
+    footnotes.each_with_index do |f, i|
+      fn = list.first.add_child(footnote_container(i+1))
+      f.parent = fn.first
+      footnote_div_to_p(f)
+    end
+    footnote_cleanup(docxml)
+  end
+
+  def self.footnote_div_to_p(f)
+    if %w{div aside}.include? f.name
+      if f.at(".//p")
+        f = f.replace(f.children)
+      else
+        f.name = "p"
+        f["class"] = "MsoFootnoteText"
+      end
+    end
+  end
+
+  def self.footnote_container(i)
+    <<~DIV
+      <div style='mso-element:footnote' id='ftn#{i}'>
+        <a style='mso-footnote-id:ftn#{i}' href=#_ftn#{i}' 
+           name='_ftnref#{i}' title='' id='_ftnref#{i}'><span 
+           class='MsoFootnoteReference'><span 
+           style='mso-special-character:footnote'></span></span></div>
+    DIV
+  end
+
+  def self.process_footnote_link(docxml, a, i, fn)
+    return false unless is_footnote(a)
+    href = a["href"].gsub(/^#/, "")
+    note = docxml.at("//*[@name = '#{href}' or @id = '#{href}']")
+    return false if note.nil?
+    set_footnote_link_attrs(a, i)
+    a.children = "<span class='MsoFootnoteReference'>"\
+      "<span style='mso-special-character:footnote'/></span>"
+    fn << transform_footnote_text(note)
+  end
+
+  def self.transform_footnote_text(note)
+    note["id"] = ""
+    note.xpath(".//div").each { |div| div = div.replace(div.children) }
+    note.xpath(".//aside | .//p").each do |p|
+      p.name = "p"
+      p["class"] = "MsoFootnoteText"
+    end
+    note.remove
+  end
+
+  def self.is_footnote(a)
+    a["epub:type"]&.casecmp("footnote") == 0 ||
+      a["class"]&.casecmp("footnote") == 0
+  end
+
+  def self.set_footnote_link_attrs(a, i)
+    a["style"] = "mso-footnote-id:ftn#{i}"
+    a["href"] = "#_ftn#{i}"
+    a["name"] = "_ftnref#{i}"
+    a["title"] = ""
+  end
+
+  # We expect that the content of the footnote text received is one or
+  # more text containers, p or aside or div (which we have already converted
+  # to p). We do not expect any <a name> or links back to text; if they
+  # are present in the HTML, they need to have been cleaned out before
+  # passing to this gem
+  def self.footnote_cleanup(docxml)
+    docxml.xpath('//div[@style="mso-element:footnote"]/a').
+      each do |x|
+      n = x.next_element
+      n&.children&.first&.add_previous_sibling(x.remove)
+    end
+    docxml
+  end
+
+
+
+
+end

data/lib/html2doc/version.rb

@@ -1,3 +1,3 @@
 module Html2Doc
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2doc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -291,6 +291,7 @@ files:
 - lib/html2doc/base.rb
 - lib/html2doc/mathml2omml.xsl
 - lib/html2doc/mime.rb
+- lib/html2doc/notes.rb
 - lib/html2doc/version.rb
 - lib/html2doc/wordstyle.css
 - spec/html2doc_spec.rb