omnidocx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb2d9b3c0660ef87f01bbae03091086530c53356
+  data.tar.gz: 06199961c7335fc951154813e6f20ba7905f3cce
+SHA512:
+  metadata.gz: 0db84fb799547a87ed70d396959846117f9a8fea6f5426e0a42f72b12b889866f685cfcfad71e86be6d468cbbfc36a8ac420590d1bb2b158e15996ae655972e2
+  data.tar.gz: e079825e879615772658e23cd28e7adeee0177e8fab882f3190b258434bf395d19a5e5b24b698de007994a2b25575404d9ce00e2bf2822c9bd7a6995a13c965b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at parth.nagori@idfy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omnidocx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Omnidocx
+
+Omnidocx is ruby gem that allows you to merge multiple docx (microsoft word) files into one, writing images to a docx file and making string replacements in the header, footer or main document content.
+This gem works for docx files generated from microsoft word as well as google docs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omnidocx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omnidocx
+
+## To Merge Documents
+
+If you plan to have a header and footer applied to all the pages of the final document, then pass the document with header and footer as the first document in the array. Currently multiple different headers and footers are not supported.
+
+While passing documents array make sure all the documents are from the same source, i.e., either microsoft word or google docs. Passing a mix of documents created from microsoft word and google docs might throw up namespace errors. 
+
+
+```ruby
+require 'omnidocx'
+
+# To merge multiple docx files into one, you can use the following
+# documents_to_merge is an array of documents (file paths) need to be merged and page_break is a boolean value if you want page breaks in b/w documents
+$ Omnidocx::Docx.merge_documents(documents_to_merge=[], output_document_path, page_break)
+
+# for e.g. if you had to merge two documents, just pass their entire paths in an array, if you need a page break in between documents then pass the page_break flag as true 
+$ Omnidocx::Docx.merge_documents(['tmp/doc1.docx', 'tmp/doc2.docx'], 'tmp/output_doc.docx', true)
+```
+
+## To Write Images to a Document
+```ruby
+require 'omnidocx'
+
+# To write images to a document, you can use the following
+# images_to_write is an array of hashes, where each hash stores information about one image
+$ Omnidocx::Docx.write_images_to_doc(images_to_write=[], input_document_path, output_document_path)
+
+# Below is an example of the images_to_write array that you can pass in for images to be written to the doc
+# image path, height and width are mandatory
+
+    $ images_to_write = [ {
+                          :path => "tmp/image1.jpg",     #URL || local path
+                          :height => 500,
+                          :width => 500,
+                          :hdpi => 115,       #optional
+                          :vdpi => 115        #optional
+                          },
+                          :path => "https://xyz.com/abc.jpeg",    #URL || local path
+                          :height => 800,
+                          :width => 500,
+                          :hdpi => 115,       #optional
+                          :vdpi => 115        #optional
+                          }
+                        ]
+
+```
+
+## For String Replacements
+
+There are three different methods that can be used for string replacements
+
+```ruby
+require 'omnidocx'
+
+# replacement_hash is a hash with keys present in the document that are to be replaced with their corresponding values
+
+# For document content, you can use the following
+$ Omnidocx::Docx.replace_doc_content(replacement_hash={}, input_document_path, output_document_path)
+
+# For header content, you can use the following
+$ Omnidocx::Docx.replace_header_content(replacement_hash={}, input_document_path, output_document_path)
+
+# For footer content, you can use the following
+$ Omnidocx::Docx.replace_footer_content(replacement_hash={}, input_document_path, output_document_path)
+
+# Below is an example of how replacement_hash can be constructed 
+$ replacement_hash = { "first_name" => "John", "last_name" => "Doe"}
+
+```
+
+Will be adding test specs soon.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/parthnagori/omnidocx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omnidocx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omnidocx.rb

@@ -0,0 +1,539 @@
+require "omnidocx/version"
+require 'nokogiri'
+require 'zip'
+require 'tempfile'
+require 'mime/types'
+require 'open-uri'
+
+
+module Omnidocx
+  class Docx
+    DOCUMENT_FILE_PATH = 'word/document.xml'
+    RELATIONSHIP_FILE_PATH = 'word/_rels/document.xml.rels'
+    CONTENT_TYPES_FILE = '[Content_Types].xml'
+    HEADER_RELS_FILE_PATH = 'word/_rels/header1.xml.rels'
+    FOOTER_RELS_FILE_PATH = 'word/_rels/footer1.xml.rels'
+    STYLES_FILE_PATH = "word/styles.xml"
+    HEADER_FILE_PATH = "word/header1.xml"
+    FOOTER_FILE_PATH = "word/footer1.xml"
+
+    MEDIA_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
+
+    EMUSPERINCH = 914400
+    EMUSPERCM = 360000
+    HORIZONTAL_DPI = 115
+    VERTICAL_DPI = 117
+
+    NAMESPACES = {
+      "w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
+      "wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
+      "a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+      "pic": "http://schemas.openxmlformats.org/drawingml/2006/picture",
+      "r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+    }
+
+    IMAGE_ELEMENT = '<w:p xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" w:rsidR="00F127EA" w:rsidRDefault="00F127EA" w:rsidP="00BF4C96"><w:pPr><w:jc w:val="center"/></w:pPr><w:r><w:rPr><w:noProof/><w:lang w:eastAsia="en-IN"/></w:rPr><w:drawing><wp:inline xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" distT="0" distB="0" distL="0" distR="0"><wp:extent cx="" cy=""/><wp:effectExtent l="0" t="0" r="2540" b="1905"/><wp:docPr id="" name=""/><wp:cNvGraphicFramePr><a:graphicFrameLocks xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" noChangeAspect="1"/></wp:cNvGraphicFramePr><a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main"><a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture"><pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture"><pic:nvPicPr><pic:cNvPr id="" name=""/><pic:cNvPicPr/></pic:nvPicPr><pic:blipFill><a:blip xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" r:embed=""><a:extLst><a:ext uri="{28A0092B-C50C-407E-A947-70E740481C1C}"><a14:useLocalDpi xmlns:a14="http://schemas.microsoft.com/office/drawing/2010/main" val="0"/></a:ext></a:extLst></a:blip><a:stretch><a:fillRect/></a:stretch></pic:blipFill><pic:spPr><a:xfrm><a:off x="0" y="0"/><a:ext cx="" cy=""/></a:xfrm><a:prstGeom prst="rect"><a:avLst/></a:prstGeom></pic:spPr></pic:pic></a:graphicData></a:graphic></wp:inline></w:drawing></w:r></w:p>'
+
+
+    def self.write_images_to_doc(images_to_write=[], doc_path, final_path)
+      
+      temp_file = Tempfile.new('docxedit-')
+
+      #every docx file is ultimately a zip file with the extension as docx
+      @document_zip = Zip::File.new(doc_path)
+      #reading the document content xml from the zip
+      @document_content = @document_zip.read(DOCUMENT_FILE_PATH)
+      @document_xml = Nokogiri::XML @document_content
+
+      #every docx file has one body tag which essentially contains all the content of the doc
+      @body = @document_xml.xpath("//w:body")
+
+      @rel_doc = ""
+      @cont_type_doc = ""
+
+      cnt = 20
+      media_hash = {}
+      
+      #to maintain a list of all the content type info to be added upon adding media with different extensions
+      media_content_type_hash = {}
+
+    
+      @document_zip.entries.each do |e|
+        if e.name == RELATIONSHIP_FILE_PATH
+          in_stream = e.get_input_stream.read
+          @rel_doc = Nokogiri::XML in_stream    #Relationships XML
+        end
+        if e.name == CONTENT_TYPES_FILE
+          in_stream = e.get_input_stream.read
+          @cont_type_doc = Nokogiri::XML in_stream  #Content types XML to be updated later on with the additional media type info
+        end 
+      end
+
+      Zip::OutputStream.open(temp_file.path) do |zos|
+
+        @document_zip.entries.each do |e|
+          unless [DOCUMENT_FILE_PATH, RELATIONSHIP_FILE_PATH, CONTENT_TYPES_FILE].include?(e.name)
+            #writing the files not needed to be edited back to the new zip
+            zos.put_next_entry(e.name)  
+            zos.print e.get_input_stream.read
+          end
+        end
+
+        images_to_write.each_with_index do |img, index|
+          data = ''
+          
+          #checking if image path is a url or a local path
+          uri = URI.parse(img[:path])
+          if %w( http https ).include?(uri.scheme)
+            data = Kernel.open(img[:path]).read rescue nil
+          else
+            File.open(img[:path], 'rb') do |f|
+              data = f.read rescue nil
+            end
+          end
+
+          #if image path is readable
+          if !data.empty?
+            extension = File.extname(img[:path]).split(".").last
+
+            if !media_content_type_hash.keys.include?(extension.split(".").last)
+              #making an entry for a new media type
+              media_content_type_hash["#{extension}"] = MIME::Types.type_for(img[:path])[0].to_s
+            end
+    
+            zos.put_next_entry("word/media/image#{cnt}.#{extension}")
+            zos.print data     #storing the image in the new zip
+            
+            new_rel_node = Nokogiri::XML::Node.new("Relationship", @rel_doc)
+            new_rel_node["Id"] = "rid#{cnt}"
+            new_rel_node["Type"] = MEDIA_TYPE
+            new_rel_node["Target"] = "media/image#{cnt}.#{extension}"
+            @rel_doc.at('Relationships').add_child(new_rel_node)      #adding a new relationship node to the relationships xml
+            
+            hdpi = img[:hdpi] || HORIZONTAL_DPI
+            vdpi = img[:vdpi] || VERTICAL_DPI
+
+            #calculating the width and height of the image in EMUs, the format accepted by docx files
+            widthEmus = (img[:width].to_i / hdpi.to_i * EMUSPERINCH)
+            heightEmus = (img[:height].to_i / vdpi.to_i * EMUSPERINCH)
+
+            #creating a new drawing element with info like rid, height, width,etc.
+            @image_element_xml = Nokogiri::XML IMAGE_ELEMENT
+            @image_element_xml.xpath("//w:drawing", NAMESPACES).each do |dr_node|
+              docPr = dr_node.xpath(".//wp:docPr", NAMESPACES).last
+              docPr["name"] = "image#{cnt}.#{extension}"
+              docPr["id"] = "#{cnt}"
+
+              extent = dr_node.xpath(".//wp:extent", NAMESPACES).last
+              extent["cx"] = widthEmus.to_s
+              extent["cy"] = heightEmus.to_s
+
+              ext = dr_node.xpath(".//a:ext", NAMESPACES).last
+              ext["cx"] = widthEmus.to_s
+              ext["cy"] = heightEmus.to_s
+
+              pic_cNvPr = dr_node.xpath(".//pic:cNvPr", NAMESPACES).last
+              pic_cNvPr["name"] = "image#{cnt}.#{extension}"
+              pic_cNvPr["id"] = "#{cnt}"
+              
+              blip = dr_node.xpath(".//a:blip", NAMESPACES).last
+              blip.attributes["embed"].value = "rid#{cnt}"
+            end
+
+            #appending the drawing element to the document's body
+            @body.children.last.add_previous_sibling(@image_element_xml.xpath("//w:p").last.to_xml)
+
+            media_hash[cnt] = index
+          end
+          cnt+=1
+        end  
+
+        #updating the content type info
+        media_content_type_hash.each do |ext, cont_type|
+          new_default_node = Nokogiri::XML::Node.new("Default", @cont_type_doc)
+          new_default_node["Extension"] = ext
+          new_default_node["ContentType"] = cont_type
+          @cont_type_doc.at("Types").add_child(new_default_node)
+        end
+
+        #writing the content types xml to the new zip
+        zos.put_next_entry CONTENT_TYPES_FILE
+        zos.print @cont_type_doc.to_xml
+
+        #writing the relationships xml to the new zip
+        zos.put_next_entry RELATIONSHIP_FILE_PATH
+        zos.print @rel_doc.to_xml
+
+        #writing the updated document content xml to the new zip
+        zos.put_next_entry DOCUMENT_FILE_PATH
+        zos.print @document_xml.to_xml
+      end
+
+      #moving the temporary docx file to the final_path specified by the user
+      FileUtils.mv(temp_file.path, final_path)
+    end
+
+    def self.merge_documents(documents_to_merge=[], final_path, page_break)
+      temp_file = Tempfile.new('docxedit-')
+
+      if documents_to_merge.count < 2
+        return "Pass atleast two documents to be merged"   #minimum two documents required to merge
+      end
+
+      #first document to which the others will be appended (header/footer will be picked from this document)
+      @main_document_zip = Zip::File.new(documents_to_merge.first)
+      @main_document_content = @main_document_zip.read(DOCUMENT_FILE_PATH)
+      @main_document_xml = Nokogiri::XML @main_document_content
+      @main_body = @main_document_xml.xpath("//w:body")
+      @rel_nodes = ""
+      @rel_doc = ""
+      @cont_type_doc = ""
+      @style_doc = ""
+      doc_cnt = 0
+      #cnt variable to construct relationship ids, taken a high value 100 to avoid duplication
+      cnt = 100
+      tbl_cnt = 10
+      #hash to store information about the media files and their corresponding new names
+      media_hash = {}
+      #rid_hash to store relationship information
+      rid_hash = {}
+      #table hash to store information if any tables present
+      table_hash = {}
+      #head_foot_media hash to store if any media files present in header/footer
+      head_foot_media = {}
+      #a counter for docPr element in the main document body
+      docPr_id = 100
+
+      #array to store content type information about media extensions
+      default_extensions = []
+      #array to store override content type information
+      override_partnames = []
+
+      #array to store information about additional content types other than the ones present in the first(main) document
+      additional_cont_type_entries = []
+
+
+      @main_document_zip.entries.each do |e|
+        if e.name == RELATIONSHIP_FILE_PATH
+          @in_stream = e.get_input_stream.read
+          @rel_doc = Nokogiri::XML @in_stream        #Relationship XML
+          @rel_nodes = @rel_doc.css "Relationship"
+        end
+        if e.name == CONTENT_TYPES_FILE
+          in_stream = e.get_input_stream.read
+          @cont_type_doc = Nokogiri::XML in_stream       #Content types XML to be updated later on with the additional media type info
+          default_nodes = @cont_type_doc.css "Default"
+          override_nodes = @cont_type_doc.css "Override"
+          default_nodes.each do |node|
+            default_extensions << node["Extension"]
+          end
+          override_nodes.each do |node|
+            override_partnames << node["PartName"]
+          end
+        end
+        if e.name == STYLES_FILE_PATH
+          in_stream = e.get_input_stream.read
+          @style_doc = Nokogiri::XML in_stream      #Styles XML to be updated later on with the additional tables info
+        end 
+      end
+
+
+      #opening a new zip for the final document
+      Zip::OutputStream.open(temp_file.path) do |zos|
+        documents_to_merge.each do |doc_path|
+          media_hash["doc#{doc_cnt}"] = {}
+          rid_hash["doc#{doc_cnt}"] = {}
+          head_foot_media["doc#{doc_cnt}"] = []
+          table_hash["doc#{doc_cnt}"] = {}
+          zip_file = Zip::File.new(doc_path)
+          
+          zip_file.entries.each do |e|
+            if [HEADER_RELS_FILE_PATH, FOOTER_RELS_FILE_PATH].include?(e.name)
+              hf_content = e.get_input_stream.read
+              hf_xml = Nokogiri::XML hf_content
+              hf_xml.css("Relationship").each do |rel_node|
+                #media file names in header & footer need not be changed as they will be picked from the first document only and not the subsequent documents, so no chance of duplication
+                head_foot_media["doc#{doc_cnt}"] << rel_node["Target"].gsub("media/","") 
+              end
+            end
+            if e.name == CONTENT_TYPES_FILE
+              cont_types = e.get_input_stream.read
+              cont_type_xml = Nokogiri::XML cont_types
+              default_nodes = cont_type_xml.css "Default"
+              override_nodes = cont_type_xml.css "Override"
+
+              default_nodes.each do |node|
+                #checking if extension type already present in the content types xml extracted from the first document
+                if !default_extensions.include?(node["Extension"]) && !node.to_xml.empty?   
+                  additional_cont_type_entries << node
+                  default_extensions << node["Extension"]    #extra extension type to be added to the content types XML
+                end
+              end
+
+              override_nodes.each do |node|
+                #checking if override content tpye infoalready present in the content types xml extracted from the first document
+                if !override_partnames.include?(node["PartName"]) && !node.to_xml.empty?
+                  additional_cont_type_entries << node
+                  override_partnames << node["Partname"]       #extra content type info to be added to the content types XML
+                end
+              end
+            end
+          end
+
+
+          zip_file.entries.each do |e|
+            unless e.name == DOCUMENT_FILE_PATH || [RELATIONSHIP_FILE_PATH, CONTENT_TYPES_FILE, STYLES_FILE_PATH].include?(e.name)
+              if e.name.include?("word/media/image")
+                if !head_foot_media["doc#{doc_cnt}"].include?(e.name.gsub("word/media/",""))
+                  #renaming media files with a higher counter to avoid duplicaiton in case multiple documents have images present
+                  e_name = e.name.gsub(/image[0-9]*./,"image#{cnt}.")
+                  #writing the media file back to the new zip with the new name
+                  zos.put_next_entry(e_name)      
+                  zos.print e.get_input_stream.read
+                  #storing the old media file name to new media file name to mapping in the media hash
+                  media_hash["doc#{doc_cnt}"][e.name.gsub("word/media/","")] = cnt
+                  cnt+=1
+                else
+                  #writing the media files present in the header and footer as their names are not needed to be changed
+                  zos.put_next_entry(e.name)
+                  zos.print e.get_input_stream.read  
+                end 
+              else
+                #writing the files not needed to be edited back to the new zip (only from the first document, so as to avoid duplication) 
+                if doc_cnt == 0
+                  zos.put_next_entry(e.name)
+                  zos.print e.get_input_stream.read
+                end
+              end
+            end
+          end
+
+          if doc_cnt == 0
+            doc_content = @main_document_xml      #first document's content XML
+          else
+            document_content = zip_file.read(DOCUMENT_FILE_PATH)
+            doc_content = Nokogiri::XML document_content      #subsequent documents' content XML
+          end
+
+          #updating the stlye ids in the table elements present in the document content XML          
+          doc_content.xpath("//w:tbl").each do |tbl_node|
+            tblStyle = tbl_node.xpath('.//w:tblStyle').last
+
+            table_hash["doc#{doc_cnt}"]["#{tblStyle.attributes['val'].value}"] = tbl_cnt
+            tblStyle.attributes['val'].value = tblStyle.attributes['val'].value.gsub(/[0-9]+/,"#{tbl_cnt}")
+            tbl_cnt+=1
+          end
+
+          #updating the relationship ids with the new media file names in the relationships XML
+          if doc_cnt == 0
+            zip_file.entries.each do |e|
+              if e.name == RELATIONSHIP_FILE_PATH
+                @rel_nodes.each do |node|
+                  if node.values.to_s.include?("image")
+                    i = media_hash["doc#{doc_cnt}"]["#{node['Target']}".gsub("media/","")]
+                    target_val = node["Target"].gsub(/image[0-9]*./,"image#{i}.")
+                    node["Target"] = target_val
+                    rid_hash["doc#{doc_cnt}"]["#{node['Id']}"] = "#{i}"
+                    node.attributes["Id"].value = node.attributes["Id"].value.gsub(/[0-9]+/,"#{i}")
+                  end
+                end
+              end
+              #adding the table style information to the styles xml, if any tables present in the document being merged
+              if e.name == STYLES_FILE_PATH
+                table_nodes = @style_doc.xpath('//w:style').select{|n| n.attributes["type"].value == "table"}
+                table_nodes.each do |table_node|
+                  tab_val = table_hash["doc#{doc_cnt}"]["#{table_node.attributes['styleId'].value}"]
+                  table_node.attributes['styleId'].value = table_node.attributes['styleId'].value.gsub(/[0-9]+/,"#{tab_val}")
+                end
+              end
+            end
+          else
+            zip_file.entries.each do |e|
+              if e.name == RELATIONSHIP_FILE_PATH
+                input_stream = e.get_input_stream.read
+                rel_xml = Nokogiri::XML input_stream
+                rel_xml_nodes = rel_xml.css "Relationship"
+                rel_xml_nodes.each do |node|
+                  if node.values.to_s.include?("image")
+                    i = media_hash["doc#{doc_cnt}"]["#{node['Target']}".gsub("media/","")]
+                    target_val = node["Target"].gsub(/image[0-9]*./,"image#{i}.")
+                    rid_hash["doc#{doc_cnt}"]["#{node['Id']}"] = "#{i}"
+                  
+                    new_rel_node = Nokogiri::XML::Node.new("Relationship", @rel_doc)
+                    new_rel_node["Id"] = node.attributes["Id"].value.gsub(/[0-9]+/,"#{i}")
+                    new_rel_node["Type"] = node["Type"]
+                    new_rel_node["Target"] = target_val
+
+                    #adding the extra relationship nodes for the media files from the subsequent documents (apart from first) to the relationship XML 
+                    @rel_doc.at('Relationships').add_child(new_rel_node)     
+                  end
+                end
+              end
+
+              if e.name == STYLES_FILE_PATH
+                input_stream = e.get_input_stream.read
+                style_xml = Nokogiri::XML input_stream
+                table_nodes = style_xml.xpath("//w:style").select{|n| n.attributes["type"].value == "table" && n.attributes["styleId"].value != "TableNormal"}
+                table_nodes.each do |table_node|
+                  tab_val = table_hash["doc#{doc_cnt}"]["#{table_node.attributes['styleId'].value}"]
+                  table_node.attributes['styleId'].value = table_node.attributes['styleId'].value.gsub(/[0-9]+/,"#{tab_val}")
+                  #adding extra table style nodes to the styles xml, if any tables present in the document being merged
+                  @style_doc.xpath("//w:styles").children.last.add_next_sibling(table_node.to_xml)
+                end
+              end
+            end
+          end
+
+          #updting the id and rid values for every drawing element in the document XML with the new counters
+          doc_content.xpath("//w:drawing").each do |dr_node|
+            blip = dr_node.xpath(".//a:blip", NAMESPACES).last
+            i = rid_hash["doc#{doc_cnt}"][blip.attributes["embed"].value]
+            blip.attributes["embed"].value = blip.attributes["embed"].value.gsub(/[0-9]+/,i)
+            docPr = dr_node.xpath(".//wp:docPr").last
+            docPr["id"] = #{docPr_id}
+            docPr_id+=1 
+          end
+
+
+          if doc_cnt > 0
+            w_p_nodes = doc_content.xpath("//w:p")
+            #pulling out the <w:p> elements fromt the document body to be appended to the main document's body    
+            body_nodes = doc_content.xpath('//w:body').children[0..doc_content.xpath('//w:body').children.count-2]
+            
+            #adding a page break between documents being merged
+            if doc_cnt > 1 && page_break
+              @main_body.children.last.add_previous_sibling('<w:p><w:r><w:br w:type="page"/></w:r></w:p>')
+            end
+            #appending the body_nodes to main document's body
+            @main_body.children.last.add_previous_sibling(body_nodes.to_xml)
+          end
+
+          doc_cnt+=1  
+        end
+
+        #writing the updated styles XML to the new zip
+        zos.put_next_entry(STYLES_FILE_PATH)
+        zos.print @style_doc.to_xml  
+
+        #writing the updated relationships XML to the new zip
+        zos.put_next_entry(RELATIONSHIP_FILE_PATH)
+        zos.print @rel_doc.to_xml
+
+        zos.put_next_entry(CONTENT_TYPES_FILE)
+        additional_cont_type_entries.each do |node|
+          #adding addtional content type nodes to the content type XML
+          @cont_type_doc.at("Types").add_child(node)
+        end
+        #writing the updated content types XML to the new zip
+        zos.print @cont_type_doc.to_xml 
+
+        #writing the updated document content XML to the new zip
+        zos.put_next_entry(DOCUMENT_FILE_PATH)
+        zos.print @main_document_xml.to_xml
+      end
+
+      #moving the temporary docx file to the final_path specified by the user
+      FileUtils.mv(temp_file.path, final_path)      
+    end
+
+    def self.replace_doc_content(replacement_hash={}, template_path, final_path)
+      @template_zip = Zip::File.new(template_path)
+      @template_content = @template_zip.read(DOCUMENT_FILE_PATH)
+
+      #replacing the keys with values in the document content xml
+      replacement_hash.each do |key,value|
+        @template_content.force_encoding("UTF-8").gsub!(key,value)
+      end
+
+      temp_file = Tempfile.new('docxedit-')
+
+      Zip::OutputStream.open(temp_file.path) do |zos|
+
+        @template_zip.entries.each do |e|
+          unless e.name == DOCUMENT_FILE_PATH
+            #writing the files not needed to be edited back to the new zip
+            zos.put_next_entry(e.name)  
+            zos.print e.get_input_stream.read
+          end
+        end
+
+        #writing the updated document content xml to the new zip
+        zos.put_next_entry DOCUMENT_FILE_PATH
+        zos.print @template_content
+      end
+
+      #moving the temporary docx file to the final_path specified by the user
+      FileUtils.mv(temp_file.path, final_path)      
+    end
+
+    def self.replace_header_content(replacement_hash={}, template_path, final_path)
+      @template_zip = Zip::File.new(template_path)
+
+      @header_content = ''
+      @template_zip.entries.each do |e|
+        if e.name == HEADER_FILE_PATH
+          @header_content = e.get_input_stream.read
+        end
+      end
+
+      replacement_hash.each do |key,value|
+        @header_content.force_encoding("UTF-8").gsub!(key,value)
+      end
+
+      temp_file = Tempfile.new('docxedit-')
+
+      Zip::OutputStream.open(temp_file.path) do |zos|
+
+        @template_zip.entries.each do |e|
+          unless e.name == HEADER_FILE_PATH
+            #writing the files not needed to be edited back to the new zip
+            zos.put_next_entry(e.name)  
+            zos.print e.get_input_stream.read
+          end
+        end
+
+        #writing the updated document content xml to the new zip
+        zos.put_next_entry HEADER_FILE_PATH
+        zos.print @header_content
+      end
+
+      #moving the temporary docx file to the final_path specified by the user
+      FileUtils.mv(temp_file.path, final_path)      
+    end
+
+    def self.replace_footer_content(replacement_hash={}, template_path, final_path)
+      @template_zip = Zip::File.new(template_path)
+
+      @footer_content = ''
+      @template_zip.entries.each do |e|
+        if e.name == FOOTER_FILE_PATH
+          @footer_content = e.get_input_stream.read
+        end
+      end
+
+      replacement_hash.each do |key,value|
+        @footer_content.force_encoding("UTF-8").gsub!(key,value)
+      end
+
+      temp_file = Tempfile.new('docxedit-')
+
+      Zip::OutputStream.open(temp_file.path) do |zos|
+
+        @template_zip.entries.each do |e|
+          unless e.name == FOOTER_FILE_PATH
+            #writing the files not needed to be edited back to the new zip
+            zos.put_next_entry(e.name)  
+            zos.print e.get_input_stream.read
+          end
+        end
+
+        #writing the updated document content xml to the new zip
+        zos.put_next_entry FOOTER_FILE_PATH
+        zos.print @footer_content
+      end
+
+      #moving the temporary docx file to the final_path specified by the user
+      FileUtils.mv(temp_file.path, final_path)            
+    end
+  end
+end

data/lib/omnidocx/version.rb

@@ -0,0 +1,3 @@
+module Omnidocx
+  VERSION = "0.1.0"
+end

data/omnidocx.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omnidocx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omnidocx"
+  spec.version       = Omnidocx::VERSION
+  spec.authors       = ["Parth Nagori"]
+  spec.email         = ["nagori.parth@gmail.com"]
+
+  spec.summary       = %q{A gem to merge docx files, write images to docx and other utilities.}
+  spec.description   = %q{A gem that allows to merge multiple docx (microsoft word) files into one, writing images to a docx file and making string replacements in the header, footer or main document content.}
+  spec.homepage      = "https://github.com/parthnagori/omnidocx"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.1', '>= 1.1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: omnidocx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parth Nagori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that allows to merge multiple docx (microsoft word) files into
+  one, writing images to a docx file and making string replacements in the header,
+  footer or main document content.
+email:
+- nagori.parth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omnidocx.rb
+- lib/omnidocx/version.rb
+- omnidocx.gemspec
+homepage: https://github.com/parthnagori/omnidocx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A gem to merge docx files, write images to docx and other utilities.
+test_files: []