docx 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00fd317c3d0d2f4ee4aafddd30ff41f29830f23c2e5f913c114cbc95b2bb58d1
-  data.tar.gz: 0ad6844aeb26d84f5275f86c43bb592f821be2541e797fa1318416dd20e77bf1
+  metadata.gz: 16df363293a0fcb4945e4ab7aa968f7138f2d0e38d25bcf689a5c5142279e520
+  data.tar.gz: '089d8ef9c78a7ae13d980d3a78ce729b05fe6dff1fefe8bbdfe4488a6b7b0f91'
 SHA512:
-  metadata.gz: 32e693b1114347678865a0b5f409a745e1f4a3a195ef70d2ab6cc255022abaad79b3bed9dd66426746b2b207ab176af19178207c4e2e6af790cd8213575ee605
-  data.tar.gz: 438dbbb6ca717e985c80f0ff4eca824c44fd1d2c94832b40121fb4423e6bf59389b03dce6d66b2f6bbbf9715e68df62c9db3db8e5a4cc60772b7cd1cdd95983d
+  metadata.gz: 8a23b154632578c3a702d3e16b6bbc3d763f062860ea9cf8db6c6814e89c1e7d99073fa28b7f90276c883d5c1f47be9d688d6f05177c06dbfc3bc452ccadc371
+  data.tar.gz: a8a735936caad5c75f56cace55e980df01bb25af795d5b8d040b735b14510898b220da3b8f40c52b74c68dc371c9a2d25bc2791d44a54a74dde9db727d3432ae

data/README.md

@@ -5,13 +5,13 @@
 [![Coverage Status](https://coveralls.io/repos/github/ruby-docx/docx/badge.svg?branch=master)](https://coveralls.io/github/ruby-docx/docx?branch=master)
 [![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.
+A ruby library/gem for interacting with `.docx` files. currently capabilities include reading paragraphs/bookmarks, inserting text at bookmarks, reading and writing headers/footers, reading tables/rows/columns/cells and saving the document.
 
 ## Usage
 
 ### Prerequisites
 
-- Ruby 2.6 or later
+- Ruby 2.7 or later
 
 ### Install
 
@@ -63,6 +63,26 @@ doc = Docx::Document.open(buffer)
 # Everything about reading is the same as shown above
 ```
 
+### Reading headers and footers
+
+``` ruby
+require 'docx'
+
+doc = Docx::Document.open('example.docx')
+
+# Headers and footers are returned as hashes keyed by their file name
+# (e.g. "header1", "footer1"), with Nokogiri documents as values.
+doc.headers.each do |name, header|
+  puts name
+  puts header.text
+end
+
+doc.footers.each do |name, footer|
+  puts name
+  puts footer.text
+end
+```
+
 ### Rendering html
 ``` ruby
 require 'docx'
@@ -116,7 +136,11 @@ doc = Docx::Document.open('example.docx')
 doc.bookmarks['example_bookmark'].insert_text_after("Hello world.")
 
 # Insert multiple lines of text at our bookmark
-doc.bookmarks['example_bookmark_2'].insert_multiple_lines_after(['Hello', 'World', 'foo'])
+doc.bookmarks['example_bookmark_2'].insert_multiple_lines(['Hello', 'World', 'foo'])
+
+# Bookmarks placed in headers and footers are included too, and edits to them
+# are saved along with the document.
+doc.bookmarks['header_bookmark'].insert_text_after("Hello from the header.")
 
 # Remove paragraphs
 doc.paragraphs.each do |p|

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?
@@ -68,6 +70,9 @@ module Docx
     def bookmarks
       bkmrks_hsh = {}
       bkmrks_ary = @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
+      # also scan headers and footers so their bookmarks can be read and edited
+      bkmrks_ary += headers.values.flat_map { |h| h.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node } }
+      bkmrks_ary += footers.values.flat_map { |f| f.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 }
@@ -200,6 +205,24 @@ module Docx
       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)
@@ -225,6 +248,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.1'
+  VERSION = '0.12.0'
 end

metadata

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