docx 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd59a023e1430fce917809931fe955651324db4fadb7a55d9a380731240466e
-  data.tar.gz: eb91759397bdc0782691c6ed46b37a67a031ab580d590568a7f221a223d2f80c
+  metadata.gz: 96b871b0d07fecde4e6c93c67463da727565f3acca519b08b9c554d987570e58
+  data.tar.gz: 2f3b9362b91c33d02e6c1b4acf0b23fb723f71d26f9b2e800b930c91c3687eee
 SHA512:
-  metadata.gz: c722c427338ceb1f4d8c926c4e3b2a8c2b2de9889e77a9b78fec4ffe2270b633dfd8f843a31ed17a77b6b5d09d9e9d8b4c88e52569b3c410d1f8ae9183c76c6d
-  data.tar.gz: 41af211af034071991a920f1ed00e9ee9c8e5e739f41553c8b263081e7626183bc21e38735bfed88f01fdea0599f13a313cfc0ea1f9cc8331edff97e5cd5c40d
+  metadata.gz: 5e198cb74eb7a06b62bb63a3a0ff065b0c95cf26aafb53320bb5b14339dc386d975a1f57178316d1d5d7753081e07989b4498bcdfa3f0092f2fc14b1e4086b84
+  data.tar.gz: d0626b7332fd3a3d95b6358a3fb6ea09b0faf58545db9bd948c9f97baa5457eacb43267cc40914df2fa54872b42cca5c1963f66111a8b0b4be33a3e6f99c4b38

data/README.md

@@ -1,7 +1,7 @@
 # docx
 
 [![Gem Version](https://badge.fury.io/rb/docx.svg)](https://badge.fury.io/rb/docx)
-[![Build Status](https://travis-ci.org/ruby-docx/docx.svg?branch=master)](https://travis-ci.org/ruby-docx/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)
 
@@ -11,7 +11,7 @@ A ruby library/gem for interacting with `.docx` files. currently capabilities in
 
 ### Prerequisites
 
-- Ruby 2.4 or later
+- Ruby 2.5 or later
 
 ### Install
 
@@ -134,6 +134,35 @@ end
 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/text_run.rb

@@ -12,14 +12,14 @@ module Docx
           bold:      false,
           underline: false
         }
-        
+
         def self.tag
           'r'
         end
 
         attr_reader :text
         attr_reader :formatting
-        
+
         def initialize(node, document_properties = {})
           @node = node
           @text_nodes = @node.xpath('w:t').map {|t_node| Elements::Text.new(t_node) }
@@ -40,6 +40,7 @@ module Docx
             new_t = Elements::Text.create_within(self)
             new_t.content = content
           end
+          reset_text
         end
 
         # Returns text contained within text run
@@ -52,6 +53,7 @@ module Docx
           @text_nodes.each do |text_node|
             text_node.content = text_node.content.gsub(match, replacement)
           end
+          reset_text
         end
 
         def parse_formatting
@@ -74,7 +76,7 @@ module Docx
           styles = {}
           styles['text-decoration'] = 'underline' if underlined?
           # No need to be granular with font size down to the span level if it doesn't vary.
-          styles['font-size'] = "#{font_size}pt" if font_size != @font_size 
+          styles['font-size'] = "#{font_size}pt" if font_size != @font_size
           html = html_tag(:span, content: html, styles: styles) unless styles.empty?
           html = html_tag(:a, content: html, attributes: {href: href, target: "_blank"}) if hyperlink?
           return html
@@ -83,11 +85,11 @@ module Docx
         def italicized?
           @formatting[:italic]
         end
-        
+
         def bolded?
           @formatting[:bold]
         end
-        
+
         def underlined?
           @formatting[:underline]
         end
@@ -102,12 +104,18 @@ module Docx
 
         def hyperlink_id
           @node.attributes['id'].value
-        end        
+        end
 
         def font_size
           size_tag = @node.xpath('w:rPr//w:sz').first
           size_tag ? size_tag.attributes['val'].value.to_i / 2 : @font_size
         end
+
+        private
+
+        def reset_text
+          @text = parse_text
+        end
       end
     end
   end

data/lib/docx/document.rb

@@ -30,8 +30,7 @@ module Docx
         @zip = Zip::File.open_buffer(path_or_io)
       end
 
-      document = @zip.find_entry('word/document.xml')
-      document ||= @zip.find_entry('word/document2.xml')
+      document = @zip.glob('word/document*.xml').first
       raise Errno::ENOENT if document.nil?
 
       @document_xml = document.get_input_stream.read
@@ -71,6 +70,10 @@ module Docx
       bkmrks_hsh
     end
 
+    def to_xml
+      Nokogiri::XML(@document_xml)
+    end
+
     def tables
       @doc.xpath('//w:document//w:body//w:tbl').map { |t_node| parse_table_from t_node }
     end
@@ -88,12 +91,12 @@ module Docx
     def hyperlinks
       hyperlink_relationships.each_with_object({}) do |rel, hash|
         hash[rel.attributes['Id'].value] = rel.attributes['Target'].value
-      end 
+      end
     end
 
     def hyperlink_relationships
       @rels.xpath("//xmlns:Relationship[contains(@Type,'hyperlink')]")
-    end    
+    end
 
     ##
     # *Deprecated*
@@ -169,13 +172,20 @@ module Docx
     def load_styles
       @styles_xml = @zip.read('word/styles.xml')
       @styles = Nokogiri::XML(@styles_xml)
-      @rels_xml = @zip.read('word/_rels/document.xml.rels')
-      @rels = Nokogiri::XML(@rels_xml)
+      load_rels
     rescue Errno::ENOENT => e
       warn e.message
       nil
     end
 
+    def load_rels
+      rels_entry = @zip.glob('word/_rels/document*.xml.rels').first
+      raise Errno::ENOENT unless rels_entry
+
+      @rels_xml = rels_entry.get_input_stream.read
+      @rels = Nokogiri::XML(@rels_xml)
+    end
+
     #--
     # 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

data/lib/docx/elements/element.rb

@@ -91,7 +91,7 @@ module Docx
       module ClassMethods
         def create_with(element)
           # Need to somehow get the xml document accessible here by default, but this is alright in the interim
-          self.new(Nokogiri::XML::Node.new("w:#{self.tag}", element.node))
+          self.new(Nokogiri::XML::Node.new("w:#{self.tag}", element.node.document))
         end
 
         def create_within(element)

data/lib/docx/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Docx #:nodoc:
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Christopher Hunt
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -20,20 +20,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.4
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -49,19 +49,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: a ruby library/gem for interacting with .docx files