docx 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16df363293a0fcb4945e4ab7aa968f7138f2d0e38d25bcf689a5c5142279e520
-  data.tar.gz: '089d8ef9c78a7ae13d980d3a78ce729b05fe6dff1fefe8bbdfe4488a6b7b0f91'
+  metadata.gz: d639e88e5950b94157fc4f81b14f0f8bf355abb4fdedd24b7f40dc00eafb72d7
+  data.tar.gz: e64400d25d919b4cd51f4b876d7f35c3433841523055866dff2c300f7c15aca7
 SHA512:
-  metadata.gz: 8a23b154632578c3a702d3e16b6bbc3d763f062860ea9cf8db6c6814e89c1e7d99073fa28b7f90276c883d5c1f47be9d688d6f05177c06dbfc3bc452ccadc371
-  data.tar.gz: a8a735936caad5c75f56cace55e980df01bb25af795d5b8d040b735b14510898b220da3b8f40c52b74c68dc371c9a2d25bc2791d44a54a74dde9db727d3432ae
+  metadata.gz: d2ad2931111374349dd03ca04bef655a9eaa797b84d688198ebeac84cdf93af147d4f8fd5a561c4e506d7f823c9b22884c698a315d7e2bb505357c7c6da9316a
+  data.tar.gz: 25cb0bc5f3b67b4af1874b902fbdfe3061205cee0c8b288187924b80cb50a6bd5a7076ea497be702a07241841da146055b3be0dbffeb90c20922f851ad31588c

data/README.md

@@ -154,6 +154,15 @@ doc.paragraphs.each do |p|
   end
 end
 
+# Substitute a placeholder even when Word has split it across several runs
+# (e.g. "{{first_name}}" stored as "{{fi", "rst_na", "me}}"). Paragraph#substitute
+# matches across run boundaries, where the per-run TextRun#substitute above cannot.
+# Accepts a String or a Regexp (capture-group backreferences work in the replacement).
+doc.paragraphs.each do |p|
+  p.substitute('{{first_name}}', 'Jane')
+  p.substitute(/\{\{(\w+)\}\}/, 'value of \1')
+end
+
 # Substitute text with access to captures, note block arg is a MatchData, a bit
 # different than String.gsub. https://ruby-doc.org/3.3.7/MatchData.html
 doc.paragraphs.each do |p|

data/lib/docx/containers/paragraph.rb

@@ -65,6 +65,59 @@ module Docx
           text_runs.each { |tr| yield(tr) }
         end
 
+        # Substitute text within the paragraph, even when a match spans multiple
+        # text runs (e.g. a "{{placeholder}}" that Word split across several runs,
+        # such as "{{fi", "rst_na", "me}}"). The per-run TextRun#substitute cannot
+        # match those, but this can, because it joins the runs first.
+        #
+        # The matched region is collapsed into the first run it touches, so that
+        # run's formatting is kept while the other spanned runs are emptied; runs
+        # outside the match are left untouched.
+        #
+        # +pattern+ may be a String or a Regexp; +replacement+ follows String#sub
+        # semantics, so capture-group backreferences (e.g. '\1') work with a Regexp.
+        #
+        #   # given a paragraph reading "Hello {{first_name}}!"
+        #   paragraph.substitute('{{first_name}}', 'Jane')   # => "Hello Jane!"
+        #   paragraph.substitute(/\{\{(\w+)\}\}/, 'value of \1')
+        #
+        # See https://github.com/ruby-docx/docx/issues/147
+        def substitute(pattern, replacement)
+          search_from = 0
+          loop do
+            runs = text_runs
+            break if runs.empty?
+
+            offsets = []
+            cursor = 0
+            runs.each do |run|
+              offsets << cursor
+              cursor += run.text.length
+            end
+            full_text = runs.map(&:text).join
+
+            match = full_text.match(pattern, search_from)
+            break unless match
+            break if match.end(0) == match.begin(0) # ignore empty matches
+
+            match_start = match.begin(0)
+            match_end   = match.end(0) # exclusive
+            first = offsets.rindex { |offset| offset <= match_start }
+            last  = offsets.rindex { |offset| offset < match_end }
+
+            combined = runs[first..last].map(&:text).join
+            local_start = match_start - offsets[first]
+            local_end   = match_end - offsets[first]
+            replaced = combined[local_start...local_end].sub(pattern, replacement)
+            runs[first].text = combined[0...local_start] + replaced + combined[local_end..-1]
+            ((first + 1)..last).each { |index| runs[index].text = '' }
+
+            # advance past the inserted replacement so it is not re-matched
+            search_from = match_start + replaced.length
+          end
+          self
+        end
+
         def aligned_left?
           ['left', nil].include?(alignment)
         end
@@ -87,7 +140,7 @@ module Docx
 
         def font_color
           color_tag = @node.xpath('w:r//w:rPr//w:color').first
-          color_tag ? color_tag.attributes['val'].value : nil
+          color_tag ? color_tag.attributes['val']&.value : nil
         end
 
         def style

data/lib/docx/containers/table.rb

@@ -13,14 +13,16 @@ module Docx
           'tbl'
         end
 
-        def initialize(node)
+        def initialize(node, document_properties = {}, doc = nil)
           @node = node
           @properties_tag = 'tblGrid'
+          @document_properties = document_properties
+          @document = doc
         end
 
         # Array of row
         def rows
-          @node.xpath('w:tr').map {|r_node| Containers::TableRow.new(r_node) }
+          @node.xpath('w:tr').map {|r_node| Containers::TableRow.new(r_node, @document_properties, @document) }
         end
 
         def row_count
@@ -31,7 +33,7 @@ module Docx
         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}]")
+            columns_containers[i] = Containers::TableColumn.new(@node.xpath("w:tr//w:tc[#{i+1}]"), @document_properties, @document)
           end
           columns_containers
         end

data/lib/docx/containers/table_cell.rb

@@ -12,9 +12,11 @@ module Docx
           'tc'
         end
 
-        def initialize(node)
+        def initialize(node, document_properties = {}, doc = nil)
           @node = node
           @properties_tag = 'tcPr'
+          @document_properties = document_properties
+          @document = doc
         end
 
         # Return text of paragraph's cell
@@ -24,7 +26,7 @@ module Docx
 
         # Array of paragraphs contained within cell
         def paragraphs
-          @node.xpath('w:p').map {|p_node| Containers::Paragraph.new(p_node) }
+          @node.xpath('w:p').map {|p_node| Containers::Paragraph.new(p_node, @document_properties, @document) }
         end
 
         # Iterate over each text run within a paragraph's cell

data/lib/docx/containers/table_column.rb

@@ -12,10 +12,12 @@ module Docx
           'w:gridCol'
         end
 
-        def initialize(cell_nodes)
+        def initialize(cell_nodes, document_properties = {}, doc = nil)
           @node = ''
           @properties_tag = ''
-          @cells = cell_nodes.map { |c_node| Containers::TableCell.new(c_node) }
+          @document_properties = document_properties
+          @document = doc
+          @cells = cell_nodes.map { |c_node| Containers::TableCell.new(c_node, @document_properties, @document) }
         end
 
         # Array of cells contained within row

data/lib/docx/containers/table_row.rb

@@ -12,14 +12,16 @@ module Docx
           'tr'
         end
 
-        def initialize(node)
+        def initialize(node, document_properties = {}, doc = nil)
           @node = node
           @properties_tag = ''
+          @document_properties = document_properties
+          @document = doc
         end
 
         # Array of cells contained within row
         def cells
-          @node.xpath('w:tc').map {|c_node| Containers::TableCell.new(c_node) }
+          @node.xpath('w:tc').map {|c_node| Containers::TableCell.new(c_node, @document_properties, @document) }
         end
         
       end

data/lib/docx/containers/text_run.rb

@@ -40,6 +40,7 @@ module Docx
           elsif @text_nodes.empty?
             new_t = Elements::Text.create_within(self)
             new_t.content = content
+            @text_nodes << new_t
           end
           reset_text
         end

data/lib/docx/document.rb

@@ -27,6 +27,9 @@ module Docx
     def initialize(path_or_io, options = {})
       @replace = {}
 
+      # accept path-like objects (e.g. Pathname, File) by using their path (#101)
+      path_or_io = path_or_io.to_path if path_or_io.respond_to?(:to_path)
+
       # if path-or_io is string && does not contain a null byte
       if (path_or_io.instance_of?(String) && !/\u0000/.match?(path_or_io))
         @zip = Zip::File.open(path_or_io)
@@ -40,6 +43,7 @@ module Docx
       @document_xml = document.get_input_stream.read
       @doc = Nokogiri::XML(@document_xml)
       load_styles
+      load_rels
       load_headers
       load_footers
       yield(self) if block_given?
@@ -100,11 +104,18 @@ module Docx
     # Hyperlink targets are extracted from the document.xml.rels file
     def hyperlinks
       hyperlink_relationships.each_with_object({}) do |rel, hash|
-        hash[rel.attributes['Id'].value] = rel.attributes['Target'].value
+        id = rel.attributes['Id']
+        target = rel.attributes['Target']
+        next unless id && target
+
+        hash[id.value] = target.value
       end
     end
 
     def hyperlink_relationships
+      # @rels is nil when the document has no relationships part (#192)
+      return Nokogiri::XML::NodeSet.new(Nokogiri::XML::Document.new) unless @rels
+
       @rels.xpath("//xmlns:Relationship[contains(@Type,'hyperlink')]")
     end
 
@@ -180,7 +191,7 @@ module Docx
     end
 
     def default_paragraph_style
-      @styles.at_xpath("w:styles/w:style[@w:type='paragraph' and @w:default='1']/w:name/@w:val").value
+      @styles&.at_xpath("w:styles/w:style[@w:type='paragraph' and @w:default='1']/w:name/@w:val")&.value
     end
 
     def style_name_of(style_id)
@@ -226,18 +237,22 @@ module Docx
     def load_styles
       @styles_xml = @zip.read('word/styles.xml')
       @styles = Nokogiri::XML(@styles_xml)
-      load_rels
     rescue Errno::ENOENT => e
       warn e.message
       nil
     end
 
+    # Loaded independently of styles so that a document without word/styles.xml
+    # still initializes @rels (see #158).
     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)
+    rescue Errno::ENOENT => e
+      warn e.message
+      nil
     end
 
     #--
@@ -267,7 +282,7 @@ module Docx
     end
 
     def parse_table_from(t_node)
-      Elements::Containers::Table.new(t_node)
+      Elements::Containers::Table.new(t_node, document_properties, self)
     end
   end
 end

data/lib/docx/elements/bookmark.rb

@@ -51,28 +51,92 @@ module Docx
 
       # Get text run immediately prior to bookmark node
       def get_run_before
-        # at_xpath returns the first match found and preceding-sibling returns siblings in the
-        # order they appear in the document not the order as they appear when moving out from
-        # the starting node
-        if not (r_nodes = @node.xpath("./preceding-sibling::w:r")).empty?
-          r_node = r_nodes.last
-          Containers::TextRun.new(r_node)
-        else
+        if enclosing_paragraph
+          # at_xpath returns the first match found and preceding-sibling returns siblings in the
+          # order they appear in the document not the order as they appear when moving out from
+          # the starting node
+          unless (r_nodes = @node.xpath("./preceding-sibling::w:r")).empty?
+            return Containers::TextRun.new(r_nodes.last)
+          end
+
           new_r = Containers::TextRun.create_with(self)
           new_r.insert_before(self)
-          new_r
+          return new_r
         end
+
+        # Block-level bookmark (e.g. Google Docs places bookmarkStart/End directly
+        # under w:body). Add a run to the preceding paragraph, or to a new
+        # paragraph before the bookmark, so the run lives inside a w:p.
+        run_at_paragraph_end(@node.xpath("./preceding-sibling::w:p").last) ||
+          run_in_new_paragraph { |paragraph| @node.add_previous_sibling(paragraph) }
       end
 
       # Get text run immediately after bookmark node
       def get_run_after
-        if (r_node = @node.at_xpath("./following-sibling::w:r"))
-          Containers::TextRun.new(r_node)
-        else
+        if enclosing_paragraph
+          if (r_node = @node.at_xpath("./following-sibling::w:r"))
+            return Containers::TextRun.new(r_node)
+          end
+
           new_r = Containers::TextRun.create_with(self)
           new_r.insert_after(self)
-          new_r
+          return new_r
+        end
+
+        # Block-level bookmark: add a run to the following paragraph, or to a new
+        # paragraph after the bookmark.
+        run_at_paragraph_start(@node.at_xpath("./following-sibling::w:p")) ||
+          run_in_new_paragraph { |paragraph| @node.add_next_sibling(paragraph) }
+      end
+
+      # Override Element#parent_paragraph so insert_multiple_lines also works for
+      # block-level bookmarks. For those we fill a fresh paragraph inserted at the
+      # bookmark, rather than an adjacent existing paragraph, so we neither crash
+      # (no enclosing paragraph) nor overwrite unrelated content.
+      def parent_paragraph
+        return Containers::Paragraph.new(enclosing_paragraph) if enclosing_paragraph
+
+        paragraph = Nokogiri::XML::Node.new("w:p", @node.document)
+        @node.add_next_sibling(paragraph)
+        Containers::Paragraph.new(paragraph)
+      end
+
+      private
+
+      # The w:p the bookmark sits inside, or nil when it is block-level.
+      def enclosing_paragraph
+        @node.at_xpath("./parent::w:p")
+      end
+
+      # A new run inserted at the start of paragraph_node (after w:pPr if present).
+      # Returns nil when paragraph_node is nil.
+      def run_at_paragraph_start(paragraph_node)
+        return nil unless paragraph_node
+
+        new_r = Containers::TextRun.create_with(self)
+        if (props = paragraph_node.at_xpath("w:pPr"))
+          props.add_next_sibling(new_r.node)
+        else
+          paragraph_node.prepend_child(new_r.node)
         end
+        new_r
+      end
+
+      # A new run appended to the end of paragraph_node. nil when it is nil.
+      def run_at_paragraph_end(paragraph_node)
+        return nil unless paragraph_node
+
+        Containers::TextRun.create_within(Containers::Paragraph.new(paragraph_node))
+      end
+
+      # Create a run wrapped in a fresh w:p; the block positions that paragraph
+      # relative to the bookmark.
+      def run_in_new_paragraph
+        new_r = Containers::TextRun.create_with(self)
+        paragraph = Nokogiri::XML::Node.new("w:p", @node.document)
+        paragraph.add_child(new_r.node)
+        yield paragraph
+        new_r
       end
     end
   end

data/lib/docx/elements/element.rb

@@ -42,7 +42,8 @@ module Docx
 
       # Insert node as first child (after properties)
       def prepend_to(element)
-        @node = element.node.properties.add_next_sibling(@node)
+        properties = element.properties if element.respond_to?(:properties)
+        @node = properties ? properties.add_next_sibling(@node) : element.node.prepend_child(@node)
         self
       end
 

data/lib/docx/helpers.rb

@@ -4,7 +4,7 @@ module Docx
     # than the default inspect method. But you can still get the default inspect method by passing
     # true as the first argument.
     def inspect(full = false)
-      return(super) if full
+      return super() if full
 
       variable_values =
         instance_variables.map do |var|

data/lib/docx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docx #:nodoc:
-  VERSION = '0.12.0'
+  VERSION = '0.13.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Christopher Hunt