sablon 0.0.22 → 0.1.0

data/lib/sablon/html/ast_builder.rb

@@ -52,13 +52,8 @@ module Sablon
       # Checking that the current tag is an allowed child of the parent_tag.
       # If the parent tag is nil then a block level tag is required.
       def validate_structure(parent, child)
-        if parent.ast_class == Root && child.type == :inline
-          msg = "#{child.name} needs to be wrapped in a block level tag."
-        elsif parent && !parent.allowed_child?(child)
-          msg = "#{child.name} is not a valid child element of #{parent.name}."
-        else
-          return
-        end
+        return unless parent && !parent.allowed_child?(child)
+        msg = "#{child.name} is not a valid child element of #{parent.name}."
         raise ContextError, "Invalid HTML structure: #{msg}"
       end
 

data/lib/sablon/html/node_properties.rb

@@ -0,0 +1,91 @@
+module Sablon
+  class HTMLConverter
+    # Manages the properties for an AST node, includes factory methods
+    # for easy use at calling sites.
+    class NodeProperties
+      attr_reader :transferred_properties
+
+      def self.paragraph(properties)
+        new('w:pPr', properties, Paragraph::PROPERTIES)
+      end
+
+      def self.table(properties)
+        new('w:tblPr', properties, Table::PROPERTIES)
+      end
+
+      def self.table_row(properties)
+        new('w:trPr', properties, TableRow::PROPERTIES)
+      end
+
+      def self.table_cell(properties)
+        new('w:tcPr', properties, TableCell::PROPERTIES)
+      end
+
+      def self.run(properties)
+        new('w:rPr', properties, Run::PROPERTIES)
+      end
+
+      def initialize(tagname, properties, whitelist)
+        @tagname = tagname
+        filter_properties(properties, whitelist)
+      end
+
+      def inspect
+        @properties.map { |k, v| v ? "#{k}=#{v}" : k }.join(';')
+      end
+
+      def [](key)
+        @properties[key]
+      end
+
+      def []=(key, value)
+        @properties[key] = value
+      end
+
+      def to_docx
+        "<#{@tagname}>#{properties_word_ml}</#{@tagname}>" unless @properties.empty?
+      end
+
+      private
+
+      # processes properties adding those on the whitelist to the
+      # properties instance variable and those not to the transferred_properties
+      # isntance variable
+      def filter_properties(properties, whitelist)
+        @transferred_properties = {}
+        @properties = {}
+        #
+        properties.each do |key, value|
+          if whitelist.include? key.to_s
+            @properties[key] = value
+          else
+            @transferred_properties[key] = value
+          end
+        end
+      end
+
+      # processes attributes defined on the node into wordML property syntax
+      def properties_word_ml
+        @properties.map { |k, v| transform_attr(k, v) }.join
+      end
+
+      # properties that have a list as the value get nested in tags and
+      # each entry in the list is transformed. When a value is a hash the
+      # keys in the hash are used to explicitly build the XML tag attributes.
+      def transform_attr(key, value)
+        if value.is_a? Array
+          sub_attrs = value.map do |sub_prop|
+            sub_prop.map { |k, v| transform_attr(k, v) }
+          end
+          "<w:#{key}>#{sub_attrs.join}</w:#{key}>"
+        elsif value.is_a? Hash
+          props = value.map { |k, v| format('w:%s="%s"', k, v) if v }
+          "<w:#{key} #{props.compact.join(' ')} />"
+        else
+          value = format('w:val="%s" ', value) if value
+          "<w:#{key} #{value}/>"
+        end
+      end
+    end
+  end
+end

data/lib/sablon/relationship.rb

@@ -0,0 +1,47 @@
+module Sablon
+  # Handles storing referenced relationships in the document.xml file and
+  # writing them to the document.xml.rels file
+  class Relationship
+    attr_accessor :relationships
+
+    def initialize
+      @relationships = []
+    end
+
+    def add_found_relationships(content, output_stream)
+      output_stream.put_next_entry('word/_rels/document.xml.rels')
+      #
+      unless @relationships.empty?
+        rels_doc = Nokogiri::XML(content)
+        rels_doc_root = rels_doc.root
+        # convert new rels to nodes
+        node_set = convert_relationships_to_node_set(rels_doc)
+        @relationships = []
+        # add new nodes to XML content
+        rels_doc_root.last_element_child.after(node_set)
+        content = rels_doc.to_xml(indent: 0, save_with: 0)
+      end
+      #
+      output_stream.write(content)
+    end
+
+    private
+
+    # Builds a set of Relationship XML nodes from the stored relationships
+    def convert_relationships_to_node_set(doc)
+      node_set = Nokogiri::XML::NodeSet.new(doc)
+      @relationships.each do |relationship|
+        rel_tag = "<Relationship#{relationship_attributes(relationship)}/>"
+        node_set << Nokogiri::XML.fragment(rel_tag).children.first
+      end
+      #
+      node_set
+    end
+
+    # Builds the attribute string for the relationship XML node
+    def relationship_attributes(relationship)
+      return '' if relationship.nil? || relationship.empty?
+      ' ' + relationship.map { |k, v| %(#{k}="#{v}") }.join(' ')
+    end
+  end
+end

data/lib/sablon/template.rb

@@ -19,11 +19,14 @@ module Sablon
     private
 
     def render(context, properties = {})
+      created_dirs = []
+      relations_file_content = nil
       env = Sablon::Environment.new(self, context)
       Zip.sort_entries = true # required to process document.xml before numbering.xml
       Zip::OutputStream.write_buffer(StringIO.new) do |out|
         Zip::File.open(@path).each do |entry|
           entry_name = entry.name
+          created_dirs = create_dirs_in_zipfile(created_dirs, entry_name, out)
           out.put_next_entry(entry_name)
           content = entry.get_input_stream.read
           if entry_name == 'word/document.xml'
@@ -32,11 +35,38 @@ module Sablon
             out.write(process(Processor::Document, content, env))
           elsif entry_name == 'word/numbering.xml'
             out.write(process(Processor::Numbering, content, env))
+          elsif entry_name == 'word/_rels/document.xml.rels'
+            relations_file_content = content
           else
             out.write(content)
           end
         end
+        if relations_file_content
+          env.relationship.add_found_relationships(relations_file_content, out)
+        end
+      end
+    end
+
+    # creates directories of the unzipped docx file in the newly created docx file e.g. in case of
+    # word/_rels/document.xml.rels it creates word/ and _rels directories to apply recursive zipping.
+    # This is a hack to fix the issue of getting a corrupted file when any referencing between the
+    # xml files happen like in the case of implementing hyperlinks
+    #
+    def create_dirs_in_zipfile(previous_created_dirs, entry_name, output_stream)
+      created_dirs = previous_created_dirs
+      entry_name_tokens = entry_name.split('/')
+      entry_name_tokens.pop()
+      if entry_name_tokens.length > 1
+        prev_dir = ''
+        entry_name_tokens.each do |dir_name|
+          prev_dir += dir_name + '/'
+          unless created_dirs.include? prev_dir
+            output_stream.put_next_entry(prev_dir)
+            created_dirs << prev_dir
+          end
+        end
       end
+      created_dirs
     end
 
     # process the sablon xml template with the given +context+.

data/lib/sablon/version.rb

@@ -1,3 +1,3 @@
 module Sablon
-  VERSION = "0.0.22"
+  VERSION = "0.1.0"
 end

data/test/content_test.rb

@@ -1,6 +1,36 @@
 # -*- coding: utf-8 -*-
 require "test_helper"
 
+module XmlContentTestSetup
+  def setup
+    super
+    @template_text = '<w:p><w:r><w:t>template</w:t></w:r></w:p><w:p>AFTER</w:p>'
+    #
+    @document = Nokogiri::XML(doc_wrapper(@template_text))
+    @paragraph = @document.xpath('//w:p').first
+    @node = @paragraph.xpath('.//w:r').first.at_xpath('./w:t')
+    @env = Sablon::Environment.new(nil)
+  end
+
+  private
+
+  def doc_wrapper(content)
+    doc = <<-XML.gsub(/^\s+|\n/, '')
+      <w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+        <w:body>
+          %<content>s
+        </w:body>
+      </w:document>
+    XML
+    format(doc, content: content)
+  end
+
+  def assert_xml_equal(expected, document)
+    expected = Nokogiri::XML(doc_wrapper(expected)).to_xml(indent: 0, save_with: 0)
+    assert_equal expected, document.to_xml(indent: 0, save_with: 0)
+  end
+end
+
 class ContentTest < Sablon::TestCase
   def test_can_build_content_objects
     content = Sablon.content(:string, "a string")
@@ -69,30 +99,14 @@ class CustomContentTest < Sablon::TestCase
   end
 end
 
-module ContentTestSetup
-  def setup
-    super
-    @template_text = '<w:p><span>template</span></w:p><w:p>AFTER</w:p>'
-    @document = Nokogiri::XML.fragment(@template_text)
-    @paragraph = @document.children.first
-    @node = @document.css("span").first
-    @env = Sablon::Environment.new(nil)
-  end
-
-  private
-  def assert_xml_equal(expected, document)
-    assert_equal expected, document.to_xml(indent: 0, save_with: 0)
-  end
-end
-
 class ContentStringTest < Sablon::TestCase
-  include ContentTestSetup
+  include XmlContentTestSetup
 
   def test_single_line_string
-    Sablon.content(:string, "a normal string").append_to @paragraph, @node, @env
+    Sablon.content(:string, 'a normal string').append_to @paragraph, @node, @env
 
     output = <<-XML.strip
-<w:p><span>template</span><span>a normal string</span></w:p><w:p>AFTER</w:p>
+      <w:p><w:r><w:t>template</w:t><w:t>a normal string</w:t></w:r></w:p><w:p>AFTER</w:p>
     XML
     assert_xml_equal output, @document
   end
@@ -101,7 +115,7 @@ class ContentStringTest < Sablon::TestCase
     Sablon.content(:string, 42).append_to @paragraph, @node, @env
 
     output = <<-XML.strip
-<w:p><span>template</span><span>42</span></w:p><w:p>AFTER</w:p>
+      <w:p><w:r><w:t>template</w:t><w:t>42</w:t></w:r></w:p><w:p>AFTER</w:p>
     XML
     assert_xml_equal output, @document
   end
@@ -109,53 +123,118 @@ class ContentStringTest < Sablon::TestCase
   def test_string_with_newlines
     Sablon.content(:string, "a\nmultiline\n\nstring").append_to @paragraph, @node, @env
 
-    output = <<-XML.strip.gsub("\n", "")
-<w:p>
-<span>template</span>
-<span>a</span>
-<w:br/>
-<span>multiline</span>
-<w:br/>
-<w:br/>
-<span>string</span>
-</w:p>
-<w:p>AFTER</w:p>
+    output = <<-XML.gsub(/\s/, '')
+      <w:p>
+        <w:r>
+          <w:t>template</w:t>
+          <w:t>a</w:t>
+          <w:br/>
+          <w:t>multiline</w:t>
+          <w:br/>
+          <w:br/>
+          <w:t>string</w:t>
+        </w:r>
+      </w:p><w:p>AFTER</w:p>
     XML
 
     assert_xml_equal output, @document
   end
 
   def test_blank_string
-    Sablon.content(:string, "").append_to @paragraph, @node, @env
+    Sablon.content(:string, '').append_to @paragraph, @node, @env
 
     assert_xml_equal @template_text, @document
   end
 end
 
 class ContentWordMLTest < Sablon::TestCase
-  include ContentTestSetup
+  include XmlContentTestSetup
 
   def test_blank_word_ml
-    Sablon.content(:word_ml, "").append_to @paragraph, @node, @env
+    # blank strings in word_ml are an odd corner case, they get treated
+    # as inline so the paragraph is retained but the display node is still
+    # removed with nothing being inserted in it's place. Nokogiri automatically
+    # collapsed the empty <w:p></w:P> tag into a <w:/p> form.
+    Sablon.content(:word_ml, '').append_to @paragraph, @node, @env
+    assert_xml_equal "<w:p/><w:p>AFTER</w:p>", @document
+  end
 
-    assert_xml_equal "<w:p>AFTER</w:p>", @document
+  def test_plain_text_word_ml
+    # text isn't a valid child element of a w:p tag, so the whole paragraph
+    # gets replaced.
+    Sablon.content(:word_ml, "test").append_to @paragraph, @node, @env
+    assert_xml_equal "test<w:p>AFTER</w:p>", @document
   end
 
-  def test_inserts_word_ml_into_the_document
+  def test_inserts_paragraph_word_ml_into_the_document
     @word_ml = '<w:p><w:r><w:t xml:space="preserve">a </w:t></w:r></w:p>'
     Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
 
-    output = <<-XML.strip.gsub("\n", "")
-<w:p>
-<w:r><w:t xml:space=\"preserve\">a </w:t></w:r>
-</w:p>
-<w:p>AFTER</w:p>
+    output = <<-XML.gsub(/^\s+|\n/, '')
+      <w:p>
+        <w:r><w:t xml:space=\"preserve\">a </w:t></w:r>
+      </w:p>
+      <w:p>AFTER</w:p>
+    XML
+
+    assert_xml_equal output, @document
+  end
+
+  def test_inserts_inline_word_ml_into_the_document
+    @word_ml = '<w:r><w:t xml:space="preserve">inline text </w:t></w:r>'
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
+
+    output = <<-XML.gsub(/^\s+|\n/, '')
+      <w:p>
+        <w:r><w:t xml:space="preserve">inline text </w:t></w:r>
+      </w:p>
+      <w:p>AFTER</w:p>
     XML
 
     assert_xml_equal output, @document
   end
 
   def test_inserting_word_ml_multiple_times_into_same_paragraph
-    skip "Content::WordML currently removes the paragraph..."
+    @word_ml = '<w:r><w:t xml:space="preserve">inline text </w:t></w:r>'
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
+    @word_ml = '<w:r><w:t xml:space="preserve">inline text2 </w:t></w:r>'
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
+    @word_ml = '<w:r><w:t xml:space="preserve">inline text3 </w:t></w:r>'
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
+
+    # Only a single insertion should work because the node that we insert
+    # the content afer contains a merge field that needs removed. That means
+    # in the next two appends the @node variable doesn't exist on the document
+    # tree
+    output = <<-XML.gsub(/^\s+|\n/, '')
+      <w:p>
+        <w:r><w:t xml:space="preserve">inline text </w:t></w:r>
+      </w:p>
+      <w:p>AFTER</w:p>
+    XML
+
+    assert_xml_equal output, @document
+  end
+
+  def test_inserting_multiple_runs_into_same_paragraph
+    @word_ml = <<-XML.gsub(/^\s+|\n/, '')
+      <w:r><w:t xml:space="preserve">inline text </w:t></w:r>
+      <w:r><w:t xml:space="preserve">inline text2 </w:t></w:r>
+      <w:r><w:t xml:space="preserve">inline text3 </w:t></w:r>
+    XML
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
+
+    # This works because all three runs are added as a single insertion
+    # event
+    output = <<-XML.gsub(/^\s+|\n/, '')
+      <w:p>
+        <w:r><w:t xml:space="preserve">inline text </w:t></w:r>
+        <w:r><w:t xml:space="preserve">inline text2 </w:t></w:r>
+        <w:r><w:t xml:space="preserve">inline text3 </w:t></w:r>
+      </w:p>
+      <w:p>AFTER</w:p>
+    XML
+
+    assert_xml_equal output, @document
   end
 end

data/test/fixtures/html/html_test_content.html

@@ -30,9 +30,20 @@
 </div>
 
 
+<h2>Hyper Links</h2>
+
+<div>
+    <a href="http://www.google.com">Hyperlink</a>
+    <br/>
+    <span style="font-style: bold"><a href="http://www.google.com">Hyperlink with bold style</a></span>
+    <br/>
+    <u><a href="http://www.google.com" style="color: #1022DD">Hyperlink with color and underline</a></u>
+    <br/>
+</div>
+
 <h2>Lists</h2>
 
-<ol>
+<ol>
   <li>
     Vestibulum&nbsp;
     <ol>
@@ -78,23 +89,23 @@
   Duis non porttitor nulla, ut eleifend enim. Pellentesque non tempor sem.
 </div>
 
-<div>Mauris auctor egestas arcu,&nbsp;</div>
+<div>Mauris auctor egestas arcu,&nbsp;</div>
 
 <ol>
-  <li>id venenatis nibh dignissim id.&nbsp;</li>
-  <li>In non placerat metus.&nbsp;</li>
+  <li>id venenatis nibh dignissim id.&nbsp;</li>
+  <li>In non placerat metus.&nbsp;</li>
 </ol>
 
-<ul>
-  <li>Nunc sed consequat metus.&nbsp;</li>
-  <li>Nulla consectetur lorem consequat,&nbsp;</li>
-  <li>malesuada dui at, lacinia lectus.&nbsp;</li>
+<ul>
+  <li>Nunc sed consequat metus.&nbsp;</li>
+  <li>Nulla consectetur lorem consequat,&nbsp;</li>
+  <li>malesuada dui at, lacinia lectus.&nbsp;</li>
 </ul>
 
-<ol>
-  <li>Aliquam efficitur&nbsp;</li>
-  <li>lorem a mauris feugiat,&nbsp;</li>
-  <li>at semper eros pellentesque.&nbsp;</li>
+<ol>
+  <li>Aliquam efficitur&nbsp;</li>
+  <li>lorem a mauris feugiat,&nbsp;</li>
+  <li>at semper eros pellentesque.&nbsp;</li>
 </ol>
 
 <div>
@@ -105,7 +116,7 @@
   tristique ultrices elit. Nulla in turpis nibh.
 </div>
 
-<ul>
+<ul>
   <li>
     Nam consectetur&nbsp;
     <ul>
@@ -133,14 +144,14 @@
   <li>Duis faucibus nunc nec venenatis faucibus.&nbsp;</li>
   <li>Aliquam erat volutpat.&nbsp;</li>
 </ul>
-<div style="border: 5px double #FF00FF">
+<div style="border: 5px double #FF00FF">
   <strong>Quisque non neque ut lacus eleifend volutpat quis sed lacus.
   <br />Praesent ultrices purus eu quam elementum, sit amet faucibus elit
   interdum. In lectus orci,<br /> elementum quis dictum ac, porta ac ante.
   Fusce tempus ac mauris id cursus. Phasellus a erat nulla. <em>Mauris dolor orci</em>,
   malesuada auctor dignissim non, <u>posuere nec odio</u>. Etiam hendrerit
   justo nec diam ullamcorper, nec blandit elit sodales.</strong>
-</div>
+</div>
 
 
 <div style="text-align: both; background-color: #EAFEDA; vertical-align: top">
@@ -172,3 +183,83 @@
   </ul>
   <li>Item 3</li>
 </ul>
+
+
+<h2>Tables</h2>
+
+<table>
+    <caption>Table 1: Example</caption>
+    <tr>
+        <th>Head Cell 1</th>
+        <th>Head Cell 2</th>
+    </tr>
+    <tr>
+        <td>Data Cell 1</td>
+        <td>Data Cell 2</td>
+    </tr>
+</table>
+
+<p>
+    <br/>
+    <br/>
+</p>
+
+<table style="border: 1px solid #FF0000">
+    <caption style="caption-side: bottom; highlight: cyan; text-align: center">
+        Table 1: Example With Formatting
+    </caption>
+    <thead>
+        <tr style="border: 1px solid #FF00FF">
+            <th>Head Cell 1</th>
+            <th>Head Cell 2</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr style="border: 1px solid #0000FF">
+            <td style="color: #FFAA22">Data Cell 1</td>
+            <td style="background-color: #123456">Data Cell 2</td>
+        </tr>
+    </tbody>
+    <tfoot>
+        <tr>
+            <td>Data Cell 3</td>
+            <td>Data Cell 4</td>
+        </tr>
+    </tfoot>
+</table>
+
+<table style="border: 1px solid #000000; width: 4000dxa">
+    <tr>
+        <td>Above paragraph tag<p>In paragraph</p>below paragraph tag</td>
+
+        <td>
+            <ul>
+                <li>Item A</li>
+                <li>Item B</li>
+            </ul>
+            <a href="http://www.github.com" style="color: #0000dd">GitHub</a>
+        </td>
+    </tr>
+
+    <tr>
+        <td>
+            <ol>
+                <li>Item 1</li>
+                <li>Item 2
+                    <ol>
+                        <li>Item 2a</li>
+                        <li>Item 2b</li>
+                    </ol>
+                </li>
+            </ol>
+        </td>
+
+        <td>
+            <table style="border: 1px solid #FF0000">
+                <caption style="text-align: center">Sub table header</caption>
+                <tr><td>A</td><td>B</td></tr>
+                <tr><td>C</td><td>D</td></tr>
+            </table>
+        </td>
+    </tr>
+</table>