sablon 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47a5aeb4ef473eea715114b4a32f0e2a5ab63711
-  data.tar.gz: 2335675beefc2ff842609cf7be53c2146c6bb4cb
+SHA256:
+  metadata.gz: c83f07a4e1add4db3c1c12d6ffab63e53b7f0acc89e7947efa8cac8a140a35eb
+  data.tar.gz: 23b8e9d2685409410dc418f615c8a23742dbcbc58c3f7a93fcb6a594e84450bf
 SHA512:
-  metadata.gz: a66e1e936397fbc66858216b2259c4665a52d32c754c416ad71705c36d2bf2e6deff152421ee67eebce4d643ee8ecf3d543746f00a921b0533ce44dcfe5bd5ab
-  data.tar.gz: '0053920d8f9de09ab35885f68c79cc63f46f72b19874c2970c4e3b0655915c210af7f0c0836d8447c8a556955d937b9535a1abe426de4ed46444e3c3ba75a35b'
+  metadata.gz: 8bf3e622843f453b9f2f8b7b9ebbaa18560ec83ecd11ca2386a885bc497ca0149e6e9db64be4a9220a508bf625b7e81748ca636456e03f274d58883efce5453c
+  data.tar.gz: 5bfe0d0737b928420342146c8b920283f0a4c3f9fa32b585871792076df75305048e17c348c44b7ca470408a84e763c2b47ac401a7711cd5219e26270c9d310a

data/.travis.yml

@@ -1,6 +1,6 @@
+before_install:
+  - gem install bundler:1.17.2
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
+  - 2.6
+  - 2.7

data/Gemfile.lock

@@ -1,20 +1,22 @@
 PATH
   remote: .
   specs:
-    sablon (0.3.1)
-      nokogiri (>= 1.6.0)
-      rubyzip (>= 1.1.1)
+    sablon (0.4.0)
+      nokogiri (>= 1.8.5)
+      rubyzip (>= 1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    mini_portile2 (2.3.0)
-    minitest (5.10.3)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    rake (12.3.0)
-    rubyzip (1.2.2)
-    xml-simple (1.1.5)
+    minitest (5.20.0)
+    nokogiri (1.15.5)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rake (13.1.0)
+    rexml (3.2.6)
+    rubyzip (2.3.2)
+    xml-simple (1.1.9)
+      rexml
 
 PLATFORMS
   ruby
@@ -22,9 +24,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.6)
   minitest (~> 5.4)
-  rake (~> 12.0)
+  rake (~> 13.0)
   sablon!
   xml-simple
 
 BUNDLED WITH
-   1.16.0
+   2.4.15

data/README.md

@@ -192,9 +192,10 @@ html_body = <<-HTML.strip
 </table>
 HTML
 context = {
-  article: Sablon.content(:html, html_body) }
-  # alternative method using special key format
-  # 'html:article' => html_body
+  article: Sablon.content(:html, html_body) },
+  # Or use html: prefix to make sablon parse the value as HTML.
+  # Does the same as above.
+  'html:article' => html_body
 }
 template.render_to_file File.expand_path("~/Desktop/output.docx"), context
 ```
@@ -256,10 +257,14 @@ sources such as file paths, URLs, or any object that exposes a `#read`
 method that returns image data. When using a "readable object" if the object
 doesn't have a `#filename` method then a `filename: '...'` option
 needs to be added to the `Sablon.content` method call.
+
+By default the inserted image takes the dimensions of the placeholder. The size of an image can also be defined dynamically by specifying width and height with unit (cm or in) in a properties hash like  `properties: {height: "2cm", width: "20cm"}`
+
 ```ruby
 context = {
   figure: Sablon.content(:image, 'fixtures/images/c3po.jpg'),
-  figure2: Sablon.content(:image, string_io_obj, filename: 'test.png')
+  figure2: Sablon.content(:image, string_io_obj, filename: 'test.png'),
+  figure3: Sablon.content(:image, string_io_obj, filename: 'test.png', properties: {height: '2cm', width: '2cm'})
   # alternative method using special key format for simple paths and URLs
   # 'image:figure' => 'fixtures/images/c3po.jpg'
 }

data/lib/sablon/content.rb

@@ -130,11 +130,16 @@ module Sablon
       # node passed in. Run properties are merged here because of namespace
       # issues when working with a document fragment
       def add_siblings_to(node, rpr_tag = nil)
-        xml.children.reverse.each do |child|
-          node.add_next_sibling child
-          # merge properties
-          next unless rpr_tag
-          merge_rpr_tags(child, rpr_tag.children)
+        # Since Nokogiri 1.11.0 adding siblings is only possible for nodes
+        # with a parent because the parent is used as the context node for
+        # parsing markup.
+        if !node.parent.nil?
+          xml.children.reverse.each do |child|
+            node.add_next_sibling child
+            # merge properties
+            next unless rpr_tag
+            merge_rpr_tags(child, rpr_tag.children)
+          end
         end
       end
 

data/lib/sablon/processor/document/blocks.rb

@@ -86,7 +86,7 @@ module Sablon
         end
       end
 
-      class ImageBlock < ParagraphBlock
+      class ImageBlock < Block
         def self.encloses?(start_field, end_field)
           start_field.expression.start_with?('@')
         end
@@ -100,12 +100,16 @@ module Sablon
             nodes.each do |node|
               pic_prop = node.at_xpath('.//pic:cNvPr', pic: 'http://schemas.openxmlformats.org/drawingml/2006/picture')
               pic_prop.attributes['name'].value = image.name if pic_prop
-              blip = node.at_xpath('.//a:blip', a: 'http://schemas.openxmlformats.org/drawingml/2006/main')
+              blip = if File.extname(image.name) == '.svg'
+                node.at_xpath('.//asvg:svgBlip', asvg: 'http://schemas.microsoft.com/office/drawing/2016/SVG/main')
+              else
+                node.at_xpath('.//a:blip', a: 'http://schemas.openxmlformats.org/drawingml/2006/main')
+              end
               blip.attributes['embed'].value = image.local_rid if blip
               drawing_size = node.at_xpath('.//wp:extent')
 
-          # if image properties are defined, the size of the placeholder image
-          # should be replaced with the actual values
+              # if image properties are defined, the size of the placeholder
+              # image should be replaced with the actual values
               if image.width && image.height
                 drawing_size.attributes['cx'].value = image.width.to_s if drawing_size
                 drawing_size.attributes['cy'].value = image.height.to_s if drawing_size
@@ -126,6 +130,28 @@ module Sablon
           super && parent(start_field) == parent(end_field)
         end
 
+        def process(env)
+          # Create a mock document structure so xpath queries will work
+          # correctly on block level content (i.e. searching for the first
+          # ancestor paragraph)
+          doc_node = Nokogiri::XML::Node.new('document', start_node.document)
+          doc_node.namespace = start_node.parent.namespace
+          p_node = Nokogiri::XML::Node.new('p', doc_node.document)
+          p_node.namespace = start_node.parent.namespace
+          p_node.children = Nokogiri::XML::NodeSet.new(p_node.document,
+                                                       body.map(&:dup))
+          doc_node.children = Nokogiri::XML::NodeSet.new(p_node.document,
+                                                         [p_node])
+          Processor::Document.process doc_node, env
+
+          if p_node.parent.nil?
+            replace_parent_node(doc_node.children)
+            []
+          else
+            p_node.children
+          end
+        end
+
         def remove_control_elements
           body.each(&:remove)
           start_field.remove
@@ -139,6 +165,16 @@ module Sablon
         def end_node
           @end_node ||= end_field.start_node
         end
+
+        private
+
+        # A block level insertion has occurred which must replace the
+        # parent paragraph of the start node.
+        def replace_parent_node(content)
+          node = start_node.ancestors('.//w:p').first
+          content.each { |n| node.add_next_sibling n }
+          node.remove
+        end
       end
     end
   end

data/lib/sablon/template.rb

@@ -53,7 +53,7 @@ module Sablon
 
     def render(context, properties = {})
       # initialize environment
-      @document = Sablon::DOM::Model.new(Zip::File.open(@path))
+      @document = Sablon::DOM::Model.new(Zip::File.open(@path, !File.exist?(@path)))
       env = Sablon::Environment.new(self, context)
       env.section_properties = properties
       #

data/lib/sablon/test/assertions.rb

@@ -0,0 +1,60 @@
+module Sablon
+  module Test
+    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
+
+          private
+
+          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
+end

data/lib/sablon/version.rb

@@ -1,3 +1,3 @@
 module Sablon
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/misc/TEMPLATE.md

@@ -1,6 +1,8 @@
-### Creating a Simple Template
+## Creating a Simple Template
+
 Creating a template is as easy as creating a normal Word document (`.docx`). Yet it could be confusing to people who haven't used the [Mail Merge](https://support.office.com/en-us/article/Use-mail-merge-to-send-bulk-email-messages-0f123521-20ce-4aa8-8b62-ac211dedefa4) feature in Microsoft Word. The steps are as follows:
 
+### Setup
 - Create a new word document
 
 ![Step 1](/misc/step_1.png)
@@ -11,6 +13,22 @@ Creating a template is as easy as creating a normal Word document (`.docx`). Yet
 
 - Add mail merge fields
 
+See [How to add a mail merge field](#how-to-add-a-mail-merge-field) for specific instructions for your operating system.
+
+- You should then have something like this:
+
+![Step 6](/misc/step_6.png)
+
+- A complete template might look like this:
+
+![Step 7](/misc/step_7.png)
+
+NOTE: When adding variables, those that display a value are preceded with an equals sign `=`. Those that just perform logics, such as loops and conditionals, do not need a preceding equals sign.
+
+### How to add a mail merge field
+
+#### Microsoft Windows
+
 - Click the `Insert` tab on the ribbon
 
 ![Step 3.1](/misc/step_3_1.png)
@@ -33,12 +51,10 @@ Creating a template is as easy as creating a normal Word document (`.docx`). Yet
 
 ![Step 5](/misc/step_5.png)
 
-- You should then have something like this:
-
-![Step 6](/misc/step_6.png)
-
-- A complete template might look like this:
-
-![Step 7](/misc/step_7.png)
-
-NOTE: When adding variables, those that display a value are preceded with an equals sign `=`. Those that just perform logics, such as loops and conditionals, do not need a preceding equals sign.
+#### MacOS
+- From the menu bar, open the **Insert** menu and select **Field...**
+- Under *Categories*, select **Mail Merge**
+- Under *Field names*, select **MergeField**
+- Add your variable name in the input box; make sure to leave a space after the word `MERGEFIELD`
+  - Example: `MERGEFIELD =person.first_name`
+- Click **OK**

data/sablon.gemspec

@@ -19,11 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'nokogiri', ">= 1.6.0"
-  spec.add_runtime_dependency 'rubyzip', ">= 1.1.1"
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_runtime_dependency 'nokogiri', ">= 1.8.5"
+  spec.add_runtime_dependency 'rubyzip', ">= 1.3.0"
 
   spec.add_development_dependency "bundler", ">= 1.6"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.4"
   spec.add_development_dependency "xml-simple"
 end

data/test/configuration_test.rb

@@ -75,8 +75,9 @@ class ConfigurationHTMLTagTest < Sablon::TestCase
 
   # 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)
+    args = ['a', 'inline']
+    kwargs = { ast_class: Sablon::HTMLConverter::Run }
+    tag = Sablon::Configuration::HTMLTag.new(*args, **kwargs)
     assert_equal :a, tag.name
     assert_equal :inline, tag.type
     assert_equal Sablon::HTMLConverter::Run, tag.ast_class

data/test/fixtures/images/svg_sample.svg

@@ -0,0 +1,6 @@
+<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'>
+  <g>
+    <rect x='10' y='10' width='90' height='75' stroke='black' fill='red' stroke-width='2' />
+    <text x='20' y='40' font-size='10'>Sample</text>
+  </g>
+</svg>

data/test/html/ast_builder_test.rb

@@ -39,7 +39,7 @@ class HTMLConverterASTBuilderTest < Sablon::TestCase
   def test_merge_properties
     @builder = new_builder
     node = Nokogiri::HTML.fragment('<span style="color: #F00; text-decoration: underline wavy">Test</span>').children[0]
-    tag = Struct.new(:properties).new(rStyle: 'Normal')
+    tag = Struct.new(:properties).new({ rStyle: 'Normal' })
     # test that properties are merged across all three arguments
     props = @builder.send(:merge_node_properties, node, tag, 'background-color' => '#00F')
     assert_equal({ 'background-color' => '#00F', rStyle: 'Normal', 'color' => '#F00', 'text-decoration' => 'underline wavy' }, props)

data/test/sablon_test.rb

@@ -105,7 +105,8 @@ class SablonConditionalsTest < Sablon::TestCase
       object: OpenStruct.new(true_method: true, false_method: false),
       success_content: '✓',
       fail_content: '✗',
-      content: 'Some Content'
+      content: 'Some Content',
+      block_content: Sablon.content(:html, '<p>HTML paragraph injected</p>')
     }
     #
     template.render_to_file @output_path, context
@@ -155,7 +156,7 @@ class SablonImagesTest < Sablon::TestCase
     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', properties: {height: '8cm', width: '4cm'})
+    trooper = Sablon.content(:image, im_data, filename: 'clone.jpg', properties: {height: '1cm', width: '4cm'})
     #
     # with the following context setup all trooper should be reused and
     # only a single file added to media. R2D2 should get duplicated in the
@@ -186,3 +187,25 @@ class SablonImagesTest < Sablon::TestCase
     assert_equal "Filename: 'clone' has no discernable extension", e.message
   end
 end
+
+class SablonSvgImagesTest < Sablon::TestCase
+  def setup
+    super
+    @base_path = Pathname.new(File.expand_path("../", __FILE__))
+    @template_path = @base_path + "fixtures/svg_images_template.docx"
+    @output_path = @base_path + "sandbox/svg_images.docx"
+    @sample_path = @base_path + "fixtures/svg_images_sample.docx"
+    @image_fixtures = @base_path + "fixtures/images"
+  end
+
+  def test_generate_document_from_template
+    template = Sablon.template @template_path
+
+    context = {
+      svg_sample: Sablon.content(:image, @image_fixtures.join('svg_sample.svg'))
+    }
+
+    template.render_to_file @output_path, context
+    assert_docx_equal @sample_path, @output_path
+  end
+end

data/test/test_helper.rb

@@ -8,64 +8,11 @@ require "pathname"
 
 $: << File.expand_path('../../lib', __FILE__)
 require "sablon"
+require "sablon/test/assertions"
 
-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
+  include Sablon::Test::Assertions
 
-class Sablon::TestCase < MiniTest::Test
   def teardown
     super
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yves Senn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.5
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ files:
 - lib/sablon/processor/section_properties.rb
 - lib/sablon/template.rb
 - lib/sablon/test.rb
+- lib/sablon/test/assertions.rb
 - lib/sablon/version.rb
 - misc/TEMPLATE.md
 - misc/cv_sample.png
@@ -174,6 +175,7 @@ files:
 - test/fixtures/images/clone.jpg
 - test/fixtures/images/darth_vader.jpg
 - test/fixtures/images/r2d2.jpg
+- test/fixtures/images/svg_sample.svg
 - test/fixtures/images_sample.docx
 - test/fixtures/images_template.docx
 - test/fixtures/insertion_template.docx
@@ -184,6 +186,8 @@ files:
 - test/fixtures/recipe_context.json
 - test/fixtures/recipe_sample.docx
 - test/fixtures/recipe_template.docx
+- test/fixtures/svg_images_sample.docx
+- test/fixtures/svg_images_template.docx
 - test/fixtures/xml/comment.xml
 - test/fixtures/xml/comment_block_and_comment_as_key.xml
 - test/fixtures/xml/complex_field.xml
@@ -227,7 +231,7 @@ homepage: http://github.com/senny/sablon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,16 +239,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: docx template processor
 test_files:
@@ -267,6 +270,7 @@ test_files:
 - test/fixtures/images/clone.jpg
 - test/fixtures/images/darth_vader.jpg
 - test/fixtures/images/r2d2.jpg
+- test/fixtures/images/svg_sample.svg
 - test/fixtures/images_sample.docx
 - test/fixtures/images_template.docx
 - test/fixtures/insertion_template.docx
@@ -277,6 +281,8 @@ test_files:
 - test/fixtures/recipe_context.json
 - test/fixtures/recipe_sample.docx
 - test/fixtures/recipe_template.docx
+- test/fixtures/svg_images_sample.docx
+- test/fixtures/svg_images_template.docx
 - test/fixtures/xml/comment.xml
 - test/fixtures/xml/comment_block_and_comment_as_key.xml
 - test/fixtures/xml/complex_field.xml