sablon 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 698e85a00ad9dace7dd51e7cf8887d59612edf60
-  data.tar.gz: 06fefc2d6ae9d747ca0d5cad4aca1cef80036cbd
+  metadata.gz: b83974c57d78d5a2b9ae7f1fc15f8527b3d349bf
+  data.tar.gz: 1d8283d8c781bb7e3810316cd71ef60f4e53cf70
 SHA512:
-  metadata.gz: f86083620b300bd83e48721ba92cd9909556692bec0362990997c8f1f9c7b78155929628a104995ba8c586e90afce5c8505eedeb3cc84ac6e23c347afae02c09
-  data.tar.gz: 4c2320a98d95071d4ea0ee3d9ec88f3cd7ba93f6618b016c3a97eb94339d7850561bf51bba5e1821b0d2f93d06123de06f41d1a35e381f240875416e46f47c05
+  metadata.gz: aacf3306315f9d9cc76c82de9a43cbf491ffccc5af4434e1409c6a7f513ef13133868201ba5cf702c478c585182fd46d8232a2c8e45ae3b50675cdc957f4b7a6
+  data.tar.gz: bf82feaafe41009c8f1e4b95a3dbbf31159da473fcfda2cad055c37bfe3ba600d7529aabba8bf3574353bbb81be9f9e9b751b7aa8e5e93b8ef8df740790db6e6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sablon (0.0.20)
+    sablon (0.0.21)
       nokogiri (>= 1.6.0)
       rubyzip (>= 1.1)
 
@@ -10,12 +10,10 @@ GEM
   specs:
     mini_portile2 (2.1.0)
     minitest (5.8.0)
-    nokogiri (1.6.8)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
     rake (10.4.2)
-    rubyzip (1.2.0)
+    rubyzip (1.2.1)
     xml-simple (1.1.5)
 
 PLATFORMS
@@ -29,4 +27,4 @@ DEPENDENCIES
   xml-simple
 
 BUNDLED WITH
-   1.12.5
+   1.14.5

data/README.md

@@ -36,6 +36,8 @@ Sablon templates are normal Word documents (`.docx`) sprinkled with MailMerge fi
 to perform operations. The following section uses the notation `«=title»` to
 refer to [Word MailMerge](http://en.wikipedia.org/wiki/Mail_merge) fields.
 
+A detailed description about how to create a template can be found [here](misc/TEMPLATE.md)
+
 #### Content Insertion
 
 The most basic operation is to insert content. The contents of a context

data/lib/sablon/operations.rb

@@ -4,7 +4,7 @@ module Sablon
     class Insertion < Struct.new(:expr, :field)
       def evaluate(context)
         if content = expr.evaluate(context)
-          field.replace(Sablon::Content.wrap(expr.evaluate(context)))
+          field.replace(Sablon::Content.wrap(content))
         else
           field.remove
         end

data/lib/sablon/parser/mail_merge.rb

@@ -111,6 +111,7 @@ module Sablon
       end
 
       private
+
       def build_complex_field(node)
         possible_field_node = node.parent
         field_nodes = [possible_field_node]
@@ -118,7 +119,8 @@ module Sablon
           possible_field_node = possible_field_node.next_element
           field_nodes << possible_field_node
         end
-        ComplexField.new(field_nodes)
+        # skip instantiation if no end tag
+        ComplexField.new(field_nodes) if field_nodes.last
       end
     end
   end

data/lib/sablon/version.rb

@@ -1,3 +1,3 @@
 module Sablon
-  VERSION = "0.0.20"
+  VERSION = "0.0.21"
 end

data/misc/TEMPLATE.md

@@ -0,0 +1,44 @@
+### Creating a Simple Template
+Creating a template is as easy as creating a normal Word document (`.docx`). Yet it could be confusing to people who haven't used the [Mail Merge](https://support.office.com/en-us/article/Use-mail-merge-to-send-bulk-email-messages-0f123521-20ce-4aa8-8b62-ac211dedefa4) feature in Microsoft Word. The steps are as follows:
+
+- Create a new word document
+
+![Step 1](/misc/step_1.png)
+
+- Create your template
+
+![Step 2](/misc/step_2.png)
+
+- Add mail merge fields
+
+- Click the `Insert` tab on the ribbon
+
+![Step 3.1](/misc/step_3_1.png)
+
+- Click the `Quick Parts` dropdown and select `Field...`
+
+![Step 3.2](/misc/step_3_2.png)
+
+- On the dialog, scroll down and select `MergeField`
+
+![Step 3.3a](/misc/step_3_3_a.png)
+
+ - Select `Field Codes`
+
+![Step 3.3b](/misc/step_3_3_b.png)
+
+![Step 4](/misc/step_4.png)
+
+- In the `Field codes` input box, enter your variable in front of the `MERGEFIELD`. Notice the space between the `MERGEFIELD` and the variable
+
+![Step 5](/misc/step_5.png)
+
+- You should then have something like this:
+
+![Step 6](/misc/step_6.png)
+
+- A complete template might look like this:
+
+![Step 7](/misc/step_7.png)
+
+NOTE: When adding variables, those that display a value are preceded with an equals sign `=`. Those that just perform logics, such as loops and conditionals, do not need a preceding equals sign.

data/test/fixtures/xml/test_ignore_complex_field_spanning_multiple_paragraphs.xml

@@ -0,0 +1,35 @@
+<w:p w14:paraId="2A8BFD66" w14:textId="77777777" w:rsidR="006F0A69" w:rsidRDefault="00E40CBA" w:rsidP="00670731">
+  <w:r>
+    <w:fldChar w:fldCharType="begin"/>
+  </w:r>
+  <w:r>
+    <w:instrText xml:space="preserve"> AUTOTEXT  Header:Date  \* MERGEFORMAT </w:instrText>
+  </w:r>
+  <w:r>
+    <w:fldChar w:fldCharType="separate"/>
+  </w:r>
+  <w:r w:rsidR="006F0A69" w:rsidRPr="009A09E3">
+    <w:t>Day Month Year</w:t>
+  </w:r>
+</w:p>
+
+<w:p w14:paraId="71B65E52" w14:textId="613138CB" w:rsidR="001D1AF8" w:rsidRDefault="00E40CBA" w:rsidP="006C34C3">
+  <w:pPr>
+    <w:pStyle w:val="Address"/>
+  </w:pPr>
+  <w:r>
+    <w:fldChar w:fldCharType="end"/>
+  </w:r>
+  <w:bookmarkEnd w:id="0"/>
+</w:p>
+
+<w:p w14:paraId="7C3EB778" w14:textId="78AB4714" w:rsidR="001D1AF8" w:rsidRPr="000C6261" w:rsidRDefault="00A35B65" w:rsidP="001D1AF8">
+  <w:fldSimple w:instr=" MERGEFIELD =current_time \* MERGEFORMAT ">
+    <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«=current_time»</w:t>
+    </w:r>
+  </w:fldSimple>
+</w:p>

data/test/processor/document_test.rb

@@ -384,6 +384,48 @@ class ProcessorDocumentTest < Sablon::TestCase
     assert_equal "ParagraphBefore Before Content After ParagraphAfter", text(with_true)
   end
 
+  def test_ignore_complex_field_spanning_multiple_paragraphs
+    result = process(snippet("test_ignore_complex_field_spanning_multiple_paragraphs"),
+                     {"current_time" => '14:53'})
+
+    assert_equal "AUTOTEXT Header:Date \\* MERGEFORMAT Day Month Year 14:53", text(result)
+    assert_xml_equal <<-document, result
+    <w:p w14:paraId="2A8BFD66" w14:textId="77777777" w:rsidR="006F0A69" w:rsidRDefault="00E40CBA" w:rsidP="00670731">
+      <w:r>
+        <w:fldChar w:fldCharType="begin"/>
+      </w:r>
+      <w:r>
+        <w:instrText xml:space="preserve"> AUTOTEXT  Header:Date  \\* MERGEFORMAT </w:instrText>
+      </w:r>
+      <w:r>
+        <w:fldChar w:fldCharType="separate"/>
+      </w:r>
+      <w:r w:rsidR="006F0A69" w:rsidRPr="009A09E3">
+        <w:t>Day Month Year</w:t>
+      </w:r>
+    </w:p>
+
+    <w:p w14:paraId="71B65E52" w14:textId="613138CB" w:rsidR="001D1AF8" w:rsidRDefault="00E40CBA" w:rsidP="006C34C3">
+      <w:pPr>
+        <w:pStyle w:val="Address"/>
+      </w:pPr>
+      <w:r>
+        <w:fldChar w:fldCharType="end"/>
+      </w:r>
+      <w:bookmarkEnd w:id="0"/>
+    </w:p>
+
+    <w:p w14:paraId="7C3EB778" w14:textId="78AB4714" w:rsidR="001D1AF8" w:rsidRPr="000C6261" w:rsidRDefault="00A35B65" w:rsidP="001D1AF8">
+        <w:r>
+          <w:rPr>
+            <w:noProof/>
+          </w:rPr>
+          <w:t>14:53</w:t>
+        </w:r>
+    </w:p>
+    document
+  end
+
   def test_conditional_with_predicate
     result = process(snippet("conditional_with_predicate"), {"body" => ""})
     assert_equal "some content", text(result)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -128,10 +128,21 @@ files:
 - lib/sablon/test.rb
 - lib/sablon/test/assertions.rb
 - lib/sablon/version.rb
+- misc/TEMPLATE.md
 - misc/cv_sample.png
 - misc/cv_template.png
 - misc/recipe_sample.png
 - misc/recipe_template.png
+- misc/step_1.png
+- misc/step_2.png
+- misc/step_3_1.png
+- misc/step_3_2.png
+- misc/step_3_3_a.png
+- misc/step_3_3_b.png
+- misc/step_4.png
+- misc/step_5.png
+- misc/step_6.png
+- misc/step_7.png
 - sablon.gemspec
 - test/content_test.rb
 - test/context_test.rb
@@ -165,6 +176,7 @@ files:
 - test/fixtures/xml/simple_fields.xml
 - test/fixtures/xml/table_multi_row_loop.xml
 - test/fixtures/xml/table_row_loop.xml
+- test/fixtures/xml/test_ignore_complex_field_spanning_multiple_paragraphs.xml
 - test/html/converter_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
@@ -195,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: docx tempalte processor
@@ -232,6 +244,7 @@ test_files:
 - test/fixtures/xml/simple_fields.xml
 - test/fixtures/xml/table_multi_row_loop.xml
 - test/fixtures/xml/table_row_loop.xml
+- test/fixtures/xml/test_ignore_complex_field_spanning_multiple_paragraphs.xml
 - test/html/converter_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb