lm_docstache 2.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 805d05c9872a3562ac59527ada43842f4f28412d4a273d3010986f1182ee8421
-  data.tar.gz: 1c0ecd9d43788420553310cefcba6bcca8fe24cd6dc14ff3cbac27f2cfb8ac8f
+  metadata.gz: f57ee42bd7804fc41051ca123be801e909acfee0b0406a5eac91e8f562827f11
+  data.tar.gz: 21ab27cac4e621eb3d3c391b71945a9f29dac1343d790ccb4026a191dbee62ae
 SHA512:
-  metadata.gz: 66881d21495aa30890ebfc392e4292bfd6ef0bccb9b31d147381b606478996707d82cb745d3dd387f98a793b743f54d695be7149282add2b4707438262bc1a0e
-  data.tar.gz: 0a75364125a98fbd22150cbcde7e3826ab2a8d28705e321e0a471290838867d211ebda8a9181fcf7bf4a1428c6351fa1e93fc0ad33c200f850ae71bed3a0808d
+  metadata.gz: 642af591848de049083886277afa1fcd082cf150785d7610ebc15ff328ddc53527bc373e4ab18f910eabffe16b747d8f2191332a968b9e5716a52b4a2e5b2a62
+  data.tar.gz: e5d7b66bdb616221ccb789841ce6d84eb7ce76b44c2319ebf522c0f8cd4fb53069fbe93df745724c34ec450884b7b462932624dc2bc10a85216dd1c655bf00d5

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 2.1.2
+
+### Bugfix
+
+* Giving a document there is no *rPr* tag we should add new *rPr* tag before 
+  *t* tag.
+
+## 2.1.1
+
+### Improvements
+
+* Hidden custom tags now follow your document background color. If there is no background defined
+  we assume white font color.
+
+## 2.1.0
+
+#### Improvements
+
+* Add new feature which you're able to "hide" matching RegExp rule with white font color.
+  This change allows you to keep your content and don't loose locations of hidden tags.
+  You can use it just adding `hide_custom_tags` list of RegExp options to `Document#render_file`.
+* Added `Document#render_xml` options parameter so you can call it with more documents
+  formatting possibilities.
+
+## 2.0.2
+
+### Improvements and bugfixes
+
+* Fix a bug related to a bad empty text nodes handling approach inside
+  `Document#flatten_paragraph` logic.
+
+## 2.0.1
+
+### Improvements and bugfixes
+
+* Improve the approach on fixing errors around paragraphs that have tags through
+  multiple `w:r` elements, by merging only `w:r` that have same styles.
+
 ## 2.0.0
 
 ### Breaking changes

data/lib/lm_docstache.rb

@@ -2,6 +2,7 @@ require 'nokogiri'
 require 'zip'
 require "lm_docstache/version"
 require "lm_docstache/document"
+require 'lm_docstache/hide_custom_tags'
 require "lm_docstache/parser"
 require "lm_docstache/condition"
 require "lm_docstache/conditional_block"

data/lib/lm_docstache/document.rb

@@ -1,7 +1,7 @@
 module LMDocstache
   class Document
     TAGS_REGEXP = /{{.+?}}/
-    ROLES_REGEXP = /(\{\{(sig|sigfirm|date|check|text|initial)\|(req|noreq)\|(.+?)\}\})/
+    ROLES_REGEXP = /({{(sig|sigfirm|date|check|text|initial)\|(req|noreq)\|(.+?)}})/
 
     def initialize(*paths)
       raise ArgumentError if paths.empty?
@@ -65,7 +65,7 @@ module LMDocstache
     end
 
     def fix_errors
-      problem_paragraphs.each { |p| flatten_paragraph(p) if p.present? }
+      problem_paragraphs.each { |pg| flatten_paragraph(pg) if pg }
     end
 
     def errors?
@@ -93,8 +93,8 @@ module LMDocstache
       buffer.sysread
     end
 
-    def render_xml(data = {})
-      render_documents(data)
+    def render_xml(data = {}, render_options = {})
+      render_documents(data, nil, render_options)
     end
 
     private
@@ -125,15 +125,23 @@ module LMDocstache
     end
 
     def flatten_paragraph(paragraph)
-      run_nodes = paragraph.css('w|r')
-      host_run_node = run_nodes.shift
+      return if (run_nodes = paragraph.css('w|r')).size < 2
 
-      until host_run_node.at_css('w|t') || run_nodes.size == 0
-        host_run_node = run_nodes.shift
-      end
+      while run_node = run_nodes.pop
+        next if run_nodes.empty?
+
+        style_node = run_node.at_css('w|rPr')
+        style_html = style_node ? style_node.inner_html : ''
+        previous_run_node = run_nodes.last
+        previous_style_node = previous_run_node.at_css('w|rPr')
+        previous_style_html = previous_style_node ? previous_style_node.inner_html : ''
+        previous_text_node = previous_run_node.at_css('w|t')
+        current_text_node = run_node.at_css('w|t')
+
+        next if style_html != previous_style_html
+        next if current_text_node.nil? || previous_text_node.nil?
 
-      run_nodes.each do |run_node|
-        host_run_node.at_css('w|t').content += run_node.text
+        previous_text_node.content = previous_text_node.text + run_node.text
         run_node.unlink
       end
     end

data/lib/lm_docstache/hide_custom_tags.rb

@@ -0,0 +1,77 @@
+module LMDocstache
+  class HideCustomTags
+    attr_reader :document, :hide_custom_tags
+
+    # The +hide_custom_tags+ options is an +Array+ of +Regexp+ or +String+ representing
+    # the pattern you expect to keep at the document but with white font color.
+    #
+    # You have to remember is not acceptable to have capture groups in your +Regexp's+.
+    # We don't accept because we need to find all parts of your text, split it in multiple runs
+    # and add document background color or white font color to matching custom tags.
+    def initialize(document:, hide_custom_tags: [])
+      @document = document
+      @hide_custom_tags = hide_custom_tags
+    end
+
+    # Find all run nodes matching hide custom tags +Regexp's+ options you defined, split it
+    # in multiple runs and replace font color to document background color or white in the matching tag run node.
+    def hide_custom_tags!
+      hide_custom_tags.each do |full_pattern|
+        paragraphs = document.css('w|p')
+        while paragraph = paragraphs.shift do
+          next unless paragraph.text =~ full_pattern
+          run_nodes = paragraph.css('w|r')
+          while run_node = run_nodes.shift
+            next if run_node.text.to_s.strip.size == 0
+            remainder_run_node = run_node.clone
+            run_node.unlink
+            tag_contents = split_tag_content(remainder_run_node.text, full_pattern)
+            tag_contents[:content_list].each_with_index do |content, idx|
+              replace_content(remainder_run_node, content)
+              run_node_with_match = remainder_run_node.dup
+              matched_tag = tag_contents[:matched_tags][idx]
+              nodes_list = [remainder_run_node]
+              if matched_tag
+                replace_style(run_node_with_match)
+                replace_content(run_node_with_match, matched_tag)
+                nodes_list << run_node_with_match
+              end
+              paragraph << Nokogiri::XML::NodeSet.new(document, nodes_list)
+              remainder_run_node = remainder_run_node.clone
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def font_color
+      @font_color ||= document.at_css('w|background')&.attr('w:color') || 'FFFFFF'
+    end
+
+    def split_tag_content(text, full_pattern)
+      content_list = text.split(full_pattern)
+      content_list = content_list.empty? ? [''] : content_list
+      matched_tags = text.scan(full_pattern)
+      { content_list: content_list, matched_tags: matched_tags}
+    end
+
+    def replace_style(run_node)
+      style = run_node.at_css('w|rPr')
+      if style
+        w_color = style.at_css('w|color')
+        w_color.unlink if w_color
+        style << "<w:color w:val=\"#{font_color}\"/>"
+      else
+        run_node.prepend_child("<w:rPr><w:color w:val=\"#{font_color}\"/></w:rPr>")
+      end
+    end
+
+    def replace_content(run_node, content)
+      run_text = run_node.at_css('w|t')
+      run_text['xml:space'] = 'preserve'
+      run_text.content = content
+    end
+  end
+end

data/lib/lm_docstache/parser.rb

@@ -17,7 +17,7 @@ module LMDocstache
     BLOCK_MATCHER = /#{BLOCK_PATTERN}/
     VARIABLE_MATCHER = /{{([^#\^\/].*?)}}/
 
-    attr_reader :document, :data, :blocks, :special_variable_replacements
+    attr_reader :document, :data, :blocks, :special_variable_replacements, :hide_custom_tags
 
     # The +special_variable_replacements+ option is a +Hash+ where the key is
     # expected to be either a +Regexp+ or a +String+ representing the pattern
@@ -34,13 +34,27 @@ module LMDocstache
     # * any other value that will be turned into a string -> in this case, this
     #   will be the value that will replace the matched string
     #
+    # The +hide_custom_tags+ options is an +Array+ of +Regexp+ or +String+ representing
+    # the pattern you expect to keep at the document but with white font color.
+    #
+    # You have to remember is not acceptable to have capture groups in your +Regexp's+.
+    # We don't accept because we need to find all parts of your text, split it in multiple runs
+    # and add document background color or white font color to matching custom tags.
     def initialize(document, data, options = {})
       @document = document
       @data = data.transform_keys(&:to_s)
       @special_variable_replacements = options.fetch(:special_variable_replacements, {})
+      @hide_custom_tags = load_hide_custom_tags(options)
+    end
+
+    def load_hide_custom_tags(options)
+      options.fetch(:hide_custom_tags, []).map do |regexp_str|
+        regexp_str.is_a?(String) ? Regexp.new("{{#{regexp_str}}}") : /{{#{regexp_str.source}}/
+      end
     end
 
     def parse_and_update_document!
+      hide_custom_tags!
       find_blocks
       replace_conditional_blocks_in_document!
       replace_variables_in_document!
@@ -81,6 +95,11 @@ module LMDocstache
       @blocks
     end
 
+    def hide_custom_tags!
+      custom_tags = HideCustomTags.new(document: document, hide_custom_tags: hide_custom_tags)
+      custom_tags.hide_custom_tags!
+    end
+
     # Evaluates all conditional blocks inside the given XML document and keep or
     # remove their content inside the document, depending on the truthiness of
     # the condition on each given conditional block.
@@ -115,6 +134,7 @@ module LMDocstache
     end
 
     def has_skippable_variable?(text)
+      return true if hide_custom_tags.find { |pattern| text =~ pattern }
       !!special_variable_replacements.find do |(pattern, value)|
         pattern = pattern.is_a?(String) ? /{{#{pattern}}}/ : /{{#{pattern.source}}}/
         text =~ pattern && value == false

data/lib/lm_docstache/renderer.rb

@@ -6,7 +6,7 @@ module LMDocstache
 
     def initialize(xml, data, options = {})
       @content = xml
-      @parser = Parser.new(xml, data, options.slice(:special_variable_replacements))
+      @parser = Parser.new(xml, data, options.slice(:special_variable_replacements, :hide_custom_tags))
     end
 
     def render

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "2.0.0"
+  VERSION = "2.1.2"
 end

data/spec/conditional_block_spec.rb

@@ -24,9 +24,7 @@ describe LMDocstache::Renderer do
   def render_docx(doc_text)
     # create doc from blank
     blank_doc.render_replace(temp_file, doc_text)
-
-    doc = LMDocstache::Document.new(temp_file).render_file(result_file, data)
-
+    LMDocstache::Document.new(temp_file).render_file(result_file, data)
     result_doc = LMDocstache::Document.new(result_file).render_xml(data)
     result_doc["word/document.xml"].text
   end

data/spec/hide_custom_tags_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe LMDocstache::HideCustomTags do
+
+  context '#example' do
+    let(:output_dir) { "#{base_path}/tmp/" }
+    let(:output_file) { File.new("#{output_dir}/BlankTestOutput.docx", 'w') }
+
+    before do
+      FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
+      Dir.mkdir(output_dir)
+    end
+
+    after do
+      File.delete(output_file.path)
+    end
+
+    let(:base_path) { SPEC_BASE_PATH.join('example_input') }
+    let(:document) { LMDocstache::Document.new(input_file).instance_variable_get(:@document) }
+    let(:regexp_tag) { /{{(?:sig|sigfirm|date|check|text|initial)\|(?:req|noreq)\|.+?}}/ }
+    let(:hide_custom_tags) {
+      LMDocstache::HideCustomTags.new(document: document, hide_custom_tags: [ regexp_tag ])
+    }
+
+    context "giving a document with blue background" do
+      let(:input_file) { "#{base_path}/sample-signature-blue.docx" }
+
+      it 'expect to have a white color on all hide custom tags matching and have first child node equal rPr tag' do
+        hide_custom_tags.hide_custom_tags!
+        d = hide_custom_tags.document
+        run_nodes = d.css('w|p w|r')
+        while run_node = run_nodes.shift
+          if run_node.text =~ regexp_tag
+            expect(run_node.at_css('w|rPr w|color').first[1]).to eq('4472C4')
+            expect(run_node.children.first.name).to eq('rPr')
+          end
+        end
+      end
+    end
+
+    context 'giving a document with white background' do
+      let(:input_file) { "#{base_path}/sample-signature.docx" }
+
+      it 'expect to have a white color on all hide custom tags matching and have first child node equal rPr tag' do
+        hide_custom_tags.hide_custom_tags!
+        d = hide_custom_tags.document
+        run_nodes = d.css('w|p w|r')
+        while run_node = run_nodes.shift
+          if run_node.text =~ regexp_tag
+            expect(run_node.at_css('w|rPr w|color').first[1]).to eq('FFFFFF')
+            expect(run_node.children.first.name).to eq('rPr')
+          end
+        end
+      end
+    end
+    context 'giving a document without rpr' do
+      let(:input_file) { "#{base_path}/docx-no-rpr.docx" }
+
+      it 'expect to have a white color on all hide custom tags matching and have first child node equal rPr tag' do
+        hide_custom_tags.hide_custom_tags!
+        d = hide_custom_tags.document
+        run_nodes = d.css('w|p w|r')
+        while run_node = run_nodes.shift
+          if run_node.text =~ regexp_tag
+            expect(run_node.at_css('w|rPr w|color').first[1]).to eq('FFFFFF')
+            expect(run_node.children.first.name).to eq('rPr')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -33,18 +33,20 @@ module LMDocstache
 end
 
 describe 'integration test', integration: true do
-  let(:data) { LMDocstache::TestData::DATA }
   let(:base_path) { SPEC_BASE_PATH.join('example_input') }
-  let(:input_file) { "#{base_path}/ExampleTemplate.docx" }
   let(:output_dir) { "#{base_path}/tmp" }
-  let(:output_file) { "#{output_dir}/IntegrationTestOutput.docx" }
-  let(:document) { LMDocstache::Document.new(input_file) }
-  before do
-    FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
-    Dir.mkdir(output_dir)
-  end
 
   context 'should process that incoming docx' do
+    let(:data) { LMDocstache::TestData::DATA }
+    let(:input_file) { "#{base_path}/ExampleTemplate.docx" }
+    let(:output_file) { "#{output_dir}/IntegrationTestOutput.docx" }
+    let(:document) { LMDocstache::Document.new(input_file) }
+
+    before do
+      FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
+      Dir.mkdir(output_dir)
+    end
+
     it 'loads the input file' do
       expect(document).to_not be_nil
     end
@@ -58,26 +60,84 @@ describe 'integration test', integration: true do
     end
 
     it 'fixes nested xml errors breaking tags' do
-      expect(document.send(:problem_paragraphs)).to_not be_empty
-      document.fix_errors
-      expect(document.send(:problem_paragraphs)).to be_empty
+      expect { document.fix_errors }.to change {
+        document.send(:problem_paragraphs).size
+      }.from(6).to(1)
+
+      expect(document.send(:problem_paragraphs).first.text).to eq(
+        '{{TAG123-\\-//WITH WE👻IRD CHARS}}'
+      )
     end
 
     it 'has the expected amount of usable tags' do
-      expect(document.usable_tags.count).to be(30)
+      expect(document.usable_tags.count).to eq(43)
     end
 
     it 'has the expected amount of usable roles tags' do
       document.fix_errors
-      expect(document.usable_role_tags.count).to be(6)
+      expect(document.usable_role_tags.count).to eq(6)
     end
 
     it 'has the expected amount of unique tag names' do
-      expect(document.usable_tag_names.count).to be(18)
+      expect(document.usable_tag_names.count).to eq(19)
     end
 
     it 'renders file using data' do
       document.render_file(output_file, data)
     end
   end
+  context "testing hide custom tags" do
+    before do
+      FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
+      Dir.mkdir(output_dir)
+    end
+
+    let(:render_options) {
+      {
+        hide_custom_tags: ['(?:sig|sigfirm|date|check|text|initial)\|(?:req|noreq)\|.+?']
+      }
+    }
+    let(:document) { LMDocstache::Document.new(input_file) }
+
+    context "witth document with blue background" do
+      let(:input_file) { "#{base_path}/sample-signature-blue.docx" }
+
+      it 'should have content replacement aligned with hide custom tags' do
+        doc = document
+        doc.fix_errors
+        noko = doc.render_xml({}, render_options)
+        output = noko['word/document.xml'].to_xml
+        expect(output).to include('<w:r>
+        <w:rPr>
+          <w:rFonts w:cstheme="minorHAnsi"/>
+          <w:lang w:val="en-US"/>
+          <w:color w:val="4472C4"/>
+        </w:rPr>
+        <w:t xml:space="preserve">{{sig|req|client}}</w:t>
+      </w:r>')
+        expect(output).to include('<w:t xml:space="preserve">Test Multiple text in the same line </w:t>')
+      end
+    end
+
+    context "with document without backgorund" do
+      let(:input_file) { "#{base_path}/sample-signature.docx" }
+      let(:document) { LMDocstache::Document.new(input_file) }
+
+      it 'should have content replacement aligned with hide custom tags' do
+        doc = document
+        doc.fix_errors
+        noko = doc.render_xml({}, render_options)
+        output = noko['word/document.xml'].to_xml
+        expect(output).to include('<w:r>
+        <w:rPr>
+          <w:rFonts w:cstheme="minorHAnsi"/>
+          <w:lang w:val="en-US"/>
+          <w:color w:val="FFFFFF"/>
+        </w:rPr>
+        <w:t xml:space="preserve">{{sig|req|client}}</w:t>
+      </w:r>')
+        expect(output).to include('<w:t xml:space="preserve">Test Multiple text in the same line </w:t>')
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -113,6 +113,7 @@ files:
 - lib/lm_docstache/condition.rb
 - lib/lm_docstache/conditional_block.rb
 - lib/lm_docstache/document.rb
+- lib/lm_docstache/hide_custom_tags.rb
 - lib/lm_docstache/parser.rb
 - lib/lm_docstache/renderer.rb
 - lib/lm_docstache/version.rb
@@ -120,6 +121,10 @@ files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.docx
+- spec/example_input/docx-no-rpr.docx
+- spec/example_input/sample-signature-blue.docx
+- spec/example_input/sample-signature.docx
+- spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/template_processor_spec.rb
@@ -150,6 +155,10 @@ test_files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.docx
+- spec/example_input/docx-no-rpr.docx
+- spec/example_input/sample-signature-blue.docx
+- spec/example_input/sample-signature.docx
+- spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/template_processor_spec.rb