serenity-odt 0.1.0 → 0.1.1

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rake'
 require 'spec/rake/spectask'
+require 'rake/gempackagetask'
 
 task :default => [:spec]
 
@@ -7,7 +8,7 @@ Spec::Rake::SpecTask.new("spec")
 
 spec = Gem::Specification.new do |s|
   s.name = %q{serenity-odt}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.authors = ["Tomas Kramar"]
   s.description = <<-EOF
@@ -16,7 +17,7 @@ spec = Gem::Specification.new do |s|
     Very similar to .erb files.
   EOF
   s.email = %q{kramar.tomas@gmail.com}
-  s.files = Dir.glob('lib/**/*.rb') + %w{README.md Rakefile serenity-odt.gemspec LICENSE}
+  s.files = Dir.glob('lib/**/*.rb') + %w{README.md Rakefile LICENSE}
   s.has_rdoc = false
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
@@ -26,11 +27,6 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '>= 1.2.9')
 end
 
-task :gemspec do
-  File.open("serenity-odt.gemspec", "w") { |f| f << spec.to_ruby }
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
 end
-
-task :gem => :gemspec do
-  system "gem build serenity-odt.gemspec"
-end
-

data/lib/serenity.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'serenity/line'
 require 'serenity/debug'
 require 'serenity/node_type'
+require 'serenity/escape_xml'
 require 'serenity/odteruby'
 require 'serenity/template'
 require 'serenity/xml_reader'

data/lib/serenity/escape_xml.rb

@@ -0,0 +1,14 @@
+class String
+  def escape_xml
+    mgsub!([[/&/, '&amp;'], [/</, '&lt;'], [/>/, '&gt;']])
+    self
+  end
+
+  def mgsub!(key_value_pairs=[].freeze)
+    regexp_fragments = key_value_pairs.collect { |k,v| k }
+    gsub!(Regexp.union(*regexp_fragments)) do |match|
+      key_value_pairs.detect{|k,v| k =~ match}[1]
+    end
+    self
+  end
+end

data/lib/serenity/generator.rb

@@ -1,5 +1,3 @@
-require  'ruby-debug'
-
 module Serenity
   module Generator
     def render_odt template_path, output_path = output_name(template_path)

data/lib/serenity/line.rb

@@ -40,16 +40,13 @@ module Serenity
     end
 
     def escape_code code
-      code.gsub!(''', "'")
-      code.gsub!('>', ">")
-      code.gsub!('&lt;', "<")
-      code
+      code.mgsub! [[/&apos;/, "'"], [/&gt;/, '>'], [/&lt/, '<'], [/&quot;/, '"']]
     end
   end
 
   class StringLine < CodeLine
     def to_buf
-      " _buf << (" << escape_code(@text) << ").to_s;"
+      " _buf << (" << escape_code(@text) << ").to_s.escape_xml;"
     end
   end
 end

data/spec/escape_xml_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe String do
+  it 'should escape <' do
+    '1 < 2'.escape_xml.should == '1 &lt; 2'
+  end
+
+  it 'should escape >' do
+    '2 > 1'.escape_xml.should == '2 &gt; 1'
+  end
+
+  it 'should escape &' do
+    '1 & 2'.escape_xml.should == '1 &amp; 2'
+  end
+
+  it 'should escape < > &' do
+    '1 < 2 && 2 > 1'.escape_xml.should == '1 &lt; 2 &amp;&amp; 2 &gt; 1'
+  end
+end

data/spec/generator_spec.rb

@@ -2,6 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 module Serenity
   describe Generator do
+    after(:each) do
+      FileUtils.rm(fixture('loop_output.odt'))
+    end
+
     it 'should make context from instance variables and run the provided template' do
       class GeneratorClient
         include Generator

data/spec/odteruby_spec.rb

@@ -16,6 +16,27 @@ module Serenity
       text.inject('') { |memo, line| memo += line.strip } unless text.nil?
     end
 
+    def run_spec template, expected, context=@context
+      content = OdtEruby.new(XmlReader.new template)
+      result = content.evaluate context
+
+      squeeze(result).should == squeeze(expected)
+    end
+
+    it 'should escape single quotes properly' do
+      expected = template = "<text:p>It's a 'quote'</text:p>"
+
+      run_spec template, expected
+    end
+
+    it 'should properly escape special XML characters ("<", ">", "&")' do
+      template = "<text:p>{%= description %}</text:p>"
+      description = 'This will only hold true if length < 1 && var == true or length > 1000'
+      expected = "<text:p>This will only hold true if length &lt; 1 &amp;&amp; var == true or length &gt; 1000</text:p>"
+
+      run_spec template, expected, binding
+    end
+
     it 'should replace variables with values from context' do
       template = <<-EOF
         <text:p text:style-name="Text_1_body">{%= name %}</text:p>
@@ -29,42 +50,15 @@ module Serenity
         <text:p text:style-name="Text_1_body"/>
       EOF
 
-      content = OdtEruby.new(XmlReader.new template)
-      result = content.evaluate @context
-
-      squeeze(expected).should == squeeze(result)
+      run_spec template, expected
     end
 
     it 'should replace multiple variables on one line' do
       template = '<text:p text:style-name="Text_1_body">{%= type %} and {%= name %}</text:p>'
       expected = '<text:p text:style-name="Text_1_body">test_type and test_name</text:p>'
 
-      content = OdtEruby.new(XmlReader.new template)
-      result = content.evaluate @context
-
-      squeeze(expected).should == squeeze(result)
-    end
-=begin
-    should 'replace a LOOP construct with variables' do
-      template = <<-EOF
-        <text:p text:style-name="Text_1_body">{% for row in rows do %}</text:p>
-          <text:p text:style-name="Text_1_body">{%= row.name %}</text:p>
-          <text:p text:style-name="Text_1_body">{%= row.type %}</text:p>
-        <text:p text:style-name="Text_1_body">{% end %}</text:p>
-      EOF
-
-      expected = <<-EOF
-          <text:p text:style-name="Text_1_body">test_name_1</text:p>
-          <text:p text:style-name="Text_1_body">test_type_1</text:p>
-          <text:p text:style-name="Text_1_body">test_name_2</text:p>
-          <text:p text:style-name="Text_1_body">test_type_2</text:p>
-      EOF
-
-      content = OdtEruby.new(XmlReader.new template)
-      result = content.evaluate @context
-      assert_equal expected, result
+      run_spec template, expected
     end
-=end
 
     it 'should remove empty tags after a control structure processing' do
       template = <<-EOF
@@ -93,10 +87,7 @@ module Serenity
         </table:table>
       EOF
 
-      content = OdtEruby.new(XmlReader.new template)
-      result = content.evaluate @context
-
-      squeeze(expected).should == squeeze(result)
+      run_spec template, expected
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serenity-odt
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Tomas Kramar
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 +01:00
+date: 2010-02-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/serenity/debug.rb
+- lib/serenity/escape_xml.rb
 - lib/serenity/generator.rb
 - lib/serenity/line.rb
 - lib/serenity/node_type.rb
@@ -51,19 +52,7 @@ files:
 - lib/serenity.rb
 - README.md
 - Rakefile
-- serenity-odt.gemspec
 - LICENSE
-- spec/generator_spec.rb
-- spec/odteruby_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/be_a_document.rb
-- spec/template_spec.rb
-- spec/xml_reader_spec.rb
-- fixtures/advanced.odt
-- fixtures/loop.odt
-- fixtures/loop_table.odt
-- fixtures/table_rows.odt
-- fixtures/variables.odt
 has_rdoc: true
 homepage: 
 licenses: []
@@ -93,6 +82,7 @@ signing_key:
 specification_version: 3
 summary: Embedded ruby for OpenOffice Text Document (.odt) files
 test_files: 
+- spec/escape_xml_spec.rb
 - spec/generator_spec.rb
 - spec/odteruby_spec.rb
 - spec/spec_helper.rb

data/serenity-odt.gemspec

@@ -1,36 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{serenity-odt}
-  s.version = "0.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tomas Kramar"]
-  s.date = %q{2010-02-18}
-  s.description = %q{    Embedded ruby for OpenOffice Text Document (.odt) files. You provide an .odt template
-    with ruby code in a special markup and the data, and Serenity generates the document.
-    Very similar to .erb files.
-}
-  s.email = %q{kramar.tomas@gmail.com}
-  s.files = ["lib/serenity/debug.rb", "lib/serenity/generator.rb", "lib/serenity/line.rb", "lib/serenity/node_type.rb", "lib/serenity/odteruby.rb", "lib/serenity/template.rb", "lib/serenity/xml_reader.rb", "lib/serenity.rb", "README.md", "Rakefile", "serenity-odt.gemspec", "LICENSE", "spec/generator_spec.rb", "spec/odteruby_spec.rb", "spec/spec_helper.rb", "spec/support/matchers/be_a_document.rb", "spec/template_spec.rb", "spec/xml_reader_spec.rb", "fixtures/advanced.odt", "fixtures/loop.odt", "fixtures/loop_table.odt", "fixtures/table_rows.odt", "fixtures/variables.odt"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Embedded ruby for OpenOffice Text Document (.odt) files}
-  s.test_files = ["spec/generator_spec.rb", "spec/odteruby_spec.rb", "spec/spec_helper.rb", "spec/support/matchers/be_a_document.rb", "spec/template_spec.rb", "spec/xml_reader_spec.rb", "fixtures/advanced.odt", "fixtures/loop.odt", "fixtures/loop_table.odt", "fixtures/table_rows.odt", "fixtures/variables.odt"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rubyzip>, [">= 0.9.1"])
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-    else
-      s.add_dependency(%q<rubyzip>, [">= 0.9.1"])
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    end
-  else
-    s.add_dependency(%q<rubyzip>, [">= 0.9.1"])
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-  end
-end