lm_docstache 2.1.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f3c502d4e4982f2361991d6b43b4d22460ab4e25d9db7fd60eb6b9f14d4a1f
-  data.tar.gz: 779810f481adebb853e62ea708df571ab355fb96cc9fde3c83d86ff7ad214714
+  metadata.gz: e8db9e1f7f1a534059ed080bfd89005372b334cc203b66cfbb45323b8116b980
+  data.tar.gz: 4af011e633d34a62fcc0ed24fa639e04ce88937423b8570ae4f3a8fd4ff8fe70
 SHA512:
-  metadata.gz: 44994ae953e0a0b42acfc1ef0a6ac8722c17be1582c227ecdac3c6cd572ae91031e85e71671628bc3eacc0981904968c15f079824b42b4f95bddefd2b417939e
-  data.tar.gz: f94f9e419671854f22031c232a7df41f8c52e1e95cb1db57e94aa5ab1f1229e387aee42a407fcadef7b09a78a114d1d2e6d642a8db0c68c1ff977b0757db9d04
+  metadata.gz: e3c0630c4472b5d5b8f2a479a7b201411a817069221026778f86581146f4ef797dd586d2a0b299df4281394edf7878f1536ceda0d59f766a737255960a07d450
+  data.tar.gz: df59e4c7c9750e75f976d47ee6d8d632c795702863cdb332627497f88026efa70a2eac2b01520c615a8faf042f677e547d3fec8ae09dc470d50383e1e5ed5548

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 3.0.2
+
+### Bugfix
+
+* Fix replacing tags related to hidden custom tags regexp formats. E.g. tab characters.
+
+
+## 3.0.1
+
+### Bugfix
+
+* Fix Hide Custom Tag feature when document there is no text inside a w|r we
+  can't split content.
+
+## 3.0.0
+
+## Breaking Changes
+* Replaced Renderer `hide_custom_tags` options to be a `Hash` instead of `Array`.
+  There are are edge cases which we want to replace the content on hide custom tags.
+  All documentations can be followed on `Renderer` and `HideCustomTag` classes.
+
+## 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

data/lib/lm_docstache/hide_custom_tags.rb

@@ -1,41 +1,52 @@
 module LMDocstache
   class HideCustomTags
-    HIDDEN_FONT_COLOR = 'FFFFFF'
-
     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.
+    # The +hide_custom_tags+ options is a +Hash+ of +Regexp+ or +String+ keys representing
+    # the pattern you expect to keep at the document but replacing the content to use
+    # font color equal to document background color or white.
+    # For the +Hash+ values we can have:
     #
-    # 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 a white font color to matching custom tags.
-    def initialize(document:, hide_custom_tags: [])
+    # * +false+ -> In this case we don't change the text content.
+    # * +Proc+ -> When a +Proc+ instance is provided, it's expected it to be
+    #   able to receive the matched string and to return the string that will be
+    #   used as replacement.
+    # * any other value that will be turned into a string -> in this case, this
+    #   will be the value that will replace the matched string
+    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 white in the matching tag run node.
+    # in multiple runs and replace font color to document background color or white in the matching tag run node.
+    # Replace content if you have defined any replacement value.
     def hide_custom_tags!
-      hide_custom_tags.each do |full_pattern|
+      hide_custom_tags.each do |full_pattern, value|
         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
+            next unless run_node.at_css('w|t')
+            next unless run_node.text =~ full_pattern
             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
+                run_node_with_match = remainder_run_node.dup
                 replace_style(run_node_with_match)
-                replace_content(run_node_with_match, matched_tag)
+                matched_content = matched_tag
+                if value
+                  matched_content = value.is_a?(Proc) ?
+                       value.call(matched_tag) :
+                       value.to_s
+                end
+                replace_content(run_node_with_match, matched_content)
                 nodes_list << run_node_with_match
               end
               paragraph << Nokogiri::XML::NodeSet.new(document, nodes_list)
@@ -47,6 +58,11 @@ module LMDocstache
     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
@@ -59,9 +75,9 @@ module LMDocstache
       if style
         w_color = style.at_css('w|color')
         w_color.unlink if w_color
-        style << "<w:color w:val=\"#{HIDDEN_FONT_COLOR}\"/>"
+        style << "<w:color w:val=\"#{font_color}\"/>"
       else
-        run_node << "<w:rPr><w:color w:val=\"#{HIDDEN_FONT_COLOR}\"/></w:rPr>"
+        run_node.prepend_child("<w:rPr><w:color w:val=\"#{font_color}\"/></w:rPr>")
       end
     end
 

data/lib/lm_docstache/parser.rb

@@ -34,22 +34,30 @@ 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.
+    # The +hide_custom_tags+ options is a +Hash+ of +Regexp+ or +String+ keys representing
+    # the pattern you expect to keep at the document but replacing the content to use
+    # font color equal to document background color or white.
+    # For the +Hash+ values we can have:
     #
-    # 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 a white font color to matching custom tags.
+    # * +false+ -> In this case we don't change the text content.
+    # * +Proc+ -> When a +Proc+ instance is provided, it's expected it to be
+    #   able to receive the matched string and to return the string that will be
+    #   used as replacement.
+    # * any other value that will be turned into a string -> in this case, this
+    #   will be the value that will replace the matched string
     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)
+      @special_variable_replacements = add_blocks_to_regexp(options.fetch(:special_variable_replacements, {}))
+      @hide_custom_tags = add_blocks_to_regexp(options.fetch(:hide_custom_tags, {}))
     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}}/
+    # Replace +Regepx+ or +String+ keys to have the enclosing blocks
+    def add_blocks_to_regexp(options)
+      options.inject({}) do |x, (regexp_str, value)|
+        key = regexp_str.is_a?(String) ? Regexp.new("{{#{regexp_str}}}") : /{{#{regexp_str.source}}/
+        x[key] = value
+        x
       end
     end
 
@@ -128,15 +136,13 @@ module LMDocstache
             variable_replacement.call($1) :
             variable_replacement.to_s
         end
-
         text_node.content = text
       end
     end
 
     def has_skippable_variable?(text)
-      return true if hide_custom_tags.find { |pattern| text =~ pattern }
+      return true if hide_custom_tags.find { |(pattern, value)| text =~ pattern }
       !!special_variable_replacements.find do |(pattern, value)|
-        pattern = pattern.is_a?(String) ? /{{#{pattern}}}/ : /{{#{pattern.source}}}/
         text =~ pattern && value == false
       end
     end
@@ -144,7 +150,6 @@ module LMDocstache
     def special_variable_replacement(text)
       Array(
         special_variable_replacements.find do |(pattern, value)|
-          pattern = pattern.is_a?(String) ? /{{#{pattern}}}/ : /{{#{pattern.source}}}/
           text =~ pattern && !!value
         end
       ).last

data/lib/lm_docstache/renderer.rb

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

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "2.1.0"
+  VERSION = "3.0.2"
 end

data/spec/hide_custom_tags_spec.rb

@@ -1,10 +1,10 @@
 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)
@@ -15,22 +15,84 @@ describe LMDocstache::HideCustomTags do
     end
 
     let(:base_path) { SPEC_BASE_PATH.join('example_input') }
-    let(:input_file) { "#{base_path}/sample-signature.docx" }
-
-    let(:document) { LMDocstache::Document.new(input_file).instance_variable_get(:@document) }
-    let(:regexp_tag) { /{{(?:sig|sigfirm|date|check|text|initial)\|(?:req|noreq)\|.+?}}/ }
+    let(:document) {
+      doc = LMDocstache::Document.new(input_file)
+      doc.fix_errors
+      doc.instance_variable_get(:@document)
+    }
+    let(:regexp_tag) { /(?:sig|sigfirm|date|text|initial)\|(?:req|noreq)\|.+?/ }
+    let(:regexp_for_replacement) { /(?:check)\|(?:req|noreq)\|.+?/ }
     let(:hide_custom_tags) {
-      LMDocstache::HideCustomTags.new(document: document, hide_custom_tags: [ regexp_tag ])
+      LMDocstache::HideCustomTags.new(document: document, hide_custom_tags: {
+        /#{regexp_tag}/ => false,
+        /#{regexp_for_replacement}/ => 'replaced_content'
+      })
     }
-    it 'expect to have a white background on all hide custom tags matching' 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(LMDocstache::HideCustomTags::HIDDEN_FONT_COLOR)
+
+    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
+          next unless 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
+
+    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
+          next unless 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
+    context 'giving a document without rpr and block tags on the left' 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
+          next unless 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
+      it 'expect to have a white color on all replacement tags and content following replacement' do
+        hide_custom_tags.hide_custom_tags!
+        d = hide_custom_tags.document
+        run_nodes = d.css('w|p w|r')
+        total_replacement = 0
+        while run_node = run_nodes.shift
+          next unless run_node.text =~ /replaced_content/
+          total_replacement+=1
+          expect(run_node.at_css('w|rPr w|color').first[1]).to eq('FFFFFF')
+          expect(run_node.children.first.name).to eq('rPr')
+        end
+        expect(total_replacement).to eq(2)
+      end
+    end
+
+    context 'giving a document with tabs spacing in the middle of replacement tags' do
+      let(:input_file) { "#{base_path}/sample-signature-with-tabs-spacing.docx" }
+      it 'expect to not replace tabs' do
+        hide_custom_tags.hide_custom_tags!
+        d = hide_custom_tags.document
+        expect(d.css('w|p w|tab').size).to eq(11)
+      end
     end
   end
 end

data/spec/integration_spec.rb

@@ -35,15 +35,18 @@ end
 describe 'integration test', integration: true do
   let(:base_path) { SPEC_BASE_PATH.join('example_input') }
   let(:output_dir) { "#{base_path}/tmp" }
+
   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
@@ -89,19 +92,43 @@ describe 'integration test', integration: true do
       Dir.mkdir(output_dir)
     end
 
-    let(:input_file) { "#{base_path}/sample-signature.docx" }
     let(:render_options) {
       {
-        hide_custom_tags: ['(?:sig|sigfirm|date|check|text|initial)\|(?:req|noreq)\\|.+?']
+        hide_custom_tags: ['(?:sig|sigfirm|date|check|text|initial)\|(?:req|noreq)\|.+?']
       }
     }
     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>
+
+    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"/>
@@ -109,7 +136,8 @@ describe 'integration test', integration: true do
         </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>')
+        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.1.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -121,6 +121,9 @@ 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-with-tabs-spacing.docx
 - spec/example_input/sample-signature.docx
 - spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb
@@ -153,6 +156,9 @@ 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-with-tabs-spacing.docx
 - spec/example_input/sample-signature.docx
 - spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb