rubyword 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94a411b43cd5b8e055aa0d391332d91e29b5a9eb
+  data.tar.gz: 3253a4e9f289ba99b9e62a0ab73b1cb43c223d58
+SHA512:
+  metadata.gz: d67230b2cb422a7a5631c9844a1fa44b77a0739b683dfcecd86b9e090989ade5d625d7dfb8a1d17aef10c9a8290a59799a95fd092507b0bd40554aea31a28557
+  data.tar.gz: 82ebc3d3424424abc1293896448472dc53d76f41fbbb921e6eeb158793172c017992458c07819c011674d29737e4f7dff8e78c115c3181379a79bd9f389778b1

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+temp
+sample/*
+.idea/*
+.vscode

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.txt

@@ -0,0 +1,10 @@
+CHANGELOG
+Version 0.1.0:
+* 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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubyword.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicholas Frandsen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+# RubyWord: Microsoft Word Generation For Ruby
+> RubyWord is a simple, efficient Word document generation gem and easy to generate docx file.
+
+# 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.
+
+# Installing RubyWord
+```
+gem install rubyword
+```
+or put this line in your Gemfile
+```
+gem 'rubyword'
+```
+# Features
++ 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 
+
+# Usage
+```
+require "rubyword"
+Rubyword::Document::generate('hello.docx') {
+  # 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'
+  })
+  
+  # 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
+    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'
+  }
+}
+```
+
+# TODO
++ Support table
++ Support paragraph
++ Support more style
++ Support Markdown/HTML to docx
+
+# Contributing
+RubyWord is use my spare time to write, so it may has a lot of Bugs and welcome everyone to create Pull Request or Issue to improve this project together.
+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
+
+# Inspiration
+Thanks [PHPWord](https://github.com/PHPOffice/PHPWord), I was very surprised when I saw the PHPWord project which is a very powerful project and provide a lot of features. But I can't find such as ruby project when i search in google and I decided to write and design by myself.
+
+# License
+RubyWord is licensed under [The MIT License](LICENSE)

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doc/README.md

@@ -0,0 +1 @@
+# keep

data/doc/text.md

@@ -0,0 +1 @@
+# keep 

data/lib/rubyword/configuration.rb

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

data/lib/rubyword/document.rb

@@ -0,0 +1,81 @@
+# -*- encoding : utf-8 -*-
+require_relative "element/section"
+require_relative "writer"
+module Rubyword
+  class Document
+    attr_accessor :sections, :init_rid
+    attr_accessor :relation_rids, :content_types, :rels_documents, :images
+    attr_accessor :header, :footer
+    attr_accessor :doc_info, :toc
+    include Writer
+
+    def self.generate(filename, options = {}, &block)
+      rubyword = new(options, &block)
+      rubyword.save(filename)
+    end
+
+    def initialize(options={}, &block)
+      @sections, @toc, @init_rid, @doc_info = [], {}, 7, {}
+      @relation_rids = []
+      @content_types = []
+      @rels_documents = []
+      @images = []
+      instance_eval(&block) if block_given?
+    end
+
+    def section(style=nil, &block)
+      @section = Element::Section.new(@sections.count + 1, style, self)
+      self.sections << @section
+      @section.instance_eval(&block) if block_given?
+    end
+
+    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
+    end
+
+  end
+end

data/lib/rubyword/element/base.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Element
+    class Base
+      attr_accessor :rubyword, :section
+      def initialize(rubyword, section=nil)
+        @rubyword = rubyword
+        @section = section
+      end
+    end
+  end
+end

data/lib/rubyword/element/image.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Element
+    class Image < Base
+      attr_accessor :images
+      def save(url, style=nil)
+        @images ||= Queue.new
+        filename = url.split('/').last
+        width, height = FastImage.size(url)
+        image_params = {
+          rid: @rubyword.init_rid,
+          path: url,
+          width: width,
+          height: height,
+          filename: filename
+        }
+        @images << image_params
+        @rubyword.images << image_params
+        @rubyword.rels_documents << {
+          Id: "rId#{@rubyword.init_rid}",
+          Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',
+          Target: "media/#{filename}"
+        }
+        @rubyword.init_rid = @rubyword.init_rid + 1
+      end
+
+      def write(section=nil, xml=nil)
+        @xml = xml
+        image = self.images.pop
+        @xml.send('w:p') {
+          @xml.send('w:pPr')
+          @xml.send('w:r') {
+            @xml.send('w:pict') {
+              @xml.send('v:shape', 'type' => '#_x0000_t75', 'style' => "width:#{image[:width]}px; height:#{image[:height]}px; margin-left:0px; margin-top:0px; mso-position-horizontal:left; mso-position-vertical:top; mso-position-horizontal-relative:char; mso-position-vertical-relative:line;") {
+                @xml.send('w10:wrap', 'type' => 'inline', 'anchorx' => 'page', 'anchory' => 'page')
+                @xml.send('v:imagedata', 'r:id' => "rId#{image[:rid]}", 'o:title' => '')
+              }
+            }
+          }
+        }
+      end
+
+    end
+  end
+end

data/lib/rubyword/element/link.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+    module Element
+      class Link < Base
+        attr_accessor :links
+        def save(text, link, style)
+					@links ||= Queue.new
+					return if text.nil?
+					@rubyword.rels_documents << {
+						Id: "rId#{@rubyword.init_rid}",
+						Type: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
+						Target: link,
+						TargetMode: 'External'
+					}
+					@links << { rId: @rubyword.init_rid, text: text, link: link }
+					@rubyword.init_rid = @rubyword.init_rid + 1
+        end
+				
+				def write(section=nil, xml=nil)
+					@xml = xml
+          link = self.links.pop
+          @xml.send('w:p') {
+            @xml.send('hyperlink', 'r:id' => "rId#{link[:rId]}", 'w:history' => '1') {
+              @xml.send('w:r') {
+                # TODO: add style
+                @xml.send('w:rPr')
+                @xml.send('w:t', {'xml:space' => 'preserve'}, link[:text])
+              }
+            }
+          }
+				end
+				
+      end
+    end
+  end

data/lib/rubyword/element/list.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Element
+    class List < Base
+      attr_accessor :lists
+
+      # write document and numbering
+      def save(text, level, style)
+        @lists ||= Queue.new
+        @lists << {
+          level: level.to_i - 1,
+          text: text
+        }
+      end
+
+      def write(section=nil, xml=nil)
+        @xml = xml
+        list = self.lists.pop
+        @xml.send('w:p') {
+          @xml.send('w:pPr') {
+            @xml.send('w:numPr') {
+              @xml.send('w:ilvl', 'w:val' => list[:level])
+              @xml.send('w:numId', 'w:val' => 3)
+            }
+          }
+          @xml.send('w:r') {
+            @xml.send('w:rPr')
+            @xml.send('w:t', {'xml:space' => 'preserve'}, list[:text])
+          }
+        }
+      end
+
+    end
+  end
+end

data/lib/rubyword/element/page_break.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Element
+    class PageBreak < Base
+      attr_accessor :numbers
+      
+      def save(numbers)
+        @numbers ||= Queue.new
+        @numbers << numbers.to_i
+      end
+
+      def write(section=nil, xml=nil)
+        @xml = xml
+        page_break = self.numbers.pop
+        page_break.to_i.times.each do |i|
+          @xml.send('w:p') {
+            @xml.send('w:r') {
+              @xml.send('w:br', 'w:type' => 'page')
+            }  
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/rubyword/element/section.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+require_relative 'base'
+require_relative 'text'
+require_relative 'link'
+require_relative 'list'
+require_relative 'image'
+require_relative 'page_break'
+require_relative 'text_break'
+module Rubyword
+  module Element
+    class Section
+      attr_accessor :section_id, :style, :rubyword, :section_objects, :objects, :titles
+      def initialize(section_count, style = nil, rubyword=nil)
+				@section_id = section_count
+				@style = style
+        @rubyword = rubyword
+        @section_objects = []
+        @objects = []
+      end
+
+      def generate(&block)
+        !block.nil? && block.arity < 1 ? instance_eval(&block) : block[self]
+      end
+
+			def text(text, style=nil)
+        object ||= Text.new(@rubyword, self)
+        object.save(text, __callee__.to_s, style)
+        @objects << object
+			end
+			alias :title_1 :text
+			alias :title_2 :text
+			alias :title_3 :text
+			alias :title_4 :text
+
+      def list(text, level, style=nil)
+        object ||= List.new(@rubyword)
+        object.save(text, level, style)
+        @objects << object
+      end
+
+      def image(url)
+        object ||= Image.new(@rubyword)
+        object.save(url)
+        @objects << object
+      end
+
+      def link(text, link, style=nil)
+        object ||= Link.new(@rubyword)
+        object.save(text, link, style)
+        @objects << object
+      end
+
+      def page_break(break_num=1)
+        object ||= PageBreak.new(@rubyword)
+        object.save(break_num)
+        @objects << object
+      end
+
+      def text_break(break_num=1)
+        object ||= TextBreak.new(@rubyword)
+        object.save(break_num)
+        @objects << object
+      end
+
+    end
+  end
+end

data/lib/rubyword/element/text.rb

@@ -0,0 +1,137 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Element
+    class Text < Base
+      attr_accessor :texts
+      
+      IndentSize = 200
+      WordStyleList = {
+        font_size: 'w:sz',
+        color: 'w:color',
+        underline: 'w:u', 
+        blod: 'w:b', 
+        all_caps: 'w:caps',
+        italic: 'w:i',
+        bgcolor: 'w:highlight'
+      }.freeze
+      ParagraphStyleList = {
+        text_align: 'w:jc',
+        spacing: 'w:spacing',
+        indent_left: 'w:ind',
+        indent_right: 'w:ind',
+        indent_between: 'w:ind'
+      }.freeze
+
+      def save(text, type, style)
+        @texts ||= Queue.new
+        @section.titles ||= []
+        return if text.nil?
+        if type == 'text'
+          text(text, style)
+        else
+          self.send(type.to_sym, text, style)
+        end
+      end
+
+      def text(text, style)
+        @texts << { size: 'normal', text: text.to_s, style: style }
+      end
+
+      (1..4).each do |num|
+        define_method "title_#{num}" do |text, style|
+          @rubyword.relation_rids << {rid: @rubyword.init_rid, type: "title_#{num}"}
+          title_hs = {
+            indent: (num - 1) * IndentSize,
+            size: "title_#{num}",
+            text: text.to_s,
+            rid: @rubyword.init_rid,
+            style: style
+          }
+          @section.titles << title_hs if (style && !style[:ignore_dir]) || style.nil?
+          @texts << title_hs
+          @rubyword.init_rid = @rubyword.init_rid + 1
+        end
+
+        define_method "write_title_#{num}" do |args|
+          @xml.send('w:p') do
+            @xml.send('w:pPr') {
+              @xml.send('w:pStyle', 'w:val' => "Heading#{num}")
+            }
+            @xml.send('bookmarkStart', 'w:id' => args[:rid], 'w:name' => "_Toc#{args[:rid]}")
+            @xml.send('w:r') {
+              @xml.send('w:t', args[:text])
+            }
+            @xml.send('bookmarkEnd', 'w:id' => args[:rid])
+          end
+        end
+      end
+
+      def write(section=nil, xml=nil)
+        @xml = xml
+        text = self.texts.pop
+        eval "write_#{text[:size]}(text)"
+      end
+
+      def write_normal(text)
+        @xml.send('w:p') do
+          write_paragraph_style(text[:style])
+          @xml.send('w:r') do
+            write_word_style(text[:style])
+            @xml.send('w:t', {'xml:space' => 'preserve'}, text[:text])
+          end
+        end
+      end
+
+      def write_word_style(style)
+        if style.is_a?(Hash)
+          @xml.send('w:rPr') {
+            style.keys.each do |style_name|
+              style_name = style_name.to_sym
+              if WordStyleList.keys.include?(style_name)
+                value =style[style_name]
+                attribute = if !!value != value # not a bool type
+                              {'w:val' => value}
+                            else
+                              nil
+                            end
+                doc_style = WordStyleList[style_name]
+                @xml.send(doc_style, attribute)
+                @xml.send('w:szCs', attribute) if style_name == :font_size
+              end
+            end
+          }
+        end
+      end
+      
+      def write_paragraph_style(style)
+        return unless style.is_a?(Hash)
+        @xml.send('w:pPr') {
+          style.keys.each do |style_name|
+            style_name = style_name.to_sym
+            next unless ParagraphStyleList.keys.include?(style_name)
+            value =style[style_name]
+            attribute = case style_name.to_s
+                        when 'spacing'
+                          {'w:after' => value}
+                        when 'indent_left'
+                          {'w:left' => value}
+                        when 'indent_right'
+                          {'w:right' => value}
+                        when 'indent_between'
+                          v = value.split '-'
+                          next unless v.is_a?(Array)
+                          { 'w:left' => v[0].to_i, 'w:right' => v[1].to_i }
+                        when !!value == value
+                          nil
+                        else
+                          {'w:val' => value}
+                        end
+            doc_style = ParagraphStyleList[style_name]
+            @xml.send(doc_style, attribute)
+          end
+        }
+      end
+
+    end
+  end
+end