rubyword 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a411b43cd5b8e055aa0d391332d91e29b5a9eb
-  data.tar.gz: 3253a4e9f289ba99b9e62a0ab73b1cb43c223d58
+  metadata.gz: 4211931a53c84371b34bd29570a365bb1c9606bd
+  data.tar.gz: bbfecc910bb93c23ddd4e8403c24820da0cd1689
 SHA512:
-  metadata.gz: d67230b2cb422a7a5631c9844a1fa44b77a0739b683dfcecd86b9e090989ade5d625d7dfb8a1d17aef10c9a8290a59799a95fd092507b0bd40554aea31a28557
-  data.tar.gz: 82ebc3d3424424abc1293896448472dc53d76f41fbbb921e6eeb158793172c017992458c07819c011674d29737e4f7dff8e78c115c3181379a79bd9f389778b1
+  metadata.gz: 2d86f0449340b3274d3cc4844fb58b5205d0d55297a0fd62ecc6efe588c4ac8f5c3e7d9e1a67d3c736b4ec15851ab147e91106836f24ea3e63151fb3e185f79f
+  data.tar.gz: 63b6215169ff3ba6012189728d188ea1bbdd1552b48b479f4db467dab3d7fb3ce0b7f0e304b52167cf7fdb8e7310618b2e45850bd5203f82b351a4b063665f15

data/.gitignore

@@ -4,7 +4,6 @@
 .config
 .yardoc
 Gemfile.lock
-temp
-sample/*
+example/*.docx
 .idea/*
 .vscode

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# CHANGELOG
+
+# Version 1.1.0 - 2017-11-02
++ add paragraph feature
++ add table feature
+```
+section {
+  text 'hello'
+  p(text_align: 'center') {
+    text 'i am '
+    text 'a boy'
+  }
+  text 'welcome to my home..'
+
+  p {
+    text 'This is a '
+    text 'apple, yellow apple', bgcolor: 'yellow', text_align: 'center'
+  }
+
+  table {
+    tr {
+      th 'id'
+      th 'name'
+      th 'age'
+    }
+    tr {
+      th '1'
+      th 'young'
+      th '66'
+    }
+  }
+}
+```
+
+# Version 1.0.0 - 2017-10-21
+
++ Support for setting the properties of the document, such as: title, subject, author and other information
++ Support for generated TOC for the title
++ Support for setting header and footer
++ Support for insert title which is different attributes, such as: title, sub title, etc.
++ Support for insert blank lines and blank page
++ Support for insert multiple images 
++ Support for insert multiple lists 
++ Support for insert hyperlink 

data/README.cn.md

@@ -0,0 +1,167 @@
+# RubyWord: Microsoft Word Generation For Ruby
+> RubyWord 是一个便捷的 word 文档生成工具
+
+# 语言
+* [English](README.md)
+* [简体中文](README.cn.md)
+
+# 更新日志
+[ChANGELOG](CHANGELOG.md)
+
+# 使用前请先阅读
+这个项目正在开发中，因为只有我自己在开发，所以进度可能会比较缓慢以及可能会存在很多未知的问题。这方面请多谅解，同时也希望各位有兴趣的朋友也加入到开发来，欢迎多提宝贵意见或者直接提PR也是非常欢迎的，感谢支持。
+
+# 安装
+```
+gem install rubyword
+```
+或者将下面这句代码写入到Gemfile
+```
+gem 'rubyword'
+```
+# 特性
++ 支持设置文档的属性，比如： 标题，副标题，作者以及等等
++ 支持插入段落
++ 支持根据一级标题，二级标题，多级标题自动生成目录结构
++ 支持设置页头和页尾
++ 支持插入多级标题
++ 支持插入空行符以及空白页
++ 支持插入图片
++ 支持插入列表
++ 支持插入超链接
++ 支持插入表格
++ 更多功能，敬请期待..
+
+# 用法说明
+```
+require "rubyword"
+Rubyword::Document::generate('hello.docx') {
+  # word 文档的属性
+  information({
+    company: 'ruby word',
+    creator: 'young',
+    title: 'example word file',
+    description: 'this is a example docx',
+    subject: 'how to create doc info',
+    keywords: 'remark',
+    category: 'category'
+  })
+  
+  section {
+    text '普通段落1'
+    p(text_align: 'center') {
+      text '连续的文本1'
+      text '连续的文本'
+    }
+    text '普通段落2'
+
+    p {
+      text '不居中的文本 '
+      text '黄色的文本', bgcolor: 'yellow', text_align: 'center'
+    }
+  }
+
+  # 根据标题生成目录
+  title_directory font_size: 24
+
+  # 插入页头
+  add_header 'rubyword'
+
+  # 插入页尾，并以数字作为页码
+  add_footer nil, text_align: 'center', nums_type: 'number'
+  # 插入页尾，使用字符作为页码
+  # add_footer 'hello', text_align: 'center'
+
+  section {
+    # 二级标题
+    title_2 "It's a subtitle"
+    # 一级标题
+    title_1 'Database'
+    # 二级标题
+    title_2 'MySQL'
+    # 三级标题
+    title_3 'NoSQL'
+    # 一级标题，并且不把它列入目录生成的范围
+    title_1 "It's a title", ignore_dir: true 
+    # 空白行
+    text_break 3
+    # 插入文本并指定样式
+    text 'hello word', bgcolor: 'yellow', text_align: 'center'
+    # 空白页
+    page_break 2
+    # 插入文本
+    text 'hello word', indent_between: '1440-1440'
+    text 'title', { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+
+    # 插入标题
+    title_1 'section2 title'
+    title_2 'section2 title'
+    title_3 'section2 title'
+
+    # 插入链接
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+  }
+
+  section {
+    # 插入文本
+    text 'another Section', bgcolor: 'yellow', text_align: 'center'
+
+    # 插入文本
+    text 'hello word', indent_between: '1440-1440'
+    text 'title', { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+  }
+
+  # 插入列表
+  section {
+    list 'test1', 1
+    list 'test1', 2
+    list 'test3', 2
+    list 'test2', 1
+    list 'test2', 1
+  }
+
+  section {
+    # 插入链接
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+    # 插入图片
+    image 'http://www.baidu.com/img/bd_logo1.png'
+    # 插入表格
+    table {
+      tr {
+        th 'id'
+        th 'name'
+        th 'age'
+      }
+      tr {
+        th '1'
+        th 'young'
+        th '66'
+      }
+    }
+  }
+
+
+}
+```
+
+# 文档
+[查看文档](doc/README.md)
+
+# 马上要做的
++ 支持更多样式
++ 支持markdown/html转换为word
+
+# 贡献
+非常欢迎有兴趣的朋友加入到开发中，以下是提交流程
+1. fork this project
+2. git clone your fork project
+3. git checkout -b fixed-something
+4. git commit fixed some bug.
+5. git push to your fork project
+6. create a new pr to request merge
+
+# 灵感
+首先非常感谢 [PHPWord](https://github.com/PHPOffice/PHPWord), 因为在无意中发现了 PHPWord 的这个非常强大项目， 并且该项目支持很多各种各样的特性。但是当我在寻找我大 Ruby 这类相关项目的时候居然找不到，本着学习的精神，参考了 PHPWord 的设计，就自己写了一个啦，欢迎 Star 支持一下。
+
+# 协议
+RubyWord is licensed under [The MIT License](LICENSE)

data/README.md

@@ -1,6 +1,13 @@
 # RubyWord: Microsoft Word Generation For Ruby
 > RubyWord is a simple, efficient Word document generation gem and easy to generate docx file.
 
+# Language
+* [English](README.md)
+* [简体中文](README.cn.md)
+
+# CHANGELOG
+[ChANGELOG](CHANGELOG.md)
+
 # Please Read Before Use
 This project is under developing, and develop by myself until now, so the progress may be slow and there may be a lot of problems, but i will try my best to improve it and welcome everyone to join the development. Thanks for supporting.
 
@@ -14,6 +21,7 @@ gem 'rubyword'
 ```
 # Features
 + Support for setting the properties of the document, such as: title, subject, author and other information
++ Support for insert a paragraph
 + Support for generated TOC for the title
 + Support for setting header and footer
 + Support for insert title which is different attributes, such as: title, sub title, etc.
@@ -21,7 +29,7 @@ gem 'rubyword'
 + Support for insert multiple images 
 + Support for insert multiple lists 
 + Support for insert hyperlink 
-
++ Support for insert table
 # Usage
 ```
 require "rubyword"
@@ -99,13 +107,26 @@ Rubyword::Document::generate('hello.docx') {
     # add a link
     link 'baidu', 'http://www.baidu.com', text_align: 'center'
     image 'http://www.baidu.com/img/bd_logo1.png'
+    # add table
+    table {
+      tr {
+        th 'id'
+        th 'name'
+        th 'age'
+      }
+      tr {
+        th '1'
+        th 'young'
+        th '66'
+      }
+    }
   }
 }
 ```
+# Document
+[More Information](doc/README.md)
 
 # TODO
-+ Support table
-+ Support paragraph
 + Support more style
 + Support Markdown/HTML to docx
 

data/bin/run-example

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+file_path = File.join(File.expand_path('../../', __FILE__), 'example')
+puts file_path
+Dir.foreach(file_path) do |filename|
+  real_path = "#{file_path}/#{filename}"
+  next if File.directory?(real_path)
+  if filename != "." and filename != ".."
+    system "ruby #{real_path}"
+    puts "#{filename} done."
+  end
+end

data/doc/README.md

@@ -1 +1,18 @@
-# keep
+# Rubyword Document
+
+### Example Text
++ You can check and run the example in `/example` dir or run `/bin/run-example`
+
+### Feature List
++ [Text](text.md)
++ [Title](title.md)
++ [Toc](toc.md)
++ [Paragraph](paragraph.md)
++ [List](list.md)
++ [Link](link.md)
++ [Image](image.md)
++ [Table](table.md)
++ [Header](header.md)
++ [Footer](footer.md)
++ [Doc Information](doc-information.md)
+

data/doc/doc-information.md

@@ -0,0 +1,16 @@
+# Doc Information
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  information({
+    company: 'ruby word',
+    creator: 'young',
+    title: 'example word file',
+    description: 'this is a example docx',
+    subject: 'how to create doc info',
+    keywords: 'remark',
+    category: 'category'
+  })
+}
+```

data/doc/footer.md

@@ -0,0 +1,19 @@
+# Footer
+
+## Options
++ text_align: 'left' | 'center' | 'right'
++ nums_type: 'number' | 'roman', Desc: when you need page numer as a footer, the text(first param) must be nil
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  # insert footer with page number
+  add_footer nil, text_align: 'center', nums_type: 'number'
+
+  # insert footer with roman number
+  add_footer nil, text_align: 'center', nums_type: 'roman'
+
+  # insert footer with string
+  add_footer 'hello', text_align: 'center'
+}
+```

data/doc/header.md

@@ -0,0 +1,11 @@
+# Header
+
+## Options
++ text_align: 'left' | 'center' | 'right'
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  add_header 'rubyword'
+}
+```

data/doc/image.md

@@ -0,0 +1,10 @@
+# Image
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    image 'http://www.baidu.com/img/bd_logo1.png'
+  }
+}
+```

data/doc/link.md

@@ -0,0 +1,10 @@
+# Link
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+  }
+}
+```

data/doc/list.md

@@ -0,0 +1,17 @@
+# List
+
+## Options
++ level: Number
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    list 'list-1', 1
+    list 'list-second', 2
+    list 'test3', 2
+    list 'test2', 1
+    list 'test2', 1
+  }
+}
+```

data/doc/paragraph.md

@@ -0,0 +1,27 @@
+# Paragraph
+
+## Style
++ font_size: Number | 16
++ color: Number | 996699
++ bgcolor: Number | 996699
++ underline: Boolean | true
++ blod: Boolean | true
++ all_caps: Boolean | false
++ italic: Boolean | false
++ text_align: 'left' || 'center' || 'right',
++ spacing: Number 200
++ indent_left: Number 100
++ indent_right: Number 200
++ indent_between: Number 200
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    p {
+      text 'This is a '
+      text 'apple, yellow apple', bgcolor: 'yellow', text_align: 'center'
+    }
+  }
+}
+```