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

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 six kinds of substitutions available:

fields
text
bookmarks
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:

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

Text

You can replace any word anywhere in the template in square brackets, f.i. [TEXT], with html. The supplied html string may be large. Currently suppoerted html tags

HTML Inline Elements

<a>, <span>, <strong>, <b>, <em>, <i>, <ins>, <u>, <del>, <strike>, <sub>, <sup>, <ode>

HTML Block Elements

<ol>, <ul>, <li> <table> <p> <blockquote> <pre>

<ol>, <ul>, <li> may be nested <table> may be nested

In the following example

:text wil replace [TEXT], :example will replace [EXAMPLE], and so on

report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
  r.add_text :text, html
end

Bookmarks

In the following example

:text wil replace boomark TEXT, :example will replace bookmark EXAMPLE, and so on

report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
  r.add_bookmark :text, html
end

html will either be copied after an empty bookmark or will replace the bookmark

bookmark reader

In the following example

:text will add content to named section TEXT, :example will add content to named section EXAMPLE, and so on

report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
  r.add_section_reader
  r.add_bookmark_reader
  hash = r.extract
end
hash = report.extract

will return a hash with all bookmarks found in the template

{
  :content => {
    :sections => {
      "Section1" => "[TEXT]"
    }, 
    :bookmarks => { 
      "MyREF" => "REF", 
      "BOOKMARK1" => "MyBookmarks",
      "Bookmark 2" => "My second bookmark", 
      "Bookmark without content Bookmark 1" => "All text to the end of the paragrapgh"
     }
  }, 
  :styles => {
    :sections=>{},
    :bookmarks=>{}
  }
}

content hash contains bookmarks of the page content, styles hash contains bookmarks on the master page, i.e. footers and headers of the odt template

it is possible to query specific bookmarks, sections

report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
  r.add_section_reader "My Section"
  r.add_bookmark_reader "Wonderful Bokokmark"
  hash = r.extract # here ...
end
hash = report.extract # ...or here

{
  :content => {
    :sections => {
      "My Section" => "My Text"
    }, 
    :bookmarks => { 
      "Wonderful Bokokmark" => "Wonderful Text"
     }
  }, 
  :styles => {
    :sections=>{},
    :bookmarks=>{}
  }
}

automatic styles

add standard styles for any of html tags

h1, h2, h3, h4, h5, h6, p, subparagraph, center, left, right, justify, bold, underline, italic, strikethrough, sup, sub, a, pre, quote, code, table, tr, td, tc, td

report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
  r.add_style :h1, :h2, :h3
  r.add_style :p, :a
end

styles

every tag will get a style name identical to its name, so <h1> will have a style-name "h1" associated to it. In your template you may create a format "h1", "h2", "p" and so forth. All styles refer to a style "body". So define font, color, size, etc in body and it will have effect on all styles. If there is no format named body, then Standard format is chosen by the odt program (LibreOffice, Word...)

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:

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:

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:

  @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?

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:

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.

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.

report = ODFReport::Report.new(io: @template.attachment.read) do |r|

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.

HugoHasenbein/odf-report

ODF-REPORT

NEW

INSTALL

USAGE

Step 1 -- the template

Fields

Text

HTML Inline Elements

HTML Block Elements

Bookmarks

bookmark reader

automatic styles

styles

Tables

Images

Sections

Step 2 -- generating the document

Generating a document in a Rails application

Generating a document in a standalone script

Using a template stored in the database (or anywhere besides the file system)

REQUIREMENTS