lm_docstache 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8d96c1d658331a8ef93e7ace164759a64e26f9fc6f579ccab6aaf37032ad6fd
+  data.tar.gz: abaf62fe5a057c4adc66cbf2ed57ec87c75b55d349259953b02bba568b55dd35
+SHA512:
+  metadata.gz: e1b98280644b99d84502cf026887d6be64b038950afe96cefb97ce5364de9b7b760c577ea052a377e4a3e7cf1af6b743a1d3d8fcbe8837b7d8a47d83b75f7625
+  data.tar.gz: 694650b1c8b433244cfc7ea891de75d77ab70816aaa69442faee72f8efc3c8de71c9201d096c24fbdcf8a02ed32b47fa471a08d2a890be11c60380d5011f1d94

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+spec/example_input/tmp
+.idea/
+*.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+## 1.0.0
+  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
+
+## 0.3.1
+* [2228ba727f8a2e3705fe223ce02b5e760c935572] Added `Document#unusable_tags` to list out tags that are not able to be interpolated due to being split across tags in the Document's XML
+
+## 0.3.0
+* [c841078f7d340c18323f05f0785e75cd560eed2c] Added ability to do tag interpolation in headers and footers.  The header/footer used is the header or footer from the first document passed into `Document.new()`
+
+## 0.2.1
+* [25b4c2e9e3dcb19b6fe9a255fec2c2bfd92029a6] Fixed a bug where a tag with regular expression characters could not be fixed with the `fix_errors` method
+
+## 0.2.0
+
+* [902d9890bee1a20a90377a94c3096a51781e8a24] You can access array elements with `[]`s within a `{{tag}}`
+* [a36c4fefed763b6a54d15564e887fbcf3c3421e3] You can use conditions on loops to only loop over specific elements
+
+## 0.1.0
+
+* [08f09d1922e73ccaf17989a568deeb2ce0ebd4b8] Hash keys inside DataScope are symbolized
+
+## 0.0.6
+
+* [f945bc70ebb684f21e2488a3ad30c205bc05ddbb] Fixed a bug When two tags were inside one xml node, it would mistakenly report that there was an error when there wasn't.
+
+## 0.0.5
+
+* Fixed a bug that caused {{^tags}} to always show up as errors
+
+## 0.0.4
+
+* Rewrite of the Renderer class
+* Conditional Blocks now work
+* Loops now work
+
+## 0.0.3
+
+* Added ability to have nested tags like `{{purchase_order.number}}` through the
+  use of the `Docstache::DataScope` class
+
+## 0.0.2
+
+* Fixed a bug that made appended documents not get appended to the *end* of a
+  document
+* Fixed a bug that made merged documents not open in Word.  This was caused due
+  to the `section properties` tag in the xml getting used more than once, since
+  each document had one.  Now only the first `sectPr` tag is kept.
+
+## 0.0.1
+
+* Initial release.  Still not working:
+  * Nested tags `{{foo.bar}}`
+  * Blocks (loops and conditiontals) `{{#foo}} ... {{/foo}}`

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,72 @@
+[![Gem Version](https://badge.fury.io/rb/lm_docstache.svg)](http://badge.fury.io/rb/lm_docstache)
+
+# LM-Docstache
+
+Lawmatics' templating utility for generating dynamic docx files.
+
+## Features
+
+* Mustache-like data interpolation into Microsoft Word .docx files
+  * This includes loops, and conditional blocks
+* Merging together multiple documents (documents are joined by a page break)
+* No more hassles with Word splitting up your tags across multiple XML tags. We gotcha.
+* Error detection for word documents, just in case we don't gotcha.
+
+## Conditionals
+
+### Truthy
+```
+{{#true_cond}}
+SHOW ME
+{{/true_cond}}
+```
+```
+{{#false_cond}}
+DONT SHOW ME
+{{/false_cond}}
+```
+
+### Falsy
+```
+{{^false_cond}}
+SHOW ME
+{{/false_cond}}
+```
+```
+{{^true_cond}}
+DONT SHOW ME
+{{/true_cond}}
+```
+
+### If
+Assume `classrooom = "Rm 202"`
+
+```
+{{#classroom == “Rm 202”}}
+SHOW ME
+{{/classroom}}
+```
+```
+{{#classroom == "NON EXISTANT"}}
+DONT SHOW ME
+{{/classroom}}
+```
+
+Without Quotes:
+```
+{{#classroom == Rm 202}}
+SHOW ME
+{{/classroom}}
+```
+
+With Negation
+```
+{{^classroom == "NON EXISTANT"}}
+SHOW ME
+{{/classroom}}
+```
+```
+{{^classroom == Rm 202}}
+DONT SHOW ME
+{{/classroom}}
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require 'bundler'
+
+RSpec::Core::RakeTask.new(:spec)
+Bundler::GemHelper.install_tasks
+
+task default: [:spec]

data/lib/lm_docstache.rb

@@ -0,0 +1,9 @@
+require 'nokogiri'
+require 'zip'
+require "lm_docstache/version"
+require "lm_docstache/data_scope"
+require "lm_docstache/document"
+require "lm_docstache/block"
+require "lm_docstache/renderer"
+
+module LMDocstache; end

data/lib/lm_docstache/block.rb

@@ -0,0 +1,62 @@
+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)
+      @name = name
+      @data = data
+      @opening_element = opening_element
+      @content_elements = content_elements
+      @closing_element = closing_element
+      @inverted = inverted
+      @condition = condition
+    end
+
+    def type
+      @type ||= if @inverted
+        :conditional
+      else
+        if @data.get(@name).is_a? Array
+          :loop
+        else
+          :conditional
+        end
+      end
+    end
+
+    def loop?
+      type == :loop
+    end
+
+    def conditional?
+      type == :conditional
+    end
+
+    def self.find_all(name:, data:, elements:, inverted:, condition: nil, ignore_missing: true)
+      inverted_op = inverted ? '\^' : '\#'
+      full_tag_regex = /\{\{#{inverted_op}(#{name})\s?#{condition}\}\}.+?\{\{\/\k<1>\}\}/m
+      start_tag_regex = /\{\{#{inverted_op}#{name}\s?#{condition}\}\}/m
+      close_tag_regex = /\{\{\/#{name}\}\}/s
+
+      if elements.text.match(full_tag_regex)
+        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)
+          end
+        else
+          opening = elements.find { |e| e.text.match(start_tag_regex) }
+          content = []
+          next_sibling = opening.next
+          while !next_sibling.text.match(close_tag_regex)
+            content << next_sibling
+            next_sibling = next_sibling.next
+          end
+          closing = next_sibling
+          return Block.new(name: name, data: data, opening_element: opening, content_elements: content, closing_element: closing, inverted: inverted, condition: condition)
+        end
+      else
+        raise "Block not found in given elements" unless ignore_missing
+      end
+    end
+  end
+end

data/lib/lm_docstache/data_scope.rb

@@ -0,0 +1,67 @@
+module LMDocstache
+  class DataScope
+
+    def initialize(data, parent=EmptyDataScope.new)
+      @data = data
+      @parent = parent
+    end
+
+    def get(key, hash: @data, original_key: key, condition: nil)
+      symbolize_keys!(hash)
+      tokens = key.split('.')
+      if tokens.length == 1
+        result = hash.fetch(key.to_sym) { |_| @parent.get(original_key) }
+        unless result.respond_to?(:select)
+          return result if evaluate_condition(condition, result)
+        else
+          return result.select { |el| evaluate_condition(condition, el) }
+        end
+      elsif tokens.length > 1
+        key = tokens.shift
+        subhash = hash.fetch(key.to_sym) { |_| @parent.get(original_key) }
+        return get(tokens.join('.'), hash: subhash, original_key: original_key)
+      end
+    end
+
+    private
+
+    def symbolize_keys!(hash)
+      hash.transform_keys!{ |key| key.to_sym rescue key }
+    end
+
+    def evaluate_condition(condition, data)
+      return true if condition.nil?
+      condition = condition.match(/(==|~=)\s*(.+)/)
+      operator = condition[1]
+      expression = condition[2]
+      case condition[1]
+      when "=="
+        # Equality condition
+        expression = evaluate_expression(expression, data)
+        return data == expression
+      else
+        # Matches condition
+        expression = evaluate_expression(expression, data)
+        right = Regex.new(expression.match(/\/(.+)\//)[1])
+        return data.match(right)
+      end
+    end
+
+    def evaluate_expression(expression, data)
+      if expression.match(/(["'“]?)(.+)(\k<1>|”)/)
+        $2
+      elsif data.respond_to?(:select)
+        get(expression, hash: data)
+      else
+        false
+      end
+    end
+  end
+
+  class EmptyDataScope
+    def get(_)
+      return nil
+    end
+  end
+
+end