docstache 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4663953840e841ea911fdd47ba74cb5bd4ef5f37
-  data.tar.gz: 1b7d7b96dad91ec189f742a6f575bc3dd0b4a298
+  metadata.gz: 3b400a5b0a023a3d6a9deb3835faff68ee17a5d7
+  data.tar.gz: 59c5ff97e4c9f34aad5c38a793bf937efcf4aa80
 SHA512:
-  metadata.gz: f1bdf1f42ad5f50efe553cb65d678ee0047889179e41c4359611100ca363238761fcfe8dfa6903b5301093bf36ed23bb5c346ae84114d04ba6c7875e51d90371
-  data.tar.gz: e37304fd77b542fb41efde67a4ea600e1d709f36a2f918bccd60a9efce9dde1e943d066da2c9b18d38cc10d70429e354a769ea2d3fca506e082c32d0b812073b
+  metadata.gz: 2130ef05930e66377c40bae00a9dabb56c9a247c8f86de787881630b02f76bc669c59ced04108091f8ec24646dc80fb286dbab5933527a0325952bb93c9f9c68
+  data.tar.gz: 7bf46117d6252fe7dbbeb729a94a459ed24c8968b7746102006df2e11ff7e75f4a379a4818575878155cfbcdb2cad3bb360b81be80e55c3c79becfdb88e0d86b

data/changelog.md

@@ -1,12 +1,17 @@
 # Changelog
 
+## 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
 
-* [08f09d19] Hash keys inside DataScope are symbolized
+* [08f09d1922e73ccaf17989a568deeb2ce0ebd4b8] Hash keys inside DataScope are symbolized
 
 ## 0.0.6
 
-* [fcba2080] Fixed a bug When two tags were inside one xml node, it would mistakenly report that there was an error when there wasn't.
+* [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
 

data/lib/docstache/block.rb

@@ -1,13 +1,14 @@
 module Docstache
   class Block
-    attr_reader :name, :opening_element, :content_elements, :closing_element, :inverted
-    def initialize(name:, data:, opening_element:, content_elements:, closing_element:, inverted:)
+    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
@@ -30,14 +31,14 @@ module Docstache
       type == :conditional
     end
 
-    def self.find_all(name:, data:, elements:, inverted:)
-      if elements.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}\}\}.+\{\{\/#{name}\}\}/m)
-        if elements.any? { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}\}\}.+\{\{\/#{name}\}\}/m) }
-          matches = elements.select { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}\}\}.+\{\{\/#{name}\}\}/m) }
-          finds = matches.map { |match| find_all(name: name, data: data, elements: match.elements, inverted: inverted) }.flatten
+    def self.find_all(name:, data:, elements:, inverted:, condition: nil)
+      if elements.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}#{condition ? " when #{condition}" : ''}\}\}.+?\{\{\/#{name}\}\}/m)
+        if elements.any? { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}#{condition ? " when #{condition}" : ''}\}\}.+?\{\{\/#{name}\}\}/m) }
+          matches = elements.select { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}#{condition ? " when #{condition}" : ''}\}\}.+?\{\{\/#{name}\}\}/m) }
+          finds = matches.map { |match| find_all(name: name, data: data, elements: match.elements, inverted: inverted, condition: condition) }.flatten
           return finds
         else
-          opening = elements.select { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}\}\}/) }.first
+          opening = elements.select { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}#{condition ? " when #{condition}" : ''}\}\}/) }.first
           content = []
           next_sibling = opening.next
           while !next_sibling.text.match(/\{\{\/#{name}\}\}/)
@@ -45,7 +46,7 @@ module Docstache
             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)
+          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"

data/lib/docstache/data_scope.rb

@@ -6,24 +6,72 @@ module Docstache
       @parent = parent
     end
 
-    def get(key, hash=@data, original_key=key)
+    def get(key, hash: @data, original_key: key, condition: nil)
       symbolize_keys!(hash)
       tokens = key.split('.')
       if tokens.length == 1
-        return hash.fetch(key.to_sym) { |key| @parent.get(original_key) }
+        if key.match(/(\w+)\[(\d+)\]/)
+          result = hash.fetch($1.to_sym) { |key| @parent.get(original_key) }
+          if result.respond_to?(:[])
+            result = result[$2.to_i]
+          end
+        else
+          result = hash.fetch(key.to_sym) { |key| @parent.get(original_key) }
+        end
+        if condition.nil? || !result.respond_to?(:select)
+          return result
+        else
+          return result.select { |el| evaluate_condition(condition, el) }
+        end
       elsif tokens.length > 1
         key = tokens.shift
-        if hash.has_key?(key.to_sym)
-          subhash = hash.fetch(key.to_sym)
+        if key.match(/(\w+)\[(\d+)\]/)
+          if hash.has_key?($1.to_sym)
+            collection = hash.fetch($1.to_sym)
+            if collection.respond_to?(:[])
+              subhash = collection[$2.to_i]
+            else
+              subhash = collection
+            end
+          else
+            return @parent.get(original_key)
+          end
         else
-          return @parent.get(original_key)
+          if hash.has_key?(key.to_sym)
+            subhash = hash.fetch(key.to_sym)
+          else
+            return @parent.get(original_key)
+          end
         end
-        return get(tokens.join('.'), subhash, original_key)
+        return get(tokens.join('.'), hash: subhash, original_key: original_key)
       end
     end
 
     private
 
+    def evaluate_condition(condition, data)
+      condition = condition.match(/(.+?)\s*(==|~=)\s*(.+)/)
+      if condition[2] == "=="
+        # Equality condition
+        left = evaluate_expression(condition[1], data)
+        right = evaluate_expression(condition[3], data)
+        return left == right
+      else
+        # Matches condition
+        left = get(condition[1], hash: data)
+        right = Regex.new(condition[3].match(/\/(.+)\//)[1])
+        return left.match(right)
+      end
+    end
+
+    def evaluate_expression(expression, data)
+      if expression.match(/(["'“])(.+)(\k<1>|”)/)
+        $2
+      else
+        get(expression, hash: data)
+      end
+    end
+
     def symbolize_keys!(hash)
       hash.keys.each do |key|
         hash[(key.to_sym rescue key)] = hash.delete(key)

data/lib/docstache/document.rb

@@ -14,12 +14,12 @@ module Docstache
     end
 
     def tags
-      @document.text.gsub(/\s+/, '').scan(/\{\{[\w\.\^\#\/]+\}\}/)
+      @document.text.gsub(/\s+/, '').scan(/\{\{.+?\}\}/)
     end
 
     def usable_tags
-      @document.css('w|t').select { |tag| tag.text =~ /\{\{[\w\.\^\#\/]+\}\}/ }.map { |tag|
-        tag.text.scan(/\{\{[\w\.\^\#\/]+\}\}/)
+      @document.css('w|t').select { |tag| tag.text =~ /\{\{.+?\}\}/ }.map { |tag|
+        tag.text.scan(/\{\{.+?\}\}/)
       }.flatten
     end
 

data/lib/docstache/renderer.rb

@@ -1,6 +1,6 @@
 module Docstache
   class Renderer
-    BLOCK_REGEX = /\{\{([\#\^])([\w\.]+)\}\}.+?\{\{\/\g<2>\}\}/m
+    BLOCK_REGEX = /\{\{([\#\^])([\w\.]+)(?:\swhen\s(.+?\s?(?:==|~=)\s?.+?))?\}\}.+?\{\{\/\k<2>\}\}/m
 
     def initialize(xml, data)
       @content = xml
@@ -19,7 +19,7 @@ module Docstache
       blocks = @content.text.scan(BLOCK_REGEX)
       found_blocks = blocks.uniq.map { |block|
         inverted = block[0] == "^"
-        Block.find_all(name: block[1], elements: @content.elements, data: @data, inverted: inverted)
+        Block.find_all(name: block[1], elements: @content.elements, data: @data, inverted: inverted, condition: block[2])
       }.flatten
       found_blocks.each do |block|
         expand_and_replace_block(block)
@@ -40,7 +40,7 @@ module Docstache
           block.content_elements.each(&:unlink)
         end
       when :loop
-        set = @data.get(block.name)
+        set = @data.get(block.name, condition: block.condition)
         content = set.map { |item|
           data = DataScope.new(item, @data)
           elements = block.content_elements.map(&:clone)
@@ -62,10 +62,10 @@ module Docstache
 
     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}\}\}/, text(data.get(r)))
+            rendered_string.gsub!("{{#{r}}}", text(data.get(r)))
           end
           text_el.content = rendered_string
         end

data/lib/docstache/version.rb

@@ -1,3 +1,3 @@
 module Docstache
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/docstache.rb

@@ -1,11 +1,11 @@
 require 'nokogiri'
 require 'zip'
 
-require "docstache/version"
-require "docstache/data_scope"
-require "docstache/block"
-require "docstache/renderer"
-require "docstache/document"
+require_relative "docstache/version"
+require_relative "docstache/data_scope"
+require_relative "docstache/block"
+require_relative "docstache/renderer"
+require_relative "docstache/document"
 
 module Docstache
   #noop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docstache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Will Cosgrove
@@ -14,42 +14,42 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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
 description: Integrates data into MS Word docx template files. Processing supports
@@ -60,7 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,17 +90,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax