lm_docstache 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e32cdd0e7cb785ccb74285d2df67556c6ae24184a49511dd08fa6aa523e845c
-  data.tar.gz: d5872f502d4e95d4135dfcf3014826c76fa3968db8be301e4cc52d73d04b9951
+  metadata.gz: 65f3c502d4e4982f2361991d6b43b4d22460ab4e25d9db7fd60eb6b9f14d4a1f
+  data.tar.gz: 779810f481adebb853e62ea708df571ab355fb96cc9fde3c83d86ff7ad214714
 SHA512:
-  metadata.gz: 65852b8af255a23a06064bc91eee802005f31cdff3e3fc3258cbb03fbec9ba07e2f0c5cbd0af37f25324db2df774070280596a87fb49e2332d28a368514ca837
-  data.tar.gz: 85ebb2d3d2af5a0a3c7e3787a8ba98688193e220e56aceba5b37aa3ac500a39fc3914f6d14251d4f4007a317e677d41cf6b8fd7a98e4d51960e441abac40a59a
+  metadata.gz: 44994ae953e0a0b42acfc1ef0a6ac8722c17be1582c227ecdac3c6cd572ae91031e85e71671628bc3eacc0981904968c15f079824b42b4f95bddefd2b417939e
+  data.tar.gz: f94f9e419671854f22031c232a7df41f8c52e1e95cb1db57e94aa5ab1f1229e387aee42a407fcadef7b09a78a114d1d2e6d642a8db0c68c1ff977b0757db9d04

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 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,74 @@
+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.
+    #
+    # 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: [])
+      @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.
+    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 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=\"#{HIDDEN_FONT_COLOR}\"/>"
+      else
+        run_node << "<w:rPr><w:color w:val=\"#{HIDDEN_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 a 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.2"
+  VERSION = "2.1.0"
 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,36 @@
+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(: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)
+        end
+      end
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -33,18 +33,17 @@ 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 +83,33 @@ 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(:input_file) { "#{base_path}/sample-signature.docx" }
+    let(:render_options) {
+      {
+        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>
+        <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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 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-17 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,8 @@ files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.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 +153,8 @@ test_files:
 - spec/conditional_block_spec.rb
 - spec/example_input/ExampleTemplate.docx
 - spec/example_input/blank.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