odf-report 0.5.1 → 0.7.1

data/README.textile

@@ -1,225 +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) do { |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 don't suppose to type this.
-  you have to use an actual table.
-  i don't know... just thought I'd mention it ;-)
-</pre>
-
-and a collection @list_of_itens, it will be created 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/fields.rb

@@ -1,40 +0,0 @@
-module ODFReport
-
-  module Fields
-
-    def field_replace!(_node, data_item = nil)
-
-      txt = _node.inner_html
-
-      @fields.each do |f|
-        val = f.get_value(data_item)
-        txt.gsub!(f.to_placeholder, sanitize(val))
-      end
-
-      _node.inner_html = txt
-
-    end
-
-    private
-
-    def sanitize(txt)
-      txt = html_escape(txt)
-      txt = odf_linebreak(txt)
-      txt
-    end
-
-    HTML_ESCAPE = { '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;' }
-
-    def html_escape(s)
-      return "" unless s
-      s.to_s.gsub(/[&"><]/) { |special| HTML_ESCAPE[special] }
-    end
-
-    def odf_linebreak(s)
-      return "" unless s
-      s.to_s.gsub("\n", "<text:line-break/>")
-    end
-
-  end
-
-end

data/lib/odf-report/file.rb

@@ -1,50 +0,0 @@
-module ODFReport
-  class File
-
-    attr_accessor :data, :output_stream
-
-    def initialize(template)
-      raise "Template [#{template}] not found." unless ::File.exists? 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

data/lib/odf-report/images.rb

@@ -1,44 +0,0 @@
-module ODFReport
-
-  module Images
-
-    IMAGE_DIR_NAME = "Pictures"
-
-    def find_image_name_matches(content)
-
-      @images.each_pair do |image_name, path|
-        if node = content.xpath("//draw:frame[@draw:name='#{image_name}']/draw:image").first
-          placeholder_path = node.attribute('href').value
-          @image_names_replacements[path] = ::File.join(IMAGE_DIR_NAME, ::File.basename(placeholder_path))
-        end
-      end
-
-    end
-
-    def replace_images(file)
-
-      return if @images.empty?
-
-      @image_names_replacements.each_pair do |path, template_image|
-
-        file.output_stream.put_next_entry(template_image)
-        file.output_stream.write ::File.read(path)
-
-      end
-
-    end # replace_images
-
-    # newer versions of LibreOffice can't open files with duplicates image names
-    def avoid_duplicate_image_names(content)
-
-      nodes = content.xpath("//draw:frame[@draw:name]")
-
-      nodes.each_with_index do |node, i|
-        node.attribute('name').value = "pic_#{i}"
-      end
-
-    end
-
-  end
-
-end

data/lib/odf-report/nested.rb

@@ -1,34 +0,0 @@
-module ODFReport
-
-  module Nested
-
-    def replace_fields!(new_section, data_item)
-      field_replace!(new_section, data_item)
-    end
-
-    def get_collection_from_item(item, collection_field)
-
-      return item[collection_field] if item.is_a?(Hash)
-
-      if collection_field.is_a?(Array)
-        tmp = item.dup
-        collection_field.each do |f|
-          if f.is_a?(Hash)
-            tmp = tmp.send(f.keys[0], f.values[0])
-          else
-            tmp = tmp.send(f)
-          end
-        end
-        collection = tmp
-      elsif collection_field.is_a?(Hash)
-        collection = item.send(collection_field.keys[0], collection_field.values[0])
-      else
-        collection = item.send(collection_field)
-      end
-
-      return collection
-    end
-
-  end
-
-end

data/test/test_fields_inside_text.rb

@@ -1,37 +0,0 @@
-# coding: UTF-8
-require '../lib/odf-report'
-require 'ostruct'
-require 'faker'
-
-html = <<-HTML
-  <p>Uniquely promote installed base total linkage via emerging deliverables com [EVENTO_TEXTO_CARTA], unleash cross-media collaboration <strong>[FUNCAO]</strong> [EVENTO_NOME].</p>
-
-  <p>Progressively fashion diverse portals nº <strong>[NUMERO_SECAO]</strong> do local <strong>[NOME_LOCAL]</strong>, situado na <strong>[ENDERECO_LOCAL]</strong> methodologies </p>
-
-  <p>Assertively orchestrate market positioning bandwidth rather than fully researched total linkage. Interactively architect granular e-markets via clicks-and-mortar ROI. Uniquely aggregate compelling.</p>
-
-  <p>Compellingly facilitate functionalized interfaces before wireless models. Compellingly morph parallel systems whereas combinado com o artigo 63, § 2º da Lei nº 9.504/97, abaixo mencionados:</p>
-
-  <p style="margin-left:1.76cm;"><em>Art. 120 - § 1º Compellingly envisioneer high standards in niches without best-of-breed leadership. Phosfluorescently unleash go forward methodologies after bricks-and-clicks niches. Authoritatively. </em></p>
-
-  <p style="margin-left:1.76cm;"><em>Art. 63 - [...] § 2º Enthusiastically parallel task user friendly functionalities whereas exceptional leadership. </em></p>
-
-  <p>Credibly enable multifunctional strategic theme areas and premium communities.</p>
-
-HTML
-
-
-report = ODFReport::Report.new("./templates/test_fields_inside_text.odt") do |r|
-
-  r.add_text(:body, html)
-
-  r.add_field('EVENTO_TEXTO_CARTA', Faker::Lorem.sentence)
-  r.add_field('FUNCAO', Faker::Lorem.word)
-  r.add_field('EVENTO_NOME', Faker::Company.name)
-
-  r.add_field('NUMERO_SECAO', Faker::Number.number(3))
-  r.add_field('NOME_LOCAL', Faker::Company.name)
-  r.add_field('ENDERECO_LOCAL', Faker::Address.street_address)
-end
-
-report.generate("./result/test_fields_inside_text.odt")

data/test/test_nested_tables.rb

@@ -1,39 +0,0 @@
-require '../lib/odf-report'
-require 'ostruct'
-
-class Item
-  attr_accessor :name, :sid, :children
-  def initialize(_name, _sid, _children=[])
-    @name=_name
-    @sid=_sid
-    @children=_children
-  end
-end
-
-items = []
-items << Item.new("LOST",           '007', %w(sawyer juliet hurley locke jack freckles))
-items << Item.new("ALIAS",          '302', %w(sidney sloane jack michael marshal))
-items << Item.new("GREY'S ANATOMY", '220', %w(meredith christina izzie alex george))
-items << Item.new("BREAKING BAD",   '556', %w(pollos gus mike heisenberg))
-
-report = ODFReport::Report.new("./templates/test_nested_tables.odt") do |r|
-
-  r.add_field("TAG_01", Time.now)
-  r.add_field("TAG_02", "TAG-2 -> New tag")
-
-  r.add_table("TABLE_MAIN", items) do |s|
-
-    s.add_column('NAME') { |i| i.name }
-
-    s.add_column('SID', :sid)
-
-    s.add_table('TABLE_S1', :children, :header=>true) do |t|
-      t.add_column('NAME1') { |item| "-> #{item}" }
-      t.add_column('INV')   { |item| item.to_s.reverse.upcase }
-    end
-
-  end
-
-end
-
-report.generate("./result/test_nested_tables.odt")