odf-report 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9603b557fe4954d39ebb8b15e64672a2fccf54a9
-  data.tar.gz: 0f7960beb896714a00d75d09db73781b176ede6f
+SHA256:
+  metadata.gz: babb3d76f7401badd099efc108cc000baa9ce38a556447162dd0d31e1ad2b940
+  data.tar.gz: 5ee08b656534f7522c60b3f784343120600761478baba47569c52d108d613237
 SHA512:
-  metadata.gz: c31b6efa59a4563028c434738547fddd7bf9520b77c5020343b5c1e2bd3a24d4324ef77ea22328a487a86a8d261ef5784a066122de3d2368b34991a9c40f283a
-  data.tar.gz: f2c540d70f4562ede248beac9e7631c8e158cdfbb0f8de353e31760d3d6578a4ccf552f52f9cde6559a0b9763c9749425b071d20f85c0a14bb14384b8b74709c
+  metadata.gz: 432a082f25cf119cc117d476abee396a1a6e24a144d5792f786aa249adf4b1bcf07a7fabad9d0789ca063484ea33c16fb74b05f6b088364efe3a0be3e5f03d5b
+  data.tar.gz: 07c003adba47dac35a15ef697e750e3a918f42f4db4cb7964c9ec4ce28141a52f74b375fc328d6a4f87ce97df381fa0a7ba14c75598b39bb9c1d435cab4a70ef

data/.gitignore

@@ -5,3 +5,4 @@ doc
 test/result
 spec/result
 Gemfile.lock
+.DS_Store

data/README.md

@@ -5,7 +5,8 @@ Gem for generating .odt files by making strings, images, tables and sections rep
 
 ### NEW
 
-* uses newer rubyzip >= **1.3.0**
+* allow nested images inside tables and sections
+* allow sections inside tables
 
 ## INSTALL
 
@@ -28,7 +29,7 @@ There are *four* kinds of substitutions available:
 
 #### Fields
 
-It's just an upcase sentence, surrounded by brackets. It will be replaced for wathever value you supply.
+It's just an upcase sentence, surrounded by brackets. It will be replaced by the value you supply.
 
 In the folowing example:
 
@@ -79,21 +80,7 @@ and a collection `@list_of_itens`, it will create one row for each item in the c
 
 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
+#### 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.
 
@@ -146,6 +133,26 @@ Note that when you add a Table to a Section, you don't pass the collection itsel
 
 In the above example, `s.add_table("TB_ITEMS", :items, header: true) do |t|`, the `:items` thing refers to a `invoice.items`. Easy, right?
 
+
+#### 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"
+
+  r.add_table("TABLE_WITH_IMAGES", @items) do |t|
+    t.add_column(:id)
+    t.add_column(:product, :product_name)
+    t.add_image('PRODUCT_IMAGE') { |item| item.image_path }
+  end  
+end
+```
+
 <hr/>
 
 ### Step 2  --  generating the document
@@ -213,5 +220,6 @@ 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.
+**rubyzip**: manipulating the contents of the odt file, since it's actually a zip file.
+**nokogiri**: parsing and manipulating the document xml files.
+**mime-types**: identify images mime types

data/bin/odt-extract

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'launchy'
+
+arg = ARGV[0]
+dir = File.basename(arg, File.extname(arg))
+
+%x( rm -rf #{dir}; unzip -d #{dir} #{arg} )
+
+Launchy.open dir

data/bin/odt-viewer

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'launchy'
+require "nokogiri"
+require "zip"
+
+xml = ""
+
+Zip::File.open(ARGV[0]) do |zip|
+  content = zip.get_entry('content.xml').get_input_stream.read
+  xml = Nokogiri::XML(content).to_xml
+end
+
+filename = File.join(Dir.mktmpdir, "#{File.basename(ARGV[0])}.result.xml")
+
+File.open(filename, 'w') { |f| f.write xml }
+
+Launchy.open filename

data/lib/odf-report.rb

@@ -2,14 +2,17 @@ require 'rubygems'
 require 'zip'
 require 'fileutils'
 require 'nokogiri'
+require 'mime/types'
+require 'securerandom'
 
 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/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__)
-require File.expand_path('../odf-report/report',    __FILE__)
+require File.expand_path('../odf-report/data_source',  __FILE__)
+require File.expand_path('../odf-report/field',        __FILE__)
+require File.expand_path('../odf-report/text',         __FILE__)
+require File.expand_path('../odf-report/template',     __FILE__)
+require File.expand_path('../odf-report/image',        __FILE__)
+require File.expand_path('../odf-report/nestable',     __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__)

data/lib/odf-report/data_source.rb

@@ -0,0 +1,64 @@
+module ODFReport
+  class DataSource
+
+    attr_reader :value
+
+    def initialize(opts, &block)
+      @value      = opts[:value]      || opts[:collection]
+      @data_field = opts[:data_field] || opts[:collection_field] || opts[:name]
+      @block      = block
+    end
+
+    def set_source(record)
+      @value = extract_value_from_item(record)
+    end
+
+    def each(&block)
+      @value.each(&block)
+    end
+
+    def empty?
+      @value.nil? || @value.empty?
+    end
+
+    private
+
+    def extract_value_from_item(record)
+
+      if @block
+        @block.call(record)
+
+      elsif record.is_a?(Hash)
+        key = @data_field
+        record[key] || record[key.to_s.downcase] || record[key.to_s.upcase] || record[key.to_s.downcase.to_sym]
+
+      elsif @data_field.is_a?(Array)
+        execute_methods_on_item(record)
+
+      elsif @data_field.is_a?(Hash) && record.respond_to?(@data_field.keys[0])
+        record.send(@data_field.keys[0], @data_field.values[0])
+
+      elsif record.respond_to?(@data_field)
+        record.send(@data_field)
+
+      else
+        raise "Can't find [#{@data_field.to_s}] in this #{record.class}"
+
+      end
+
+    end
+
+    def execute_methods_on_item(record)
+      tmp = record.dup
+      @data_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
+      tmp
+    end
+
+  end
+end

data/lib/odf-report/field.rb

@@ -5,56 +5,25 @@ module ODFReport
 
     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
+      @data_source = DataSource.new(opts, &block)
+    end
 
+    def set_source(record)
+      @data_source.set_source(record)
+      self
     end
 
     def replace!(content, data_item = nil)
 
       txt = content.inner_html
 
-      val = get_value(data_item)
-
-      txt.gsub!(to_placeholder, sanitize(val))
+      txt.gsub!(to_placeholder, sanitize(@data_source.value))
 
       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
+  private
 
     def to_placeholder
       if DELIMITERS.is_a?(Array)
@@ -82,7 +51,5 @@ module ODFReport
       s.to_s.gsub("\n", "<text:line-break/>")
     end
 
-
-
   end
 end

data/lib/odf-report/image.rb

@@ -0,0 +1,52 @@
+module ODFReport
+  class Image < Field
+
+    IMAGE_DIR_NAME = "Pictures"
+
+    attr_reader :files
+
+    def initialize(opts, &block)
+      @files = []
+      super
+    end
+
+    def replace!(doc, data_item = nil)
+
+      frame = doc.xpath("//draw:frame[@draw:name='#{@name}']").first
+      image = doc.xpath("//draw:frame[@draw:name='#{@name}']/draw:image").first
+
+      return unless image
+
+      file = @data_source.value
+
+      image.attribute('href').content = File.join(IMAGE_DIR_NAME, File.basename(file))
+      frame.attribute('name').content = SecureRandom.uuid
+
+      @files << file
+    end
+
+    def self.include_image_file(zip_file, image_file)
+      return unless image_file
+
+      href = File.join(IMAGE_DIR_NAME, File.basename(image_file))
+
+      zip_file.update_file(href, File.read(image_file))
+    end
+
+    def self.include_manifest_entry(content, image_file)
+      return unless image_file
+
+      return unless root_node = content.at("//manifest:manifest")
+
+      href = File.join(IMAGE_DIR_NAME, File.basename(image_file))
+
+      entry = content.create_element('manifest:file-entry')
+      entry['manifest:full-path']  = href
+      entry['manifest:media-type'] = MIME::Types.type_for(href)[0].content_type
+
+      root_node.add_child entry
+
+    end
+
+  end
+end

data/lib/odf-report/nestable.rb

@@ -0,0 +1,65 @@
+module ODFReport
+  class Nestable
+
+    def initialize(opts)
+      @name = opts[:name]
+
+      @data_source = DataSource.new(opts)
+
+      @fields   = []
+      @texts    = []
+      @tables   = []
+      @sections = []
+      @images   = []
+
+    end
+
+    def set_source(data_item)
+      @data_source.set_source(data_item)
+      self
+    end
+
+    def add_field(name, data_field=nil, &block)
+      opts = { name: name, data_field: data_field }
+      @fields << Field.new(opts, &block)
+    end
+    alias_method :add_column, :add_field
+
+    def add_text(name, data_field=nil, &block)
+      opts = {name: name, data_field: data_field}
+      @texts << Text.new(opts, &block)
+    end
+
+    def add_image(name, data_field=nil, &block)
+      opts = {name: name, data_field: data_field}
+      @images << Image.new(opts, &block)
+    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 all_images
+      (@images.map(&:files) + @sections.map(&:all_images) + @tables.map(&:all_images)).flatten
+    end
+
+    def wrap_with_ns(node)
+      <<-XML
+       <root xmlns:draw="a" xmlns:xlink="b" xmlns:text="c" xmlns:table="d">#{node.to_xml}</root>
+      XML
+    end
+    
+  end
+end

data/lib/odf-report/nested.rb

@@ -3,22 +3,24 @@ module ODFReport
   module Nested
 
     def add_field(name, data_field=nil, &block)
-      opts = {:name => name, :data_field => data_field}
-      field = Field.new(opts, &block)
-      @fields << field
+      opts = {name: name, data_field: data_field}
+      @fields << Field.new(opts, &block)
 
     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
+      opts = {name: name, data_field: data_field}
+      @texts << Text.new(opts, &block)
+    end
 
+    def add_image(name, data_field=nil, &block)
+      opts = {name: name, data_field: data_field}
+      @images << Image.new(opts, &block)
     end
 
     def add_table(table_name, collection_field, opts={})
-      opts.merge!(:name => table_name, :collection_field => collection_field)
+      opts.merge!(name: table_name, collection_field: collection_field)
       tab = Table.new(opts)
       @tables << tab
 
@@ -26,13 +28,16 @@ module ODFReport
     end
 
     def add_section(section_name, collection_field, opts={})
-      opts.merge!(:name => section_name, :collection_field => collection_field)
+      opts.merge!(name: section_name, collection_field: collection_field)
       sec = Section.new(opts)
       @sections << sec
 
       yield(sec)
     end
 
+    def all_images
+      (@images.map(&:files) + @sections.map(&:all_images) + @tables.map(&:all_images)).flatten
+    end
 
     def get_collection_from_item(item, collection_field)