standard-procedure-consolidate 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39e8b33a8f43ddb4a3bff6ccfb91ee9608d741dc9dff3759ea7c45b1c3cf3d3c
-  data.tar.gz: 71d357d9e60a98f199c7d67ab3f6a0b5ee8999218162fabf43a4fc4283f04a85
+  metadata.gz: 6cbb574bced054ba32f67038b7f91eed28836470eb0d40e7bbbbcaefdca41142
+  data.tar.gz: 64438e3b31ea879c4c10d42afa08873a44528ec89ba60d3e248c07baf1bd028b
 SHA512:
-  metadata.gz: e68a557b00ecb43feb93cdc9a5c9a4c09edd93f8421206be3372e617809bc9ce01cb9ad4928e6f97f49b6db64fd9a329dd2ff7360d5d7b618ce455d0f080c6b1
-  data.tar.gz: 94417403770d855c0df0d1927b3de00235a668503790e06388de83cadb3b3d2b533f394fab3ddcda5ace164bbe7394810c8ad6b00092eb553552f74fabaa2e5e
+  metadata.gz: 947a488ad5d98514589cbaa9495cd7970e7821832a05f74719821d9423785fc9e04f2563b7c4c4c34e5c5c25c32c6a1fd175cbd862e247cdfc2e8612663412b4
+  data.tar.gz: cc6e12303d7abea0be365df9c443d868d18bc658f3696488a6826ce83b93cfd17e588aecc6f3af94a9ac46e9621bc483800effd44e37b550dc752767757fe9fc

data/.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 // README at: https://github.com/devcontainers/templates/tree/main/src/ruby
 {
   "name": "Ruby",
-  "image": "mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye",
+  "image": "ghcr.io/rails/devcontainer/images/ruby:3.3.5",
   "postCreateCommand": "bundle install",
   "customizations": {
     "vscode": {

data/.ruby-version

@@ -1 +1 @@
-3.2.5
+3.3.5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# [0.4.1] - 2024-12-18
+
+Replace image merge fields with blanks if the image data is not provided 
+
 # [0.4.0] - 2024-12-16
 
 Image embedding works

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

@@ -0,0 +1 @@
+dfd2ec36154a632f86dd8f99a2b85c59ed6048dbb6b8100f84645ea1cf49e3e77ad73b3367ef89d46e055c860f1b1e82c5b0d0d37c969a19c2644a3e42ebbe21

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

@@ -0,0 +1 @@
+391a0d85024adf2a5866f0dabab3d601e6865c482e4fff5e780af0a6dc6ca36aade243a9e97cdb68552b00fce51d763ed94e89a701ce466428a64df9f4d574a0

data/lib/consolidate/docx/image_reference_node_builder.rb

@@ -7,6 +7,9 @@ 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)
+
         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:inline", document).tap do |inline|
@@ -15,8 +18,8 @@ module Consolidate
             inline["distL"] = "0"
             inline["distR"] = "0"
             inline << Nokogiri::XML::Node.new("wp:extent", document).tap do |extent|
-              extent["cx"] = image.clamped_width(max_width_from(document))
-              extent["cy"] = image.clamped_height(max_width_from(document))
+              extent["cx"] = scaled_width
+              extent["cy"] = scaled_height
             end
             inline << Nokogiri::XML::Node.new("wp:effectExtent", document).tap do |effect_extent|
               effect_extent["l"] = "0"
@@ -59,8 +62,8 @@ module Consolidate
                         off["y"] = "0"
                       end
                       xfrm << Nokogiri::XML::Node.new("a:ext", document).tap do |ext|
-                        ext["cx"] = image.clamped_width(max_width_from(document))
-                        ext["cy"] = image.clamped_height(max_width_from(document))
+                        ext["cx"] = scaled_width
+                        ext["cy"] = scaled_height
                       end
                     end
                     sp_pr << Nokogiri::XML::Node.new("a:prstGeom", document).tap do |prst_geom|
@@ -78,11 +81,32 @@ module Consolidate
       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 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
+
+      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
+
+        width_emu = page_width * TWENTIETHS_OF_A_POINT_TO_EMU
+        height_emu = page_height * TWENTIETHS_OF_A_POINT_TO_EMU
+
+        [width_emu, height_emu]
+      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
+
+        [(width * scale).to_i, (height * scale).to_i]
+      end
     end
   end
 end

data/lib/consolidate/docx/merge.rb

@@ -70,6 +70,7 @@ module Consolidate
           @output[contents_xml] = @contents_xml.serialize save_with: 0
 
           @images.each do |field_name, image|
+            next if image.nil?
             puts "...  writing image #{field_name} to #{image.storage_path}" if verbose
             out.get_output_stream(image.storage_path) { |o| o.write image.contents }
           end
@@ -120,7 +121,7 @@ module Consolidate
       def relation_number_for(field_name) = @mapping.keys.index(field_name) + 1000
 
       # Identifier to use when linking a merge field to the actual image file contents
-      def relation_id_for(field_name) = "rId#{relation_number_for(field_name)}"
+      def relation_id_for(field_name) = "rId#{field_name}"
 
       # Empty elations document for documents that do not already have one
       def default_relations_document = %(<?xml version="1.0" encoding="UTF-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"></Relationships>)
@@ -156,8 +157,8 @@ module Consolidate
       # Build a mapping of image paths to the image data so that the image data can be stored in the output docx
       def load_images
         image_field_names.each_with_object({}) do |field_name, result|
-          result[field_name] = Consolidate::Docx::Image.new(@mapping[field_name])
-          puts "...   #{field_name} => #{result[field_name].media_path}" if verbose
+          result[field_name] = @mapping[field_name].nil? ? nil : Consolidate::Docx::Image.new(@mapping[field_name])
+          puts "...   #{field_name} => #{result[field_name]&.media_path}" if verbose
         end
       end
 
@@ -166,6 +167,8 @@ module Consolidate
         @relations.each do |name, xml|
           puts "...   linking images in #{name}" if verbose
           images.each do |field_name, image|
+            # Has an actual image file been supplied?
+            next if image.nil? 
             # Is this image already referenced in this relationship document?
             next unless xml.at_xpath("//Relationship[@Target=\"#{image.media_path}\"]").nil?
             puts "...      #{relation_id_for(field_name)} => #{image.media_path}" if verbose
@@ -245,8 +248,15 @@ module Consolidate
             field_name = piece.strip
             if field_names.include? field_name
               image = @images[field_name]
-              puts "...   substituting '#{field_name}' with '<#{relation_id_for(field_name)}/>'" if verbose
-              ImageReferenceNodeBuilder.new(field_name: field_name, image: image, node_id: relation_id_for(field_name), image_number: relation_number_for(field_name), document: document).call
+              # if no image was provided then insert blank text
+              # otherwise insert a w:drawing node that references the image contents
+              if image.nil? 
+                puts "...   substituting '#{field_name}' with blank as no image was provided" if verbose
+                Nokogiri::XML::Node.new("w:t", document) { |t| t.content = "" }
+              else
+                puts "...   substituting '#{field_name}' with '<#{relation_id_for(field_name)}/>'" if verbose
+                ImageReferenceNodeBuilder.new(field_name: field_name, image: image, node_id: relation_id_for(field_name), image_number: relation_number_for(field_name), document: document).call
+              end
             else
               Nokogiri::XML::Node.new("w:t", document) { |t| t.content = piece }
             end

data/lib/consolidate/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-consolidate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Rahoul Baruah
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -65,6 +64,8 @@ files:
 - checksums/standard-procedure-consolidate-0.3.1.gem.sha512
 - checksums/standard-procedure-consolidate-0.3.9.gem.sha512
 - checksums/standard-procedure-consolidate-0.4.0.gem.sha512
+- checksums/standard-procedure-consolidate-0.4.1.gem.sha512
+- checksums/standard-procedure-consolidate-0.4.2.gem.sha512
 - exe/consolidate
 - exe/examine
 - lib/consolidate.rb
@@ -83,7 +84,6 @@ metadata:
   homepage_uri: https://github.com/standard-procedure/standard-procedure-consolidate
   source_code_uri: https://github.com/standard-procedure/standard-procedure-consolidate
   changelog_uri: https://github.com/standard-procedure/standard-procedure-consolidate/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Simple ruby mailmerge for Microsoft Word .docx files.
 test_files: []