lm_docstache 1.1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da1923074bce295e621bf0fff86882e16fe9f8bef9bf7373e955ce4b1a1f8f7
-  data.tar.gz: 7fb1709820b0d692c68b0ca8f5b2cea3769170e2387254f309bc77cd2cb9c730
+  metadata.gz: c16a6e73e07d070f2c486647c784c04627d746849481c145d66f6735780c65bb
+  data.tar.gz: 2fa52f69ea406bfe221bccff2a599af568ea9e0d6c21ab20500d06ad0dbfaeb4
 SHA512:
-  metadata.gz: b4d8662856ee7a9b1239b4ca5e1427ae57132b0da6133b7cc955e85966c90facfa20da9261b6d4654a5fa2b96fe5bedf2dd61ea20d70039a276aa9628d412223
-  data.tar.gz: 65912e5b0715e750de569d69b3da542e1f7ebbe58a58cab115b8090e64de4e8b329b18f7c95e45bc2a234a15045728acab13611303889ba7dde923f54830c86d
+  metadata.gz: '0096916f50745ca968b0a2d365a0d279aae3007c4d7e5e6376c87b1d512f082d0646e064d5a84bef9be1b33e53eb3d81d33122a6e868c2e389f67aecfbe00662'
+  data.tar.gz: 0723cefa1931bbc2d8b7ab513d1af844f43d05ff4d61fa04d73ad772cbd8a81dea29319a72403b6657ae49688026edc6ace60dc5a0b32a85ed8223c003820901

data/.github/workflows/ruby.yml

@@ -0,0 +1,29 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: rspec

data/CHANGELOG.md

@@ -1,7 +1,17 @@
 # Changelog
 
+## 1.2.2
+* Remove uneccessary runtime dependency on active support.
+
+## 1.2.1
+* Fix inline conditional issues such as no support for multi conditionals.
+
+## 1.2.0
+* Add support for inline conditionals.
+* Add some tests.
+
 ## 1.0.0
-  Fork the Docstache codebase and rename all references to LMDocstache.
+* Fork the Docstache codebase and rename all references to LMDocstache.
 
 ## 0.3.2
 * [b3b66a0cd7ae67834cdbe7c18cefdb1498bcc5ab] I'm an idiot.  Fixed an error in the `Document#unusable_tags` method

data/lib/lm_docstache/block.rb

@@ -1,7 +1,7 @@
 module LMDocstache
   class Block
-    attr_reader :name, :opening_element, :content_elements, :closing_element, :inverted, :condition
-    def initialize(name:, data:, opening_element:, content_elements:, closing_element:, inverted:, condition: nil)
+    attr_reader :name, :opening_element, :content_elements, :closing_element, :inverted, :condition, :inline
+    def initialize(name:, data:, opening_element:, content_elements:, closing_element:, inverted:, condition: nil, inline: false)
       @name = name
       @data = data
       @opening_element = opening_element
@@ -9,6 +9,7 @@ module LMDocstache
       @closing_element = closing_element
       @inverted = inverted
       @condition = condition
+      @inline = inline
     end
 
     def type
@@ -31,7 +32,7 @@ module LMDocstache
       type == :conditional
     end
 
-    def self.find_all(name:, data:, elements:, inverted:, condition: nil, ignore_missing: true)
+    def self.find_all(name:, data:, elements:, inverted:, condition: nil, ignore_missing: true, child: false)
       inverted_op = inverted ? '\^' : '\#'
       full_tag_regex = /\{\{#{inverted_op}(#{name})\s?#{condition}\}\}.+?\{\{\/\k<1>\}\}/m
       start_tag_regex = /\{\{#{inverted_op}#{name}\s?#{condition}\}\}/m
@@ -41,7 +42,11 @@ module LMDocstache
         if elements.any? { |e| e.text.match(full_tag_regex) }
           matches = elements.select { |e| e.text.match(full_tag_regex) }
           return matches.flat_map do |match|
-            find_all(name: name, data: data, elements: match.elements, inverted: inverted, condition: condition)
+            if match.elements.any?
+              find_all(name: name, data: data, elements: match.elements, inverted: inverted, condition: condition, child: true)
+            else
+              extract_block_from_element(name, data, match, inverted, condition)
+            end
           end
         else
           opening = elements.find { |e| e.text.match(start_tag_regex) }
@@ -58,5 +63,9 @@ module LMDocstache
         raise "Block not found in given elements" unless ignore_missing
       end
     end
+
+    def self.extract_block_from_element(name, data, element, inverted, condition)
+      return Block.new(name: name, data: data, opening_element: element.parent.previous, content_elements: [element.parent], closing_element: element.parent.next, inverted: inverted, condition: condition, inline: true)
+    end
   end
 end

data/lib/lm_docstache/document.rb

@@ -68,6 +68,16 @@ module LMDocstache
       File.open(output, "w") { |f| f.write buffer.string }
     end
 
+    def render_replace(output, text)
+      rendered_documents = Hash[
+        @documents.map do |(path, document)|
+          [path, LMDocstache::Renderer.new(document.dup, {}).render_replace(text)]
+        end
+      ]
+      buffer = zip_buffer(rendered_documents)
+      File.open(output, "w") { |f| f.write buffer.string }
+    end
+
     def render_stream(data={})
       rendered_documents = Hash[
         @documents.map do |(path, document)|
@@ -79,6 +89,16 @@ module LMDocstache
       return buffer.sysread
     end
 
+    def render_xml(data={})
+      rendered_documents = Hash[
+        @documents.map do |(path, document)|
+          [path, LMDocstache::Renderer.new(document.dup, data).render]
+        end
+      ]
+
+      rendered_documents
+    end
+
     private
 
     def problem_paragraphs
@@ -91,7 +111,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

@@ -13,6 +13,16 @@ module LMDocstache
       return @content
     end
 
+    def render_replace(text)
+      @content.css('w|t').each do |text_el|
+        rendered_string = text_el.text
+        if !(results = rendered_string.scan(/\|-Lawmatics Test-\|/)).empty?
+          text_el.content = text
+        end
+      end
+      return @content
+    end
+
     private
 
     def find_and_expand_blocks
@@ -22,20 +32,18 @@ module LMDocstache
         Block.find_all(name: block[1], elements: @content.elements, data: @data, inverted: inverted, condition: block[2])
       end
       found_blocks.each do |block|
-        expand_and_replace_block(block) if block.present?
+        if block.inline
+          replace_conditionals(block)
+        else
+          expand_and_replace_block(block) if block.present?
+        end
       end
     end
 
     def expand_and_replace_block(block)
       case block.type
       when :conditional
-        case condition = @data.get(block.name, condition: block.condition)
-        when Array
-          condition = !condition.empty?
-        else
-          condition = !!condition
-        end
-        condition = !condition if block.inverted
+        condition = get_condition(block.name, block.condition, block.inverted)
         unless condition
           block.content_elements.each(&:unlink)
         end
@@ -60,6 +68,42 @@ module LMDocstache
       block.closing_element.unlink
     end
 
+    def replace_conditionals(block)
+      @content.css('w|t').each do |text_el|
+        rendered_string = text_el.text
+
+        if !(results = rendered_string.scan(/{{#(.*?)}}(.*?){{\/(.*?)}}/)).empty?
+          results.each do |r|
+            vals = r[0].split('==')
+            condition = get_condition(vals[0].strip, "== #{vals[1]}")
+            if condition
+              rendered_string.sub!("{{##{r[0]}}}", "")
+              rendered_string.sub!("{{/#{r[2]}}}", "")
+            else
+              rendered_string.sub!("{{##{r[0]}}}#{r[1]}{{/#{r[2]}}}", "")
+            end
+          end
+        end
+
+        # the only difference in this code block is caret instead of pound in three places,
+        # the inverted value passed to get_condition, and the condition being inverted. maybe combine them?
+        if !(results = rendered_string.scan(/{{\^(.*?)}}(.*?){{\/(.*?)}}/)).empty?
+          results.each do |r|
+            vals = r[0].split('==')
+            condition = get_condition(vals[0].strip, "== #{vals[1]}", true)
+            if condition
+              rendered_string.sub!("{{^#{r[0]}}}", "")
+              rendered_string.sub!("{{/#{r[2]}}}", "")
+            else
+              rendered_string.sub!("{{^#{r[0]}}}#{r[1]}{{/#{r[2]}}}", "")
+            end
+          end
+        end
+
+        text_el.content = rendered_string
+      end
+    end
+
     def replace_tags(elements, data)
       elements.css('w|t').each do |text_el|
         if !(results = text_el.text.scan(/\{\{([\w\.]+)\}\}/).flatten).empty?
@@ -72,5 +116,19 @@ module LMDocstache
       end
       return elements
     end
+
+    private
+
+    def get_condition(name, condition, inverted = false)
+      case condition = @data.get(name, condition: condition)
+      when Array
+        condition = !condition.empty?
+      else
+        condition = !!condition
+      end
+      condition = !condition if inverted
+
+      condition
+    end
   end
 end

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "1.1.2"
+  VERSION = "1.2.3"
 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", "Will Cosgrove"]
-  s.email       = ["roey@lawmatics.com", "will@willcosgrove.com"]
+  s.authors     = ["Roey Chasman", "Jonathan Stevens", "Will Cosgrove"]
+  s.email       = ["roey@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,6 +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 'rspec', '~> 3.1', '>= 3.1.0'
+  s.add_development_dependency 'pry-byebug', '~> 1'
+  s.add_development_dependency 'activesupport', '~> 3'
 end

data/spec/conditional_block_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'nokogiri'
+
+module LMDocstache
+  module BlockTestData
+    DATA = {
+      gender: 'Male',
+      num: '2',
+      first_name: 'Hector',
+      last_name: 'Jones'
+    }
+  end
+end
+
+describe LMDocstache::Renderer do
+  let(:data) { Marshal.load(Marshal.dump(LMDocstache::BlockTestData::DATA)) } # deep copy
+  let(:base_path) { SPEC_BASE_PATH.join('example_input') }
+  let(:blank_doc_path) { "#{base_path}/blank.docx" }
+  let(:blank_doc) { LMDocstache::Document.new(blank_doc_path) }
+  let(:output_dir) { "#{base_path}/tmp" }
+  let(:temp_file) { "#{output_dir}/temp.docx" }
+  let(:result_file) { "#{output_dir}/result.docx" }
+
+  def render_docx(doc_text)
+    # create doc from blank
+    blank_doc.render_replace(temp_file, doc_text)
+
+    doc = LMDocstache::Document.new(temp_file).render_file(result_file, data)
+
+    result_doc = LMDocstache::Document.new(result_file).render_xml(data)
+    result_doc["word/document.xml"].text
+  end
+
+  before do
+    FileUtils.rm_rf(output_dir) if File.exist?(output_dir)
+    Dir.mkdir(output_dir)
+  end
+
+  after do
+    File.delete(temp_file)
+    File.delete(result_file)
+  end
+
+  it 'should handle inline conditional tags' do
+    result_text = render_docx("Refer to the matter as {{#gender == Male}}he{{/gender}}{{^gender == Male}}she{{/gender}} please")
+    expected_text = "Refer to the matter as he please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle else statements with inline conditional tags' do
+    result_text = render_docx("Refer to the matter as {{#gender == 'Female'}}he{{/gender}}{{^gender == 'Female'}}she{{/gender}} please")
+    expected_text = "Refer to the matter as she please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle inline conditional tags with no matches' do
+    result_text = render_docx("Refer to the matter as {{#gender == 'none'}}he{{/gender}} please")
+    expected_text = "Refer to the matter as  please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle inline conditional tags with tags inside' do
+    result_text = render_docx("Refer to the matter as {{#gender == 'Male'}}{{first_name}}{{/gender}}{{^gender == 'Male'}}{{last_name}}{{/gender}} please")
+    expected_text = "Refer to the matter as Hector please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle multiple positive checks in one line' do
+    result_text = render_docx("Refer to the matter as {{#gender == 'Male'}}him{{/gender}}{{#gender == 'Female'}}her{{/gender}} please")
+    expected_text = "Refer to the matter as him please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle multiple positive checks and multiple negative checks in one line' do
+    result_text = render_docx("be {{#num == 1}}1{{/num}}{{#num == 2}}2{{/num}} and {{^num == 2}}!2{{/num}}{{^num == 1}}!1{{/num}} please")
+    expected_text = "be 2 and !1 please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle multiple types of conditionals in one line' do
+    result_text = render_docx("be{{#gender == Male}} he {{/gender}}{{#num == 1}}1{{/num}}{{#num == 2}}2{{/num}} and {{^num == 2}}!2{{/num}}{{^num == 1}}!1{{/num}} please")
+    expected_text = "be he 2 and !1 please"
+    expect(result_text).to eq(expected_text)
+  end
+
+  it 'should handle multiline conditional tags' do
+    text = [
+      "Refer to the matter as",
+      "{{#gender == 'Male'}}",
+      "{{first_name}}",
+      "{{/gender}}",
+      "{{^gender == 'Male'}}",
+      "{{last_name}}",
+      "{{/gender}}Thank you"
+    ].join("\r\n")
+
+    result_text = render_docx(text)
+    expected_text = "Refer to the matter as\r\rHector\r\rThank you"
+    expect(result_text).to eq(expected_text)
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Roey Chasman
+- Jonathan Stevens
 - Will Cosgrove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -46,6 +47,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
@@ -53,29 +57,48 @@ 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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+- jonathan@lawmatics.com
 - will@willcosgrove.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -89,9 +112,11 @@ files:
 - lib/lm_docstache/renderer.rb
 - lib/lm_docstache/version.rb
 - lm_docstache.gemspec
+- spec/conditional_block_spec.rb
 - spec/data_scope_spec.rb
 - spec/empty_data_scope_spec.rb
 - spec/example_input/ExampleTemplate.docx
+- spec/example_input/blank.docx
 - spec/example_input/word/document.xml
 - spec/integration_spec.rb
 - spec/spec_helper.rb
@@ -120,9 +145,11 @@ signing_key:
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax
 test_files:
+- spec/conditional_block_spec.rb
 - spec/data_scope_spec.rb
 - spec/empty_data_scope_spec.rb
 - spec/example_input/ExampleTemplate.docx
+- spec/example_input/blank.docx
 - spec/example_input/word/document.xml
 - spec/integration_spec.rb
 - spec/spec_helper.rb