docxtor 0.1.1 → 0.2.1

data/.ruby-version

@@ -1 +1 @@
-ree-1.8.7-2012.02
+1.9.3-p448

data/Gemfile

@@ -15,4 +15,5 @@ end
 
 group :development do
   gem "pry"
+  gem "pry-debugger"
 end

data/README.md

@@ -9,12 +9,14 @@ docxtor
 ## Summary
 
 Ruby docx generator.
-Supported ruby versions: ree-1.8.7, mri 1.8.7
+**Docxtor** is built to work with Ruby 1.8 as well as 1.9
 
 ## Features
 
-1. Paragraphs and headings: bold, italic, custom style id, line breaks, page breaks, spacing
-2. Table of contents
+- Paragraphs and headings markup.
+- Bold, underline & italic font styles.
+- Document table of contents.
+- Document headers & footers, page numbers.
 
 More to come, stay tuned!
 
@@ -34,7 +36,9 @@ Or install it yourself as:
 
 ## Usage
 
-```
+Here's the taste of what **Docxtor's** "markup language" may look like.
+
+```ruby
 package = Docxtor.generate do
   table_of_contents "Contents"
   h 1, "heading1"
@@ -63,51 +67,91 @@ end
 package.save('test.docx')
 ```
 
-more usage examples:
+### Entry point
 
+```ruby
+Docxtor.generate do
+  ...
+end
 ```
-# Usage sample:
-# elements - any collection of your elements, so in this example i have:
-# class Element
-#   attr_reader :title1, :title2, :content
-# end
-# elements = Array.new(5, Element)
-
-# Somewhere in your controller:
-
-def action_method
-  @stream = Docxtor.generate do
-    p 'Paragraph text', :align => 'center', :b => true
-    table_of_contents 'Table of contents'
-    page_break
-    
-    elements.each do |el|
-      h 1, el.title do
-        spacing :before => 120, :after => 120
-  
-        write el.title1
-        write ", blahblah "
-        br
-        write el.title2
-      end
-  
-      p do
-        el.content.lines.map(&:chomp).each do |line|
-          write line; br
-        end
-      end
-      
-    end
-  end
-  
-  send_data(
-    @stream.read,
-    :filename => 'yourfilename.docx',
-    :type =>'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-  )
+
+### Paragraphs
+
+The main building block of `docx` document is a paragraph. There're couple of ways of defining a paragraph.
+
+```ruby
+p "Hi there!", :bold => true
+```
+
+Is the same as
+
+```ruby
+p do
+  w "Hi there!"
+  b
+end
+```
+
+or
+
+```ruby
+p do
+  write "Hi there!"
+  bold
+end
+```
+
+Everything styling-related that is written either inside the block or in options hash will be applied to the whole parapraph.
+
+You can mix and match different ways to define text & options.
+
+```ruby
+p "I'm a first string in this paragraph", :bold => true do
+  write "I'm a second one."
+  u
+  w "And we all will be bold and underlined in the same time!"
 end
 ```
 
+### Headings
+
+**Currently not working as expected! Will be fixed soon!**
+
+Generally the same as paragraphs, but have additional argument - the level of heading and styled by default.
+
+```ruby
+  h 1, "Chapter 1"
+  h 2, "Where our hero goes for an adventure"
+```
+
+### Table of Contents
+
+**Currently not working as expected! Will be fixed soon!**
+
+Inserts the ToC for a document with a caption.
+
+```ruby
+table_of_contents "Table of Contents"
+```
+
+### Footers & Headers
+
+You can specify following properties for footers and headers:
+
+- on which pages footer or header will appear (`:odd`, `:even` or only `:first`);
+- alignment (`:center`, `:left`, `:right`)
+- contents of a footer/header, including special keyword `:pagenum` which inserts page numbers
+
+```ruby
+footer :pagenum, :align => :center
+header "Proudly made by me", :pages => :odd
+footer "2013", :pages => :first, :align => :right
+```
+
+### Breaks
+
+You can insert `page_break` or newline inside a paragraph with `br`.
+
 ## Contributing
 
 1. Fork it

data/lib/docxtor.rb

@@ -6,6 +6,9 @@ require "docxtor/version"
 module Docxtor
   autoload :Generator, 'docxtor/generator'
   autoload :TemplateParser, 'docxtor/template_parser'
+  autoload :RunningElementsBuilder, 'docxtor/running_elements_builder'
+  autoload :RunningElement, 'docxtor/running_element'
+  autoload :ReferenceBuilder, 'docxtor/reference_builder'
 
   module Document
     autoload :Builder, 'docxtor/document/builder'

data/lib/docxtor/document/builder.rb

@@ -1,12 +1,17 @@
 module Docxtor
   module Document
     class Builder
-      attr_accessor :content
+      attr_accessor :content, :running_elements
 
-      def initialize(&block)
+      def initialize(running_elements, &block)
+        @running_elements = running_elements
         @content = render(&block)
       end
 
+      def filename
+        "word/document.xml"
+      end
+
       def render(&block)
         xml = ::Builder::XmlMarkup.new
 
@@ -21,12 +26,22 @@ module Docxtor
         "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
         "xmlns:wne" => "http://schemas.microsoft.com/office/word/2006/wordml" do
           xml.w :body do
-            xml << Document::Root.new(&block).render(xml)
+            xml << Document::Root.new(&block).render(::Builder::XmlMarkup.new)
+
+            render_running_elements xml
           end
         end
 
         xml.target!
       end
+
+      def render_running_elements xml
+        xml.w :sectPr do |xml|
+          running_elements.each do |re|
+            xml.w re.reference_name.to_sym, "r:id" => re.reference_id, "w:type" => "#{re.pages}"
+          end
+        end
+      end
     end
   end
 end

data/lib/docxtor/document/element.rb

@@ -11,6 +11,10 @@ module Docxtor
         end
       end
 
+      def method_missing name, *args
+        super unless [:header, :footer].include? name
+      end
+
       def initialize(*args, &block)
         @elements = []
 
@@ -82,8 +86,11 @@ module Docxtor
       def get_properties_for(el)
         props = properties[el]
         if props
-          pairs = @params.
-            map { |k, v| props[k] && [props[k][:name] || props[k], v] }
+          pairs = @params.map do |k, v|
+            unless props[k].nil?
+              props[k].is_a?(Hash) ? [props[k][:name], v] : [props[k], v]
+            end
+          end
           Hash[pairs]
         end
       end

data/lib/docxtor/generator.rb

@@ -5,8 +5,13 @@ module Docxtor
         template_parser = TemplateParser.new(template)
         parts = template_parser.parts
 
-        document = Document::Builder.new(&block)
-        Package::Builder.new(parts, document)
+        running_elements = RunningElementsBuilder.new(&block).elements
+        parts += running_elements
+
+        parts << ReferenceBuilder.new(running_elements)
+        parts << Document::Builder.new(running_elements, &block)
+
+        Package::Builder.new(parts)
       end
     end
   end

data/lib/docxtor/package/builder.rb

@@ -3,9 +3,8 @@ module Docxtor
     class Builder
       attr_reader :parts
 
-      def initialize(parts, document)
+      def initialize(parts)
         @parts = parts
-        @parts['document'] = Part.new("word/document.xml", document.content)
       end
 
       def save(filepath)
@@ -14,18 +13,10 @@ module Docxtor
         end
       end
 
-      def to_stream
-        ostream = Zip::ZipOutputStream.new("streamed", true)
-        write_parts(ostream)
-        string_io = ostream.close_buffer
-        string_io.rewind
-        string_io
-      end
-
       private
 
       def write_parts(ostream)
-        @parts.each do |name, part|
+        @parts.each do |part|
           ostream.put_next_entry(part.filename)
           ostream.puts part.content
         end

data/lib/docxtor/reference_builder.rb

@@ -0,0 +1,29 @@
+module Docxtor
+  class ReferenceBuilder
+    attr_accessor :elements
+
+    def initialize elements
+      @elements = elements
+      @elements.each_with_index { |el, i| el.reference_id = "rId#{i+1}" }
+    end
+
+    def filename
+      "word/_rels/document.xml.rels"
+    end
+
+    def content
+      xml = ::Builder::XmlMarkup.new
+
+      xml.instruct! :xml, :version => "1.0", :encoding=>"UTF-8", :standalone => "yes"
+      xml.Relationships "xmlns" => "http://schemas.openxmlformats.org/package/2006/relationships" do |xml|
+        elements.each do |element|
+          xml.Relationship "Id" => element.reference_id,
+                           "Target" => element.name,
+                           "Type" => element.reference_type
+        end
+      end
+
+      xml.target!
+    end
+  end
+end

data/lib/docxtor/running_element.rb

@@ -0,0 +1,69 @@
+module Docxtor
+  class RunningElement
+    attr_accessor :pages, :type, :reference_id
+
+    def initialize type, num, contents, options = {}
+      @type = type
+      @contents = contents
+      @align = options[:align]
+      @pages = options[:pages] || :default
+      @num = num
+    end
+
+    def reference_name
+      "#{type}Reference"
+    end
+
+    def name
+      "#{type}#{@num}.xml"
+    end
+
+    def filename
+      "word/#{name}"
+    end
+
+    def reference_type
+      "http://schemas.openxmlformats.org/officeDocument/2006/relationships/#{type}"
+    end
+
+    def content
+      xml = ::Builder::XmlMarkup.new
+
+      xml.instruct! :xml, :version => "1.0", :encoding=>"UTF-8", :standalone => "yes"
+      xml.w :ftr, "xmlns:o" => "urn:schemas-microsoft-com:office:office",
+      "xmlns:r" => "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+      "xmlns:v" => "urn:schemas-microsoft-com:vml",
+      "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
+      "xmlns:w10" => "urn:schemas-microsoft-com:office:word",
+      "xmlns:wp" => "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" do |xml|
+
+        xml.w :p do |xml|
+          xml.w :pPr do |xml|
+            xml.w :jc, "w:val" => "#{@align}" if @align
+          end
+          if @contents == :pagenum
+            xml.w :r do |xml|
+              xml.w :fldChar, "w:fldCharType" => "begin"
+            end
+            xml.w :r do |xml|
+              xml.w :instrText, "PAGE"
+            end
+            xml.w :r do |xml|
+              xml.w :fldChar, "w:fldCharType" => "separate"
+            end
+            xml.w :r do |xml|
+              xml.w :t, "i"
+            end
+            xml.w :r do |xml|
+              xml.w :fldChar, "w:fldCharType" => "end"
+            end
+          else
+            xml.w :r do |xml|
+              xml.w :t, @contents
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docxtor/running_elements_builder.rb

@@ -0,0 +1,18 @@
+module Docxtor
+  class RunningElementsBuilder
+    attr_accessor :elements
+
+    def method_missing method_name, *args
+      num = 0
+      if [:header, :footer].include? method_name
+        num += 1
+        @elements << RunningElement.new(method_name, num, *args)
+      end
+    end
+
+    def initialize &block
+      @elements = []
+      instance_eval &block
+    end
+  end
+end

data/lib/docxtor/template_parser.rb

@@ -4,19 +4,13 @@ module Docxtor
 
     FILES_PATTERN = File.join('**', '{*,.}{xml,rels}')
 
-    def initialize(template)
+    def initialize(template = nil)
       @template = template || File.join(File.dirname(__FILE__), "..", "..", "templates", "default")
     end
 
     def parts
-      @parts ||= parse
-    end
-
-    private
-
-    def parse
       Dir.chdir(template) do
-        Hash[create_parts]
+        create_parts
       end
     end
 
@@ -29,9 +23,8 @@ module Docxtor
     def create_part(file)
       content = File.read(file)
       part = Package::Part.new(file, content)
-      key = File.basename(file, '.xml')
 
-      [key, part]
+      part
     end
 
   end