docx-cloner 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTM4MjRmN2JhOTQ2YzNlZGY2NzJiYjM4ZWRiOGJjODk5ZTExYzE1MA==
+    OTc0OTQ0ZjIzMTFkNDAzZGU2ODUwZmM3MWM2ZDNlMjQyYTZlNTkwNw==
   data.tar.gz: !binary |-
-    MGVhNzYxYmNjZTQxYTYyNzhhNzVkMDgyOTcxNDVjMjI1NWY3NTZmMA==
+    NDM0MjBmNTg4ZWUzZGVjNWNkNGI4OWYwNjIxODQ1MmY5Y2VmYWRkZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTNmNDI5NWJhYTc2YjAzZDU2Njc1ZDQ0MDdjNjg4ODNjYTIyYzI2YmIxYjZi
-    ZjM0YTBhYjI0NjQyYzhhMGM2OTEyMWVlYmFjMGU2NDczNGI4MGVlY2Q5OTdj
-    OGY2MjE0OTZmMjlmNTZmZDc2YmEwMmY4MWFkYTY3NWNiODkxODU=
+    OTY5ODY1Y2Y4ZDYwZDA0NzY5Zjg0NmQ5YzU2Zjk0Mjg3MTA5OGYzNmI3ZDVj
+    ZGUzM2Q0YzM1YzkxMDllMzg3MTFhYzRhZGVjYzU4Y2UzMmE4OWEyNDk2ZjIz
+    MjI5N2JiOTBhMWIxMDZkZWM5YWFhZWMyYWM5ZDNkZDM4ODE3ZGE=
   data.tar.gz: !binary |-
-    YWI4M2NiNDBlNDc1NGI2MmY1YzNkYmNlZTkyNzU4MTI2MjkxNDg2ZTI2OTQy
-    N2JmZTA1YjQzNmJiOTE3MGU1ZDExMWJkZjNkOWQ3YWI5MzIyMTJlOGYxYjg0
-    MTVjNTc3NDVlNzM4Njc0NDNiNTI4NTgxZWI2OGM3MDc0ZWYzOTE=
+    ZDQxYmQ0MTY5MWZhMDY3YjAzZGE3OWM5ODdlZDc0YWE2ZmE3ZTg2NzBkNTBh
+    ZmY2YzA2MzVkMWVjZjk3MTA0NTViY2E5MzZmNDE4YmFkMzIzZTcyZDUzNzQ0
+    NWU2OTA1MTljNDJjMDE1NWRiZjAxYWQ0N2U4MTYwYzAxNmYwMTQ=

data/README.md

@@ -17,22 +17,29 @@ Or install it yourself as:
     $ gem install docx-cloner
 
 ## Usage
-    #encoding: utf-8
-    require 'docx/cloner'
-
-    sourc_file = 'source.docx'
-    dest_file = 'dest.docx'
-    docx = Docx::Cloner::DocxTool.new sourc_file
-
-    docx.set_single_tag '{Name}', '周大福'
+* docx_cloner
+* set_text
+* set_row_tr
 
-    table_title = ["{名称1}", "{00.01}"]
-    table_data = [["自行车1", "125.00"], ["大卡车1", "256500.00"]]
-    docx.set_row_tags table_title, table_data, 'tr'
-
-    docx.save dest_file
-    docx.release
+    it's so easy to use it with DSL:
 
+    #encoding: utf-8
+    require 'docx/dsl'
+
+    class C
+      include Docx::DSL
+
+      def my_method
+        #template is 'source.docx' and save to 'dest.docx'
+        docx_cloner 'source.docx', 'dest.docx' do
+          #replace the text of '{Name}' in 'source.docx'
+          set_text '{Name}', '周大福'
+          #multi lines replace
+          set_row_tr ["{名称1}", "{00.01}"], [["自行车1", "125.00"], ["大卡车1", "256500.00"]]
+          end
+        end
+      end
+    end
 
 ## Contributing
 

data/docx-examples/test.rb

@@ -1,15 +1,28 @@
 #encoding: utf-8
-require 'docx/cloner'
+require 'docx/dsl'
 
+<<-ABC
 sourc_file = 'source.docx'
 dest_file = 'dest.docx'
 docx = Docx::Cloner::DocxTool.new sourc_file
 
-docx.set_single_tag '{Name}', '周大福'
+docx.set_text_tag '{Name}', '周大福'
 
 table_title = ["{名称1}", "{00.01}"]
 table_data = [["自行车1", "125.00"], ["大卡车1", "256500.00"]]
 docx.set_row_tags table_title, table_data, 'tr'
 
 docx.save dest_file
-docx.release
+docx.release
+
+ABC
+##################
+
+extend Docx::DSL
+docx_cloner 'source.docx', 'dest.docx' do
+  set_text '{Name}', '周大福'
+  set_row 'tr' do |t|
+    t[:tags] = ["{名称1}", "{00.01}"]
+    t[:data] = [["自行车1", "125.00"], ["大卡车1", "256500.00"]]
+  end
+end

data/features/dsl.feature

@@ -0,0 +1,59 @@
+#language: zh-CN
+
+功能: 支持DSL用法
+  允许在ruby代码中使用类似的DSL语法来指定docx标签替换操作：
+  """
+  extend 'Docx::DSL'
+  docx_cloner 'source.docx', 'dest.docx' do
+    set_text '{Name}', '周大福'
+    set_row 'tr' do |t|
+      t[:tags] = ["{名称1}", "{00.01}"]
+      t[:data] = [["自行车1", "125.00"], ["大卡车1", "256500.00"]]
+    end
+  end
+  """
+  其中：
+  1、需要用include或extend包含 'Docx::DSL'
+  2、docx_cloner，是指定过程容器，'source_docx'是模板文件，'dest.docx'是要保存的目标文件。
+  3、set_text，可以将独立的文字标签替换，如'{Name}'替换为'周大福'
+  4、set_row，可以按照一行内的标签模板，根据指定数据集生成多行文字，t[:tags]为标签数组，t[:data]为被替换的二维数组
+
+  背景: 被替换的源文件
+    假如"docx-examples"示例文件夹中存在一个"source.docx"的文件
+    而且"docx-examples/dest.docx"这个目标文件已经被清除
+    而且要求使用DSL语法
+
+  
+  场景大纲: 1、使用DSL，简单替换单个文字标签
+    这是最简单的情形，例如将标签{name}，替换为真正的姓名。
+
+    假如程序使用DSL语法将目标文件中的"<tagname>"替换为"<value>"
+    那么应该生成目标文件
+    而且被目标文件中应该包含"<value>"这个标签词
+
+    例子: 替换单个标签的几种情况
+
+      | tagname | value |
+      | {name}  | 周大福 |
+      | {Name}  | 周大福 |
+      | {NAME}  | 周大福 |
+      | {{名字}} | 周大福 |
+      | $名字$   | 周大福 |    
+
+  @wip
+  场景: 2、使用DSL，替换表格行数据
+    按行数据替换表格内容是常见的应用
+
+    假如有这样一组数据：
+      | {名称1} | {00.01}   |
+      | 自行车  | 256.00    |
+      | 小汽车  | 125600.00 |
+      | 大卡车  | 256000.00 |
+      | 电视机  | 6999.00   |
+      | 洗衣机  | 3488.00   |
+
+    当程序使用DSL，将表中第1行作为标签名，第2行以后作为行数据替换
+    那么应该生成目标文件
+    而且被目标文件中应该包含被替换的第2行以后的数据
+
+

data/features/read.feature

@@ -26,7 +26,6 @@
       | {{名字}} |
       | $名字$   |
 
-  @wip
   场景大纲: 读取表格行替换标签
     这通常是在表格上追加行所使用的
 

data/features/replace.feature

@@ -46,7 +46,6 @@
     那么应该生成目标文件
     而且被目标文件中应该包含被替换的第2列数据
 
-  @wip
   场景: 3、替换表格行数据
     按行数据替换表格内容是常见的应用
 

data/features/steps_define/steps.rb

@@ -1,7 +1,10 @@
 #encoding: utf-8
 lib = File.expand_path('../../../lib', __FILE__)
+puts lib
 require "#{lib}/docx/cloner"
 #require 'fileutils'
+require "#{lib}/docx/dsl"
+
 
 假如(/^"(.*?)"示例文件夹中存在一个"(.*?)"的文件$/) do |folder, file|
   @source_filename = File.expand_path "#{folder}/#{file}"
@@ -11,7 +14,7 @@ end
 
 那么(/^程序应该能读到"(.*?)"这个标签词$/) do |tag_name|
   docx = Docx::Cloner::DocxTool.new @source_filename
-  result = docx.include_single_tag? tag_name
+  result = docx.include_text_tag? tag_name
   docx.release
   result.should be_true
 end
@@ -25,7 +28,7 @@ end
 
 假如(/^程序将目标文件中的"(.*?)"替换为"(.*?)"$/) do |tag, value|
   docx = Docx::Cloner::DocxTool.new @source_filename
-  result = docx.set_single_tag tag, value
+  result = docx.set_text_tag tag, value
   docx.save @dest_filename
   docx.release
   result.should be_true
@@ -37,7 +40,7 @@ end
 
 而且(/^被目标文件中应该包含"(.*?)"这个标签词$/) do |value|
   docx = Docx::Cloner::DocxTool.new @dest_filename
-  result = docx.include_single_tag? value
+  result = docx.include_text_tag? value
   docx.release
   result.should be_true
 end
@@ -50,7 +53,7 @@ end
   result = true
   docx = Docx::Cloner::DocxTool.new @source_filename
   @data.each do |row|
-    result &= docx.set_single_tag row[0], row[1]
+    result &= docx.set_text_tag row[0], row[1]
   end
   docx.save @dest_filename
   docx.release
@@ -61,7 +64,7 @@ end
   result = true
   docx = Docx::Cloner::DocxTool.new @dest_filename
   @data.each do |row|
-    result &= docx.include_single_tag? row[1]
+    result &= docx.include_text_tag? row[1]
   end
   docx.release
   result.should be_true
@@ -84,9 +87,30 @@ end
   docx = Docx::Cloner::DocxTool.new @dest_filename
   @data[1..-1].each do |row|
     row.each do |value|
-      result &= docx.include_single_tag? value
+      result &= docx.include_text_tag? value
     end
   end
   docx.release
   result.should be_true
+end
+
+假如(/^要求使用DSL语法$/) do
+  
+end
+
+假如(/^程序使用DSL语法将目标文件中的"(.*?)"替换为"(.*?)"$/) do |tag, value|
+  #定义一个DSL的执行环境
+  extend Docx::DSL
+  docx_cloner @source_filename, @dest_filename do
+    set_text tag, value
+  end
+end
+
+当(/^程序使用DSL，将表中第1行作为标签名，第2行以后作为行数据替换$/) do
+  #定义一个DSL的执行环境
+  extend Docx::DSL
+  docx_cloner @source_filename, @dest_filename do
+    #set_row  @data.first, @data[1..-1], 'tr'
+    set_row_tr @data.first, @data[1..-1]
+  end
 end

data/lib/docx/cloner.rb

@@ -40,7 +40,7 @@ module Docx
       end
 
       
-      def include_single_tag?(tag)
+      def include_text_tag?(tag)
         @global_paragraph.each do |p|
           if p[:text_content].include? tag
             return true
@@ -49,7 +49,7 @@ module Docx
         return false
       end
 
-      def read_single_tag_xml(tag)
+      def read_text_tag_xml(tag)
         @global_paragraph.each do |p|
           if p[:text_content].include? tag
             from = p[:text_content].index tag
@@ -75,7 +75,7 @@ module Docx
       end
 
       #替换单个标签为指定值
-      def set_single_tag tag, value
+      def set_text_tag tag, value
         replace_tag tag, value
       end
 

data/lib/docx/cloner/version.rb

@@ -1,5 +1,5 @@
 module Docx
   module Cloner
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/docx/dsl.rb

@@ -0,0 +1,42 @@
+#encoding: utf-8
+require 'docx/cloner'
+
+module Docx
+  module DSL
+    lambda{
+      docx = nil
+      define_method :set_text do |tag, value|
+        #puts "#set_text: #{tag}, #{value}"
+        docx.set_text_tag tag, value
+      end
+
+      define_method :set_row do |tags, data, type|
+        #puts "#set_row_#{type}"
+        #puts "tags: #{tags}"
+        #puts "data: #{data}"
+        docx.set_row_tags tags, data, type
+      end
+
+      define_method :docx_cloner do |source, dest, &b|
+        docx = Docx::Cloner::DocxTool.new source
+        #return unless block_given?
+        #puts 'start dsl'
+        b.call self
+        #puts 'end dsl'
+
+        docx.save dest
+        docx.release
+      end
+    }.call
+
+    def method_missing name, *args
+      puts "name: #{name}"
+      puts "args: #{args}"
+      /set_row_(.+)/.match name do
+        return set_row *(args << $1) if $1
+      end
+      super
+    end
+
+  end
+end

data/spec/cloner_spec.rb

@@ -10,18 +10,18 @@ module Docx
         end
         context "#include_single_tag?" do
           it "读取'$名字$'标签" do
-            result = @docx.include_single_tag? "$名字$"
+            result = @docx.include_text_tag? "$名字$"
             result.should be_true
           end
           it "读取'{Name}'标签" do
-            result = @docx.include_single_tag? "{Name}"
+            result = @docx.include_text_tag? "{Name}"
             result.should be_true
           end
         end
 
         context "#read_single_tags_xml" do
           it "读取'{name}'的xml标签'<w:r>'，应该是" do
-            result = @docx.read_single_tag_xml "{name}"
+            result = @docx.read_text_tag_xml "{name}"
             result.should  == <<-HERE
 <w:r w:rsidR="000F595B">
   <w:rPr>
@@ -65,11 +65,11 @@ module Docx
         context "#set_single_tag" do
           it "设置单个标签{Name}" do
             value = '周大福'
-            @source_docx.set_single_tag '{Name}', value
+            @source_docx.set_text_tag '{Name}', value
             @source_docx.save @dest_file
 
             dest = DocxTool.new @dest_file
-            result = dest.include_single_tag? value
+            result = dest.include_text_tag? value
             dest.release
             result.should be_true
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docx-cloner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - homeway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,11 +57,13 @@ files:
 - docx-examples/source.docx
 - docx-examples/test.rb
 - docx-examples/wp.xml
+- features/dsl.feature
 - features/read.feature
 - features/replace.feature
 - features/steps_define/steps.rb
 - lib/docx/cloner.rb
 - lib/docx/cloner/version.rb
+- lib/docx/dsl.rb
 - spec/cloner_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -89,6 +91,7 @@ signing_key:
 specification_version: 4
 summary: generate docx file with tags
 test_files:
+- features/dsl.feature
 - features/read.feature
 - features/replace.feature
 - features/steps_define/steps.rb