File replacement within document

Author: tmikoss

lib/docx/document.rb

@@ -4,13 +4,13 @@
 module Docx
   # The Document class wraps around a docx file and provides methods to
   # interface with it.
-  # 
+  #
   #   # get a Docx::Document for a docx file in the local directory
   #   doc = Docx::Document.open("test.docx")
-  #   
+  #
   #   # get the text from the document
   #   puts doc.text
-  #   
+  #
   #   # do the same thing in a block
   #   Docx::Document.open("test.docx") do |d|
   #     puts d.text
@@ -26,7 +26,7 @@ def initialize(path, &block)
         @parser = Parser.new(File.expand_path(path))
       end
     end
-    
+
     # With no associated block, Docx::Document.open is a synonym for Docx::Document.new. If the optional code block is given, it will be passed the opened +docx+ file as an argument and the Docx::Document oject will automatically be closed when the block terminates. The values of the block will be returned from Docx::Document.open.
     # call-seq:
     #   open(filepath) => file
@@ -37,14 +37,14 @@ def self.open(path, &block)
 
     ##
     # *Deprecated*
-    # 
+    #
     # Iterates over paragraphs within document
     # call-seq:
     #   each_paragraph => Enumerator
     def each_paragraph
       paragraphs.each { |p| yield(p) }
     end
-    
+
     # call-seq:
     #   to_s -> string
     def to_s
@@ -69,18 +69,22 @@ def save(path)
       end
       zip.close
     end
-    
+
     alias_method :text, :to_s
 
+    def replace_entry(entry_path, file_contents)
+      @replace[entry_path] = file_contents
+    end
+
     private
 
     #--
     # TODO: Flesh this out to be compatible with other files
-    # TODO: Method to set flag on files that have been edited, probably by inserting something at the 
+    # TODO: Method to set flag on files that have been edited, probably by inserting something at the
     # end of methods that make edits?
     #++
     def update
-      @replace["word/document.xml"] = doc.serialize :save_with => 0
+      replace_entry "word/document.xml", doc.serialize(:save_with => 0)
     end
 
   end

spec/docx/document_spec.rb

@@ -214,12 +214,12 @@
       @doc.paragraphs[5].text_runs[0].italicized?.should be_false
       @doc.paragraphs[5].text_runs[0].bolded?.should be_false
       @doc.paragraphs[5].text_runs[0].underlined?.should be_false
-      
+
       @formatting[5][1].should eq @all_formatted
       @doc.paragraphs[5].text_runs[1].italicized?.should be_true
       @doc.paragraphs[5].text_runs[1].bolded?.should be_true
       @doc.paragraphs[5].text_runs[1].underlined?.should be_true
-      
+
       @formatting[5][2].should eq @default_formatting
       @doc.paragraphs[5].text_runs[2].italicized?.should be_false
       @doc.paragraphs[5].text_runs[2].bolded?.should be_false
@@ -258,4 +258,29 @@
       end
     end
   end
-end
+
+  describe 'replacing contents' do
+    let(:replacement_file_path) { @fixtures_path + '/replacement.png' }
+    let(:temp_file_path){ Tempfile.new(['docx_gem', '.docx']).path }
+    let(:entry_path){ 'word/media/image1.png' }
+    let(:doc){ Docx::Document.open(@fixtures_path + '/replacement.docx') }
+
+    it 'should replace existing file within the document' do
+      File.open replacement_file_path, "rb" do |io|
+        doc.replace_entry entry_path, io.read
+      end
+
+      doc.save(temp_file_path)
+
+      File.open replacement_file_path, "rb" do |io|
+        expect(Zip::File.open(temp_file_path).read entry_path).to eq io.read
+      end
+    end
+
+    after do
+      if File.exists?(temp_file_path)
+        File.delete(temp_file_path)
+      end
+    end
+  end
+end