docx 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b2cc086dcc2bb5043cc9f20b311f1e4b02f7c9730f459c8b91e48097d8bacb5
-  data.tar.gz: 8536619dd3cebe92112b7328cf64cdca40be898411d974037d5e9ffc02af1a08
+  metadata.gz: db3defcbe5cacff393d7c87a7ad93cb305a630397f90c4ae6e93c51cf0d5b6a1
+  data.tar.gz: 63efc745ef47ae41110937e2b4596ad49a8b8e4bb5e4557799be6efcabee369a
 SHA512:
-  metadata.gz: 77a0ee6f32422ad64e916b98d52d685958867e574582252d4ce424fac721cee4f73b400f8960ad88c762608024bfa7a5d966bea0cd65e1daecdb4d58967da307
-  data.tar.gz: e87937fb28f2c6f7d7777b63df9b483fde5670e98261253b91ed55fee4d737f72cc2596542ced45a80ba525a18b9ca7a1760f76440ad71ed30facdfe17fd0cc1
+  metadata.gz: 1b7540ec11e9067374988c91bf09c733892275d39803bf121e88025bc27233e129712a7e478167598e8c6cf805947004807ed80cddf8461bf28c602336b53d9e
+  data.tar.gz: abedf7373093642703701f6ac6b7e4026a4fe713ab9af6665b39fd01de58ceffac211916cec08b14e0179f5d691afac3be3d0c5b05b8fcc0e397466e0a672385

data/README.md

@@ -1,5 +1,9 @@
 # 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
@@ -47,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'

data/lib/docx/document.rb

@@ -20,19 +20,27 @@ module Docx
   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,13 +49,12 @@ module Docx
       }
     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
@@ -55,11 +62,11 @@ module Docx
     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 @@ module Docx
     # 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
@@ -103,6 +112,7 @@ module Docx
       Zip::OutputStream.open(path) do |out|
         zip.each do |entry|
           next unless entry.file?
+
           out.put_next_entry(entry.name)
 
           if @replace[entry.name]
@@ -115,7 +125,28 @@ module Docx
       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
@@ -123,13 +154,21 @@ module Docx
 
     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

data/lib/docx/elements/bookmark.rb

@@ -5,7 +5,7 @@ module Docx
     class Bookmark
       include Element
       attr_accessor :name
-      
+
       def self.tag
         'bookmarkStart'
       end
@@ -17,14 +17,14 @@ module Docx
 
       # Insert text before bookmarkStart node
       def insert_text_before(text)
-        text_run = get_run_after
-        text_run.text = "#{text}#{text_run.text}"
+        text_run = get_run_before
+        text_run.text = "#{text_run.text}#{text}"
       end
 
       # Insert text after bookmarkStart node
       def insert_text_after(text)
-        text_run = get_run_before
-        text_run.text = "#{text_run.text}#{text}"
+        text_run = get_run_after
+        text_run.text = "#{text}#{text_run.text}"
       end
 
       # insert multiple lines starting with paragraph containing bookmark node.
@@ -51,7 +51,7 @@ module Docx
 
       # Get text run immediately prior to bookmark node
       def get_run_before
-        # at_xpath returns the first match found and preceding-sibling returns siblings in the 
+        # at_xpath returns the first match found and preceding-sibling returns siblings in the
         # order they appear in the document not the order as they appear when moving out from
         # the starting node
         if not (r_nodes = @node.xpath("./preceding-sibling::w:r")).empty?

data/lib/docx/version.rb

@@ -1,3 +1,3 @@
 module Docx #:nodoc:
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Christopher Hunt
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri