lm_docstache 1.2.2.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a795ca947b082eca640e84db42ca03588902b010c4e564599dd13a61a2ba6b
-  data.tar.gz: d18772ec72ef30d8ac01fe790456bc881167c6908664b11c0d73b3d419a05c79
+  metadata.gz: e5fc07cb8e83945cfdf666da91c1128736fe04b268f6650a5e5f7362e73138f1
+  data.tar.gz: 2d9d44dd5fe120c422689218367d811c081f1cf30e7aa30221875ee008134418
 SHA512:
-  metadata.gz: 3d7314dead61fe490028624a2900ea55095e6e95d0ebf6ac6487e2f42f624702644eade733208d27d3a1f1166e24baa591e646f8cf963c56887c2b43a2743d83
-  data.tar.gz: 9c030a05bbf6ea2ecc96163520690813594b1345a56f85e7f554ef2201647d7ee2d3859a8e620da7afb86a0e94fe15507dee3dbe1ca6877b413ec1212267720d
+  metadata.gz: 8d84deb7909e533b9af7ee3f70ec2201ee95a55d4bc8069b811c3650411ff4a8e0d3ddf9f9007dcb72b9c6b4dcb8aabe05a64d33557879426f98253fb4af1270
+  data.tar.gz: cf3cc3249c5f6e6b70a4d3121993e0cccd09472a08e61e57c33f71266d1b1b8bf52032cfd99a6b97c4957a08e6d8e8661faf93f8512ce30215b8559c5ed8d61c

data/CHANGELOG.md

@@ -1,4 +1,18 @@
 # Changelog
+## 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

@@ -15,6 +15,36 @@ module LMDocstache
       find_documents_to_interpolate
     end
 
+    def signature_tags
+      @documents.values.flat_map do |document|
+        document.text.strip.scan(/\[\[sig_.+?\]\]/)
+      end
+    end
+
+    def usable_signature_tags
+      @documents.values.flat_map do |document|
+        document.css('w|p')
+          .select { |tag| tag.text =~ /\[\[sig_.+?\]\]/ }
+          .flat_map { |tag| tag.text.scan(/\[\[sig_.+?\]\]/) }
+      end
+    end
+
+    def usable_signature_tag_names
+      self.usable_signature_tags.map do |tag|
+        tag.scan(/\[\[sig_(.+?)\]\]/)
+        $1
+      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(/\{\{.+?\}\}/)
@@ -58,10 +88,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)
@@ -111,7 +141,12 @@ module LMDocstache
 
     def flatten_paragraph(p)
       runs = p.css('w|r')
+
       host_run = runs.shift
+      until host_run.at_css('w|t').present? || runs.size == 0 do
+        host_run = runs.shift
+      end
+
       runs.each do |run|
         host_run.at_css('w|t').content += run.text
         run.unlink

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.2.1"
+  VERSION = "1.3.2"
 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.}
@@ -22,5 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
   s.add_development_dependency 'pry-byebug', '~> 1'
-  s.add_development_dependency 'activesupport', '~> 1'
+  s.add_development_dependency 'activesupport', '~> 3'
 end

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.2.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Roey Chasman
+- Frederico Assunção
 - Jonathan Stevens
 - Will Cosgrove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-09-17 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
@@ -80,18 +81,19 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
 description: Integrates data into MS Word docx template files. Processing supports
   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,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax
@@ -149,6 +153,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