odf-report 0.7.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: babb3d76f7401badd099efc108cc000baa9ce38a556447162dd0d31e1ad2b940
-  data.tar.gz: 5ee08b656534f7522c60b3f784343120600761478baba47569c52d108d613237
+  metadata.gz: 1ff3d6495c26d851b5497d740ce9443d69957efa8b6f11e99c9287e68c339147
+  data.tar.gz: 3ffaee2475b15b556c8bdf7f1e15697442c9603e2c8dc09643887c0170effb2c
 SHA512:
-  metadata.gz: 432a082f25cf119cc117d476abee396a1a6e24a144d5792f786aa249adf4b1bcf07a7fabad9d0789ca063484ea33c16fb74b05f6b088364efe3a0be3e5f03d5b
-  data.tar.gz: 07c003adba47dac35a15ef697e750e3a918f42f4db4cb7964c9ec4ce28141a52f74b375fc328d6a4f87ce97df381fa0a7ba14c75598b39bb9c1d435cab4a70ef
+  metadata.gz: 6eff87a548135805364a1a214687e3b949975184b71bd0ea1796351110e4e142e02e6fda65a45bd039a4825e7bd58f435e2267a040a7ee69c1f8983a956331ce
+  data.tar.gz: 6638443f8259b7b2c8b1fcbee7efa83c935febacbf28141e2392dc2de4a1b67d31caea6726070fe85dfb7eeb1eefb23c39ee57527a8621694252b3a31130ced2

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 21
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github/workflows/gem-push.yml

@@ -0,0 +1,40 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+#     - name: Publish to GPR
+#       run: |
+#         mkdir -p $HOME/.gem
+#         touch $HOME/.gem/credentials
+#         chmod 0600 $HOME/.gem/credentials
+#         printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+#         gem build *.gemspec
+#         gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+#       env:
+#         GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+#         OWNER: username
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Unreleased
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- None
+
+## 0.7.3
+
+### Fixed
+- newer versions (> 1.3.0) of Nokogiri where presenting "Nokogiri::CSS::SyntaxError: unexpected '|'" #120
+- prevent unnecessary memory expensive operations with missing placeholders #117
+
+## 0.7.2
+
+### Fixed
+
+- files being recognized as "broken file" in Microsoft Word
+
+
+## 0.7.1
+
+### Added
+
+- remove image if path is null
+- remove section if collection is empty/null
+
+
+## 0.7.0
+
+### Added
+
+- allow nested images inside tables and sections
+- allow sections inside tables
+
+### Dependencies
+
+- rubyzip >= 1.3.0 (was ~> 1.2.0)
+
+
+## 0.6.0
+
+### Breaking Changes
+
+- `ODFReport::File` renamed to `ODFReport::Template`
+- `ODFReport::Report` constructor signature changed
+
+### Dependencies
+
+- rubyzip ~> 1.2.0 (was ~> 1.1.0)
+
+
+## Earlier Versions
+
+- No docs yet. Contributions welcome!

data/README.md

@@ -3,11 +3,6 @@
 
 Gem for generating .odt files by making strings, images, tables and sections replacements in a previously created .odt file.
 
-### NEW
-
-* allow nested images inside tables and sections
-* allow sections inside tables
-
 ## INSTALL
 
 In your Gemfile
@@ -223,3 +218,19 @@ report = ODFReport::Report.new(io: @template.attachment.read) do |r|
 **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
+
+#### TROUBLESHOOTING
+
+##### Placeholder not replaced
+
+If your placeholder is not being replaced, the problem might come from OpenOffice/LibreOffice which, when a placeholder is edited,  add some markup that prevents odf-report from identifying the placeholder.
+
+The golden rule is: NEVER edit the placeholders. If you want to change one, delete it an write again, including the []
+Example: if you have, say, [USER] in your template and you want to change to [USERNAME], you should not edit and type NAME.
+Delete the PLACEHOLDER [USER] and type [USERNAME].
+
+##### Word found unreadable content
+
+- Symptom: You prepare your template file in eg. LibreOffice, and when you open the template in Word it says "Word found unreadable content"
+- Solution: Open your template in LibreOffice, save as `.docx`, quit LibreOffice. Open the `.docx` in LibreOffice, save as `.odt`.
+- Hypothesis: Word does not support all ODT features. Saving as `.docx` removes those features of the document.

data/lib/odf-report/data_source.rb

@@ -14,6 +14,7 @@ module ODFReport
     end
 
     def each(&block)
+      return unless @value
       @value.each(&block)
     end
 

data/lib/odf-report/field.rb

@@ -17,9 +17,9 @@ module ODFReport
 
       txt = content.inner_html
 
-      txt.gsub!(to_placeholder, sanitize(@data_source.value))
-
-      content.inner_html = txt
+      if txt.gsub!(to_placeholder, sanitize(@data_source.value))
+        content.inner_html = txt
+      end
 
     end
 

data/lib/odf-report/image.rb

@@ -19,10 +19,15 @@ module ODFReport
 
       file = @data_source.value
 
-      image.attribute('href').content = File.join(IMAGE_DIR_NAME, File.basename(file))
-      frame.attribute('name').content = SecureRandom.uuid
-
-      @files << file
+      if file
+        image.attribute('href').content = File.join(IMAGE_DIR_NAME, File.basename(file))
+        frame.attribute('name').content = SecureRandom.uuid
+
+        @files << file
+      else
+        frame.remove
+      end
+      
     end
 
     def self.include_image_file(zip_file, image_file)

data/lib/odf-report/report.rb

@@ -45,7 +45,7 @@ class Report
     yield(sec)
   end
 
-  def add_image(image_name, value='')
+  def add_image(image_name, value=nil)
     opts = {:name => image_name, :value => value}
     image = Image.new(opts)
     @images << image

data/lib/odf-report/section.rb

@@ -26,11 +26,11 @@ module ODFReport
   private
 
     def find_section_node(doc)
-      @section_node = doc.at_css("text|section[@text|name='#{@name}']")
+      @section_node = doc.at_xpath("//text:section[@text:name='#{@name}']")
     end
 
     def deep_clone(node)
-      Nokogiri::XML(wrap_with_ns(node)).at("text|section")
+      Nokogiri::XML(wrap_with_ns(node)).at_xpath("//text:section")
                                        .tap { |n| n.attribute('name').content = SecureRandom.uuid }
 
     end

data/lib/odf-report/table.rb

@@ -60,7 +60,6 @@ module ODFReport
       end
 
       return deep_clone(ret)
-      # return ret.dup
     end
 
     def get_start_node
@@ -72,11 +71,11 @@ module ODFReport
     end
 
     def find_table_node(doc)
-      doc.at_css("table|table[@table|name='#{@name}']")
+      doc.at_xpath("//table:table[@table:name='#{@name}']")
     end
 
     def deep_clone(node)
-      Nokogiri::XML(wrap_with_ns(node)).at("table|table-row")
+      Nokogiri::XML(wrap_with_ns(node)).at_xpath("//table:table-row")
     end
 
   end

data/lib/odf-report/template.rb

@@ -35,7 +35,7 @@ module ODFReport
             process_entry(data, &block)
           end
 
-          update_file(entry.name, data)
+          update_file(entry.name, data) unless entry.name == MANIFEST_FILE
 
         end
       end

data/lib/odf-report/version.rb

@@ -1,3 +1,3 @@
 module ODFReport
-  VERSION = "0.7.0"
+  VERSION = "0.7.3"
 end

data/spec/images_spec.rb

@@ -1,77 +1,156 @@
 RSpec.describe "Images" do
 
-  before(:context) do
+  context('Adding Images') 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' })
+    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')
+      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
 
-      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)
+      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
 
-    report.generate("spec/result/images.odt")
+    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")
 
-    @data = Inspector.new("spec/result/images.odt")
+        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
 
-  it "simple image replacement" do
+    before(:context) do
 
-    images = @data.xml.xpath("//draw:image")
+      @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' })
 
-    expect(images[0].attribute('href').value).to eq "Pictures/rails.png"
-    expect(images[1].attribute('href').value).to eq "Pictures/piriapolis.jpg"
+      report = ODFReport::Report.new("spec/templates/images.odt") do |r|
 
-  end
+        # r.add_image("IMAGE_01")
+        r.add_image("IMAGE_02", nil)
 
-  it "table columns replacement" do
+        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
 
-    table = @data.xml.at_xpath(".//table:table[@table:name='IMAGE_TABLE']")
+        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
 
-    @list.each_with_index do |item, idx|
+      end
 
-      row = table.xpath(".//table:table-row[#{idx+1}]")
+      report.generate("spec/result/images.odt")
 
-      images = row.xpath(".//draw:image")
+      @data = Inspector.new("spec/result/images.odt")
 
-      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
 
+    it "removes nil images in report" do
+      expect(@data.xml.at_xpath(".//draw:frame[@draw:name='IMAGE_01']")).to be
+      expect(@data.xml.at_xpath(".//draw:frame[@draw:name='IMAGE_02']")).to be_nil
     end
 
-  end
+    it "removes nil images in tables" do
+
+      table = @data.xml.at_xpath(".//table:table[@table:name='IMAGE_TABLE']")
 
-  it "section fields replacement" do
+      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
 
-    @list.each_with_index do |item, idx|
+    it "removes nil images in sections " do
 
-      section = @data.xml.at_xpath(".//text:section[#{idx+1}]")
+      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 = section.xpath(".//draw:image")
+      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
 
-      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)
+      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
 

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_xpath("//text:section[@text:name='SECTION_02']")
+    expect(section).to be_nil
+  end
+
+  it "should remove section with nil collection" do
+    section = @data.xml.at_xpath("//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(digits: 10), Faker::Name.name)
+    (1..quant).map do |i|
+      Item.new(Faker::Number.number(digits: 10), Faker::Name.name)
     end
-    r
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odf-report
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.3
 platform: ruby
 authors:
 - Sandro Duarte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,8 +130,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - Manifest
@@ -144,7 +147,6 @@ files:
 - lib/odf-report/field.rb
 - lib/odf-report/image.rb
 - lib/odf-report/nestable.rb
-- lib/odf-report/nested.rb
 - lib/odf-report/parser/default.rb
 - lib/odf-report/report.rb
 - lib/odf-report/section.rb
@@ -161,6 +163,7 @@ files:
 - spec/images/placeholder.jpg
 - spec/images/rails.png
 - spec/images_spec.rb
+- spec/sections_spec.rb
 - spec/spec_helper.rb
 - spec/tables_spec.rb
 - spec/template_spec.rb
@@ -208,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Generates ODF files, given a template (.odt) and data, replacing tags
@@ -221,6 +224,7 @@ test_files:
 - spec/images/placeholder.jpg
 - spec/images/rails.png
 - spec/images_spec.rb
+- spec/sections_spec.rb
 - spec/spec_helper.rb
 - spec/tables_spec.rb
 - spec/template_spec.rb

data/lib/odf-report/nested.rb

@@ -1,67 +0,0 @@
-module ODFReport
-
-  module Nested
-
-    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 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