Merge branch 'master' into fix-newlines

Author: satoryu

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [satoryu] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce
+
+Steps to reproduce the behavior or put a short code to reproduce the bug. 
+
+### example
+
+```rb
+require 'docx'
+
+doc = Docx::Document.new('/path/to/your/docx/file.docx')
+
+## Something to reproduce the bug here
+```
+
+## Sample docx file
+
+Put a sample docx file to reproduce the bug reported here to this issue. 
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Environment
+
+- Ruby version: [e.g 2.7.1]
+- `docx` gem version: [e.g 0.5.0]
+- OS: [e.g. iOS]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+## Problem
+
+Please share a clear and concise description of what the problem is. 
+
+> Ex. I'm always frustrated when [...]
+
+## Solution
+
+Please describe the solution you'd like. 
+
+## Alternative solutions
+
+A clear and concise description of any alternative solutions or features you've considered.

.travis.yml

@@ -2,8 +2,18 @@ language: ruby
 dist: trusty
 sudo: false
 rvm:
-- 2.4
-- 2.5
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+cache: bundler
 bundler_args: --jobs=2
+
 script:
-- bundle exec rake spec
+  - bundle exec rake spec

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## v0.5.0
+
+### Enhancements
+
+- Added opening streams and outputting to a stream [#66](https://github.com/ruby-docx/docx/pull/66)
+- Added supports for Office 365 files [#85](https://github.com/ruby-docx/docx/pull/85)
+
+### Bug fixes
+
+- `Docx::Document` handles a docx file without styles.xml [#81](https://github.com/ruby-docx/docx/pull/81)
+- Fixes insert text before after were switched [#84](https://github.com/ruby-docx/docx/pull/84)
+
+## v0.4.0
+
+### Enhancements
+
+- Implement substitute method on TextRun class. [#75](https://github.com/ruby-docx/docx/pull/75)
+
+### Improvements
+
+- Updates dependencies. [#72](https://github.com/ruby-docx/docx/pull/72), [#77](https://github.com/ruby-docx/docx/pull/77)
+- Fix: #paragraphs grabs paragraphs in tables. [#76](https://github.com/ruby-docx/docx/pull/76)
+- Updates supported ruby versions. [#78](https://github.com/ruby-docx/docx/pull/78)

README.md

@@ -1,14 +1,36 @@
 # docx
 
+[![Gem Version](https://badge.fury.io/rb/docx.svg)](https://badge.fury.io/rb/docx)
+[![Build Status](https://travis-ci.org/ruby-docx/docx.svg?branch=master)](https://travis-ci.org/ruby-docx/docx)
+[![Gitter](https://badges.gitter.im/ruby-docx/community.svg)](https://gitter.im/ruby-docx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
 A ruby library/gem for interacting with `.docx` files. currently capabilities include reading paragraphs/bookmarks, inserting text at bookmarks, reading tables/rows/columns/cells and saving the document.
 
 ## Usage
 
+### Prerequisites
+
+- Ruby 2.4 or later
+
 ### Install
 
-Requires ruby (tested with 2.1.1)
+Add the following line to your application's Gemfile:
 
-    gem 'docx', '~> 0.2.07', :require => ["docx"]
+```ruby
+gem 'docx'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install docx
+```
 
 ### Reading
 
@@ -29,6 +51,17 @@ doc.bookmarks.each_pair do |bookmark_name, bookmark_object|
 end
 ```
 
+Don't have a local file but a buffer? Docx handles those to:
+
+```ruby
+require 'docx'
+
+# Create a Docx::Document object from a remote file
+doc = Docx::Document.open(buffer)
+
+# Everything about reading is the same as shown above
+```
+
 ### Rendering html
 ``` ruby
 require 'docx'
@@ -61,7 +94,7 @@ doc.tables.each do |table|
       puts cell.text
     end
   end
-  
+
   table.columns.each do |column| # Column-based iteration
     column.cells.each do |cell|
       puts cell.text
@@ -89,6 +122,13 @@ doc.paragraphs.each do |p|
   p.remove! if p.to_s =~ /TODO/
 end
 
+# Substitute text, preserving formatting
+doc.paragraphs.each do |p|
+  p.each_text_run do |tr|
+    tr.substitute('_placeholder_', 'replacement value')
+  end
+end
+
 # Save document to specified path
 doc.save('example-edited.docx')
 ```

docx.gemspec

@@ -11,10 +11,11 @@ Gem::Specification.new do |s|
   s.email       = ['chrahunt@gmail.com']
   s.homepage    = 'https://github.com/chrahunt/docx'
   s.files       = Dir["README.md", "LICENSE.md", "lib/**/*.rb"]
+  s.required_ruby_version = '>= 2.4.0'
 
-  s.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
-  s.add_dependency 'rubyzip',  '~> 1.2', '>= 1.2.1'
+  s.add_dependency 'nokogiri', '~> 1.10', '>= 1.10.4'
+  s.add_dependency 'rubyzip',  '~> 2.0'
 
   s.add_development_dependency 'rspec', '~> 3.7'
-  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'rake', '~> 13.0'
 end

lib/docx/containers/text_run.rb

@@ -45,6 +45,13 @@ def parse_text
           @text_nodes.map(&:content).join('')
         end
 
+        # Substitute text in text @text_nodes
+        def substitute(match, replacement)
+          @text_nodes.each do |text_node|
+            text_node.content = text_node.content.gsub(match, replacement)
+          end
+        end
+
         def parse_formatting
           {
             italic:    !@node.xpath('.//w:i').empty?,

lib/docx/document.rb

@@ -19,20 +19,28 @@ module Docx
   #   end
   class Document
     attr_reader :xml, :doc, :zip, :styles
-    
-    def initialize(path, &block)
+
+    def initialize(path_or_io, options = {})
       @replace = {}
-      @zip = Zip::File.open(path)
-      @document_xml = @zip.read('word/document.xml')
-      @doc = Nokogiri::XML(@document_xml)
-      @styles_xml = @zip.read('word/styles.xml')
-      @styles = Nokogiri::XML(@styles_xml)
-      if block_given?
-        yield self
-        @zip.close
+
+      # if path-or_io is string && does not contain a null byte
+      if (path_or_io.instance_of?(String) && !/\u0000/.match?(path_or_io))
+        @zip = Zip::File.open(path_or_io)
+      else
+        @zip = Zip::File.open_buffer(path_or_io)
       end
-    end
 
+      document = @zip.find_entry('word/document.xml')
+      document ||= @zip.find_entry('word/document2.xml')
+      raise Errno::ENOENT if document.nil?
+
+      @document_xml = document.get_input_stream.read
+      @doc = Nokogiri::XML(@document_xml)
+      load_styles
+      yield(self) if block_given?
+    ensure
+      @zip.close
+    end
 
     # This stores the current global document properties, for now
     def document_properties
@@ -41,25 +49,24 @@ def document_properties
       }
     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
     #   open(filepath) {|file| block } => obj
     def self.open(path, &block)
-      self.new(path, &block)
+      new(path, &block)
     end
 
     def paragraphs
-      @doc.xpath('//w:document//w:body//w:p').map { |p_node| parse_paragraph_from p_node }
+      @doc.xpath('//w:document//w:body/w:p').map { |p_node| parse_paragraph_from p_node }
     end
 
     def bookmarks
-      bkmrks_hsh = Hash.new
+      bkmrks_hsh = {}
       bkmrks_ary = @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
       # auto-generated by office 2010
-      bkmrks_ary.reject! {|b| b.name == "_GoBack" }
-      bkmrks_ary.each {|b| bkmrks_hsh[b.name] = b }
+      bkmrks_ary.reject! { |b| b.name == '_GoBack' }
+      bkmrks_ary.each { |b| bkmrks_hsh[b.name] = b }
       bkmrks_hsh
     end
 
@@ -70,6 +77,8 @@ def tables
     # Some documents have this set, others don't.
     # Values are returned as half-points, so to get points, that's why it's divided by 2.
     def font_size
+      return nil unless @styles
+
       size_tag = @styles.xpath('//w:docDefaults//w:rPrDefault//w:rPr//w:sz').first
       size_tag ? size_tag.attributes['val'].value.to_i / 2 : nil
     end
@@ -102,6 +111,8 @@ def save(path)
       update
       Zip::OutputStream.open(path) do |out|
         zip.each do |entry|
+          next unless entry.file?
+
           out.put_next_entry(entry.name)
 
           if @replace[entry.name]
@@ -114,21 +125,50 @@ def save(path)
       zip.close
     end
 
-    alias_method :text, :to_s
+    # 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)
       @replace[entry_path] = file_contents
     end
 
     private
 
+    def load_styles
+      @styles_xml = @zip.read('word/styles.xml')
+      @styles = Nokogiri::XML(@styles_xml)
+    rescue Errno::ENOENT => e
+      warn e.message
+      nil
+    end
+
     #--
     # 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
     # end of methods that make edits?
     #++
     def update
-      replace_entry "word/document.xml", doc.serialize(:save_with => 0)
+      replace_entry 'word/document.xml', doc.serialize(save_with: 0)
     end
 
     # generate Elements::Containers::Paragraph from paragraph XML node