rubyword 1.0.0 → 1.1.0

data/doc/table.md

@@ -0,0 +1,21 @@
+# Table
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    table {
+      tr {
+        th 'id'
+        th 'name'
+        th 'age'
+      }
+      tr {
+        th '1'
+        th 'young'
+        th '66'
+      }
+    }
+  }
+}
+```

data/doc/text.md

@@ -1 +1,26 @@
-# keep 
+# Text
+
+## 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 {
+    text "hello world"
+    # add some style
+    text "hello", { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+  }
+}
+```

data/doc/title.md

@@ -0,0 +1,14 @@
+# Title
+
+## Options
++ ignore_dir: Boolean. Desc: Doc will ignore add this title to TOC
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  section {
+    title_1 "It's a title", ignore_dir: true 
+    title_2 "It's a subtitle"
+  }
+}
+```

data/doc/toc.md

@@ -0,0 +1,11 @@
+# Toc
+
+## Options
++ font_size: Number
+
+## Example
+```
+Rubyword::Document::generate('hello.docx') {
+  title_directory font_size: 24
+}
+```

data/example/doc_information.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'doc-information.docx')
+Rubyword::Document::generate(filename) {
+  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/example/footer.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'footer.docx')
+Rubyword::Document::generate(filename) {
+  add_footer 'hello', text_align: 'center'
+}

data/example/header.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'header.docx')
+Rubyword::Document::generate(filename) {
+  add_header 'rubyword'
+}

data/example/image.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'image.docx')
+Rubyword::Document::generate(filename) {
+  section {
+    image 'http://www.baidu.com/img/bd_logo1.png'
+  }
+}

data/example/link.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'link.docx')
+Rubyword::Document::generate(filename) {
+  section {
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+  }
+}

data/example/list.rb

@@ -0,0 +1,11 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'list.docx')
+Rubyword::Document::generate(filename) {
+  section {
+    list 'test1', 1, { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+    list 'test1', 2
+    list 'test3', 2
+    list 'test2', 1
+    list 'test2', 1
+  }
+}

data/example/paragraph.rb

@@ -0,0 +1,17 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'paragraph.docx')
+Rubyword::Document::generate(filename) {
+  section {
+    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'
+    }
+  }
+}

data/example/table.rb

@@ -0,0 +1,18 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'table.docx')
+Rubyword::Document::generate(filename) {
+  section {
+    table {
+      tr {
+        th 'id'
+        th 'name'
+        th 'age'
+      }
+      tr {
+        th '1'
+        th 'young'
+        th '66'
+      }
+    }
+  }
+}

data/example/test.rb

@@ -0,0 +1,117 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'test.docx')
+Rubyword::Document::generate(filename) {
+  # write the doc infomation
+  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 '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'
+    }
+  }
+
+  # Generate the directory structure
+  title_directory font_size: 24
+
+  #insert header
+  add_header 'rubyword'
+
+  # insert footer with number
+  add_footer nil, text_align: 'center', nums_type: 'number'
+  # insert text
+  add_footer 'hello', text_align: 'center'
+  # # initialize section and insert something in the section
+  section {
+    # insert title
+    title_1 "It's a title", ignore_dir: true 
+    # insert subtitle
+    title_2 "It's a subtitle"
+    # insert title
+    title_1 'Database'
+    # insert subtitle
+    title_2 'MySQL'
+    # insert No.3 title
+    title_3 'NoSQL'
+    # text break
+    text_break 3
+    # insert text
+    text 'hello word', bgcolor: 'yellow', text_align: 'center'
+    # page break
+    page_break 2
+    # insert text
+    text 'hello word', indent_between: '1440-1440'
+    text 'title', { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+
+    # insert title
+    title_1 'section2 title'
+    title_2 'section2 title'
+    title_3 'section2 title'
+
+    # add a link
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+  }
+
+  section {
+    # insert a text
+    text 'another Section', bgcolor: 'yellow', text_align: 'center'
+
+    # insert a text
+    text 'hello word', indent_between: '1440-1440'
+    text 'title', { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+  }
+
+  section {
+    list 'test1', 1, { font_size: 62, color: '996699', blod: true, text_align: 'center' }
+    list 'test1', 2
+    list 'test3', 2
+    list 'test2', 1
+    list 'test2', 1
+  }
+
+  section {
+    # add a link
+    link 'baidu', 'http://www.baidu.com', text_align: 'center'
+    image 'http://www.baidu.com/img/bd_logo1.png'
+  }
+
+  section {
+    title_1 'section1 title'
+    title_2 'section2 title'
+    title_3 'section3 title'
+  }
+
+  section {
+    table {
+      tr {
+        th 'h0'
+        th 'h1'
+        th 'h2'
+        th 'h3'
+        th 'h4'
+      }
+      tr {
+        th 'b1'
+        th 'b2'
+        th 'b3'
+        th 'b4'
+      }
+    }
+    text 'aa'
+  }
+}

data/example/text.rb

@@ -0,0 +1,9 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'text.docx')
+Rubyword::Document::generate(filename) {
+  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' }
+  }
+}

data/example/toc.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'test.docx')
+Rubyword::Document::generate(filename) {
+  # Generate the directory structure
+  title_directory font_size: 24
+  section {
+    # insert title
+    title_1 "It's a title", ignore_dir: true 
+    # insert subtitle
+    title_2 "It's a subtitle"
+    # insert title
+    title_1 'Database'
+    # insert subtitle
+    title_2 'MySQL'
+    # insert No.3 title
+    title_3 'NoSQL'
+  }
+
+  section {
+    title_1 'section1 title'
+    title_2 'section2 title'
+    title_3 'section3 title'
+  }
+}

data/lib/rubyword.rb

@@ -6,4 +6,5 @@ require "fastimage"
 require_relative "rubyword/version"
 require_relative "rubyword/configuration"
 require_relative "rubyword/writer"
+require_relative "rubyword/style"
 require_relative "rubyword/document"

data/lib/rubyword/configuration.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Rubyword
-  TEMP_PATH = File.join(File.expand_path('../../../', __FILE__), 'temp')
+  TEMP_PATH = File.join(File.expand_path('../../../', __FILE__), 'example/result')
   WORD_TEMP_PATH = File.join(File.expand_path('../../../', __FILE__), 'template')
 end

data/lib/rubyword/document.rb

@@ -11,6 +11,8 @@ module Rubyword
 
     def self.generate(filename, options = {}, &block)
       rubyword = new(options, &block)
+
+      # module Write to create word document
       rubyword.save(filename)
     end
 
@@ -27,54 +29,40 @@ module Rubyword
       @section = Element::Section.new(@sections.count + 1, style, self)
       self.sections << @section
       @section.instance_eval(&block) if block_given?
+      @section
+    end
+
+    # initialize doc information
+    def information(options={})
+      @doc_info = options
     end
 
+    # generate TOC 
     def title_directory(option= {})
       @toc.merge!(open: true)
       @toc.merge!(option)
     end
 
-    def add_header(text, options={})
-      @header = {
-        id: 1,
-        text: text,
-        rid: self.init_rid,
-        text_align: options[:align] || 'center',
-        type: 'header'
-      }
-      self.content_types << {
-        "/word/header1.xml" => "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml"
-      }
-      self.rels_documents << {
-        Id: "rId#{self.init_rid}", 
-        Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header", 
-        Target: "header1.xml"
-      }
-      self.init_rid = self.init_rid + 1
-    end
-
-    def add_footer(text=nil, options={})
-      @footer = {
-        id: 1,
-        text: text,
-        rid: self.init_rid,
-        text_align: options[:align] || 'center',
-        nums_type: options[:nums_type],
-        type: 'footer'
-      }
-      self.content_types << {
-        "/word/footer1.xml" => "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml"
-      }
-      self.rels_documents << {
-        Id: "rId#{self.init_rid}", 
-        Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
-        Target: "footer1.xml"
-      }
-      self.init_rid = self.init_rid + 1
-    end
-
-    def information(options={})
-      @doc_info = options
+    # add header and footer
+    ['header', 'footer'].each do |method_name|
+      define_method "add_#{method_name}" do |text, options={}|
+        instance_variable_set("@#{method_name}", {
+                                id: 1,
+                                text: text,
+                                rid: self.init_rid,
+                                type: method_name,
+                                style: options
+                              })
+        self.content_types << {
+          "/word/#{method_name}1.xml" => "application/vnd.openxmlformats-officedocument.wordprocessingml.#{method_name}+xml"
+        }
+        self.rels_documents << {
+          Id: "rId#{self.init_rid}", 
+          Type: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/#{method_name}", 
+          Target: "#{method_name}1.xml"
+        }
+        self.init_rid = self.init_rid + 1
+      end
     end
 
   end