openxml_docx_templater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e44105a83cceb34f68989e87a812785660a1cb8
+  data.tar.gz: 738f88c71f5788ec30ce40e0cad79f1ca50492fa
+SHA512:
+  metadata.gz: 4d1b6eee10f00beea595e90ea4785435abb4ab304cdb3c6be0cf11ebbf4716242bcad8dbbe06a2d4c838e5b0dfceb55ba43d6f6a852b776a94b426c2909c889d
+  data.tar.gz: bbab5dd250bec7ee756aeee9c63fbe9255892e88cfc32dad3bdfbbe484c79637b5a30095be9bff4efbdab2daca368707cdbd89e98abec1fac6e08ccedc50dbca

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Ageev
+
+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,80 @@
+# OpenxmlDocxTemplater
+
+OpenxmlDocxTempleter allows you to embed ruby code in MS Office documents (.docx files). You provide .docx template with ruby code, inside a special markup, and the data. In this way gem generates the document. It must be familiar to you, if you know erb!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openxml_docx_templater'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openxml_docx_templater
+
+## Usage
+
+OpenxmlDocxTemplater is the best to demonstrate with an example.
+At the picture shown below, you can see the MS Word template with ruby code (this template, the output file, and the sample script can be found in [examples directory](https://github.com/AgeevAndrew/openxml_docx_templater/tree/master/examples)).
+
+![Template](https://github.com/AgeevAndrew/openxml_docx_templater/tree/master/examples/images/template.PNG?raw=true)
+
+This image is a screenshot of example_template.docx from the [examples directory](https://github.com/AgeevAndrew/openxml_docx_templater/tree/master/examples). It is a regular Microsoft Office document with ruby code, embedded inside a special markup. That ruby code drives the document creation. You can use conditions, loops, blocks — in fact, the whole ruby language. And you can apply any MS Office formatting to the outputted variables or static text.
+
+The second line in the template is `{%= @title1 %}`. That means output the value of variable `title1`. This variable will be replaced in the generated document, but it will still be bold.
+
+You can take that template, provide the data and generate the final document:
+
+    require 'openxml_docx_templater'
+
+    class Example
+      include OpenxmlDocxTemplater::Generator
+
+      Brand = Struct.new(:name, :models)
+      Model = Struct.new(:name, :description, :cost)
+
+      def generate
+        @is_usa = true
+        @title1 = "Price"
+        @title2 = "Прайс"
+
+        lg_models = [Model.new('Google Nexus 5x', 'LG Nexus 5x was released in November 2015.', '$550'),
+          Model.new('Google Nexus 5', 'LG Nexus 5 was released in November 2013.', '$350'),
+          Model.new('Google Nexus 6p', 'LG nexus 6p was released in November 2015.', '$750'),
+          ]
+        lg = Brand.new("LG", lg_models)
+
+        iphone_models = [Model.new('iPhone 6+', 'iPhone 6+ was released in September 2014.', '$1000'),
+          Model.new('iPhone 6', 'iPhone 6 was released in September 2014.', '$700')]
+        iphone = Brand.new("iPhone", iphone_models)
+
+        @brands = [lg, iphone]
+
+        render_msword 'example_template.docx'
+      end
+    end
+
+The key parts are `include OpenxmlDocxTemplater::Generator` and `render_msword`. The data for the template must be provided as instance variables.
+
+Following picture shows the generated document. It is a screenshot of the example_template_output.docx document from the [examples directory](https://github.com/AgeevAndrew/openxml_docx_templater/tree/master/examples).
+
+![Document](https://github.com/AgeevAndrew/openxml_docx_templater/tree/master/examples/images/output.PNG?raw=true)
+
+## 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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openxml_docx_templater"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/example.rb

@@ -0,0 +1,33 @@
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'openxml_docx_templater'
+
+class Example
+  include OpenxmlDocxTemplater::Generator
+
+  Brand = Struct.new(:name, :models)
+  Model = Struct.new(:name, :description, :cost)
+
+  def generate
+    @is_usa = true
+    @title1 = "Price"
+    @title2 = "Прайс"
+
+    lg_models = [Model.new('Google Nexus 5x', 'LG Nexus 5x was released in November 2015.', '$550'),
+      Model.new('Google Nexus 5', 'LG Nexus 5 was released in November 2013.', '$350'),
+      Model.new('Google Nexus 6p', 'LG nexus 6p was released in November 2015.', '$750'),
+      ]
+    lg = Brand.new("LG", lg_models)
+
+    iphone_models = [Model.new('iPhone 6+', 'iPhone 6+ was released in September 2014.', '$1000'),
+      Model.new('iPhone 6', 'iPhone 6 was released in September 2014.', '$700')]
+    iphone = Brand.new("iPhone", iphone_models)
+
+    @brands = [lg, iphone]
+
+    render_msword 'example_template.docx'
+  end
+end
+
+example = Example.new
+example.generate

data/lib/openxml_docx_templater.rb

@@ -0,0 +1,13 @@
+require "openxml_docx_templater/version"
+require "openxml_docx_templater/debug"
+require "openxml_docx_templater/node_type"
+require "openxml_docx_templater/escape_xml"
+require "openxml_docx_templater/line"
+require "openxml_docx_templater/xml_reader"
+require "openxml_docx_templater/docx_eruby"
+require "openxml_docx_templater/template"
+require "openxml_docx_templater/generator"
+
+module OpenxmlDocxTemplater
+  # Your code goes here...
+end

data/lib/openxml_docx_templater/debug.rb

@@ -0,0 +1,19 @@
+module OpenxmlDocxTemplater
+  module Debug
+    def debug?
+      false
+    end
+
+    def debug_file_path
+      File.join(debug_dir, debug_file_name)
+    end
+
+    def debug_file_name
+      "serenity_debug_#{rand(100)}.rb"
+    end
+
+    def debug_dir
+      File.join(File.dirname(__FILE__), '..', '..', 'debug')
+    end
+  end
+end

data/lib/openxml_docx_templater/docx_eruby.rb

@@ -0,0 +1,90 @@
+module OpenxmlDocxTemplater
+  class DocxEruby
+    include Debug
+
+    EMBEDDED_PATTERN = /\{%([=%]+)?(.*?)-?%\}/m
+
+    def initialize template
+      @src = convert template
+      if debug?
+        File.open(debug_file_path, 'w') do |f|
+          f << @src
+        end
+      end
+    end
+
+    def evaluate context
+      eval(@src, context)
+    end
+
+    private
+
+    def convert template
+      src = "_buf = '';"
+      buffer = []
+      buffer_next = []
+
+      template.each_node do |node, type|
+        if !buffer_next.empty?
+          if is_matching_pair?(buffer.last, node)
+            buffer.pop
+            next
+          elsif is_nonpair_tag? node
+            next
+          else
+            buffer << buffer_next
+            buffer.flatten!
+            buffer_next = []
+          end
+        end
+
+        if type == NodeType::CONTROL
+          buffer_next = process_instruction(node)
+        else
+          buffer << process_instruction(node)
+          buffer.flatten!
+        end
+      end
+
+      buffer.each { |line| src << line.to_buf }
+      src << "\n_buf.to_s\n"
+    end
+
+    def process_instruction text
+      #text = text.strip
+      pos = 0
+      src = []
+
+      text.scan(EMBEDDED_PATTERN) do |indicator, code|
+        m = Regexp.last_match
+        middle = text[pos...m.begin(0)]
+        pos  = m.end(0)
+        src << Line.text(middle) unless middle.empty?
+
+        if !indicator            # <% %>
+          src << Line.code(code)
+        elsif indicator == '='   # <%= %>
+          src << Line.string(code)
+        elsif indicator == '%'   # <%% %>
+          src << Line.literal(code)
+        end
+      end
+
+      rest = pos == 0 ? text : text[pos..-1]
+
+      src << Line.text(rest) unless rest.nil? or rest.empty?
+      src
+    end
+
+    def is_nonpair_tag? tag
+      tag =~ /<.+?\/>/
+    end
+
+    def is_matching_pair? open, close
+      open = open.to_s.strip
+      close = close.to_s.strip
+
+      close == "</#{open[1, close.length - 3]}>"
+    end
+  end
+end

data/lib/openxml_docx_templater/escape_xml.rb

@@ -0,0 +1,26 @@
+class String
+
+  CODE_LINE_PATTERN = /{(.*?)%(.+?)%(.*?)}/
+  TAG_PATTERN = /<(.+?)>[\n]?/m
+
+  def escape_xml
+    mgsub!([[/&/, '&amp;'], [/</, '&lt;'], [/>/, '&gt;']])
+  end
+
+  def convert_newlines
+    gsub!("\n", '<w:br/>')
+    self
+  end
+
+  def refact
+    gsub(CODE_LINE_PATTERN) { |result| result.gsub(TAG_PATTERN, "") }
+  end
+
+  def mgsub!(key_value_pairs=[].freeze)
+    regexp_fragments = key_value_pairs.collect { |k, v| k }
+    gsub!(Regexp.union(*regexp_fragments)) do |match|
+      key_value_pairs.detect { |k, v| k =~ match }[1]
+    end
+    self
+  end
+end

data/lib/openxml_docx_templater/generator.rb

@@ -0,0 +1,18 @@
+module OpenxmlDocxTemplater
+  module Generator
+    def render_msword template_path, output_path = output_name(template_path)
+      template = Template.new template_path, output_path
+      template.process binding
+    end
+
+    private
+
+    def output_name input
+      if input =~ /(.+)\.docx\Z/
+        "#{$1}_output.docx"
+      else
+        "#{input}_output.docx"
+      end
+    end
+  end
+end

data/lib/openxml_docx_templater/line.rb

@@ -0,0 +1,68 @@
+module OpenxmlDocxTemplater
+  class Line
+    attr_reader :text
+
+    def initialize text
+      @text = text
+    end
+
+    def to_s
+      @text
+    end
+
+    def self.text txt
+      TextLine.new txt
+    end
+
+    def self.code txt
+      CodeLine.new txt
+    end
+
+    def self.string txt
+      StringLine.new txt
+    end
+
+    def self.literal txt
+      LiteralLine.new txt
+    end
+
+  end
+
+  class TextLine < Line
+    def to_buf
+      " _buf << '" << escape_text(@text) << "';"
+    end
+
+    def escape_text text
+      text.gsub(/['\\]/, '\\\\\&')
+    end
+  end
+
+  class CodeLine < Line
+    def to_buf
+      escape_code(@text) << ';'
+    end
+
+    def escape_code code
+      code.mgsub! [[/&apos;/, "'"], [/&gt;/, '>'], [/&lt/, '<'], [/&quot;/, '"'], [/&amp;/, '&']]
+    end
+  end
+
+  class StringLine < CodeLine
+    def to_buf
+      " _buf << (" << escape_code(@text) << ").to_s.escape_xml.convert_newlines;"
+    end
+
+    def convert_newlines text
+      text.gsub("First line", '<w:br/>')
+    end
+  end
+
+  class LiteralLine < CodeLine
+    def to_buf
+      " _buf << (" << escape_code(@text) << ").to_s;"
+    end
+  end
+
+end
+

data/lib/openxml_docx_templater/node_type.rb

@@ -0,0 +1,7 @@
+module OpenxmlDocxTemplater
+  class NodeType
+    TAG = 1
+    CONTROL = 2
+    TEMPLATE = 3
+  end
+end

data/lib/openxml_docx_templater/template.rb

@@ -0,0 +1,31 @@
+require 'zip'
+require 'fileutils'
+
+module OpenxmlDocxTemplater
+  class Template
+    attr_accessor :template
+
+    def initialize(template, output)
+      FileUtils.cp(template, output)
+      @template = output
+    end
+
+    def process context
+      tmpfiles = []
+      Zip::File.open(@template) do |zipfile|
+        %w(word/document.xml word/styles.xml).each do |xml_file|
+          content = zipfile.read(xml_file).refact
+
+          docxeruby = DocxEruby.new(XmlReader.new(content))
+          out = docxeruby.evaluate(context)
+
+          tmpfiles << (file = Tempfile.new("openxml_template"))
+          file << out
+          file.close
+
+          zipfile.replace(xml_file, file.path)
+        end
+      end
+    end
+  end
+end

data/lib/openxml_docx_templater/version.rb

@@ -0,0 +1,3 @@
+module OpenxmlDocxTemplater
+  VERSION = "0.1.0"
+end

data/lib/openxml_docx_templater/xml_reader.rb

@@ -0,0 +1,31 @@
+module OpenxmlDocxTemplater
+  class XmlReader
+
+    def initialize src
+      @src = src
+    end
+
+    def each_node
+      last_match_pos = 0
+
+      @src.scan(/<.*?>/) do |node|
+        m = Regexp.last_match
+        if m.begin(0) > last_match_pos
+          text = @src[last_match_pos...m.begin(0)]
+          yield text, node_type(text) if text.gsub(/\s+/, '') != ''
+        end
+
+        last_match_pos = m.end(0)
+        yield node, NodeType::TAG
+      end
+    end
+
+    def node_type text
+      if text =~ /\s*\{%[^=#].+?%\}\s*/
+        NodeType::CONTROL
+      else
+        NodeType::TEMPLATE
+      end
+    end
+  end
+end

data/openxml_docx_templater.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openxml_docx_templater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openxml_docx_templater"
+  spec.version       = OpenxmlDocxTemplater::VERSION
+  spec.authors       = ["Andrew Ageev"]
+  spec.email         = ["ageev86@gmail.com"]
+
+  spec.summary       = %q{Simple creation .docx files by templates}
+  spec.description   = %q{Simple creation .docx files by templates}
+  spec.homepage      = "https://github.com/AgeevAndrew/openxml_docx_templater"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'rubyzip'
+
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: openxml_docx_templater
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Ageev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Simple creation .docx files by templates
+email:
+- ageev86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/example.rb
+- examples/example_template.docx
+- examples/example_template_output.docx
+- examples/images/output.PNG
+- examples/images/template.PNG
+- lib/openxml_docx_templater.rb
+- lib/openxml_docx_templater/debug.rb
+- lib/openxml_docx_templater/docx_eruby.rb
+- lib/openxml_docx_templater/escape_xml.rb
+- lib/openxml_docx_templater/generator.rb
+- lib/openxml_docx_templater/line.rb
+- lib/openxml_docx_templater/node_type.rb
+- lib/openxml_docx_templater/template.rb
+- lib/openxml_docx_templater/version.rb
+- lib/openxml_docx_templater/xml_reader.rb
+- openxml_docx_templater.gemspec
+homepage: https://github.com/AgeevAndrew/openxml_docx_templater
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple creation .docx files by templates
+test_files: []