serenity-odt 0.2.1 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17fd0d1ef98dd78013054dd47ddb91141bd90ee83d1c023160421872f3e2be6b
+  data.tar.gz: 2a66ff91bf4b31bea7f20be8cbc804c26562bafacde52e099ce3d3a99e0213c9
+SHA512:
+  metadata.gz: 42f5842bd6dd034d4a65bbc7133eec279c654c2509b9af2fe4fffae053cc16ad8bd24d8027ee5efb71aecb07e770182cd76b29fe1760e70759080cdd288ef60c
+  data.tar.gz: a477a692d9afbb4ffea38028ca5c22599a1a3a2c1348bfc68df130203e471c8536e1aedbce21301397244615c65c70b3b714c998e51c24c7e70082197bb338c4

data/Rakefile

@@ -1,32 +1,8 @@
 require 'rake'
-require 'spec/rake/spectask'
-require 'rake/gempackagetask'
+require 'rspec/core/rake_task'
 
 task :default => [:spec]
 
-Spec::Rake::SpecTask.new("spec")
+RSpec::Core::RakeTask.new(:spec)
 
-spec = Gem::Specification.new do |s|
-  s.name = %q{serenity-odt}
-  s.version = "0.2.1"
-
-  s.authors = ["Tomas Kramar"]
-  s.description = <<-EOF
-    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.
-  EOF
-  s.email = %q{kramar.tomas@gmail.com}
-  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}
-  s.summary = %q{Embedded ruby for OpenOffice Text Document (.odt) files}
-  s.test_files = Dir.glob('spec/**/*.rb') + Dir.glob('fixtures/*.odt')
-  s.add_dependency('rubyzip', '>= 0.9.1')
-  s.add_development_dependency('rspec', '>= 1.2.9')
-end
-
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-end
+# Build the gem with:  gem build serenity-odt.gemspec

data/lib/serenity/images_processor.rb

@@ -0,0 +1,32 @@
+module Serenity
+  class ImagesProcessor
+    include Debug
+
+    IMAGE_DIR_NAME = "Pictures"
+
+    def initialize(xml_content, context)
+      @replacements = []
+      @images = eval('@images', context)
+      @xml_content = xml_content
+    end
+
+    def generate_replacements
+      require 'nokogiri'
+
+      if @images && @images.kind_of?(Hash)
+        xml_data = Nokogiri::XML(@xml_content)
+
+        @images.each do |image_name, replacement_path|
+          if node = xml_data.xpath("//draw:frame[@draw:name='#{image_name}']/draw:image").first
+            placeholder_path = node.attribute('href').value
+            odt_image_path = ::File.join(IMAGE_DIR_NAME, ::File.basename(placeholder_path))
+
+            @replacements << [odt_image_path, replacement_path]
+          end
+        end
+      end
+
+      @replacements
+    end
+  end
+end

data/lib/serenity/odteruby.rb

@@ -14,6 +14,7 @@ module Serenity
     end
 
     def evaluate context
+      @src = @src.force_encoding Encoding.default_external
       eval(@src, context)
     end
 
@@ -21,6 +22,9 @@ module Serenity
 
     def convert template
       src = "_buf = '';"
+      # `buffer`/`buffer_next` stay flat arrays of Line objects, so appending with `concat`
+      # keeps them flat in O(k). (The old `buffer << arr; buffer.flatten!` rescanned the whole
+      # buffer on every node, making `convert` O(n^2) in the number of template nodes.)
       buffer = []
       buffer_next = []
 
@@ -32,8 +36,7 @@ module Serenity
           elsif is_nonpair_tag? node
             next
           else
-            buffer << buffer_next
-            buffer.flatten!
+            buffer.concat(buffer_next)
             buffer_next = []
           end
         end
@@ -41,8 +44,7 @@ module Serenity
         if type == NodeType::CONTROL
           buffer_next = process_instruction(node)
         else
-          buffer << process_instruction(node)
-          buffer.flatten!
+          buffer.concat(process_instruction(node))
         end
       end
 

data/lib/serenity/template.rb

@@ -1,7 +1,15 @@
-require 'zip/zip'
+begin
+  require 'zip'          # rubyzip >= 1.0
+rescue LoadError
+  require 'zip/zip'      # rubyzip 0.9.x (legacy)
+end
 require 'fileutils'
+require 'tempfile'
 
 module Serenity
+  # rubyzip renamed Zip::ZipFile to Zip::File in 1.0; support both.
+  ZipFile = defined?(::Zip::File) ? ::Zip::File : ::Zip::ZipFile
+
   class Template
     attr_accessor :template
 
@@ -12,11 +20,19 @@ module Serenity
 
     def process context
       tmpfiles = []
-      Zip::ZipFile.open(@template) do |zipfile|
+      ZipFile.open(@template) do |zipfile|
         %w(content.xml styles.xml).each do |xml_file|
           content = zipfile.read(xml_file)
+
+          # Images replacement
+          images_replacements = ImagesProcessor.new(content, context).generate_replacements
+          images_replacements.each do |r|
+            zipfile.replace(r.first, r.last)
+          end
+
           odteruby = OdtEruby.new(XmlReader.new(content))
           out = odteruby.evaluate(context)
+          out.force_encoding Encoding.default_external
 
           tmpfiles << (file = Tempfile.new("serenity"))
           file << out

data/lib/serenity/xml_reader.rb

@@ -2,7 +2,7 @@ module Serenity
   class XmlReader
 
     def initialize src
-      @src = src
+      @src = src.force_encoding("UTF-8")
     end
 
     def each_node

data/lib/serenity.rb

@@ -4,6 +4,7 @@ require 'serenity/debug'
 require 'serenity/node_type'
 require 'serenity/escape_xml'
 require 'serenity/odteruby'
+require 'serenity/images_processor'
 require 'serenity/template'
 require 'serenity/xml_reader'
 require 'serenity/generator'

metadata

@@ -1,133 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: serenity-odt
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.2.3
 platform: ruby
-authors: 
-- Tomas Kramar
-autorequire: 
+authors:
+- kremso
 bindir: bin
 cert_chain: []
-
-date: 2010-11-03 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+      - !ruby/object:Gem::Version
+        version: '3.0'
   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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Embedded ruby for OpenOffice/LibreOffice 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.
+email: ''
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/serenity.rb
 - lib/serenity/debug.rb
 - lib/serenity/escape_xml.rb
 - lib/serenity/generator.rb
+- lib/serenity/images_processor.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
-- 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/footer.odt
-- fixtures/header.odt
-- fixtures/loop.odt
-- fixtures/loop_table.odt
-- fixtures/table_rows.odt
-- fixtures/variables.odt
-has_rdoc: true
-homepage: 
-licenses: []
-
-post_install_message: 
+homepage: https://github.com/kremso/serenity
+licenses:
+- MIT
+metadata: {}
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.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
-- 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/footer.odt
-- fixtures/header.odt
-- fixtures/loop.odt
-- fixtures/loop_table.odt
-- fixtures/table_rows.odt
-- fixtures/variables.odt
+rubygems_version: 4.0.14
+specification_version: 4
+summary: Parse ODT file and substitutes placeholders like ERb.
+test_files: []

data/spec/escape_xml_spec.rb

@@ -1,19 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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 Serenity::Generator
-
-        def generate_odt
-          @crew = ['Mal', 'Inara', 'Wash', 'Zoe']
-
-          render_odt fixture('loop.odt')
-        end
-      end
-
-      client = GeneratorClient.new
-      lambda { client.generate_odt }.should_not raise_error
-      fixture('loop_output.odt').should be_a_document
-    end
-  end
-end

data/spec/odteruby_spec.rb

@@ -1,102 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-module Serenity
-
-  describe OdtEruby do
-    before(:each) do
-      name = 'test_name'
-      type = 'test_type'
-      rows = []
-      rows << Ship.new('test_name_1', 'test_type_1')
-      rows << Ship.new('test_name_2', 'test_type_2')
-      @context = binding
-    end
-
-    def squeeze text
-      text.each_char.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>
-        <text:p text:style-name="Text_1_body">{%= type %}</text:p>
-        <text:p text:style-name="Text_1_body"/>
-      EOF
-
-      expected = <<-EOF
-        <text:p text:style-name="Text_1_body">test_name</text:p>
-        <text:p text:style-name="Text_1_body">test_type</text:p>
-        <text:p text:style-name="Text_1_body"/>
-      EOF
-
-      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>'
-
-      run_spec template, expected
-    end
-
-    it 'should remove empty tags after a control structure processing' do
-      template = <<-EOF
-        <table:table style="Table_1">
-          <table:row style="Table_1_A1">
-            <table:cell style="Table_1_A1_cell">
-              {% for row in rows do %}
-            </table:cell>
-          </table:row>
-            <text:p text:style-name="Text_1_body">{%= row.name %}</text:p>
-            <text:p text:style-name="Text_1_body">{%= row.type %}</text:p>
-          <table:row style="Table_1_A1">
-            <table:cell style="Table_1_A1_cell">
-              {% end %}
-            </table:cell>
-          </table:row>
-        </table:table>
-      EOF
-
-      expected = <<-EOF
-        <table:table style="Table_1">
-            <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>
-        </table:table>
-      EOF
-
-      run_spec template, expected
-    end
-
-    it 'should replace \n with soft newlines' do
-      text_with_newline = "First line\nSecond line"
-
-      template = '<text:p text:style-name="P2">{%= text_with_newline %}</text:p>'
-      expected = '<text:p text:style-name="P2">First line <text:line-break/>Second line</text:p>'
-
-      run_spec template, expected, binding
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
-
-require 'rubygems'
-require 'serenity'
-Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
-
-Ship = Struct.new(:name, :type)
-Person = Struct.new(:name, :skill)
-
-def fixture name
-  File.join(File.dirname(__FILE__), '..', 'fixtures', name)
-end

data/spec/support/matchers/be_a_document.rb

@@ -1,16 +0,0 @@
-module Serenity
-  Spec::Matchers.define :be_a_document do
-    match do |actual|
-      File.exists? actual
-    end
-
-    failure_message_for_should do |actual|
-      "expected that a file #{actual} would exist"
-    end
-
-    failure_message_for_should_not do |actual|
-      "expected that a file #{actual} would not exist"
-    end
-
-  end
-end

data/spec/support/matchers/contain_in.rb

@@ -1,20 +0,0 @@
-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

@@ -1,79 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'fileutils'
-
-module Serenity
-
-  describe Template do
-
-    after(:each) do
-      FileUtils.rm(Dir['*.odt'])
-    end
-
-    it "should process a document with simple variable substitution" do
-      @name = 'Malcolm Reynolds'
-      @title = 'captain'
-
-      template = Template.new(fixture('variables.odt'), 'output_variables.odt')
-      template.process binding
-
-      'output_variables.odt'.should contain_in('content.xml', 'Malcolm Reynolds')
-      'output_variables.odt'.should contain_in('content.xml', 'captain')
-    end
-
-    it "should unroll a simple for loop" do
-      @crew = %w{'River', 'Jayne', 'Wash'}
-
-      template = Template.new(fixture('loop.odt'), 'output_loop.odt')
-      template.process binding
-    end
-
-    it "should unroll an advanced loop with tables" do
-      @ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
-
-      template = Template.new(fixture('loop_table.odt'), 'output_loop_table.odt')
-      template.process binding
-
-      ['Firefly', 'transport', 'Colonial', 'battle'].each do |text|
-        'output_loop_table.odt'.should contain_in('content.xml', text)
-      end
-    end
-
-    it "should process an advanced document" do
-      @persons = [Person.new('Malcolm', 'captain'), Person.new('River', 'psychic'), Person.new('Jay', 'gunslinger')]
-
-      template = Template.new(fixture('advanced.odt'), 'output_advanced.odt')
-      template.process binding
-
-      ['Malcolm', 'captain', 'River', 'psychic', 'Jay', 'gunslinger'].each do |text|
-        'output_advanced.odt'.should contain_in('content.xml', text)
-      end
-    end
-
-    it "should loop and generate table rows" do
-      @ships = [Ship.new('Firefly', 'transport'), Ship.new('Colonial', 'battle')]
-
-      template = Template.new(fixture('table_rows.odt'), 'output_table_rows.odt')
-      template.process binding
-
-      ['Firefly', 'transport', 'Colonial', 'battle'].each do |text|
-        'output_table_rows.odt'.should contain_in('content.xml', text)
-      end
-    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
-
-    it 'should parse the footer' do
-      @title = 'captain'
-
-      template = Template.new(fixture('footer.odt'), 'output_footer.odt')
-      template.process(binding)
-      'output_footer.odt'.should contain_in('styles.xml', 'captain')
-    end
-  end
-end

data/spec/xml_reader_spec.rb

@@ -1,41 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-module Serenity
-
-  Node = Struct.new(:text, :type)
-
-  describe XmlReader do
-    it "should stream the xml, tag by tag" do
-      xml  = <<-EOF
-          <?xml version="1.0" encoding="UTF-8"?><office:document-content><office:scripts/>
-          <office:body><text:p style="Standard">This is a sentence</text:p><text:s>{%= yeah %}</text:s></office:body>
-          {% for row in rows %}
-          </office:document-content>
-        EOF
-
-      expected = [Node.new('<?xml version="1.0" encoding="UTF-8"?>', NodeType::TAG),
-                  Node.new('<office:document-content>', NodeType::TAG),
-                  Node.new('<office:scripts/>', NodeType::TAG),
-                  Node.new('<office:body>', NodeType::TAG),
-                  Node.new('<text:p style="Standard">', NodeType::TAG),
-                  Node.new('This is a sentence', NodeType::TEMPLATE),
-                  Node.new('</text:p>', NodeType::TAG),
-                  Node.new('<text:s>', NodeType::TAG),
-                  Node.new('{%= yeah %}', NodeType::TEMPLATE),
-                  Node.new('</text:s>', NodeType::TAG),
-                  Node.new('</office:body>', NodeType::TAG),
-                  Node.new('{% for row in rows %}', NodeType::CONTROL),
-                  Node.new('</office:document-content>', NodeType::TAG)]
-
-      reader = XmlReader.new xml
-
-      idx = 0
-      reader.each_node do |node, type|
-        expected[idx].text.should == node.strip
-        expected[idx].type.should == type
-        idx += 1
-      end
-    end
-  end
-end
-