sablon 0.0.21 → 0.0.22

data/test/html/node_properties_test.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+require "test_helper"
+
+class NodePropertiesTest < Sablon::TestCase
+  def setup
+    # struct to simplify prop whitelisting during tests
+    @inc_props = Struct.new(:props) do
+      def include?(*)
+        true
+      end
+    end
+  end
+
+  def test_empty_node_properties_converison
+    # test empty properties
+    props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', {}, @inc_props.new)
+    assert_equal props.inspect, ''
+    assert_nil props.to_docx
+  end
+
+  def test_simple_node_property_converison
+    props = { 'pStyle' => 'Paragraph' }
+    props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
+    assert_equal props.inspect, 'pStyle=Paragraph'
+    assert_equal props.to_docx, '<w:pPr><w:pStyle w:val="Paragraph" /></w:pPr>'
+  end
+
+  def test_node_property_with_nil_value_converison
+    props = { 'b' => nil }
+    props = Sablon::HTMLConverter::NodeProperties.new('w:rPr', props, @inc_props.new)
+    assert_equal props.inspect, 'b'
+    assert_equal props.to_docx, '<w:rPr><w:b /></w:rPr>'
+  end
+
+  def test_node_property_with_hash_value_converison
+    props = { 'shd' => { color: 'clear', fill: '123456', test: nil } }
+    props = Sablon::HTMLConverter::NodeProperties.new('w:rPr', props, @inc_props.new)
+    assert_equal props.inspect, 'shd={:color=>"clear", :fill=>"123456", :test=>nil}'
+    assert_equal props.to_docx, '<w:rPr><w:shd w:color="clear" w:fill="123456" /></w:rPr>'
+  end
+
+  def test_node_property_with_array_value_converison
+    props = { 'numPr' => [{ 'ilvl' => 1 }, { 'numId' => 34 }] }
+    props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
+    assert_equal props.inspect, 'numPr=[{"ilvl"=>1}, {"numId"=>34}]'
+    assert_equal props.to_docx, '<w:pPr><w:numPr><w:ilvl w:val="1" /><w:numId w:val="34" /></w:numPr></w:pPr>'
+  end
+
+  def test_complex_node_properties_conversion
+    props = {
+      'top1' => 'val1',
+      'top2' => [
+        { 'mid0' => nil },
+        { 'mid1' => [
+          { 'bottom1' => { key1: 'abc' } },
+          { 'bottom2' => 'xyz' }
+        ] },
+        { 'mid2' => 'val2' }
+      ],
+      'top3' => { key1: 1, key2: '2', key3: nil, key4: true, key5: false }
+    }
+    output = <<-DOCX.gsub(/^\s*/, '').delete("\n")
+      <w:pPr>
+        <w:top1 w:val="val1" />
+        <w:top2>
+          <w:mid0 />
+          <w:mid1>
+            <w:bottom1 w:key1="abc" />
+            <w:bottom2 w:val="xyz" />
+          </w:mid1>
+          <w:mid2 w:val="val2" />
+        </w:top2>
+        <w:top3 w:key1="1" w:key2="2" w:key4="true" />
+      </w:pPr>
+    DOCX
+    props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
+    assert_equal props.to_docx, output
+  end
+
+  def test_setting_property_value
+    props = {}
+    props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
+    props['rStyle'] = 'FootnoteText'
+    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))
+  end
+
+  def test_transferred_properties
+    props = { 'pStyle' => 'Paragraph', 'rStyle' => 'EndnoteText' }
+    props = Sablon::HTMLConverter::NodeProperties.new(nil, props, %w[pStyle])
+    trans = props.transferred_properties
+    assert_equal({ 'rStyle' => 'EndnoteText' }, trans)
+  end
+
+  def test_node_properties_paragraph_factory
+    props = { 'pStyle' => 'Paragraph' }
+    props = Sablon::HTMLConverter::NodeProperties.paragraph(props)
+    assert_equal 'pStyle=Paragraph', props.inspect
+    assert_equal props.to_docx, '<w:pPr><w:pStyle w:val="Paragraph" /></w:pPr>'
+  end
+
+  def test_node_properties_run_factory
+    props = { 'color' => 'FF00FF' }
+    props = Sablon::HTMLConverter::NodeProperties.run(props)
+    assert_equal 'color=FF00FF', props.inspect
+    assert_equal '<w:rPr><w:color w:val="FF00FF" /></w:rPr>', props.to_docx
+  end
+end

data/test/html_test.rb

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
 require "test_helper"
-require "support/xml_snippets"
+require "support/html_snippets"
 
 class SablonHTMLTest < Sablon::TestCase
   include Sablon::Test::Assertions
+  include HTMLSnippets
 
   def setup
     super
@@ -16,7 +17,7 @@ class SablonHTMLTest < Sablon::TestCase
     template_path = @base_path + "fixtures/insertion_template.docx"
     output_path = @base_path + "sandbox/html.docx"
     template = Sablon.template template_path
-    context = {'html:content' => content}
+    context = { 'html:content' => content }
     template.render_to_file output_path, context
 
     assert_docx_equal @sample_path, output_path
@@ -26,7 +27,7 @@ class SablonHTMLTest < Sablon::TestCase
     template_path = @base_path + "fixtures/insertion_template_no_styles.docx"
     output_path = @base_path + "sandbox/html_no_styles.docx"
     template = Sablon.template template_path
-    context = {'html:content' => content}
+    context = { 'html:content' => content }
 
     e = assert_raises(ArgumentError) do
       template.render_to_file output_path, context
@@ -37,13 +38,12 @@ class SablonHTMLTest < Sablon::TestCase
   end
 
   private
+
   def content
-    <<-HTML
-<h1>Sablon HTML insertion</h1>
-<h2>Text</h2>
-<div>Lorem&nbsp;<strong>ipsum</strong>&nbsp;<em>dolor</em>&nbsp;<strong>sit</strong>&nbsp;<em>amet</em>,&nbsp;<strong>consectetur adipiscing elit</strong>.&nbsp;<em>Suspendisse a tempus turpis</em>. Duis urna justo, vehicula vitae ultricies vel, congue at sem. Fusce turpis turpis, aliquet id pulvinar aliquam, iaculis non elit. Nulla feugiat lectus nulla, in dictum ipsum cursus ac. Quisque at odio neque. Sed ac tortor iaculis, bibendum leo ut, malesuada velit. Donec iaculis sed urna eget pharetra. <u>Praesent ornare fermentum turpis</u>, placerat iaculis urna bibendum vitae. Nunc in quam consequat, tristique tellus in, commodo turpis. Curabitur ullamcorper odio purus, lobortis egestas magna laoreet vitae. Nunc fringilla velit ante, eu aliquam nisi cursus vitae. Suspendisse sit amet dui egestas, volutpat nisi vel, mattis justo. Nullam pellentesque, ipsum eget blandit pharetra, augue elit aliquam mauris, vel mollis nisl augue ut ipsum.</div>
-<h2>Lists</h2>
-<ol><li>Vestibulum&nbsp;<ol><li>ante ipsum primis&nbsp;</li></ol></li><li>in faucibus orci luctus&nbsp;<ol><li>et ultrices posuere cubilia Curae;&nbsp;<ol><li>Aliquam vel dolor&nbsp;</li><li>sed sem maximus&nbsp;</li></ol></li><li>fermentum in non odio.&nbsp;<ol><li>Fusce hendrerit ornare mollis.&nbsp;</li></ol></li><li>Nunc scelerisque nibh nec turpis tempor pulvinar.&nbsp;</li></ol></li><li>Donec eros turpis,&nbsp;</li><li>aliquet vel volutpat sit amet,&nbsp;<ol><li>semper eu purus.&nbsp;</li><li>Proin ac erat nec urna efficitur vulputate.&nbsp;<ol><li>Quisque varius convallis ultricies.&nbsp;</li><li>Nullam vel fermentum eros.&nbsp;</li></ol></li></ol></li></ol><div>Pellentesque nulla leo, auctor ornare erat sed, rhoncus congue diam. Duis non porttitor nulla, ut eleifend enim. Pellentesque non tempor sem.</div><div>Mauris auctor egestas arcu,&nbsp;</div><ol><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><ol><li>Aliquam efficitur&nbsp;</li><li>lorem a mauris feugiat,&nbsp;</li><li>at semper eros pellentesque.&nbsp;</li></ol><div>Nunc lacus diam, consectetur ut odio sit amet, placerat pharetra erat. Sed commodo ut sem id congue. Sed eget neque elit. Curabitur at erat tortor. Maecenas eget sapien vitae est sagittis accumsan et nec orci. Integer luctus at nisl eget venenatis. Nunc nunc eros, consectetur at tortor et, tristique ultrices elit. Nulla in turpis nibh.</div><ul><li>Nam consectetur&nbsp;<ul><li>venenatis tempor.&nbsp;</li></ul></li><li>Aenean&nbsp;<ul><li>blandit<ul><li>porttitor massa,&nbsp;<ul><li>non efficitur&nbsp;<ul><li>metus.&nbsp;</li></ul></li></ul></li></ul></li></ul></li><li>Duis faucibus nunc nec venenatis faucibus.&nbsp;</li><li>Aliquam erat volutpat.&nbsp;</li></ul><div><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>
-HTML
+    html_str = snippet('html_test_content')
+    # combine all white space
+    html_str = html_str.gsub(/\s+/, ' ')
+    # clear any white space between block level tags and other content
+    html_str.gsub(%r{\s*<(/?(?:h\d|div|p|br|ul|ol|li).*?)>\s*}, '<\1>')
   end
 end

data/test/mail_merge_parser_test.rb

@@ -7,6 +7,7 @@ module MailMergeParser
     include DocumentXMLHelper
     def setup
       super
+      @env = Sablon::Environment.new(nil)
       @parser = Sablon::Parser::MailMerge.new
     end
 
@@ -35,7 +36,7 @@ module MailMergeParser
     end
 
     def test_replace
-      field.replace(Sablon.content(:string, "Hello"))
+      field.replace(Sablon.content(:string, "Hello"), @env)
       xml = <<-xml.strip
 <w:p>
 <w:r w:rsidR=\"004B49F0\">
@@ -70,7 +71,7 @@ xml
     end
 
     def test_replace
-      field.replace(Sablon.content(:string, "Hello"))
+      field.replace(Sablon.content(:string, "Hello"), @env)
       xml = <<-xml.strip
 <w:p>
 

data/test/processor/document_test.rb

@@ -59,7 +59,8 @@ class ProcessorDocumentTest < Sablon::TestCase
   end
 
   def test_context_can_contain_string_and_symbol_keys
-    result = process(snippet("simple_fields"), {"first_name" => "Jack", last_name: "Davis"})
+    context = {"first_name" => "Jack", last_name: "Davis"}
+    result = process(snippet("simple_fields"), context)
     assert_equal "Jack Davis", text(result)
   end
 
@@ -439,8 +440,25 @@ class ProcessorDocumentTest < Sablon::TestCase
     assert_equal "Before After", text(result)
   end
 
+  def test_comment_block_and_comment_as_key
+    result = process(snippet("comment_block_and_comment_as_key"), {comment: 'Contents of comment key'})
+
+    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:r w:rsidR="004B49F0">
+        <w:rPr><w:noProof/></w:rPr>
+        <w:t>Contents of comment key</w:t>
+      </w:r>
+    </w:p>
+    document
+  end
+
   private
+
   def process(document, context)
-    @processor.process(wrap(document), context).to_xml
+    env = Sablon::Environment.new(nil, context)
+    @processor.process(wrap(document), env).to_xml
   end
 end

data/test/section_properties_test.rb

@@ -34,7 +34,7 @@ class SectionPropertiesTest < Sablon::TestCase
 </w:body>
     documentxml
     properties = Sablon::Processor::SectionProperties.from_document(xml)
-    assert_equal nil, properties.start_page_number
+    assert_nil properties.start_page_number
     properties.start_page_number = "16"
     assert_equal "16", properties.start_page_number
   end

data/test/support/html_snippets.rb

@@ -0,0 +1,9 @@
+module HTMLSnippets
+  def snippet(name)
+    File.read(File.expand_path("#{name}.html", snippet_path))
+  end
+
+  def snippet_path
+    @snippet_path ||= File.expand_path("../../fixtures/html", __FILE__)
+  end
+end

data/test/test_helper.rb

@@ -13,6 +13,5 @@ require "sablon/test"
 class Sablon::TestCase < MiniTest::Test
   def teardown
     super
-    Sablon::Numbering.instance.reset!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -113,9 +113,13 @@ files:
 - bin/rake
 - exe/sablon
 - lib/sablon.rb
+- lib/sablon/configuration/configuration.rb
+- lib/sablon/configuration/html_tag.rb
 - lib/sablon/content.rb
 - lib/sablon/context.rb
+- lib/sablon/environment.rb
 - lib/sablon/html/ast.rb
+- lib/sablon/html/ast_builder.rb
 - lib/sablon/html/converter.rb
 - lib/sablon/html/visitor.rb
 - lib/sablon/numbering.rb
@@ -144,14 +148,17 @@ files:
 - misc/step_6.png
 - misc/step_7.png
 - sablon.gemspec
+- test/configuration_test.rb
 - test/content_test.rb
 - test/context_test.rb
+- test/environment_test.rb
 - test/executable_test.rb
 - test/expression_test.rb
 - test/fixtures/conditionals_sample.docx
 - test/fixtures/conditionals_template.docx
 - test/fixtures/cv_sample.docx
 - test/fixtures/cv_template.docx
+- test/fixtures/html/html_test_content.html
 - test/fixtures/html_sample.docx
 - test/fixtures/insertion_template.docx
 - test/fixtures/insertion_template_no_styles.docx
@@ -160,6 +167,7 @@ files:
 - test/fixtures/recipe_sample.docx
 - test/fixtures/recipe_template.docx
 - test/fixtures/xml/comment.xml
+- test/fixtures/xml/comment_block_and_comment_as_key.xml
 - test/fixtures/xml/complex_field.xml
 - test/fixtures/xml/complex_field_inline_conditional.xml
 - test/fixtures/xml/conditional.xml
@@ -177,7 +185,10 @@ files:
 - 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/ast_builder_test.rb
+- test/html/ast_test.rb
 - test/html/converter_test.rb
+- test/html/node_properties_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
 - test/processor/document_test.rb
@@ -185,6 +196,7 @@ files:
 - test/sandbox/.gitkeep
 - test/section_properties_test.rb
 - test/support/document_xml_helper.rb
+- test/support/html_snippets.rb
 - test/support/xml_snippets.rb
 - test/test_helper.rb
 homepage: http://github.com/senny/sablon
@@ -210,16 +222,19 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: docx tempalte processor
+summary: docx template processor
 test_files:
+- test/configuration_test.rb
 - test/content_test.rb
 - test/context_test.rb
+- test/environment_test.rb
 - test/executable_test.rb
 - test/expression_test.rb
 - test/fixtures/conditionals_sample.docx
 - test/fixtures/conditionals_template.docx
 - test/fixtures/cv_sample.docx
 - test/fixtures/cv_template.docx
+- test/fixtures/html/html_test_content.html
 - test/fixtures/html_sample.docx
 - test/fixtures/insertion_template.docx
 - test/fixtures/insertion_template_no_styles.docx
@@ -228,6 +243,7 @@ test_files:
 - test/fixtures/recipe_sample.docx
 - test/fixtures/recipe_template.docx
 - test/fixtures/xml/comment.xml
+- test/fixtures/xml/comment_block_and_comment_as_key.xml
 - test/fixtures/xml/complex_field.xml
 - test/fixtures/xml/complex_field_inline_conditional.xml
 - test/fixtures/xml/conditional.xml
@@ -245,7 +261,10 @@ test_files:
 - 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/ast_builder_test.rb
+- test/html/ast_test.rb
 - test/html/converter_test.rb
+- test/html/node_properties_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
 - test/processor/document_test.rb
@@ -253,5 +272,6 @@ test_files:
 - test/sandbox/.gitkeep
 - test/section_properties_test.rb
 - test/support/document_xml_helper.rb
+- test/support/html_snippets.rb
 - test/support/xml_snippets.rb
 - test/test_helper.rb