docxify 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9feb2e005b3722bb91013f2b319a93da1f7ee49cbce3d28491dc279f1a06776a
-  data.tar.gz: 792b462f78fb7c03dc73f12ef9c9ab9359e55ab09d06a3cbcf10bd65b332cac9
+  metadata.gz: '078327d60105c81b5d2408dc41a12f8938fc99ef39fc813e5313913b4fb85fe8'
+  data.tar.gz: 8a96ec54548b34768e3480db12349ed9301c5fbc0f3f5b5f470b2788805541a0
 SHA512:
-  metadata.gz: fe9457df0501983598674783c781ebf2cc8b964e540aadc90645d8a1132a62ed0a28c2cbec56931d069b2435cb5e6419cca4a7e4232afb22f0b4a08bac2687ee
-  data.tar.gz: 0a8d8fb56b6f88350885cb0afadf8100fa31b682c3bef5c1cdba90ce0c039fdb9fc2f00aa3024723c9add5bb7cc97b288378def2f0ccf4ab85287f72d4f65408
+  metadata.gz: 7891e352135d11bba98851c99733afece051a37fb283d2f576179dfd66a1a0da6e8656cd0b2d1885389b448baff183194cb0ce3e0599d468330f5b6981f4619f
+  data.tar.gz: 28098adcc6b17ca39f67c15a5dacfe63c5d1d453bd19da781b0124b9398fb534fdeae8f78597c36372aa5f2b4103e961553474c9ea14783be9a86d7161a27400

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.1.6
+
+Bugfix:
+
+- Stop additional page being added after content. Add known issue.
+
+## 0.1.5
+
+Bugfix:
+
+- Should insert image with correct aspect ratio if only one dimension is specified
+
 ## 0.1.4
 
 Bugfix:

data/README.md

@@ -90,6 +90,10 @@ The main object created by users is a `DocXify::Document`. This builds up a `@co
 
 The `render` method on a `DocXify::Document` will generate a complete `document.xml` (Word terminology not a Ruby method) by creating a template and iterating each `@content` item. It will then create a `DocXify::Container` with that `document.xml` to generate a complete Zipped DocX file, and call it's `render` method to generate an in-memory file. This is then either returned to the `render` caller, or if a file path was passed as the first attribute, then it writes it out.
 
+### Known issues
+
+The only known issue is that it doesn't like mixing and matching page orientations. If you start a document as portrait or landscape, it's fine, but it really doesn't like a single page being in a different orientation.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/foundercatalyst/docxify>.

data/lib/docxify/document.rb

@@ -8,7 +8,7 @@ module DocXify
       @relationships = []
       @width = options[:width] || A4_PORTRAIT_WIDTH
       @height = options[:height] || A4_PORTRAIT_HEIGHT
-      @orientation = options[:orientation] || :portrait
+      @orientation = options[:orientation]
       @font = options[:font] || "Times New Roman"
       @size = options[:size] || 12
       @color = options[:color] || 12

data/lib/docxify/element/file.rb

@@ -7,7 +7,7 @@ module DocXify
       JPEG_START = "\xFF\xD8".b.freeze
       JPEG_END = "\xFF\xD9".b.freeze
 
-      attr_accessor :data, :filename
+      attr_accessor :data, :filename, :width, :height
 
       def initialize(file_path_or_data)
         super()
@@ -15,16 +15,16 @@ module DocXify
       end
 
       def load_file_data(file_path_or_data)
-        if ::File.exist?(file_path_or_data)
+        if (::File.exist?(file_path_or_data) rescue false)
           file_path_or_data = ::File.read(file_path_or_data, mode: "rb")
         end
 
-        if contains_png_image?(file_path_or_data)
-          @data = file_path_or_data
-          @filename = "#{Digest::SHA1.hexdigest(@data)}.png"
-        elsif contains_jpeg_image?(file_path_or_data)
-          @data = file_path_or_data
-          @filename = "#{Digest::SHA1.hexdigest(@data)}.jpg"
+        @data = file_path_or_data
+
+        if contains_png_image?(data)
+          @filename = "#{Digest::SHA1.hexdigest(data)}.png"
+        elsif contains_jpeg_image?(data)
+          @filename = "#{Digest::SHA1.hexdigest(data)}.jpg"
         else
           raise ArgumentError.new("Unsupported file type - images must be PNG or JPEG")
         end

data/lib/docxify/element/image.rb

@@ -1,3 +1,5 @@
+require "image_size"
+
 module DocXify
   module Element
     class Image < Base
@@ -9,8 +11,25 @@ module DocXify
 
         @align = options[:align] || :left
         @after = options[:after]
-        @height_cm = options[:height_cm] || 5
-        @width_cm = options[:width_cm] || 5
+        @height_cm = options[:height_cm]
+        @width_cm = options[:width_cm]
+
+        image_size = ImageSize.new(StringIO.new(file.data))
+
+        if @height_cm.nil? || @width_cm.nil?
+          @width = image_size.width
+          @height = image_size.height
+        end
+
+        if @height_cm.nil? && @width_cm.nil?
+          @height_cm = 5
+        end
+
+        if @height_cm.nil?
+          @height_cm = @width_cm * image_size.height / image_size.width
+        elsif @width_cm.nil?
+          @width_cm = @height_cm * image_size.width / image_size.height
+        end
       end
 
       def id

data/lib/docxify/element/page_layout.rb

@@ -12,7 +12,7 @@ module DocXify
         @margins = @document.margins
         @width = options[:width] || @document&.width || DocXify::A4_PORTRAIT_WIDTH
         @height = options[:height] || @document&.height || DocXify::A4_PORTRAIT_HEIGHT
-        @orientation = options[:orientation] || :portrait
+        @orientation = options[:orientation]
       end
 
       # Don't consider this part of the public API, they're used by Document if it's been created
@@ -26,16 +26,12 @@ module DocXify
 
       def to_s(_container = nil)
         <<~XML
-          <w:p>
-            <w:pPr>
-              <w:sectPr>
-                <w:pgSz w:w="#{@width}" w:h="#{@height}" w:orient="#{@orientation}"/>
-                <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"/>
-              </w:sectPr>
-            </w:pPr>
-          </w:p>
+          <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: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"/>
+          </w:sectPr>
         XML
       end
     end

data/lib/docxify/version.rb

@@ -1,3 +1,3 @@
 module DocXify
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.6".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Andy Jeffries
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: image_size
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: DocXify is a gem to help you generate Word documents from Ruby.