template_docx 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e83a00f787254eadc60f298a9a4c0ffa25b5e3cf
-  data.tar.gz: 2df41e4ca1e89b5e8e3db65aa0916c2c73738cba
+  metadata.gz: 659fd10b37a237160b5030a416a992af4df658fd
+  data.tar.gz: 9f3dc09be8c5c2304b7df86de79232f1abb8d856
 SHA512:
-  metadata.gz: 40f9f1eb8bb3c42027c84a07064ac3983803cbfeb605e6a021017442e6bbfbb2c5f7e0f38381a53fdac93c290963072e02ecec1866c453d07fb06345381a570f
-  data.tar.gz: 64d4898ddf60c4076e4ac77fd9e8e5fdabfacf2f3f001d4c64d98a37b22af755a210ea21e5b03529caecd7ead2374cb84615236c9918857a514e0c97ae440a77
+  metadata.gz: bdefb2005499f76a403312f742e15b0348c2a91e0a7bebdba4aab07233950ac6d8e15247f0317ffc67978a0a64935b10b0ef4f33c28a0f37ff4577b9523916e0
+  data.tar.gz: a676e275f69ec389615d89e7f44f84b080c825553e03d6f7eda906376307e14a559796219dcb25c4b092fab2f07bef2543c3c678148f7906126b6869883f6463

data/README.md

@@ -1,17 +1,74 @@
-{<img src#"https://travis-ci.org/jawspeak/ruby-docx-templater.png" />}[https://travis-ci.org/jawspeak/ruby-docx-templater]
+<img src="https://travis-ci.org/jawspeak/ruby-docx-templater.png" /> [https://travis-ci.org/jawspeak/ruby-docx-templater]
 
+[!](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
+# ruby-docx-templater 
 
-## Features
+Roughly, this takes a .docx file and uses it as a template to create a new docx, with your data
 
-* 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#`
+## Installation
+   
+Add this line to your application's Gemfile:
+
+
+```ruby
+gem 'template_docx'
+```
+
+Or, 
+
+```ruby
+
+```
+
+And then execute:
+
+   $ bundle
+
+Or install it yourself as:
+
+   $ gem install aliexpress
 
 ## Usage
 
+
+Command Line: 
+
+```
+Usage: docx-templater [options]
+    -i, --input-file [file]          Default: Example.docx
+    -d, --format-data [data]         Default: data format file, json format - Not Implementation, No Used!!
+    -o, --output-file [file]         Default: OutputTemplate.docx
+    -h, --help                       Show this message
+    -v, --version                    Print version
+```
+
+Program: 
+
+```
+options = {
+  input_file: 'spec/example_input/ExampleBrand.docx'
+  output_file: 'OutputTemplate.docx',
+  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日') 
+  }
+}
+
+DocxTemplater.template_docx options
+```
+
+### operatation flow
+
 * Create your docx "template" in Word
 * Install rvm and bundler
 * Run `bundle install`.
@@ -37,6 +94,13 @@ __PRO TIP:__ You don’t want any grammar errors on the template Keys, or they w
 * Run the integration test suite (on mac, with word installed): `rake integration`
 * Build the gem file: `gem build docx_templater.gemspec`
 
+## 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#`
+
 
 ## Future ideas
 
@@ -44,4 +108,4 @@ __PRO TIP:__ You don’t want any grammar errors on the template Keys, or they w
 ** 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.)
+* Try templating header/footer (I haven't attempted that yet because I do not have a need for it.)

data/lib/docx_templater/command.rb

@@ -21,14 +21,7 @@ module DocxTemplater
     end
 
     def self.generate_doc(options = {})
-      puts "options: #{options}"
-
-      DocxTemplater::DocxCreator.new(options[:input_file], options[:data]).generate_docx_file(options[:output_file])
-
-      archive = Zip::File.open(options[:output_file])
-      archive.close
-
-      DocxTemplater.open_output_file options[:output_file]
+      DocxTemplater.template_docx options
     end
 
     protected

data/lib/docx_templater/version.rb

@@ -1,3 +1,3 @@
 module DocxTemplater
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/docx_templater.rb

@@ -1,5 +1,6 @@
 require 'docx_templater/version'
 require 'docx_templater/template_processor'
+require 'docx_templater/docx_creator'
 
 module DocxTemplater
   module_function
@@ -9,6 +10,29 @@ module DocxTemplater
     puts str if ENV['DEBUG']
   end
 
+  # template docx file
+  #
+  # @param {Hash} options -
+  #
+  # @example
+  #   options = {
+  #     input_file: 'xxx',
+  #     output_file: 'xxx',
+  #     data: { key: value }
+  #   }
+  def template_docx(options = {})
+    puts "options: #{options}"
+
+    DocxTemplater::DocxCreator.new(options[:input_file], options[:data]).generate_docx_file(options[:output_file])
+
+    archive = Zip::File.open(options[:output_file])
+    archive.close
+
+    DocxTemplater.open_output_file options[:output_file]
+  end
+
+
+  # Open word file in mac os(with word installed)
   def open_output_file(output_file)
     puts "\n************************************"
     puts '   >>> Only will work on mac <<<'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: template_docx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonathan Andrew Wolter