docxify 0.0.5 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19220bad643ba9281144f2af8122d7c3300befdef7ed3dff796b81ccb493850c
-  data.tar.gz: fd960d429aedf127bfdca4eaf1d7a2aeda5a7c18577081a9f280169ccc74c23e
+  metadata.gz: 9ce756578c53df736bb1a6641722c8915ccc6bfdf24ce19c21e4bd64624f8405
+  data.tar.gz: 62039225ee265819d72a6cd6ef64a6cd7150b89d99f93fc1a0dfcf7994cafa4c
 SHA512:
-  metadata.gz: 7ef5802312027442107a8541ab7e34be20b8309403c12506b2d48ae77eaeaeb3c2a19877a20ac54dbcc88af3a92869dbc4e718a7647b1abecfce677a05ace286
-  data.tar.gz: b79ab3fc2a484c4882a0330c8bc25471ecb5304e8efa9260de945cdce57cd2ec2dae71133adaf7a10cf385f72d02c8f4f9255e0025ce47a442ce752f674939ec
+  metadata.gz: 514adbdd7c383dc3a373f460b9c548b532e3885b16d75030e5a12e070a13d41e3addab9cbed4cd89794e2bb057e67599e44d1399981d5a6e94c9fb1c5747dc6c
+  data.tar.gz: d3d04f7f8ad20fcdc4478cfe07247f4dc1d687423d4df46336ffd742cbbf941846e8831b8344279db182c324e3eac515856937152162be89f84590c095d80f14

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## 0.0.8
+
+Features:
+
+- Allow changing of following section's page layotu
+
+## 0.0.7
+
+Features:
+
+- Table support
+
+## 0.0.6
+
+Features:
+
+- Tab stops and hanging indents done
+- Replacing of {CHECKBOX_EMPTY} and {CHECKBOX_CHECKED} with correct UTF-8 characters done
+
 ## 0.0.5
 
 Features:

data/README.md

@@ -35,21 +35,32 @@ gem install docxify
 @docx.add_paragraph "{CHECKBOX_EMPTY}\tEmpty checkbox", tab_stops_cm: [2]
 @docx.add_paragraph "{CHECKBOX_CHECKED}\tChecked checkbox", tab_stops_cm: [2]
 
-@docx.add_page_break
 @docx.add_divider
 
 @docx.add_image "file_path or data", align: :right, height_cm: 2, width_cm: 4
 
-headers = [
+@docx.add_page_break
+
+@docx.page_layout width: DocXify::A4_PORTRAIT_HEIGHT, height: DocXify::A4_PORTRAIT_WIDTH, orientation: :landscape
+
+rows = []
+rows << [
   DocXify::Element::TableCell.new("<b>Header 1</b>"),
   DocXify::Element::TableCell.new("<b>Header 2</b>")
+  DocXify::Element::TableCell.new("<b>Header 3</b>")
+  DocXify::Element::TableCell.new("<b>Header 4</b>", width_cm: 10)
+]
+rows << [
+  DocXify::Element::TableCell.new("Content 1", valign: :center, align: :left, nowrap: true, colspan: 3),
+  DocXify::Element::TableCell.new("Rowspan <b>here</b>", rowspan: true) # merges until a "nil" cell
 ]
-row = [
-  DocXify::Element::TableCell.new("Content <b>here</b>", valign: :center, align: :left, nowrap: true, colspan: 3),
-  DocXify::Element::TableCell.new("Content <b>here</b>")
+rows << [
+  DocXify::Element::TableCell.new("Secondary 1")
+  DocXify::Element::TableCell.new("Secondary 2")
+  DocXify::Element::TableCell.new("Secondary 3")
+  DocXify::Element::TableCell.new(nil) # Word requires that there's an empty cell merged with the previous rowspan
 ]
-rows = [row]
-@docx.add_table headers, rows, expand: :full
+container.add_table rows
 
 docx_binary_data = @docx.render
 # or

data/lib/docxify/container.rb

@@ -39,9 +39,11 @@ module DocXify
         zip.put_next_entry "word/_rels/document.xml.rels"
         zip.write document_xml_rels
 
-        @document.images.each do |image|
-          zip.put_next_entry "word/media/#{image.filename}"
-          zip.write image.data
+        @document.relationships.each do |relation|
+          if relation.is_a?(DocXify::Element::File)
+            zip.put_next_entry "word/media/#{relation.filename}"
+            zip.write relation.data
+          end
         end
       end
 
@@ -64,8 +66,8 @@ module DocXify
           <Relationship Id="rId4" Target="fontTable.xml" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable"/>
       XML
 
-      @document.images.each do |image|
-        xml << "<Relationship Id=\"#{image.reference}\" Target=\"media/#{image.filename}\" Type=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships/image\"/>"
+      @document.relationships.each do |relation|
+        xml << relation.to_s
       end
 
       xml << "</Relationships>"

data/lib/docxify/document.rb

@@ -1,18 +1,19 @@
 module DocXify
   class Document
-    attr_accessor :font, :size, :color, :background
-    attr_reader :content, :images
+    attr_accessor :font, :size, :color, :background, :margins, :page_layout
+    attr_reader :content, :relationships, :width
 
     def initialize(options = {})
       @content = []
-      @images = []
+      @relationships = []
       @width = options[:width] || A4_PORTRAIT_WIDTH
       @height = options[:height] || A4_PORTRAIT_HEIGHT
+      @orientation = options[:orientation] || :portrait
       @font = options[:font] || "Times New Roman"
       @size = options[:size] || 12
       @color = options[:color] || 12
       @background = options[:background] if options[:background]
-      @margins = { top: 2, bottom: 2, left: 2, right: 2 }
+      @margins = { top: 2, bottom: 2, left: 2, right: 2 }.merge(options[:margins] || {})
     end
 
     def default_styling(options = {})
@@ -41,17 +42,21 @@ module DocXify
           <w:body>
       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)
+
       @content.each do |element|
-        xml << element.to_s(container)
+        if element.is_a?(DocXify::Element::PageLayout)
+          xml << @page_layout.to_s
+          @page_layout = element
+        else
+          xml << element.to_s(container)
+        end
       end
 
+      xml << @page_layout.to_s
+
       xml << <<~XML
-            <w:sectPr >
-              <w:pgSz w:h="#{@height}" w:w="#{@width}"/>
-              <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:body>
         </w:document>
       XML
@@ -74,7 +79,7 @@ module DocXify
 
     def add_file(file_path_or_data)
       file = DocXify::Element::File.new(file_path_or_data)
-      @images << file
+      @relationships << file
       file
     end
 
@@ -82,6 +87,11 @@ module DocXify
       add DocXify::Element::PageBreak.new
     end
 
+    def add_page_layout(options = {})
+      options[:document] = self
+      add DocXify::Element::PageLayout.new(options)
+    end
+
     def add_divider
       add DocXify::Element::Divider.new
     end
@@ -91,8 +101,9 @@ module DocXify
       add DocXify::Element::Paragraph.new(text, options)
     end
 
-    def add_table(headers, rows, options = {})
-      add DocXify::Element::Table.new(headers, rows, options)
+    def add_table(rows, options = {})
+      options[:document] = self
+      add DocXify::Element::Table.new(rows, options)
     end
   end
 end

data/lib/docxify/element/base.rb

@@ -22,7 +22,7 @@ module DocXify
             if char == "<"
               state = :tag
               tag = ""
-              result << text.strip unless text.strip.empty?
+              result << text unless text.empty?
               text = ""
             else
               text << char
@@ -61,7 +61,7 @@ module DocXify
           when :content # With the content of an HTML tag
             if char == "<"
               state = :tag
-              result.last[:content] = content.strip
+              result.last[:content] = content
               content = ""
             else
               content << char
@@ -71,7 +71,7 @@ module DocXify
           last_char = char
         end
 
-        result << text.strip unless text.strip.empty?
+        result << text unless text.empty?
         result
       end
     end

data/lib/docxify/element/file.rb

@@ -34,6 +34,10 @@ module DocXify
         "image-#{Digest::SHA1.hexdigest(@data)[0, 8]}"
       end
 
+      def to_s
+        "<Relationship Id=\"#{reference}\" Target=\"media/#{filename}\" Type=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships/image\"/>"
+      end
+
       def contains_png_image?(data)
         data[0, 8] == PNG_SIGNATURE
       end

data/lib/docxify/element/page_break.rb

@@ -8,7 +8,6 @@ module DocXify
               <w:br w:type="page"/>
             </w:r>
           </w:p>
-          <w:p/>
         XML
       end
     end

data/lib/docxify/element/paragraph.rb

@@ -1,7 +1,7 @@
 module DocXify
   module Element
     class Paragraph < Base
-      attr_accessor :text, :font, :size, :color, :background, :align, :inline_styling, :tab_stops_cm
+      attr_accessor :text, :font, :size, :color, :background, :align, :inline_styling, :tab_stops_cm, :hanging_cm
 
       def initialize(text, options = {})
         super()
@@ -14,38 +14,86 @@ module DocXify
         @background = options[:background] if options[:background]
         @background ||= @document&.background if @document&.background
         @align = options[:align] || :left
-        @inline_styling = options[:inline_styling] || true
+        @inline_styling = options.key?(:inline_styling) ? options[:inline_styling] : true
         @tab_stops_cm = options[:tab_stops_cm] || []
+        @hanging_cm = options[:hanging_cm] || 0
       end
 
       def to_s(_container = nil)
         nodes = if @inline_styling
           parse_simple_html(@text)
         else
-          [@text]
+          [@text.gsub("<", "&lt;").gsub(">", "&gt;")]
         end
 
         xml = "<w:p>"
-        xml << <<~XML
-          <w:pPr>
-            <w:jc w:val="#{@align}"/>
-          </w:pPr>
-        XML
-        xml << "<w:r>"
-        xml << <<~XML
-          <w:rPr>
-            <w:rFonts w:ascii="#{@font}" w:cs="#{@font}" w:hAnsi="#{@font}"/>
-            <w:color w:val="#{@color.gsub("#", "")}"/>
-            <w:sz w:val="#{DocXify.pt2halfpt(@size)}"/>
-            <w:szCs w:val="#{DocXify.pt2halfpt(@size)}"/>
-            #{"<w:highlight w:val=\"yellow\"/>" if @highlight}
-          </w:rPr>
-        XML
+
+        xml << "<w:pPr>"
+        xml << "<w:jc w:val=\"#{@align}\"/>" if @align != :left
+
+        if tab_stops_cm.any?
+          xml << "<w:tabs>"
+          tab_stops_cm.each do |stop|
+            xml << "<w:tab w:pos=\"#{DocXify.cm2dxa(stop)}\" w:val=\"left\"/>"
+          end
+          xml << "</w:tabs>"
+        end
+
+        if @hanging_cm&.positive?
+          xml << "<w:ind w:hanging=\"#{DocXify.cm2dxa(@hanging_cm)}\" w:left=\"#{DocXify.cm2dxa(@hanging_cm)}\"/>"
+        end
+
+        xml << "</w:pPr>"
 
         nodes.each do |node|
-          xml << "<w:t xml:space=\"preserve\">#{node}</w:t>"
+          if node.is_a?(Hash) && node[:tag] == "a"
+            xml << "<w:hyperlink r:id=\"#{ref_for_href(node[:attributes][:href])}\">"
+          end
+
+          xml << "<w:r>"
+          xml << <<~XML
+            <w:rPr>
+              <w:rFonts w:ascii="#{@font}" w:cs="#{@font}" w:hAnsi="#{@font}"/>
+              <w:color w:val="#{@color.gsub("#", "")}"/>
+              <w:sz w:val="#{DocXify.pt2halfpt(@size)}"/>
+              <w:szCs w:val="#{DocXify.pt2halfpt(@size)}"/>
+              #{"<w:highlight w:val=\"yellow\"/>" if @highlight}
+              #{"<w:b/><w:bCs/>" if node.is_a?(Hash) && node[:tag] == "b"}
+              #{"<w:i/><w:iCs/>" if node.is_a?(Hash) && node[:tag] == "i"}
+              #{"<w:u w:val=\"single\"/>" if node.is_a?(Hash) && (node[:tag] == "u" || node[:tag] == "a")}
+              #{"<w:rStyle w:val=\"Hyperlink\"/>" if node.is_a?(Hash) && node[:tag] == "a"}
+            </w:rPr>
+          XML
+
+          content = node.is_a?(Hash) ? node[:content] : node
+          content = content.gsub("{CHECKBOX_EMPTY}", "☐").gsub("{CHECKBOX_CHECKED}", "☒")
+          xml << "<w:t xml:space=\"preserve\">#{content}</w:t>"
+          xml << "</w:r>"
+
+          if node.is_a?(Hash) && node[:tag] == "a"
+            xml << "</w:hyperlink>"
+          end
         end
-        xml << "</w:r></w:p>"
+
+        xml << "</w:p>"
+      end
+
+      def ref_for_href(href)
+        relation = nil
+
+        @document.relationships.select { |r| r.is_a?(DocXify::Element::WebAddress) }.each do |r|
+          if r.target == href
+            relation = r
+            break
+          end
+        end
+
+        if relation.nil?
+          relation = DocXify::Element::WebAddress.new(href)
+          @document.relationships << relation
+        end
+
+        relation.reference
       end
     end
   end

data/lib/docxify/element/table.rb

@@ -1,8 +1,106 @@
+# Structure of a table element looks something like this
+# <w:tbl> - Table element
+#   <w:tblPr> - Table properties
+#   <w:tblGrid> - Table grid (column widths)
+#   <w:tr> - Table row
+#     <w:tc> - Table cell
+#       <w:tcPr> - Table cell properties
+#        <w:tcW w:type="dxa" w:w="1502"/> - Table cell width
+#        <w:vMerge w:val="restart"/> - Something about merging TODO - figure out
+#        <w:tcBorders> - Overriding table cell borders
+#          <w:top w:val="nil"/>
+#          <w:bottom w:color="auto" w:space="0" w:sz="4" w:val="single"/>
+#          <w:right w:val="nil"/>
+#        </w:tcBorders>
+#        <w:vAlign w:val="bottom"/>
+#      </w:tcPr>
+#      <w:p> - Paragraph element
+
 module DocXify
   module Element
     class Table < Base
+      attr_accessor :rows, :column_widths
+
+      def initialize(rows, options = {})
+        super()
+        @document = options[:document]
+        @rows = rows
+      end
+
       def to_s(_container = nil)
-        # TODO: Implement output
+        xml = ""
+        xml << table_element_start
+        xml << table_properties
+        xml << table_grid
+        @rows.each do |row|
+          xml << table_row(row)
+        end
+        xml << table_element_end
+        xml
+      end
+
+      def table_element_start
+        "<w:tbl>"
+      end
+
+      def table_properties
+        xml = ""
+        xml << "<w:tblPr>"
+        xml << '<w:tblStyle w:val="TableGrid"/>'
+        xml << '<w:tblW w:type="auto" w:w="0"/>'
+        xml << "<w:tblBorders>"
+        xml << '<w:top w:color="auto" w:space="0" w:sz="0" w:val="none"/>'
+        xml << '<w:left w:color="auto" w:space="0" w:sz="0" w:val="none"/>'
+        xml << '<w:bottom w:color="auto" w:space="0" w:sz="0" w:val="none"/>'
+        xml << '<w:right w:color="auto" w:space="0" w:sz="0" w:val="none"/>'
+        xml << "</w:tblBorders>"
+        xml << '<w:tblLook w:firstColumn="1" w:firstRow="1" w:lastColumn="0" w:lastRow="0" w:noHBand="0" w:noVBand="1" w:val="04A0"/>'
+        xml << "</w:tblPr>"
+        xml
+      end
+
+      def table_grid
+        default_equal_width = (@document.width / @rows.first.size).to_i
+
+        @column_widths = []
+        xml = "<w:tblGrid>"
+        @rows.first.each do |cell|
+          width = if cell.width_cm
+            DocXify.cm2dxa(cell.width_cm)
+          else
+            default_equal_width
+          end
+          xml << "<w:gridCol w:w=\"#{width}\"/>"
+          @column_widths << width
+        end
+
+        xml << "</w:tblGrid>"
+        xml
+      end
+
+      def table_row(row)
+        xml = "<w:tr>"
+        widths = @column_widths.dup
+        row.each do |cell|
+          if cell.nil?
+            cell = DocXify::Element::TableCell.new(nil)
+          end
+
+          if cell.width_cm.nil?
+            cell.width_cm = 0
+            (cell.colspan || 1).times do
+              cell.width_cm += DocXify.dxa2cm(widths.shift)
+            end
+          end
+
+          xml << cell.to_s
+        end
+        xml << "</w:tr>"
+        xml
+      end
+
+      def table_element_end
+        "</w:tbl>"
       end
     end
   end

data/lib/docxify/element/table_cell.rb

@@ -0,0 +1,66 @@
+module DocXify
+  module Element
+    class TableCell < Base
+      attr_accessor :content, :valign, :align, :nowrap, :colspan, :width_cm, :borders, :font, :size, :colour
+
+      def initialize(content, options = {})
+        super()
+        @content = content
+        @valign = options[:valign] || :top
+        @align = options[:align] || :left
+        @nowrap = options[:nowrap]
+        @colspan = options[:colspan]
+        @rowspan = options[:rowspan]
+        @width_cm = options[:width_cm]
+        @font = options[:font]
+        @size = options[:size]
+        @color = options[:color]
+        @borders = options[:borders]&.map(&:to_sym) || []
+      end
+
+      def to_s
+        xml = "<w:tc>"
+        xml << "<w:tcPr>"
+        xml << %Q(<w:tcW w:type="dxa" w:w="#{DocXify.cm2dxa(@width_cm)}"/>)
+        if !@colspan.nil? && @colspan.to_i > 1
+          xml << %Q(<w:gridSpan w:val="#{@colspan}"/>')
+        end
+
+        if borders.any?
+          xml << "<w:tcBorders>"
+          xml << (borders.include?(:top) ? '<w:top w:color="auto" w:space="0" w:sz="4" w:val="single"/>' : '<w:top w:val="nil"/>')
+          xml << (borders.include?(:bottom) ? '<w:bottom w:color="auto" w:space="0" w:sz="4" w:val="single"/>' : '<w:bottom w:val="nil"/>')
+          xml << (borders.include?(:left) ? '<w:left w:color="auto" w:space="0" w:sz="4" w:val="single"/>' : '<w:left w:val="nil"/>')
+          xml << (borders.include?(:right) ? '<w:right w:color="auto" w:space="0" w:sz="4" w:val="single"/>' : '<w:right w:val="nil"/>')
+          xml << "</w:tcBorders>"
+        end
+
+        if @valign != :top
+          xml << %Q(<w:vAlign w:val="#{@valign}"/>)
+        end
+
+        if @nowrap
+          xml << "<w:noWrap/>"
+        end
+
+        if @content.nil?
+          @content = "" # Nil is useful for rowspan, but we need to output something or Word breaks
+        end
+
+        if @rowspan
+          xml << '<w:vMerge w:val="restart"/>'
+        elsif @content == ""
+          xml << "<w:vMerge/>"
+        end
+
+        xml << "</w:tcPr>"
+
+        xml << DocXify::Element::Paragraph.new(@content, document: @document, font: @font, size: @size, color: @color, align: @align).to_s
+
+        xml << "</w:tc>"
+
+        xml
+      end
+    end
+  end
+end

data/lib/docxify/element/web_address.rb

@@ -0,0 +1,20 @@
+module DocXify
+  module Element
+    class WebAddress < Base
+      attr_accessor :target
+
+      def initialize(target)
+        super()
+        @target = target
+      end
+
+      def reference
+        "url-#{Digest::SHA1.hexdigest(target)[0, 8]}"
+      end
+
+      def to_s
+        "<Relationship Id=\"#{reference}\" Target=\"#{target}/\" TargetMode=\"External\" Type=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink\"/>"
+      end
+    end
+  end
+end

data/lib/docxify/version.rb

@@ -1,3 +1,3 @@
 module DocXify
-  VERSION = "0.0.5".freeze
+  VERSION = "0.0.8".freeze
 end

data/lib/docxify.rb

@@ -8,8 +8,11 @@ require_relative "docxify/element/divider"
 require_relative "docxify/element/file"
 require_relative "docxify/element/image"
 require_relative "docxify/element/page_break"
+require_relative "docxify/element/page_layout"
 require_relative "docxify/element/paragraph"
 require_relative "docxify/element/table"
+require_relative "docxify/element/table_cell"
+require_relative "docxify/element/web_address"
 
 module DocXify
   class Error < StandardError; end
@@ -28,6 +31,14 @@ module DocXify
     (value * UNITS_PER_CM).to_i
   end
 
+  # Inverse of cm2dxa
+  def self.dxa2cm(value)
+    value = value.to_f
+    raise ArgumentError.new("Value must be greater than or equal to 0") if value.negative?
+
+    (value / UNITS_PER_CM).to_i
+  end
+
   # Used for font sizes
   def self.pt2halfpt(value)
     value = value.to_f

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.8
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -48,6 +48,8 @@ files:
 - lib/docxify/element/page_break.rb
 - lib/docxify/element/paragraph.rb
 - lib/docxify/element/table.rb
+- lib/docxify/element/table_cell.rb
+- lib/docxify/element/web_address.rb
 - lib/docxify/template.rb
 - lib/docxify/version.rb
 homepage: https://github.com/foundercatalyst/docxify