lm_docstache 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1f6fc5b88008b8b1ac10ee094cd6d9c4848fc5beffab1a2ebe258067e87b07
-  data.tar.gz: 78d2b3c6da9b1dbb3c6378c02ac5fc782e226b696a6fe4be8692a15e1b9fced7
+  metadata.gz: 0ab76fe58e63d2b57612f1b63cde29861a5552f08549dfdef6487127d63ee30c
+  data.tar.gz: 397def49df4c8a2fcb5688c5b52ca2d1b2940b9efebf37747ff745b33b4561d5
 SHA512:
-  metadata.gz: d84c886d7c5c436d040548b5c7c4191d7a2d545e5ee06f3edb45a6fd587c4b1af027911df8fc987392499787d4a322a76b064afb170460e52f92eae8937d523e
-  data.tar.gz: 23b685a6aac5a889bcb6eee6f2a12c7059328cdc7b52ea253d34c2cd2f25c7a33f932161eac39e1e8552cc6cff8d821bdb9c0923a45ce62e4e96939f56bb1683
+  metadata.gz: 55ab02fac2c3e0033522d89d739be8fb16c2431952dea35485c9f1d6aca2264c6d8bb06ab2fb0e9a491f03077e54c870802c77ff51888a03a53208dc86d2bcbc
+  data.tar.gz: 0b9ac7bfac5f4a106d12da49a75291f1a5740a154e64641db1d93caa9187089c028de6e12648b074079867750b65fbced6de6cff48b7bad64d2acbea1cfaccb9

data/.gitignore

@@ -2,3 +2,4 @@
 spec/example_input/tmp
 .idea/
 *.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
+## 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|t').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"
+  VERSION = "1.3.1"
 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.}
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'nokogiri', '~> 1.6'
   s.add_runtime_dependency 'rubyzip', '~> 1.1'
 
-  s.add_development_dependency 'rspec', '>= 3.1.0'
-  s.add_development_dependency 'pry-byebug', '>= 1'
-  s.add_development_dependency 'activesupport', '6.0.3.2'
+  s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+  s.add_development_dependency 'pry-byebug', '~> 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
+  version: 1.3.1
 platform: ruby
 authors:
 - Roey Chasman
+- Frederico Assunção
 - Jonathan Stevens
 - Will Cosgrove
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -47,6 +48,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -54,38 +58,42 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
+        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: []
@@ -96,7 +104,6 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -111,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
@@ -120,7 +128,7 @@ homepage: https://www.lawmatics.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax
 test_files:
@@ -144,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

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    lm_docstache (1.2.1)
-      nokogiri (~> 1.6)
-      rubyzip (~> 1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.4.4)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubyzip (1.3.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 6.0.3.2)
-  lm_docstache!
-  pry-byebug (>= 1)
-  rspec (>= 3.1.0)
-
-BUNDLED WITH
-   1.17.2