odf-report 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d30a8580192ffaf7fa4908a5b674e69ecef19a5c3fe054baeaf1e72c3770ad
-  data.tar.gz: e402b3a61216a3070cdfcc0799930038ed9cd37687c7a844eaf76ead2b55a704
+  metadata.gz: 1ff3d6495c26d851b5497d740ce9443d69957efa8b6f11e99c9287e68c339147
+  data.tar.gz: 3ffaee2475b15b556c8bdf7f1e15697442c9603e2c8dc09643887c0170effb2c
 SHA512:
-  metadata.gz: 72e8c9581c0f655dd1ba4ef5dcfd11706f36a2e69d810261fb7f233d72f0cb982a298da7f24055d7561551f3ac737abf018809ea982d495661e0386895ee75bf
-  data.tar.gz: 9113f76a643655aa46227a0390c425cca828ba2c05835eb33d3894c7cb2219253bda16c109bf885148e63736671be3389abe804782a196ca860fb958b786ecf5
+  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/CHANGELOG.md

@@ -18,6 +18,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - 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

data/README.md

@@ -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/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.7.3"
 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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odf-report
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Sandro Duarte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/stale.yml"
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
@@ -210,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