docx 0.2.07 → 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d330b3e0314db11795c19864a96cfe839e9c9959211f0b1b54af5270f4157c4
+  data.tar.gz: 291e34e45c7d56185cdf5716fc15e9143b2134bea6d14102cf699e0d3cd6f8f5
+SHA512:
+  metadata.gz: cbbe86dd086c4cae691af852e596d7a416e6e08fac56ad76ba03e5d44b12285eb84391204afe3df4d53b4a2a760149a791a03efc4cc08942565d4cead0014d62
+  data.tar.gz: 107a8e8aaad25115b824812681335fb072aebad3945e3263b622105b6847c6c25abb30ca4c5cbd5753ea1b3940f27a91e6a82dc3fb7f126dcf465e18e314ed32

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

@@ -1,14 +1,37 @@
 # docx
 
+[![Gem Version](https://badge.fury.io/rb/docx.svg)](https://badge.fury.io/rb/docx)
+[![Ruby](https://github.com/ruby-docx/docx/workflows/Ruby/badge.svg)](https://github.com/ruby-docx/docx/actions?query=workflow%3ARuby)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-docx/docx/badge.svg?branch=master)](https://coveralls.io/github/ruby-docx/docx?branch=master)
+[![Gitter](https://badges.gitter.im/ruby-docx/community.svg)](https://gitter.im/ruby-docx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
 A ruby library/gem for interacting with `.docx` files. currently capabilities include reading paragraphs/bookmarks, inserting text at bookmarks, reading tables/rows/columns/cells and saving the document.
 
 ## Usage
 
+### Prerequisites
+
+- Ruby 2.5 or later
+
 ### Install
 
-Requires ruby (tested with 2.1.1)
+Add the following line to your application's Gemfile:
+
+```ruby
+gem 'docx'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
 
-    gem 'docx', '~> 0.2.07', :require => ["docx"]
+Or install it yourself as:
+
+```shell
+gem install docx
+```
 
 ### Reading
 
@@ -29,6 +52,17 @@ doc.bookmarks.each_pair do |bookmark_name, bookmark_object|
 end
 ```
 
+Don't have a local file but a buffer? Docx handles those to:
+
+```ruby
+require 'docx'
+
+# Create a Docx::Document object from a remote file
+doc = Docx::Document.open(buffer)
+
+# Everything about reading is the same as shown above
+```
+
 ### Rendering html
 ``` ruby
 require 'docx'
@@ -61,7 +95,7 @@ doc.tables.each do |table|
       puts cell.text
     end
   end
-  
+
   table.columns.each do |column| # Column-based iteration
     column.cells.each do |cell|
       puts cell.text
@@ -84,10 +118,51 @@ 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
+
+# Substitute text, preserving formatting
+doc.paragraphs.each do |p|
+  p.each_text_run do |tr|
+    tr.substitute('_placeholder_', 'replacement value')
+  end
+end
+
 # Save document to specified path
 doc.save('example-edited.docx')
 ```
 
+### Writing to tables
+
+``` ruby
+require 'docx'
+
+# Create a Docx::Document object for our existing docx file
+doc = Docx::Document.open('tables.docx')
+
+# Iterate over each table
+doc.tables.each do |table|
+  last_row = table.rows.last
+  
+  # Copy last row and insert a new one before last row
+  new_row = last_row.copy
+  new_row.insert_before(last_row)
+
+  # Substitute text in each cell of this new row
+  new_row.cells.each do |cell|
+    cell.paragraphs.each do |paragraph|
+      paragraph.each_text_run do |text|
+        text.substitute('_placeholder_', 'replacement value')
+      end
+    end
+  end
+end
+
+doc.save('tables-edited.docx')
+```
+
 ### Advanced
 
 ``` ruby

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/paragraph.rb

@@ -55,7 +55,7 @@ module Docx
 
         # Array of text runs contained within paragraph
         def text_runs
-          @node.xpath('w:r|w:hyperlink/w:r').map { |r_node| Containers::TextRun.new(r_node, @document_properties) }
+          @node.xpath('w:r|w:hyperlink').map { |r_node| Containers::TextRun.new(r_node, @document_properties) }
         end
 
         # Iterate over each text run within a paragraph

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