lm_docstache 1.2.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16a6e73e07d070f2c486647c784c04627d746849481c145d66f6735780c65bb
-  data.tar.gz: 2fa52f69ea406bfe221bccff2a599af568ea9e0d6c21ab20500d06ad0dbfaeb4
+  metadata.gz: 3268400635c8fd94b49786b4509b78f3acc649e8fb1bea2b65ba4a7f520b6b22
+  data.tar.gz: 19a429793e0699e2026a726c73d8c579f3644b4f88425ef57944dada31e878cc
 SHA512:
-  metadata.gz: '0096916f50745ca968b0a2d365a0d279aae3007c4d7e5e6376c87b1d512f082d0646e064d5a84bef9be1b33e53eb3d81d33122a6e868c2e389f67aecfbe00662'
-  data.tar.gz: 0723cefa1931bbc2d8b7ab513d1af844f43d05ff4d61fa04d73ad772cbd8a81dea29319a72403b6657ae49688026edc6ace60dc5a0b32a85ed8223c003820901
+  metadata.gz: a902c19fa827102d3396d317e977031db56071d3bead3900f83f67583f41e96bca042c4f9ab54d215058c0af3d76ff492bc059d17d22c3c710a6ee7aa637492d
+  data.tar.gz: deb3bda8b3ce6ea84f6334197bf93fd7e10950e84386731ad9426f9f746ab1967485b54b312160c98bae2eac7a1752b0c35e65e36c54208ea8177af03db730ec

data/CHANGELOG.md

@@ -1,4 +1,21 @@
 # Changelog
+## 1.3.4
+* Change signature signs identifiers to be braces instead of brackets.
+
+## 1.3.2
+* Fix bug replacing signature tags accross xml nodes.
+
+## 1.3.1
+* Fix bug searching accross xml nodes for e-signature tags.
+
+## 1.3.0
+* Add support for e-signature tags
+
+## 1.2.4
+* Add support for pipe character in merge tags so we can use as a modifier for the context of merge tag.
+
+## 1.2.3
+* Fix issue where some paragraphs do not contain text as their first block. If this is the case, we just use the first block that does contain text.
 
 ## 1.2.2
 * Remove uneccessary runtime dependency on active support.

data/lib/lm_docstache/document.rb

@@ -1,5 +1,7 @@
 module LMDocstache
   class Document
+    TAGS_REGEXP = /\{\{.+?\}\}/
+    SIGNATURE_REGEXP = /(\{\{(sig|sigfirm|date|check|text|initial)\|(req|noreq)\|(.+?)\}\})/
     def initialize(*paths)
       raise ArgumentError if paths.empty?
       @path = paths.shift
@@ -15,17 +17,52 @@ module LMDocstache
       find_documents_to_interpolate
     end
 
+    def signature_tags
+      @documents.values.flat_map do |document|
+        document.text.strip.scan(SIGNATURE_REGEXP)
+          .map {|r| r.first }
+      end
+    end
+
+    def usable_signature_tags
+      @documents.values.flat_map do |document|
+        document.css('w|p')
+          .select { |tag| tag.text =~ SIGNATURE_REGEXP }
+          .flat_map { |tag|
+            tag.text.scan(SIGNATURE_REGEXP)
+              .map {|r| r.first }
+          }
+      end
+    end
+
+    def usable_signature_tag_names
+      self.usable_signature_tags.map do |tag|
+        tag.scan(SIGNATURE_REGEXP)
+          .map {|r| r.first }
+      end.compact.uniq
+    end
+
+    def unusable_signature_tags
+      unusable_signature_tags = signature_tags
+      unusable_signature_tags.each do |usable_tag|
+        index = unusable_signature_tags.index(usable_tag)
+        unusable_signature_tags.delete_at(index) if index
+      end
+      return unusable_signature_tags
+    end
+
     def tags
       @documents.values.flat_map do |document|
-        document.text.strip.scan(/\{\{.+?\}\}/)
+        document.text.strip.scan(TAGS_REGEXP)
+          .select {|t| !(t =~ SIGNATURE_REGEXP)}
       end
     end
 
     def usable_tags
       @documents.values.flat_map do |document|
         document.css('w|t')
-          .select { |tag| tag.text =~ /\{\{.+?\}\}/ }
-          .flat_map { |tag| tag.text.scan(/\{\{.+?\}\}/) }
+          .select { |tag| tag.text =~ TAGS_REGEXP && !(tag.text =~ SIGNATURE_REGEXP) }
+          .flat_map { |tag| tag.text.scan(TAGS_REGEXP) }
       end
     end
 
@@ -58,10 +95,10 @@ module LMDocstache
       File.open(path, "w") { |f| f.write buffer.string }
     end
 
-    def render_file(output, data={})
+    def render_file(output, data={}, remove_signature_tags = false)
       rendered_documents = Hash[
         @documents.map do |(path, document)|
-          [path, LMDocstache::Renderer.new(document.dup, data).render]
+          [path, LMDocstache::Renderer.new(document.dup, data, remove_signature_tags).render]
         end
       ]
       buffer = zip_buffer(rendered_documents)

data/lib/lm_docstache/renderer.rb

@@ -2,14 +2,16 @@ module LMDocstache
   class Renderer
     BLOCK_REGEX = /\{\{([\#\^])([\w\.]+)(?:(\s(?:==|~=)\s?.+?))?\}\}.+?\{\{\/\k<2>\}\}/m
 
-    def initialize(xml, data)
+    def initialize(xml, data, remove_signature_tags = false)
       @content = xml
       @data = DataScope.new(data)
+      @remove_signature_tags = remove_signature_tags
     end
 
     def render
       find_and_expand_blocks
       replace_tags(@content, @data)
+      remove_signature_tags(@content) if @remove_signature_tags
       return @content
     end
 
@@ -106,7 +108,7 @@ module LMDocstache
 
     def replace_tags(elements, data)
       elements.css('w|t').each do |text_el|
-        if !(results = text_el.text.scan(/\{\{([\w\.]+)\}\}/).flatten).empty?
+        if !(results = text_el.text.scan(/\{\{([\w\.\|]+)\}\}/).flatten).empty?
           rendered_string = text_el.text
           results.each do |r|
             rendered_string.gsub!("{{#{r}}}", data.get(r).to_s)
@@ -117,6 +119,20 @@ module LMDocstache
       return elements
     end
 
+    def remove_signature_tags(elements)
+      elements.css('w|p').each do |text_el|
+        if !(results = text_el.text.scan(/\[\[sig_(.+?)\]\]/).flatten).empty?
+          rendered_string = text_el.text
+          results.each do |r|
+            padding = "".ljust(r.length + 8, " ")
+            rendered_string.gsub!("[[sig_#{r}]]", padding)
+          end
+          text_el.content = rendered_string
+        end
+      end
+      return elements
+    end
+
     private
 
     def get_condition(name, condition, inverted = false)

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "1.2.3"
+  VERSION = "1.3.4"
 end

data/lm_docstache.gemspec

@@ -5,8 +5,8 @@ require "lm_docstache/version"
 Gem::Specification.new do |s|
   s.name        = "lm_docstache"
   s.version     = LMDocstache::VERSION
-  s.authors     = ["Roey Chasman", "Jonathan Stevens", "Will Cosgrove"]
-  s.email       = ["roey@lawmatics.com", "jonathan@lawmatics.com", "will@willcosgrove.com"]
+  s.authors     = ["Roey Chasman", "Frederico Assunção", "Jonathan Stevens", "Will Cosgrove"]
+  s.email       = ["roey@lawmatics.com", "fred@lawmatics.com", "jonathan@lawmatics.com", "will@willcosgrove.com"]
   s.homepage    = "https://www.lawmatics.com"
   s.summary     = %q{Merges Hash of Data into Word docx template files using mustache syntax}
   s.description = %q{Integrates data into MS Word docx template files. Processing supports loops and replacement of strings of data both outside and within loops.}

data/spec/integration_spec.rb

@@ -35,7 +35,7 @@ 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(:input_file) { "#{base_path}/ExampleTemplate2.docx" }
   let(:output_dir) { "#{base_path}/tmp" }
   let(:output_file) { "#{output_dir}/IntegrationTestOutput.docx" }
   let(:document) { LMDocstache::Document.new(input_file) }
@@ -64,11 +64,19 @@ describe 'integration test', integration: true do
     end
 
     it 'has the expected amount of usable tags' do
-      expect(document.usable_tags.count).to be(27)
+      expect(document.usable_tags.count).to be(30)
+    end
+
+    it 'has the expected amount of signature tags' do
+      expect(document.signature_tags.count).to be(6)
+    end
+
+    it 'has the expected amount of usable signature tags' do
+      expect(document.usable_signature_tags.count).to be(6)
     end
 
     it 'has the expected amount of unique tag names' do
-      expect(document.usable_tag_names.count).to be(16)
+      expect(document.usable_tag_names.count).to be(18)
     end
 
     it 'renders file using data' do

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.4
 platform: ruby
 authors:
 - Roey Chasman
+- Frederico Assunção
 - Jonathan Stevens
 - Will Cosgrove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -44,22 +45,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +93,7 @@ description: Integrates data into MS Word docx template files. Processing suppor
   loops and replacement of strings of data both outside and within loops.
 email:
 - roey@lawmatics.com
+- fred@lawmatics.com
 - jonathan@lawmatics.com
 - will@willcosgrove.com
 executables: []
@@ -116,6 +118,7 @@ files:
 - spec/data_scope_spec.rb
 - spec/empty_data_scope_spec.rb
 - spec/example_input/ExampleTemplate.docx
+- spec/example_input/ExampleTemplate2.docx
 - spec/example_input/blank.docx
 - spec/example_input/word/document.xml
 - spec/integration_spec.rb
@@ -140,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax
@@ -149,6 +152,7 @@ test_files:
 - spec/data_scope_spec.rb
 - spec/empty_data_scope_spec.rb
 - spec/example_input/ExampleTemplate.docx
+- spec/example_input/ExampleTemplate2.docx
 - spec/example_input/blank.docx
 - spec/example_input/word/document.xml
 - spec/integration_spec.rb