lm_docstache 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f57ee42bd7804fc41051ca123be801e909acfee0b0406a5eac91e8f562827f11
-  data.tar.gz: 21ab27cac4e621eb3d3c391b71945a9f29dac1343d790ccb4026a191dbee62ae
+  metadata.gz: f59dcaa224f4e8e899df674bc5bd296432ebb24e8e4f929be6b414b8f3a8e0a9
+  data.tar.gz: b05e837bccad1978807e82bd7d13da786d24fc796213f4f2859f6ebf023522f1
 SHA512:
-  metadata.gz: 642af591848de049083886277afa1fcd082cf150785d7610ebc15ff328ddc53527bc373e4ab18f910eabffe16b747d8f2191332a968b9e5716a52b4a2e5b2a62
-  data.tar.gz: e5d7b66bdb616221ccb789841ce6d84eb7ce76b44c2319ebf522c0f8cd4fb53069fbe93df745724c34ec450884b7b462932624dc2bc10a85216dd1c655bf00d5
+  metadata.gz: 900ff62d4ada49c3645abfd6fbb64f30b6d7f7e0bf0d619d378c1702890dc25d15685e0c950b152242ca3438d9c4e09658788cc36171d0dacad57c37046eb545
+  data.tar.gz: abd44d43c73c3012b1512e56c2c0fa985295876217d66d86a83670c73e23054362a29899608a86e90893cc1b82ce5306770a57e45fdbf71f0bec5cacf6518900

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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/hide_custom_tags.rb

@@ -2,21 +2,27 @@ 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
@@ -33,7 +39,13 @@ module LMDocstache
               nodes_list = [remainder_run_node]
               if matched_tag
                 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)

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 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)
+      @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.2"
+  VERSION = "3.0.0"
 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,11 +66,23 @@ 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
   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.0
 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-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri