docx 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f170295a0362d6fcbbe6313ddd9f3ccf50379eb220ab52b26caee581786471a4
-  data.tar.gz: f6050fc0a2959392184da37012e0a2efcb5290f8bb1d015510e9dd52abf71ee7
+  metadata.gz: 00fd317c3d0d2f4ee4aafddd30ff41f29830f23c2e5f913c114cbc95b2bb58d1
+  data.tar.gz: 0ad6844aeb26d84f5275f86c43bb592f821be2541e797fa1318416dd20e77bf1
 SHA512:
-  metadata.gz: de8c52dced6b5d95b7fa3d34ab8c124ce5e1539fc5874fac1b5a71d31c3f7c46af7b27cc53bd89960f122a01a5a36372825f91acd8c1d0cae715f7380a2b7625
-  data.tar.gz: bb39bab159ac4f5ccec77ddd3c64bd9a1a8863f80a948c7d963cfde2e6904ecc112f2c4c79e080dbfc37b2580ecc37ab4249c0d303f945a02ccae432a33671fc
+  metadata.gz: 32e693b1114347678865a0b5f409a745e1f4a3a195ef70d2ab6cc255022abaad79b3bed9dd66426746b2b207ab176af19178207c4e2e6af790cd8213575ee605
+  data.tar.gz: 438dbbb6ca717e985c80f0ff4eca824c44fd1d2c94832b40121fb4423e6bf59389b03dce6d66b2f6bbbf9715e68df62c9db3db8e5a4cc60772b7cd1cdd95983d

data/README.md

@@ -52,7 +52,7 @@ doc.bookmarks.each_pair do |bookmark_name, bookmark_object|
 end
 ```
 
-Don't have a local file but a buffer? Docx handles those to:
+Don't have a local file but a buffer? Docx handles those too:
 
 ```ruby
 require 'docx'
@@ -130,6 +130,14 @@ doc.paragraphs.each do |p|
   end
 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|
+  p.each_text_run do |tr|
+    tr.substitute_with_block(/total: (\d+)/) { |match_data| "total: #{match_data[1].to_i * 10}" }
+  end
+end
+
 # Save document to specified path
 doc.save('example-edited.docx')
 ```
@@ -145,7 +153,7 @@ 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)
@@ -261,3 +269,4 @@ The following is a list of attributes and what they control within the style.
 * Default formatting of inserted elements to inherited values
 * Implement formattable elements.
 * Easier multi-line text insertion at a single bookmark (inserting paragraph nodes after the one containing the bookmark)
+

data/lib/docx/containers/text_run.rb

@@ -57,6 +57,19 @@ module Docx
           reset_text
         end
 
+        # Weird things with how $1/$2 in regex blocks are handled means we can't just delegate
+        # block to gsub to get block, we have to do it this way, with a block that gets a MatchData,
+        # from which captures and other match data can be retrieved.
+        # https://ruby-doc.org/3.3.7/MatchData.html
+        def substitute_with_block(match, &block)
+          @text_nodes.each do |text_node|
+            text_node.content = text_node.content.gsub(match) { |_unused_matched_string|
+              block.call(Regexp.last_match)
+            }
+          end
+          reset_text
+        end
+
         def parse_formatting
           {
             italic:    !@node.xpath('.//w:i').empty?,

data/lib/docx/document.rb

@@ -128,40 +128,44 @@ module Docx
     # call-seq:
     #   save(filepath) => void
     def save(path)
-      update
-      Zip::OutputStream.open(path) do |out|
-        zip.each do |entry|
-          next unless entry.file?
+      with_zip64_disabled do
+        update
+        Zip::OutputStream.open(path) do |out|
+          zip.each do |entry|
+            next unless entry.file?
 
-          out.put_next_entry(entry.name)
-          value = @replace[entry.name] || zip.read(entry.name)
+            out.put_next_entry(entry.name)
+            value = @replace[entry.name] || zip.read(entry.name)
 
-          out.write(value)
-        end
+            out.write(value)
+          end
 
+        end
+        zip.close
       end
-      zip.close
     end
 
     # Output entire document as a StringIO object
     def stream
-      update
-      stream = Zip::OutputStream.write_buffer do |out|
-        zip.each do |entry|
-          next unless entry.file?
-
-          out.put_next_entry(entry.name)
-
-          if @replace[entry.name]
-            out.write(@replace[entry.name])
-          else
-            out.write(zip.read(entry.name))
+      with_zip64_disabled do
+        update
+        stream = Zip::OutputStream.write_buffer do |out|
+          zip.each do |entry|
+            next unless entry.file?
+
+            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
-      end
 
-      stream.rewind
-      stream
+        stream.rewind
+        stream
+      end
     end
 
     alias text to_s
@@ -184,6 +188,18 @@ module Docx
 
     private
 
+    # rubyzip 3.x enables ZIP64 by default, which breaks readers (e.g. pandoc)
+    # that don't support it for small files (issue #168). Disable ZIP64 only
+    # while writing, and restore the previous global value afterwards so we
+    # don't affect other rubyzip users in the consuming application.
+    def with_zip64_disabled
+      previous = Zip.write_zip64_support
+      Zip.write_zip64_support = false
+      yield
+    ensure
+      Zip.write_zip64_support = previous
+    end
+
     def load_styles
       @styles_xml = @zip.read('word/styles.xml')
       @styles = Nokogiri::XML(@styles_xml)

data/lib/docx/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docx
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Christopher Hunt
@@ -11,7 +11,7 @@ authors:
 - Sebastian Wittenkamp
 bindir: bin
 cert_chain: []
-date: 2025-05-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -37,16 +37,22 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: a ruby library/gem for interacting with .docx files
 test_files: []