lm_docstache 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f3c502d4e4982f2361991d6b43b4d22460ab4e25d9db7fd60eb6b9f14d4a1f
-  data.tar.gz: 779810f481adebb853e62ea708df571ab355fb96cc9fde3c83d86ff7ad214714
+  metadata.gz: 6065b961f3d05db1773c70c088a67909755b633a3f412eec7f73cc76992a6a19
+  data.tar.gz: 808ce002e3bd777efc705851f610a1a26df183e81784e51cb28915a375f7f4cd
 SHA512:
-  metadata.gz: 44994ae953e0a0b42acfc1ef0a6ac8722c17be1582c227ecdac3c6cd572ae91031e85e71671628bc3eacc0981904968c15f079824b42b4f95bddefd2b417939e
-  data.tar.gz: f94f9e419671854f22031c232a7df41f8c52e1e95cb1db57e94aa5ab1f1229e387aee42a407fcadef7b09a78a114d1d2e6d642a8db0c68c1ff977b0757db9d04
+  metadata.gz: 41a377be982d11259c4a6a7f362d01e23a800e23203d3114a81b064ee158527a40f2a9a0ad6883923583c661c7e7d712945e894f68ba1e72afd0299b1bc10ed8
+  data.tar.gz: b8a49a51ab46335fac6c862f1a26b2a23f557d6e007a741cf7f3093891a8e1d696514b55597eee08c3734d2117fe98dd76030827f9a4c02a9af04cb7818dea76

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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,7 +1,5 @@
 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
@@ -9,14 +7,14 @@ module LMDocstache
     #
     # 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.
+    # 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 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.
     def hide_custom_tags!
       hide_custom_tags.each do |full_pattern|
         paragraphs = document.css('w|p')
@@ -47,6 +45,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 +62,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 << "<w:rPr><w:color w:val=\"#{font_color}\"/></w:rPr>"
       end
     end
 

data/lib/lm_docstache/parser.rb

@@ -39,7 +39,7 @@ module LMDocstache
     #
     # 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.
+    # 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)

data/lib/lm_docstache/version.rb

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

data/spec/hide_custom_tags_spec.rb

@@ -5,6 +5,7 @@ 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,20 +16,38 @@ 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(:hide_custom_tags) {
       LMDocstache::HideCustomTags.new(document: document, hide_custom_tags: [ regexp_tag ])
     }
-    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 blue color 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('4472C4')
+          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' 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')
+          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: 2.1.1
 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-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -121,6 +121,7 @@ files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.docx
+- spec/example_input/sample-signature-blue.docx
 - spec/example_input/sample-signature.docx
 - spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb
@@ -153,6 +154,7 @@ test_files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.docx
+- spec/example_input/sample-signature-blue.docx
 - spec/example_input/sample-signature.docx
 - spec/hide_custom_tags_spec.rb
 - spec/integration_spec.rb