docstache 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e82b56fd6b5c8941104ade8ba8c8d683a1e01389
-  data.tar.gz: 60abfa4c732098cbf233088d00d84bed12d15546
+  metadata.gz: 498cab83d9bdadd7f60741682832abff60440b8b
+  data.tar.gz: 7ae7842084c4e2f9d32e06df3d4892664975dd68
 SHA512:
-  metadata.gz: 4293f3d05fab0da40b7d0bcffbd5df4cd583ab00e61b158b7e5ecab247566cb6f99cb7623b1528df2c0bebb19e1882ee0d10a811693d061dc1738d21c6bfaeaf
-  data.tar.gz: c67664422e5d74242af736abc33909ba0626ae0ca52c002213d855c2c58a10c1b92ad7a66da21e227a84a779e092f512bd2eba69a17929e3da7cdde0984a2f22
+  metadata.gz: 33dcab26cfadbc1c6af24fb888faa084c7a31e00abdc2975b1ddab8a4946d4c684063d764b41e14efb0f2973b70e2d8c5229887fffef6b3288c602c8669be27e
+  data.tar.gz: c8f53d99e0b6c00d23533f046826ec9fd042b0678e5c09d8a1df5ea618dd0d0eaf90989510039dff02db27c8cd0fd4eecc94037d4ce4bbc55cdd79098bd515bd

data/changelog.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 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/lib/docstache/block.rb

@@ -0,0 +1,56 @@
+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:)
+      @name = name
+      @data = data
+      @opening_element = opening_element
+      @content_elements = content_elements
+      @closing_element = closing_element
+      @inverted = inverted
+    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:)
+      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
+          return finds
+        else
+          opening = elements.select { |e| e.text.match(/\{\{#{inverted ? '\^' : '\#'}#{name}\}\}/) }.first
+          content = []
+          next_sibling = opening.next
+          while !next_sibling.text.match(/\{\{\/#{name}\}\}/)
+            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)
+        end
+      else
+        raise "Block not found in given elements"
+      end
+    end
+
+  end
+end

data/lib/docstache/document.rb

@@ -14,7 +14,7 @@ module Docstache
     end
 
     def tags
-      @document.text.gsub(/\s+/, '').scan(/\{\{[\w\.\/\#]+\}\}/)
+      @document.text.gsub(/\s+/, '').scan(/\{\{[\w\.\/\#\^]+\}\}/)
     end
 
     def usable_tags

data/lib/docstache/renderer.rb

@@ -1,151 +1,80 @@
 module Docstache
   class Renderer
+    BLOCK_REGEX = /\{\{([\#\^])([\w\.]+)\}\}.+?\{\{\/\g<2>\}\}/m
+
     def initialize(xml, data)
       @content = xml
       @data = DataScope.new(data)
     end
 
     def render
-      process_content
+      find_and_expand_blocks
+      replace_tags(@content, @data)
       return @content
     end
 
     private
 
-    def process_content
-      parse_content(@content.elements)
-
-      content_tr = @content.xpath('//w:tr')
-
-      cleanup_loop(content_tr)
-    end
-
-    def extract_end_row(nd, key)
-      if !nd.nil?
-        case nd.text.to_s
-        when /\{\{\/#{key.to_s}\}\}/
-          puts "Found End Row for #{key.to_s}"
-          return nd
-        else
-          return extract_end_row(nd.next, key)
-        end
-      else
-        return nil
-      end
-    end
-
-    def expand_loop(nd, end_nd, key, element)
-      out = []
-      case nd.text.to_s
-      when /\{\{\##{key.to_s}\}\}/
-        out = expand_loop(nd.next, end_nd, key, element)
-      when end_nd.text.to_s
-        out = []
-      when /\{\{\#([a-zA-Z0-9_\.]+)\}\}/
-        new_key = $1
-        out += process_loop(nd, new_key, element)
-      else
-        new_node = nd.dup
-        puts "Adding Row #{nd.text} to list"
-        parse_content(new_node.elements, element)
-        out << new_node
-        puts "Next Node is: #{nd.next.text.to_s}"
-        out += expand_loop(nd.next, end_nd, key, element)
+    def find_and_expand_blocks
+      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)
+      }.flatten
+      found_blocks.each do |block|
+        expand_and_replace_block(block)
       end
-      return out
     end
 
-
-    def remove_loop(nd, key)
-      if nd
-        case nd.text.to_s
-        when /\{\{\/#{key.upcase.to_s}\}\}/
-          nd.unlink
+    def expand_and_replace_block(block)
+      case block.type
+      when :conditional
+        case condition = @data.get(block.name)
+        when Array
+          condition = !condition.empty?
         else
-          remove_loop(nd.next, key)
-          nd.unlink
+          condition = !!condition
         end
-      end
-    end
-
-
-    def process_loop(nd, key, data)
-      out = []
-      # puts "Found Loop #{key.to_s}"
-      # end_row = extract_end_row(nd, key)
-      #
-      # if !data.has_key?(key)
-      #   nil # Error in the data model
-      #   return []
-      # elsif data[key].empty?
-      #   remove_loop(nd, key) # No data to put in
-      #   return []
-      # else # Actual loop to process
-      #   data_set = data[key]
-      #   puts "Expanding Rows for loop #{key.to_s}"
-      #   puts "Data count is #{data_set.count}"
-      #   puts "Data is #{data_set}"
-      #
-      #   data_set.each do |element|
-      #     out += expand_loop(nd, end_row, key, element)
-      #   end
-      #   return out
-      # end
-    end
-
-    def parse_content(elements, data=@data)
-      elements.each do |nd|
-        case nd.name
-        when "tr"
-          case nd.text.to_s
-          when /\{\{\#([a-zA-Z0-9_\.]+)\}\}/
-            key = $1
-            # Get elements to add
-            elements = process_loop(nd, key, data)
-            # Add elements
-            elements.reverse.each do |e|
-              puts "Adding Row to file: #{e.text.to_s}"
-              nd.add_next_sibling(e)
-            end
-          else # it's a normal table row
-            parse_content(nd.elements, data)
+        condition = !condition if block.inverted
+        unless condition
+          block.content_elements.each(&:unlink)
+        end
+      when :loop
+        set = @data.get(block.name)
+        content = set.map { |item|
+          data = DataScope.new(item, @data)
+          elements = block.content_elements.map(&:clone)
+          replace_tags(Nokogiri::XML::NodeSet.new(@content, elements), data)
+        }
+        content.each do |els|
+          el = els[0]
+          els[1..-1].each do |next_el|
+            el.after(next_el)
+            el = next_el
           end
-        when "t" # It's a leaf that contains data to replace
-          subst_content(nd, data)
-	else # it's neither a leaf or a loop so let's process it
-          parse_content(nd.elements, data)
+          block.closing_element.before(els[0])
         end
+        block.content_elements.each(&:unlink)
       end
+      block.opening_element.unlink
+      block.closing_element.unlink
     end
 
-    def cleanup_loop(nodeset) # Acts in w/tr only as loops are based on these
-      nodeset.each do |nd|
-        case nd.text.to_s
-        when /\{\{\#([a-zA-Z0-9_\.]+)\}\}/
-          nd.unlink
-        when /\{\{\/([a-zA-Z0-9_\.]+)\}\}/
-          nd.unlink
-        when /\{\{[a-zA-Z0-9_\.]+\}\}/
-          nd.unlink
+    def replace_tags(elements, data)
+      elements.css('w|t').each do |text_el|
+        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)))
+          end
+          text_el.content = rendered_string
         end
       end
+      return elements
     end
 
-    def subst_content(nd, data)
-      inner = nd.inner_html
-      keys = nd.text.scan(/\{\{([a-zA-Z0-9_\.]+)\}\}/).map(&:first)
-      keys.each do |key|
-        value = data.get(key)
-        puts "Substituting {{#{key.to_s}}} with #{value}"
-        inner.gsub!("{{#{key.to_s}}}", safe(value))
-      end
-      if !keys.empty?
-        nd.inner_html = inner
-      end
-    end
-
-    def safe(text)
-      text.to_s
+    def text(obj)
+      "#{obj}"
     end
 
   end

data/lib/docstache/version.rb

@@ -1,3 +1,3 @@
 module Docstache
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/docstache.rb

@@ -2,6 +2,7 @@ require 'nokogiri'
 require 'zip'
 
 require "docstache/data_scope"
+require "docstache/block"
 require "docstache/renderer"
 require "docstache/document"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docstache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Will Cosgrove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -65,8 +65,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- changelog.md
 - docstache.gemspec
 - lib/docstache.rb
+- lib/docstache/block.rb
 - lib/docstache/data_scope.rb
 - lib/docstache/document.rb
 - lib/docstache/renderer.rb
@@ -98,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Merges Hash of Data into Word docx template files using mustache syntax
@@ -110,4 +112,3 @@ test_files:
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/template_processor_spec.rb
-has_rdoc: