sablon 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 249d5af8b120f806c35a208e2804915c575b23e7
-  data.tar.gz: e7a006f1fcd0bbd7202d25681578c4fb327ed49b
+  metadata.gz: 1c8b7cc35ce1718d11e3ebc44d2b50e5a03b1575
+  data.tar.gz: 003512773f3372b9ed1243a4a7fd88ac301dafcb
 SHA512:
-  metadata.gz: 39bc20fe127fbd6d8bc2737af0e5c1e559182815ce94798ac5c488c66029829148665befdafee6fec0dab3c1b9a241ec6326600dedd6518b8eb5e697e10ed2d3
-  data.tar.gz: ceb09efa9b30aa2a6ac69ef199f2f8f8452db76b9272c5940c9c10b437459bbd4fbff370d62adbba5a3bacda4eb8f79aa0d1abf2856176ef2e33a73e02f4ee89
+  metadata.gz: ad54b7f87dc83a60b77fb3559d756d1798197f264618195e11796c0cd0cd71bea955991b5f7d01aa2ad668c4afbed0f2c9eaf16c0b28a3d693b0bb2c4cbe891a
+  data.tar.gz: 4c45533f60f2cf77b7d17be0ad77a3180fc17c3c6257178963229d1374bc8eef0d31024a110e8a9b11b4b768e451a4d04f674d0113b696a6d102cc4f8b16cdd6

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    sablon (0.0.10)
+      nokogiri (>= 1.6.0)
+      rubyzip (>= 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rake (10.4.2)
+    rubyzip (1.1.7)
+    xml-simple (1.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.6)
+  minitest (~> 5.4)
+  rake (~> 10.0)
+  sablon!
+  xml-simple

data/README.md

@@ -90,7 +90,7 @@ word_processing_ml = <<-XML
 </w:p>
 XML
 context = {
-  long_description: Sablon.word_ml(word_processing_ml)
+  long_description: Sablon.content(:word_ml, word_processing_ml)
 }
 template.render_to_file File.expand_path("~/Desktop/output.docx"), context
 ```

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/sablon/content.rb

@@ -1,7 +1,55 @@
 module Sablon
   module Content
+    class << self
+      def wrap(value)
+        case value
+        when Sablon::Content
+          value
+        else
+          if type = type_wrapping(value)
+            type.new(value)
+          else
+            raise ArgumentError, "Could not find Sablon content type to wrap #{value.inspect}"
+          end
+        end
+      end
+
+      def make(type_id, *args)
+        if types.key?(type_id)
+          types[type_id].new(*args)
+        else
+          raise ArgumentError, "Could not find Sablon content type with id '#{type_id}'"
+        end
+      end
+
+      def register(content_type)
+        types[content_type.id] = content_type
+      end
+
+      def remove(content_type_or_id)
+        types.delete_if {|k,v| k == content_type_or_id || v == content_type_or_id }
+      end
+
+      private
+      def type_wrapping(value)
+        types.values.reverse.detect { |type| type.wraps?(value) }
+      end
+
+      def types
+        @types ||= {}
+      end
+    end
+
     class String < Struct.new(:string)
       include Sablon::Content
+      def self.id; :string end
+      def self.wraps?(value)
+        value.respond_to?(:to_s)
+      end
+
+      def initialize(value)
+        super value.to_s
+      end
 
       def append_to(paragraph, display_node)
         string.scan(/[^\n]+|\n/).reverse.each do |part|
@@ -18,6 +66,8 @@ module Sablon
 
     class WordML < Struct.new(:xml)
       include Sablon::Content
+      def self.id; :word_ml end
+      def self.wraps?(value) false end
 
       def append_to(paragraph, display_node)
         Nokogiri::XML.fragment(xml).children.reverse.each do |child|
@@ -26,5 +76,8 @@ module Sablon
         paragraph.remove
       end
     end
+
+    register Sablon::Content::String
+    register Sablon::Content::WordML
   end
 end

data/lib/sablon/context.rb

@@ -9,8 +9,8 @@ module Sablon
     end
 
     def self.transform_pair(key, value)
-      if key =~ /\Awordml:(.+)\z/
-        [$1, Sablon.word_ml(value)]
+      if key =~ /\A([^:]+):(.+)\z/
+        [$2, Sablon.content($1.to_sym, value)]
       else
         transform_standard_key(key, value)
       end

data/lib/sablon/operations.rb

@@ -3,16 +3,7 @@ module Sablon
   module Statement
     class Insertion < Struct.new(:expr, :field)
       def evaluate(context)
-        field.replace(wrap_content(expr.evaluate(context)))
-      end
-
-      private
-      def wrap_content(value)
-        if value.is_a?(Sablon::Content)
-          value
-        else
-          Sablon.string(value)
-        end
+        field.replace(Sablon::Content.wrap(expr.evaluate(context)))
       end
     end
 

data/lib/sablon/version.rb

@@ -1,3 +1,3 @@
 module Sablon
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/lib/sablon.rb

@@ -18,11 +18,7 @@ module Sablon
     Template.new(path)
   end
 
-  def self.word_ml(xml)
-    Sablon::Content::WordML.new(xml)
-  end
-
-  def self.string(object)
-    Sablon::Content::String.new(object.to_s)
+  def self.content(type, *args)
+    Content.make(type, *args)
   end
 end

data/sablon.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'nokogiri', ">= 1.6.0"
   spec.add_runtime_dependency 'rubyzip', ">= 1.1"
 
   spec.add_development_dependency "bundler", ">= 1.6"

data/test/content_test.rb

@@ -1,6 +1,74 @@
 # -*- coding: utf-8 -*-
 require "test_helper"
 
+class ContentTest < Sablon::TestCase
+  def test_can_build_content_objects
+    content = Sablon.content(:string, "a string")
+    assert_instance_of Sablon::Content::String, content
+  end
+
+  def test_raises_error_when_building_non_registered_type
+    e = assert_raises ArgumentError do
+      Sablon.content :nope, "this should not work"
+    end
+    assert_equal "Could not find Sablon content type with id 'nope'", e.message
+  end
+
+  def test_wraps_string_objects
+    content = Sablon::Content.wrap(67)
+    assert_instance_of Sablon::Content::String, content
+    assert_equal "67", content.string
+  end
+
+  def test_raises_an_error_if_no_wrapping_type_was_found
+    Sablon::Content.remove Sablon::Content::String
+
+    e = assert_raises ArgumentError do
+      Sablon::Content.wrap(43)
+    end
+    assert_equal "Could not find Sablon content type to wrap 43", e.message
+  ensure
+    Sablon::Content.register Sablon::Content::String
+  end
+
+  def test_does_not_wrap_content_objects
+    original_content = Sablon.content(:word_ml, "<w:p></w:p>")
+    content = Sablon::Content.wrap(original_content)
+    assert_instance_of Sablon::Content::WordML, content
+    assert_equal original_content.object_id, content.object_id
+  end
+end
+
+class CustomContentTest < Sablon::TestCase
+  class MyContent < Struct.new(:numeric)
+    include Sablon::Content
+    def self.id; :custom end
+    def self.wraps?(value); Numeric === value end
+
+    def append_to(paragraph, display_node)
+    end
+  end
+
+  def setup
+    Sablon::Content.register MyContent
+  end
+
+  def teardown
+    Sablon::Content.remove MyContent
+  end
+
+  def test_can_build_custom_content
+    content = Sablon.content(:custom, 42)
+    assert_instance_of MyContent, content
+  end
+
+  def test_wraps_custom_content
+    content = Sablon::Content.wrap(31)
+    assert_instance_of MyContent, content
+    assert_equal 31, content.numeric
+  end
+end
+
 module ContentTestSetup
   def setup
     super
@@ -20,7 +88,7 @@ class ContentStringTest < Sablon::TestCase
   include ContentTestSetup
 
   def test_single_line_string
-    Sablon.string("a normal string").append_to @paragraph, @node
+    Sablon.content(:string, "a normal string").append_to @paragraph, @node
 
     output = <<-XML.strip
 <w:p><span>template</span><span>a normal string</span></w:p><w:p>AFTER</w:p>
@@ -29,7 +97,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_numeric_string
-    Sablon.string(42).append_to @paragraph, @node
+    Sablon.content(:string, 42).append_to @paragraph, @node
 
     output = <<-XML.strip
 <w:p><span>template</span><span>42</span></w:p><w:p>AFTER</w:p>
@@ -38,7 +106,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_string_with_newlines
-    Sablon.string("a\nmultiline\n\nstring").append_to @paragraph, @node
+    Sablon.content(:string, "a\nmultiline\n\nstring").append_to @paragraph, @node
 
     output = <<-XML.strip.gsub("\n", "")
 <w:p>
@@ -57,7 +125,7 @@ class ContentStringTest < Sablon::TestCase
   end
 
   def test_blank_string
-    Sablon.string("").append_to @paragraph, @node
+    Sablon.content(:string, "").append_to @paragraph, @node
 
     assert_xml_equal @template_text, @document
   end
@@ -67,14 +135,14 @@ class ContentWordMLTest < Sablon::TestCase
   include ContentTestSetup
 
   def test_blank_word_ml
-    Sablon.word_ml("").append_to @paragraph, @node
+    Sablon.content(:word_ml, "").append_to @paragraph, @node
 
     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.word_ml(@word_ml).append_to @paragraph, @node
+    Sablon.content(:word_ml, @word_ml).append_to @paragraph, @node
 
     output = <<-XML.strip.gsub("\n", "")
 <w:p>

data/test/context_test.rb

@@ -8,8 +8,8 @@ class ContextTest < Sablon::TestCase
   end
 
   def test_recognizes_wordml_keys
-    transformed = Sablon::Context.transform({"wordml:mykey" => "<w:p><w:p>", "otherkey" => "<nope>"})
-    assert_equal({ "mykey"=>Sablon.word_ml("<w:p><w:p>"),
+    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)
   end
 end

data/test/executable_test.rb

@@ -9,7 +9,7 @@ class ExecutableTest < Sablon::TestCase
     @output_path = @base_path + "sandbox/shopping_list.docx"
     @template_path = @base_path + "fixtures/shopping_list_template.docx"
     @context_path = @base_path + "fixtures/shopping_list_context.json"
-    @executable_path = @base_path + '../bin/sablon'
+    @executable_path = @base_path + '../exe/sablon'
 
     @output_path.delete if @output_path.exist?
   end

data/test/fixtures/shopping_list_context.json

@@ -5,7 +5,7 @@
       "first_name": "John",
       "last_name": "Doe"
     },
-    "wordml:description": "<w:p><w:r><w:t xml:space=\"preserve\">A list of items to buy at the next </w:t></w:r><w:r><w:rPr><w:b /></w:rPr><w:t>Shop</w:t></w:r><w:r><w:t xml:space=\"preserve\">.</w:t></w:r></w:p>"
+    "word_ml:description": "<w:p><w:r><w:t xml:space=\"preserve\">A list of items to buy at the next </w:t></w:r><w:r><w:rPr><w:b /></w:rPr><w:t>Shop</w:t></w:r><w:r><w:t xml:space=\"preserve\">.</w:t></w:r></w:p>"
   },
   "items": [
     {"name": "Milk", "amount": "1L"},

data/test/mail_merge_parser_test.rb

@@ -35,7 +35,7 @@ module MailMergeParser
     end
 
     def test_replace
-      field.replace(Sablon.string("Hello"))
+      field.replace(Sablon.content(:string, "Hello"))
       xml = <<-xml.strip
 <w:p>
 <w:r w:rsidR=\"004B49F0\">
@@ -70,7 +70,7 @@ xml
     end
 
     def test_replace
-      field.replace(Sablon.string("Hello"))
+      field.replace(Sablon.content(:string, "Hello"))
       xml = <<-xml.strip
 <w:p>
 

data/test/sablon_test.rb

@@ -23,7 +23,7 @@ class SablonTest < Sablon::TestCase
       author: "Yves Senn",
       title: "Letter of application",
       person: person,
-      about_me: Sablon.word_ml(snippet("about_me_snippet").strip),
+      about_me: Sablon.content(:word_ml, snippet("about_me_snippet").strip),
       items: [item.new("1.", "Ruby", "★" * 5), item.new("2.", "Java", "★" * 1), item.new("3.", "Python", "★" * 3)],
       career: [position.new("1999 - 2006", "Junior Java Engineer", "Lorem ipsum dolor\nsit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."),
                position.new("2006 - 2013", "Senior Ruby Developer", "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo."),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sablon
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Yves Senn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -99,17 +99,19 @@ description: Sablon is a document template processor. At this time it works only
 email:
 - yves.senn@gmail.com
 executables:
-- sablon
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/sablon
+- bin/rake
+- exe/sablon
 - lib/sablon.rb
 - lib/sablon/content.rb
 - lib/sablon/context.rb
@@ -175,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: docx tempalte processor