docxtor 0.1.1

data/lib/docxtor/document/root.rb

@@ -0,0 +1,17 @@
+module Docxtor
+  module Document
+    class Root < Element
+      map({ :table_of_contents  => Document::TableOfContents,
+            :p                  => Document::Paragraph,
+            :h                  => Document::Heading,
+            :page_break         => Document::PageBreak
+          })
+
+      def render(xml)
+        super
+        write_elements
+        xml.target!
+      end
+    end
+  end
+end

data/lib/docxtor/document/table_of_contents.rb

@@ -0,0 +1,95 @@
+module Docxtor
+  module Document
+    class TableOfContents < Element
+      STYLE = 'defprnRUSSelStyle'
+      PARAGRAPH_STYLE = '10'
+
+      def after_initialize(text)
+        create_params({:style => STYLE})
+        @text = text
+      end
+
+      # TODO: Add support for extended styling & properties
+
+      def render(xml)
+        super
+
+        xml.w :sdt, "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main" do
+
+          write_properties
+
+          xml.w :sdtContent do
+
+            write_heading
+
+            xml.w :p do
+              xml.w :pPr do
+                xml.w :pStyle, "w:val" => PARAGRAPH_STYLE
+                xml.w :tabs do
+                  xml.w :tab, "w:val" => "right", "w:leader" => "dot", "w:pos" => 9350
+                end
+                xml.w :rPr do
+                  xml.w :noProof
+                end
+              end
+              xml.w :r do
+                xml.w :fldChar, "w:fldCharType" => "begin", "w:dirty" => true
+              end
+
+              write_instruct
+
+              xml.w :r do
+                xml.w :fldChar, "w:fldCharType" => "separate"
+              end
+            end
+
+            xml.w :p do
+              xml.w :r do
+                # xml.w :rPr do
+                #   xml.w :b
+                #   xml.w :bCs
+                #   xml.w :noProof
+                # end
+                xml.w :fldChar, "w:fldCharType" => "end"
+              end
+            end
+
+          end
+        end
+      end
+
+      private
+
+      def write_properties
+        xml.w :sdtPr do
+          xml.w :docPartObj do
+            xml.w :docPartGallery, "w:val" => "Table of Contents"
+            xml.w :docPartUnique
+          end
+        end
+      end
+
+      def write_heading
+        xml.w :p do
+          xml.w :pPr do
+            xml.w :pStyle, "w:val" => @params[:style]
+          end
+          xml.w :r do
+            xml.w :t do
+              xml.text! @text
+            end
+          end
+        end
+      end
+
+      def write_instruct
+        xml.w :r do
+          xml.w :instrText, "xml:space" => "preserve" do
+            xml.text! " TOC \\o '1-3' \\h \\z \\u "
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/docxtor/generator.rb

@@ -0,0 +1,13 @@
+module Docxtor
+  class Generator
+    class << self
+      def generate(template, &block)
+        template_parser = TemplateParser.new(template)
+        parts = template_parser.parts
+
+        document = Document::Builder.new(&block)
+        Package::Builder.new(parts, document)
+      end
+    end
+  end
+end

data/lib/docxtor/package/builder.rb

@@ -0,0 +1,35 @@
+module Docxtor
+  module Package
+    class Builder
+      attr_reader :parts
+
+      def initialize(parts, document)
+        @parts = parts
+        @parts['document'] = Part.new("word/document.xml", document.content)
+      end
+
+      def save(filepath)
+        Zip::ZipOutputStream.open(filepath) do |ostream|
+          write_parts(ostream)
+        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|
+          ostream.put_next_entry(part.filename)
+          ostream.puts part.content
+        end
+      end
+    end
+  end
+end

data/lib/docxtor/package/part.rb

@@ -0,0 +1,12 @@
+module Docxtor
+  module Package
+    class Part
+      attr_reader :filename, :content
+
+      def initialize(filename, content)
+        @filename = filename
+        @content = content
+      end
+    end
+  end
+end

data/lib/docxtor/template_parser.rb

@@ -0,0 +1,38 @@
+module Docxtor
+  class TemplateParser
+    attr_accessor :template
+
+    FILES_PATTERN = File.join('**', '{*,.}{xml,rels}')
+
+    def initialize(template)
+      @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]
+      end
+    end
+
+    def create_parts
+      Dir[FILES_PATTERN].
+        delete_if { |file| File.directory?(file) }.
+        map { |file| create_part(file) }
+    end
+
+    def create_part(file)
+      content = File.read(file)
+      part = Package::Part.new(file, content)
+      key = File.basename(file, '.xml')
+
+      [key, part]
+    end
+
+  end
+end

data/lib/docxtor/version.rb

@@ -0,0 +1,3 @@
+module Docxtor
+  VERSION = "0.1.1"
+end

data/spec/docxtor/document/builder_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Document::Builder do
+    include WordprocessingMLMatchers
+
+    subject { Document::Builder.new do
+      p "Hi"
+      end
+    }
+
+    it 'contains body' do
+      subject.content.should contain_body
+    end
+  end
+end

data/spec/docxtor/document/heading_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Document::Heading do
+    include_context 'xmlbuilder' do
+      #it 'renders heading style'
+    end
+  end
+end

data/spec/docxtor/document/paragraph_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Document::Paragraph do
+    include_context 'xmlbuilder' do
+
+      subject {
+        render(Document::Paragraph, "text1", :b => true) do
+          style 123
+          spacing :before => 80, :after => 240
+          font_size 32
+          font_size_complex 30
+          indent :start => 720
+          i; u
+
+          w "text2"; br; w "text3"
+        end
+      }
+
+      it 'contains reference to style' do
+        subject.should contain_element_style(:p)
+      end
+
+      it 'contains spacing property' do
+        subject.should contain_element_property(:p, :spacing)
+      end
+
+      it 'contains font size property' do
+        subject.should contain_element_property(:p, :sz)
+      end
+
+      it 'contains complex font size property' do
+        subject.should contain_element_property(:p, :szCs)
+      end
+
+      it 'contains indentiation property' do
+        subject.should contain_element_property(:p, :ind)
+      end
+
+      context 'nested run' do
+        it 'is bold' do
+          subject.should contain_element_property(:r, :b)
+        end
+
+        it 'is italic' do
+          subject.should contain_element_property(:r, :i)
+        end
+
+        it 'is underlined' do
+          subject.should contain_element_property(:r, :u)
+        end
+      end
+
+    end
+  end
+end

data/spec/docxtor/document/root_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Document::Root do
+    include_context "xmlbuilder" do
+
+      subject {
+        Document::Root.new(:style => 1) do
+          p do
+            w "Hi"
+          end
+        end
+      }
+
+      it 'appends element to elements' do
+        subject.elements.first.should be_instance_of Docxtor::Document::Paragraph
+      end
+    end
+  end
+end

data/spec/docxtor/document/table_of_contents_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Document::TableOfContents do
+    include_context 'xmlbuilder' do
+
+      subject { render(Document::TableOfContents, 'Contents') }
+
+      it 'contains gallery of document parts' do
+        subject.should contain_gallery_of_document_parts
+      end
+
+      it 'contains heading text' do
+        subject.should contain_sdt_content_heading
+      end
+    end
+  end
+end

data/spec/docxtor/docxtor_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Docxtor, "#generate" do
+  context "when supplied all the same parameters that Generator takes" do
+    it 'does not throw errors' do
+      deny { rescuing {
+          Docxtor.generate do
+            p "Paragraph"
+          end
+      } }
+    end
+  end
+end

data/spec/docxtor/package/builder_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Package::Builder do
+    subject { Package::Builder.new({}, Package::Part.new("word/document.xml", 'content')) }
+
+    include_context 'integration' do
+      context "given filepath and source document" do
+        it 'saves to file' do
+          subject.save(docx)
+
+          expect { File.exists?(docx) }
+          deny { rescuing { File.delete(docx) } }
+        end
+      end
+
+      context 'after serialization' do
+        it 'contains data' do
+          string_io = subject.to_stream
+          expect { string_io.size > 0 }
+        end
+
+        it 'contains document part' do
+          string_io = subject.to_stream
+          istream = Zip::ZipInputStream.open_buffer(string_io)
+
+          deny { rescuing {
+            document_entry = istream.get_next_entry
+
+            expect { document_entry != nil }
+            expect { document_entry.name == "word/document.xml" }
+          } }
+        end
+      end
+    end
+  end
+end

data/spec/docxtor/package/part_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Docxtor
+  describe Package::Part do
+    context "given filename and content" do
+      subject { Package::Part.new("filename", "content") }
+
+      it 'returns filename' do
+        expect { subject.filename == "filename" }
+      end
+      it 'returns content' do
+        expect { subject.content == "content" }
+      end
+    end
+  end
+end

data/spec/docxtor/prerequisites_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Docxtor do
+  context 'prerequisites' do
+    it 'has a version number' do
+      expect { Docxtor::VERSION != nil }
+    end
+  end
+end

data/spec/docxtor/support/contexts/integration_context.rb

@@ -0,0 +1,6 @@
+module Docxtor
+  shared_context 'integration' do
+    let(:template) { File.join(File.dirname(__FILE__), "..", "..", "..", "..", "templates", "default") }
+    let(:docx) { File.join(File.dirname(__FILE__), "..", "..", "tmp", 'test.docx') }
+  end
+end

data/spec/docxtor/support/contexts/xml_builder_context.rb

@@ -0,0 +1,11 @@
+module Docxtor
+  shared_context 'xmlbuilder' do
+    include WordprocessingMLMatchers
+
+    def render(klass, *args, &block)
+      builder = Builder::XmlMarkup.new
+      klass.new(*args, &block).render(builder)
+      builder.target!
+    end
+  end
+end