docxify 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6452a64308ce07a1158e0cb0af2aaeab67085f4e17726e4c098de78151ee1fc1
-  data.tar.gz: 04a7c49e56af79e4ab67a3f66269dc1940856488257e73888cbdfea4a74b301b
+  metadata.gz: cb6c9076520d0776ed132e2abbc42166a6ff0106fce181d5d178ecf3abff1a96
+  data.tar.gz: 042d1e27e5572cd0b4868eb9af065d1b3831e25d80569eafd2086bda130ab7b1
 SHA512:
-  metadata.gz: d8ee36086086aef5941636ad168b0bc11e526d5e801fb482cdda6169b2065901069cdd9d6d68d05ab482bbc3c1541aad0258f051e673019590987b3991d36db1
-  data.tar.gz: b34e167da1eb82d24cac8b15c54882a2b6f130dfc68281f024e02739ebd04880076847f9345f38ffc0dcaf7b36ffa3c194a521cc0c0b9d8b29e6a8098b065d52
+  metadata.gz: 83ee99a55280b56efd7f571c00c8cb09eb026345b821173c389f40f3bffb907bc2f4b57ce08d6d587a0bc653cdbc4efc630a1400dd48e3dee78f005bf574469e
+  data.tar.gz: 62a9965149dde87c65db3877642fff5e6cf0cc8f02f373ab59422b78ca9a645522c2df45125268140f8b1e36b29a105b500ea06489f0fc5fee6056bff740bd6a

data/.rubocop.yml

@@ -0,0 +1,309 @@
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+    - 'vendor/**/*'
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+Style/FetchEnvVar:
+  Enabled: false
+Style/StringChars:
+  Enabled: false
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+Metrics/ClassLength:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Lint/SuppressedException:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Bundler/OrderedGems:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Layout/SpaceBeforeSemicolon:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Lint/RescueException:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: never
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: false
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/HashLikeCase:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RedundantParentheses:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # CHANGELOG
 
+## 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:
+
+- Paragraph font name, size, colour and yellow highlight done
+- Document level default font name, size and colour done
+
+## 0.0.4
+
+Features:
+
+- Image insertion is working
+
+## 0.0.3
+
+Features:
+
+- Dividers and page breaks implemented
+- Simple HTML parsing (for paragraphs) implemented
+
 ## 0.0.2
 
 Features:

data/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright ©️2024 FounderCatalyst IP Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -25,32 +25,42 @@ gem install docxify
 
 @docx.add_paragraph "Title", font: "Something", size: 18, color: "#00000"
 @docx.add_paragraph "Body copy"
-@docx.add_paragraph "This is <b>bold</b>, <i>Italic</i> and <u>Underlined</u>. It can also contain <a href='foo'>Links</a>."
+@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>."
 @docx.add_paragraph "Centred text", align: :center
 @docx.add_paragraph "Highlighted text", background: "#FFFF99"
-@docx.add_paragraph "This is <b>bold</b>, <i>Italic</i> and <u>Underlined</u>. It can also contain <a href='foo'>Links</a>.", inline_styling: false
+@docx.add_paragraph "This won't show as <b>bold</b>", inline_styling: false
 
-@docx.add_paragraph "1.1.1\tBody copy", tab_stops_cm: [2]
+@docx.add_paragraph "\t1.1.1\tBody copy", tab_stops_cm: [1, 2]
 @docx.add_paragraph "{CHECKBOX_EMPTY}\tEmpty checkbox", tab_stops_cm: [2]
 @docx.add_paragraph "{CHECKBOX_CHECKED}\tChecked checkbox", tab_stops_cm: [2]
 
-@docx.add_numbered_list_item "This is a list item", level: 0
-
-@docx.add_page_break
 @docx.add_divider
 
 @docx.add_image "file_path or data", align: :right, height_cm: 2, width_cm: 4
 
-headers = [
-  DocXify::Element::TableCell.new("<b>Header 1</b>"),
-  DocXify::Element::TableCell.new("<b>Header 2</b>")
-]
-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 = [row]
-@docx.add_table headers, rows, expand: :full
+@docx.add_page_break
+
+@docx.container page_width: DocXify::A4_PORTRAIT_HEIGHT, page_height: DocXify::A4_PORTRAIT_WIDTH do |container|
+  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
+  ]
+  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
+  ]
+  container.add_table rows
+end
 
 docx_binary_data = @docx.render
 # or

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-require "standard/rake"
-
-task default: %i[spec standard]
+task default: %i[spec rubocop]

data/lib/docxify/container.rb

@@ -36,9 +36,14 @@ module DocXify
         zip.put_next_entry "word/document.xml"
         zip.write document.build_xml(self)
 
-        @document.images.each do |image|
-          zip.put_next_entry "word/media/#{image.filename}"
-          zip.write image.file_contents
+        zip.put_next_entry "word/_rels/document.xml.rels"
+        zip.write document_xml_rels
+
+        @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
 
@@ -61,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,18 @@
 module DocXify
   class Document
     attr_accessor :font, :size, :color, :background
-    attr_reader :content, :images
+    attr_reader :content, :relationships, :width
 
     def initialize(options = {})
       @content = []
-      @images = []
+      @relationships = []
       @width = options[:width] || A4_PORTRAIT_WIDTH
       @height = options[:height] || A4_PORTRAIT_HEIGHT
       @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 }
     end
 
     def default_styling(options = {})
@@ -37,7 +37,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: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 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:body>
       XML
 
@@ -64,34 +64,36 @@ module DocXify
     end
 
     def add_image(file_path_or_data, options = {})
-      file = DocXify::Element::File.new(self, file_path_or_data, options)
-      @images << file
-      add DocXify::Element::Image.new(self, file, options)
+      file = if file_path_or_data.is_a?(DocXify::Element::File)
+        file_path_or_data
+      else
+        add_file(file_path_or_data)
+      end
+      add DocXify::Element::Image.new(file, options)
     end
 
-    def add_numbered_list_item(text, level: 0)
-      add DocXify::Element::NumberedListItem.new(self, text, level: level)
+    def add_file(file_path_or_data)
+      file = DocXify::Element::File.new(file_path_or_data)
+      @relationships << file
+      file
     end
 
     def add_page_break
-      add DocXify::Element::PageBreak.new(self)
+      add DocXify::Element::PageBreak.new
     end
 
     def add_divider
-      add DocXify::Element::Divider.new(self)
+      add DocXify::Element::Divider.new
     end
 
     def add_paragraph(text, options = {})
-      add DocXify::Element::Paragraph.new(self, text, options)
+      options[:document] = self
+      add DocXify::Element::Paragraph.new(text, options)
     end
 
-    def add_table(headers, rows, options = {})
-      add DocXify::Element::Table.new(self, headers, rows, options)
+    def add_table(rows, options = {})
+      options[:document] = self
+      add DocXify::Element::Table.new(rows, options)
     end
-
-    # MARK: Private
-
-    private
-
   end
 end

data/lib/docxify/element/base.rb

@@ -4,6 +4,76 @@ module DocXify
       def to_s(container = nil)
         raise NotImplementedError
       end
+
+      private
+
+      def parse_simple_html(html)
+        state = :text
+        tag = ""
+        content = ""
+        result = []
+        text = ""
+        last_char = ""
+
+        html.each_char do |char|
+          # puts "State: #{state}, Char: #{char}, Tag: #{tag}, Content: #{content}, Text: #{text}"
+          case state
+          when :text # This is a text node, not part of an HTML tag
+            if char == "<"
+              state = :tag
+              tag = ""
+              result << text unless text.empty?
+              text = ""
+            else
+              text << char
+            end
+          when :tag # Within an HTML tag itself
+            if char == ">"
+              state = :content
+              content = ""
+              tag_name, *attributes = tag.split
+              tag_name.gsub!(/\s*\//, "")
+              attributes.delete_if { |attr| attr == "/" }
+              if attributes.any?
+                attrs = {}
+                attributes.each do |attribute|
+                  name, value = attribute.split("=")
+                  value = value.to_s[1..-2] if value
+                  attrs[name.to_sym] = value
+                end
+                result << { tag: tag_name, attributes: attrs, content: "" }
+              else
+                result << { tag: tag_name, content: "" }
+              end
+
+              if last_char == "/"
+                state = :text
+              end
+            elsif char == "/" && last_char == "<"
+              state = :closing_tag
+            else
+              tag << char
+            end
+          when :closing_tag
+            if char == ">"
+              state = :text
+            end
+          when :content # With the content of an HTML tag
+            if char == "<"
+              state = :tag
+              result.last[:content] = content
+              content = ""
+            else
+              content << char
+            end
+          end
+
+          last_char = char
+        end
+
+        result << text unless text.empty?
+        result
+      end
     end
   end
 end

data/lib/docxify/element/divider.rb

@@ -0,0 +1,18 @@
+module DocXify
+  module Element
+    class Divider < Base
+      def to_s(_container = nil)
+        <<~XML
+          <w:p>
+            <w:pPr>
+              <w:pBdr>
+                <w:bottom w:color="auto" w:space="1" w:sz="6" w:val="single"/>
+              </w:pBdr>
+            </w:pPr>
+          </w:p>
+          <w:p/>
+        XML
+      end
+    end
+  end
+end

data/lib/docxify/element/file.rb

@@ -0,0 +1,50 @@
+require "digest/sha1"
+
+module DocXify
+  module Element
+    class File < Base
+      PNG_SIGNATURE = "\x89PNG\r\n\u001A\n".b.freeze
+      JPEG_START = "\xFF\xD8".b.freeze
+      JPEG_END = "\xFF\xD9".b.freeze
+
+      attr_accessor :data, :filename
+
+      def initialize(file_path_or_data)
+        super()
+        load_file_data(file_path_or_data)
+      end
+
+      def load_file_data(file_path_or_data)
+        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"
+        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)
+        else
+          raise ArgumentError.new("Unsupported file type - images must be PNG or JPEG")
+        end
+      end
+
+      def reference
+        "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
+
+      def contains_jpeg_image?(data)
+        data[0..1] == JPEG_START && data[-2..] == JPEG_END
+      end
+    end
+  end
+end

data/lib/docxify/element/image.rb

@@ -0,0 +1,88 @@
+module DocXify
+  module Element
+    class Image < Base
+      attr_accessor :file, :align, :height_cm, :width_cm
+
+      def initialize(file, options = {})
+        super()
+        @file = file
+
+        @align = options[:align] || :left
+        @height_cm = options[:height_cm] || 5
+        @width_cm = options[:width_cm] || 5
+      end
+
+      def id
+        rand(1_000_000_000)
+      end
+
+      def to_s(_container = nil)
+        xml = "<w:p>"
+
+        if @align == :right
+          xml << <<~XML
+            <w:pPr>
+              <w:jc w:val="right"/>
+            </w:pPr>
+          XML
+        elsif @align == :center
+          xml << <<~XML
+            <w:pPr>
+              <w:jc w:val="center"/>
+            </w:pPr>
+          XML
+        end
+
+        xml << <<~XML
+            <w:r>
+              <w:rPr>
+                <w:noProof/>
+              </w:rPr>
+              <w:drawing>
+                <wp:inline distB="0" distL="0" distR="0" distT="0">
+                  <wp:extent cx="#{DocXify.cm2emu(@width_cm)}" cy="#{DocXify.cm2emu(@height_cm)}"/>
+                  <wp:effectExtent b="0" l="0" r="0" t="0"/>
+                  <wp:docPr id="#{id}" name="Picture 1"/>
+                  <wp:cNvGraphicFramePr>
+                    <a:graphicFrameLocks noChangeAspect="1" xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main"/>
+                  </wp:cNvGraphicFramePr>
+                  <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
+                    <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
+                      <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
+                        <pic:nvPicPr>
+                          <pic:cNvPr id="#{id}" name="Picture #{id}"/>
+                          <pic:cNvPicPr/>
+                        </pic:nvPicPr>
+                        <pic:blipFill>
+                          <a:blip cstate="print" r:embed="#{@file.reference}">
+                            <a:extLst>
+                              <a:ext uri="{28A0092B-C50C-407E-A947-70E740481C1C}">
+                                <a14:useLocalDpi val="0" xmlns:a14="http://schemas.microsoft.com/office/drawing/2010/main"/>
+                              </a:ext>
+                            </a:extLst>
+                          </a:blip>
+                          <a:stretch>
+                            <a:fillRect/>
+                          </a:stretch>
+                        </pic:blipFill>
+                        <pic:spPr>
+                          <a:xfrm>
+                            <a:off x="0" y="0"/>
+                            <a:ext cx="#{DocXify.cm2emu(@width_cm)}" cy="#{DocXify.cm2emu(@height_cm)}"/>
+                          </a:xfrm>
+                          <a:prstGeom prst="rect">
+                            <a:avLst/>
+                          </a:prstGeom>
+                        </pic:spPr>
+                      </pic:pic>
+                    </a:graphicData>
+                  </a:graphic>
+                </wp:inline>
+              </w:drawing>
+            </w:r>
+          </w:p>
+        XML
+      end
+    end
+  end
+end

data/lib/docxify/element/page_break.rb

@@ -0,0 +1,16 @@
+module DocXify
+  module Element
+    class PageBreak < Base
+      def to_s(_container = nil)
+        <<~XML
+          <w:p>
+            <w:r>
+              <w:br w:type="page"/>
+            </w:r>
+          </w:p>
+          <w:p/>
+        XML
+      end
+    end
+  end
+end

data/lib/docxify/element/paragraph.rb

@@ -1,24 +1,99 @@
 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(document, text, options = {})
-        @document = document
+      def initialize(text, options = {})
+        super()
+        @document = options[:document]
         @text = text
-        @font = options[:font] || document.font
-        @size = options[:size] || document.size
-        @color = options[:color] || document.color
+        @font = options[:font] || @document&.font || "Times New Roman"
+        @size = options[:size] || @document&.size || 14
+        @color = options[:color] || @document&.color || "#000000"
+        @highlight = options[:highlight] || false
         @background = options[:background] if options[:background]
-        @background ||= document.background if document.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)
-        # TODO: Implement all optionality
-        "<w:p><w:r><w:t xml:space=\"preserve\">#{@text}</w:t></w:r></w:p>"
+      def to_s(_container = nil)
+        nodes = if @inline_styling
+          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
+
+        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|
+          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: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

@@ -0,0 +1,107 @@
+# 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)
+        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
+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/template.rb

@@ -15,6 +15,8 @@ module DocXify
         <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
           <Default ContentType="application/vnd.openxmlformats-package.relationships+xml" Extension="rels"/>
           <Default ContentType="application/xml" Extension="xml"/>
+          <Default ContentType="image/png" Extension="png"/>
+          <Default ContentType="image/jpeg" Extension="jpg"/>
           <Override ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml" PartName="/word/document.xml"/>
           <Override ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml" PartName="/word/styles.xml"/>
           <Override ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml" PartName="/word/settings.xml"/>

data/lib/docxify/version.rb

@@ -1,3 +1,3 @@
 module DocXify
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/docxify.rb

@@ -2,13 +2,16 @@ require_relative "docxify/version"
 require_relative "docxify/document"
 require_relative "docxify/container"
 require_relative "docxify/template"
+
 require_relative "docxify/element/base"
 require_relative "docxify/element/divider"
+require_relative "docxify/element/file"
 require_relative "docxify/element/image"
-require_relative "docxify/element/numbered_list_item"
 require_relative "docxify/element/page_break"
 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
@@ -22,24 +25,32 @@ module DocXify
   # Used for most sizes
   def self.cm2dxa(value)
     value = value.to_f
-    raise ArgumentError, "Value must be greater than or equal to 0" if value < 0
+    raise ArgumentError.new("Value must be greater than or equal to 0") if value.negative?
+
+    (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
+    (value / UNITS_PER_CM).to_i
   end
 
   # Used for font sizes
   def self.pt2halfpt(value)
     value = value.to_f
-    raise ArgumentError, "Value must be greater than or equal to 0" if value < 0
+    raise ArgumentError.new("Value must be greater than or equal to 0") if value.negative?
 
-    value * 2
+    (value * 2).to_i
   end
 
   # Used for image sizes
   def self.cm2emu(value)
     value = value.to_f
-    raise ArgumentError, "Value must be greater than or equal to 0" if value < 0
+    raise ArgumentError.new("Value must be greater than or equal to 0") if value.negative?
 
-    value * 360000
+    (value * 360_000).to_i
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -33,8 +33,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".standard.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/docxify.rb
@@ -42,11 +43,13 @@ files:
 - lib/docxify/document.rb
 - lib/docxify/element/base.rb
 - lib/docxify/element/divider.rb
+- lib/docxify/element/file.rb
 - lib/docxify/element/image.rb
-- lib/docxify/element/numbered_list_item.rb
 - 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
@@ -55,6 +58,7 @@ metadata:
   homepage_uri: https://github.com/foundercatalyst/docxify
   source_code_uri: https://github.com/foundercatalyst/docxify
   changelog_uri: https://github.com/foundercatalyst/docxify/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 3.0