lm_docstache 2.1.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f57ee42bd7804fc41051ca123be801e909acfee0b0406a5eac91e8f562827f11
-  data.tar.gz: 21ab27cac4e621eb3d3c391b71945a9f29dac1343d790ccb4026a191dbee62ae
+  metadata.gz: ce8fea2c12829636bd22622e1c022cf2ead4ec09997b7e13322f2b94b4261654
+  data.tar.gz: a25d02153cb1a53bf74111dc59710d83a133a821c4632607c60e06531b28b4ad
 SHA512:
-  metadata.gz: 642af591848de049083886277afa1fcd082cf150785d7610ebc15ff328ddc53527bc373e4ab18f910eabffe16b747d8f2191332a968b9e5716a52b4a2e5b2a62
-  data.tar.gz: e5d7b66bdb616221ccb789841ce6d84eb7ce76b44c2319ebf522c0f8cd4fb53069fbe93df745724c34ec450884b7b462932624dc2bc10a85216dd1c655bf00d5
+  metadata.gz: 99bcdac9eea8b1d62e0733b692c600be5e8dcb88710f58d22299b6daa7eabab5f5b01eeb83e61668709655869f6580e918ef38d11bb5ae781db4462b38abba65
+  data.tar.gz: ea96603b65d984edfeeb9aa9f9b760c9665af2c5df163e4c3dae076b24ebc10fccb8e1bdee1cc6e01761496a4b89b7454e80965d6a24e96eb67b53b17e46be84

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 3.0.4
+* Allow replacement `data` argument to be an `Array`. This feature allow to replace blocks
+in a sequentially order following the sequence of matching blocks order.
+
+## 3.0.3
+
+### Bugfix
+
+* Hide custom tags arguments was pushing blocks tags to end of paragraph. There are cases this approach
+ doesn't work. I changed to be an ordered replacement when we match hide tags.
+* Avoid to merge Tab tags on fix errors methods. This was causing unexpected document changes.  
+
+## 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

data/lib/lm_docstache/document.rb

@@ -138,6 +138,10 @@ module LMDocstache
         previous_text_node = previous_run_node.at_css('w|t')
         current_text_node = run_node.at_css('w|t')
 
+        # avoid to merge blocks with tabs
+        next if run_node.at_css('w|tab')
+        next if previous_run_node.at_css('w|tab')
+
         next if style_html != previous_style_html
         next if current_text_node.nil? || previous_text_node.nil?
 

data/lib/lm_docstache/hide_custom_tags.rb

@@ -2,43 +2,56 @@ 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.
+    # 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 document background color or 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 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
-            remainder_run_node = run_node.clone
-            run_node.unlink
-            tag_contents = split_tag_content(remainder_run_node.text, full_pattern)
+            next unless run_node.at_css('w|t')
+            next unless run_node.text =~ full_pattern
+            tag_contents = split_tag_content(run_node.text, full_pattern)
+            replacement_nodes = []
             tag_contents[:content_list].each_with_index do |content, idx|
+              remainder_run_node = run_node.clone
               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]
+              replacement_nodes << remainder_run_node
               if matched_tag
+                run_node_with_match = run_node.clone
                 replace_style(run_node_with_match)
-                replace_content(run_node_with_match, matched_tag)
-                nodes_list << 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)
+                replacement_nodes << run_node_with_match
               end
-              paragraph << Nokogiri::XML::NodeSet.new(document, nodes_list)
-              remainder_run_node = remainder_run_node.clone
             end
+            run_node.add_next_sibling(Nokogiri::XML::NodeSet.new(document, replacement_nodes))
+            run_node.unlink
           end
         end
       end

data/lib/lm_docstache/parser.rb

@@ -18,7 +18,22 @@ module LMDocstache
     VARIABLE_MATCHER = /{{([^#\^\/].*?)}}/
 
     attr_reader :document, :data, :blocks, :special_variable_replacements, :hide_custom_tags
+    attr_reader :data_sequential_replacement
 
+    # Constructor +data+ argument is a +Hash+ where the key is
+    # expected to be a +String+ representing the replacement block value. +Hash+
+    # key must not contain the `{{}}` part, but only the pattern characters.
+    # As for the values of the +Hash+, we have options:
+    #
+    # * +String+  will be the value that will replace matching string.
+    # * +Array<String>+ will be an ordered sequence of values that will replace the matched string following
+    # document matching order.
+    #
+    # Example:
+    # { 'full_name' => 'John Doe', 'text|req|Client' => ['John', 'Matt', 'Paul'] }
+    #
+    # Constructor +options+ argument is a +Hash+ where keys can be:
+    #
     # The +special_variable_replacements+ option is a +Hash+ where the key is
     # expected to be either a +Regexp+ or a +String+ representing the pattern
     # of more specific type of variables that deserves a special treatment. The
@@ -34,22 +49,31 @@ 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 document background color or 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)
+      @data = data.transform_keys(&:to_s).select {|e, v| !v.is_a?(Array) }
+      @data_sequential_replacement = data.transform_keys(&:to_s).select {|e, v| v.is_a?(Array) }
+      @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
 
@@ -57,6 +81,7 @@ module LMDocstache
       hide_custom_tags!
       find_blocks
       replace_conditional_blocks_in_document!
+      replace_data_sequentially_in_document!
       replace_variables_in_document!
     end
 
@@ -128,15 +153,39 @@ module LMDocstache
             variable_replacement.call($1) :
             variable_replacement.to_s
         end
-
         text_node.content = text
       end
     end
 
+    def replace_data_sequentially_in_document!
+      data_sequential_replacement.each do |tag_key, values|
+
+        tag = Regexp.escape("{{#{tag_key}}}")
+        pattern_found = 0
+
+        document.css('w|t').each do |text_node|
+          text = text_node.text
+
+          if text.match(tag)
+
+            text.gsub!(/#{tag}/) do |_match|
+              value = values[pattern_found]
+              # if there is no more available value replace the content with empty string
+              return '' unless value
+
+              pattern_found +=1
+              value
+            end
+
+            text_node.content = text
+          end
+        end
+      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 +193,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.2"
+  VERSION = "3.0.4"
 end

data/spec/hide_custom_tags_spec.rb

@@ -1,7 +1,6 @@
 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') }
@@ -16,10 +15,18 @@ describe LMDocstache::HideCustomTags do
     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(: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'
+      })
     }
 
     context "giving a document with blue background" do
@@ -30,10 +37,9 @@ describe LMDocstache::HideCustomTags do
         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
+          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
@@ -46,14 +52,13 @@ describe LMDocstache::HideCustomTags do
         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
+          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' do
+    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
@@ -61,12 +66,33 @@ describe LMDocstache::HideCustomTags do
         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
+          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

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'securerandom'
 require 'active_support/core_ext/object/blank.rb'
 
 module LMDocstache
@@ -139,5 +140,30 @@ describe 'integration test', integration: true do
         expect(output).to include('<w:t xml:space="preserve">Test Multiple text in the same line </w:t>')
       end
     end
+
+    context "yoooo" do
+      let(:input_file) { "#{base_path}/multi_o.docx" }
+      let(:render_options) {
+        {
+          special_variable_replacements: { "(date|sig|sigfirm|text|check|initial|initials)\\|(req|noreq)\\|(.+?)" => false }.freeze,
+          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
+        new_file_path = "#{Time.now.to_i}-#{SecureRandom.uuid}.docx"
+        n = doc.render_file(new_file_path, { 'full_name' => 'fred document01' }, render_options)
+        noko = doc.render_xml({ 'full_name' => 'fred document01' }, render_options)
+        output = noko['word/document.xml'].to_xml
+        #puts output
+        #doc.render_file(new_file_path, { 'full_name' => 'fred document01' }, render_options)
+        #noko = doc.render_xml({ 'full_name' => 'fred document01' }, render_options)
+        #output = noko['word/document.xml'].to_xml
+        #puts output
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.4
 platform: ruby
 authors:
 - Roey Chasman
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -123,6 +123,7 @@ files:
 - 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
@@ -157,6 +158,7 @@ test_files:
 - 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