sheng 0.3.2

data/lib/sheng/wml_file.rb

@@ -0,0 +1,47 @@
+module Sheng
+  class WMLFile
+    class InvalidWML < StandardError; end
+    class MergefieldNotReplacedError < StandardError
+      def initialize(unmerged_fields)
+        unmerged_keys = unmerged_fields.map(&:raw_key)
+        super("Mergefields not replaced: #{unmerged_keys.join(', ')}")
+      end
+    end
+
+    attr_reader :xml, :filename
+
+    def initialize(filename, xml)
+      @filename = filename
+      @xml = Nokogiri::XML(xml)
+    end
+
+    def interpolate(data_set)
+      parent_set.interpolate(data_set)
+      check_for_full_interpolation!
+      parent_set.xml_fragment.to_s
+    end
+
+    def check_for_full_interpolation!
+      modified_parent_set = MergeFieldSet.new('main', xml)
+      unmerged_fields = modified_parent_set.basic_nodes.reject { |node|
+        node.is_a?(CheckBox)
+      }
+
+      unless unmerged_fields.empty?
+        raise MergefieldNotReplacedError.new(unmerged_fields)
+      end
+    end
+
+    def parent_set
+      @parent_set ||= MergeFieldSet.new('main', xml)
+    end
+
+    def required_hash
+      parent_set.required_hash
+    end
+
+    def to_tree
+      parent_set.to_tree
+    end
+  end
+end

data/lib/sheng.rb

@@ -0,0 +1,21 @@
+
+require 'active_support/inflector'
+require 'active_support/core_ext/hash'
+require 'sheng/support'
+require 'sheng/version'
+require 'sheng/data_set'
+require 'sheng/docx'
+require 'sheng/wml_file'
+require 'sheng/merge_field_set'
+require 'sheng/merge_field'
+require 'sheng/sequence'
+require 'sheng/conditional_block'
+require 'sheng/check_box'
+
+require 'zip'
+require 'nokogiri'
+require 'fileutils'
+require 'json'
+
+module Sheng
+end

data/sheng.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sheng/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sheng"
+  spec.version       = Sheng::VERSION
+  spec.authors       = ["Ravi Gadad", "Maher Hawash"]
+  spec.email         = ["ravi@renewfund.com"]
+  spec.description   = "A Ruby gem for data merging Word documents."
+  spec.summary       = "A Ruby gem for data merging Word documents, using native MergeFields as placeholders in templates, and a Ruby hash as the data set for substitution."
+  spec.homepage      = ""
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "equivalent-xml", ">= 0.6"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "rubyzip", "~> 1.1.1"
+  spec.add_dependency "activesupport", "~> 4.2"
+end

data/spec/fixtures/inputs/complete.json

@@ -0,0 +1,61 @@
+{
+  "account_identifier": "XYZ-0999223c",
+  "first_name": "Bobby",
+  "last_name": "McGee",
+  "a_long_paragraph": "Pede erat feugiat ante, auctor facilisis dui augue non turpis. Suspendisse mattis metus et justo. Aliquam erat volutpat.  Suspendisse potenti. Nam hendrerit lorem commodo metus laoreet ullamcorper.  Proin vel nunc a felis sollicitudin pretium. Maecenas in metus at mi mollis posuere. Quisque ac quam sed massa adipiscing rutrum. Vestibulum ipsum.  Phasellus porta sapien. Maecenas venenatis tellus vel tellus.\n\n Aliquam aliquam dolor at justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Morbi pretium purus a magna. Nullam dui tellus, blandit eu, facilisis non, pharetra consectetuer, leo. Maecenas sit amet ante sagittis magna imperdiet pulvinar. Vestibulum a lacus at.",
+  "check_me": "true",
+  "leave_me_unchecked": "false",
+  "embedded": {
+    "first_level": "shallow",
+    "two_levels": {
+      "second_level": "deep"
+    }
+  },
+  "meals": [
+    {
+      "meal": "sHrImP",
+      "drink": "tea",
+      "dessert": "kanafa",
+      "appetizer": "lettuce"
+    },
+    {
+      "meal": "fish",
+      "drink": "coffee",
+      "dessert": "baklava",
+      "appetizer": "cheese cakes are really yummy"
+    }
+  ],
+  "owners": [
+    {
+      "first_name": "Bob",
+      "last_name": "Jones"
+    },
+    {
+      "first_name": "Sally",
+      "last_name": "Fields"
+    }
+  ],
+  "frogs": [
+    {
+      "first_name": "Bill",
+      "last_name": "Jones"
+    },
+    {
+      "first_name": "Sam",
+      "last_name": "Fields"
+    }
+  ],
+  "animals": [
+    { "color": "blue"}
+  ],
+  "birds": [
+    { "wingspan": "amazing"}
+  ],
+  "exceptions": [],
+  "grocery_list": [
+    { "quantity": 4, "product": "bananas" },
+    { "quantity": "3 cups", "product": "sugar" }
+  ],
+  "invitees": ["Brad", "Ulisha", "Marcionette"],
+  "potluck_dishes": ["Salad", "Croutons", "Dressing", "Radishes"]
+}

data/spec/fixtures/inputs/incomplete.json

@@ -0,0 +1,52 @@
+{
+  "account_identifier": "XYZ-0999223c",
+  "a_long_paragraph": "Pede erat feugiat ante, auctor facilisis dui augue non turpis. Suspendisse mattis metus et justo. Aliquam erat volutpat.  Suspendisse potenti. Nam hendrerit lorem commodo metus laoreet ullamcorper.  Proin vel nunc a felis sollicitudin pretium. Maecenas in metus at mi mollis posuere. Quisque ac quam sed massa adipiscing rutrum. Vestibulum ipsum.  Phasellus porta sapien. Maecenas venenatis tellus vel tellus.\n\n Aliquam aliquam dolor at justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Morbi pretium purus a magna. Nullam dui tellus, blandit eu, facilisis non, pharetra consectetuer, leo. Maecenas sit amet ante sagittis magna imperdiet pulvinar. Vestibulum a lacus at.",
+  "check_me": "true",
+  "leave_me_unchecked": "false",
+  "embedded": {
+    "first_level": "shallow",
+    "two_levels": {
+      "second_level": "deep"
+    }
+  },
+  "meals": [
+    {
+      "meal": "sHrImP",
+      "drink": "tea",
+      "dessert": "kanafa",
+      "appetizer": "lettuce"
+    },
+    {
+      "meal": "fish",
+      "drink": "coffee",
+      "dessert": "baklava",
+      "appetizer": "cheese cakes are really yummy"
+    }
+  ],
+  "owners": [
+    {
+      "first_name": "Bob",
+      "last_name": "Jones"
+    },
+    {
+      "first_name": "Sally",
+      "last_name": "Fields"
+    }
+  ],
+  "frogs": [
+    {
+      "first_name": "Bill",
+      "last_name": "Jones"
+    },
+    {
+      "first_name": "Sam",
+      "last_name": "Fields"
+    }
+  ],
+  "grocery_list": [
+    { "quantity": 4, "product": "bananas" },
+    { "quantity": "3 cups", "product": "sugar" }
+  ],
+  "invitees": ["Brad", "Ulisha", "Marcionette"],
+  "potluck_dishes": ["Salad", "Croutons", "Dressing", "Radishes"]
+}

data/spec/fixtures/trees/embedded_sequence.yml

@@ -0,0 +1,13 @@
+---
+- :type: sequence
+  :key: start:library.books
+  :nodes:
+  - :type: merge_field
+    :key: title
+  - :type: sequence
+    :key: start:pages
+    :nodes:
+    - :type: merge_field
+      :key: size
+  - :type: merge_field
+    :key: scent

data/spec/fixtures/trees/merge_field_set.yml

@@ -0,0 +1,16 @@
+---
+- :type: merge_field
+  :key: person.first_name
+- :type: merge_field
+  :key: person.last_name | upcase
+- :type: sequence
+  :key: start:person.socks
+  :nodes:
+  - :type: merge_field
+    :key: color
+  - :type: merge_field
+    :key: size
+- :type: check_box
+  :key: veggies.green.spinach
+- :type: merge_field
+  :key: person.first_name

data/spec/fixtures/xml_fragments/input/check_box/check_box.xml

@@ -0,0 +1,11 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:ffData>
+    <w:name w:val="goats"/>
+    <w:enabled/>
+    <w:calcOnExit w:val="0"/>
+    <w:checkBox>
+      <w:sizeAuto/>
+      <w:default w:val="0"/>
+    </w:checkBox>
+  </w:ffData>
+</w:document>

data/spec/fixtures/xml_fragments/input/conditional_block/bad/badly_nested_conditional.xml

@@ -0,0 +1,105 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:r>
+    <w:t>What we gots?</w:t>
+  </w:r>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  unless:pumpkins \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«unless:pumpkins»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  end_if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«end_if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  end_unless:pumpkins \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«end_unless:pumpkins»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/input/conditional_block/bad/unclosed_conditional.xml

@@ -0,0 +1,35 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:r>
+    <w:rPr>
+      <w:b/>
+      <w:i/>
+      <w:noProof/>
+    </w:rPr>
+    <w:t xml:space="preserve">Oh phew, alicorns. They are </w:t>
+  </w:r>
+</w:document>

data/spec/fixtures/xml_fragments/input/conditional_block/conditional_block_if.xml

@@ -0,0 +1,84 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:r>
+    <w:t>What we gots?</w:t>
+  </w:r>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:r>
+    <w:rPr>
+      <w:b/>
+      <w:i/>
+      <w:noProof/>
+    </w:rPr>
+    <w:t xml:space="preserve">Oh phew, alicorns. They are </w:t>
+  </w:r>
+  <w:r>
+    <w:fldChar w:fldCharType="begin"/>
+  </w:r>
+  <w:r>
+    <w:instrText xml:space="preserve">MERGEFIELD alicorns \* MERGEFORMAT </w:instrText>
+  </w:r>
+  <w:r>
+    <w:fldChar w:fldCharType="separate"/>
+  </w:r>
+  <w:r>
+    <w:rPr>
+      <w:noProof/>
+    </w:rPr>
+    <w:t>«alicorns»</w:t>
+  </w:r>
+  <w:r w:rsidR="00FD21FA">
+    <w:rPr>
+      <w:noProof/>
+    </w:rPr>
+    <w:fldChar w:fldCharType="end"/>
+  </w:r>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  end_if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«end_if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/input/conditional_block/conditional_block_inline.xml

@@ -0,0 +1,59 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:p>
+    <w:r>
+      <w:t xml:space="preserve">Let me tell you a story. </w:t>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+    <w:r>
+      <w:t xml:space="preserve">It will have alicorns in it. </w:t>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  end_if:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:b/>
+        <w:i/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«end_if:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+    <w:r>
+      <w:t>Isn't that exciting?</w:t>
+    </w:r>
+  </w:p>
+</w:document>

data/spec/fixtures/xml_fragments/input/conditional_block/conditional_block_unless.xml

@@ -0,0 +1,51 @@
+<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:r>
+    <w:t>What we don't gots?</w:t>
+  </w:r>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  unless:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:t>«unless:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+  <w:r>
+    <w:rPr>
+      <w:i/>
+    </w:rPr>
+    <w:t>No alicorns? SADFACES</w:t>
+  </w:r>
+  <w:p>
+    <w:r>
+      <w:fldChar w:fldCharType="begin"/>
+    </w:r>
+    <w:r>
+      <w:instrText xml:space="preserve">MERGEFIELD  end_unless:alicorns \* MERGEFORMAT </w:instrText>
+    </w:r>
+    <w:r>
+      <w:fldChar w:fldCharType="separate"/>
+    </w:r>
+    <w:r>
+      <w:t>«end_unless:alicorns»</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:fldChar w:fldCharType="end"/>
+    </w:r>
+  </w:p>
+</w:document>