lm_docstache 1.2.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b345230c53f335f5de05dccdaca946bf30edaee21031c219dbdad1315c61c915
-  data.tar.gz: 554faf30a6988614877f20d72d172d1a66c11bcb2a145f4eb4efd45f7a598fb0
+  metadata.gz: c127a60845dc1c0d7d532fb71bbd4707fb9e7c57dd7471308fa01715d409f56f
+  data.tar.gz: 35a7e1c75e45bf01615912a7aaf8ac5552a79a4dd7a1f03249f08eae8878a96a
 SHA512:
-  metadata.gz: 66732e83ef4cbd515c10904dd293a29346bb1278f1bcfa3ad7becc6e027798f8ca2ca1534f2a9ffc86ee1e4db2d632cd6c926fd703975f386524fd42ccd48516
-  data.tar.gz: f3ff05f0d5e5b55e3c6eb3e070713b625f74544d667816a71a761d48521ffda12146ff72b3a1189b9a794b8a190a60ea7227a374c0c58711471fba1786de0ce4
+  metadata.gz: f703252194067f0478974ed8823cbdb68a3cfd4fcf853c038e9f183b5e2865ce6775f521ec8977ecc53db4ae79ecfdbf753f5248725bdd7dc353473bd6914ae6
+  data.tar.gz: 3386aacc5a80637145a24dfc13fa2fcefe9c0114701f911554e0e2bf53f5f3aaedee8669c54792f63d069e658d9c74786f89c1dfa063c7f668a74dfcf8c1ad0e

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/.gitignore

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

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
+## 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.
+
+## 1.2.1
+* Fix inline conditional issues such as no support for multi conditionals.
 
 ## 1.2.0
 * Add support for inline conditionals.

data/lib/lm_docstache/block.rb

@@ -45,7 +45,7 @@ module LMDocstache
             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: name, data: data, element: match, inverted: inverted, condition: condition)
+              extract_block_from_element(name, data, match, inverted, condition)
             end
           end
         else
@@ -64,7 +64,7 @@ module LMDocstache
       end
     end
 
-    def self.extract_block_from_element(name: name, data: data, element: element, inverted: inverted, condition: condition)
+    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

data/lib/lm_docstache/document.rb

@@ -111,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

@@ -43,7 +43,7 @@ module LMDocstache
     def expand_and_replace_block(block)
       case block.type
       when :conditional
-        condition = get_condition(block)
+        condition = get_condition(block.name, block.condition, block.inverted)
         unless condition
           block.content_elements.each(&:unlink)
         end
@@ -69,13 +69,13 @@ module LMDocstache
     end
 
     def replace_conditionals(block)
-      condition = get_condition(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]}}}", "")
@@ -86,10 +86,12 @@ module LMDocstache
         end
 
         # the only difference in this code block is caret instead of pound in three places,
-        # and the condition being inverted. maybe combine them?
+        # 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|
-            if !condition
+            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
@@ -104,7 +106,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,14 +119,14 @@ module LMDocstache
 
     private
 
-    def get_condition(block)
-      case condition = @data.get(block.name, condition: block.condition)
+    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 block.inverted
+      condition = !condition if inverted
 
       condition
     end

data/lib/lm_docstache/version.rb

@@ -1,3 +1,3 @@
 module LMDocstache
-  VERSION = "1.2.0"
+  VERSION = "1.2.4"
 end

data/lm_docstache.gemspec

@@ -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

@@ -2,9 +2,10 @@ require 'spec_helper'
 require 'nokogiri'
 
 module LMDocstache
-  module TestData
+  module BlockTestData
     DATA = {
       gender: 'Male',
+      num: '2',
       first_name: 'Hector',
       last_name: 'Jones'
     }
@@ -12,7 +13,7 @@ module LMDocstache
 end
 
 describe LMDocstache::Renderer do
-  let(:data) { Marshal.load(Marshal.dump(LMDocstache::TestData::DATA)) } # deep copy
+  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) }
@@ -64,6 +65,24 @@ describe LMDocstache::Renderer do
     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",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lm_docstache
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.4
 platform: ruby
 authors:
 - Roey Chasman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -47,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
@@ -54,20 +57,37 @@ 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:
@@ -78,10 +98,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,48 +0,0 @@
-PATH
-  remote: .
-  specs:
-    lm_docstache (1.2.0)
-      nokogiri (~> 1.6)
-      rubyzip (~> 1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  lm_docstache!
-  pry-byebug (>= 1)
-  rspec (>= 3.1.0)
-
-BUNDLED WITH
-   1.17.2