sablon 0.1.1 → 0.2.0

data/test/html/node_properties_test.rb

@@ -81,13 +81,13 @@ class NodePropertiesTest < Sablon::TestCase
     props = {}
     props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
     props['rStyle'] = 'FootnoteText'
-    assert_equal({ 'rStyle' => 'FootnoteText' }, props.instance_variable_get(:@properties))
+    assert_equal({ rStyle: 'FootnoteText' }, props.instance_variable_get(:@properties))
   end
 
   def test_properties_filtered_on_init
     props = { 'pStyle' => 'Paragraph', 'rStyle' => 'EndnoteText' }
     props = Sablon::HTMLConverter::NodeProperties.new('w:rPr', props, %w[rStyle])
-    assert_equal({ 'rStyle' => 'EndnoteText' }, props.instance_variable_get(:@properties))
+    assert_equal({ rStyle: 'EndnoteText' }, props.instance_variable_get(:@properties))
   end
 
   def test_transferred_properties

data/test/html_test.rb

@@ -3,7 +3,6 @@ require "test_helper"
 require "support/html_snippets"
 
 class SablonHTMLTest < Sablon::TestCase
-  include Sablon::Test::Assertions
   include HTMLSnippets
 
   def setup
@@ -14,7 +13,6 @@ class SablonHTMLTest < Sablon::TestCase
   end
 
   def test_generate_document_from_template_with_styles_and_html
-    uid_generator = UIDTestGenerator.new
     template_path = @base_path + "fixtures/insertion_template.docx"
     output_path = @base_path + "sandbox/html.docx"
     template = Sablon.template template_path
@@ -25,9 +23,7 @@ class SablonHTMLTest < Sablon::TestCase
         'html:github' => '<a href="http://www.github.com" style="color: #0000FF">GitHub</a>'
       }
     }
-    SecureRandom.stub(:uuid, uid_generator.method(:new_uid)) do
-      template.render_to_file output_path, context
-    end
+    template.render_to_file output_path, context
     #
     assert_docx_equal @sample_path, output_path
   end
@@ -41,7 +37,7 @@ class SablonHTMLTest < Sablon::TestCase
     e = assert_raises(ArgumentError) do
       template.render_to_file output_path, context
     end
-    assert_equal 'Could not find w:abstractNum definition for style: "ListNumber"', e.message
+    assert_equal "Could not find w:abstractNum definition for style: 'ListNumber'", e.message
 
     skip 'implement default styles'
   end

data/test/processor/document_test.rb

@@ -311,7 +311,6 @@ class ProcessorDocumentTest < Sablon::TestCase
         </w:tc>
       </w:tr>
     </w:tbl>
-
     document
   end
 
@@ -348,6 +347,22 @@ class ProcessorDocumentTest < Sablon::TestCase
     assert_equal "Could not find end field for «technologies:each(technology)». Was looking for «technologies:endEach»", e.message
   end
 
+  def test_loop_incrementing_unique_ids
+    context = {
+      fruits: %w[Apple Blueberry Cranberry Date].map { |i| { name: i } },
+      cars: %w[Silverado Serria Ram Tundra].map { |i| { name: i } }
+    }
+    #
+    xml = Nokogiri::XML(process(snippet('loop_with_unique_ids'), context))
+    #
+    # all unique ids should get incremented to stay unique
+    ids = xml.xpath("//*[local-name() = 'docPr']").map { |n| n.attr('id') }
+    assert_equal %w[1 2 3 4], ids
+    #
+    ids = xml.xpath("//*[local-name() = 'cNvPr']").map { |n| n.attr('id') }
+    assert_equal %w[1 2 3 4], ids
+  end
+
   def test_conditional_with_missing_end_raises_error
     e = assert_raises Sablon::TemplateError do
       process(snippet("conditional_without_ending"), {})
@@ -446,7 +461,7 @@ class ProcessorDocumentTest < Sablon::TestCase
     assert_xml_equal <<-document, result
     <w:r><w:t xml:space="preserve">Before </w:t></w:r>
     <w:r><w:t xml:space="preserve">After </w:t></w:r>
-    <w:p>           
+    <w:p>
       <w:r w:rsidR="004B49F0">
         <w:rPr><w:noProof/></w:rPr>
         <w:t>Contents of comment key</w:t>
@@ -455,10 +470,72 @@ class ProcessorDocumentTest < Sablon::TestCase
     document
   end
 
+  def test_image_replacement
+    base_path = Pathname.new(File.expand_path("../../", __FILE__))
+    image = Sablon.content(:image, base_path + "fixtures/images/r2d2.jpg")
+    result = process(snippet("image"), { "item" => { "image" => image } })
+
+    assert_xml_equal <<-document, result
+      <w:p>
+      </w:p>
+      <w:p>
+      <w:r>
+      <w:rPr>
+        <w:noProof/>
+      </w:rPr>
+      <w:drawing>
+        <wp:inline distT="0" distB="0" distL="0" distR="0">
+          <wp:extent cx="1875155" cy="1249045"/>
+          <wp:effectExtent l="0" t="0" r="0" b="0"/>
+          <wp:docPr id="2" name="Picture 2"/>
+          <wp:cNvGraphicFramePr>
+            <a:graphicFrameLocks xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main" noChangeAspect="1"/>
+          </wp:cNvGraphicFramePr>
+          <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
+            <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
+              <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
+                <pic:nvPicPr>
+                  <pic:cNvPr id="2" name="r2d2.jpg"/>
+                  <pic:cNvPicPr/>
+                </pic:nvPicPr>
+                <pic:blipFill>
+                  <a:blip r:embed="rId1235\">
+                    <a:extLst>
+                      <a:ext uri="{28A0092B-C50C-407E-A947-70E740481C1C}">
+                        <a14:useLocalDpi xmlns:a14="http://schemas.microsoft.com/office/drawing/2010/main" val="0"/>
+                      </a:ext>
+                    </a:extLst>
+                  </a:blip>
+                  <a:stretch>
+                    <a:fillRect/>
+                  </a:stretch>
+                </pic:blipFill>
+                <pic:spPr>
+                  <a:xfrm>
+                    <a:off x="0" y="0"/>
+                    <a:ext cx="1875155" cy="1249045"/>
+                  </a:xfrm>
+                  <a:prstGeom prst="rect">
+                    <a:avLst/>
+                  </a:prstGeom>
+                </pic:spPr>
+              </pic:pic>
+            </a:graphicData>
+          </a:graphic>
+        </wp:inline>
+      </w:drawing>
+      </w:r>
+      </w:p>
+      <w:p>
+      </w:p>
+    document
+  end
+
   private
 
   def process(document, context)
-    env = Sablon::Environment.new(nil, context)
+    env = Sablon::Environment.new(MockTemplate.new, context)
+    env.document.current_entry = 'word/document.xml'
     @processor.process(wrap(document), env).to_xml
   end
 end

data/test/processor/section_properties_test.rb

@@ -0,0 +1,68 @@
+require "test_helper"
+require "support/document_xml_helper"
+
+class SectionPropertiesTest < Sablon::TestCase
+  include DocumentXMLHelper
+
+  def setup
+    @env = Sablon::Environment.new(nil, {})
+  end
+
+  def test_process
+    xml = <<-XML
+      <w:body>
+        <w:sectPr w:rsidR="00FC1AFD" w:rsidSect="006745DF">
+          <w:pgSz w:w="11900" w:h="16840"/>
+          <w:pgMar w:top="1440" w:right="1800" w:bottom="1440" w:left="1800" w:header="708" w:footer="708" w:gutter="0"/>
+          <w:pgNumType w:start="1"/>
+          <w:cols w:space="708"/>
+          <w:docGrid w:linePitch="360"/>
+        </w:sectPr>
+      </w:body>
+    XML
+    expected = xml.gsub(/w:start="1"/, 'w:start="123"')
+    xml = wrap(xml)
+    #
+    @env.section_properties = { start_page_number: 123 }
+    Sablon::Processor::SectionProperties.process(xml, @env)
+    #
+    assert_xml_equal expected, xml.to_s
+  end
+
+  def test_assign_start_page_number_with_pgNumType_tag
+    xml = wrap <<-XML
+      <w:body>
+        <w:sectPr w:rsidR="00FC1AFD" w:rsidSect="006745DF">
+          <w:pgSz w:w="11900" w:h="16840"/>
+          <w:pgMar w:top="1440" w:right="1800" w:bottom="1440" w:left="1800" w:header="708" w:footer="708" w:gutter="0"/>
+          <w:pgNumType w:start="1"/>
+          <w:cols w:space="708"/>
+          <w:docGrid w:linePitch="360"/>
+        </w:sectPr>
+      </w:body>
+    XML
+    #
+    properties = Sablon::Processor::SectionProperties.new(xml)
+    assert_equal "1", properties.start_page_number
+    properties.start_page_number = "23"
+    assert_equal "23", properties.start_page_number
+  end
+
+  def test_assign_start_page_number_without_pgNumType_tag
+    xml = wrap <<-XML
+      <w:body>
+        <w:sectPr w:rsidR="00FC1AFD" w:rsidSect="006745DF">
+          <w:pgSz w:w="11900" w:h="16840"/>
+          <w:pgMar w:top="1440" w:right="1800" w:bottom="1440" w:left="1800" w:header="708" w:footer="708" w:gutter="0"/>
+          <w:cols w:space="708"/>
+          <w:docGrid w:linePitch="360"/>
+        </w:sectPr>
+      </w:body>
+    XML
+    #
+    properties = Sablon::Processor::SectionProperties.new(xml)
+    assert_nil properties.start_page_number
+    properties.start_page_number = "16"
+    assert_equal "16", properties.start_page_number
+  end
+end

data/test/sablon_test.rb

@@ -3,7 +3,6 @@ require "test_helper"
 require "support/xml_snippets"
 
 class SablonTest < Sablon::TestCase
-  include Sablon::Test::Assertions
   include XMLSnippets
 
   def setup
@@ -24,7 +23,7 @@ class SablonTest < Sablon::TestCase
     referee = Struct.new(:name, :company, :position, :phone)
 
     context = {
-      current_time: Time.now.strftime("%d.%m.%Y %H:%M"),
+      current_time: '15.04.2015 14:57',
       metadata: { generator: "Sablon" },
       title: "Resume",
       person: OpenStruct.new("first_name" => "Ronald", "last_name" => "Anderson",
@@ -85,8 +84,7 @@ class SablonTest < Sablon::TestCase
   end
 end
 
-class SablonTest < Sablon::TestCase
-  include Sablon::Test::Assertions
+class SablonConditionalsTest < Sablon::TestCase
   include XMLSnippets
 
   def setup
@@ -99,7 +97,81 @@ class SablonTest < Sablon::TestCase
 
   def test_generate_document_from_template
     template = Sablon.template @template_path
-    context = {paragraph: true, inline: true, table: true, table_inline: true, content: "Some Content"}
+    context = {
+      paragraph: true,
+      inline: true,
+      table: true,
+      table_inline: true,
+      content: "Some Content"
+    }
+    #
+    context = { paragraph: true, inline: true, table: true, table_inline: true, content: "Some Content" }
+    template.render_to_file @output_path, context
+    assert_docx_equal @sample_path, @output_path
+  end
+end
+
+class SablonLoopsTest < Sablon::TestCase
+  include XMLSnippets
+
+  def setup
+    super
+    @base_path = Pathname.new(File.expand_path("../", __FILE__))
+    @template_path = @base_path + "fixtures/loops_template.docx"
+    @output_path = @base_path + "sandbox/loops.docx"
+    @sample_path = @base_path + "fixtures/loops_sample.docx"
+  end
+
+  def test_generate_document_from_template
+    template = Sablon.template @template_path
+    context = {
+      fruits: %w[Apple Blueberry Cranberry Date].map { |i| { name: i } },
+      cars: %w[Silverado Serria Ram Tundra].map { |i| { name: i } }
+    }
+
+    template.render_to_file @output_path, context
+    assert_docx_equal @sample_path, @output_path
+  end
+end
+
+class SablonImagesTest < Sablon::TestCase
+  def setup
+    super
+    @base_path = Pathname.new(File.expand_path("../", __FILE__))
+    @template_path = @base_path + "fixtures/images_template.docx"
+    @output_path = @base_path + "sandbox/images.docx"
+    @sample_path = @base_path + "fixtures/images_sample.docx"
+    @image_fixtures = @base_path + "fixtures/images"
+  end
+
+  def test_generate_document_from_template
+    template = Sablon.template @template_path
+    #
+    # setup two image contents to allow quick reuse
+    r2d2 = Sablon.content(:image, @image_fixtures.join('r2d2.jpg').to_s)
+    c3po = Sablon.content(:image, @image_fixtures.join('c3po.jpg'))
+    darth = Sablon.content(:image, @image_fixtures.join('darth_vader.jpg'))
+    #
+    im_data = StringIO.new(IO.binread(@image_fixtures.join('clone.jpg')))
+    trooper = Sablon.content(:image, im_data, filename: 'clone.jpg')
+    #
+    # with the following context setup all trooper should be reused and
+    # only a single file added to media. R2D2 should get duplicated in the
+    # media folder because it is used in two different context keys as
+    # separate instances. Darth Vader should not be duplicated because
+    # the ket "unused_darth" doesn't appear in the template
+    context = {
+      items: [
+        { title: 'C-3PO', image: c3po },
+        { title: 'R2-D2', image: r2d2 },
+        { title: 'Darth Vader', 'image:image' => @image_fixtures.join('darth_vader.jpg') },
+        { title: 'Storm Trooper', image: trooper }
+      ],
+      'image:r2d2' => @image_fixtures.join('r2d2.jpg'),
+      'unused_darth' => darth,
+      trooper: trooper
+    }
+
     template.render_to_file @output_path, context
     assert_docx_equal @sample_path, @output_path
   end

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require "bundler/setup"
-
+require 'minitest/assertions'
 require "minitest/autorun"
 require "minitest/mock"
 require "xmlsimple"
@@ -8,26 +8,126 @@ require "pathname"
 
 $: << File.expand_path('../../lib', __FILE__)
 require "sablon"
-require "sablon/test"
+
+module Minitest
+  module Assertions
+    def assert_docx_equal(expected_path, actual_path)
+      #
+      # Parse document archives and generate a diff
+      xml_diffs = diff_docx_files(expected_path, actual_path)
+      #
+      # build error message
+      msg = 'The generated document does not match the sample. Please investigate file(s): '
+      msg += xml_diffs.keys.sort.join(', ')
+      xml_diffs.each do |name, diff_text|
+        msg += "\n#{'-' * 72}\nFile: #{name}\n#{diff_text}\n"
+      end
+      msg += '-' * 72 + "\n"
+      msg += "If the generated document is correct, the sample needs to be updated:\n"
+      msg += "\t cp #{actual_path} #{expected_path}"
+      #
+      raise Minitest::Assertion, msg unless xml_diffs.empty?
+    end
+
+    # Returns a hash of all XML files that differ in the docx file. This
+    # only checks files that have the extension ".xml" or ".rels".
+    def diff_docx_files(expected_path, actual_path)
+      expected = parse_docx(expected_path)
+      actual = parse_docx(actual_path)
+      xml_diffs = {}
+      #
+      expected.each do |entry_name, expect|
+        next unless entry_name =~ /.xml$|.rels$/
+        next unless expect != actual[entry_name]
+        #
+        xml_diffs[entry_name] = diff(expect, actual[entry_name])
+      end
+      #
+      xml_diffs
+    end
+
+    def parse_docx(path)
+      contents = {}
+      #
+      # step over all entries adding them to the hash to diff against
+      Zip::File.open(path).each do |entry|
+        next unless entry.file?
+        content = entry.get_input_stream.read
+        # normalize xml content
+        if entry.name =~ /.xml$|.rels$/
+          content = Nokogiri::XML(content).to_xml(indent: 2)
+        end
+        contents[entry.name] = content
+      end
+      #
+      contents
+    end
+  end
+end
 
 class Sablon::TestCase < MiniTest::Test
   def teardown
     super
   end
 
-  class UIDTestGenerator
+  class MockTemplate
+    attr_reader :document
+
+    def initialize
+      @path = nil
+      @document = MockDomModel.new
+    end
+  end
+
+  # catch all for method stubs that are needed during testing
+  class MockDomModel
+    attr_accessor :current_entry
+    attr_reader :current_rid, :zip_contents
+
+    # Simple class to reload mock document components from fixtures on demand
+    class ZipContents
+      def [](entry_name)
+        load_mock_content(entry_name)
+      end
+
+      private
+
+      # Loads and parses individual files to build the mock document
+      def load_mock_content(entry_name)
+        root = Pathname.new(File.dirname(__FILE__))
+        xml_path = root.join('fixtures', 'xml', 'mock_document', entry_name)
+        Nokogiri::XML(File.read(xml_path))
+      end
+    end
+
     def initialize
-      @current_id = 1234
-      @current_id_start = @current_id
+      @current_entry = nil
+      @current_rid = 1234
+      @current_rid_start = @current_rid
+      @current_numid = 0
+      @current_numid_start = @current_numid
+      @zip_contents = ZipContents.new
+    end
+
+    # Returns the corresponding DOM handled file
+    def [](entry_name)
+      Sablon::DOM.wrap_with_handler(entry_name, @zip_contents[entry_name])
     end
 
-    def new_uid
-      @current_id += 1
-      @current_id.to_s
+    def add_relationship(*)
+      "rId#{@current_rid += 1}"
+    end
+
+    def add_list_definition(style)
+      @current_numid += 1
+      Struct.new(:style, :numid).new(style, @current_numid)
     end
 
     def reset
-      @current_id = @current_id_start
+      @current_rid = @current_rid_start
+      @current_numid = @current_numid_start
     end
+
+    alias add_media add_relationship
   end
 end