docx_tools 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5a2434c4452cf3eb2b6602513bbac7da765114d
+  data.tar.gz: 3e5d338708722a05adb60937b6ebc161dce2a2e9
+SHA512:
+  metadata.gz: 1864672d009f8bc460c2730aabb4f9fa5818957b04c80d020cf8b0fd6e428a4272e1c1f9ef70165b93ca4a96a1d260606a31a8f897144d2a3a50a05e95cfb001
+  data.tar.gz: 7b904651582f0ac616d291ce0b751478fee02945c0228d0a47c481cb5da99972574df4c407b803528037aac31e522eb34129d60bf80b4a65283f14e511c470de

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/.yardoc/
+/coverage/
+/doc/
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    docx_tools (0.0.1)
+      nokogiri (~> 1.6, >= 1.6.6)
+      rubyzip (~> 1.1, >= 1.1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.1.5)
+    json (1.8.3)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rubyzip (1.1.7)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  docx_tools!
+  minitest (~> 5.8)
+  simplecov (~> 0.10)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 DrugDev, Inc.
+
+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,3 @@
+= DocxTools
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'rake/testtask'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DocxTools'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'docx_tools'
+
+require 'irb'
+IRB.start

data/docx_tools.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docx_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docx_tools'
+  spec.version       = DocxTools::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['info@trialnetworks.com']
+  spec.homepage      = 'https://github.com/drugdev/docx_tools'
+
+  spec.summary       = 'Tools for manipulating docx files'
+  spec.description   = 'An API for managing merge fields within docx files'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.6'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.1', '>= 1.1.7'
+
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/docx_tools/document.rb

@@ -0,0 +1,22 @@
+module DocxTools
+  class Document
+
+    # the stored zip file (docx)
+    attr_accessor :zip
+
+    # read the filepath and parse it as a zip file
+    def initialize(filepath)
+      self.zip = Zip::File.open(filepath)
+    end
+
+    # the entries contained within the zip
+    def entries
+      zip.entries
+    end
+
+    # read the file within the zip at the given filename
+    def get(filename)
+      Nokogiri::XML(zip.read(filename))
+    end
+  end
+end

data/lib/docx_tools/mail_merge.rb

@@ -0,0 +1,111 @@
+module DocxTools
+  class MailMerge
+
+    REGEXP = / MERGEFIELD "?([^ ]+?)"? (| \\\* MERGEFORMAT )/i.freeze
+    attr_accessor :document, :part_list
+
+    def initialize(file_object)
+      self.document  = Document.new(file_object)
+      self.part_list = PartList.new(document, %w[document.main header footer])
+      process_merge_fields
+    end
+
+    def fields
+      fields = Set.new
+      part_list.each_part do |part|
+        part.xpath('.//w:MergeField').each do |mf|
+          fields.add(mf.content)
+        end
+      end
+      fields.to_a
+    end
+
+    def merge(replacements = {})
+      part_list.each_part do |part|
+        replacements.each do |field, text|
+          merge_field(part, field, text)
+        end
+      end
+    end
+
+    def write(filename)
+      File.open(filename, 'w') do |file|
+        file.write(generate.string)
+      end
+    end
+
+    private
+
+      def clean_up
+        remaining = fields.map { |field| [field.to_sym, ''] }
+        merge(remaining.to_h)
+      end
+
+      def generate
+        clean_up
+        buffer = Zip::OutputStream.write_buffer do |out|
+          document.entries.each do |entry|
+            unless entry.ftype == :directory
+              out.put_next_entry(entry.name)
+              if self.part_list.has?(entry.name)
+                out.write self.part_list.get(entry.name).to_xml(indent: 0).gsub('\n', '')
+              else
+                out.write entry.get_input_stream.read
+              end
+            end
+          end
+        end
+        buffer.seek(0)
+        buffer
+      end
+
+      def merge_field(part, field, text)
+        part.xpath(".//w:MergeField[text()=\"#{field}\"]").each do |merge_field|
+          r_elem = Nokogiri::XML::Node.new('r', part)
+          t_elem = Nokogiri::XML::Node.new('t', part)
+          t_elem.content = text
+          t_elem.parent = r_elem
+          merge_field.replace(r_elem)
+        end
+      end
+
+      # replace the original convoluted tag with a simplified tag for easy searching a processing
+      def process_merge_fields
+        self.part_list.each_part do |part|
+          part.root.remove_attribute('Ignorable')
+
+          part.xpath('.//w:fldSimple/..').each do |parent|
+            parent.children.each do |child|
+              match_data = REGEXP.match(child.attribute('instr'))
+              next if (child.node_name != 'fldSimple') || !match_data
+
+              new_tag = Nokogiri::XML::Node.new('MergeField', part)
+              new_tag.content = match_data[1]
+              child.replace(new_tag)
+            end
+          end
+
+          part.xpath('.//w:instrText/../..').each do |parent|
+            begin_tags = parent.xpath('w:r/w:fldChar[@w:fldCharType="begin"]/..')
+            end_tags = parent.xpath('w:r/w:fldChar[@w:fldCharType="end"]/..')
+            instr_tags = parent.xpath('w:r/w:instrText').map(&:content)
+
+            instr_tags.take(begin_tags.length).each_with_index do |instr, idx|
+              next unless match_data = REGEXP.match(instr)
+
+              children = parent.children
+              start_idx = children.index(begin_tags[idx]) + 1
+              end_idx = children.index(end_tags[idx])
+              children[start_idx..end_idx].each do |child|
+                child.remove
+              end
+
+              new_tag = Nokogiri::XML::Node.new('MergeField', part)
+              new_tag.content = match_data[1]
+              begin_tags[idx].replace(new_tag)
+            end
+          end
+        end
+      end
+  end
+end

data/lib/docx_tools/part_list.rb

@@ -0,0 +1,39 @@
+module DocxTools
+  class PartList
+
+    # the stored list of parts
+    attr_accessor :parts
+
+    # parse the content type entries out of the given document
+    def initialize(document, content_types)
+      self.parts = {}
+
+      content_types.map!(&method(:expand_type))
+      document.get('[Content_Types].xml').xpath(content_types.join(' | ')).each do |tag|
+        filename = tag['PartName'].split('/', 2)[1]
+        parts[filename] = document.get(filename)
+      end
+    end
+
+    # yield each part to the block
+    def each_part(&block)
+      parts.values.each(&block)
+    end
+
+    # get the requested part
+    def get(filename)
+      parts[filename]
+    end
+
+    # true if this part list has extracted this part from the document
+    def has?(filename)
+      parts.key?(filename)
+    end
+
+    private
+
+      def expand_type(content_type)
+        "xmlns:Types/xmlns:Override[@ContentType='application/vnd.openxmlformats-officedocument.wordprocessingml.#{content_type}+xml']"
+      end
+  end
+end

data/lib/docx_tools/version.rb

@@ -0,0 +1,4 @@
+module DocxTools
+
+  VERSION = '0.0.1'
+end

data/lib/docx_tools.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+require 'set'
+require 'zip'
+
+require 'docx_tools/document'
+require 'docx_tools/mail_merge'
+require 'docx_tools/part_list'
+require 'docx_tools/version'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: docx_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-25 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.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.7
+  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.7
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: An API for managing merge fields within docx files
+email:
+- info@trialnetworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- docx_tools.gemspec
+- lib/docx_tools.rb
+- lib/docx_tools/document.rb
+- lib/docx_tools/mail_merge.rb
+- lib/docx_tools/part_list.rb
+- lib/docx_tools/version.rb
+homepage: https://github.com/drugdev/docx_tools
+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.5
+signing_key: 
+specification_version: 4
+summary: Tools for manipulating docx files
+test_files: []
+has_rdoc: