sablon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 975fe24c74bf896987909e597c4600087b4aee50
-  data.tar.gz: c884b29cb782ed4e30125e3020e80f52af34a92e
+  metadata.gz: 1f2bdc7b8b84da3ad1a1893b515d23530fa6f597
+  data.tar.gz: c872738213cbc5ebd926a9287512c40393a27fe2
 SHA512:
-  metadata.gz: aec7e1fa1c03628473f4ea9122ea44c64dedf6041d62a891e21267f12456cca58751cb43be982b588937bd8051ed4358e56ab97cebff85127f19f089a28e058a
-  data.tar.gz: 024a467e6a943623413deb38b2e2422a234b53d24ba1b7985778ba6d38ae66443af6df6c52321ec5ae5312c8eb195023701def63f40d7e027fa0dcb90f5dbf5f
+  metadata.gz: b12594e4647d2787ed4b8a2020ac44f668d2834f53cf8a16df4ff384fe52587386b8af8004cfdcb2c0da89d7c64481fb33363d1a59b43235cbb19f2b65f3bfa1
+  data.tar.gz: 5a4ea402a07886f1009d24917ec850f7adef2d248511e2d5e93272794d0d49ff632af0554a2cd4cfcd1ddda7535db6f081e117d00b9d333f7e859b0abcaa5076

data/README.md

@@ -2,8 +2,9 @@
 
 [![Build Status](https://travis-ci.org/senny/sablon.svg?branch=master)](https://travis-ci.org/senny/sablon)
 
-Is a document template processor based on `docx`. Tags are represented using
-MailMerge fields.
+Is a document template processor for Word `docx` files. It leverages Word's
+built-in formatting and layouting capabilities to make it easy to create your
+templates.
 
 ## Installation
 
@@ -33,7 +34,7 @@ Sablon templates are normal word documents (`.docx`) sprinkled with MergeFields
 to perform operations. The following section will use the notation `«=title»` to
 refer to [Word MailMerge](http://en.wikipedia.org/wiki/Mail_merge) fields.
 
-#### Inserting content
+#### Content Insertion
 
 The most basic operation is to insert content. The contents of a context
 variable can be inserted using a field like:
@@ -61,8 +62,16 @@ context variable. Conditional fields are inserted around the content.
 ```
 
 This will render the enclosed markup only if the expression is truthy.
-Note that `nil`, `false` and `[]` are considered falsy. Everything else is truthy.
+Note that `nil`, `false` and `[]` are considered falsy. Everything else is
+truthy.
 
+For more complex conditionals you can use a predicate like so:
+
+```
+«body:if(present?)»
+    ... arbitrary document markup ...
+«body:endIf»
+```
 
 #### Loops
 
@@ -88,9 +97,24 @@ It is possible to nest loops and conditionals.
 
 ### Examples
 
-[This test](test/sablon_test.rb) is a good example of what Sablon can do for
-you. Make sure to look at the [template](test/fixtures/sablon_template.docx) and
-the corresponding [output](test/fixtures/sablon_sample.docx).
+There is a [sample template](test/fixtures/sablon_template.docx) in the
+repository, which illustrates the functionality of sablon:
+
+<p align="center">
+  <img
+  src="https://raw.githubusercontent.com/senny/sablon/master/misc/template.png"
+  alt="Sablon Template"/>
+</p>
+
+Processing this template with some sample data yields the following
+[output document](test/fixtures/sablon_sample.docx).
+For more details, check out this [test case](test/sablon_test.rb).
+
+<p align="center">
+  <img
+  src="https://raw.githubusercontent.com/senny/sablon/master/misc/output.png"
+  alt="Sablon Output"/>
+</p>
 
 
 ## Contributing
@@ -101,6 +125,7 @@ the corresponding [output](test/fixtures/sablon_sample.docx).
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+
 ## Inspiration
 
 The following projects address a similar goal and inspired the work on Sablon:

data/lib/sablon/operations.rb

@@ -16,9 +16,10 @@ module Sablon
       end
     end
 
-    class Condition < Struct.new(:conditon_expr, :block)
+    class Condition < Struct.new(:conditon_expr, :block, :predicate)
       def evaluate(context)
-        if truthy?(conditon_expr.evaluate(context))
+        value = conditon_expr.evaluate(context)
+        if truthy?(predicate ? value.public_send(predicate) : value)
           block.replace(block.process(context).reverse)
         else
           block.replace([])

data/lib/sablon/parser/mail_merge.rb

@@ -10,7 +10,7 @@ module Sablon
         private
         def replace_field_display(node, text)
           display_node = node.search(".//w:t").first
-          text.scan(/[^\n]+|\n/).reverse.each do |part|
+          text.to_s.scan(/[^\n]+|\n/).reverse.each do |part|
             if part == "\n"
               display_node.add_next_sibling Nokogiri::XML::Node.new "w:br", display_node.document
             else
@@ -67,20 +67,26 @@ module Sablon
       def parse_fields(xml)
         fields = []
         xml.traverse do |node|
-          if node.name == "fldSimple" && node.namespace && node.namespace.prefix == "w"
-            fields << SimpleField.new(node)
-          elsif node.name == "fldChar" && node.namespace && node.namespace.prefix == "w" && node["w:fldCharType"] == "begin"
-            possible_field_node = node.parent
-            field_nodes = [possible_field_node]
-            while possible_field_node && possible_field_node.search(".//w:fldChar[@w:fldCharType='end']").empty?
-              possible_field_node = possible_field_node.next_element
-              field_nodes << possible_field_node
-            end
-            fields << ComplexField.new(field_nodes)
+          if node.name == "fldSimple"
+            field = SimpleField.new(node)
+          elsif node.name == "fldChar" && node["w:fldCharType"] == "begin"
+            field = build_complex_field(node)
           end
+          fields << field if field && field.expression
         end
         fields
       end
+
+      private
+      def build_complex_field(node)
+        possible_field_node = node.parent
+        field_nodes = [possible_field_node]
+        while possible_field_node && possible_field_node.search(".//w:fldChar[@w:fldCharType='end']").empty?
+          possible_field_node = possible_field_node.next_element
+          field_nodes << possible_field_node
+        end
+        ComplexField.new(field_nodes)
+      end
     end
   end
 end

data/lib/sablon/processor.rb

@@ -38,16 +38,15 @@ module Sablon
     class Block < Struct.new(:start_field, :end_field)
       def self.enclosed_by(start_field, end_field)
         @blocks ||= [RowBlock, ParagraphBlock]
-        block_class = @blocks.detect { |klass| klass.possible?(start_field) && klass.possible?(end_field) }
+        block_class = @blocks.detect { |klass| klass.encloses?(start_field, end_field) }
         block_class.new start_field, end_field
       end
 
       def process(context)
-        body.map do |template_node|
-          replaced_node = template_node.dup
-          Processor.process replaced_node, context
-          replaced_node
-        end
+        replaced_node = Nokogiri::XML::Node.new("tmp", start_node.document)
+        replaced_node.children = Nokogiri::XML::NodeSet.new(start_node.document, body.map(&:dup))
+        Processor.process replaced_node, context
+        replaced_node.children
       end
 
       def replace(content)
@@ -76,8 +75,8 @@ module Sablon
         @end_node ||= self.class.parent(end_field).first
       end
 
-      def self.possible?(node)
-        parent(node).any?
+      def self.encloses?(start_field, end_field)
+        parent(start_field).any? && parent(end_field).any?
       end
     end
 
@@ -85,6 +84,12 @@ module Sablon
       def self.parent(node)
         node.ancestors ".//w:tr"
       end
+
+      def self.encloses?(start_field, end_field)
+        if super
+          parent(start_field) != parent(end_field)
+        end
+      end
     end
 
     class ParagraphBlock < Block
@@ -108,6 +113,7 @@ module Sablon
 
       def consume(allow_insertion)
         @field = @fields.shift
+        return unless @field
         case @field.expression
         when /^=/
           if allow_insertion
@@ -116,6 +122,9 @@ module Sablon
         when /([^ ]+):each\(([^ ]+)\)/
           block = consume_block("#{$1}:endEach")
           Statement::Loop.new(Expression.parse($1), $2, block)
+        when /([^ ]+):if\(([^)]+)\)/
+          block = consume_block("#{$1}:endIf")
+          Statement::Condition.new(Expression.parse($1), block, $2)
         when /([^ ]+):if/
           block = consume_block("#{$1}:endIf")
           Statement::Condition.new(Expression.parse($1), block)
@@ -125,10 +134,15 @@ module Sablon
       def consume_block(end_expression)
         start_field = end_field = @field
         while end_field && end_field.expression != end_expression
-          @operations << consume(false)
+          consume(false)
           end_field = @field
         end
-        Block.enclosed_by start_field, end_field
+
+        if end_field
+          Block.enclosed_by start_field, end_field
+        else
+          raise "no end field for #{start_field.expression}. Was looking for #{end_expression}"
+        end
       end
     end
   end

data/lib/sablon/template.rb

@@ -25,6 +25,8 @@ module Sablon
           content = entry.get_input_stream.read
           if entry_name == 'word/document.xml'
             out.write(Processor.process(Nokogiri::XML(content), context, properties).to_xml)
+          elsif entry_name =~ /word\/header\d*\.xml/ || entry_name =~ /word\/footer\d*\.xml/
+            out.write(Processor.process(Nokogiri::XML(content), context).to_xml)
           else
             out.write(content)
           end

data/lib/sablon/test.rb

@@ -0,0 +1 @@
+require "sablon/test/assertions"

data/lib/sablon/test/assertions.rb

@@ -0,0 +1,22 @@
+module Sablon
+  module Test
+    module Assertions
+      def assert_docx_equal(expected_path, actual_path)
+        if get_document_xml(expected_path) != get_document_xml(actual_path)
+          msg = <<-error
+The generated document does not match the sample. Please investigate.
+
+If the generated document is correct, the sample needs to be updated:
+\t cp #{actual_path} #{expected_path}
+      error
+          fail msg
+        end
+      end
+
+      def get_document_xml(path)
+        document_xml_entry = Zip::File.open(path).get_entry("word/document.xml")
+        document_xml_entry.get_input_stream.read
+      end
+    end
+  end
+end

data/lib/sablon/version.rb

@@ -1,3 +1,3 @@
 module Sablon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/sablon.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'rubyzip'
+  spec.add_runtime_dependency 'rubyzip', ">= 1.1"
 
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "rake", "~> 10.0"

data/test/mail_merge_parser_test.rb

@@ -10,13 +10,20 @@ module MailMergeParser
       @parser = Sablon::Parser::MailMerge.new
     end
 
+    def field
+      @field ||= fields.first
+    end
+
     def fields
-      @document = xml
-      @parser.parse_fields(@document)
+      @parser.parse_fields(document)
     end
 
     def body_xml
-      @document.search(".//w:body").children.map(&:to_xml).join.strip
+      document.search(".//w:body").children.map(&:to_xml).join.strip
+    end
+
+    def document
+      @document ||= xml
     end
   end
 
@@ -28,7 +35,6 @@ module MailMergeParser
     end
 
     def test_replace
-      field = fields.first
       field.replace("Hello")
       assert_equal <<-body_xml.strip, body_xml
 <w:r w:rsidR=\"004B49F0\">
@@ -39,7 +45,6 @@ body_xml
     end
 
     def test_replace_with_newlines
-      field = fields.first
       field.replace("First\nSecond\n\nThird")
 
       assert_equal <<-body_xml.strip, body_xml
@@ -50,6 +55,28 @@ body_xml
 body_xml
     end
 
+    def test_replace_with_nil
+      field.replace(nil)
+
+      assert_equal <<-body_xml.strip, body_xml.gsub(/^\s+$/,'')
+<w:r w:rsidR=\"004B49F0\">
+    <w:rPr><w:noProof/></w:rPr>
+
+  </w:r>
+body_xml
+    end
+
+    def test_replace_with_numeric
+      field.replace(45)
+
+      assert_equal <<-body_xml.strip, body_xml.gsub(/^\s+$/,'')
+<w:r w:rsidR=\"004B49F0\">
+    <w:rPr><w:noProof/></w:rPr>
+    <w:t>45</w:t>
+  </w:r>
+body_xml
+    end
+
     private
     def xml
       wrap(<<-xml)
@@ -71,7 +98,6 @@ body_xml
     end
 
     def test_replace
-      field = fields.first
       field.replace("Hello")
       assert_equal <<-body_xml.strip, body_xml
 <w:r w:rsidR="004B49F0">
@@ -85,7 +111,6 @@ body_xml
     end
 
     def test_replace_with_newlines
-      field = fields.first
       field.replace("First\nSecond\n\nThird")
 
       assert_equal <<-body_xml.strip, body_xml
@@ -99,6 +124,20 @@ body_xml
 body_xml
     end
 
+    def test_replace_with_nil
+      field.replace(nil)
+
+      assert_equal <<-body_xml.strip, body_xml.gsub(/^\s+$/,'')
+<w:r w:rsidR="004B49F0">
+  <w:rPr>
+    <w:b/>
+    <w:noProof/>
+  </w:rPr>
+
+</w:r>
+body_xml
+    end
+
     private
     def xml
       wrap(<<-xml)
@@ -128,4 +167,58 @@ body_xml
       xml
     end
   end
+
+  class NonSablonFieldTest < Sablon::TestCase
+    include SharedBehavior
+
+    def test_is_ignored
+      assert_equal [], fields.map(&:class)
+    end
+
+    private
+    def xml
+      wrap(<<-xml)
+  <w:p w14:paraId="0CF428D7" w14:textId="77777777" w:rsidR="00043618" w:rsidRDefault="00043618" w:rsidP="00B960C2">
+    <w:pPr>
+      <w:pStyle w:val="Footer" />
+      <w:framePr w:wrap="around" w:vAnchor="text" w:hAnchor="margin" w:xAlign="right" w:y="1" />
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+      </w:rPr>
+    </w:pPr>
+    <w:r>
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+      </w:rPr>
+      <w:fldChar w:fldCharType="begin" />
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+      </w:rPr>
+      <w:instrText xml:space="preserve">PAGE  </w:instrText>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+      </w:rPr>
+      <w:fldChar w:fldCharType="separate" />
+    </w:r>
+    <w:r w:rsidR="00326FC5">
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+        <w:noProof />
+      </w:rPr>
+      <w:t>1</w:t>
+    </w:r>
+    <w:r>
+      <w:rPr>
+        <w:rStyle w:val="PageNumber" />
+      </w:rPr>
+      <w:fldChar w:fldCharType="end" />
+    </w:r>
+  </w:p>
+      xml
+    end
+  end
 end

data/test/processor_test.rb

@@ -38,34 +38,23 @@ class ProcessorTest < Sablon::TestCase
     result = process(<<-documentxml, {"last_name" => "Zane"})
       <w:r><w:t xml:space="preserve">Hello! My Name is </w:t></w:r>
       <w:r w:rsidR="00BE47B1" w:rsidRPr="00BE47B1">
-        <w:rPr>
-          <w:b/>
-        </w:rPr>
+        <w:rPr><w:b/></w:rPr>
         <w:fldChar w:fldCharType="begin"/>
       </w:r>
       <w:r w:rsidR="00BE47B1" w:rsidRPr="00BE47B1">
-        <w:rPr>
-          <w:b/>
-        </w:rPr>
+        <w:rPr><w:b/></w:rPr>
         <w:instrText xml:space="preserve"> MERGEFIELD =last_name \\* MERGEFORMAT </w:instrText>
       </w:r>
       <w:r w:rsidR="00BE47B1" w:rsidRPr="00BE47B1">
-        <w:rPr>
-          <w:b/>
-        </w:rPr>
+        <w:rPr><w:b/></w:rPr>
         <w:fldChar w:fldCharType="separate"/>
       </w:r>
       <w:r w:rsidR="004B49F0">
-        <w:rPr>
-          <w:b/>
-          <w:noProof/>
-        </w:rPr>
+        <w:rPr><w:b/><w:noProof/></w:rPr>
         <w:t>«=last_name»</w:t>
       </w:r>
       <w:r w:rsidR="00BE47B1" w:rsidRPr="00BE47B1">
-        <w:rPr>
-          <w:b/>
-        </w:rPr>
+        <w:rPr><w:b/></w:rPr>
         <w:fldChar w:fldCharType="end"/>
       </w:r>
       <w:r w:rsidR="00BE47B1"><w:t xml:space="preserve">, nice to meet you.</w:t></w:r>
@@ -75,10 +64,7 @@ class ProcessorTest < Sablon::TestCase
     assert_xml_equal <<-document, result
       <w:r><w:t xml:space="preserve">Hello! My Name is </w:t></w:r>
       <w:r w:rsidR="004B49F0">
-        <w:rPr>
-          <w:b/>
-          <w:noProof/>
-        </w:rPr>
+        <w:rPr><w:b/><w:noProof/></w:rPr>
         <w:t>Zane</w:t>
       </w:r>
       <w:r w:rsidR="00BE47B1"><w:t xml:space="preserve">, nice to meet you.</w:t></w:r>
@@ -106,9 +92,7 @@ class ProcessorTest < Sablon::TestCase
         <w:fldChar w:fldCharType="separate" />
       </w:r>
       <w:r w:rsidR="00441382">
-        <w:rPr>
-          <w:noProof />
-        </w:rPr>
+        <w:rPr><w:noProof /></w:rPr>
         <w:t>«=person.first_name»</w:t>
       </w:r>
       <w:r w:rsidR="003C4780">
@@ -121,9 +105,7 @@ class ProcessorTest < Sablon::TestCase
     assert_xml_equal <<-document, result
       <w:r><w:t xml:space="preserve">Hello! My Name is </w:t></w:r>
       <w:r w:rsidR="00441382">
-        <w:rPr>
-          <w:noProof/>
-        </w:rPr>
+        <w:rPr><w:noProof/></w:rPr>
         <w:t>Daniel</w:t>
       </w:r>
       <w:r w:rsidR="00BE47B1"><w:t xml:space="preserve">, nice to meet you.</w:t></w:r>
@@ -131,7 +113,6 @@ class ProcessorTest < Sablon::TestCase
   end
 
   def test_paragraph_block_replacement
-    item = Struct.new(:index, :label, :rating)
     result = process(<<-document, {"technologies" => ["Ruby", "Rails"]})
       <w:p w14:paraId="6CB29D92" w14:textId="164B70F4" w:rsidR="007F5CDE" w:rsidRDefault="007F5CDE" w:rsidP="007F5CDE">
          <w:pPr>
@@ -143,9 +124,7 @@ class ProcessorTest < Sablon::TestCase
          </w:pPr>
          <w:fldSimple w:instr=" MERGEFIELD technologies:each(technology) \\* MERGEFORMAT ">
             <w:r>
-               <w:rPr>
-                  <w:noProof />
-               </w:rPr>
+               <w:rPr><w:noProof /></w:rPr>
                <w:t>«technologies:each(technology)»</w:t>
             </w:r>
          </w:fldSimple>
@@ -174,9 +153,7 @@ class ProcessorTest < Sablon::TestCase
             <w:fldChar w:fldCharType="separate" />
          </w:r>
          <w:r w:rsidR="009F01DA">
-            <w:rPr>
-               <w:noProof />
-            </w:rPr>
+            <w:rPr><w:noProof /></w:rPr>
             <w:t>«=technology»</w:t>
          </w:r>
          <w:r>
@@ -193,9 +170,7 @@ class ProcessorTest < Sablon::TestCase
          </w:pPr>
          <w:fldSimple w:instr=" MERGEFIELD technologies:endEach \\* MERGEFORMAT ">
             <w:r>
-               <w:rPr>
-                  <w:noProof />
-               </w:rPr>
+               <w:rPr><w:noProof /></w:rPr>
                <w:t>«technologies:endEach»</w:t>
             </w:r>
          </w:fldSimple>
@@ -213,9 +188,7 @@ class ProcessorTest < Sablon::TestCase
             </w:numPr>
          </w:pPr>
          <w:r w:rsidR="009F01DA">
-            <w:rPr>
-               <w:noProof/>
-            </w:rPr>
+            <w:rPr><w:noProof/></w:rPr>
             <w:t>Ruby</w:t>
          </w:r>
       </w:p><w:p w14:paraId="1081E316" w14:textId="3EAB5FDC" w:rsidR="00380EE8" w:rsidRDefault="00380EE8" w:rsidP="007F5CDE">
@@ -227,15 +200,76 @@ class ProcessorTest < Sablon::TestCase
             </w:numPr>
          </w:pPr>
          <w:r w:rsidR="009F01DA">
-            <w:rPr>
-               <w:noProof/>
-            </w:rPr>
+            <w:rPr><w:noProof/></w:rPr>
             <w:t>Rails</w:t>
          </w:r>
       </w:p>
     document
   end
 
+  def test_paragraph_block_within_table_cell
+    result = process(<<-document, {"technologies" => ["Puppet", "Chef"]})
+    <w:tbl>
+      <w:tblGrid>
+        <w:gridCol w:w="2202"/>
+      </w:tblGrid>
+      <w:tr w:rsidR="00757DAD">
+        <w:tc>
+          <w:p>
+            <w:fldSimple w:instr=" MERGEFIELD technologies:each(technology) \\* MERGEFORMAT ">
+              <w:r w:rsidR="004B49F0">
+                <w:rPr><w:noProof/></w:rPr>
+                <w:t>«technologies:each(technology)»</w:t>
+              </w:r>
+            </w:fldSimple>
+          </w:p>
+          <w:p>
+            <w:fldSimple w:instr=" MERGEFIELD =technology \\* MERGEFORMAT ">
+              <w:r w:rsidR="004B49F0">
+                <w:rPr><w:noProof/></w:rPr>
+                <w:t>«=technology»</w:t>
+              </w:r>
+            </w:fldSimple>
+          </w:p>
+          <w:p>
+            <w:fldSimple w:instr=" MERGEFIELD technologies:endEach \\* MERGEFORMAT ">
+              <w:r w:rsidR="004B49F0">
+                <w:rPr><w:noProof/></w:rPr>
+                <w:t>«technologies:endEach»</w:t>
+              </w:r>
+            </w:fldSimple>
+          </w:p>
+        </w:tc>
+      </w:tr>
+    </w:tbl>
+    document
+
+    assert_equal "Puppet Chef", text(result)
+    assert_xml_equal <<-document, result
+    <w:tbl>
+      <w:tblGrid>
+        <w:gridCol w:w="2202"/>
+      </w:tblGrid>
+      <w:tr w:rsidR="00757DAD">
+        <w:tc>
+          <w:p>
+            <w:r w:rsidR="004B49F0">
+              <w:rPr><w:noProof/></w:rPr>
+              <w:t>Puppet</w:t>
+            </w:r>
+          </w:p>
+          <w:p>
+            <w:r w:rsidR="004B49F0">
+              <w:rPr><w:noProof/></w:rPr>
+              <w:t>Chef</w:t>
+            </w:r>
+          </w:p>
+        </w:tc>
+      </w:tr>
+    </w:tbl>
+    document
+  end
+
   def test_single_row_table_loop
     item = Struct.new(:index, :label, :rating)
     result = process(<<-document, {"items" => [item.new("1.", "Milk", "***"), item.new("2.", "Sugar", "**")]})
@@ -266,9 +300,7 @@ class ProcessorTest < Sablon::TestCase
               <w:fldChar w:fldCharType="separate"/>
             </w:r>
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>«items:each(item)»</w:t>
             </w:r>
             <w:r>
@@ -305,9 +337,7 @@ class ProcessorTest < Sablon::TestCase
               <w:fldChar w:fldCharType="separate"/>
             </w:r>
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>«=item.index»</w:t>
             </w:r>
             <w:r>
@@ -330,9 +360,7 @@ class ProcessorTest < Sablon::TestCase
               <w:fldChar w:fldCharType="separate"/>
             </w:r>
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>«=item.label»</w:t>
             </w:r>
             <w:r>
@@ -355,9 +383,7 @@ class ProcessorTest < Sablon::TestCase
               <w:fldChar w:fldCharType="separate"/>
             </w:r>
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>«=item.rating»</w:t>
             </w:r>
             <w:r>
@@ -382,9 +408,7 @@ class ProcessorTest < Sablon::TestCase
               <w:fldChar w:fldCharType="separate"/>
             </w:r>
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>«items:endEach»</w:t>
             </w:r>
             <w:r>
@@ -427,9 +451,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="41ACB3D9" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>1.</w:t>
             </w:r>
           </w:p>
@@ -440,9 +462,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="197C6F31" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>Milk</w:t>
             </w:r>
           </w:p>
@@ -453,9 +473,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="55C258BB" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>***</w:t>
             </w:r>
           </w:p>
@@ -467,9 +485,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="41ACB3D9" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>2.</w:t>
             </w:r>
           </w:p>
@@ -480,9 +496,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="197C6F31" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>Sugar</w:t>
             </w:r>
           </w:p>
@@ -493,9 +507,7 @@ class ProcessorTest < Sablon::TestCase
           </w:tcPr>
           <w:p w14:paraId="55C258BB" w14:textId="77777777" w:rsidR="00757DAD" w:rsidRDefault="00757DAD" w:rsidP="006333C3">
             <w:r>
-              <w:rPr>
-                <w:noProof/>
-              </w:rPr>
+              <w:rPr><w:noProof/></w:rPr>
               <w:t>**</w:t>
             </w:r>
           </w:p>
@@ -521,9 +533,7 @@ class ProcessorTest < Sablon::TestCase
                <w:p w14:paraId="7630A6C6" w14:textId="699D0C71" w:rsidR="00F23752" w:rsidRDefault="00F23752" w:rsidP="003F16E3">
                   <w:fldSimple w:instr=" MERGEFIELD foods:each(food) \\* MERGEFORMAT ">
                      <w:r w:rsidR="00213ACD">
-                        <w:rPr>
-                           <w:noProof />
-                        </w:rPr>
+                        <w:rPr><w:noProof /></w:rPr>
                         <w:t>«foods:each(food)»</w:t>
                      </w:r>
                   </w:fldSimple>
@@ -546,9 +556,7 @@ class ProcessorTest < Sablon::TestCase
                <w:p w14:paraId="3FCF3855" w14:textId="38FA7F3B" w:rsidR="00F23752" w:rsidRDefault="00F23752" w:rsidP="00F23752">
                   <w:fldSimple w:instr=" MERGEFIELD =food.index \\* MERGEFORMAT ">
                      <w:r w:rsidR="00213ACD">
-                        <w:rPr>
-                           <w:noProof />
-                        </w:rPr>
+                        <w:rPr><w:noProof /></w:rPr>
                         <w:t>«=food.index»</w:t>
                      </w:r>
                   </w:fldSimple>
@@ -598,9 +606,7 @@ class ProcessorTest < Sablon::TestCase
                <w:p w14:paraId="3E9FF163" w14:textId="0F37CDFB" w:rsidR="00213ACD" w:rsidRDefault="00213ACD" w:rsidP="003F16E3">
                   <w:fldSimple w:instr=" MERGEFIELD =food.body \\* MERGEFORMAT ">
                      <w:r>
-                        <w:rPr>
-                           <w:noProof />
-                        </w:rPr>
+                        <w:rPr><w:noProof /></w:rPr>
                         <w:t>«=food.body»</w:t>
                      </w:r>
                   </w:fldSimple>
@@ -624,9 +630,7 @@ class ProcessorTest < Sablon::TestCase
                      <w:fldChar w:fldCharType="separate" />
                   </w:r>
                   <w:r>
-                     <w:rPr>
-                        <w:noProof />
-                     </w:rPr>
+                     <w:rPr><w:noProof /></w:rPr>
                      <w:t>«foods:endEach»</w:t>
                   </w:r>
                   <w:r>
@@ -654,9 +658,7 @@ class ProcessorTest < Sablon::TestCase
       <w:p>
         <w:fldSimple w:instr=" MERGEFIELD middle_name:if \\* MERGEFORMAT ">
           <w:r>
-            <w:rPr>
-              <w:noProof/>
-            </w:rPr>
+            <w:rPr><w:noProof/></w:rPr>
             <w:t>«middle_name:if»</w:t>
           </w:r>
         </w:fldSimple>
@@ -664,9 +666,7 @@ class ProcessorTest < Sablon::TestCase
       <w:p>
         <w:fldSimple w:instr=" MERGEFIELD =middle_name \\* MERGEFORMAT ">
           <w:r>
-            <w:rPr>
-              <w:noProof/>
-            </w:rPr>
+            <w:rPr><w:noProof/></w:rPr>
             <w:t>«=middle_name»</w:t>
           </w:r>
         </w:fldSimple>
@@ -674,9 +674,7 @@ class ProcessorTest < Sablon::TestCase
       <w:p>
         <w:fldSimple w:instr=" MERGEFIELD middle_name:endIf \\* MERGEFORMAT ">
           <w:r>
-            <w:rPr>
-              <w:noProof/>
-            </w:rPr>
+            <w:rPr><w:noProof/></w:rPr>
             <w:t>«middle_name:endIf»</w:t>
           </w:r>
         </w:fldSimple>
@@ -690,6 +688,35 @@ class ProcessorTest < Sablon::TestCase
     assert_equal "Anthony Hall", text(result)
   end
 
+  def test_conditional_with_predicate
+    document = <<-documentxml
+      <w:p>
+        <w:fldSimple w:instr=" MERGEFIELD body:if(empty?) \\* MERGEFORMAT ">
+          <w:r>
+            <w:rPr><w:noProof/></w:rPr>
+            <w:t>«body:if(empty?)»</w:t>
+          </w:r>
+        </w:fldSimple>
+      </w:p>
+      <w:p>
+        <w:t>some content</w:t>
+      </w:p>
+      <w:p>
+        <w:fldSimple w:instr=" MERGEFIELD body:endIf \\* MERGEFORMAT ">
+          <w:r>
+            <w:rPr><w:noProof/></w:rPr>
+            <w:t>«body:endIf»</w:t>
+          </w:r>
+        </w:fldSimple>
+      </w:p>
+    documentxml
+    result = process(document, {"body" => ""})
+    assert_equal "some content", text(result)
+
+    result = process(document, {"body" => "not empty"})
+    assert_equal "", text(result)
+  end
+
   private
   def process(document, context)
     @processor.process(wrap(document), context).to_xml

data/test/sablon_test.rb

@@ -2,6 +2,8 @@
 require "test_helper"
 
 class SablonTest < Sablon::TestCase
+  include Sablon::Test::Assertions
+
   def setup
     super
     @base_path = Pathname.new(File.expand_path("../", __FILE__))
@@ -15,11 +17,14 @@ class SablonTest < Sablon::TestCase
     position = Struct.new(:duration, :label, :description)
     language = Struct.new(:name, :skill)
     context = {
+      "current_time" => Time.now.strftime("%d.%m.%Y %H:%M"),
+      "author" => "Yves Senn",
       "title" => "Letter of application",
       "person" => person,
       "items" => [item.new("1.", "Ruby", "★" * 5), item.new("2.", "Java", "★" * 1), item.new("3.", "Python", "★" * 3)],
       "career" => [position.new("1999 - 2006", "Junior Java Engineer", "Lorem ipsum dolor\nsit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."),
-                   position.new("2006 - 2013", "Senior Ruby Developer", "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.")],
+                   position.new("2006 - 2013", "Senior Ruby Developer", "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo."),
+                   position.new("2013 - today", "Sales...", nil)],
       "technologies" => ["HTML", "CSS", "SASS", "LESS", "JavaScript"],
       "languages" => [language.new("German", "native speaker"), language.new("English", "fluent")],
       "training" => "At vero eos et accusam et justo duo dolores et ea rebum.\n\nStet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet."
@@ -31,22 +36,4 @@ class SablonTest < Sablon::TestCase
 
     assert_docx_equal @base_path + "fixtures/sablon_sample.docx", @output_path
   end
-
-  private
-  def assert_docx_equal(expected_path, actual_path)
-    if get_document_xml(expected_path) != get_document_xml(actual_path)
-      msg = <<-error
-The generated document does not match the sample. Please investigate.
-
-If the generated document is correct, the sample needs to be updated:
-\t cp #{actual_path} #{expected_path}
-      error
-      fail msg
-    end
-  end
-
-  def get_document_xml(path)
-    document_xml_entry = Zip::File.open(path).get_entry("word/document.xml")
-    document_xml_entry.get_input_stream.read
-  end
 end

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require "pathname"
 
 $: << File.expand_path('../../lib', __FILE__)
 require "sablon"
+require "sablon/test"
 
 class Sablon::TestCase < MiniTest::Test
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,11 @@ files:
 - lib/sablon/processor.rb
 - lib/sablon/processor/section_properties.rb
 - lib/sablon/template.rb
+- lib/sablon/test.rb
+- lib/sablon/test/assertions.rb
 - lib/sablon/version.rb
+- misc/output.png
+- misc/template.png
 - sablon.gemspec
 - test/expression_test.rb
 - test/fixtures/sablon_sample.docx