open_xml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d5a61d483d830ba65ff655b1109cfd6c6658df0
+  data.tar.gz: f912f15f3ae8988ebd3630fe1eca1b7d42cc2468
+SHA512:
+  metadata.gz: e458a1b9edab91f74a06d5998cc65578453981bcc6dc89a07bfe6e2d5782311a30416f75c2bfe2c961cd070ffd224bc0c8eb350c5e2fd445f40bd3cac9cf3df7
+  data.tar.gz: 1526980394d5a3adf23e9c372a3f4948d21ca9386cc70e47f7a09d91c165f591176f4a26d2eef27cd1eda675e670c393179c443fbd52a022653d3699afa5153f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Carlos Espejo
+
+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,48 @@
+OpenXml
+========
+
+Library for reading and writing to open xml documents (*but at the moment you can generate word docs from a template*)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_xml'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_xml
+
+   
+## Usage
+Provide a path to a docx with the word [SUPERPOWER] placed anywhere.
+
+```ruby
+require 'open_xml'
+
+doc = OpenXml::TemplateDocument.new(path: "[path to template]", data: {"[SUPERPOWER]" => "Bug Fixing!!!!"})
+doc.process
+  
+IO.write "./powers.docx", doc.to_zip_buffer.string
+```
+
+## Todo
+  * ~~Implement reading and writing the word zip files~~
+  * ~~Create a template word document with formatted key words (bold, 14pt).~~
+  * ~~Replace the key words with the supplied plain text content but maintain all the formatting.~~
+  * ~~Handle replacing a key with multiple content~~
+  * Extract these features into a gem
+  * Format html content for wordprocessingML e.x. bold, italic,
+    underline
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/lib/open_xml/template_document.rb

@@ -0,0 +1,50 @@
+require 'zip'
+require 'nokogiri'
+
+module OpenXml
+
+
+  class TemplateDocument
+    attr_reader :template_path, :parts, :data
+
+    def initialize(options)
+      @template_path = options[:path]
+      @parts = {}
+      @data = options[:data]
+      split_parts
+    end
+
+    def to_zip_buffer
+      Zip::OutputStream.write_buffer do |w|
+        parts.each do |k, v|
+          w.put_next_entry k
+          w.write v
+        end
+      end
+    end
+
+    def process
+      doc = Nokogiri::XML(parts["word/document.xml"])
+      doc.xpath("//w:t").each do |node|
+        data.each do |k, v|
+          node.content = node.content.gsub(k, Array(v).join("\n")) if node.content[/#{k}/]
+        end
+      end
+
+      parts["word/document.xml"] = doc.to_xml
+    end
+
+    private
+
+    def split_parts
+      Zip::File.new(template_path).each do |f|
+        parts[f.name] = f.get_input_stream.read
+      end
+
+      parts
+    end
+
+
+  end
+
+end

data/lib/open_xml/version.rb

@@ -0,0 +1,3 @@
+module OpenXml
+  VERSION = "0.0.1"
+end

data/lib/open_xml.rb

@@ -0,0 +1,2 @@
+require 'open_xml/version'
+require_relative 'open_xml/template_document'

data/open_xml.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_xml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_xml"
+  spec.version       = OpenXml::VERSION
+  spec.authors       = ["Carlos Espejo"]
+  spec.email         = ["carlosespejo@gmail.com"]
+  spec.description   = %q{Currently you can only generate word documents from a template word document.}
+  spec.summary       = %q{Library for reading and writing to open xml documents (*but at the moment you can generate word docs from a template*)}
+  spec.homepage      = "https://github.com/CarlosEspejo/open_xml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubyzip"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'open_xml'
+require 'pry'
+
+include OpenXml

data/spec/template_document_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'tempfile'
+require 'nokogiri'
+
+describe TemplateDocument do
+
+  it "should read the template file and split it into parts" do
+    t = TemplateDocument.new(path: template_path)
+    t.parts.keys.must_equal template_parts.keys
+
+  end
+
+  it "should create a new file from the template parts" do
+    t = Tempfile.new(['output','.docx'])
+
+    temp_doc = TemplateDocument.new(path: template_path)
+
+    IO.write t.path, temp_doc.to_zip_buffer.string
+
+    Zip::File.new(t.path).each do |f|
+      temp_doc.parts[f.name].must_equal f.get_input_stream.read
+    end
+
+  end
+
+  it "should replace key words in the document xml" do
+    temp = Tempfile.new(['output','.docx'])
+
+    t = TemplateDocument.new(path: template_path, data: {"[NAME]" => "<b>Carlos</b>", "[AGE]" => 30 })
+    t.process
+    IO.write temp.path, t.to_zip_buffer.string
+
+    processed = TemplateDocument.new(path: temp.path)
+    doc = Nokogiri::XML(processed.parts["word/document.xml"])
+
+    doc.xpath('//w:t').text[/\[NAME\]/].must_be_nil
+    doc.xpath('//w:t').text[/\[AGE\]/].must_be_nil
+  end
+
+  it "should replace one key word with many items" do
+    data = {
+      "[LIST]" => [
+                    "list 1",
+                    "list 2",
+                    "list 3",
+                    "list 4",
+                    "list 5"
+                  ]
+    }
+
+    t = TemplateDocument.new(path: template_path, data: data)
+    t.process
+    doc = Nokogiri::XML(t.parts["word/document.xml"])
+
+    text = doc.xpath('//w:t').text
+
+    text[/list 1\nlist 2/].wont_be_nil
+  end
+
+  let(:template_path){"#{File.expand_path('samples', File.dirname(__FILE__))}/template_sample.docx"}
+
+  let(:template_parts) do
+    {
+      "_rels/.rels" => '',
+      "docProps/core.xml" => '',
+      "docProps/app.xml" => '',
+      "word/document.xml" => '',
+      "word/styles.xml" => '',
+      "word/fontTable.xml" => '',
+      "word/header.xml" => '',
+      "word/footer.xml" => '',
+      "word/settings.xml" => '',
+      "word/_rels/document.xml.rels" => '',
+      "[Content_Types].xml" => ''
+    }
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: open_xml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carlos Espejo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Currently you can only generate word documents from a template word document.
+email:
+- carlosespejo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/open_xml.rb
+- lib/open_xml/template_document.rb
+- lib/open_xml/version.rb
+- open_xml.gemspec
+- spec/samples/template_sample.docx
+- spec/spec_helper.rb
+- spec/template_document_spec.rb
+homepage: https://github.com/CarlosEspejo/open_xml
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Library for reading and writing to open xml documents (*but at the moment
+  you can generate word docs from a template*)
+test_files:
+- spec/samples/template_sample.docx
+- spec/spec_helper.rb
+- spec/template_document_spec.rb