docx 0.2.07 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 436e2d77b50265c75cd9be63a2957a5f71da61e5
+  data.tar.gz: 6b14b8f1a8ec88a2f7286777f4238da6c95748e0
+SHA512:
+  metadata.gz: aa87a1a97fab2a49e023bae4dfe1000477ed20f7cf09df9d5f63f46caf8a8e238533f2df680684f0da3530b1031a827f7d4c54fa2520a72c153214db547b0e26
+  data.tar.gz: 856503643daa3f057cd4625fc8f63660748e476f71712005a841721bf392d9322430dd6d5988a3c6549ef1d7668c12de49faeacb032ffe19b2e47a5d2504292b

data/LICENSE.md

@@ -1,21 +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.
+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

@@ -84,6 +84,11 @@ doc.bookmarks['example_bookmark'].insert_text_after("Hello world.")
 # Insert multiple lines of text at our bookmark
 doc.bookmarks['example_bookmark_2'].insert_multiple_lines_after(['Hello', 'World', 'foo'])
 
+# Remove paragraphs
+doc.paragraphs.each do |p|
+  p.remove! if p.to_s =~ /TODO/
+end
+
 # Save document to specified path
 doc.save('example-edited.docx')
 ```

data/lib/docx/containers.rb

@@ -1,4 +1,4 @@
-require 'docx/containers/container'
-require 'docx/containers/text_run'
-require 'docx/containers/paragraph'
-require 'docx/containers/table'
+require 'docx/containers/container'
+require 'docx/containers/text_run'
+require 'docx/containers/paragraph'
+require 'docx/containers/table'

data/lib/docx/containers/container.rb

@@ -14,7 +14,11 @@ module Docx
         def blank!
           @node.xpath(".//w:t").each {|t| t.content = '' }
         end
+
+        def remove!
+          @node.remove
+        end
       end
     end
   end
-end
+end

data/lib/docx/containers/table.rb

@@ -1,51 +1,51 @@
-require 'docx/containers/table_row'
-require 'docx/containers/table_column'
-require 'docx/containers/container'
-
-module Docx
-  module Elements
-    module Containers
-      class Table
-        include Container
-        include Elements::Element
-
-        def self.tag
-          'tbl'
-        end
-
-        def initialize(node)
-          @node = node
-          @properties_tag = 'tblGrid'
-        end
-
-        # Array of row
-        def rows
-          @node.xpath('w:tr').map {|r_node| Containers::TableRow.new(r_node) }
-        end
-
-        def row_count
-          @node.xpath('w:tr').count
-        end
-
-        # Array of column
-        def columns
-          columns_containers = []
-          (0..(column_count-1)).each do |i|
-            columns_containers[i] = Containers::TableColumn.new @node.xpath("w:tr//w:tc[#{i+1}]")
-          end
-          columns_containers
-        end
-
-        def column_count
-          @node.xpath('w:tblGrid/w:gridCol').count
-        end
-
-        # Iterate over each row within a table
-        def each_rows
-          rows.each { |r| yield(r) }
-        end
-        
-      end
-    end
-  end
-end
+require 'docx/containers/table_row'
+require 'docx/containers/table_column'
+require 'docx/containers/container'
+
+module Docx
+  module Elements
+    module Containers
+      class Table
+        include Container
+        include Elements::Element
+
+        def self.tag
+          'tbl'
+        end
+
+        def initialize(node)
+          @node = node
+          @properties_tag = 'tblGrid'
+        end
+
+        # Array of row
+        def rows
+          @node.xpath('w:tr').map {|r_node| Containers::TableRow.new(r_node) }
+        end
+
+        def row_count
+          @node.xpath('w:tr').count
+        end
+
+        # Array of column
+        def columns
+          columns_containers = []
+          (0..(column_count-1)).each do |i|
+            columns_containers[i] = Containers::TableColumn.new @node.xpath("w:tr//w:tc[#{i+1}]")
+          end
+          columns_containers
+        end
+
+        def column_count
+          @node.xpath('w:tblGrid/w:gridCol').count
+        end
+
+        # Iterate over each row within a table
+        def each_rows
+          rows.each { |r| yield(r) }
+        end
+        
+      end
+    end
+  end
+end

data/lib/docx/containers/table_cell.rb

@@ -1,39 +1,39 @@
-require 'docx/containers/text_run'
-require 'docx/containers/container'
-
-module Docx
-  module Elements
-    module Containers
-      class TableCell
-        include Container
-        include Elements::Element
-
-        def self.tag
-          'tc'
-        end
-
-        def initialize(node)
-          @node = node
-          @properties_tag = 'tcPr'
-        end
-
-        # Return text of paragraph's cell
-        def to_s
-          paragraphs.map(&:text).join('')
-        end
-
-        # Array of paragraphs contained within cell
-        def paragraphs
-          @node.xpath('w:p').map {|p_node| Containers::Paragraph.new(p_node) }
-        end
-
-        # Iterate over each text run within a paragraph's cell
-        def each_paragraph
-          paragraphs.each { |tr| yield(tr) }
-        end
-        
-        alias_method :text, :to_s
-      end
-    end
-  end
-end
+require 'docx/containers/text_run'
+require 'docx/containers/container'
+
+module Docx
+  module Elements
+    module Containers
+      class TableCell
+        include Container
+        include Elements::Element
+
+        def self.tag
+          'tc'
+        end
+
+        def initialize(node)
+          @node = node
+          @properties_tag = 'tcPr'
+        end
+
+        # Return text of paragraph's cell
+        def to_s
+          paragraphs.map(&:text).join('')
+        end
+
+        # Array of paragraphs contained within cell
+        def paragraphs
+          @node.xpath('w:p').map {|p_node| Containers::Paragraph.new(p_node) }
+        end
+
+        # Iterate over each text run within a paragraph's cell
+        def each_paragraph
+          paragraphs.each { |tr| yield(tr) }
+        end
+        
+        alias_method :text, :to_s
+      end
+    end
+  end
+end

data/lib/docx/containers/table_column.rb

@@ -1,29 +1,29 @@
-require 'docx/containers/table_cell'
-require 'docx/containers/container'
-
-module Docx
-  module Elements
-    module Containers
-      class TableColumn
-        include Container
-        include Elements::Element
-
-        def self.tag
-          'w:gridCol'
-        end
-
-        def initialize(cell_nodes)
-          @node = ''
-          @properties_tag = ''
-          @cells = cell_nodes.map { |c_node| Containers::TableCell.new(c_node) }
-        end
-
-        # Array of cells contained within row
-        def cells
-          @cells
-        end
-        
-      end
-    end
-  end
-end
+require 'docx/containers/table_cell'
+require 'docx/containers/container'
+
+module Docx
+  module Elements
+    module Containers
+      class TableColumn
+        include Container
+        include Elements::Element
+
+        def self.tag
+          'w:gridCol'
+        end
+
+        def initialize(cell_nodes)
+          @node = ''
+          @properties_tag = ''
+          @cells = cell_nodes.map { |c_node| Containers::TableCell.new(c_node) }
+        end
+
+        # Array of cells contained within row
+        def cells
+          @cells
+        end
+        
+      end
+    end
+  end
+end

data/lib/docx/containers/table_row.rb

@@ -1,28 +1,28 @@
-require 'docx/containers/table_cell'
-require 'docx/containers/container'
-
-module Docx
-  module Elements
-    module Containers
-      class TableRow
-        include Container
-        include Elements::Element
-
-        def self.tag
-          'tr'
-        end
-
-        def initialize(node)
-          @node = node
-          @properties_tag = ''
-        end
-
-        # Array of cells contained within row
-        def cells
-          @node.xpath('w:tc').map {|c_node| Containers::TableCell.new(c_node) }
-        end
-        
-      end
-    end
-  end
-end
+require 'docx/containers/table_cell'
+require 'docx/containers/container'
+
+module Docx
+  module Elements
+    module Containers
+      class TableRow
+        include Container
+        include Elements::Element
+
+        def self.tag
+          'tr'
+        end
+
+        def initialize(node)
+          @node = node
+          @properties_tag = ''
+        end
+
+        # Array of cells contained within row
+        def cells
+          @node.xpath('w:tc').map {|c_node| Containers::TableCell.new(c_node) }
+        end
+        
+      end
+    end
+  end
+end

data/lib/docx/core_ext/module.rb

@@ -1,172 +1,172 @@
-unless Object.const_defined?("ActiveSupport")
-  class Module
-    # Provides a delegate class method to easily expose contained objects' public methods
-    # as your own. Pass one or more methods (specified as symbols or strings)
-    # and the name of the target object via the <tt>:to</tt> option (also a symbol
-    # or string). At least one method and the <tt>:to</tt> option are required.
-    #
-    # Delegation is particularly useful with Active Record associations:
-    #
-    #   class Greeter < ActiveRecord::Base
-    #     def hello
-    #       'hello'
-    #     end
-    #
-    #     def goodbye
-    #       'goodbye'
-    #     end
-    #   end
-    #
-    #   class Foo < ActiveRecord::Base
-    #     belongs_to :greeter
-    #     delegate :hello, to: :greeter
-    #   end
-    #
-    #   Foo.new.hello   # => "hello"
-    #   Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c>
-    #
-    # Multiple delegates to the same target are allowed:
-    #
-    #   class Foo < ActiveRecord::Base
-    #     belongs_to :greeter
-    #     delegate :hello, :goodbye, to: :greeter
-    #   end
-    #
-    #   Foo.new.goodbye # => "goodbye"
-    #
-    # Methods can be delegated to instance variables, class variables, or constants
-    # by providing them as a symbols:
-    #
-    #   class Foo
-    #     CONSTANT_ARRAY = [0,1,2,3]
-    #     @@class_array  = [4,5,6,7]
-    #
-    #     def initialize
-    #       @instance_array = [8,9,10,11]
-    #     end
-    #     delegate :sum, to: :CONSTANT_ARRAY
-    #     delegate :min, to: :@@class_array
-    #     delegate :max, to: :@instance_array
-    #   end
-    #
-    #   Foo.new.sum # => 6
-    #   Foo.new.min # => 4
-    #   Foo.new.max # => 11
-    #
-    # It's also possible to delegate a method to the class by using +:class+:
-    #
-    #   class Foo
-    #     def self.hello
-    #       "world"
-    #     end
-    #
-    #     delegate :hello, to: :class
-    #   end
-    #
-    #   Foo.new.hello # => "world"
-    #
-    # Delegates can optionally be prefixed using the <tt>:prefix</tt> option. If the value
-    # is <tt>true</tt>, the delegate methods are prefixed with the name of the object being
-    # delegated to.
-    #
-    #   Person = Struct.new(:name, :address)
-    #
-    #   class Invoice < Struct.new(:client)
-    #     delegate :name, :address, to: :client, prefix: true
-    #   end
-    #
-    #   john_doe = Person.new('John Doe', 'Vimmersvej 13')
-    #   invoice = Invoice.new(john_doe)
-    #   invoice.client_name    # => "John Doe"
-    #   invoice.client_address # => "Vimmersvej 13"
-    #
-    # It is also possible to supply a custom prefix.
-    #
-    #   class Invoice < Struct.new(:client)
-    #     delegate :name, :address, to: :client, prefix: :customer
-    #   end
-    #
-    #   invoice = Invoice.new(john_doe)
-    #   invoice.customer_name    # => 'John Doe'
-    #   invoice.customer_address # => 'Vimmersvej 13'
-    #
-    # If the delegate object is +nil+ an exception is raised, and that happens
-    # no matter whether +nil+ responds to the delegated method. You can get a
-    # +nil+ instead with the +:allow_nil+ option.
-    #
-    #   class Foo
-    #     attr_accessor :bar
-    #     def initialize(bar = nil)
-    #       @bar = bar
-    #     end
-    #     delegate :zoo, to: :bar
-    #   end
-    #
-    #   Foo.new.zoo   # raises NoMethodError exception (you called nil.zoo)
-    #
-    #   class Foo
-    #     attr_accessor :bar
-    #     def initialize(bar = nil)
-    #       @bar = bar
-    #     end
-    #     delegate :zoo, to: :bar, allow_nil: true
-    #   end
-    #
-    #   Foo.new.zoo   # returns nil
-    def delegate(*methods)
-      options = methods.pop
-      unless options.is_a?(Hash) && to = options[:to]
-        raise ArgumentError, 'Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
-      end
-
-      prefix, allow_nil = options.values_at(:prefix, :allow_nil)
-
-      if prefix == true && to =~ /^[^a-z_]/
-        raise ArgumentError, 'Can only automatically set the delegation prefix when delegating to a method.'
-      end
-
-      method_prefix = \
-        if prefix
-          "#{prefix == true ? to : prefix}_"
-        else
-          ''
-        end
-
-      file, line = caller.first.split(':', 2)
-      line = line.to_i
-
-      to = to.to_s
-      to = 'self.class' if to == 'class'
-
-      methods.each do |method|
-        # Attribute writer methods only accept one argument. Makes sure []=
-        # methods still accept two arguments.
-        definition = (method =~ /[^\]]=$/) ? 'arg' : '*args, &block'
-
-        if allow_nil
-          module_eval(<<-EOS, file, line - 2)
-            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
-              if #{to} || #{to}.respond_to?(:#{method})         #   if client || client.respond_to?(:name)
-                #{to}.#{method}(#{definition})                  #     client.name(*args, &block)
-              end                                               #   end
-            end                                                 # end
-          EOS
-        else
-          exception = %(raise "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
-
-          module_eval(<<-EOS, file, line - 1)
-            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
-              #{to}.#{method}(#{definition})                    #   client.name(*args, &block)
-            rescue NoMethodError                                # rescue NoMethodError
-              if #{to}.nil?                                     #   if client.nil?
-                #{exception}                                    #     # add helpful message to the exception
-              else                                              #   else
-                raise                                           #     raise
-              end                                               #   end
-            end                                                 # end
-          EOS
-        end
-      end
-    end
-  end
+unless Object.const_defined?("ActiveSupport")
+  class Module
+    # Provides a delegate class method to easily expose contained objects' public methods
+    # as your own. Pass one or more methods (specified as symbols or strings)
+    # and the name of the target object via the <tt>:to</tt> option (also a symbol
+    # or string). At least one method and the <tt>:to</tt> option are required.
+    #
+    # Delegation is particularly useful with Active Record associations:
+    #
+    #   class Greeter < ActiveRecord::Base
+    #     def hello
+    #       'hello'
+    #     end
+    #
+    #     def goodbye
+    #       'goodbye'
+    #     end
+    #   end
+    #
+    #   class Foo < ActiveRecord::Base
+    #     belongs_to :greeter
+    #     delegate :hello, to: :greeter
+    #   end
+    #
+    #   Foo.new.hello   # => "hello"
+    #   Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c>
+    #
+    # Multiple delegates to the same target are allowed:
+    #
+    #   class Foo < ActiveRecord::Base
+    #     belongs_to :greeter
+    #     delegate :hello, :goodbye, to: :greeter
+    #   end
+    #
+    #   Foo.new.goodbye # => "goodbye"
+    #
+    # Methods can be delegated to instance variables, class variables, or constants
+    # by providing them as a symbols:
+    #
+    #   class Foo
+    #     CONSTANT_ARRAY = [0,1,2,3]
+    #     @@class_array  = [4,5,6,7]
+    #
+    #     def initialize
+    #       @instance_array = [8,9,10,11]
+    #     end
+    #     delegate :sum, to: :CONSTANT_ARRAY
+    #     delegate :min, to: :@@class_array
+    #     delegate :max, to: :@instance_array
+    #   end
+    #
+    #   Foo.new.sum # => 6
+    #   Foo.new.min # => 4
+    #   Foo.new.max # => 11
+    #
+    # It's also possible to delegate a method to the class by using +:class+:
+    #
+    #   class Foo
+    #     def self.hello
+    #       "world"
+    #     end
+    #
+    #     delegate :hello, to: :class
+    #   end
+    #
+    #   Foo.new.hello # => "world"
+    #
+    # Delegates can optionally be prefixed using the <tt>:prefix</tt> option. If the value
+    # is <tt>true</tt>, the delegate methods are prefixed with the name of the object being
+    # delegated to.
+    #
+    #   Person = Struct.new(:name, :address)
+    #
+    #   class Invoice < Struct.new(:client)
+    #     delegate :name, :address, to: :client, prefix: true
+    #   end
+    #
+    #   john_doe = Person.new('John Doe', 'Vimmersvej 13')
+    #   invoice = Invoice.new(john_doe)
+    #   invoice.client_name    # => "John Doe"
+    #   invoice.client_address # => "Vimmersvej 13"
+    #
+    # It is also possible to supply a custom prefix.
+    #
+    #   class Invoice < Struct.new(:client)
+    #     delegate :name, :address, to: :client, prefix: :customer
+    #   end
+    #
+    #   invoice = Invoice.new(john_doe)
+    #   invoice.customer_name    # => 'John Doe'
+    #   invoice.customer_address # => 'Vimmersvej 13'
+    #
+    # If the delegate object is +nil+ an exception is raised, and that happens
+    # no matter whether +nil+ responds to the delegated method. You can get a
+    # +nil+ instead with the +:allow_nil+ option.
+    #
+    #   class Foo
+    #     attr_accessor :bar
+    #     def initialize(bar = nil)
+    #       @bar = bar
+    #     end
+    #     delegate :zoo, to: :bar
+    #   end
+    #
+    #   Foo.new.zoo   # raises NoMethodError exception (you called nil.zoo)
+    #
+    #   class Foo
+    #     attr_accessor :bar
+    #     def initialize(bar = nil)
+    #       @bar = bar
+    #     end
+    #     delegate :zoo, to: :bar, allow_nil: true
+    #   end
+    #
+    #   Foo.new.zoo   # returns nil
+    def delegate(*methods)
+      options = methods.pop
+      unless options.is_a?(Hash) && to = options[:to]
+        raise ArgumentError, 'Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, to: :greeter).'
+      end
+
+      prefix, allow_nil = options.values_at(:prefix, :allow_nil)
+
+      if prefix == true && to =~ /^[^a-z_]/
+        raise ArgumentError, 'Can only automatically set the delegation prefix when delegating to a method.'
+      end
+
+      method_prefix = \
+        if prefix
+          "#{prefix == true ? to : prefix}_"
+        else
+          ''
+        end
+
+      file, line = caller.first.split(':', 2)
+      line = line.to_i
+
+      to = to.to_s
+      to = 'self.class' if to == 'class'
+
+      methods.each do |method|
+        # Attribute writer methods only accept one argument. Makes sure []=
+        # methods still accept two arguments.
+        definition = (method =~ /[^\]]=$/) ? 'arg' : '*args, &block'
+
+        if allow_nil
+          module_eval(<<-EOS, file, line - 2)
+            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
+              if #{to} || #{to}.respond_to?(:#{method})         #   if client || client.respond_to?(:name)
+                #{to}.#{method}(#{definition})                  #     client.name(*args, &block)
+              end                                               #   end
+            end                                                 # end
+          EOS
+        else
+          exception = %(raise "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
+
+          module_eval(<<-EOS, file, line - 1)
+            def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
+              #{to}.#{method}(#{definition})                    #   client.name(*args, &block)
+            rescue NoMethodError                                # rescue NoMethodError
+              if #{to}.nil?                                     #   if client.nil?
+                #{exception}                                    #     # add helpful message to the exception
+              else                                              #   else
+                raise                                           #     raise
+              end                                               #   end
+            end                                                 # end
+          EOS
+        end
+      end
+    end
+  end
 end

data/lib/docx/document.rb

@@ -1,148 +1,148 @@
-require 'docx/containers'
-require 'docx/elements'
-require 'nokogiri'
-require 'zip'
-
-module Docx
-  # The Document class wraps around a docx file and provides methods to
-  # interface with it.
-  #
-  #   # get a Docx::Document for a docx file in the local directory
-  #   doc = Docx::Document.open("test.docx")
-  #
-  #   # get the text from the document
-  #   puts doc.text
-  #
-  #   # do the same thing in a block
-  #   Docx::Document.open("test.docx") do |d|
-  #     puts d.text
-  #   end
-  class Document
-    attr_reader :xml, :doc, :zip, :styles
-    
-    def initialize(path, &block)
-      @replace = {}
-      @zip = Zip::File.open(path)
-      @document_xml = @zip.read('word/document.xml')
-      @doc = Nokogiri::XML(@document_xml)
-      @styles_xml = @zip.read('word/styles.xml')
-      @styles = Nokogiri::XML(@styles_xml)
-      if block_given?
-        yield self
-        @zip.close
-      end
-    end
-
-
-    # This stores the current global document properties, for now
-    def document_properties
-      {
-        font_size: font_size
-      }
-    end
-
-
-    # With no associated block, Docx::Document.open is a synonym for Docx::Document.new. If the optional code block is given, it will be passed the opened +docx+ file as an argument and the Docx::Document oject will automatically be closed when the block terminates. The values of the block will be returned from Docx::Document.open.
-    # call-seq:
-    #   open(filepath) => file
-    #   open(filepath) {|file| block } => obj
-    def self.open(path, &block)
-      self.new(path, &block)
-    end
-
-    def paragraphs
-      @doc.xpath('//w:document//w:body//w:p').map { |p_node| parse_paragraph_from p_node }
-    end
-
-    def bookmarks
-      bkmrks_hsh = Hash.new
-      bkmrks_ary = @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
-      # auto-generated by office 2010
-      bkmrks_ary.reject! {|b| b.name == "_GoBack" }
-      bkmrks_ary.each {|b| bkmrks_hsh[b.name] = b }
-      bkmrks_hsh
-    end
-
-    def tables
-      @doc.xpath('//w:document//w:body//w:tbl').map { |t_node| parse_table_from t_node }
-    end
-
-    # Some documents have this set, others don't.
-    # Values are returned as half-points, so to get points, that's why it's divided by 2.
-    def font_size
-      size_tag = @styles.xpath('//w:docDefaults//w:rPrDefault//w:rPr//w:sz').first
-      size_tag ? size_tag.attributes['val'].value.to_i / 2 : nil
-    end
-
-    ##
-    # *Deprecated*
-    #
-    # Iterates over paragraphs within document
-    # call-seq:
-    #   each_paragraph => Enumerator
-    def each_paragraph
-      paragraphs.each { |p| yield(p) }
-    end
-
-    # call-seq:
-    #   to_s -> string
-    def to_s
-      paragraphs.map(&:to_s).join("\n")
-    end
-
-    # Output entire document as a String HTML fragment
-    def to_html
-      paragraphs.map(&:to_html).join('\n')
-    end
-
-    # Save document to provided path
-    # call-seq:
-    #   save(filepath) => void
-    def save(path)
-      update
-      Zip::OutputStream.open(path) do |out|
-        zip.each do |entry|
-          out.put_next_entry(entry.name)
-
-          if @replace[entry.name]
-            out.write(@replace[entry.name])
-          else
-            out.write(zip.read(entry.name))
-          end
-        end
-      end
-      zip.close
-    end
-
-    alias_method :text, :to_s
-
-    def replace_entry(entry_path, file_contents)
-      @replace[entry_path] = file_contents
-    end
-
-    private
-
-    #--
-    # TODO: Flesh this out to be compatible with other files
-    # TODO: Method to set flag on files that have been edited, probably by inserting something at the
-    # end of methods that make edits?
-    #++
-    def update
-      replace_entry "word/document.xml", doc.serialize(:save_with => 0)
-    end
-
-    # generate Elements::Containers::Paragraph from paragraph XML node
-    def parse_paragraph_from(p_node)
-      Elements::Containers::Paragraph.new(p_node, document_properties)
-    end
-
-    # generate Elements::Bookmark from bookmark XML node
-    def parse_bookmark_from(b_node)
-      Elements::Bookmark.new(b_node)
-    end
-
-    def parse_table_from(t_node)
-      Elements::Containers::Table.new(t_node)
-    end
-  end
-end
+require 'docx/containers'
+require 'docx/elements'
+require 'nokogiri'
+require 'zip'
+
+module Docx
+  # The Document class wraps around a docx file and provides methods to
+  # interface with it.
+  #
+  #   # get a Docx::Document for a docx file in the local directory
+  #   doc = Docx::Document.open("test.docx")
+  #
+  #   # get the text from the document
+  #   puts doc.text
+  #
+  #   # do the same thing in a block
+  #   Docx::Document.open("test.docx") do |d|
+  #     puts d.text
+  #   end
+  class Document
+    attr_reader :xml, :doc, :zip, :styles
+    
+    def initialize(path, &block)
+      @replace = {}
+      @zip = Zip::File.open(path)
+      @document_xml = @zip.read('word/document.xml')
+      @doc = Nokogiri::XML(@document_xml)
+      @styles_xml = @zip.read('word/styles.xml')
+      @styles = Nokogiri::XML(@styles_xml)
+      if block_given?
+        yield self
+        @zip.close
+      end
+    end
+
+
+    # This stores the current global document properties, for now
+    def document_properties
+      {
+        font_size: font_size
+      }
+    end
+
+
+    # With no associated block, Docx::Document.open is a synonym for Docx::Document.new. If the optional code block is given, it will be passed the opened +docx+ file as an argument and the Docx::Document oject will automatically be closed when the block terminates. The values of the block will be returned from Docx::Document.open.
+    # call-seq:
+    #   open(filepath) => file
+    #   open(filepath) {|file| block } => obj
+    def self.open(path, &block)
+      self.new(path, &block)
+    end
+
+    def paragraphs
+      @doc.xpath('//w:document//w:body//w:p').map { |p_node| parse_paragraph_from p_node }
+    end
+
+    def bookmarks
+      bkmrks_hsh = Hash.new
+      bkmrks_ary = @doc.xpath('//w:bookmarkStart').map { |b_node| parse_bookmark_from b_node }
+      # auto-generated by office 2010
+      bkmrks_ary.reject! {|b| b.name == "_GoBack" }
+      bkmrks_ary.each {|b| bkmrks_hsh[b.name] = b }
+      bkmrks_hsh
+    end
+
+    def tables
+      @doc.xpath('//w:document//w:body//w:tbl').map { |t_node| parse_table_from t_node }
+    end
+
+    # Some documents have this set, others don't.
+    # Values are returned as half-points, so to get points, that's why it's divided by 2.
+    def font_size
+      size_tag = @styles.xpath('//w:docDefaults//w:rPrDefault//w:rPr//w:sz').first
+      size_tag ? size_tag.attributes['val'].value.to_i / 2 : nil
+    end
+
+    ##
+    # *Deprecated*
+    #
+    # Iterates over paragraphs within document
+    # call-seq:
+    #   each_paragraph => Enumerator
+    def each_paragraph
+      paragraphs.each { |p| yield(p) }
+    end
+
+    # call-seq:
+    #   to_s -> string
+    def to_s
+      paragraphs.map(&:to_s).join("\n")
+    end
+
+    # Output entire document as a String HTML fragment
+    def to_html
+      paragraphs.map(&:to_html).join('\n')
+    end
+
+    # Save document to provided path
+    # call-seq:
+    #   save(filepath) => void
+    def save(path)
+      update
+      Zip::OutputStream.open(path) do |out|
+        zip.each do |entry|
+          out.put_next_entry(entry.name)
+
+          if @replace[entry.name]
+            out.write(@replace[entry.name])
+          else
+            out.write(zip.read(entry.name))
+          end
+        end
+      end
+      zip.close
+    end
+
+    alias_method :text, :to_s
+
+    def replace_entry(entry_path, file_contents)
+      @replace[entry_path] = file_contents
+    end
+
+    private
+
+    #--
+    # TODO: Flesh this out to be compatible with other files
+    # TODO: Method to set flag on files that have been edited, probably by inserting something at the
+    # end of methods that make edits?
+    #++
+    def update
+      replace_entry "word/document.xml", doc.serialize(:save_with => 0)
+    end
+
+    # generate Elements::Containers::Paragraph from paragraph XML node
+    def parse_paragraph_from(p_node)
+      Elements::Containers::Paragraph.new(p_node, document_properties)
+    end
+
+    # generate Elements::Bookmark from bookmark XML node
+    def parse_bookmark_from(b_node)
+      Elements::Bookmark.new(b_node)
+    end
+
+    def parse_table_from(t_node)
+      Elements::Containers::Table.new(t_node)
+    end
+  end
+end

data/lib/docx/elements.rb

@@ -1,3 +1,3 @@
-require 'docx/elements/bookmark'
-require 'docx/elements/element'
+require 'docx/elements/bookmark'
+require 'docx/elements/element'
 require 'docx/elements/text'

data/lib/docx/elements/text.rb

@@ -1,17 +1,17 @@
-module Docx
-  module Elements
-    class Text
-      include Element
-      delegate :content, :content=, :to => :@node
-
-      def self.tag
-        't'
-      end
-
-
-      def initialize(node)
-        @node = node
-      end
-    end
-  end
+module Docx
+  module Elements
+    class Text
+      include Element
+      delegate :content, :content=, :to => :@node
+
+      def self.tag
+        't'
+      end
+
+
+      def initialize(node)
+        @node = node
+      end
+    end
+  end
 end

data/lib/docx/version.rb

@@ -1,3 +1,3 @@
 module Docx #:nodoc:
-  VERSION = '0.2.07'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.2.07
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Christopher Hunt
@@ -13,65 +12,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: a ruby library/gem for interacting with .docx files
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: thin wrapper around rubyzip and nokogiri as a way to get started with
+  docx files
 email:
 - chrahunt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE.md
+- README.md
+- lib/docx.rb
+- lib/docx/containers.rb
 - lib/docx/containers/container.rb
 - lib/docx/containers/paragraph.rb
 - lib/docx/containers/table.rb
@@ -79,38 +101,35 @@ files:
 - lib/docx/containers/table_column.rb
 - lib/docx/containers/table_row.rb
 - lib/docx/containers/text_run.rb
-- lib/docx/containers.rb
 - lib/docx/core_ext/module.rb
 - lib/docx/document.rb
+- lib/docx/elements.rb
 - lib/docx/elements/bookmark.rb
 - lib/docx/elements/element.rb
 - lib/docx/elements/text.rb
-- lib/docx/elements.rb
 - lib/docx/version.rb
-- lib/docx.rb
 homepage: https://github.com/chrahunt/docx
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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.28
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a ruby library/gem for interacting with .docx files
 test_files: []
-has_rdoc: