odf-report 0.5.2 → 0.7.2

data/lib/odf-report/template.rb

@@ -0,0 +1,88 @@
+module ODFReport
+  class Template
+
+    CONTENT_FILES = ['content.xml', 'styles.xml']
+    MANIFEST_FILE = "META-INF/manifest.xml"
+
+    attr_accessor :output_stream
+
+    def initialize(template = nil, io: nil)
+      raise "You must provide either a filename or an io: string" unless template || io
+      raise "Template [#{template}] not found." unless template.nil? || ::File.exist?(template)
+
+      @template = template
+      @io = io
+    end
+
+    def update_content
+      @buffer = Zip::OutputStream.write_buffer do |out|
+        @output_stream = out
+        yield self
+      end
+    end
+
+    def update_files(&block)
+
+      get_template_entries.each do |entry|
+
+        next if entry.directory?
+
+        entry.get_input_stream do |is|
+
+          data = is.sysread
+
+          if CONTENT_FILES.include?(entry.name)
+            process_entry(data, &block)
+          end
+
+          update_file(entry.name, data) unless entry.name == MANIFEST_FILE
+
+        end
+      end
+
+    end
+
+    def update_manifest(&block)
+      entry = get_template_entries.find_entry(MANIFEST_FILE)
+
+      entry.get_input_stream do |is|
+
+        data = is.sysread
+
+        process_entry(data, &block)
+
+        update_file(MANIFEST_FILE, data)
+
+      end
+
+    end
+
+    def data
+      @buffer.string
+    end
+
+    def update_file(name, data)
+      @output_stream.put_next_entry(name)
+      @output_stream.write data
+    end
+
+    private
+
+    def get_template_entries
+
+      if @template
+        Zip::File.open(@template)
+      else
+        Zip::File.open_buffer(@io.force_encoding("ASCII-8BIT"))
+      end
+
+    end
+
+    def process_entry(entry)
+      doc = Nokogiri::XML(entry, &:noblanks)
+      yield doc
+      entry.replace(doc.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML))
+    end
+
+  end
+end

data/lib/odf-report/text.rb

@@ -8,9 +8,7 @@ module ODFReport
 
       return unless node = find_text_node(doc)
 
-      text_value = get_value(data_item)
-
-      @parser = Parser::Default.new(text_value, node)
+      @parser = Parser::Default.new(@data_source.value, node)
 
       @parser.paragraphs.each do |p|
         node.before(p)

data/lib/odf-report/version.rb

@@ -1,3 +1,3 @@
 module ODFReport
-  VERSION = "0.5.2"
+  VERSION = "0.7.2"
 end

data/odf-report.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |s|
   s.authors = ["Sandro Duarte"]
   s.description = %q{Generates ODF files, given a template (.odt) and data, replacing tags}
   s.email = %q{sandrods@gmail.com}
-  s.has_rdoc = false
   s.homepage = %q{http://sandrods.github.com/odf-report/}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Generates ODF files, given a template (.odt) and data, replacing tags}
@@ -19,13 +18,14 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 3.0.0"
   s.add_development_dependency "faker"
   s.add_development_dependency "launchy"
 
-  s.add_runtime_dependency('rubyzip', "~> 1.2.0")
-  s.add_runtime_dependency('nokogiri', ">= 1.5.0")
+  s.add_runtime_dependency('rubyzip', ">= 1.3.0")
+  s.add_runtime_dependency('nokogiri', ">= 1.10.0")
+  s.add_runtime_dependency('mime-types')
 
 end

data/spec/fields_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe "Fields" do
 
     @itens_01 = Item.get_list(3)
 
-    report = ODFReport::Report.new("spec/specs.odt") do |r|
+    report = ODFReport::Report.new("spec/templates/specs.odt") do |r|
 
       r.add_field(:field_01, @field_01)
       r.add_field(:field_02, @field_02)
@@ -51,7 +51,7 @@ RSpec.describe "Fields" do
       expect(table).not_to match(/\[COLUMN_02\]/)
       expect(table).to match(/\[COLUMN_03\]/)
 
-      expect(table).to match(item.id)
+      expect(table).to match(item.id.to_s)
       expect(table).to match(item.name)
 
     end
@@ -65,9 +65,9 @@ RSpec.describe "Fields" do
 
     @itens_01.each_with_index do |item, idx|
 
-      section = @data.xml.xpath(".//text:section[@text:name='SECTION_01_#{idx+1}']").to_s
+      section = @data.xml.at_xpath(".//text:section[#{idx+1}]").to_s
 
-      expect(section).to match(item.id)
+      expect(section).to match(item.id.to_s)
       expect(section).to match(item.name)
 
     end

data/spec/images_spec.rb

@@ -0,0 +1,159 @@
+RSpec.describe "Images" do
+
+  context('Adding Images') do
+
+    before(:context) do
+
+      @list = []
+      @list << OpenStruct.new({ name: "IMG - [1, 1]", path: 'spec/images/image_1.jpg', path2: 'spec/images/image_1.jpg' })
+      @list << OpenStruct.new({ name: "IMG - [2, 1]", path: 'spec/images/image_2.jpg', path2: 'spec/images/image_1.jpg' })
+      @list << OpenStruct.new({ name: "IMG - [3, 2]", path: 'spec/images/image_3.jpg', path2: 'spec/images/image_2.jpg' })
+      @list << OpenStruct.new({ name: "IMG - [1, 3]", path: 'spec/images/image_1.jpg', path2: 'spec/images/image_3.jpg' })
+      @list << OpenStruct.new({ name: "IMG - [2, 2]", path: 'spec/images/image_2.jpg', path2: 'spec/images/image_2.jpg' })
+
+
+      report = ODFReport::Report.new("spec/templates/images.odt") do |r|
+
+        r.add_image("IMAGE_01", 'spec/images/rails.png')
+        r.add_image("IMAGE_02", 'spec/images/piriapolis.jpg')
+
+        r.add_table('IMAGE_TABLE', @list) do |t|
+          t.add_column(:image_name, :name)
+          t.add_image('IMAGE_IN_TABLE_01', :path)
+          t.add_image('IMAGE_IN_TABLE_02', :path2)
+        end
+
+        r.add_section('SECTION', @list) do |t|
+          t.add_field(:image_name, :name)
+          t.add_image('IMAGE_IN_SECTION_01', :path2)
+          t.add_image('IMAGE_IN_SECTION_02', :path)
+        end
+
+      end
+
+      report.generate("spec/result/images.odt")
+
+      @data = Inspector.new("spec/result/images.odt")
+
+    end
+
+
+    it "simple image replacement" do
+
+      images = @data.xml.xpath("//draw:image")
+
+      expect(images[0].attribute('href').value).to eq "Pictures/rails.png"
+      expect(images[1].attribute('href').value).to eq "Pictures/piriapolis.jpg"
+
+    end
+
+    it "table columns replacement" do
+
+      table = @data.xml.at_xpath(".//table:table[@table:name='IMAGE_TABLE']")
+
+      @list.each_with_index do |item, idx|
+
+        row = table.xpath(".//table:table-row[#{idx+1}]")
+
+        images = row.xpath(".//draw:image")
+
+        expect(File.basename(images[0].attribute('href').value)).to eq File.basename(item.path)
+        expect(File.basename(images[1].attribute('href').value)).to eq File.basename(item.path2)
+
+      end
+
+    end
+
+    it "section fields replacement" do
+
+      @list.each_with_index do |item, idx|
+
+        section = @data.xml.at_xpath(".//text:section[#{idx+1}]")
+
+        images = section.xpath(".//draw:image")
+
+        expect(File.basename(images[0].attribute('href').value)).to eq File.basename(item.path)
+        expect(File.basename(images[1].attribute('href').value)).to eq File.basename(item.path2)
+
+      end
+
+    end
+  end
+
+  context "Removing Images" do
+
+    before(:context) do
+
+      @list = []
+      @list << OpenStruct.new({ name: "IMG - both ok",   path: 'spec/images/image_1.jpg', path2: 'spec/images/image_1.jpg' })
+      @list << OpenStruct.new({ name: "IMG - 1 ok",      path: 'spec/images/image_2.jpg', path2: nil })
+      @list << OpenStruct.new({ name: "IMG - 2 ok",      path: nil, path2: 'spec/images/image_3.jpg' })
+      # @list << OpenStruct.new({ name: "IMG - 2 invalid", path: nil, path2: 'spec/images/invalid.jpg' })
+
+      report = ODFReport::Report.new("spec/templates/images.odt") do |r|
+
+        # r.add_image("IMAGE_01")
+        r.add_image("IMAGE_02", nil)
+
+        r.add_table('IMAGE_TABLE', @list) do |t|
+          t.add_column(:image_name, :name)
+          t.add_image('IMAGE_IN_TABLE_01', :path)
+          t.add_image('IMAGE_IN_TABLE_02', :path2)
+        end
+
+        r.add_section('SECTION', @list) do |t|
+          t.add_field(:image_name, :name)
+          t.add_image('IMAGE_IN_SECTION_01', :path2)
+          t.add_image('IMAGE_IN_SECTION_02', :path)
+        end
+
+      end
+
+      report.generate("spec/result/images.odt")
+
+      @data = Inspector.new("spec/result/images.odt")
+
+    end
+
+    it "removes nil images in report" do
+      expect(@data.xml.at_css("draw|frame[@draw|name='IMAGE_01']")).to be
+      expect(@data.xml.at_css("draw|frame[@draw|name='IMAGE_02']")).to be_nil
+    end
+
+    it "removes nil images in tables" do
+
+      table = @data.xml.at_xpath(".//table:table[@table:name='IMAGE_TABLE']")
+
+      images = table.xpath(".//table:table-row[1]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[0].path)
+      expect(File.basename(images[1].attribute('href').value)).to eq File.basename(@list[0].path2)
+
+      images = table.xpath(".//table:table-row[2]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[1].path)
+      expect(images[1]).to be_nil
+
+      images = table.xpath(".//table:table-row[3]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[2].path2)
+      expect(images[1]).to be_nil
+
+    end
+
+    it "removes nil images in sections " do
+
+      images = @data.xml.xpath(".//text:section[1]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[0].path)
+      expect(File.basename(images[1].attribute('href').value)).to eq File.basename(@list[0].path2)
+
+      images = @data.xml.xpath(".//text:section[2]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[1].path)
+      expect(images[1]).to be_nil
+
+      images = @data.xml.xpath(".//text:section[3]//draw:image")
+      expect(File.basename(images[0].attribute('href').value)).to eq File.basename(@list[2].path2)
+      expect(images[1]).to be_nil
+
+    end
+
+  end
+
+end

data/spec/sections_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe "Sections" do
+
+  before(:context) do
+    @itens = Item.get_list(3)
+
+    report = ODFReport::Report.new("spec/templates/specs.odt") do |r|
+
+      r.add_section('SECTION_01', @itens) do |t|
+        t.add_field(:s01_field_01, :id)
+        t.add_field(:s01_field_02, :name)
+      end
+
+      r.add_section('SECTION_02', []) do |t|
+        t.add_field(:s02_field_01, :id)
+        t.add_field(:s02_field_02, :name)
+      end
+
+      r.add_section('SECTION_03', nil) do |t|
+        t.add_field(:s03_field_01, :id)
+        t.add_field(:s03_field_02, :name)
+      end
+
+    end
+
+    report.generate("spec/result/specs.odt")
+
+    @data = Inspector.new("spec/result/specs.odt")
+
+  end
+
+  it "should render section with collection" do
+    @itens.each_with_index do |item, idx|
+      section = @data.xml.at_xpath(".//text:section[#{idx+1}]").to_s
+
+      expect(section).to match(item.id.to_s)
+      expect(section).to match(item.name)
+    end
+  end
+
+  it "should remove section with empty collection" do
+    section = @data.xml.at_css("text|section[@text|name='SECTION_02']")
+    expect(section).to be_nil
+  end
+
+  it "should remove section with nil collection" do
+    section = @data.xml.at_css("text|section[@text|name='SECTION_03']")
+    expect(section).to be_nil
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -12,11 +12,9 @@ class Item
   end
 
   def self.get_list(quant = 3)
-    r = []
-    (1..quant).each do |i|
-      r << Item.new(Faker::Number.number(10), Faker::Name.name)
+    (1..quant).map do |i|
+      Item.new(Faker::Number.number(digits: 10), Faker::Name.name)
     end
-    r
   end
 
 end

data/spec/tables_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe "Tables" do
 
   before(:context) do
 
-    report = ODFReport::Report.new("spec/specs.odt") do |r|
+    report = ODFReport::Report.new("spec/templates/specs.odt") do |r|
 
       r.add_table('TABLE_02', []) do |t|
         t.add_column(:column_01, :id)

data/spec/template_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe "Templates Types" do
+
+  before(:each) do
+
+    @field_01 = Faker::Company.name
+    @field_02 = Faker::Name.name
+
+    report.add_field(:field_01, @field_01)
+    report.add_field(:field_02, @field_02)
+
+    report.generate("spec/result/specs.odt")
+
+    @data = Inspector.new("spec/result/specs.odt")
+
+  end
+
+  context "template from file" do
+    let(:report) { ODFReport::Report.new("spec/templates/specs.odt") }
+
+    it "works" do
+
+      expect(@data.text).not_to match(/\[FIELD_01\]/)
+      expect(@data.text).not_to match(/\[FIELD_02\]/)
+
+      expect(@data.text).to match @field_01
+      expect(@data.text).to match @field_02
+
+    end
+  end
+
+  context "template from a String" do
+    let(:report) { ODFReport::Report.new(io: File.open("spec/templates/specs.odt").read) }
+
+    it "works" do
+
+      expect(@data.text).not_to match(/\[FIELD_01\]/)
+      expect(@data.text).not_to match(/\[FIELD_02\]/)
+
+      expect(@data.text).to match @field_01
+      expect(@data.text).to match @field_02
+
+    end
+  end
+
+end