standard-procedure-consolidate 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a7f02d5159a44a47af30100fe1743b2b5bff5ab845a0da2170ffaf44302f03
-  data.tar.gz: b041806b3d682a4c5ccc0011025a1d3d5b25a7c1a65fda56e9b3fcce34b364a9
+  metadata.gz: 81a63ebba28600dbc0e124ab27e8c6cf150f8dafc80942a12c5e22691bbf8b88
+  data.tar.gz: cbfad371ee9b13baa9eb1fd8aefa9aecf8e1979d581e9b490df7ebdf01706ec3
 SHA512:
-  metadata.gz: 2bc84355758ef68cd525c684fe1ef6973858eb3ba360f4a37a026cc54a11c9eb143cc364bd034cdd4452bec75a91a768b7f96ccbb727039da5e6ba727fb643bd
-  data.tar.gz: b8061eb3ff1a61deb3c1b153be11d9c5b416be6a576d559c0846236a1e8dabdf9dcf339f33479e39589d3c247930cb28d437a360becbe5e498e90b99eb26ffea
+  metadata.gz: 856086986d7a075cefe919716d039481ac80480ee169b00d6038d9aeef751338daf4fab90889c96fbd00d183708fa610c450df3d14f704aa9c6d515f5a1a5b54
+  data.tar.gz: ef54556ae1258cf20b08a3a519c1744f6010d80c955e3d26469bf2710a76b2ddf70734c4fe9d76920ab06ca8fbc0d08741a7b2f2dfdf5a0f1769524dcc642b3d

data/checksums/standard-procedure-consolidate-0.4.4.gem.sha512

@@ -0,0 +1 @@
+c1a13d3d2b2c50741b839e2ca20c730b2689fac090e9c67660950a506ce83b3b9e07e31f3de205ec67dcbf4b1eff462f8fc507468fdb378e864e9a5952b9decf

data/checksums/standard-procedure-consolidate-0.4.5.gem.sha512

@@ -0,0 +1 @@
+cb04bbf111020966f8acc5dbe0b4d8917d4b6603e6dae83afc15d81e1c9c9163072d3ba7c177a2a0a127d9dc4a5d2e3a5f7177d957bb02e4411ec7301587106b

data/lib/consolidate/docx/image.rb

@@ -2,7 +2,6 @@
 
 require "zip"
 require "nokogiri"
-
 module Consolidate
   module Docx
     class Image < SimpleDelegator
@@ -12,21 +11,26 @@ module Consolidate
       # Path to use when storing this image within the docx
       def storage_path = "word/#{media_path}"
 
-      # Convert width from pixels to EMU
-      def width = super * emu_per_width_pixel
+      # Convert width from pixels to EMU with proper DPI scaling
+      def width_in_emu = width * emu_per_width_pixel
 
-      # Convert height from pixels to EMU
-      def height = super * emu_per_height_pixel
+      # Convert height from pixels to EMU with proper DPI scaling
+      def height_in_emu = height * emu_per_height_pixel
 
-      # Get the width of this image in EMU up to a maximum page width (also in EMU)
-      def clamped_width(maximum = 7_772_400) = [width, maximum].min
+      def emu_per_width_pixel = EMU_PER_PIXEL * 72 / dpi[:x]
 
-      # Get the height of this image in EMU adjusted for a maximum page width (also in EMU)
-      def clamped_height(maximum = 7_772_400) = (height * clamped_width(maximum).to_f / width.to_f).to_i
+      def emu_per_height_pixel = EMU_PER_PIXEL * 72 / dpi[:y]
 
-      def emu_per_width_pixel = 914_400 / dpi[:x]
+      # Constants
+      DEFAULT_PAGE_WIDTH = 12_240
+      TWENTIETHS_OF_A_POINT_TO_EMU = 635
+      DEFAULT_PAGE_WIDTH_IN_EMU = DEFAULT_PAGE_WIDTH * TWENTIETHS_OF_A_POINT_TO_EMU
+      EMU_PER_PIXEL = 9525
+      DEFAULT_PAGE_HEIGHT = DEFAULT_PAGE_WIDTH * 11 / 8.5 # Assuming US Letter size
+      DEFAULT_PAGE_HEIGHT_IN_EMU = DEFAULT_PAGE_HEIGHT * TWENTIETHS_OF_A_POINT_TO_EMU
 
-      def emu_per_height_pixel = 914_400 / dpi[:y]
+      # Common page margins in EMU (0.75 inches)
+      DEFAULT_MARGIN_IN_EMU = 685800
     end
   end
 end

data/lib/consolidate/docx/image_reference_node_builder.rb

@@ -2,148 +2,202 @@
 
 require "zip"
 require "nokogiri"
-
+# To test image scaling manually, from the console:
+# Consolidate::Docx::Merge.open "spec/files/logo-doc.docx" do |doc|
+#   doc.data logo_image: Consolidate::Image.new(name: "logo.png", width: 4096, height: 1122, path: "spec/files/logo.png")
+#   doc.write_to "tmp/doc-with-logos.docx"
+# end
 module Consolidate
   module Docx
     class ImageReferenceNodeBuilder < Data.define(:field_name, :image, :node_id, :image_number, :document)
       def call
-        max_width, max_height = max_dimensions_from(document)
-        scaled_width, scaled_height = scale_dimensions(image.width, image.height, max_width, max_height)
+        usable_width, usable_height = usable_dimensions_from(document)
+        scaled_width, scaled_height = scale_dimensions(image.width_in_emu, image.height_in_emu, usable_width, usable_height)
 
         Nokogiri::XML::Node.new("w:drawing", document).tap do |drawing|
           drawing["xmlns:a"] = "http://schemas.openxmlformats.org/drawingml/2006/main"
-          drawing << Nokogiri::XML::Node.new("wp:anchor", document).tap do |anchor|
-            anchor["behindDoc"] = "0"
-            anchor["distT"] = "0"
-            anchor["distB"] = "0"
-            anchor["distL"] = "0"
-            anchor["distR"] = "0"
-            anchor["simplePos"] = "0"
-            anchor["locked"] = "0"
-            anchor["layoutInCell"] = "0"
-            anchor["allowOverlap"] = "1"
-            anchor["relativeHeight"] = "2"
-            anchor << Nokogiri::XML::Node.new("wp:simplePos", document).tap do |pos|
-              pos["x"] = "0"
-              pos["y"] = "0"
-            end
-            anchor << Nokogiri::XML::Node.new("wp:positionH", document).tap do |posh|
-              posh["relativeFrom"] = "column"
-              posh << Nokogiri::XML::Node.new("wp:align", document).tap do |align|
-                align.content = "center"
-              end
-            end
-            anchor << Nokogiri::XML::Node.new("wp:positionV", document).tap do |posv|
-              posv["relativeFrom"] = "paragraph"
-              posv << Nokogiri::XML::Node.new("wp:posOffset", document).tap do |offset|
-                offset.content = "635"
-              end
-            end
-            anchor << Nokogiri::XML::Node.new("wp:extent", document).tap do |extent|
-              extent["cx"] = scaled_width
-              extent["cy"] = scaled_height
-            end
-            anchor << Nokogiri::XML::Node.new("wp:effectExtent", document).tap do |effect_extent|
-              effect_extent["l"] = "0"
-              effect_extent["t"] = "0"
-              effect_extent["r"] = "0"
-              effect_extent["b"] = "0"
-            end
-            anchor << Nokogiri::XML::Node.new("wp:wrapSquare", document).tap do |wrap_square|
-              wrap_square["wrapText"] = "largest"
-            end
-            anchor << Nokogiri::XML::Node.new("wp:docPr", document).tap do |doc_pr|
-              doc_pr["id"] = image_number
-              doc_pr["name"] = image.name
-              doc_pr["descr"] = ""
-              doc_pr["title"] = ""
+          drawing << create_inline_node(scaled_width, scaled_height)
+        end
+      rescue => ex
+        puts ex.backtrace
+      end
+
+      private def create_inline_node(scaled_width, scaled_height)
+        Nokogiri::XML::Node.new("wp:inline", document).tap do |inline|
+          # Set the inline properties
+          inline["distT"] = "0"
+          inline["distB"] = "0"
+          inline["distL"] = "0"
+          inline["distR"] = "0"
+
+          # Size node (extent)
+          inline << Nokogiri::XML::Node.new("wp:extent", document).tap do |extent|
+            extent["cx"] = scaled_width
+            extent["cy"] = scaled_height
+          end
+
+          # Effect extent
+          inline << create_effect_extent_node
+
+          # Document properties
+          inline << create_doc_properties_node
+
+          # Non-visual properties
+          inline << create_non_visual_properties_node
+
+          # Graphic node
+          inline << create_graphic_node(scaled_width, scaled_height)
+        end
+      end
+
+      private def create_effect_extent_node
+        Nokogiri::XML::Node.new("wp:effectExtent", document).tap do |effect_extent|
+          effect_extent["l"] = "0"
+          effect_extent["t"] = "0"
+          effect_extent["r"] = "0"
+          effect_extent["b"] = "0"
+        end
+      end
+
+      private def create_doc_properties_node
+        Nokogiri::XML::Node.new("wp:docPr", document).tap do |doc_pr|
+          doc_pr["id"] = image_number
+          doc_pr["name"] = image.name
+          doc_pr["descr"] = image.name
+        end
+      end
+
+      private def create_non_visual_properties_node
+        Nokogiri::XML::Node.new("wp:cNvGraphicFramePr", document).tap do |c_nv_graphic_frame_pr|
+          c_nv_graphic_frame_pr << Nokogiri::XML::Node.new("a:graphicFrameLocks", document).tap do |graphic_frame_locks|
+            graphic_frame_locks["noChangeAspect"] = "1"
+          end
+        end
+      end
+
+      private def create_graphic_node(scaled_width, scaled_height)
+        Nokogiri::XML::Node.new("a:graphic", document).tap do |graphic|
+          graphic["xmlns:a"] = "http://schemas.openxmlformats.org/drawingml/2006/main"
+          graphic << Nokogiri::XML::Node.new("a:graphicData", document).tap do |graphic_data|
+            graphic_data["uri"] = "http://schemas.openxmlformats.org/drawingml/2006/picture"
+            graphic_data << create_picture_node(scaled_width, scaled_height)
+          end
+        end
+      end
+
+      private def create_picture_node(scaled_width, scaled_height)
+        Nokogiri::XML::Node.new("pic:pic", document).tap do |pic|
+          pic["xmlns:pic"] = "http://schemas.openxmlformats.org/drawingml/2006/picture"
+
+          # Non-visual picture properties
+          pic << create_non_visual_picture_properties
+
+          # Blip fill (the image reference)
+          pic << create_blip_fill
+
+          # Shape properties
+          pic << create_shape_properties(scaled_width, scaled_height)
+        end
+      end
+
+      private def create_non_visual_picture_properties
+        Nokogiri::XML::Node.new("pic:nvPicPr", document).tap do |nv_pic_pr|
+          nv_pic_pr << Nokogiri::XML::Node.new("pic:cNvPr", document).tap do |c_nv_pr|
+            c_nv_pr["id"] = image_number
+            c_nv_pr["name"] = image.name
+            c_nv_pr["descr"] = image.name
+          end
+          nv_pic_pr << Nokogiri::XML::Node.new("pic:cNvPicPr", document).tap do |c_nv_pic_pr|
+            c_nv_pic_pr << Nokogiri::XML::Node.new("a:picLocks", document).tap do |pic_locks|
+              pic_locks["noChangeAspect"] = "1"
+              pic_locks["noChangeArrowheads"] = "0"
             end
-            anchor << Nokogiri::XML::Node.new("wp:cNvGraphicFramePr", document).tap do |c_nv_graphic_frame_pr|
-              c_nv_graphic_frame_pr << Nokogiri::XML::Node.new("a:graphicFrameLocks", document).tap do |graphic_frame_locks|
-                graphic_frame_locks["noChangeAspect"] = true
-              end
+          end
+        end
+      end
+
+      private def create_blip_fill
+        Nokogiri::XML::Node.new("pic:blipFill", document).tap do |blip_fill|
+          blip_fill << Nokogiri::XML::Node.new("a:blip", document).tap do |blip|
+            blip["r:embed"] = node_id
+            blip["cstate"] = "print"
+          end
+          blip_fill << Nokogiri::XML::Node.new("a:stretch", document).tap do |stretch|
+            stretch << Nokogiri::XML::Node.new("a:fillRect", document)
+          end
+        end
+      end
+
+      private def create_shape_properties(scaled_width, scaled_height)
+        Nokogiri::XML::Node.new("pic:spPr", document).tap do |sp_pr|
+          sp_pr["bwMode"] = "auto"
+          # Transform
+          sp_pr << Nokogiri::XML::Node.new("a:xfrm", document).tap do |xfrm|
+            xfrm << Nokogiri::XML::Node.new("a:off", document).tap do |off|
+              off["x"] = "0"
+              off["y"] = "0"
             end
-            anchor << Nokogiri::XML::Node.new("a:graphic", document).tap do |graphic|
-              graphic["xmlns:a"] = "http://schemas.openxmlformats.org/drawingml/2006/main"
-              graphic << Nokogiri::XML::Node.new("a:graphicData", document).tap do |graphic_data|
-                graphic_data["uri"] = "http://schemas.openxmlformats.org/drawingml/2006/picture"
-                graphic_data << Nokogiri::XML::Node.new("pic:pic", document).tap do |pic|
-                  pic["xmlns:pic"] = "http://schemas.openxmlformats.org/drawingml/2006/picture"
-                  pic << Nokogiri::XML::Node.new("pic:nvPicPr", document).tap do |nv_pic_pr|
-                    nv_pic_pr << Nokogiri::XML::Node.new("pic:cNvPr", document).tap do |c_nv_pr|
-                      c_nv_pr["id"] = image_number
-                      c_nv_pr["name"] = image.name
-                      c_nv_pr["descr"] = image.name
-                      c_nv_pr["hidden"] = false
-                      c_nv_pr << Nokogiri::XML::Node.new("pic:cNvPicPr", document).tap do |c_nv_pic_pr|
-                        c_nv_pic_pr << Nokogiri::XML::Node.new("a:picLocks", document).tap do |pic_locks|
-                          pic_locks["noChangeAspect"] = "1"
-                          pic_locks["noChangeArrowheads"] = "1"
-                        end
-                      end
-                    end
-                  end
-                  pic << Nokogiri::XML::Node.new("pic:blipFill", document).tap do |blip_fill|
-                    blip_fill << Nokogiri::XML::Node.new("a:blip", document).tap do |blip|
-                      blip["r:embed"] = node_id
-                    end
-                    blip_fill << Nokogiri::XML::Node.new("a:stretch", document).tap do |stretch|
-                      stretch << Nokogiri::XML::Node.new("a:fillRect", document)
-                    end
-                  end
-                  pic << Nokogiri::XML::Node.new("pic:spPr", document).tap do |sp_pr|
-                    sp_pr["bwMode"] = "auto"
-                    sp_pr << Nokogiri::XML::Node.new("a:xfrm", document).tap do |xfrm|
-                      xfrm << Nokogiri::XML::Node.new("a:off", document).tap do |off|
-                        off["x"] = "0"
-                        off["y"] = "0"
-                      end
-                      xfrm << Nokogiri::XML::Node.new("a:ext", document).tap do |ext|
-                        ext["cx"] = scaled_width
-                        ext["cy"] = scaled_height
-                      end
-                    end
-                    sp_pr << Nokogiri::XML::Node.new("a:prstGeom", document).tap do |prst_geom|
-                      prst_geom["prst"] = "rect"
-                      prst_geom << Nokogiri::XML::Node.new("a:avLst", document)
-                    end
-                    sp_pr << Nokogiri::XML::Node.new("a:noFill", document)
-                  end
-                end
-              end
+            xfrm << Nokogiri::XML::Node.new("a:ext", document).tap do |ext|
+              ext["cx"] = scaled_width
+              ext["cy"] = scaled_height
             end
           end
+          # Pre-set geometry
+          sp_pr << Nokogiri::XML::Node.new("a:prstGeom", document).tap do |prst_geom|
+            prst_geom["prst"] = "rect"
+            prst_geom << Nokogiri::XML::Node.new("a:avLst", document)
+          end
+          # No fill
+          sp_pr << Nokogiri::XML::Node.new("a:noFill", document)
         end
       end
 
-      DEFAULT_PAGE_WIDTH = 12_240
-      TWENTIETHS_OF_A_POINT_TO_EMU = 635
-      DEFAULT_PAGE_WIDTH_IN_EMU = DEFAULT_PAGE_WIDTH * TWENTIETHS_OF_A_POINT_TO_EMU
-      EMU_PER_PIXEL = 9525
-      DEFAULT_PAGE_HEIGHT = DEFAULT_PAGE_WIDTH * 11 / 8.5 # Assuming standard page ratio
-      DEFAULT_PAGE_HEIGHT_IN_EMU = DEFAULT_PAGE_HEIGHT * TWENTIETHS_OF_A_POINT_TO_EMU
+      private def usable_dimensions_from(document)
+        # Get page dimensions
+        page_width = (document.at_xpath("//w:sectPr/w:pgSz/@w:w")&.value || Image::DEFAULT_PAGE_WIDTH).to_i
+        page_height = (document.at_xpath("//w:sectPr/w:pgSz/@w:h")&.value || Image::DEFAULT_PAGE_HEIGHT).to_i
 
-      private def max_width_from document
-        page_width = (document.at_xpath("//w:sectPr/w:pgSz/@w:w")&.value || DEFAULT_PAGE_WIDTH).to_i
-        page_width * TWENTIETHS_OF_A_POINT_TO_EMU
-      end
+        # Convert to EMU
+        width_emu = page_width * Image::TWENTIETHS_OF_A_POINT_TO_EMU
+        height_emu = page_height * Image::TWENTIETHS_OF_A_POINT_TO_EMU
+
+        # Account for margins
+        left_margin = (document.at_xpath("//w:sectPr/w:pgMar/@w:left")&.value || 0).to_i * Image::TWENTIETHS_OF_A_POINT_TO_EMU
+        right_margin = (document.at_xpath("//w:sectPr/w:pgMar/@w:right")&.value || 0).to_i * Image::TWENTIETHS_OF_A_POINT_TO_EMU
+        top_margin = (document.at_xpath("//w:sectPr/w:pgMar/@w:top")&.value || 0).to_i * Image::TWENTIETHS_OF_A_POINT_TO_EMU
+        bottom_margin = (document.at_xpath("//w:sectPr/w:pgMar/@w:bottom")&.value || 0).to_i * Image::TWENTIETHS_OF_A_POINT_TO_EMU
 
-      private def max_dimensions_from(document)
-        page_width = (document.at_xpath("//w:sectPr/w:pgSz/@w:w")&.value || DEFAULT_PAGE_WIDTH).to_i
-        page_height = (document.at_xpath("//w:sectPr/w:pgSz/@w:h")&.value || DEFAULT_PAGE_HEIGHT).to_i
+        # If no margins found, use defaults
+        if left_margin == 0 && right_margin == 0
+          left_margin = right_margin = Image::DEFAULT_MARGIN_IN_EMU
+        end
 
-        width_emu = page_width * TWENTIETHS_OF_A_POINT_TO_EMU
-        height_emu = page_height * TWENTIETHS_OF_A_POINT_TO_EMU
+        if top_margin == 0 && bottom_margin == 0
+          top_margin = bottom_margin = Image::DEFAULT_MARGIN_IN_EMU
+        end
 
-        [width_emu, height_emu]
+        # Usable area
+        usable_width = width_emu - left_margin - right_margin
+        usable_height = height_emu - top_margin - bottom_margin
+
+        # Add a small buffer (10%) to ensure image fits
+        usable_width = (usable_width * 0.9).to_i
+        usable_height = (usable_height * 0.9).to_i
+
+        [usable_width, usable_height]
       end
 
-      private def scale_dimensions(width, height, max_width, max_height)
-        width_ratio = max_width.to_f / width
-        height_ratio = max_height.to_f / height
-        scale = [width_ratio, height_ratio, 1.0].min # Never scale up
+      private def scale_dimensions(width_emu, height_emu, max_width_emu, max_height_emu)
+        # Ensure we're working with EMU values throughout
+        width_ratio = max_width_emu.to_f / width_emu
+        height_ratio = max_height_emu.to_f / height_emu
+
+        # Take the smaller ratio to ensure image fits within boundaries
+        # but never scale up (keep at 1.0 if the image is smaller than available space)
+        scale = [width_ratio, height_ratio, 1.0].min
 
-        [(width * scale).to_i, (height * scale).to_i]
+        # Apply scaling factor and ensure integer values
+        [(width_emu * scale).to_i, (height_emu * scale).to_i]
       end
     end
   end

data/lib/consolidate/image.rb

@@ -3,8 +3,7 @@
 module Consolidate
   class Image
     attr_reader :name, :width, :height, :aspect_ratio, :dpi
-
-    def initialize name:, width:, height:, path: nil, url: nil, contents: nil
+    def initialize name:, width:, height:, path: nil, url: nil, contents: nil, dpix: nil, dpiy: nil
       @name = name
       @width = width
       @height = height
@@ -13,7 +12,7 @@ module Consolidate
       @contents = contents
       @aspect_ratio = width.to_f / height.to_f
       #  TODO: Read this from the contents
-      @dpi = {x: 72, y: 72}
+      @dpi = {x: dpix || 72, y: dpiy || 72}
     end
 
     def to_s = name

data/lib/consolidate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consolidate
-  VERSION = "0.4.3"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-consolidate
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Rahoul Baruah
 bindir: exe
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -67,6 +67,8 @@ files:
 - checksums/standard-procedure-consolidate-0.4.1.gem.sha512
 - checksums/standard-procedure-consolidate-0.4.2.gem.sha512
 - checksums/standard-procedure-consolidate-0.4.3.gem.sha512
+- checksums/standard-procedure-consolidate-0.4.4.gem.sha512
+- checksums/standard-procedure-consolidate-0.4.5.gem.sha512
 - exe/consolidate
 - exe/examine
 - lib/consolidate.rb