odf-report 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 639774f385b52ff5939a37b9e5d46f0ef32883fa
-  data.tar.gz: 518447cce1c1ccae65960ffd0d75b617f3bb48bf
+SHA256:
+  metadata.gz: 561d0b3f786d5514b046221b73e9d9056b8ea4b41e74c91bb6ddfd41ce6919fc
+  data.tar.gz: 062e1f340e3923cb3f5e977844a2bc9acc8de1d44496cd3a9dae19d08de92c83
 SHA512:
-  metadata.gz: 823da1a19f5c7fa4d44d2f130fd208658fe38472ea252c71427e2a5580126f882c40ba5a3ccb0d4bcc55e93e54d739fd22142fc3cfb540696fa0d52539227fdd
-  data.tar.gz: ba034ba239cd822fccb1c08e2586d33aa3c7ffd9268dc372fbac54cdd5b7f2b09f63d7aa69e48b83bcc1056cd64d4e4ced757c226771eaf999428f5144f33518
+  metadata.gz: c15b086a652768a8199d45ba92ad67f3d2f1d920757d2605b3903f0b41c2f05af8a23be7234c4ef5805f32f368e8a7c44180d133584216f65f49f8e6d50c0538
+  data.tar.gz: 3b9b7907b90d3316dc63afa19e52df2c0d0b6e5e085f3454077cf78bd30916458b582093d403d998450123300e067a7ebf19bc69833bd6d0ddf2aff608b008f6

data/README.md

@@ -0,0 +1,218 @@
+
+# ODF-REPORT
+
+Gem for generating .odt files by making strings, images, tables and sections replacements in a previously created .odt file.
+
+### NEW
+
+* you can provide an `io:` param to the report, so you can use templates stored in the database.
+* now uses rubyzip ~> **1.2.0**
+
+## INSTALL
+
+In your Gemfile
+```ruby
+gem 'odf-report'
+```
+
+## USAGE
+
+### Step 1  --  the template
+
+First of all, you need a `.odt` file to serve as a template.
+Templates are normal .odt files with `[PLACEHOLDERS]` for *substitutions*.
+There are *four* kinds of substitutions available:
+* fields
+* tables
+* images
+* sections
+
+#### Fields
+
+It's just an upcase sentence, surrounded by brackets. It will be replaced for wathever value you supply.
+
+In the folowing example:
+
+```ruby
+report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
+  r.add_field :user_name, @user.name
+  r.add_field :address, "My new address"
+end
+```
+
+All occurences of `[USER_NAME]` found in the file will be replaced by the value of `@user.name` whereas all `[ADDRESS]` 'es will contains `My new address`
+
+
+#### Tables
+
+To use table placeholders, you should create a Table in your document and give it a name. In OpenOffice, it's just a matter of right-clicking the table you just created, choose `Table Properties...` and type a name in the Name field.
+
+If you inform `header: true`, the first row will be treated as a *header* and left untouched. The remaining rows will be used as the template for the table.
+
+If you have more than one template row, they will be cycled. This is usefull for making zebra tables.
+
+As with **Field placeholders**, just insert a `[FIELD_NAME]` in each cell and let the magic takes place.
+
+Taking the folowing example:
+
+```ruby
+report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
+
+  r.add_field "USER_NAME", @user.nome
+  r.add_field "ADDRESS", @user.address
+
+  r.add_table("TABLE_1", @list_of_itens, :header=>true) do |t|
+    t.add_column(:item_id, :id)
+    t.add_column(:description) { |item| "==> #{item.description}" }
+  end
+
+end
+```
+
+and considering you have a table like this in your template
+
+| #ID | Description |
+|--|--|
+| [ITEM_ID] | [DESCRIPTION] |
+
+
+and a collection `@list_of_itens`, it will create one row for each item in the collection, and the replacement will take place accordingly.
+
+Any format applied to the fields in the template will be preserved.
+
+
+### Images
+
+You must put a mock image in your `.odt` template and give it a name. That name will be used to replace the mock image for the actual image.
+You can also assign any properties you want to the mock image and they will be kept once the image is replaced.
+
+An image replace would look like this:
+
+```ruby
+report = ODFReport::Report.new("my_template.odt") do |r|
+  r.add_image :graphic1, "/path/to/the/image.jpg"
+end
+```
+
+### Sections
+
+Sometimes, you have to repeat a whole chunk of a document, in a structure a lot more complex than a table. You can make a Section in your template and use it in this situations. Creating a Section in OpenOffice is as easy as select menu *Insert* and then *Section...*, and then choose a name for it.
+
+Sections are lot like Tables, in the sense that you can pass a collection and have that section repeated for each member of the collection. *But*, Sections can have anything inside it, even Tables *and nested Sections*, as long as you provide the appropriate data structure.
+
+Let's see an example:
+
+```ruby
+  @invoices = Invoice.find(:all)
+
+  report = ODFReport::Report.new("reports/invoice.odt") do |r|
+
+    r.add_field(:title, "INVOICES REPORT")
+    r.add_field(:date, Date.today)
+
+    r.add_section("SC_INVOICE", @invoices) do |s|
+
+      s.add_field(:number) { |invoice| invoice.number.to_s.rjust(5, '0') }
+      s.add_field(:name,    :customer_name)
+      s.add_field(:address, :customer_address)
+
+      s.add_table("TB_ITEMS", :items, header: true) do |t|
+        t.add_column(:id)
+        t.add_column(:product) {|item| item.product.name }
+        t.add_column(:value, :product_value)
+      end
+
+      s.add_field(:total) do |invoice|
+        if invoice.status == 'CLOSED'
+          invoice.total
+        else
+          invoice.items.sum('product_value')}
+        end
+      end
+
+      s.add_section("SUB_NOTES", :notes) do |s1|
+
+        s1.add_field(:note_title) { |n| n.title }
+
+        s1.add_table ...
+
+      end
+
+    end
+
+  end
+```
+
+Note that when you add a Table to a Section, you don't pass the collection itself, but the attribute of the item of that section that will return the collection for that particular Table. Sounds complicated, huh? But once you get it, it's quite straightforward.
+
+In the above example, `s.add_table("TB_ITEMS", :items, header: true) do |t|`, the `:items` thing refers to a `invoice.items`. Easy, right?
+
+<hr/>
+
+### Step 2  --  generating the document
+
+It's fairly simple to generate the document. You can use this inside a Rails application or in a standalone script.
+
+#### Generating a document in a Rails application
+
+In a controller, you can have a code like this:
+
+```ruby
+def print
+
+  @ticket = Ticket.find(params[:id])
+
+  report = ODFReport::Report.new(Rails.root.join("/app/reports/ticket.odt") do |r|
+
+    r.add_field(:id,         @ticket.id.to_s)
+    r.add_field(:created_by, @ticket.created_by)
+    r.add_field(:created_at, @ticket.created_at.strftime("%d/%m/%Y - %H:%M"))
+    r.add_field(:type,       @ticket.type.name)
+    r.add_field(:status,     @ticket.status_text)
+    r.add_field(:date,       Time.now.strftime("%d/%m/%Y - %H:%M"))
+    r.add_field(:solution,   (@ticket.solution || ''))
+
+    r.add_table("OPERATORS", @ticket.operators) do |t|
+      t.add_column(:name) { |op| "#{op.name} (#{op.department.short_name})" }
+    end
+
+    r.add_table("FIELDS", @ticket.fields) do |t|
+      t.add_column(:field_name, :name)
+      t.add_column(:field_value) { |field| field.text_value || "Empty" }
+    end
+
+  end
+
+  send_data report.generate,
+		    type: 'application/vnd.oasis.opendocument.text',
+            disposition: 'attachment',
+            filename: 'report.odt'
+
+end
+```
+
+#### Generating a document in a standalone script
+
+It's very similar to a Rails app, but you can inform the path where the file will be saved.
+
+```ruby
+report = ODFReport::Report.new("ticket.odt") do |r|
+... populates the report ...
+end
+
+report.generate("./documents/new_ticket.odt")
+```
+
+#### Using a template stored in the database (or anywhere besides the file system)
+You can provide an `io:` param, containing the actual file read into a String.
+
+```ruby
+report = ODFReport::Report.new(io: @template.attachment.read) do |r|
+```
+
+<hr/>
+
+#### REQUIREMENTS
+
+**rubyzip**: for manipulating the contents of the odt file, since it's actually a zip file.
+**nokogiri**: for parsing and manipulating the document xml files.

data/lib/odf-report.rb

@@ -8,7 +8,7 @@ require File.expand_path('../odf-report/parser/default',  __FILE__)
 require File.expand_path('../odf-report/images',    __FILE__)
 require File.expand_path('../odf-report/field',     __FILE__)
 require File.expand_path('../odf-report/text',      __FILE__)
-require File.expand_path('../odf-report/file',      __FILE__)
+require File.expand_path('../odf-report/template',      __FILE__)
 require File.expand_path('../odf-report/nested',    __FILE__)
 require File.expand_path('../odf-report/section',   __FILE__)
 require File.expand_path('../odf-report/table',     __FILE__)

data/lib/odf-report/images.rb

@@ -15,7 +15,7 @@ module ODFReport
 
     end
 
-    def replace_images(file)
+    def include_image_files(file)
 
       return if @images.empty?
 

data/lib/odf-report/report.rb

@@ -3,9 +3,9 @@ module ODFReport
 class Report
   include Images
 
-  def initialize(template_name, &block)
+  def initialize(template_name = nil, io: nil)
 
-    @file = ODFReport::File.new(template_name)
+    @template = ODFReport::Template.new(template_name, io: io)
 
     @texts = []
     @fields = []
@@ -14,7 +14,7 @@ class Report
     @image_names_replacements = {}
     @sections = []
 
-    yield(self)
+    yield(self) if block_given?
 
   end
 
@@ -52,45 +52,33 @@ class Report
 
   def generate(dest = nil)
 
-    @file.update_content do |file|
+    @template.update_content do |file|
 
-      file.update_files('content.xml', 'styles.xml') do |txt|
+      file.update_files do |doc|
 
-        parse_document(txt) do |doc|
+        @sections.each { |s| s.replace!(doc) }
+        @tables.each   { |t| t.replace!(doc) }
 
-          @sections.each { |s| s.replace!(doc) }
-          @tables.each   { |t| t.replace!(doc) }
+        @texts.each    { |t| t.replace!(doc) }
+        @fields.each   { |f| f.replace!(doc) }
 
-          @texts.each    { |t| t.replace!(doc) }
-          @fields.each   { |f| f.replace!(doc) }
-
-          find_image_name_matches(doc)
-          avoid_duplicate_image_names(doc)
-
-        end
+        find_image_name_matches(doc)
+        avoid_duplicate_image_names(doc)
 
       end
 
-      replace_images(file)
+      include_image_files(file)
 
     end
 
     if dest
-      ::File.open(dest, "wb") {|f| f.write(@file.data) }
+      ::File.open(dest, "wb") {|f| f.write(@template.data) }
     else
-      @file.data
+      @template.data
     end
 
   end
 
-private
-
-  def parse_document(txt)
-    doc = Nokogiri::XML(txt)
-    yield doc
-    txt.replace(doc.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML))
-  end
-
 end
 
 end

data/lib/odf-report/template.rb

@@ -0,0 +1,68 @@
+module ODFReport
+  class Template
+
+    CONTENT_FILES = ['content.xml', 'styles.xml']
+
+    attr_accessor :output_stream
+
+    def initialize(template = nil, io: nil)
+      raise "You must provide either a filename or an io: string" unless template || io
+      raise "Template [#{template}] not found." unless template.nil? || ::File.exist?(template)
+
+      @template = template
+      @io = io
+    end
+
+    def update_content
+      @buffer = Zip::OutputStream.write_buffer do |out|
+        @output_stream = out
+        yield self
+      end
+    end
+
+    def update_files(&block)
+
+      get_template_entries.each do |entry|
+
+        next if entry.directory?
+
+        entry.get_input_stream do |is|
+
+          data = is.sysread
+
+          if CONTENT_FILES.include?(entry.name)
+            process_entry(data, &block)
+          end
+
+          @output_stream.put_next_entry(entry.name)
+          @output_stream.write data
+
+        end
+      end
+
+    end
+
+    def data
+      @buffer.string
+    end
+
+    private
+
+    def get_template_entries
+
+      if @template
+        Zip::File.open(@template)
+      else
+        Zip::File.open_buffer(@io.force_encoding("ASCII-8BIT"))
+      end
+
+    end
+
+    def process_entry(entry)
+      doc = Nokogiri::XML(entry)
+      yield doc
+      entry.replace(doc.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML))
+    end
+
+  end
+end

data/lib/odf-report/version.rb

@@ -1,3 +1,3 @@
 module ODFReport
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/odf-report.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |s|
   s.authors = ["Sandro Duarte"]
   s.description = %q{Generates ODF files, given a template (.odt) and data, replacing tags}
   s.email = %q{sandrods@gmail.com}
-  s.has_rdoc = false
   s.homepage = %q{http://sandrods.github.com/odf-report/}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Generates ODF files, given a template (.odt) and data, replacing tags}
@@ -19,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 3.0.0"
   s.add_development_dependency "faker"

data/spec/template_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe "Templates Types" do
+
+  before(:each) do
+
+    @field_01 = Faker::Company.name
+    @field_02 = Faker::Name.name
+
+    report.add_field(:field_01, @field_01)
+    report.add_field(:field_02, @field_02)
+
+    report.generate("spec/result/specs.odt")
+
+    @data = Inspector.new("spec/result/specs.odt")
+
+  end
+
+  context "template from file" do
+    let(:report) { ODFReport::Report.new("spec/specs.odt") }
+
+    it "works" do
+
+      expect(@data.text).not_to match(/\[FIELD_01\]/)
+      expect(@data.text).not_to match(/\[FIELD_02\]/)
+
+      expect(@data.text).to match @field_01
+      expect(@data.text).to match @field_02
+
+    end
+  end
+
+  context "template from a String" do
+    let(:report) { ODFReport::Report.new(io: ::File.open("spec/specs.odt").read) }
+
+    it "works" do
+
+      expect(@data.text).not_to match(/\[FIELD_01\]/)
+      expect(@data.text).not_to match(/\[FIELD_02\]/)
+
+      expect(@data.text).to match @field_01
+      expect(@data.text).to match @field_02
+
+    end
+  end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: odf-report
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Sandro Duarte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,17 +119,17 @@ files:
 - Gemfile
 - MIT-LICENSE
 - Manifest
-- README.textile
+- README.md
 - Rakefile
 - lib/odf-report.rb
 - lib/odf-report/field.rb
-- lib/odf-report/file.rb
 - lib/odf-report/images.rb
 - lib/odf-report/nested.rb
 - lib/odf-report/parser/default.rb
 - lib/odf-report/report.rb
 - lib/odf-report/section.rb
 - lib/odf-report/table.rb
+- lib/odf-report/template.rb
 - lib/odf-report/text.rb
 - lib/odf-report/version.rb
 - odf-report.gemspec
@@ -138,6 +138,7 @@ files:
 - spec/spec_helper.rb
 - spec/specs.odt
 - spec/tables_spec.rb
+- spec/template_spec.rb
 - test/fields_inside_text_test.rb
 - test/nested_tables_test.rb
 - test/sections_test.rb
@@ -173,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Generates ODF files, given a template (.odt) and data, replacing tags
@@ -183,6 +184,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/specs.odt
 - spec/tables_spec.rb
+- spec/template_spec.rb
 - test/fields_inside_text_test.rb
 - test/nested_tables_test.rb
 - test/sections_test.rb

data/README.textile

@@ -1,223 +0,0 @@
-h1. ODF-REPORT
-
-Gem for generating .odt files by making strings, images, tables and sections replacements in a previously created .odt file.
-
-h3. NEW
-
-* as per popular request, now uses rubyzip ~> 1.1.0
-* uses @Zip::OutputStream.write_buffer@ to generate the file. This should avoid corruption issues.
-* the @.generate@ method now returns the actual report binary, so you can send_data it directly
-* you can also use @.generate('file.odt')@, which saves the report to the specified file
-
-h2. INSTALL
-
-In your Gemfile
-<pre>gem 'odf-report' </pre>
-
-h2. USAGE
-
-h3. Step 1  --  the template
-
-First of all, you need to create a .odt file to serve as a template.
-Templates are normal .odt files with placeholders for *substitutions*.
-There are now *four* kinds of substitutions available: *fields*, *tables*, *images* and *sections*.
-
-h3. Fields placeholders
-
-It's just an upcase sentence, surrounded by brackets. It will be replaced for wathever value you supply.
-
-In the folowing example:
-
-<pre>
-report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
-
-  r.add_field :user_name, @user.name
-  r.add_field :address, "My new address"
-
-end
-</pre>
-
-All occurences of @[USER_NAME]@ found in the file will be replaced by the value of @@user.name@ whereas all @[ADDRESS]@ 'es will contains @My new address@
-
-It's as simple as that.
-
-
-h3. Table placeholders
-
-To use table placeholders, you should create a Table in your document and give it a name. In OpenOffice, it's just a matter of right-clicking the table you just created, choose _Table Properties..._ and type a name in the Name field.
-
-If you inform @:header=>true@, the first row will be treated as a *header* and left untouched. The remaining rows will be used as the template for the table. If you have more than one template row, they will be cycled. This is usefull for making zebra tables.
-
-As with Field placeholders, just insert a @[FIELD_NAME]@ in each cell and let the magic takes place.
-
-Taking the folowing example:
-
-<pre>
-report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
-
-  r.add_field "USER_NAME", @user.nome
-  r.add_field "ADDRESS", @user.address
-
-  r.add_table("TABLE_1", @list_of_itens, :header=>true) do |t|
-    t.add_column(:item_id, :id)
-    t.add_column(:description) { |item| "==> #{item.description}" }
-  end
-
-end
-</pre>
-
-and considering you have a table like this in your template
-
-<pre>
----------------------------------
-|  [ITEM_ID]  |  [DESCRIPTION]  |
----------------------------------
-
-* this is my lame attempt to draw a table.
-  you are not supposed to type this.
-  you have to use an actual table.
-  i don't know... just thought I should mention it ;-)
-</pre>
-
-and a collection @list_of_itens, it will create one row for each item in the collection, and the replacement will take place accordingly.
-
-Any format applied to the fields in the template will be preserved.
-
-
-h3. Images
-
-You must put a mock image in your odt template and give it a name. That name will be used to replace the mock image for the actual image.
-You can also assign any properties you want to the mock image and they will be kept once the image is replaced.
-
-An image replace would look like this:
-
-<pre>
-report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
-
-  r.add_image :graphics1, "/path/to/the/image.jpg"
-
-end
-</pre>
-
-
-h3. Sections
-
-Sometimes, you have to repeat a whole chunk of a document, in a structure a lot more complex than a table. Now you can make a Section in your template and use it in this situations. Creating a Section in OpenOffice is as easy as select menu *Insert* and then *Section...*, and then choose a name for it.
-
-*Section* 's are lot like Tables, in the sense that you can pass a collection and have that section repeated for each member of the collection. *But*, Sections can have anything inside it, even Tables *and nested Sections*, as long as you pass the appropriate data structure.
-
-Let's see an example:
-
-<pre>
-
-  @invoices = Invoice.find(:all)
-
-  report = ODFReport::Report.new("reports/invoice.odt") do |r|
-
-    r.add_field(:title, "INVOICES REPORT")
-    r.add_field(:date, Date.today)
-
-    r.add_section("SC_INVOICE", @invoices) do |s|
-
-      s.add_field(:number) { |invoice| invoice.number.to_s.rjust(5, '0') }
-      s.add_field(:name,    :customer_name)
-      s.add_field(:address, :customer_address)
-
-      s.add_table("TB_ITEMS", :items, :header => true) do |t|
-        t.add_column(:id)
-        t.add_column(:product) {|item| item.product.name }
-        t.add_column(:value, :product_value)
-      end
-
-      s.add_field(:total) do |invoice|
-        if invoice.status == 'CLOSED'
-          invoice.total
-        else
-          invoice.items.sum('product_value')}
-        end
-      end
-
-      s.add_section("SUB_NOTES", :notes) do |s1|
-
-        s1.add_field(:note_title) { |n| n.title }
-
-        s1.add_table ...
-
-      end
-
-    end
-
-  end
-</pre>
-
-Note that when you add a Table to a Section, you don't pass the collection itself, but the attribute of the item of that section that's gonna return the collection for that particular Table. Sounds complicated, huh? But once you get it, it's quite straightforward.
-
-In the above example, @s.add_table("TB_ITEMS", :items, :header => true) do |t|@, the @:items@ thing refers to a @invoice.items@. Easy, right?
-
-<hr/><br/>
-
-h3. Step 2  --  generating the document
-
-It's fairly simple to generate the document. You can use this inside a Rails application or in a standalone script.
-
-h4. Generating a document in a Rails application
-
-In a controller, you can have a code like this:
-
-<pre>
-def print
-
-  @ticket = Ticket.find(params[:id])
-
-  # For Rails 3 or latest replace #{RAILS_ROOT} to #{Rails.root}
-  report = ODFReport::Report.new("#{RAILS_ROOT}/app/reports/ticket.odt") do |r|
-
-    r.add_field(:id,         @ticket.id.to_s)
-    r.add_field(:created_by, @ticket.created_by)
-    r.add_field(:created_at, @ticket.created_at.strftime("%d/%m/%Y - %H:%M"))
-    r.add_field(:type,       @ticket.type.name)
-    r.add_field(:status,     @ticket.status_text)
-    r.add_field(:date,       Time.now.strftime("%d/%m/%Y - %H:%M"))
-    r.add_field(:solution,   (@ticket.solution || ''))
-
-    r.add_table("OPERATORS", @ticket.operators) do |t|
-      t.add_column(:operator_name) { |op| "#{op.name} (#{op.department.short_name})" }
-    end
-
-    r.add_table("FIELDS", @ticket.fields) do |t|
-      t.add_column(:field_name, :name)
-      t.add_column(:field_value) { |field| field.text_value || "Empty" }
-    end
-
-  end
-
-  send_data report.generate, type: 'application/vnd.oasis.opendocument.text',
-                              disposition: 'attachment',
-                              filename: 'report.odt'
-
-end
-</pre>
-
-
-_That's all I have to say about that._
-
-h4. Generating a document in a standalone script
-
-It's just the same as in a Rails app, but you can inform the path where the file will be saved.
-
-<pre>
-report = ODFReport::Report.new("ticket.odt") do |r|
-
-... populates the report ...
-
-end
-
-report.generate("./documents/new_ticket.odt")
-</pre>
-
-<hr/>
-
-h3. REQUIREMENTS
-
-* rubyzip*: for manipulating the contents of the odt file, since it's actually a zip file.
-* nokogiri*: for parsing and manipulating the document xml files.

data/lib/odf-report/file.rb

@@ -1,50 +0,0 @@
-module ODFReport
-  class File
-
-    attr_accessor :output_stream
-
-    def initialize(template)
-      raise "Template [#{template}] not found." unless ::File.exist? template
-      @template = template
-    end
-
-    def update_content
-      @buffer = Zip::OutputStream.write_buffer do |out|
-        @output_stream = out
-        yield self
-      end
-    end
-
-    def update_files(*content_files, &block)
-
-      Zip::File.open(@template) do |file|
-
-        file.each do |entry|
-
-          next if entry.directory?
-
-          entry.get_input_stream do |is|
-
-            data = is.sysread
-
-            if content_files.include?(entry.name)
-              yield data
-            end
-
-            @output_stream.put_next_entry(entry.name)
-            @output_stream.write data
-
-          end
-
-        end
-
-      end
-
-    end
-
-    def data
-      @buffer.string
-    end
-
-  end
-end