rubyword 1.0.0

data/lib/rubyword/writer/part/toc.rb

@@ -0,0 +1,89 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Writer
+    module Part
+      module Toc
+        def write_toc(rubyword, xml)
+          return if rubyword.toc.nil? || !rubyword.toc[:open]
+          @xml = xml
+          rubyword.sections.each_with_index do |section, section_index|
+            next if section.titles.nil?
+            section.titles.each_with_index do |title, title_index|
+              rid = title[:rid]
+              indent = 0
+
+              @xml.send('w:p') {
+                @xml.send('w:pPr') {
+                  @xml.send('w:tabs') {
+                    @xml.send('w:tab', 'w:val' => 'right', 'w:leader' => 'dot', 'w:pos' => '9062')
+                  }
+
+                  # According title size to set tab index, detail: rubyword/element/text.rb
+                  if title[:indent] > 0
+                    @xml.send('w:ind', 'w:left' => title[:indent])
+                  end
+                }
+                
+                # initailize in first loop
+                if section_index == 0 && title_index == 0
+                  @xml.send('w:r') {
+                    @xml.send('w:fldChar', 'w:fldCharType' => 'begin')
+                  }
+      
+                  @xml.send('w:r') {
+                    @xml.send('w:instrText', {'xml:space' => 'preserve'}, "TOC \\o 1-10 \\h \\z \\u") # What does '1-13' mean?
+                  }
+
+                  @xml.send('w:r') {
+                    @xml.send('w:fldChar', 'w:fldCharType' => 'separate')
+                  }
+                end
+
+                @xml.send('w:hyperlink', 'w:anchor' => "_Toc#{rid}", 'w:history' => 1) {
+                  @xml.send('w:r') {
+                    # add font style
+                    if rubyword.toc[:font_size]
+                      @xml.send('w:rPr') {
+                        @xml.send('w:sz', 'w:val' => rubyword.toc[:font_size])
+                        @xml.send('w:szCs', 'w:val' => rubyword.toc[:font_size])
+                      }
+                    end
+                    # add text
+                    @xml.send('w:t', title[:text])
+                  }
+
+                  @xml.send('w:r') {
+                    @xml.send('w:tab')
+                  }
+
+                  @xml.send('w:r') {
+                    @xml.send('fldChar', 'w:fldCharType' => 'begin')
+                  }
+
+                  @xml.send('w:r') {
+                    @xml.send('w:instrText', {'xml:space' => 'preserve'}, "PAGEREF _Toc#{rid} \\h")
+                  }
+
+                  # page numbers
+                  # @xml.send('w:r') {
+                  #   @xml.send('w:t', 1)
+                  # }
+
+                  @xml.send('w:r') {
+                    @xml.send('w:fldChar', 'w:fldCharType' => 'end')
+                  }
+                }
+              }
+            end
+          end
+          # end of fldchar
+          @xml.send('w:p') {
+            @xml.send('w:r') {
+              @xml.send('w:fldChar', 'w:fldCharType' => 'end')
+            }
+          }
+        end # end of write
+      end
+    end
+  end
+end

data/lib/rubyword/writer/part/web_settings.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+	module Writer
+		module Part
+			class WebSettings < Base
+				def write
+					webs = {
+						'xmlns:r' => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+						'xmlns:w' => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+					}
+					builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+						xml.send('w:webSettings', webs){
+							xml.send('w:optimizeForBrowser')
+						}
+					end
+					builder.to_xml
+				end
+			end
+		end
+  end
+end

data/lib/rubyword/writer/style/base.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Writer
+    module Style
+      class Base
+        attr_accessor :rubyword, :style, :section, :xml
+        def initialize(section, xml, rubyword)
+          @style = section.style
+          @section = section
+          @xml = xml
+          @rubyword = rubyword
+        end
+      end
+    end
+  end
+end

data/lib/rubyword/writer/style/section.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+module Rubyword
+  module Writer
+    module Style
+      class Section < Base
+
+        MarginsDefault = {
+          width: 11870, 
+          height: 16787,
+          margin: 1440,
+          gutter: 0,
+          header_height: 720,
+          footer_height: 720,
+          column_count: 1,
+          column_spacing: 720
+        }.freeze
+
+        Margins = {
+          'w:top' => MarginsDefault[:margin],
+          'w:right' => MarginsDefault[:margin],
+          'w:bottom' => MarginsDefault[:margin],
+          'w:left' => MarginsDefault[:margin],
+          'w:header' => MarginsDefault[:header_height],
+          'w:footer' => MarginsDefault[:footer_height],
+          'w:gutter' => MarginsDefault[:gutter]
+        }
+        
+        Orientation = 'portrait'.freeze
+        Landspace = 'landscape'.freeze
+
+        def write
+          @xml.send('w:sectPr') {
+            # header or footerReference
+
+            [@rubyword.header, @rubyword.footer].each do |target|
+              next if target.nil?
+              @xml.send("w:#{target[:type]}Reference", {
+                'w:type' => 'default',
+                'r:id' => "rId#{target[:rid]}"
+              })
+            end
+            
+            # pgsize
+            @xml.send('w:pgSz', {
+              'w:orient' => Orientation,
+              'w:w' => MarginsDefault[:width],
+              'w:h' => MarginsDefault[:height]
+            })
+            #borders 暂无
+
+            # pgMar
+            @xml.send('w:pgMar', Margins)
+            # cols
+            @xml.send('w:cols', 'w:num' => MarginsDefault[:column_count], 'w:space' => MarginsDefault[:column_spacing])
+            #Page numbering start 暂无
+
+            # Line numbering 暂无
+
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/rubyword/writer.rb

@@ -0,0 +1,87 @@
+# -*- encoding : utf-8 -*-
+require_relative "writer/part/base"
+require_relative "writer/part/toc"
+require_relative "writer/part/content_types"
+require_relative "writer/part/doc_props_app"
+require_relative "writer/part/doc_props_core"
+require_relative "writer/part/doc_props_custom"
+require_relative "writer/part/document"
+require_relative "writer/part/font_table"
+require_relative "writer/part/numbering"
+require_relative "writer/part/rels_document"
+require_relative "writer/part/rels"
+require_relative "writer/part/settings"
+require_relative "writer/part/styles"
+require_relative "writer/part/theme"
+require_relative "writer/part/web_settings"
+require_relative "writer/part/footer"
+require_relative "writer/part/header"
+# style file
+require_relative 'writer/style/base'
+require_relative 'writer/style/section'
+
+module Rubyword
+  module Writer
+    # word base file
+    DocumentBaseFile = {
+      'ContentTypes' => '[Content_Types].xml',
+      'Rels' => '_rels/.rels',
+      'DocPropsApp' => 'docProps/app.xml',
+      'DocPropsCore' => 'docProps/core.xml',
+      'DocPropsCustom' => 'docProps/custom.xml',
+      'RelsDocument' => 'word/_rels/document.xml.rels',
+      'Document' => 'word/document.xml',
+      'Styles' => 'word/styles.xml',
+      'Numbering' => 'word/numbering.xml',
+      'Settings' => 'word/settings.xml',
+      'WebSettings' => 'word/webSettings.xml',
+      'FontTable' => 'word/fontTable.xml',
+      'Theme' => 'word/theme/theme1.xml'
+    }.freeze
+
+    def save(filename = 'document.docx')
+      buffer = Zip::OutputStream.write_buffer do |zio|
+        write_header_and_footer(zio)
+
+        # write image
+        self.images.each do |image|
+          source = open(image[:path]).read 
+          zio.put_next_entry("word/media/#{image[:filename]}")
+          zio.write(source)
+        end
+
+        DocumentBaseFile.each do |helper_method, entry|
+          obj = eval "Part::#{helper_method}.new(self)"
+          source = obj.write
+          zio.put_next_entry(entry)
+          zio.write(source)
+        end
+      end
+      file = File.new(filename,'wb')
+      file.write(buffer.string)
+      file.close
+    end
+
+    def write_header_and_footer(zio)
+      header = self.header
+      footer = self.footer
+      if header
+        elmFile = "word/header#{header[:id]}.xml"
+        obj = Part::Header.new(self)
+        source = obj.write
+        zio.put_next_entry(elmFile)
+        zio.write(source)
+      end
+
+      if footer
+        elmFile = "word/footer#{footer[:id]}.xml"
+        obj = Part::Footer.new(self)
+        source = obj.write
+        zio.put_next_entry(elmFile)
+        zio.write(source)
+      end
+    end
+    
+  end
+end
+

data/lib/rubyword.rb

@@ -0,0 +1,9 @@
+require "nokogiri"
+require "zip"
+require "open-uri"
+require "fastimage"
+
+require_relative "rubyword/version"
+require_relative "rubyword/configuration"
+require_relative "rubyword/writer"
+require_relative "rubyword/document"

data/rubyword.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubyword/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubyword"
+  spec.version       = Rubyword::VERSION
+  spec.authors       = ["young"]
+  spec.email         = ["youngjy6@gmail.com"]
+
+  spec.summary       = %q{Generate MS Word for ruby}
+  spec.description   = %q{RubyWord is a simple, efficient Word document generation gem and easy to generate docx file.}
+  spec.homepage      = "https://github.com/yigger/rubyword"
+  spec.license = "MIT"
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "zip"
+  spec.add_development_dependency "open-uri"
+  spec.add_development_dependency "fastimage"
+end

data/sample/test.rb

@@ -0,0 +1,78 @@
+require_relative '../lib/rubyword'
+filename = File.join(Rubyword::TEMP_PATH, 'hello.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'
+  })
+  
+  # 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'
+  }
+}

data/spec/rubyword/document_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+module Rubyword
+  describe Document do
+    describe "#create section" do
+      let(:document) { Rubyword::Document.new }
+      it "return a document class" do
+        
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "rubyword"
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/template/fontTable.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:fonts 
+    xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" 
+    xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+    <w:font w:name="Times New Roman">
+        <w:panose1 w:val="02020603050405020304" />
+        <w:charset w:val="00" />
+        <w:family w:val="roman" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="E0002AFF" w:usb1="C0007841" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Courier New">
+        <w:panose1 w:val="02070309020205020404" />
+        <w:charset w:val="00" />
+        <w:family w:val="modern" />
+        <w:pitch w:val="fixed" />
+        <w:sig w:usb0="E0002AFF" w:usb1="C0007843" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Wingdings">
+        <w:panose1 w:val="05000000000000000000" />
+        <w:charset w:val="02" />
+        <w:family w:val="auto" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="00000000" w:usb1="10000000" w:usb2="00000000" w:usb3="00000000" w:csb0="80000000" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Symbol">
+        <w:panose1 w:val="05050102010706020507" />
+        <w:charset w:val="02" />
+        <w:family w:val="roman" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="00000000" w:usb1="10000000" w:usb2="00000000" w:usb3="00000000" w:csb0="80000000" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Arial">
+        <w:panose1 w:val="020B0604020202020204" />
+        <w:charset w:val="00" />
+        <w:family w:val="swiss" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="E0002AFF" w:usb1="C0007843" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Cambria">
+        <w:panose1 w:val="02040503050406030204" />
+        <w:charset w:val="00" />
+        <w:family w:val="roman" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="A00002EF" w:usb1="4000004B" w:usb2="00000000" w:usb3="00000000" w:csb0="0000019F" w:csb1="00000000" />
+    </w:font>
+    <w:font w:name="Calibri">
+        <w:panose1 w:val="020F0502020204030204" />
+        <w:charset w:val="00" />
+        <w:family w:val="swiss" />
+        <w:pitch w:val="variable" />
+        <w:sig w:usb0="E10002FF" w:usb1="4000ACFF" w:usb2="00000009" w:usb3="00000000" w:csb0="0000019F" w:csb1="00000000" />
+    </w:font>
+</w:fonts>