docxtor 0.1.1

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 4wdVJp9RHu5gRyn96RakitmhAHQri6OFe

data/.gitignore

@@ -0,0 +1,21 @@
+~*
+.DS_Store
+*.swp
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ree-1.8.7-2012.02

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - ree-1.8.7-2012.02
+  - 1.8.7

data/.wrong

@@ -0,0 +1 @@
+color

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'pre-commit'
+end
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'simplecov', :require => false
+  gem 'tconsole'
+  gem 'turn'
+end
+
+group :development do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vasiliy Yorkin
+
+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,117 @@
+docxtor
+========
+
+[![Build Status](https://travis-ci.org/docxtor/docxtor.png?branch=master)](https://travis-ci.org/docxtor/docxtor)
+[![Coverage Status](https://coveralls.io/repos/docxtor/docxtor/badge.png)](https://coveralls.io/r/docxtor/docxtor)
+[![Dependency Status](https://gemnasium.com/docxtor/docxtor.png)](https://gemnasium.com/docxtor/docxtor)
+[![Gem Version](http://stillmaintained.com/docxtor/docxtor.png)](http://stillmaintained.com/docxtor/docxtor)
+
+## Summary
+
+Ruby docx generator.
+Supported ruby versions: ree-1.8.7, mri 1.8.7
+
+## Features
+
+1. Paragraphs and headings: bold, italic, custom style id, line breaks, page breaks, spacing
+2. Table of contents
+
+More to come, stay tuned!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docxtor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 'docxtor'
+
+## Usage
+
+```
+package = Docxtor.generate do
+  table_of_contents "Contents"
+  h 1, "heading1"
+
+  p "text1", :b => true do
+    style 'p1'
+    spacing :before => 80, :after => 240
+    italic; u
+
+    w "text2"
+    br
+    write "text3"
+  end
+
+  h 2 do
+    w "heading2"
+    line_break
+    write "some text"
+    br
+    write "another text"
+  end
+
+  p "content", :style => 'p2', :i => true, :align => 'center'
+end
+
+package.save('test.docx')
+```
+
+more usage examples:
+
+```
+# 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'
+  )
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,5 @@
+1) Paragraph spacing support [Done]
+2) Dynamic style generation
+3) Tables
+4) Lists
+5) Images

data/docxtor.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docxtor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docxtor"
+  spec.version       = Docxtor::VERSION
+  spec.authors       = ["Irina Bednova, Vasiliy Yorkin"]
+  spec.email         = ["howeveririna@gmail.com, vasiliy.yorkin@gmail.com"]
+  spec.description   = %q{Ruby docx generator, provides simple DSL for building word documents}
+  spec.summary       = %q{Ruby docx generator}
+  spec.homepage      = "http://github.com/docxtor/docxtor"
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  # HINT: Version lock is required for ruby ree-1.8.7
+  spec.add_development_dependency "nokogiri", "~> 1.4.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-xml"
+  spec.add_development_dependency "wrong"
+
+  spec.add_runtime_dependency "builder"
+  spec.add_runtime_dependency "rubytree"
+  spec.add_runtime_dependency "rubyzip", "0.9.9"
+end

data/lib/docxtor.rb

@@ -0,0 +1,30 @@
+require "builder"
+require "zip/zip"
+
+require "docxtor/version"
+
+module Docxtor
+  autoload :Generator, 'docxtor/generator'
+  autoload :TemplateParser, 'docxtor/template_parser'
+
+  module Document
+    autoload :Builder, 'docxtor/document/builder'
+    autoload :Element, 'docxtor/document/element'
+    autoload :Root, 'docxtor/document/root'
+    autoload :Run, 'docxtor/document/run'
+    autoload :Text, 'docxtor/document/text'
+    autoload :TableOfContents, 'docxtor/document/table_of_contents'
+    autoload :Paragraph, 'docxtor/document/paragraph'
+    autoload :Heading, 'docxtor/document/heading'
+    autoload :PageBreak, 'docxtor/document/page_break'
+  end
+
+  module Package
+    autoload :Part, 'docxtor/package/part'
+    autoload :Builder, "docxtor/package/builder"
+  end
+
+  def self.generate(template = nil, &block)
+    Generator.generate(template, &block)
+  end
+end

data/lib/docxtor/document/builder.rb

@@ -0,0 +1,32 @@
+module Docxtor
+  module Document
+    class Builder
+      attr_accessor :content
+
+      def initialize(&block)
+        @content = render(&block)
+      end
+
+      def render(&block)
+        xml = ::Builder::XmlMarkup.new
+
+        xml.instruct! :xml, :version => "1.0", :encoding => "UTF-8", :standalone => "yes"
+        xml.w :document, "xmlns:ve" => "http://schemas.openxmlformats.org/markup-compatibility/2006",
+        "xmlns:o" => "urn:schemas-microsoft-com:office:office",
+        "xmlns:r" => "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+        "xmlns:m" => "http://schemas.openxmlformats.org/officeDocument/2006/math",
+        "xmlns:v" => "urn:schemas-microsoft-com:vml",
+        "xmlns:wp" => "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
+        "xmlns:w10" => "urn:schemas-microsoft-com:office:word",
+        "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)
+          end
+        end
+
+        xml.target!
+      end
+    end
+  end
+end

data/lib/docxtor/document/element.rb

@@ -0,0 +1,96 @@
+module Docxtor
+  module Document
+    class Element
+      attr_accessor :elements, :xml
+
+      def self.map(mappings)
+        mappings.each do |name, klass|
+          define_method(name) do |*args, &block|
+            elements << klass.new(*args, &block)
+          end
+        end
+      end
+
+      def initialize(*args, &block)
+        @elements = []
+
+        # FIXME You have to call #create_params in this hook
+        after_initialize(*args)
+
+        instance_eval &block if block_given?
+      end
+
+      def render(xml)
+        @xml = xml
+      end
+
+      protected
+
+      def after_initialize *args; end
+
+      def properties
+        {}
+      end
+
+      def aliases
+        {}
+      end
+
+      def write_elements
+        @elements.each { |el| el.render(@xml) }
+      end
+
+      def write_element(name, &block)
+        xml.tag!("w:#{name}") do
+          write_properties(name)
+          instance_eval &block if block_given?
+          write_elements
+        end
+      end
+
+      def write_properties(el)
+        @properties = get_properties_for(el)
+        if @properties
+          xml.tag!("w:#{el}Pr") do
+            @properties.each { |k, v| write_property(k, v) }
+          end
+        end
+      end
+
+      def write_property(key, val)
+        if self_closing? val
+          xml.tag!("w:#{key}")
+        elsif val
+          if val.is_a?(Hash) && !val.empty?
+            xml.tag!("w:#{key}", prefixize(val))
+          else
+            xml.tag!("w:#{key}", 'w:val' => val)
+          end
+        end
+      end
+
+      private
+
+      def create_params(options)
+        @params = Hash[options.map {|k,v| [aliases[k] || k, v]}]
+      end
+
+      def self_closing?(val)
+        val == true
+      end
+
+      def get_properties_for(el)
+        props = properties[el]
+        if props
+          pairs = @params.
+            map { |k, v| props[k] && [props[k][:name] || props[k], v] }
+          Hash[pairs]
+        end
+      end
+
+      def prefixize(attrs)
+        Hash[attrs.map { |k, v| ["w:#{k}", v] }]
+      end
+    end
+  end
+end

data/lib/docxtor/document/heading.rb

@@ -0,0 +1,13 @@
+module Docxtor
+  module Document
+    class Heading < Paragraph
+      H1 = 1
+      H2 = 2
+
+      def after_initialize(nesting = H1, *args)
+        super(*args)
+        @params[:style] ||= nesting
+      end
+    end
+  end
+end

data/lib/docxtor/document/page_break.rb

@@ -0,0 +1,14 @@
+module Docxtor
+  module Document
+    class PageBreak < Element
+      def render(xml)
+        super
+        write_element(:p) do
+          write_element(:r) do
+            xml.w :br, 'w:type' => 'page'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docxtor/document/paragraph.rb

@@ -0,0 +1,125 @@
+module Docxtor
+  module Document
+    class Paragraph < Element
+      STYLE = 'a5'
+
+      PROPERTIES =
+        {
+        :p => {
+          :style => 'pStyle',
+          :align => 'jc',
+          :font_size => 'sz',
+          :font_size_complex => 'szCs',
+          :spacing => {
+            :name => 'spacing',
+            :before => 'before',
+            :after => 'after'
+          },
+          :indent => {
+            :name => 'ind',
+            :start => 'start',
+            :end => 'end',
+            :hanging => 'hanging'
+          }
+        },
+        :r => {
+          :bold => 'b',
+          :italic => 'i',
+          :underline => 'u'
+        }
+      }
+
+      PLAIN_PROPERTIES =
+        PROPERTIES[:p].reject {|k,v| v.is_a? Hash}
+
+      NESTED_PROPERTIES =
+        PROPERTIES[:p].reject {|k,v| !v.is_a? Hash}
+
+      def after_initialize(*args)
+        @contents = []
+        @contents << args.shift if args.first.is_a? String
+
+        create_params(args.shift || {})
+
+        NESTED_PROPERTIES.each do |name, element|
+          @params[name] ||= {}
+        end
+        @params[:space] ||= 'default'
+      end
+
+      def render(xml)
+        super
+        write_element(:p) do
+          write_element(:r) do
+            write_contents
+          end
+        end
+      end
+
+      PLAIN_PROPERTIES.each do |name, element|
+        define_method(name) { |val| @params[name] = val }
+      end
+
+      PROPERTIES[:r].each do |name, element|
+        define_method(name) { @params[name] = true }
+      end
+
+      NESTED_PROPERTIES.each do |name, element|
+        define_method(name) { |attrs| @params[name].merge!(attrs) }
+      end
+
+      def properties
+        PROPERTIES
+      end
+
+      def line_break
+        @contents << :br
+      end
+
+      def preserve_whitespace
+        @params[:space] = 'preserve'
+      end
+
+      def write(text)
+        @contents << text
+      end
+
+      def aliases
+        {
+          :b => :bold,
+          :i => :italic,
+          :u => :underline
+        }
+      end
+
+      private
+
+      def write_contents
+        @contents.each { |c| write_content(c) }
+      end
+
+      def write_content(content)
+        content == :br ?
+        write_line_break :
+          write_text(content)
+      end
+
+      def write_line_break
+        @xml.w :br
+      end
+
+      def write_text(text)
+        @xml.w :t, 'xml:space' => @params[:space] do
+          @xml.text! text
+        end
+      end
+
+      alias_method :b, :bold
+      alias_method :i, :italic
+      alias_method :u, :underline
+      alias_method :br, :line_break
+      alias_method :w, :write
+      alias_method :ind, :indent
+    end
+  end
+end