docstache 0.0.1

data/spec/integration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'template_processor_spec'
+
+describe 'integration test', integration: true do
+  let(:data) { Docstache::TestData::DATA }
+  let(:base_path) { SPEC_BASE_PATH.join('example_input') }
+  let(:input_file) { "#{base_path}/ExampleTemplate.docx" }
+  let(:output_dir) { "#{base_path}/tmp" }
+  let(:output_file) { "#{output_dir}/IntegrationTestOutput.docx" }
+  before do
+    FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
+    Dir.mkdir(output_dir)
+  end
+
+  context 'should process in incoming docx' do
+    it 'generates a valid zip file (.docx)' do
+      Docstache::Render.new(input_file, data).generate_docx_file(output_file)
+
+      archive = Zip::File.open(output_file)
+      archive.close
+
+      puts "\n************************************"
+      puts '   >>> Only will work on mac <<<'
+      puts 'NOW attempting to open created file in Word.'
+      cmd = "open #{output_file}"
+      puts "  will run '#{cmd}'"
+      puts '************************************'
+
+      system cmd
+    end
+
+    it 'generates a file with the same contents as the input docx' do
+      input_entries = Zip::File.open(input_file) { |z| z.map(&:name) }
+      DocxTemplater::DocxCreator.new(input_file, data).generate_docx_file(output_file)
+      output_entries = Zip::File.open(output_file) { |z| z.map(&:name) }
+
+      expect(input_entries).to eq(output_entries)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'fileutils'
+require 'docstache'
+
+SPEC_BASE_PATH = Pathname.new(File.expand_path(File.dirname(__FILE__)))
+
+RSpec.configure do |config|
+  [:expect_with, :mock_with].each do |method|
+    config.send(method, :rspec) do |c|
+      c.syntax = :expect
+    end
+  end
+end

data/spec/template_processor_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+require 'nokogiri'
+
+module Docstache
+  module TestData
+    DATA = {
+      teacher: 'Priya Vora',
+      building: 'Building #14',
+      classroom: 'Rm 202'.to_sym,
+      district: 'Washington County Public Schools',
+      senority: 12.25,
+      roster: [
+        { name: 'Sally', age: 12, attendence: '100%' },
+        { name: :Xiao, age: 10, attendence: '94%' },
+        { name: 'Bryan', age: 13, attendence: '100%' },
+        { name: 'Larry', age: 11, attendence: '90%' },
+        { name: 'Kumar', age: 12, attendence: '76%' },
+        { name: 'Amber', age: 11, attendence: '100%' },
+        { name: 'Isaiah', age: 12, attendence: '89%' },
+        { name: 'Omar', age: 12, attendence: '99%' },
+        { name: 'Xi', age: 11, attendence: '20%' },
+        { name: 'Noushin', age: 12, attendence: '100%' }
+      ],
+      event_reports: [
+        { name: 'Science Museum Field Trip', notes: 'PTA sponsored event. Spoke to Astronaut with HAM radio.' },
+        { name: 'Wilderness Center Retreat', notes: '2 days hiking for charity:water fundraiser, $10,200 raised.' }
+      ],
+      created_at: '11-12-03 02:01'
+    }
+  end
+end
+
+describe Docstache::Render do
+  let(:data) { Marshal.load(Marshal.dump(DocxTemplater::TestData::DATA)) } # deep copy
+  let(:base_path) { SPEC_BASE_PATH.join('example_input') }
+  let(:xml) { File.read("#{base_path}/word/document.xml") }
+  let(:parser) { DocxTemplater::TemplateProcessor.new(data) }
+
+  context 'valid xml' do
+    it 'should render and still be valid XML' do
+      expect(Nokogiri::XML.parse(xml)).to be_xml
+      out = parser.render(xml)
+      expect(Nokogiri::XML.parse(out)).to be_xml
+    end
+
+    it 'should accept non-ascii characters' do
+      data[:teacher] = '老师'
+      out = parser.render(xml)
+      expect(out).to include('老师')
+      expect(Nokogiri::XML.parse(out)).to be_xml
+    end
+
+    it 'should escape as necessary invalid xml characters, if told to' do
+      data[:building] = '23rd & A #1 floor'
+      data[:classroom] = '--> 201 <!--'
+      data[:roster][0][:name] = '<#Ai & Bo>'
+      out = parser.render(xml)
+
+      expect(Nokogiri::XML.parse(out)).to be_xml
+      expect(out).to include('23rd &amp; A #1 floor')
+      expect(out).to include('--&gt; 201 &lt;!--')
+      expect(out).to include('&lt;#Ai &amp; Bo&gt;')
+    end
+
+    context 'not escape xml' do
+      let(:parser) { DocxTemplater::TemplateProcessor.new(data, false) }
+      it 'does not escape the xml attributes' do
+        data[:building] = '23rd <p>&amp;</p> #1 floor'
+        out = parser.render(xml)
+        expect(Nokogiri::XML.parse(out)).to be_xml
+        expect(out).to include('23rd <p>&amp;</p> #1 floor')
+      end
+    end
+  end
+
+  context 'unmatched begin and end row templates' do
+    it 'should not raise' do
+      xml = <<EOF
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:body>
+    <w:tbl>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#BEGIN_ROW:#{:roster.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#END_ROW:#{:roster.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#BEGIN_ROW:#{:event_reports.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#END_ROW:#{:event_reports.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+    </w:tbl>
+  </w:body>
+</xml>
+EOF
+      expect { parser.render(xml) }.to_not raise_error
+    end
+
+    it 'should raise an exception' do
+      xml = <<EOF
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:body>
+    <w:tbl>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#BEGIN_ROW:#{:roster.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#END_ROW:#{:roster.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+      <w:tr><w:tc>
+          <w:p>
+            <w:r><w:t>#BEGIN_ROW:#{:event_reports.to_s.upcase}#</w:t></w:r>
+          </w:p>
+      </w:tc></w:tr>
+    </w:tbl>
+  </w:body>
+</xml>
+EOF
+      expect { parser.render(xml) }.to raise_error(/#END_ROW:EVENT_REPORTS# nil: true/)
+    end
+  end
+
+  it 'should enter no text for a nil value' do
+    xml = <<EOF
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+<w:body>
+  <w:p>Before.$KEY$After</w:p>
+</w:body>
+</xml>
+EOF
+    actual = DocxTemplater::TemplateProcessor.new(key: nil).render(xml)
+    expected_xml = <<EOF
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+<w:body>
+  <w:p>Before.After</w:p>
+</w:body>
+</xml>
+EOF
+    expect(actual).to eq(expected_xml)
+  end
+
+  it 'should replace all simple keys with values' do
+    non_array_keys = data.reject { |_, v| v.is_a?(Array) }
+    non_array_keys.keys.each do |key|
+      expect(xml).to include("$#{key.to_s.upcase}$")
+      expect(xml).not_to include(data[key].to_s)
+    end
+    out = parser.render(xml)
+
+    non_array_keys.each do |key|
+      expect(out).not_to include("$#{key}$")
+      expect(out).to include(data[key].to_s)
+    end
+  end
+
+  it 'should replace all array keys with values' do
+    expect(xml).to include('#BEGIN_ROW:')
+    expect(xml).to include('#END_ROW:')
+    expect(xml).to include('$EACH:')
+
+    out = parser.render(xml)
+
+    expect(out).not_to include('#BEGIN_ROW:')
+    expect(out).not_to include('#END_ROW:')
+    expect(out).not_to include('$EACH:')
+
+    [:roster, :event_reports].each do |key|
+      data[key].each do |row|
+        row.values.map(&:to_s).each do |row_value|
+          expect(out).to include(row_value)
+        end
+      end
+    end
+  end
+
+  it 'shold render students names in the same order as the data' do
+    out = parser.render(xml)
+    expect(out).to include('Sally')
+    expect(out).to include('Kumar')
+    expect(out.index('Kumar')).to be > out.index('Sally')
+  end
+
+  it 'shold render event reports names in the same order as the data' do
+    out = parser.render(xml)
+    expect(out).to include('Science Museum Field Trip')
+    expect(out).to include('Wilderness Center Retreat')
+    expect(out.index('Wilderness Center Retreat')).to be > out.index('Science Museum Field Trip')
+  end
+
+  it 'should render 2-line event reports in same order as docx' do
+    event_reports_starting_at = xml.index('#BEGIN_ROW:EVENT_REPORTS#')
+    expect(event_reports_starting_at).to be >= 0
+    expect(xml.index('$EACH:NAME$', event_reports_starting_at)).to be > event_reports_starting_at
+    expect(xml.index('$EACH:NOTES$', event_reports_starting_at)).to be > event_reports_starting_at
+    expect(xml.index('$EACH:NOTES$', event_reports_starting_at)).to be > xml.index('$EACH:NAME$', event_reports_starting_at)
+
+    out = parser.render(xml)
+    expect(out.index('PTA sponsored event. Spoke to Astronaut with HAM radio.')).to be > out.index('Science Museum Field Trip')
+  end
+
+  it 'should render sums of input data' do
+    expect(xml).to include('#SUM')
+    out = parser.render(xml)
+    expect(out).not_to include('#SUM')
+    expect(out).to include("#{data[:roster].count} Students")
+    expect(out).to include("#{data[:event_reports].count} Events")
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: docstache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Cosgrove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Integrates data into MS Word docx template files. Processing supports
+  loops and replacement of strings of data both outside and within loops.
+email:
+- will@willcosgrove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- docstache.gemspec
+- lib/docstache.rb
+- lib/docstache/document.rb
+- lib/docstache/renderer.rb
+- lib/docstache/version.rb
+- spec/example_input/ExampleTemplate.docx
+- spec/example_input/word/document.xml
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/template_processor_spec.rb
+homepage: https://github.com/willcosgrove/docstache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Merges Hash of Data into Word docx template files using mustache syntax
+test_files:
+- spec/example_input/ExampleTemplate.docx
+- spec/example_input/word/document.xml
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/template_processor_spec.rb
+has_rdoc: