serenity-odt 0.1.1 → 0.2.0

data/README.md

@@ -1,29 +1,22 @@
 Serenity is an embedded ruby for OpenOffice documents (.odt files). You provide an .odt template with ruby code inside a special markup and the data and Serenity generates the document. If you know erb all of this should sound familiar.
 
-Serenity is best demonstrated with a picture. The first picture shows the template with the ruby code, next image shows the generated document. The template, output and the sample script can be found in the showcase directory.
+Important Changes
+=================
 
-![Serenity template](http://github.com/kremso/serenity/blob/master/showcase/imgs/serenity_template.png?raw=true)
-
-![Generated document](http://github.com/kremso/serenity/blob/master/showcase/imgs/serenity_output.png?raw=true)
-
-Installation
-============
+As of version 0.2.0 serenity is using instance variables in the templates. In previous versions, your instance variables would be converted to local before passing to the template, so while in the code you had `@title = 'Serenity'`, you had to put `{%= title }` in the template to get serenity to work. This has now changed and you need to use instance variables in the templates: `{%= @title }`. Honestly, I don't know why I did it this way in the first place, considering that people are used to instance variables in templates from rails.
 
-    gem install serenity-odt
+Usage
+======
 
-Yeah, serenity is already taken on gemcutter.
+Serenity is best demonstrated with an example. The first picture shows the template with the ruby code, next image shows the generated document. The template, output and the sample script can be found in the showcase directory.
 
-Creating templates
-===================
+![Serenity template](http://github.com/kremso/serenity/blob/master/showcase/imgs/serenity_template.png?raw=true)
 
-Templates are created directly in OpenOffice. Ruby code is enclosed in special markup:
-* `{%= %}` is for ruby code which should be output to the final document. `to_s` is applied to anything found inside this markup
-* `{% %}` is for everything else — loops, ifs, ends and any other non-outputting code
+The image above is a screenshot of showcase.odt from the [showcase](http://github.com/kremso/serenity/blob/master/showcase) directory. It's a regular OpenOffice document with ruby code embedded inside a special markup. That ruby code drives the document creation. You can use conditionals, loops, blocks — in fact, the whole ruby language and you can apply any OpenOffice formatting to the outputted variables or static text.
 
-Any special formatting should by applied directly on the markup. E.g. if you need to ouput the value of variable title in bold font, write `{%= title %}`, select in in OpenOffice and make it bold. See the showcase.odt for more examples.
+The second line in the template is `{%= @title%}` what means: output the value of variable title. It's bold and big, in fact, it's has the 'Heading 1' style applied. That variable will be replaced in the generated document, but it will still be a 'Heading 1'.
 
-Generating documents
-====================
+You can now take that template, provide the data and generate the final document:
 
     require 'rubygems'
     require 'serenity'
@@ -51,10 +44,31 @@ Generating documents
       end
     end
 
-The key parts are `include Serenity::Generator` and render_odt. The data for the template must be provided as instance variables.
+The key parts are `include Serenity::Generator` and `render_odt`. The data for the template must be provided as instance variables.
+
+Following picture shows the generated document. It's a screenshot of the showcase_output.odt document from the [showcase](http://github.com/kremso/serenity/blob/master/showcase) directory.
+
+![Generated document](http://github.com/kremso/serenity/blob/master/showcase/imgs/serenity_output.png?raw=true)
+
+Installation
+============
+
+    gem install serenity-odt
+
+Yeah, serenity is already taken on gemcutter.
+
+Creating templates
+===================
+
+Templates are created directly in OpenOffice. Ruby code is enclosed in special markup:
+
++ `{%= %}` is for ruby code which should be output to the final document. `to_s` is applied to anything found inside this markup
++ `{% %}` is for everything else — loops, ifs, ends and any other non-outputting code
+
+Any special formatting should by applied directly on the markup. E.g. if you need to ouput the value of variable title in bold font, write `{%= title %}`, select in in OpenOffice and make it bold. See the showcase.odt for more examples.
 
 Contact
 =======
 
-kramar[dot]tomas[at]gmail.com — I love the attention
+kramar[dot]tomas[at]gmail.com
 

data/Rakefile

@@ -8,7 +8,7 @@ Spec::Rake::SpecTask.new("spec")
 
 spec = Gem::Specification.new do |s|
   s.name = %q{serenity-odt}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.authors = ["Tomas Kramar"]
   s.description = <<-EOF

data/lib/serenity/escape_xml.rb

@@ -1,7 +1,6 @@
 class String
   def escape_xml
     mgsub!([[/&/, '&amp;'], [/</, '&lt;'], [/>/, '&gt;']])
-    self
   end
 
   def mgsub!(key_value_pairs=[].freeze)

data/lib/serenity/generator.rb

@@ -1,23 +1,12 @@
 module Serenity
   module Generator
     def render_odt template_path, output_path = output_name(template_path)
-
-      local_variables = {}
-      instance_variables.each { |name| local_variables[name] = instance_variable_get(name) }
-
-      locals = instance_variables.map { |name| "#{ival_name_to_local(name)} = local_variables['#{name}'];" }.join
-      eval locals
-
       template = Template.new template_path, output_path
       template.process binding
     end
 
     private
 
-    def ival_name_to_local ival_name
-      ival_name[1, ival_name.length]
-    end
-
     def output_name input
       if input =~ /(.+)\.odt\Z/
         "#{$1}_output.odt"

data/lib/serenity/line.rb

@@ -22,6 +22,10 @@ module Serenity
       StringLine.new txt
     end
 
+    def self.literal txt
+      LiteralLine.new txt
+    end
+
   end
 
   class TextLine < Line
@@ -49,5 +53,12 @@ module Serenity
       " _buf << (" << escape_code(@text) << ").to_s.escape_xml;"
     end
   end
+
+  class LiteralLine < CodeLine
+    def to_buf
+      " _buf << (" << escape_code(@text) << ").to_s;"
+    end
+  end
+
 end
 

data/lib/serenity/odteruby.rb

@@ -2,7 +2,7 @@ module Serenity
   class OdtEruby
     include Debug
 
-    EMBEDDED_PATTERN = /\{%(=+)?(.*?)-?%\}/m
+    EMBEDDED_PATTERN = /\{%([=%]+)?(.*?)-?%\}/m
 
     def initialize template
       @src = convert template
@@ -61,10 +61,12 @@ module Serenity
         pos  = m.end(0)
         src << Line.text(middle) unless middle.empty?
 
-        if !indicator              # <% %>
+        if !indicator            # <% %>
           src << Line.code(code)
-        else                       # <%= %>
+        elsif indicator == '='   # <%= %>
           src << Line.string(code)
+        elsif indicator == '%'   # <%% %>
+          src << Line.literal(code)
         end
       end
 

data/lib/serenity/template.rb

@@ -11,16 +11,19 @@ module Serenity
     end
 
     def process context
+      tmpfiles = []
       Zip::ZipFile.open(@template) do |zipfile|
-        content = zipfile.read('content.xml')
-        odteruby = OdtEruby.new(XmlReader.new(content))
-        out = odteruby.evaluate context
+        %w(content.xml styles.xml).each do |xml_file|
+          content = zipfile.read(xml_file)
+          odteruby = OdtEruby.new(XmlReader.new(content))
+          out = odteruby.evaluate(context)
 
-        file = Tempfile.new("serenity")
-        file << out
-        file.close
+          tmpfiles << (file = Tempfile.new("serenity"))
+          file << out
+          file.close
 
-        zipfile.replace('content.xml', file.path)
+          zipfile.replace(xml_file, file.path)
+        end
       end
     end
   end

data/spec/generator_spec.rb

@@ -8,7 +8,7 @@ module Serenity
 
     it 'should make context from instance variables and run the provided template' do
       class GeneratorClient
-        include Generator
+        include Serenity::Generator
 
         def generate_odt
           @crew = ['Mal', 'Inara', 'Wash', 'Zoe']

data/spec/odteruby_spec.rb

@@ -13,7 +13,7 @@ module Serenity
     end
 
     def squeeze text
-      text.inject('') { |memo, line| memo += line.strip } unless text.nil?
+      text.each_char.inject('') { |memo, line| memo += line.strip } unless text.nil?
     end
 
     def run_spec template, expected, context=@context

data/spec/support/matchers/contain_in.rb

@@ -0,0 +1,20 @@
+require "zip/zip"
+
+module Serenity
+  Spec::Matchers.define :contain_in do |xml_file, expected|
+
+    match do |actual|
+      content = Zip::ZipFile.open(actual) { |zip_file| zip_file.read(xml_file) }
+      content =~ Regexp.new(".*#{Regexp.escape(expected)}.*")
+    end
+
+    failure_message_for_should do |actual|
+      "expected #{actual} to contain the text #{expected}"
+    end
+
+    failure_message_for_should_not do |actual|
+      "expected #{actual} to not contain the text #{expected}"
+    end
+
+  end
+end

data/spec/template_spec.rb

@@ -10,39 +10,47 @@ module Serenity
     end
 
     it "should process a document with simple variable substitution" do
-      name = 'Malcolm Reynolds'
-      title = 'captain'
+      @name = 'Malcolm Reynolds'
+      @title = 'captain'
 
       template = Template.new(fixture('variables.odt'), 'output_variables.odt')
       lambda {template.process binding}.should_not raise_error
     end
 
     it "should unroll a simple for loop" do
-      crew = %w{'River', 'Jayne', 'Wash'}
+      @crew = %w{'River', 'Jayne', 'Wash'}
 
       template = Template.new(fixture('loop.odt'), 'output_loop.odt')
       lambda {template.process binding}.should_not raise_error
     end
 
     it "should unroll an advanced loop with tables" do
-      ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
+      @ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
 
       template = Template.new(fixture('loop_table.odt'), 'output_loop_table.odt')
       lambda {template.process binding}.should_not raise_error
     end
 
     it "should process an advanced document" do
-      persons = [Person.new('Malcolm', 'captain'), Person.new('River', 'psychic'), Person.new('Jay', 'gunslinger')]
+      @persons = [Person.new('Malcolm', 'captain'), Person.new('River', 'psychic'), Person.new('Jay', 'gunslinger')]
 
       template = Template.new(fixture('advanced.odt'), 'output_advanced.odt')
       lambda {template.process binding}.should_not raise_error
     end
 
     it "should loop and generate table rows" do
-      ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
+      @ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
 
       template = Template.new(fixture('table_rows.odt'), 'output_table_rows.odt')
       lambda {template.process binding}.should_not raise_error
     end
+
+    it "should parse the header" do
+      @title = 'captain'
+
+      template = Template.new(fixture('header.odt'), 'output_header.odt')
+      template.process(binding)
+      'output_header.odt'.should contain_in('styles.xml', 'captain')
+    end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: serenity-odt
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tomas Kramar
@@ -9,29 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 +01:00
+date: 2010-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubyzip
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
         version: 0.9.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id002
 description: "    Embedded ruby for OpenOffice Text Document (.odt) files. You provide an .odt template\n    with ruby code in a special markup and the data, and Serenity generates the document.\n    Very similar to .erb files.\n"
 email: kramar.tomas@gmail.com
 executables: []
@@ -53,6 +71,20 @@ files:
 - README.md
 - Rakefile
 - LICENSE
+- spec/escape_xml_spec.rb
+- spec/generator_spec.rb
+- spec/odteruby_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_a_document.rb
+- spec/support/matchers/contain_in.rb
+- spec/template_spec.rb
+- spec/xml_reader_spec.rb
+- fixtures/advanced.odt
+- fixtures/header.odt
+- fixtures/loop.odt
+- fixtures/loop_table.odt
+- fixtures/table_rows.odt
+- fixtures/variables.odt
 has_rdoc: true
 homepage: 
 licenses: []
@@ -63,21 +95,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Embedded ruby for OpenOffice Text Document (.odt) files
@@ -87,9 +125,11 @@ test_files:
 - spec/odteruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/be_a_document.rb
+- spec/support/matchers/contain_in.rb
 - spec/template_spec.rb
 - spec/xml_reader_spec.rb
 - fixtures/advanced.odt
+- fixtures/header.odt
 - fixtures/loop.odt
 - fixtures/loop_table.odt
 - fixtures/table_rows.odt