sablon 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c2c9b769fd159749fb61b9b78230df84538365
-  data.tar.gz: 579139d21b1b06e6dd7ee1dca688b766269fd932
+  metadata.gz: 698e85a00ad9dace7dd51e7cf8887d59612edf60
+  data.tar.gz: 06fefc2d6ae9d747ca0d5cad4aca1cef80036cbd
 SHA512:
-  metadata.gz: ab4593d0368b40eb82a3daa381d0121ca2b8e339a9e195980ef8afc6f75f063ad88f2f7753e8075107c13d67ca831436bd849e5e7ccb118d690659a6d3129908
-  data.tar.gz: f419b97772e4572e5b567eb649eef3471a78b1fcede8e50962142988ab603c3bc428e2503b32f29e2676a22d1a2c37a49315e79d4115cada442248754686eab6
+  metadata.gz: f86083620b300bd83e48721ba92cd9909556692bec0362990997c8f1f9c7b78155929628a104995ba8c586e90afce5c8505eedeb3cc84ac6e23c347afae02c09
+  data.tar.gz: 4c2320a98d95071d4ea0ee3d9ec88f3cd7ba93f6618b016c3a97eb94339d7850561bf51bba5e1821b0d2f93d06123de06f41d1a35e381f240875416e46f47c05

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    sablon (0.0.19)
+    sablon (0.0.20)
       nokogiri (>= 1.6.0)
-      redcarpet (>= 3.2)
       rubyzip (>= 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    mini_portile2 (2.0.0)
+    mini_portile2 (2.1.0)
     minitest (5.8.0)
-    nokogiri (1.6.7.1)
-      mini_portile2 (~> 2.0.0.rc2)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
     rake (10.4.2)
-    redcarpet (3.3.3)
-    rubyzip (1.1.7)
+    rubyzip (1.2.0)
     xml-simple (1.1.5)
 
 PLATFORMS
@@ -29,4 +29,4 @@ DEPENDENCIES
   xml-simple
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

data/README.md

@@ -24,7 +24,7 @@ require "sablon"
 template = Sablon.template(File.expand_path("~/Desktop/template.docx"))
 context = {
   title: "Fabulous Document",
-  technologies: ["Ruby", "Markdown", "ODF"]
+  technologies: ["Ruby", "HTML", "ODF"]
 }
 template.render_to_file File.expand_path("~/Desktop/output.docx"), context
 ```
@@ -100,54 +100,6 @@ IMPORTANT: This feature is very much *experimental*. Currently, the insertion
     will replace the containing paragraph. This means that other content in the same
     paragraph is discarded.
 
-##### Markdown [deprecated]
-
-IMPORTANT: Markdown insertion has been deprecated in favor of HTML
-    insertion. For now the behavior is still packaged with sablon. Note that the
-    implementation of `Sablon::Content::Markdown` is already based on
-    `Sablon::Content::HTML`. Markdown insertion will be removed in the future.
-
-Similar to WordProcessingML it's possible to use markdown while processing the
-tempalte. You don't need to modify your templates, a simple insertion operation
-is sufficient:
-
-```
-«=article.body»
-```
-
-To use Markdown insertion prepare the context like so:
-
-```ruby
-markdown_body = <<-MD
-This text can contain *additional formatting*
-according to the **Markdown** specification.
-MD
-context = {
-  article: { body: Sablon.content(:markdown, markdown_body) }
-}
-template.render_to_file File.expand_path("~/Desktop/output.docx"), context
-```
-
-Markdown insertion has built-in support for:
-
-* [Headers](http://spec.commonmark.org/0.17/#atx-header)
-* [Paragraphs](http://spec.commonmark.org/0.17/#paragraphs)
-* [Emphasis and strong emphasis](http://spec.commonmark.org/0.17/#emphasis-and-strong-emphasis)
-* [Hard line breaks](http://spec.commonmark.org/0.17/#hard-line-breaks)
-* [Lists](http://spec.commonmark.org/0.17/#lists)
-
-For headings and lists to function properly it is necessary that the template
-defines specific styles. Headings use styles called `Heading1`, `Heading2`,
-etc. according to the header level. Ordered lists will use the style
-`ListNumber` and unordered lists use `ListBullet`. Nested lists are not
-supported. Normal text paragraphs use the style `Paragraph`. It's not necessary
-to have that style in the template. Word will fall back to using the `Normal` style.
-
-IMPORTANT: This feature is very much *experimental*. Currently, the insertion
-    will replace the containing paragraph. This means that other content in the same
-    paragraph is discarded. In the near future this feature will most likely be
-    implemented on top of HTML insertion.
-
 ##### HTML [experimental]
 
 Similar to WordProcessingML it's possible to use html as input while processing the

data/lib/sablon.rb

@@ -14,8 +14,6 @@ require "sablon/operations"
 require "sablon/html/converter"
 require "sablon/content"
 
-require 'redcarpet'
-
 module Sablon
   class TemplateError < ArgumentError; end
   class ContextError < ArgumentError; end

data/lib/sablon/content.rb

@@ -77,23 +77,6 @@ module Sablon
       end
     end
 
-    class Markdown < Struct.new(:word_ml)
-      include Sablon::Content
-      def self.id; :markdown end
-      def self.wraps?(value) false end
-
-      def initialize(markdown)
-        warn "[DEPRECATION] `Sablon::Content::Markdown` is deprecated.  Please use `Sablon::Content::HTML` instead."
-        redcarpet = ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML.new)
-        word_ml = Sablon.content(:html, redcarpet.render(markdown))
-        super word_ml
-      end
-
-      def append_to(*args)
-        word_ml.append_to(*args)
-      end
-    end
-
     class HTML < Struct.new(:word_ml)
       include Sablon::Content
       def self.id; :html end
@@ -112,7 +95,6 @@ module Sablon
 
     register Sablon::Content::String
     register Sablon::Content::WordML
-    register Sablon::Content::Markdown
     register Sablon::Content::HTML
   end
 end

data/lib/sablon/parser/mail_merge.rb

@@ -73,6 +73,7 @@ module Sablon
         end
 
         def replace(content)
+          remove_extra_runs!
           replace_field_display(@node, content)
           @node.replace(@node.children)
         end
@@ -89,6 +90,11 @@ module Sablon
           @node
         end
         alias_method :end_node, :start_node
+
+        private
+        def remove_extra_runs!
+          @node.search(".//w:r")[1..-1].each(&:remove)
+        end
       end
 
       def parse_fields(xml)

data/lib/sablon/version.rb

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

data/sablon.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'nokogiri', ">= 1.6.0"
   spec.add_runtime_dependency 'rubyzip', ">= 1.1"
-  spec.add_runtime_dependency 'redcarpet', ">= 3.2"
 
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "rake", "~> 10.0"

data/test/content_test.rb

@@ -158,47 +158,3 @@ class ContentWordMLTest < Sablon::TestCase
     skip "Content::WordML currently removes the paragraph..."
   end
 end
-
-
-class ContentMarkdownTest < Sablon::TestCase
-  include ContentTestSetup
-
-  def test_is_deprecated
-    previous_stderr, $stderr = $stderr, StringIO.new
-    Sablon.content(:markdown, "")
-    assert_equal "[DEPRECATION] `Sablon::Content::Markdown` is deprecated.  Please use `Sablon::Content::HTML` instead.\n", $stderr.string
-  ensure
-    $stderr = previous_stderr
-  end
-
-  def test_blank_markdown
-    Sablon.content(:markdown, "").append_to @paragraph, @node
-
-    assert_xml_equal "<w:p>AFTER</w:p>", @document
-  end
-
-  def test_inserts_markdown
-    Sablon.content(:markdown, "yay **bold** text").append_to @paragraph, @node
-
-    output = <<-XML.strip.gsub("\n", "")
-<w:p>
-<w:pPr><w:pStyle w:val=\"Paragraph\"/></w:pPr>
-<w:r><w:t xml:space=\"preserve\">yay </w:t></w:r>
-<w:r>
-<w:rPr><w:b/></w:rPr>
-<w:t xml:space=\"preserve\">bold</w:t>
-</w:r>
-<w:r>
-<w:t xml:space=\"preserve\"> text</w:t>
-</w:r>
-</w:p>
-<w:p>AFTER</w:p>
-    XML
-
-    assert_xml_equal output, @document
-  end
-
-  def test_inserting_markdown_multiple_times_into_same_paragraph
-    skip "Content::Markdown currently removes the paragraph..."
-  end
-end

data/test/context_test.rb

@@ -13,14 +13,14 @@ class ContextTest < Sablon::TestCase
                    "otherkey"=>"<nope>"}, transformed)
   end
 
-  def test_recognizes_markdown_keys
-    transformed = Sablon::Context.transform({"markdown:mykey" => "**yay**", "otherkey" => "<nope>"})
-    assert_equal({ "mykey"=>Sablon.content(:markdown, "**yay**"),
+  def test_recognizes_html_keys
+    transformed = Sablon::Context.transform({"html:mykey" => "**yay**", "otherkey" => "<nope>"})
+    assert_equal({ "mykey"=>Sablon.content(:html, "**yay**"),
                    "otherkey"=>"<nope>"}, transformed)
   end
 
-  def test_does_not_wrap_markdown_and_wordml_with_nil_value
-    transformed = Sablon::Context.transform({"markdown:mykey" => nil, "word_ml:otherkey" => nil, "normalkey" => nil})
+  def test_does_not_wrap_html_and_wordml_with_nil_value
+    transformed = Sablon::Context.transform({"html:mykey" => nil, "word_ml:otherkey" => nil, "normalkey" => nil})
     assert_equal({ "mykey" => nil,
                    "otherkey" => nil,
                    "normalkey" => nil}, transformed)

data/test/fixtures/recipe_context.json

@@ -13,7 +13,7 @@
   },
   "title": "Bruschetta",
   "word_ml:intro": "<w:p><w:r><w:rPr><w:b/></w:rPr><w:t xml:space=\"preserve\">Bruschetta</w:t></w:r><w:r><w:t xml:space=\"preserve\"> </w:t></w:r><w:r><w:rPr><w:i/></w:rPr><w:t xml:space=\"preserve\">(Italian pronunciation: [bruˈsketta])</w:t></w:r><w:r><w:t xml:space=\"preserve\"> is an antipasto (starter dish) from Italy consisting of grilled bread rubbed with garlic and topped with tomatoes, olive oil, salt and pepper. Variations may include toppings of tomato, vegetables, beans, cured meat, or cheese, a popular dish is Bruschetta pomodoro; the most popular recipe outside of Italy involves basil, fresh tomato, garlic and onion or mozzarella. Bruschetta is usually served as a snack or appetizer. In some countries, a topping of chopped tomato, olive oil and herbs is marketed under the bruschetta name.</w:t></w:r></w:p>",
-  "markdown:preparation": "## How to make Baby's Bruschetta\n\n### Preparation\nMake the bruschetta mixture one day before the event and let it sit in the fridge overnight to absorb all the flavours(be aware your fridge will smell entirely like the *tomatoes* and *garlic*\n\nI find it works best to slice the *baguette* on an angle to create more space. Put the broiler on the oven on to toast the bread. Line them up on a baking sheet and make a small mixture of chopped garlic and olive oil to lightly spread on the slices of *baguette*, then place into the oven.\n\nOnce Half toasted remove bread and place bruschetta mixture on top (after draining off the majority of fluid). Then sprinkle the grated cheese on top and place back into the oven to broil/toast to your desired effect.  ~ Please note that if you prefer to not have your *cheese* melted you can skip this step and just toast the bread fully, add the mixture and *cheese* and serve.\n\nOnce melted, remove and place directly on a serving platter and let rest for one minute while adding fresh chopped *basil* for garnish, and **ENJOY!**\n\n### Variations\n\n1. Use fresh oregano instead of basil.\n1. Other possible toppings: prosciutto, salami, bean spreads\n\n### Notes\n- In **Italy**, bruschetta is often prepared using a brustolina grill. In the Abruzzo region of Italy a variation of bruschetta made with a salame called *ventricina* is served.\n- In **Tuscany** it is called *fettunta* and it is usually served without toppings,  \nespecially in November, to taste the very first oil of the season.\n- The chinese translation of 'Bruschetta' is '大蒜麵包' (Google Translator)",
+  "html:preparation": "<h2>How to make Baby's Bruschetta</h2>\n<h3>Preparation</h3><p>Make the bruschetta mixture one day before the event and let it sit in the fridge overnight to absorb all the flavours(be aware your fridge will smell entirely like the <i>tomatoes</i> and <i>garlic</i></p><p>I find it works best to slice the <i>baguette</i> on an angle to create more space. Put the broiler on the oven on to toast the bread. Line them up on a baking sheet and make a small mixture of chopped garlic and olive oil to lightly spread on the slices of <i>baguette</i>, then place into the oven.</p><p>Once Half toasted remove bread and place bruschetta mixture on top (after draining off the majority of fluid). Then sprinkle the grated cheese on top and place back into the oven to broil/toast to your desired effect.  ~ Please note that if you prefer to not have your <i>cheese</i> melted you can skip this step and just toast the bread fully, add the mixture and <i>cheese</i> and serve.</p><p>Once melted, remove and place directly on a serving platter and let rest for one minute while adding fresh chopped *basil* for garnish, and <strong>ENJOY!</strong></p><h3>Variations</h3><ol><li>Use fresh oregano instead of basil.</li><li>Other possible toppings: prosciutto, salami, bean spreads</li></ol><h3>Notes</h3><ul><li>In <b>Italy</b>, bruschetta is often prepared using a brustolina grill. In the Abruzzo region of Italy a variation of bruschetta made with a salame called <em>ventricina</em> is served.</li><li>In <strong>Tuscany</strong> it is called <em>fettunta</em> and it is usually served without toppings, especially in November, to taste the very first oil of the season.</li><li>The chinese translation of 'Bruschetta' is '大蒜麵包' (Google Translator)</li></ul>",
   "ingredients": [
     {"name": "Ripened, chopped, medium sized tomatoes ", "amount": "6"},
     {"name": "medium sized red (Spanish) onion", "amount": "1"},

data/test/fixtures/xml/simple_field_with_styling.xml

@@ -0,0 +1,20 @@
+<w:p>
+  <w:r><w:t xml:space="preserve">Generated by </w:t></w:r>
+  <w:fldSimple w:instr=" MERGEFIELD  =system_name  \* MERGEFORMAT ">
+    <w:r w:rsidR="002D39A9">
+      <w:rPr>
+        <w:rFonts w:hint="eastAsia"/>
+        <w:noProof/>
+      </w:rPr>
+      <w:t>«</w:t>
+    </w:r>
+    <w:r w:rsidR="002D39A9">
+      <w:rPr><w:noProof/></w:rPr>
+      <w:t>=system_name</w:t>
+    </w:r>
+    <w:r w:rsidR="002D39A9">
+      <w:rPr><w:rFonts w:hint="eastAsia"/><w:noProof/></w:rPr>
+      <w:t>»</w:t>
+    </w:r>
+  </w:fldSimple>
+</w:p>

data/test/processor/document_test.rb

@@ -40,6 +40,24 @@ class ProcessorDocumentTest < Sablon::TestCase
     document
   end
 
+  def test_simple_field_with_styling_replacement
+    result = process(snippet("simple_field_with_styling"), {"system_name" => "Sablon 1 million"})
+
+    assert_equal "Generated by Sablon 1 million", text(result)
+    assert_xml_equal <<-document, result
+    <w:p>
+      <w:r><w:t xml:space="preserve">Generated by </w:t></w:r>
+        <w:r w:rsidR="002D39A9">
+          <w:rPr>
+            <w:rFonts w:hint="eastAsia"/>
+            <w:noProof/>
+          </w:rPr>
+          <w:t>Sablon 1 million</w:t>
+        </w:r>
+    </w:p>
+    document
+  end
+
   def test_context_can_contain_string_and_symbol_keys
     result = process(snippet("simple_fields"), {"first_name" => "Jack", last_name: "Davis"})
     assert_equal "Jack Davis", text(result)

data/test/sablon_test.rb

@@ -65,7 +65,7 @@ class SablonTest < Sablon::TestCase
                   language.new("German", "fluent"),
                   language.new("French", "basics"),
                  ],
-      about_me: Sablon.content(:markdown, "I am fond of writing *short stories* and *poems* in my spare time,  \nand have won several literary contests in pursuit of my **passion**."),
+      about_me: Sablon.content(:html, "I am fond of writing <i>short stories</i> and <i>poems</i> in my spare time,  <br />and have won several literary contests in pursuit of my <b>passion</b>."),
       activities: ["Writing", "Photography", "Traveling"],
       referees: [
                  referee.new("Mary P. Larsen", "Strongbod",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -175,13 +161,13 @@ files:
 - test/fixtures/xml/paragraph_loop.xml
 - test/fixtures/xml/paragraph_loop_within_table_cell.xml
 - test/fixtures/xml/simple_field.xml
+- test/fixtures/xml/simple_field_with_styling.xml
 - test/fixtures/xml/simple_fields.xml
 - test/fixtures/xml/table_multi_row_loop.xml
 - test/fixtures/xml/table_row_loop.xml
 - test/html/converter_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
-- test/markdown_test.rb
 - test/processor/document_test.rb
 - test/sablon_test.rb
 - test/sandbox/.gitkeep
@@ -209,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: docx tempalte processor
@@ -242,13 +228,13 @@ test_files:
 - test/fixtures/xml/paragraph_loop.xml
 - test/fixtures/xml/paragraph_loop_within_table_cell.xml
 - test/fixtures/xml/simple_field.xml
+- test/fixtures/xml/simple_field_with_styling.xml
 - test/fixtures/xml/simple_fields.xml
 - test/fixtures/xml/table_multi_row_loop.xml
 - test/fixtures/xml/table_row_loop.xml
 - test/html/converter_test.rb
 - test/html_test.rb
 - test/mail_merge_parser_test.rb
-- test/markdown_test.rb
 - test/processor/document_test.rb
 - test/sablon_test.rb
 - test/sandbox/.gitkeep

data/test/markdown_test.rb

@@ -1,81 +0,0 @@
-# -*- coding: utf-8 -*-
-require "test_helper"
-require "support/xml_snippets"
-
-class SablonMarkdownTest < Sablon::TestCase
-  include Sablon::Test::Assertions
-
-  def setup
-    super
-    @base_path = Pathname.new(File.expand_path("../", __FILE__))
-
-    @sample_path = @base_path + "fixtures/markdown_sample.docx"
-  end
-
-  def test_generate_document_from_template_with_styles_and_markdown
-    template_path = @base_path + "fixtures/insertion_template.docx"
-    output_path = @base_path + "sandbox/markdown.docx"
-    template = Sablon.template template_path
-    context = {'markdown:content' => content}
-    template.render_to_file output_path, context
-
-    assert_docx_equal @sample_path, output_path
-  end
-
-  private
-  def content
-    <<-MARKDOWN
-# Sablon Markdown insertion
-
-## Text
-
-**_Lorem ipsum_ dolor sit amet, consectetur adipiscing elit. Suspendisse at libero at elit posuere convallis ac vitae augue. Morbi pretium diam et leo pulvinar, sit amet placerat mauris scelerisque.** Vivamus sollicitudin ante ligula, non egestas diam molestie at.
-
-Nunc tincidunt massa id libero mollis bibendum.
-Sed vel arcu blandit, scelerisque ex ut, semper justo.
-Nunc tempor velit a tortor lacinia, vel mattis diam sollicitudin.
-Etiam eget faucibus enim.
-
-Curabitur rutrum vestibulum nisi, vel posuere ligula commodo a. Sed nibh odio, convallis vitae orci a, cursus venenatis tellus. Duis consequat auctor elementum. Quisque blandit augue id faucibus dignissim. Aenean malesuada placerat turpis. Mauris tincidunt lorem sit amet est ultricies, eu tristique arcu dapibus. Nam ultrices vulputate tellus, quis feugiat ante faucibus non. Donec lectus est, suscipit in arcu molestie, pharetra cursus massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
-
-## Lists
-
-* Etiam vulputate elementum mi, at porta est malesuada sit amet.
-* Praesent porttitor arcu id justo dignissim, vitae dignissim lectus pharetra.
-* Curabitur efficitur mauris ac justo porta dignissim. Integer sed dui justo.
-
-Donec finibus lectus a erat pharetra dapibus.
-
-1. Nulla facilisis aliquet ex.
-1. Mauris eget ante sed purus dictum tempus eu non dolor.
-1. Aliquam finibus, leo at rutrum euismod, urna quam scelerisque ante, eu finibus dolor lectus vel ipsum.
-
-Ut id condimentum ante, eget convallis justo. Quisque accumsan porta interdum. Integer sit amet luctus felis.
-
-Nunc imperdiet, massa id ultricies porttitor, felis magna tincidunt augue, a egestas orci neque sed odio.
-
-1. Suspendisse
-  1. tempor
-    1. turpis
-      1. turpis
-    1. vitae
-  1. tristique
-    1. nulla
-      1. pulvinar
-1. nec.
-
-* Suspendisse
-  * potenti
-    * In condimentum
-    * enim ut nibh cursus imperdiet.
-  * Aliquam
-  * lacinia
-    * scelerisque
-* tristique.
-
-Phasellus consectetur placerat ornare. Nulla facilisi. Morbi fringilla est vitae pulvinar dictum. Praesent quis malesuada ex. Pellentesque posuere facilisis molestie.
-
-Maecenas pretium erat vitae neque convallis consectetur. Cras ultricies mi nec mauris consectetur, eu blandit purus mattis. Quisque ante nulla, sagittis sed interdum non, eleifend quis augue. Curabitur vestibulum quam sed blandit rhoncus. Morbi eget vestibulum felis. Nulla vitae molestie elit. Etiam sagittis lorem elit, sit amet rhoncus eros dapibus non. Praesent nec dignissim dui. Quisque quis vehicula turpis, sit amet aliquet leo. Ut urna magna, malesuada eget fringilla ut, laoreet sed diam. Maecenas a ipsum varius, efficitur eros quis, vulputate mauris.
-MARKDOWN
-  end
-end