docxify 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2001fd538f53baaa855da323413656be06af5c3d6ad55c662a27cda494e03d8b
-  data.tar.gz: ca1ade585eb4a3e662362d7909daf2026f6069e7ede204be165fec2f542ac6a4
+  metadata.gz: 468ed63c77e6e9759f3310c7b3a45dbfb45437529d39193d4b138998f5ad065a
+  data.tar.gz: f59112b36b5d2db86eff32e74dd7184cace6fa40da156bba18eda6871914c9e5
 SHA512:
-  metadata.gz: d1dcbd60cdd20008d7f3ae06d624024d7d236ef3740e8c7b86f4a6dee052e23bb5f1a4431ef3c2c0eb4005b0b73ce1d731995f30da534778ce9ad93ad798142b
-  data.tar.gz: fec075ad3e35e7cd0d8c3d449d758d06174762734e56f2365b80d829e9dff48708c12152d253dc11d6187e779e76c71b795bc0deb5c60380a7c6299d34645471
+  metadata.gz: d9e3f0ad21d53586647982b41dd08ba72f667121ff39b2cce7c47cf1540b3e7a48e1456fbb621ecef0b96aae825d7b8ec2b4899898fd42381a9211b540335d58
+  data.tar.gz: 3ea81df4409e565b5e3bfdd6247b5f82296e9bf2334e8bad85de94f4d070754488bf47e7bcb2e6fa395a753622e14daa5d658355183c8d4a67b19063e8161e35

data/.ruby-version

@@ -0,0 +1 @@
+4.0.5

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## 0.1.10
+
+Bugfix:
+
+- `A4_PORTRAIT_HEIGHT` (and so `A4_LANDSCAPE_WIDTH`) was 15840 twips, which is US Letter's 11 inches; it is now A4's 16838, so documents using the default page size come out on A4
+- `w:orient` was written as `"portrait}"` / `"landscape}"` (stray brace), and the `orientation:` passed to `Document.new` was never written at all
+- `Document#height` reader added, so `add_page_layout` without an explicit `height:` no longer raises `NoMethodError`
+- README showed `page_width:`/`page_height:` (ignored; the options are `width:`/`height:`) and `page_layout` instead of `add_page_layout`
+
+## 0.1.9
+
+Security:
+
+- Require rubyzip 3.6+ (`~> 3.6`), fixing CVE-2026-85396 (path traversal in `Zip::Entry#extract` before rubyzip 3.4.0)
+
+Bugfix:
+
+- Entry sizes are now declared up front when writing the docx package, so rubyzip 3 no longer adds ZIP64 headers (version needed to extract 4.5) that OPC readers such as Word and Google Docs reject
+
 ## 0.1.8
 
 Bugfix:

data/README.md

@@ -19,7 +19,7 @@ gem install docxify
 ## Usage
 
 ```ruby
-@docx = DocXify::Document.new(page_width: DocXify::A4_PORTRAIT_WIDTH, page_height: DocXify::A4_PORTRAIT_HEIGHT)
+@docx = DocXify::Document.new(width: DocXify::A4_PORTRAIT_WIDTH, height: DocXify::A4_PORTRAIT_HEIGHT)
 
 @docx.default_styling font: "Serif font here", size: 14, color: "#040404"
 
@@ -41,7 +41,7 @@ gem install docxify
 
 @docx.add_page_break
 
-@docx.page_layout width: DocXify::A4_PORTRAIT_HEIGHT, height: DocXify::A4_PORTRAIT_WIDTH, orientation: :landscape
+@docx.add_page_layout width: DocXify::A4_PORTRAIT_HEIGHT, height: DocXify::A4_PORTRAIT_WIDTH, orientation: :landscape
 
 rows = []
 rows << [

data/lib/docxify/container.rb

@@ -1,3 +1,4 @@
+require "tempfile"
 require "zip"
 
 module DocXify
@@ -12,37 +13,19 @@ module DocXify
       temp_file = Tempfile.new("docxify.zip")
 
       Zip::OutputStream.open(temp_file) do |zip|
-        zip.put_next_entry "_rels/.rels"
-        zip.write DocXify::Template.top_level_rels
-
-        zip.put_next_entry "[Content_Types].xml"
-        zip.write DocXify::Template.content_types
-
-        zip.put_next_entry "word/theme/theme1.xml"
-        zip.write DocXify::Template.theme
-
-        zip.put_next_entry "word/fontTable.xml"
-        zip.write DocXify::Template.font_table
-
-        zip.put_next_entry "word/settings.xml"
-        zip.write DocXify::Template.settings
-
-        zip.put_next_entry "word/styles.xml"
-        zip.write DocXify::Template.styles
-
-        zip.put_next_entry "word/webSettings.xml"
-        zip.write DocXify::Template.web_settings
-
-        zip.put_next_entry "word/document.xml"
-        zip.write document.build_xml(self)
-
-        zip.put_next_entry "word/_rels/document.xml.rels"
-        zip.write document_xml_rels
+        write_entry zip, "_rels/.rels", DocXify::Template.top_level_rels
+        write_entry zip, "[Content_Types].xml", DocXify::Template.content_types
+        write_entry zip, "word/theme/theme1.xml", DocXify::Template.theme
+        write_entry zip, "word/fontTable.xml", DocXify::Template.font_table
+        write_entry zip, "word/settings.xml", DocXify::Template.settings
+        write_entry zip, "word/styles.xml", DocXify::Template.styles
+        write_entry zip, "word/webSettings.xml", DocXify::Template.web_settings
+        write_entry zip, "word/document.xml", document.build_xml(self)
+        write_entry zip, "word/_rels/document.xml.rels", document_xml_rels
 
         @document.relationships.each do |relation|
           if relation.is_a?(DocXify::Element::File)
-            zip.put_next_entry "word/media/#{relation.filename}"
-            zip.write relation.data
+            write_entry zip, "word/media/#{relation.filename}", relation.data
           end
         end
       end
@@ -73,5 +56,16 @@ module DocXify
       xml << "</Relationships>"
       xml
     end
+
+    private
+
+    # Word and other OPC readers reject Zip64 headers. Since rubyzip 3 defaults
+    # to Zip64 for any entry whose size is unknown while its local header is
+    # streamed out, declare the size up front (all entry data is already in
+    # memory) so entries stay in the classic zip format.
+    def write_entry(zip, name, data)
+      zip.put_next_entry Zip::Entry.new(nil, name, size: data.bytesize)
+      zip.write data
+    end
   end
 end

data/lib/docxify/document.rb

@@ -1,7 +1,7 @@
 module DocXify
   class Document
     attr_accessor :font, :size, :color, :background, :margins, :page_layout
-    attr_reader :content, :relationships, :width
+    attr_reader :content, :relationships, :width, :height
 
     def initialize(options = {})
       @content = []
@@ -51,7 +51,7 @@ module DocXify
       XML
 
       # See the note in DocXify::Element::PageLayout for why it's not just handled the same as any other element
-      @page_layout = DocXify::Element::PageLayout.new(width: @width, height: @height, orientation: @orientatation, document: self)
+      @page_layout = DocXify::Element::PageLayout.new(width: @width, height: @height, orientation: @orientation, document: self)
 
       @content.each do |element|
         if element.is_a?(DocXify::Element::PageLayout)

data/lib/docxify/element/page_layout.rb

@@ -27,7 +27,7 @@ module DocXify
       def to_s(_container = nil)
         <<~XML
           <w:sectPr>
-            <w:pgSz w:w="#{@width}" w:h="#{@height}" #{'w:orient="portrait}"' if @orientation.to_s == "portrait"} #{'w:orient="landscape}"' if @orientation.to_s == "landscape"} />
+            <w:pgSz w:w="#{@width}" w:h="#{@height}" #{'w:orient="portrait"' if @orientation.to_s == "portrait"} #{'w:orient="landscape"' if @orientation.to_s == "landscape"} />
             <w:pgMar w:bottom="#{DocXify.cm2dxa @margins[:bottom]}" w:footer="708" w:gutter="0" w:header="708" w:left="#{DocXify.cm2dxa @margins[:left]}" w:right="#{DocXify.cm2dxa @margins[:right]}" w:top="#{DocXify.cm2dxa @margins[:top]}"/>
             <w:cols w:space="708"/>
             <w:docGrid w:linePitch="360"/>

data/lib/docxify/version.rb

@@ -1,3 +1,3 @@
 module DocXify
-  VERSION = "0.1.8".freeze
+  VERSION = "0.1.10".freeze
 end

data/lib/docxify.rb

@@ -19,7 +19,7 @@ module DocXify
 
   UNITS_PER_CM = (1440 / 2.54)
   A4_PORTRAIT_WIDTH = 11_906 # cm2dxa(21)
-  A4_PORTRAIT_HEIGHT = 15_840 # cm2dxa(29.7)
+  A4_PORTRAIT_HEIGHT = 16_838 # cm2dxa(29.7)
   A4_LANDSCAPE_WIDTH = A4_PORTRAIT_HEIGHT
   A4_LANDSCAPE_HEIGHT = A4_PORTRAIT_WIDTH
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Andy Jeffries
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.6'
 description: Using a relatively simple DSL, you can generate Word DocX documents from
   Ruby.
 email:
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.md
 - README.md
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: DocXify is a gem to help you generate Word documents from Ruby.
 test_files: []