Added streaming result instead of saving to a path

Author: visoft

lib/docx/document.rb

@@ -121,6 +121,27 @@ def save(path)
       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))
+          end
+        end
+      end
+
+      stream.rewind
+      stream
+    end
+
     alias text to_s
 
     def replace_entry(entry_path, file_contents)

spec/docx/document_spec.rb

@@ -48,7 +48,7 @@
     end
   end
 
-  shared_examples_for 'saving' do
+  shared_examples_for 'saving to file' do
     it 'should save to a normal file path' do
       @new_doc_path = @fixtures_path + '/new_save.docx'
       @doc.save(@new_doc_path)
@@ -359,7 +359,7 @@
         @doc = Docx::Document.open(@fixtures_path + '/saving.docx')
       end
 
-      it_behaves_like 'saving'
+      it_behaves_like 'saving to file'
     end
 
     context 'from a stream' do
@@ -368,7 +368,7 @@
         @doc = Docx::Document.open_buffer(stream)
       end
 
-      it_behaves_like 'saving'
+      it_behaves_like 'saving to file'
     end
 
     context 'wps modified docx file' do
@@ -382,6 +382,13 @@
     end
   end
 
+  describe 'streaming' do
+    it 'should return a StringIO to send over HTTP' do
+      doc = Docx::Document.open(@fixtures_path + '/basic.docx')
+      expect(doc.stream).to be_a(StringIO)
+    end
+  end
+
   describe 'outputting html' do
     before do
       @doc = Docx::Document.open(@fixtures_path + '/formatting.docx')