cure-odf-report 0.5.1b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d36288e169f5ae0e36674e1a5ddb3d4d0ea25253
+  data.tar.gz: 163d75c4ca04321dcf403f257febd24d05b7a271
+SHA512:
+  metadata.gz: 6e50976d86bd701d27f013ebeaf93c267e89a0ed8a2d44d1fe05e4ab5b03eeda1b160c1e19324f491fcc7b871eb6e04ca968ff96720fbac8820f81fa6c0aa24d
+  data.tar.gz: 65ce3ca1adbe04827703793d042d1422215f048cce1e86c6eaafd2c2d0ab560ccc4f542520f3756b15dcb5da4d01df6ade6462929f69ee960e1a0f78c6677520

data/.gitignore

@@ -0,0 +1,6 @@
+pkg
+pckg
+doc
+*.gem
+test/result
+Gemfile.lock

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--warnings
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in odf-report.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sandro Duarte
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,12 @@
+lib/odf-report.rb
+lib/odf-report/report.rb
+lib/odf-report/table.rb
+lib/odf-report/section.rb
+lib/odf-report/file_ops.rb
+lib/odf-report/hash_gsub.rb
+odf-report.gemspec
+README.textile
+test/test.odt
+test/sections.odt
+test/test.rb
+Manifest

data/README.textile

@@ -0,0 +1,223 @@
+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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'launchy'
+task :test do
+  Dir.glob('./test/*_test.rb').each { |file| require file}
+end
+
+task :open do
+  Dir.glob('./test/result/*.odt').each { |file| Launchy.open(file) }
+end

data/lib/odf-report.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'zip'
+require 'fileutils'
+require 'nokogiri'
+
+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/nested',    __FILE__)
+require File.expand_path('../odf-report/section',   __FILE__)
+require File.expand_path('../odf-report/table',     __FILE__)
+require File.expand_path('../odf-report/report',    __FILE__)
+require File.expand_path('../odf-report/actions/remove_section',    __FILE__)

data/lib/odf-report/actions/remove_section.rb

@@ -0,0 +1,22 @@
+module ODFReport
+  module Actions
+    class RemoveSection
+      def initialize(section_name)
+        @section_name = section_name.upcase
+      end
+
+      def process!(doc)
+        section_node = section_node(doc)
+
+        section_node.remove if section_node
+      end
+
+      private
+
+      def section_node(doc)
+        sections = doc.xpath(".//text:section[@text:name='#{@section_name}']")
+        sections.empty? ? nil : sections.first
+      end
+    end
+  end
+end

data/lib/odf-report/field.rb

@@ -0,0 +1,88 @@
+module ODFReport
+  class Field
+
+    DELIMITERS = %w([ ])
+
+    def initialize(opts, &block)
+      @name = opts[:name]
+      @data_field = opts[:data_field]
+
+      unless @value = opts[:value]
+
+        if block_given?
+          @block = block
+
+        else
+          @block = lambda { |item| self.extract_value(item) }
+        end
+
+      end
+
+    end
+
+    def replace!(content, data_item = nil)
+
+      txt = content.inner_html
+
+      val = get_value(data_item)
+
+      txt.gsub!(to_placeholder, sanitize(val))
+
+      content.inner_html = txt
+
+    end
+
+    def get_value(data_item = nil)
+      @value || @block.call(data_item) || ''
+    end
+
+    def extract_value(data_item)
+      return unless data_item
+
+      key = @data_field || @name
+
+      if data_item.is_a?(Hash)
+        data_item[key] || data_item[key.to_s.downcase] || data_item[key.to_s.upcase] || data_item[key.to_s.downcase.to_sym]
+
+      elsif data_item.respond_to?(key.to_s.downcase.to_sym)
+        data_item.send(key.to_s.downcase.to_sym)
+
+      else
+        raise "Can't find field [#{key}] in this #{data_item.class}"
+
+      end
+
+    end
+
+    private
+
+    def to_placeholder
+      if DELIMITERS.is_a?(Array)
+        "#{DELIMITERS[0]}#{@name.to_s.upcase}#{DELIMITERS[1]}"
+      else
+        "#{DELIMITERS}#{@name.to_s.upcase}#{DELIMITERS}"
+      end
+    end
+
+    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

@@ -0,0 +1,50 @@
+module ODFReport
+  class File
+
+    attr_accessor :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