odf-report 0.5.1 → 0.5.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzhiYWE2MTU5OTRjZWQ2NGExZDc1ZDRjMGUzM2ZlZWU1ZWY4ZWUwNg==
-  data.tar.gz: !binary |-
-    YTBkNGEzZjE1NmNkMjc3MTdiNjdmNjZhMDI4ZjAzYjg5NTU0NjJjZA==
+SHA1:
+  metadata.gz: 639774f385b52ff5939a37b9e5d46f0ef32883fa
+  data.tar.gz: 518447cce1c1ccae65960ffd0d75b617f3bb48bf
 SHA512:
-  metadata.gz: !binary |-
-    ZjU1YzA0ZjY5YmRlMmJhZTE4YmM0NjY5MDQ0MDkyNGFlYjU1MGYzOTM1NTk0
-    Y2IyODBlMmEwNWRiODgzZmViMDI1MGE1MmJhODUxYzc3MWY4NDdlNzZmYTEw
-    YzVmZDA5NDIwNTVlYTRjMTQ0YTM1ZTQ0N2JkOTE4MDIyYThkOTY=
-  data.tar.gz: !binary |-
-    MDNlY2U4ZTU2NTUxZTYzYTZlMWZkN2YxYjI1YTE0YTFlODBmMzFiOTdmMThk
-    YzYyMWQwN2QzZDcxZDhmZjE3ZmQ1ZjFhY2E0NTY5MzcxM2M4NWE3NmEzZTBk
-    ZTI1MjI2OGJmZGMzZGIzYTcwZDYxNjYzYzYyYTgzYjhkNDFmNDc=
+  metadata.gz: 823da1a19f5c7fa4d44d2f130fd208658fe38472ea252c71427e2a5580126f882c40ba5a3ccb0d4bcc55e93e54d739fd22142fc3cfb540696fa0d52539227fdd
+  data.tar.gz: ba034ba239cd822fccb1c08e2586d33aa3c7ffd9268dc372fbac54cdd5b7f2b09f63d7aa69e48b83bcc1056cd64d4e4ced757c226771eaf999428f5144f33518

data/.gitignore

@@ -3,4 +3,5 @@ pckg
 doc
 *.gem
 test/result
+spec/result
 Gemfile.lock

data/.rspec

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

data/README.textile

@@ -18,10 +18,8 @@ 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
-
+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
@@ -62,7 +60,7 @@ report = ODFReport::Report.new("Users/john/my_template.odt") do |r|
 
   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}" }
+    t.add_column(:description) { |item| "==> #{item.description}" }
   end
 
 end
@@ -76,12 +74,12 @@ and considering you have a table like this in your template
 ---------------------------------
 
 * this is my lame attempt to draw a table.
-  you don't suppose to type this.
+  you are not supposed to type this.
   you have to use an actual table.
-  i don't know... just thought I'd mention it ;-)
+  i don't know... just thought I should 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.
+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.
 

data/Rakefile

@@ -1 +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

@@ -9,7 +9,6 @@ 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/fields',    __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/field.rb

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

data/lib/odf-report/file.rb

@@ -1,10 +1,10 @@
 module ODFReport
   class File
 
-    attr_accessor :data, :output_stream
+    attr_accessor :output_stream
 
     def initialize(template)
-      raise "Template [#{template}] not found." unless ::File.exists? template
+      raise "Template [#{template}] not found." unless ::File.exist? template
       @template = template
     end
 

data/lib/odf-report/nested.rb

@@ -2,10 +2,38 @@ module ODFReport
 
   module Nested
 
-    def replace_fields!(new_section, data_item)
-      field_replace!(new_section, data_item)
+    def add_field(name, data_field=nil, &block)
+      opts = {:name => name, :data_field => data_field}
+      field = Field.new(opts, &block)
+      @fields << field
+
+    end
+    alias_method :add_column, :add_field
+
+    def add_text(name, data_field=nil, &block)
+      opts = {:name => name, :data_field => data_field}
+      field = Text.new(opts, &block)
+      @texts << field
+
     end
 
+    def add_table(table_name, collection_field, opts={})
+      opts.merge!(:name => table_name, :collection_field => collection_field)
+      tab = Table.new(opts)
+      @tables << tab
+
+      yield(tab)
+    end
+
+    def add_section(section_name, collection_field, opts={})
+      opts.merge!(:name => section_name, :collection_field => collection_field)
+      sec = Section.new(opts)
+      @sections << sec
+
+      yield(sec)
+    end
+
+
     def get_collection_from_item(item, collection_field)
 
       return item[collection_field] if item.is_a?(Hash)
@@ -31,4 +59,4 @@ module ODFReport
 
   end
 
-end
+end

data/lib/odf-report/parser/default.rb

@@ -34,6 +34,7 @@ module Parser
     end
 
     def parse
+
       xml = @template_node.parse(@text)
 
       xml.css("p", "h1", "h2").each do |p|
@@ -59,9 +60,9 @@ module Parser
 
     def parse_formatting(text)
       text.strip!
-      text.gsub!(/<strong>(.+?)<\/strong>/)  { "<text:span text:style-name=\"bold\">#{$1}<\/text:span>" }
-      text.gsub!(/<em>(.+?)<\/em>/)          { "<text:span text:style-name=\"italic\">#{$1}<\/text:span>" }
-      text.gsub!(/<u>(.+?)<\/u>/)            { "<text:span text:style-name=\"underline\">#{$1}<\/text:span>" }
+      text.gsub!(/<strong.*?>(.+?)<\/strong>/)  { "<text:span text:style-name=\"bold\">#{$1}<\/text:span>" }
+      text.gsub!(/<em.*?>(.+?)<\/em>/)          { "<text:span text:style-name=\"italic\">#{$1}<\/text:span>" }
+      text.gsub!(/<u.*?>(.+?)<\/u>/)            { "<text:span text:style-name=\"underline\">#{$1}<\/text:span>" }
       text.gsub!("\n", "")
       text
     end
@@ -87,4 +88,4 @@ module Parser
 
 end
 
-end
+end

data/lib/odf-report/report.rb

@@ -1,9 +1,7 @@
 module ODFReport
 
 class Report
-  include Fields, Images
-
-  attr_accessor :fields, :tables, :images, :sections, :file, :texts
+  include Images
 
   def initialize(template_name, &block)
 
@@ -20,19 +18,19 @@ class Report
 
   end
 
-  def add_field(field_tag, value='', &block)
+  def add_field(field_tag, value='')
     opts = {:name => field_tag, :value => value}
-    field = Field.new(opts, &block)
+    field = Field.new(opts)
     @fields << field
   end
 
-  def add_text(field_tag, value='', &block)
+  def add_text(field_tag, value='')
     opts = {:name => field_tag, :value => value}
     text = Text.new(opts)
     @texts << text
   end
 
-  def add_table(table_name, collection, opts={}, &block)
+  def add_table(table_name, collection, opts={})
     opts.merge!(:name => table_name, :collection => collection)
     tab = Table.new(opts)
     @tables << tab
@@ -40,7 +38,7 @@ class Report
     yield(tab)
   end
 
-  def add_section(section_name, collection, opts={}, &block)
+  def add_section(section_name, collection, opts={})
     opts.merge!(:name => section_name, :collection => collection)
     sec = Section.new(opts)
     @sections << sec
@@ -60,11 +58,11 @@ class Report
 
         parse_document(txt) do |doc|
 
-          replace_texts!(doc)
-          replace_fields!(doc)
+          @sections.each { |s| s.replace!(doc) }
+          @tables.each   { |t| t.replace!(doc) }
 
-          replace_sections!(doc)
-          replace_tables!(doc)
+          @texts.each    { |t| t.replace!(doc) }
+          @fields.each   { |f| f.replace!(doc) }
 
           find_image_name_matches(doc)
           avoid_duplicate_image_names(doc)
@@ -93,28 +91,6 @@ private
     txt.replace(doc.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML))
   end
 
-  def replace_fields!(content)
-    field_replace!(content)
-  end
-
-  def replace_texts!(content)
-    @texts.each do |text|
-      text.replace!(content)
-    end
-  end
-
-  def replace_tables!(content)
-    @tables.each do |table|
-      table.replace!(content)
-    end
-  end
-
-  def replace_sections!(content)
-    @sections.each do |section|
-      section.replace!(content)
-    end
-  end
-
 end
 
 end

data/lib/odf-report/section.rb

@@ -1,87 +1,43 @@
 module ODFReport
 
   class Section
-    include Fields, Nested
-
-    attr_accessor :fields, :tables, :data, :name, :collection_field, :parent
+    include Nested
 
     def initialize(opts)
       @name             = opts[:name]
       @collection_field = opts[:collection_field]
       @collection       = opts[:collection]
-      @parent           = opts[:parent]
 
       @fields = []
       @texts = []
-
       @tables = []
       @sections = []
-    end
-
-    def add_field(name, data_field=nil, &block)
-      opts = {:name => name, :data_field => data_field}
-      field = Field.new(opts, &block)
-      @fields << field
-
-    end
-
-    def add_text(name, data_field=nil, &block)
-      opts = {:name => name, :data_field => data_field}
-      field = Text.new(opts, &block)
-      @texts << field
-
-    end
-
-    def add_table(table_name, collection_field, opts={}, &block)
-      opts.merge!(:name => table_name, :collection_field => collection_field, :parent => self)
-      tab = Table.new(opts)
-      @tables << tab
-
-      yield(tab)
-    end
-
-    def add_section(section_name, collection_field, opts={}, &block)
-      opts.merge!(:name => section_name, :collection_field => collection_field, :parent => self)
-      sec = Section.new(opts)
-      @sections << sec
 
-      yield(sec)
-    end
-
-    def populate!(row)
-      @collection = get_collection_from_item(row, @collection_field) if row
     end
 
     def replace!(doc, row = nil)
 
-      return unless section = find_section_node(doc)
+      return unless @section_node = find_section_node(doc)
 
-      template = section.dup
-
-      populate!(row)
+      @collection = get_collection_from_item(row, @collection_field) if row
 
       @collection.each do |data_item|
-        new_section = template.dup
 
-        @texts.each do |t|
-          t.replace!(new_section, data_item)
-        end
+        new_section = get_section_node
+
+        @tables.each    { |t| t.replace!(new_section, data_item) }
 
-        @tables.each do |t|
-          t.replace!(new_section, data_item)
-        end
+        @sections.each  { |s| s.replace!(new_section, data_item) }
 
-        @sections.each do |s|
-          s.replace!(new_section, data_item)
-        end
+        @texts.each     { |t| t.replace!(new_section, data_item) }
 
-        replace_fields!(new_section, data_item)
+        @fields.each    { |f| f.replace!(new_section, data_item) }
 
-        section.before(new_section)
+        @section_node.before(new_section)
 
       end
 
-      section.remove
+      @section_node.remove
 
     end # replace_section
 
@@ -95,8 +51,16 @@ module ODFReport
 
     end
 
-  end
+    def get_section_node
+      node = @section_node.dup
 
-end
+      name = node.get_attribute('text:name').to_s
+      @idx ||=0; @idx +=1
+      node.set_attribute('text:name', "#{name}_#{@idx}")
+
+      node
+    end
 
+  end
 
+end