docxify 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc2de5623d8d0605d4aa0ad437c657749e0b39c91c13dc3af0bea385e75dabc3
-  data.tar.gz: 026160dfca1a977e7a8b7563e4268c363918f2130fe2e89dc0346037013d13ef
+  metadata.gz: 7440bb498b7d16a2e1abb5a6a65edfa8cafe69f9e9edc5175431a685becec44e
+  data.tar.gz: 0f099f0d7213de1d3c9d3d32e18d150b5cf119b6b2be53b9b4d74dd21fe90a53
 SHA512:
-  metadata.gz: 41d3b81b2ef6e3f90a1cc9a0149b19f93b96f86bb581d0c83a7f739d55cac24bae6337871a70c7278039f46ca50ecd164525d3b2f9631a7e329d1bd2e3a54989
-  data.tar.gz: eca5c4a3eeb6855546fb7584605fc6579c8cfbe6a31014b1d0dd9896da9c6e15482c34b2638a98c6bca6d6ca887f0f12c076d71018af6f52bcc1421ba03e5ff1
+  metadata.gz: f7761058786959073a9cf63d72206f6861a9afcc65df64e209e1ecd365b9ca47f99bbd7c11435f1d2688af8dc4f4734ff56cf4249767d1e3ab0c829f3d9aea1f
+  data.tar.gz: c4fefd656f6d9a3bf3c87ffc21c94f8c85e41700e880588bd16d266eeb734b98a874e5805a85a767b06596f2a6bdeff17e71c00d9a3d05f43bdbeee6c87ef6b1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.1.3
+
+Bugfix:
+
+- Files that contain a PNG but weren't named ending in .png (e.g. a Tempfile in Ruby) were causing corrupted Docx files (which Word could auto-recover)
+
+## 0.1.2
+
+Features:
+
+- Add 'after' to images and paragraphs to adjust spacing after those elements
+
 ## 0.1.1
 
 Features:

data/README.md

@@ -23,7 +23,7 @@ gem install docxify
 
 @docx.default_styling font: "Serif font here", size: 14, color: "#040404"
 
-@docx.add_paragraph "Title", font: "Something", size: 18, color: "#00000"
+@docx.add_paragraph "Title", font: "Something", size: 18, color: "#00000", after: 18
 @docx.add_paragraph "Body copy"
 @docx.add_paragraph "This is <b>bold</b>, <i>Italic</i> and <u>Underlined</u>."
 @docx.add_paragraph "Text can also contain <a href='foo'>Links</a>."
@@ -37,7 +37,7 @@ gem install docxify
 
 @docx.add_divider
 
-@docx.add_image "file_path or data", align: :right, height_cm: 2, width_cm: 4
+@docx.add_image "file_path or data", align: :right, height_cm: 2, width_cm: 4, after: 18
 
 @docx.add_page_break
 
@@ -92,4 +92,4 @@ The `render` method on a `DocXify::Document` will generate a complete `document.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/andyjeffries/docxify>.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/foundercatalyst/docxify>.

data/lib/docxify/document.rb

@@ -46,7 +46,7 @@ module DocXify
     def build_xml(container)
       xml = <<~XML
         <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-        <w:document mc:Ignorable="w14 w15 w16se w16cid w16 w16cex w16sdtdh wp14" xmlns:aink="http://schemas.microsoft.com/office/drawing/2016/ink" xmlns:am3d="http://schemas.microsoft.com/office/drawing/2017/model3d" xmlns:cx="http://schemas.microsoft.com/office/drawing/2014/chartex" xmlns:cx1="http://schemas.microsoft.com/office/drawing/2015/9/8/chartex" xmlns:cx2="http://schemas.microsoft.com/office/drawing/2015/10/21/chartex" xmlns:cx3="http://schemas.microsoft.com/office/drawing/2016/5/9/chartex" xmlns:cx4="http://schemas.microsoft.com/office/drawing/2016/5/10/chartex" xmlns:cx5="http://schemas.microsoft.com/office/drawing/2016/5/11/chartex" xmlns:cx6="http://schemas.microsoft.com/office/drawing/2016/5/12/chartex" xmlns:cx7="http://schemas.microsoft.com/office/drawing/2016/5/13/chartex" xmlns:cx8="http://schemas.microsoft.com/office/drawing/2016/5/14/chartex" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:oel="http://schemas.microsoft.com/office/2019/extlst" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" xmlns:w16="http://schemas.microsoft.com/office/word/2018/wordml" xmlns:w16cex="http://schemas.microsoft.com/office/word/2018/wordml/cex" xmlns:w16cid="http://schemas.microsoft.com/office/word/2016/wordml/cid" xmlns:w16sdtdh="http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash" xmlns:w16se="http://schemas.microsoft.com/office/word/2015/wordml/symex" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape">
+        <w:document mc:Ignorable="w14 w15 w16se w16cid w16 w16cex w16sdtdh w16du wp14" xmlns:aink="http://schemas.microsoft.com/office/drawing/2016/ink" xmlns:am3d="http://schemas.microsoft.com/office/drawing/2017/model3d" xmlns:cx="http://schemas.microsoft.com/office/drawing/2014/chartex" xmlns:cx1="http://schemas.microsoft.com/office/drawing/2015/9/8/chartex" xmlns:cx2="http://schemas.microsoft.com/office/drawing/2015/10/21/chartex" xmlns:cx3="http://schemas.microsoft.com/office/drawing/2016/5/9/chartex" xmlns:cx4="http://schemas.microsoft.com/office/drawing/2016/5/10/chartex" xmlns:cx5="http://schemas.microsoft.com/office/drawing/2016/5/11/chartex" xmlns:cx6="http://schemas.microsoft.com/office/drawing/2016/5/12/chartex" xmlns:cx7="http://schemas.microsoft.com/office/drawing/2016/5/13/chartex" xmlns:cx8="http://schemas.microsoft.com/office/drawing/2016/5/14/chartex" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:oel="http://schemas.microsoft.com/office/2019/extlst" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" xmlns:w16="http://schemas.microsoft.com/office/word/2018/wordml" xmlns:w16cex="http://schemas.microsoft.com/office/word/2018/wordml/cex" xmlns:w16cid="http://schemas.microsoft.com/office/word/2016/wordml/cid" xmlns:w16du="http://schemas.microsoft.com/office/word/2023/wordml/word16du" xmlns:w16sdtdh="http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash" xmlns:w16se="http://schemas.microsoft.com/office/word/2015/wordml/symex" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape">
           <w:body>
       XML
 

data/lib/docxify/element/file.rb

@@ -15,16 +15,18 @@ module DocXify
       end
 
       def load_file_data(file_path_or_data)
+        if ::File.exist?(file_path_or_data)
+          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"
+          puts "Contains PNG image #{@filename}"
         elsif contains_jpeg_image?(file_path_or_data)
           @data = file_path_or_data
           @filename = "#{Digest::SHA1.hexdigest(@data)}.jpg"
-        elsif ::File.exist?(file_path_or_data)
-          @filename = ::File.basename(file_path_or_data)
-          @data = ::File.read(file_path_or_data, mode: "rb")
-          raise ArgumentError.new("Unsupported file type - images must be PNG or JPEG") unless contains_png_image?(@data) || contains_jpeg_image?(@data)
+          puts "Contains JPEG image #{@filename}"
         else
           raise ArgumentError.new("Unsupported file type - images must be PNG or JPEG")
         end

data/lib/docxify/element/image.rb

@@ -8,6 +8,7 @@ module DocXify
         @file = file
 
         @align = options[:align] || :left
+        @after = options[:after]
         @height_cm = options[:height_cm] || 5
         @width_cm = options[:width_cm] || 5
       end
@@ -19,20 +20,17 @@ module DocXify
       def to_s(_container = nil)
         xml = "<w:p>"
 
+        xml << "<w:pPr>"
         if @align == :right
-          xml << <<~XML
-            <w:pPr>
-              <w:jc w:val="right"/>
-            </w:pPr>
-          XML
+          xml << "<w:jc w:val=\"right\"/>"
         elsif @align == :center
-          xml << <<~XML
-            <w:pPr>
-              <w:jc w:val="center"/>
-            </w:pPr>
-          XML
+          xml << "<w:jc w:val=\"center\"/>"
         end
 
+        xml << "<w:spacing w:after=\"#{DocXify.pt2spacing @after}\"/>" if @after
+
+        xml << "</w:pPr>"
+
         xml << <<~XML
             <w:r>
               <w:rPr>

data/lib/docxify/element/paragraph.rb

@@ -14,6 +14,7 @@ module DocXify
         @background = options[:background] if options[:background]
         @background ||= @document&.background if @document&.background
         @align = options[:align] || :left
+        @after = options[:after]
         @inline_styling = options.key?(:inline_styling) ? options[:inline_styling] : true
         @tab_stops_cm = options[:tab_stops_cm] || []
         @hanging_cm = options[:hanging_cm] || 0
@@ -21,15 +22,16 @@ module DocXify
 
       def to_s(_container = nil)
         nodes = if @inline_styling
-                  parse_simple_html(@text)
-                else
-                  [@text.gsub("<", "&lt;").gsub(">", "&gt;")]
-                end
+          parse_simple_html(@text)
+        else
+          [@text.gsub("<", "&lt;").gsub(">", "&gt;")]
+        end
 
         xml = "<w:p>"
 
         xml << "<w:pPr>"
         xml << "<w:jc w:val=\"#{@align}\"/>" if @align != :left
+        xml << "<w:spacing w:after=\"#{DocXify.pt2spacing @after}\"/>" if @after
 
         if tab_stops_cm.any?
           xml << "<w:tabs>"

data/lib/docxify/version.rb

@@ -1,3 +1,3 @@
 module DocXify
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.3".freeze
 end

data/lib/docxify.rb

@@ -47,6 +47,14 @@ module DocXify
     (value * 2).to_i
   end
 
+  # Used for spacing
+  def self.pt2spacing(value)
+    value = value.to_f
+    raise ArgumentError.new("Value must be greater than or equal to 0") if value.negative?
+
+    (value * 20).to_i
+  end
+
   # Used for image sizes
   def self.cm2emu(value)
     value = value.to_f

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Andy Jeffries
+- FounderCatalyst Ltd
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -27,7 +28,7 @@ dependencies:
 description: Using a relatively simple DSL, you can generate Word DocX documents from
   Ruby.
 email:
-- andy@andyjeffries.co.uk
+- andy@foundercatalyst.com
 executables: []
 extensions: []
 extra_rdoc_files: []