template_docx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e83a00f787254eadc60f298a9a4c0ffa25b5e3cf
+  data.tar.gz: 2df41e4ca1e89b5e8e3db65aa0916c2c73738cba
+SHA512:
+  metadata.gz: 40f9f1eb8bb3c42027c84a07064ac3983803cbfeb605e6a021017442e6bbfbb2c5f7e0f38381a53fdac93c290963072e02ecec1866c453d07fb06345381a570f
+  data.tar.gz: 64d4898ddf60c4076e4ac77fd9e8e5fdabfacf2f3f001d4c64d98a37b22af755a210ea21e5b03529caecd7ead2374cb84615236c9918857a514e0c97ae440a77

data/.gitignore

@@ -0,0 +1,53 @@
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+
+# Ignore IDE
+.idea/
+
+# Ignore bundler config
+.bundle
+
+#mac os
+.DS_Store
+._.DS_Store
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/example_input/tmp
+docx_templater*gem
+Gemfile.lock
+
+# 特定的 docx 文件
+~*.docx
+**/~*.docx
+Template.docx
+Example.docx
+OutputTemplate.docx
+OutputTemplate-*.docx
+ExampleTemplate_RenderedOutput.docx
+
+*.swo
+*.swp
+
+**/*.swo
+**/*.swp
+
+*.gem
+
+# 忽略 rvm gemset 的文件
+.ruby-gemset
+.ruby-version

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,47 @@
+{<img src#"https://travis-ci.org/jawspeak/ruby-docx-templater.png" />}[https://travis-ci.org/jawspeak/ruby-docx-templater]
+
+
+# Roughly, this takes a .docx file and uses it as a template to create a new docx, with your data
+
+## Features
+
+* All manipulation in memory (great if you have sensitive data)
+* Global key/value substitutions by entering a `$KEY$` anywhere in the word document, with whatever formatting you want.
+* Multi-row loops inside tables, also with whatever your formatting you wish. `#BEGIN_ROW:XYZ#`... `#END_ROW:XYZ#` see tests/example
+* Summation formula for row count `#SUM:XYZ_LIST#`
+
+## Usage
+
+* Create your docx "template" in Word
+* Install rvm and bundler
+* Run `bundle install`.
+* Render new docx files from the template, ex: `ruby render_docx_template.rb`. Look for an output_*.docx file.
+* Sample output with tests: `rake spec` (unit tests) `rake integration` (opens word)
+
+__TECHNICAL NOTE:__ You will probably need to extract and edit the xml template manually after creating in Word, to prepare the ruby script template with it. This is very fiddly / hacky. You can’t have Word’s ugly markup around the fields to template. It will try to break up fields with markup. Test the template, fixing it until the extracted word/document.xml as needed.
+
+I frequently use this workflow:
+`rm -rf word/;   unzip ExampleTemplate.docx  word/document.xml;   mate word/document.xml`
+Grep/search for all $ and # lines and ensure no templating is split with xml markup.
+And then re-add the edited document:
+`zip ExampleTemplate.docx word/document.xml`
+
+__PRO TIP:__ You don’t want any grammar errors on the template Keys, or they will not substitute. (Grammar suggestion markup splits up the tokens in the xml). Right click and choose Ignore each grammar error.
+
+[中文文档](https://github.com/Yundianjia/ruby-docx-templater/blob/master/README_cn.md)
+
+
+## Development
+
+* Install any missing dependencies, then run the test suite: `script/ci`
+* Run the integration test suite (on mac, with word installed): `rake integration`
+* Build the gem file: `gem build docx_templater.gemspec`
+
+
+## Future ideas
+
+* We could in the future use Word's MailMerge fields instead of using our own style `$KEY_ABC$` keys. We would then not have to worry about Word munging our text by inserting XML markup in-between parts of a template key #BEGIN_ROW:BLAH#. This is probably a really good idea. Also we would need to delete these other nodes that get added when Fields are added.
+** See also: {http://tomasvarsavsky.com/2009/04/04/simple-word-document-templating-using-ruby-and-xml/} and {https://github.com/bagilevi/docx_builder/tree/master/example/plan_report_template},
+* Possibly, also use Fields to create the looping constructs. That would be a big win for preventing word adding markup between words in by text.
+* Make rendering from the template more efficient.
+* Try templating header/footer (I haven't attempted that yet because I do not have a need for it.)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "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/docx-templater

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'json'
+require 'bundler/setup'
+require 'docx_templater'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: docx-templater [options]"
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+
+  opts.on_tail('-v', '--version', 'Print version') do
+    puts "docx-templater #{DocxTemplater::VERSION}"
+    exit
+  end
+
+  opts.on('-i', '--input-file [file]', 'Default: Example.docx') do |file|
+    puts "input file: #{file}"
+    options[:input_file] = file || 'Example.docx'
+  end
+
+  opts.on('-d', '--format-data [data]', 'Default: data format file, json format') do |data|
+    unless data
+      options[:data] = {
+          company: '伟大的邪王真眼',
+          shop_name: '斜阳西下，三百二十七',
+          shop_id: 122323232323,
+          shop_url: 'http://blog.csdn.net/ruixj/article/details/3765385',
+          master_company: '紫电清爽公司',
+          brand_name: '邪王正眼',
+          start_date: (Time.now - 3600 * 24).strftime('%Y年-%m月-%d日'),
+          end_date: Time.now.strftime('%Y年-%m月-%d日'),
+          license_number: 1212121212,
+          authorized_party: '夏健的夏天',
+          authorized_date: Time.now.strftime('%Y年-%m月-%d日')
+      }
+    else
+      # 可以选择的 YML 文件，或者 json 文件之类格式化的文件，或者直接就是 Ruby 的 Hash 对象
+    end
+  end
+
+  opts.on('-o', '--output-file [file]', 'Default: OutputTemplate.docx') do |file|
+    puts "input file: #{file}"
+
+    options[:output_file] = file || "OutputTemplate-#{Time.now.strftime('%Y-%m-%d')}.docx"
+  end
+end.parse!
+
+DocxTemplater::Command.generate_doc options

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/docx_templater.gemspec

@@ -0,0 +1,37 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'docx_templater/version'
+
+Gem::Specification.new do |s|
+  s.name = 'template_docx'
+  s.version = DocxTemplater::VERSION
+  s.authors = ['Jonathan Andrew Wolter', 'xiajian']
+  s.email = ['jaw@jawspeak.com', 'jhqy2011@gmail.com']
+  s.description = 'A Ruby library to template Microsoft Word .docx files. Uses a .docx file with keyword tags within "$$" as a template. '
+  s.summary = 'Generates new Word .docx files based on a template file.'
+  s.homepage = 'https://github.com/Yundianjia/ruby-docx-templater'
+  s.license  = 'MIT'
+
+  if s.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  s.require_paths = ['lib']
+  root_files = %w(docx_templater.gemspec LICENSE.txt Rakefile README.md .gitignore Gemfile)
+  s.files = Dir['{lib,script,spec,bin}/**/*'] + root_files
+  s.test_files = Dir['spec/**/*']
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'rubyzip', '>= 1.1.1'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler', '~> 1.8'
+  s.add_development_dependency 'rubocop'
+end

data/lib/docx_templater.rb

@@ -0,0 +1,24 @@
+require 'docx_templater/version'
+require 'docx_templater/template_processor'
+
+module DocxTemplater
+  module_function
+
+  def log(str)
+    # braindead logging
+    puts str if ENV['DEBUG']
+  end
+
+  def open_output_file(output_file)
+    puts "\n************************************"
+    puts '   >>> Only will work on mac <<<'
+    puts 'NOW attempting to open created file in Word.'
+    cmd = "open #{output_file}"
+    puts "  will run '#{cmd}'"
+    puts '************************************'
+
+    system cmd
+  end
+end
+
+Gem.find_files('docx_templater/*.rb').each { |path| require path }