odf-report 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d30a8580192ffaf7fa4908a5b674e69ecef19a5c3fe054baeaf1e72c3770ad
-  data.tar.gz: e402b3a61216a3070cdfcc0799930038ed9cd37687c7a844eaf76ead2b55a704
+  metadata.gz: 14183fe9ba54b5f98cd72cd48aa1277aa9d5b576c7980ae2bbfeef2346c9c49d
+  data.tar.gz: dcf77b2934897f3b490effdd62a1ee1effc2d13898523249b81b4be62be1eea9
 SHA512:
-  metadata.gz: 72e8c9581c0f655dd1ba4ef5dcfd11706f36a2e69d810261fb7f233d72f0cb982a298da7f24055d7561551f3ac737abf018809ea982d495661e0386895ee75bf
-  data.tar.gz: 9113f76a643655aa46227a0390c425cca828ba2c05835eb33d3894c7cb2219253bda16c109bf885148e63736671be3389abe804782a196ca860fb958b786ecf5
+  metadata.gz: 7eb665c1fe1f414dac1b5e3ef3714b398d207125b00589573f2e2e9a2d4632355f26bf968fe3eec53c7bdcdff92c3fe24f5216fe18a1e160ddd4c8947804390a
+  data.tar.gz: 237f77a79aa11754aff00d0973c696dc9f62a8ce65b6b57c1c101293b632ee0399025f13b04f9649feaeda1d63310b58ac83ac67d5565cc602c9b2bcd5be127c

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

@@ -8,13 +8,16 @@ jobs:
   build:
     name: Build + Publish
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
       with:
-        version: 2.6.x
+        ruby-version: '3.2' 
+        bundler-cache: true
 
 #     - name: Publish to GPR
 #       run: |

data/CHANGELOG.md

@@ -18,6 +18,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - None
 
+## 0.8.0
+
+### Dependencies
+
+- nokogiri >= 1.12.0 (was >= 1.10.0)
+
+## 0.7.3
+
+### Fixed
+- newer versions (> 1.13.0) of Nokogiri where presenting "Nokogiri::CSS::SyntaxError: unexpected '|'" #120
+- prevent unnecessary memory expensive operations with missing placeholders #117
+
 ## 0.7.2
 
 ### Fixed

data/README.md

@@ -56,7 +56,7 @@ 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|
+  r.add_table("TABLE_1", @list_of_items, :header=>true) do |t|
     t.add_column(:item_id, :id)
     t.add_column(:description) { |item| "==> #{item.description}" }
   end
@@ -71,7 +71,7 @@ and considering you have a table like this in your template
 | [ITEM_ID] | [DESCRIPTION] |
 
 
-and a collection `@list_of_itens`, it will create one row for each item in the collection, and the replacement will take place accordingly.
+and a collection `@list_of_items`, 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.
 
@@ -218,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/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/parser/default.rb

@@ -34,11 +34,9 @@ module Parser
     end
 
     def parse
+      html = Nokogiri::HTML5.fragment(@text)
 
-      xml = @template_node.parse(@text)
-
-      xml.css("p", "h1", "h2").each do |p|
-
+      html.css("p", "h1", "h2").each do |p|
         style = check_style(p)
         text = parse_formatting(p.inner_html)
 
@@ -63,6 +61,7 @@ module Parser
       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!("<br\/?>", "<text:line-break/>")
       text.gsub!("\n", "")
       text
     end

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/version.rb

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

data/odf-report.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "launchy"
 
   s.add_runtime_dependency('rubyzip', ">= 1.3.0")
-  s.add_runtime_dependency('nokogiri', ">= 1.10.0")
+  s.add_runtime_dependency('nokogiri', ">= 1.12.0")
   s.add_runtime_dependency('mime-types')
 
 end

data/spec/images_spec.rb

@@ -116,8 +116,8 @@ RSpec.describe "Images" do
     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
+      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
 
     it "removes nil images in tables" do

data/spec/sections_spec.rb

@@ -38,12 +38,12 @@ RSpec.describe "Sections" do
   end
 
   it "should remove section with empty collection" do
-    section = @data.xml.at_css("text|section[@text|name='SECTION_02']")
+    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_css("text|section[@text|name='SECTION_03']")
+    section = @data.xml.at_xpath("//text:section[@text:name='SECTION_03']")
     expect(section).to be_nil
   end
 

data/spec/texts_spec.rb

@@ -0,0 +1,48 @@
+RSpec.describe "Texts" do
+   before(:context) do
+
+    @text1 = <<-HTML
+      <p>This is some text in a paragraph</p>
+    HTML
+
+    @text2 = <<-HTML
+      <p>Text before line break <br> text after line break</p>
+    HTML
+
+    @text3 = <<-HTML
+      <p>Text before entities
+         Maur&iacute;cio
+         Text after entities</p>
+    HTML
+
+
+    report = ODFReport::Report.new("spec/templates/specs.odt") do |r|
+
+      r.add_text(:text1, @text1)
+      r.add_text(:text2, @text2)
+      r.add_text(:text3, @text3)
+
+    end
+
+    report.generate("spec/result/specs.odt")
+
+    @data = Inspector.new("spec/result/specs.odt")
+
+  end
+
+  it "simple text replacement" do
+    expect(@data.text).to include "This is some text in a paragraph"
+  end
+
+  it "text replacement with <br>" do
+    expect(@data.text).to include "Text before line break"
+    expect(@data.text).to include "text after line break"
+  end
+
+  it "text replacement with html entities" do
+    expect(@data.text).to include "Text before entities"
+    expect(@data.text).to include "Maurício"
+    expect(@data.text).to include "Text after entities"
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odf-report
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Sandro Duarte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
@@ -168,6 +169,7 @@ files:
 - spec/template_spec.rb
 - spec/templates/images.odt
 - spec/templates/specs.odt
+- spec/texts_spec.rb
 - test/fields_inside_text_test.rb
 - test/images_test.rb
 - test/nested_tables_test.rb
@@ -210,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Generates ODF files, given a template (.odt) and data, replacing tags
@@ -229,6 +231,7 @@ test_files:
 - spec/template_spec.rb
 - spec/templates/images.odt
 - spec/templates/specs.odt
+- spec/texts_spec.rb
 - test/fields_inside_text_test.rb
 - test/images_test.rb
 - test/nested_tables_test.rb