lm_docstache 2.0.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e32cdd0e7cb785ccb74285d2df67556c6ae24184a49511dd08fa6aa523e845c
-  data.tar.gz: d5872f502d4e95d4135dfcf3014826c76fa3968db8be301e4cc52d73d04b9951
+  metadata.gz: b43bd6c92fe86cdde66926647f6b98a90c68d9cdf2418d7c3db07494d1872bc1
+  data.tar.gz: 52b819e713189acc459c8290614a46791e7dbc6e0049ba32e2fb7b204f44bd29
 SHA512:
-  metadata.gz: 65852b8af255a23a06064bc91eee802005f31cdff3e3fc3258cbb03fbec9ba07e2f0c5cbd0af37f25324db2df774070280596a87fb49e2332d28a368514ca837
-  data.tar.gz: 85ebb2d3d2af5a0a3c7e3787a8ba98688193e220e56aceba5b37aa3ac500a39fc3914f6d14251d4f4007a317e677d41cf6b8fd7a98e4d51960e441abac40a59a
+  metadata.gz: f96c3e1d1f76400286c984309db190326440aaf6c4bf93aaec2896297fa1fad4a1e44fb0c09f0e4c2aa0c8a912876e5aabdf5eadd7edd85a7345d2d819860377
+  data.tar.gz: fee26975013fe5e92699a5da1ef317c9bf989269f5a369e3e11ef47aa82a8047d1648563ece41d4fed6186c58a7fe7319ce9ba9b1cfab732fbc7dd77e464c981

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 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
+
+* 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

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

@@ -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

data/lib/lm_docstache/hide_custom_tags.rb

@@ -0,0 +1,90 @@
+module LMDocstache
+  class HideCustomTags
+    attr_reader :document, :hide_custom_tags
+
+    # 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:
+    #
+    # * +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 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, 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')
+            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)
+                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)
+              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,35 @@ 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 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:
+    #
+    # * +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, {})
+      @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
+
+    # 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
 
     def parse_and_update_document!
+      hide_custom_tags!
       find_blocks
       replace_conditional_blocks_in_document!
       replace_variables_in_document!
@@ -81,6 +103,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.
@@ -109,14 +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, value)| text =~ pattern }
       !!special_variable_replacements.find do |(pattern, value)|
-        pattern = pattern.is_a?(String) ? /{{#{pattern}}}/ : /{{#{pattern.source}}}/
         text =~ pattern && value == false
       end
     end
@@ -124,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))
+      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.0.2"
+  VERSION = "3.0.1"
 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,89 @@
+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) {
+      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}/ => false,
+        /#{regexp_for_replacement}/ => 'replaced_content'
+      })
+    }
+
+    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
+  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
@@ -84,4 +86,58 @@ describe 'integration test', integration: true 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.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-03-26 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