docx-templater 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjFlNTJkZDEzOTQyZWViMDJmMzVjNTljMjdkYmM0ODgxZDYxMjlkZQ==
+  data.tar.gz: !binary |-
+    ZTZjYTAwODdmMGM1ZGQzMGFmYTA3M2VjODAxYjQ2YjM2ODcxNTUxMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2M0ZWUyMzI4ZWEwNGYzMjFmMThmY2ExNDRlMmIxODRkOGU4NmNkYWU1MDYw
+    OWI1ZGZjNmQ1NjQxZTljODAxYjc1Mzk2M2JlZDVlMDdlOTdmZDQxNzc3MTVl
+    NGNiMjBhOTZmYzcxZTg1YTFlNDQxNjI3OWY4M2ZhY2FjOTdjZWY=
+  data.tar.gz: !binary |-
+    MjU1OWNjOTkzNDMxNWNiYTY4MmQxM2NiMzFkMDBmNTk4ZWY5NDhjZGFjZWRk
+    ODcyYjYxMGQ3M2ZiNGQ4NTFlNGYxYWE0NGYzNTAzOTc3ZjI2Y2M0YWJhYTYz
+    MmMzNTgzNzRkMzQ5ZmEyZjJhODBiZDMwYjQwOTJiOTg1ODM0ZWQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docx-templater.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 DmitryKa
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# DocxTemplater
+
+PURE RUBY GEM (works on Windows)! I tried use ready solutions, but some of them hasn't neccessary functions, other one didn't work in Win.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docx-templater2'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install docx_templater
+
+## Usage
+
+Can work with:
+- $SOME_VALUE$ : replace template stub (if value for replacing will be provided);
+- $REPEAT:SOME_COLLECTION$
+ (at least, one new row)
+ $EACH:SOME_VALUE_OF_COLLECTION_ITEM$
+ (at least, one new row)
+ $UNREPEAT:SOME_COLLECTION$;
+
+Repeating commands must be at the separate paragraphs.
+Note, that created template may look good but have bad structure for templater, so you should open docx as a zip archive, open "word/document.xml" and edit it
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/docx.rb

@@ -0,0 +1,6 @@
+require "docx/version"
+require 'docx/docx_handler'
+
+
+module Docx
+end

data/lib/docx/docx_handler.rb

@@ -0,0 +1,49 @@
+require 'zip'
+require 'nokogiri'
+require 'docx/template_handler'
+
+module Docx
+  class DocxHandler
+    include TemplateHandler
+
+    DOC_XML_ARCHIVE_PATH = 'word/document.xml'
+
+    def self.open(path, &block)
+      self.new(path, &block)
+    end
+
+    def initialize(path, &block)
+      @replace = {}
+      if block_given?
+        @zip = Zip::File.open(path)
+        yield(self)
+        @zip.close
+      else
+        @zip = Zip::File.open(path)
+      end
+    end
+
+    def insert(arg_hash)
+      raise TypeError unless arg_hash.kind_of? Hash
+      xml = @zip.read(DOC_XML_ARCHIVE_PATH)
+      into_doc = Nokogiri::XML(xml) { |x| x.noent } #TODO what is noent?
+      TemplateHandler::insert arg_hash, into_doc
+      @replace[DOC_XML_ARCHIVE_PATH] = into_doc.serialize save_with: 0
+    end
+
+    def save(path)
+      Zip::File.open(path, Zip::File::CREATE) do |out|
+        @zip.each do |entry|
+          out.get_output_stream(entry.name) do |o|
+            if @replace[entry.name]
+              o.write(@replace[entry.name])
+            else
+              o.write(@zip.read(entry.name))
+            end
+          end
+        end
+      end
+      @zip.close
+    end
+  end
+end

data/lib/docx/template_handler.rb

@@ -0,0 +1,161 @@
+module Docx
+  module TemplateHandler
+
+    START = 'REPEAT:'
+    FINISH = 'UNREPEAT:'
+    EACH = 'EACH:'
+    PARAGRAPH_XPATH = '//w:p'
+    TEXT_NODE_XPATH = './/w:t'
+    BUX = '$'
+    COLON = ':'
+
+    PR = 'Pr'
+    P = 'p'
+    W = 'w'
+
+    # Now supported only one-depth cycles and cycle begin/end must be in the separate rows
+    def self.insert(hash, doc)
+      paragraphs = doc.xpath(PARAGRAPH_XPATH)
+      paragraphs.each do |paragraph|
+        text_nodes = paragraph.xpath(TEXT_NODE_XPATH)
+        text_nodes.each do |text_node|
+          value = text_node.content
+          next unless value[0] == BUX && value[-1] == BUX
+          key = value[1..-2]
+          if key.include? COLON
+            if key.start_with? START
+              key.sub! START, FINISH
+              fin_value = value.sub START, FINISH
+              paragraph, repeat = bound_repeatable_piece(text_node, fin_value)
+              elems_for_repeating = key.sub FINISH, ''
+              if hash[elems_for_repeating] && (hash[elems_for_repeating].kind_of? Enumerable)
+                hash[elems_for_repeating].each do |repeated_elem|
+                  repeat.each do |repeatable_paragraph|
+                    dup_par = repeatable_paragraph.dup
+                    handle_paragraph dup_par, repeated_elem
+                    paragraph.add_next_sibling dup_par
+                    paragraph = dup_par
+                  end
+                end
+              end
+              repeat.each do |par|
+                par.remove
+              end
+              break
+            else
+              vars = key.split COLON
+              obj = hash[vars[0]]
+              text_node.content = if obj.is_a? Hash
+                                    obj[vars[1]]
+                                  else
+                                    begin
+                                      obj.send vars[1]
+                                    rescue NoMethodError => e
+                                      value
+                                    end
+                                  end
+            end
+          else
+            text_node.content = hash[key] || value
+          end
+        end
+      end
+    end
+
+    private
+
+
+    def self.handle_paragraph(paragraph, hash)
+      paragraph.xpath(TEXT_NODE_XPATH).each do |text_node|
+        value = text_node.content
+        next unless value[0] == BUX && value[-1] == BUX
+        key = value[1..-2]
+        if key.include? COLON
+          if key.start_with? EACH
+            key.sub! EACH, ''
+            text_node.content = hash[key] || value
+          end
+        end
+      end
+    end
+
+    def self.bound_repeatable_piece(node, fin_value)
+      # Tag name consists from prefix (usually, 'w') and name (i.e. 'r', 'rPr' and so on)
+      temp_key = paragraph_containing node
+      paragraph = temp_key.next_sibling
+      temp_key.remove
+      #next unless paragraph
+      repeat = []
+      while true
+        result = find_finish paragraph, fin_value
+        #if result.kind_of? Array
+        #  new_children = Nokogiri::XML::NodeSet.new paragraph.document
+        #  result.each do |node|
+        #    new_children.push node
+        #  end
+        #  paragraph.children = new_children
+        #  repeat.push paragraph
+        #  break
+        #end
+        unless result
+          # Move 'paragraph' back and remove ending delimiter
+          temp_key = paragraph
+          paragraph = paragraph.previous_sibling
+          temp_key.remove
+          break
+        end
+        #paragraph.xpath('.//w:t')
+        repeat.push result
+        paragraph = paragraph.next_sibling
+        break unless paragraph
+      end
+      return paragraph, repeat
+    end
+
+    def self.find_finish(node, finish_str)
+
+      # Now think that repeating will be bounded by paragraphs
+
+      return node if node.name.end_with? PR
+      children = []
+      node.children.each do |child|
+        ## Be careful, result = nil in the case, when we found finish_str
+        #result = find_finish child, finish_str
+        #unless result                                                             # '$FINISH:...$' returns nil
+        #  return nil if children.empty?                                           # <w:t>$...$</w:t> returns nil here
+        #  return nil if children.size == 1 && node.name+PR == children.first.name # <w:p><w:pPr>...</w:pPr><w:t>...</w:t> returns nil here
+        #  return children
+        #else
+        #  # If node is returned, then... If array, then...
+        #  if result.kind_of? Nokogiri::XML::Node
+        #    children.push child
+        #  elsif result.kind_of? Array
+        #    new_children = Nokogiri::XML::NodeSet.new child.document
+        #    result.each do |res_node|
+        #      new_children.push res_node
+        #    end
+        #    child.children = new_children
+        #    children.push child
+        #    return children
+        #  end
+        #end
+      end
+
+      # WARNING: It seems, situation exists, when finish_str willn't contain in the children but will be in the node
+      if node.content == finish_str
+        return nil
+      else
+        return node
+      end
+    end
+
+
+    def self.paragraph_containing node
+      return nil unless node.namespace.prefix == W
+      return node if node.name == P
+      while (node = node.parent).name != P
+      end
+      node
+    end
+  end
+end

data/lib/docx/version.rb

@@ -0,0 +1,3 @@
+module Docx
+  VERSION = "0.0.6"
+end

data/lib/example/document.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:document xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" mc:Ignorable="w14 wp14"><w:body><w:p w:rsidR="003E7B44" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t xml:space="preserve">Dear </w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$NAME$</w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>!</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>You want to know my progress, so:</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$REPEAT:ELEMENTS$</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$EACH:INDEX$</w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t xml:space="preserve">. </w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$EACH:NAME$</w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t xml:space="preserve"> - </w:t></w:r><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$EACH:NUMBER$</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$EACH:COMMENTS$</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRPr="00F622F5" w:rsidRDefault="00F622F5" w:rsidP="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>$UNREPEAT:ELEMENTS$</w:t></w:r></w:p><w:p w:rsidR="00F622F5" w:rsidRPr="00F622F5" w:rsidRDefault="00F622F5"><w:pPr><w:rPr><w:lang w:val="en-US"/></w:rPr></w:pPr><w:r><w:rPr><w:lang w:val="en-US"/></w:rPr><w:t>Good luck!</w:t></w:r></w:p><w:sectPr w:rsidR="00F622F5" w:rsidRPr="00F622F5"><w:pgSz w:w="11906" w:h="16838"/><w:pgMar w:top="1134" w:right="850" w:bottom="1134" w:left="1701" w:header="708" w:footer="708" w:gutter="0"/><w:cols w:space="708"/><w:docGrid w:linePitch="360"/></w:sectPr></w:body></w:document>

data/lib/example/example.rb

@@ -0,0 +1,14 @@
+require 'docx'
+
+SRC_FILE = 'template.docx'
+DST_FILE = 'ready.docx'
+
+# Note, in second element 'COMMENTS' is absent. Original stub in template file will be remainded
+hash = {'NAME' => 'Ann', 'ELEMENTS' => [
+    { 'NAME' => 'World history', 'INDEX' => '1','NUMBER' => '3', 'COMMENTS' => "Yeah, I'm so stupid in it"},
+    {'INDEX' => '2', 'NAME' => 'Russian language', 'NUMBER' => '5'}
+]}
+
+w = Docx::DocxHandler.open(SRC_FILE)
+w.insert(hash)
+w.save(DST_FILE)

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: docx-templater
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- DmitryKa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: ! 'PURE RUBY GEM (works on Windows)! Can work with:
+
+  - $SOME_VALUE$;
+
+  - $REPEAT:SOME_COLLECTION$ (at least, new row) $EACH:SOME_VALUE_OF_COLLECTION_ITEM$
+  (at least, new row) $UNREPEAT:SOME_COLLECTION$;
+
+  Repeating commands must be at the separate paragraphs.
+
+  Note, that created template may look good but have bad structure for templater,
+  so you should open docx as a zip archive, open "word/document.xml" and edit it'
+email:
+- mail.of.dima.ka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/docx.rb
+- lib/docx/docx_handler.rb
+- lib/docx/template_handler.rb
+- lib/docx/version.rb
+- lib/example/document.xml
+- lib/example/example.rb
+- lib/example/template.docx
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7
+signing_key: 
+specification_version: 4
+summary: Simple docx templater
+test_files: []