docx 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc798e71a79265389a2dcf22d0ecff1268a920f92463c23b9ccbce94517b7be
-  data.tar.gz: 1b21fef113ce8a84a7aeaf97b05139822763a4ac96835efd59971b52fb34ce98
+  metadata.gz: bba1301a8a8e00e7fd9ee748af89280af2348120628c9a3d806dbcef78b17bb4
+  data.tar.gz: 699e0f10746445987737d090a0cf11886251f98385224dd0c9ec543b59676735
 SHA512:
-  metadata.gz: eab6dae181b61b9b7103460a4e5d582ef534b36f2f09cbfaba9c5ef16d880b9bca6a97d76e7c671fbb24a897189e6b1861a6f4874e589075d781b3a660e796c9
-  data.tar.gz: ca39d10248be1d18d173293fc8a918fe86e615cbd6fbdb5340a532792d9ef478ac563fb3ef61a6fdd4e1542a9d7258015e5bc34ecd69c86e6edb39ce422ec636
+  metadata.gz: 52fd4f0aeafbf5a9ce0f5c3b4b75b8235fa291806a95dcb9455c993fe322b949aea7780a56a92ce78c2d51248eab4c6366e3511eda11991a739f53cd052460b7
+  data.tar.gz: 598be461460ae0aee15f4f13028850497df9a9bb30d47594f3ce678725095a8dd3b72ebc5cc1bb32825f10efef8c4cf27a7c54736c2875b344e0374af8daa92b

data/lib/docx/containers/paragraph.rb

@@ -44,7 +44,7 @@ module Docx
 
         # Return paragraph as a <p></p> HTML fragment with formatting based on properties.
         def to_html
-          html = ''
+          html = +''
           text_runs.each do |text_run|
             html << text_run.to_html
           end

data/lib/docx/document.rb

@@ -22,7 +22,7 @@ module Docx
   class Document
     include Docx::SimpleInspect
 
-    attr_reader :xml, :doc, :zip, :styles
+    attr_reader :xml, :doc, :zip, :styles, :headers, :footers
 
     def initialize(path_or_io, options = {})
       @replace = {}
@@ -40,6 +40,8 @@ module Docx
       @document_xml = document.get_input_stream.read
       @doc = Nokogiri::XML(@document_xml)
       load_styles
+      load_headers
+      load_footers
       yield(self) if block_given?
     ensure
       @zip.close unless @zip.nil?
@@ -128,40 +130,44 @@ module Docx
     # call-seq:
     #   save(filepath) => void
     def save(path)
-      update
-      Zip::OutputStream.open(path) do |out|
-        zip.each do |entry|
-          next unless entry.file?
+      with_zip64_disabled do
+        update
+        Zip::OutputStream.open(path) do |out|
+          zip.each do |entry|
+            next unless entry.file?
 
-          out.put_next_entry(entry.name)
-          value = @replace[entry.name] || zip.read(entry.name)
+            out.put_next_entry(entry.name)
+            value = @replace[entry.name] || zip.read(entry.name)
 
-          out.write(value)
-        end
+            out.write(value)
+          end
 
+        end
+        zip.close
       end
-      zip.close
     end
 
     # Output entire document as a StringIO object
     def stream
-      update
-      stream = Zip::OutputStream.write_buffer do |out|
-        zip.each do |entry|
-          next unless entry.file?
-
-          out.put_next_entry(entry.name)
-
-          if @replace[entry.name]
-            out.write(@replace[entry.name])
-          else
-            out.write(zip.read(entry.name))
+      with_zip64_disabled do
+        update
+        stream = Zip::OutputStream.write_buffer do |out|
+          zip.each do |entry|
+            next unless entry.file?
+
+            out.put_next_entry(entry.name)
+
+            if @replace[entry.name]
+              out.write(@replace[entry.name])
+            else
+              out.write(zip.read(entry.name))
+            end
           end
         end
-      end
 
-      stream.rewind
-      stream
+        stream.rewind
+        stream
+      end
     end
 
     alias text to_s
@@ -184,6 +190,36 @@ module Docx
 
     private
 
+    # rubyzip 3.x enables ZIP64 by default, which breaks readers (e.g. pandoc)
+    # that don't support it for small files (issue #168). Disable ZIP64 only
+    # while writing, and restore the previous global value afterwards so we
+    # don't affect other rubyzip users in the consuming application.
+    def with_zip64_disabled
+      previous = Zip.write_zip64_support
+      Zip.write_zip64_support = false
+      yield
+    ensure
+      Zip.write_zip64_support = previous
+    end
+
+    def load_headers
+      header_files = @zip.glob("word/header*.xml").map{|h| h.name}
+      filename_and_contents_pairs = header_files.map do |file|
+        simple_file_name = file.sub(/^word\//, "").sub(/\.xml$/, "")
+        [simple_file_name, Nokogiri::XML(@zip.read(file))]
+      end
+      @headers = Hash[filename_and_contents_pairs]
+    end
+
+    def load_footers
+      footer_files = @zip.glob("word/footer*.xml").map{|h| h.name}
+      filename_and_contents_pairs = footer_files.map do |file|
+        simple_file_name = file.sub(/^word\//, "").sub(/\.xml$/, "")
+        [simple_file_name, Nokogiri::XML(@zip.read(file))]
+      end
+      @footers = Hash[filename_and_contents_pairs]
+    end
+
     def load_styles
       @styles_xml = @zip.read('word/styles.xml')
       @styles = Nokogiri::XML(@styles_xml)
@@ -209,6 +245,12 @@ module Docx
     def update
       replace_entry 'word/document.xml', doc.serialize(save_with: 0)
       replace_entry 'word/styles.xml', styles_configuration.serialize(save_with: 0)
+      headers.each do |name, content|
+        replace_entry "word/#{name}.xml", content.serialize(save_with: 0)
+      end
+      footers.each do |name, content|
+        replace_entry "word/#{name}.xml", content.serialize(save_with: 0)
+      end
     end
 
     # generate Elements::Containers::Paragraph from paragraph XML node

data/lib/docx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docx #:nodoc:
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Christopher Hunt