docx 0.1.0

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Marcus Ortiz, http://marcusortiz.com
+
+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,32 @@
+# docx
+
+a ruby library/gem for interacting with `.docx` files
+
+## usage
+
+### basic
+
+``` ruby
+require 'docx'
+
+d = Docx::Document.open('example.docx')
+d.each_paragraph do |p|
+  puts d
+end
+```
+
+### advanced
+
+``` ruby
+require 'docx'
+
+d = Docx::Document.open('example.docx')
+d.each_paragraph do |p|
+  p.each_text_run do |run|
+    run.italicized?
+    run.bolded?
+    run.underlined?
+    run.formatting
+    run.text
+  end
+end

data/lib/docx.rb

@@ -0,0 +1,5 @@
+require 'docx/version'
+
+module Docx
+  autoload :Document, 'docx/document'
+end

data/lib/docx/containers.rb

@@ -0,0 +1,2 @@
+require 'docx/containers/text_run'
+require 'docx/containers/paragraph'

data/lib/docx/containers/paragraph.rb

@@ -0,0 +1,23 @@
+require 'docx/containers/text_run'
+
+module Docx
+  module Containers
+    class Paragraph
+      attr_accessor :text_runs
+      
+      def initialize(txt_runs)
+        @text_runs = txt_runs
+      end
+      
+      def to_s
+        @text_runs.map(&:text).join('')
+      end
+      
+      def each_text_run
+        @text_runs.each { |tr| yield(tr) }
+      end
+      
+      alias_method :text, :to_s
+    end
+  end
+end

data/lib/docx/containers/text_run.rb

@@ -0,0 +1,35 @@
+module Docx
+  module Containers
+    class TextRun
+      DEFAULT_FORMATTING = {
+        italic:    false,
+        bold:      false,
+        underline: false
+      }
+      
+      attr_reader :text
+      attr_reader :formatting
+      
+      def initialize(attrs)
+        @text       = attrs[:text] || ''
+        @formatting = attrs[:formatting] || DEFAULT_FORMATTING
+      end
+      
+      def to_s
+        @text
+      end
+      
+      def italicized?
+        @formatting[:italic]
+      end
+      
+      def bolded?
+        @formatting[:bold]
+      end
+      
+      def underlined?
+        @formatting[:underline]
+      end
+    end
+  end
+end

data/lib/docx/document.rb

@@ -0,0 +1,27 @@
+require 'docx/parser'
+
+module Docx
+  class Document
+    attr_reader :paragraphs
+    
+    def initialize(path)
+      Parser.new(File.expand_path(path)) do |p|
+        @paragraphs = p.paragraphs
+      end
+    end
+    
+    def self.open(path)
+      self.new(path)
+    end
+    
+    def each_paragraph
+      @paragraphs.each { |p| yield(p) }
+    end
+    
+    def to_s
+      @paragraphs.map(&:to_s).join("\n")
+    end
+    
+    alias_method :text, :to_s
+  end
+end

data/lib/docx/parser.rb

@@ -0,0 +1,49 @@
+require 'docx/containers'
+require 'nokogiri'
+require 'zip/zip'
+
+module Docx
+  class Parser
+    def initialize(path)
+      @zip = Zip::ZipFile.open(path)
+      @xml = Nokogiri::XML(@zip.find_entry('word/document.xml').get_input_stream)
+      
+      if block_given?
+        yield self
+        @zip.close
+      end
+    end
+    
+    def paragraphs
+      @xml.xpath('//w:document//w:body//w:p').map { |p_node| parse_paragraph_from p_node }
+    end
+    
+    private
+    
+    def parse_paragraph_from(p_node)
+      Containers::Paragraph.new(parse_runs_from(p_node))
+    end
+    
+    def parse_runs_from(p_node)
+      p_node.xpath('w:r').map do |r_node|
+        rpr_node = r_node.xpath('w:rPr')
+        Containers::TextRun.new({
+          text:       parse_text_from(r_node),
+          formatting: parse_formatting_from(rpr_node)
+        })
+      end
+    end
+    
+    def parse_text_from(r_node)
+      r_node.xpath('w:t').map(&:text).join('')
+    end
+    
+    def parse_formatting_from(rpr_node)
+      {
+        italic:    !rpr_node.xpath('w:i').empty?,
+        bold:      !rpr_node.xpath('w:b').empty?,
+        underline: !rpr_node.xpath('w:u').empty?
+      }
+    end
+  end
+end

data/lib/docx/version.rb

@@ -0,0 +1,3 @@
+module Docx
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: docx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marcus Ortiz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70332799492380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332799492380
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &70332799491720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70332799491720
+description: a ruby library/gem for interacting with .docx files
+email: mportiz08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE.md
+- lib/docx/containers/paragraph.rb
+- lib/docx/containers/text_run.rb
+- lib/docx/containers.rb
+- lib/docx/document.rb
+- lib/docx/parser.rb
+- lib/docx/version.rb
+- lib/docx.rb
+homepage: https://github.com/mportiz08/docx
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: a ruby library/gem for interacting with .docx files
+test_files: []