sablon 0.0.21 → 0.0.22

data/lib/sablon/version.rb

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

data/sablon.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Sablon::VERSION
   spec.authors       = ["Yves Senn"]
   spec.email         = ["yves.senn@gmail.com"]
-  spec.summary       = %q{docx tempalte processor}
+  spec.summary       = %q{docx template processor}
   spec.description   = %q{Sablon is a document template processor. At this time it works only with docx and MailMerge fields.}
   spec.homepage      = "http://github.com/senny/sablon"
   spec.license       = "MIT"
@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'nokogiri', ">= 1.6.0"
-  spec.add_runtime_dependency 'rubyzip', ">= 1.1"
+  spec.add_runtime_dependency 'rubyzip', ">= 1.1.1"
 
   spec.add_development_dependency "bundler", ">= 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "minitest", "~> 5.4"
   spec.add_development_dependency "xml-simple"
 end

data/test/configuration_test.rb

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+require "test_helper"
+
+class ConfigurationTest < Sablon::TestCase
+  def setup
+    super
+    @config = Sablon::Configuration.send(:new)
+  end
+
+  def test_register_tag
+    options = {
+      ast_class: :paragraph,
+      attributes: { dummy: 'value' },
+      properties: { pstyle: 'ListBullet' },
+      allowed_children: %i[_inline ol ul li]
+    }
+    # test initialization without type
+    tag = @config.register_html_tag(:test_tag, **options)
+    assert_equal @config.permitted_html_tags[:test_tag], tag
+    assert_equal tag.name, :test_tag
+    assert_equal tag.type, :inline
+    assert_equal tag.ast_class, Sablon::HTMLConverter::Paragraph
+    assert_equal tag.attributes, dummy: 'value'
+    assert_equal tag.properties, pstyle: 'ListBullet'
+    assert_equal tag.allowed_children, %i[_inline ol ul li]
+
+    # test initialization with type
+    tag = @config.register_html_tag('test_tag2', :block, **options)
+    assert_equal @config.permitted_html_tags[:test_tag2], tag
+    assert_equal tag.name, :test_tag2
+    assert_equal tag.type, :block
+  end
+
+  def test_remove_tag
+    tag = @config.register_html_tag(:test)
+    assert_equal @config.remove_html_tag(:test), tag
+    assert_nil @config.permitted_html_tags[:test]
+  end
+
+  def test_register_style_converter_on_existing_ast_class
+    converter = ->(v) { return "test-attr-#{v}" }
+    @config.register_style_converter(:run, 'my-test-attr', converter)
+    #
+    assert @config.defined_style_conversions[:run]['my-test-attr'], 'converter should be stored in hash'
+    assert_equal 'test-attr-123', @config.defined_style_conversions[:run]['my-test-attr'].call(123)
+  end
+
+  def test_register_style_converter_on_newast_class
+    converter = ->(v) { return "test-attr-#{v}" }
+    @config.register_style_converter(:unset_ast_class, 'my-test-attr', converter)
+    #
+    assert @config.defined_style_conversions[:unset_ast_class]['my-test-attr'], 'converter should be stored in hash'
+  end
+
+  def test_remove_style_converter
+    converter = ->(v) { return "test-attr-#{v}" }
+    converter = @config.register_style_converter(:run, 'my-test-attr', converter)
+    #
+    assert_equal converter, @config.remove_style_converter(:run, 'my-test-attr')
+    assert_nil @config.defined_style_conversions[:run]['my-test-attr']
+  end
+end
+
+class ConfigurationHTMLTagTest < Sablon::TestCase
+  # test basic instantiation of an HTMLTag
+  def test_html_tag_defaults
+    tag = Sablon::Configuration::HTMLTag.new(:a, :inline)
+    assert_equal tag.name, :a
+    assert_equal tag.type, :inline
+    assert_nil tag.ast_class
+    assert_equal tag.attributes, {}
+    assert_equal tag.properties, {}
+    assert_equal tag.allowed_children, %i[_inline ol ul]
+  end
+
+  # Exercising more of the logic used to conform args into valid
+  def test_html_tag_full_init
+    args = ['a', 'inline', ast_class: Sablon::HTMLConverter::Run]
+    tag = Sablon::Configuration::HTMLTag.new(*args)
+    assert_equal tag.name, :a
+    assert_equal tag.type, :inline
+    assert_equal tag.ast_class, Sablon::HTMLConverter::Run
+    #
+    options = {
+      ast_class: :run,
+      attributes: { dummy: 'value1' },
+      properties: { dummy2: 'value2' },
+      allowed_children: 'text'
+    }
+    tag = Sablon::Configuration::HTMLTag.new('a', 'inline', **options)
+    #
+    assert_equal tag.name, :a
+    assert_equal tag.type, :inline
+    assert_equal tag.ast_class, Sablon::HTMLConverter::Run
+    assert_equal tag.attributes, dummy: 'value1'
+    assert_equal tag.properties, dummy2: 'value2'
+    assert_equal tag.allowed_children, [:text]
+  end
+
+  def test_html_tag_init_block_without_class
+    e = assert_raises ArgumentError do
+      Sablon::Configuration::HTMLTag.new(:form, :block)
+    end
+    assert_equal "Block level tag form must have an AST class.", e.message
+  end
+
+  def test_html_tag_allowed_children
+    # define different tags for testing
+    text = Sablon::Configuration::HTMLTag.new(:text, :inline)
+    div = Sablon::Configuration::HTMLTag.new(:div, :block, ast_class: :paragraph)
+    olist = Sablon::Configuration::HTMLTag.new(:ol, :block, ast_class: :paragraph, allowed_children: %i[_block])
+
+    # test default allowances
+    assert div.allowed_child?(text) # all inline elements allowed
+    assert div.allowed_child?(olist) # tag name is included even though it is bock leve
+    assert_equal div.allowed_child?(div), false # other block elms are not allowed
+
+    # test olist with allowances for all blocks but no inline
+    assert olist.allowed_child?(div) # all block elements allowed
+    assert_equal olist.allowed_child?(text), false # no inline elements
+  end
+end

data/test/content_test.rb

@@ -76,6 +76,7 @@ module ContentTestSetup
     @document = Nokogiri::XML.fragment(@template_text)
     @paragraph = @document.children.first
     @node = @document.css("span").first
+    @env = Sablon::Environment.new(nil)
   end
 
   private
@@ -88,7 +89,7 @@ class ContentStringTest < Sablon::TestCase
   include ContentTestSetup
 
   def test_single_line_string
-    Sablon.content(:string, "a normal string").append_to @paragraph, @node
+    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>
@@ -97,7 +98,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_numeric_string
-    Sablon.content(:string, 42).append_to @paragraph, @node
+    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>
@@ -106,7 +107,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_string_with_newlines
-    Sablon.content(:string, "a\nmultiline\n\nstring").append_to @paragraph, @node
+    Sablon.content(:string, "a\nmultiline\n\nstring").append_to @paragraph, @node, @env
 
     output = <<-XML.strip.gsub("\n", "")
 <w:p>
@@ -125,7 +126,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_blank_string
-    Sablon.content(:string, "").append_to @paragraph, @node
+    Sablon.content(:string, "").append_to @paragraph, @node, @env
 
     assert_xml_equal @template_text, @document
   end
@@ -135,14 +136,14 @@ class ContentWordMLTest < Sablon::TestCase
   include ContentTestSetup
 
   def test_blank_word_ml
-    Sablon.content(:word_ml, "").append_to @paragraph, @node
+    Sablon.content(:word_ml, "").append_to @paragraph, @node, @env
 
     assert_xml_equal "<w:p>AFTER</w:p>", @document
   end
 
   def test_inserts_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
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node, @env
 
     output = <<-XML.strip.gsub("\n", "")
 <w:p>

data/test/context_test.rb

@@ -1,28 +1,28 @@
 # -*- coding: utf-8 -*-
 require "test_helper"
 
-class ContextTest < Sablon::TestCase
+class EnvironmentTest < Sablon::TestCase
   def test_converts_symbol_keys_to_string_keys
-    transformed = Sablon::Context.transform({a: 1, b: {c: 2, "d" => 3}})
-    assert_equal({"a"=>1, "b"=>{"c" =>2, "d"=>3}}, transformed)
+    context = Sablon::Context.transform_hash(a: 1, b: { c: 2, "d" => 3 })
+    assert_equal({ "a" => 1, "b" => { "c" => 2, "d" => 3 } }, context)
   end
 
   def test_recognizes_wordml_keys
-    transformed = Sablon::Context.transform({"word_ml:mykey" => "<w:p><w:p>", "otherkey" => "<nope>"})
-    assert_equal({ "mykey"=>Sablon.content(:word_ml, "<w:p><w:p>"),
-                   "otherkey"=>"<nope>"}, transformed)
+    context = Sablon::Context.transform_hash("word_ml:mykey" => "<w:p><w:p>", "otherkey" => "<nope>")
+    assert_equal({ "mykey" => Sablon.content(:word_ml, "<w:p><w:p>"),
+                   "otherkey" => "<nope>"}, context)
   end
 
   def test_recognizes_html_keys
-    transformed = Sablon::Context.transform({"html:mykey" => "**yay**", "otherkey" => "<nope>"})
-    assert_equal({ "mykey"=>Sablon.content(:html, "**yay**"),
-                   "otherkey"=>"<nope>"}, transformed)
+    context = Sablon::Context.transform_hash("html:mykey" => "**yay**", "otherkey" => "<nope>")
+    assert_equal({ "mykey" => Sablon.content(:html, "**yay**"),
+                   "otherkey" => "<nope>"}, context)
   end
 
   def test_does_not_wrap_html_and_wordml_with_nil_value
-    transformed = Sablon::Context.transform({"html:mykey" => nil, "word_ml:otherkey" => nil, "normalkey" => nil})
+    context = Sablon::Context.transform_hash("html:mykey" => nil, "word_ml:otherkey" => nil, "normalkey" => nil)
     assert_equal({ "mykey" => nil,
                    "otherkey" => nil,
-                   "normalkey" => nil}, transformed)
+                   "normalkey" => nil}, context)
   end
 end

data/test/environment_test.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require "test_helper"
+
+class EnvironmentTest < Sablon::TestCase
+  def test_transforms_internal_hash
+    context = Sablon::Context.transform_hash(a: 1, b: { c: 2, "d" => 3 })
+    env = Sablon::Environment.new(nil, a: 1, b: { c: 2, "d" => 3 })
+    #
+    assert_nil env.template
+    assert_equal context, env.context
+  end
+
+  def test_alter_context
+    # set initial context
+    env = Sablon::Environment.new(nil, a: 1, b: { c: 2, "d" => 3 })
+    # alter context to change a single key and set a new one
+    env2 = env.alter_context(a: "a", e: "new-key")
+    assert_equal({ "a" => "a", "b" => { "c" => 2, "d" => 3 }, "e" => "new-key" }, env2.context)
+    # check that the old context was not modified
+    assert_equal({"a" => 1, "b" => { "c" => 2, "d" => 3 }}, env.context)
+    # check that numbering and template are the same references
+    assert env.template.equal?(env2.template), "#{env.template} != #{env2.template}"
+    assert env.numbering.equal?(env2.numbering), "#{env.numbering} != #{env2.numbering}"
+    # check that a new context reference was created
+    assert !env.context.equal?(env2.context), "#{env.context} == #{env2.context}"
+  end
+end

data/test/expression_test.rb

@@ -55,7 +55,7 @@ class LookupOrMethodCallTest < Sablon::TestCase
   def test_missing_receiver
     user = OpenStruct.new(first_name: "Jack")
     expr = Sablon::Expression.parse("user.address.line_1")
-    assert_equal nil, expr.evaluate("user" => user)
-    assert_equal nil, expr.evaluate({})
+    assert_nil expr.evaluate("user" => user)
+    assert_nil expr.evaluate({})
   end
 end

data/test/fixtures/html/html_test_content.html

@@ -0,0 +1,174 @@
+<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>. <span>Duis urna <b>justo</b>,
+  <i>vehicula</i> vitae ultricies vel, congue at sem.</span> 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 <s><sup>egestas</sup>, <sub>volutpat</sub></s>
+  nisi vel, mattis justo. Nullam pellentesque, ipsum eget blandit pharetra,
+  augue elit <sup>aliquam <sub>mauris</sub></sup>, vel mollis nisl augue ut
+  <s>ipsum</s>.
+</div>
+
+<h2>HTML Entities</h2>
+<div>
+    All HTML entities should get passed through to the final doc <br/>
+    Less Than: &lt; <br/>
+    Ampersand: &amp; <br/>
+    Percent: &#37; <br/>
+    One Quarter: &frac14; <br/>
+</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 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 style="text-align: both; background-color: #EAFEDA; vertical-align: top">
+  <span style="font-size: 24;">U</span>t eget auctor enim.
+  <span style="text-decoration: underline wavyDouble #123456">Quisque id
+  neque eu nibh feugiat <b style="text-decoration: line-through">imperdiet</b>
+  id ut dui.</span> Ut auctor libero eget <em style="text-decoration: emboss; color: #F3AADE">
+  massa tristique pharetra</em>. Cras tincidunt finibus sapien, ut maximus
+  tortor tempor at. <span style="background-color: #00FF00">Proin pulvinar
+  pretium</span> justo vitae malesuada. Suspendisse porta purus eget tortor
+  tincidunt vestibulum. Maecenas id egestas purus, quis vulputate
+  lacus. Quisque <span style="vertical-align: superscript">non</span>
+  <span style="vertical-align: subscript">eleifend</span> est.
+</div>
+
+<ul style="background-color: #F19F42">
+  <li>Item 1</li>
+  <li>Item 2</li>
+  <ul>
+    <li>Nested 1</li>
+    <li style="background-color: #FFAAAA">
+      Nested 2
+      <ul>
+        <li>Nested 2.1</li>
+        <li><span style="font-style: italic; font-weight: bold">Nested</span> 2.2</li>
+        <li>Nested 2.3</li>
+      </ul>
+    </li>
+  </ul>
+  <li>Item 3</li>
+</ul>