docxify 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cca8db68cf66e2ef536b4f78c25cecfe748adb531395d22e858f5e2525be3612
-  data.tar.gz: 77c9e427bcd6294561654d4b1857f8846c1da4e9bd109aa78de0b42119ecb394
+  metadata.gz: 19220bad643ba9281144f2af8122d7c3300befdef7ed3dff796b81ccb493850c
+  data.tar.gz: fd960d429aedf127bfdca4eaf1d7a2aeda5a7c18577081a9f280169ccc74c23e
 SHA512:
-  metadata.gz: 5ffb8d35049585d33df5e75c178a00be24c0a447f45e0d1ad960a538789f2f996cb74e486d8e1671aced45cb51c3a0eb24fe475377d3eb182ebbbd91ddc835dd
-  data.tar.gz: 64f8104304ff8ded85f511d598de2d3ef47eb957c85b1d13431882423fdaaf9a6436a4de96710579634a59fd96be11780ce21ec9f94d6f6bc7b0186eadd706b4
+  metadata.gz: 7ef5802312027442107a8541ab7e34be20b8309403c12506b2d48ae77eaeaeb3c2a19877a20ac54dbcc88af3a92869dbc4e718a7647b1abecfce677a05ace286
+  data.tar.gz: b79ab3fc2a484c4882a0330c8bc25471ecb5304e8efa9260de945cdce57cd2ec2dae71133adaf7a10cf385f72d02c8f4f9255e0025ce47a442ce752f674939ec

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 +1,33 @@
 # CHANGELOG
+
+## 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:
+
+- Able to generate a valid docx file, with no styling or anything useful yet
+
+## 0.0.1
+
+Features:
+
+- Brand new code/gem generated

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

@@ -1,24 +1,71 @@
-# Docxify
+# DocXify
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/docxify`. To experiment with that code, run `bin/console` for an interactive prompt.
+If you've ever wanted to generate a Word Document containing a letter or a contract (not a full page layout advert or advanced formatting like that), DocXify is the gem you need in your life.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+bundle add docxify
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+gem install docxify
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+@docx = DocXify::Document.new(page_width: DocXify::A4_PORTRAIT_WIDTH, page_height: DocXify::A4_PORTRAIT_HEIGHT)
+
+@docx.default_styling font: "Serif font here", size: 14, color: "#040404"
+
+@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>."
+@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 won't show as <b>bold</b>", inline_styling: false
+
+@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_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_binary_data = @docx.render
+# or
+@docx.render "file_path"
+
+# All of the above add_* are also available as objects for more dynamic control
+
+para = DocXify::Element::Paragraph.new()
+para.content = "This is <b>bold</b>, <i>Italic</i> and <u>Underlined</u>. It can also contain <a href='foo'>Links</a>."
+para.font = "Something"
+para.size = 18
+para.color = "#040404"
+para.background = "#FFFF99"
+para.align = :center
+@docx.add para
+```
 
 ## Development
 
@@ -26,6 +73,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Overall architecture
+
+The main object created by users is a `DocXify::Document`. This builds up a `@content` instance variable containing an array of all of the elements. Each element has a `to_s` method that will convert it's current state to a string, ready for insertion in to a complete document.
+
+The `render` method on a `DocXify::Document` will generate a complete `document.xml` (Word terminology not a Ruby method) by creating a template and iterating each `@content` item. It will then create a `DocXify::Container` with that `document.xml` to generate a complete Zipped DocX file, and call it's `render` method to generate an in-memory file. This is then either returned to the `render` caller, or if a file path was passed as the first attribute, then it writes it out.
+
 ## 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/andyjeffries/docxify>.

data/Rakefile

@@ -1,10 +1,8 @@
-# frozen_string_literal: true
-
 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

@@ -0,0 +1,75 @@
+require "zip"
+
+module DocXify
+  class Container
+    attr_accessor :document
+
+    def initialize(document)
+      @document = document
+    end
+
+    def render
+      temp_file = Tempfile.new("docxify.zip")
+
+      Zip::OutputStream.open(temp_file) do |zip|
+        zip.put_next_entry "_rels/.rels"
+        zip.write DocXify::Template.top_level_rels
+
+        zip.put_next_entry "[Content_Types].xml"
+        zip.write DocXify::Template.content_types
+
+        zip.put_next_entry "word/theme/theme1.xml"
+        zip.write DocXify::Template.theme
+
+        zip.put_next_entry "word/fontTable.xml"
+        zip.write DocXify::Template.font_table
+
+        zip.put_next_entry "word/settings.xml"
+        zip.write DocXify::Template.settings
+
+        zip.put_next_entry "word/styles.xml"
+        zip.write DocXify::Template.styles
+
+        zip.put_next_entry "word/webSettings.xml"
+        zip.write DocXify::Template.web_settings
+
+        zip.put_next_entry "word/document.xml"
+        zip.write document.build_xml(self)
+
+        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
+        end
+      end
+
+      temp_file.flush
+      temp_file.rewind
+      temp_file.read
+    ensure
+      temp_file.close
+      temp_file.unlink
+    end
+
+    def document_xml_rels
+      xml = <<~XML
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+          <Relationship Id="rId3" Target="webSettings.xml" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings"/>
+          <Relationship Id="rId2" Target="settings.xml" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings"/>
+          <Relationship Id="rId1" Target="styles.xml" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"/>
+          <Relationship Id="rId5" Target="theme/theme1.xml" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme"/>
+          <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\"/>"
+      end
+
+      xml << "</Relationships>"
+      xml
+    end
+  end
+end

data/lib/docxify/document.rb

@@ -0,0 +1,98 @@
+module DocXify
+  class Document
+    attr_accessor :font, :size, :color, :background
+    attr_reader :content, :images
+
+    def initialize(options = {})
+      @content = []
+      @images = []
+      @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 }
+    end
+
+    def default_styling(options = {})
+      @font = options[:font] if options[:font]
+      @size = options[:size] if options[:size]
+      @color = options[:color] if options[:color]
+      @background = options[:background] if options[:background]
+    end
+
+    # MARK: Rendering
+
+    def render(path = nil)
+      container = DocXify::Container.new(self)
+
+      if path
+        File.write(path, container.render)
+      else
+        container.render
+      end
+    end
+
+    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:body>
+      XML
+
+      @content.each do |element|
+        xml << element.to_s(container)
+      end
+
+      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
+    end
+
+    # MARK: Elements
+
+    def add(element)
+      @content << element
+    end
+
+    def add_image(file_path_or_data, 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_file(file_path_or_data)
+      file = DocXify::Element::File.new(file_path_or_data)
+      @images << file
+      file
+    end
+
+    def add_page_break
+      add DocXify::Element::PageBreak.new
+    end
+
+    def add_divider
+      add DocXify::Element::Divider.new
+    end
+
+    def add_paragraph(text, options = {})
+      options[:document] = self
+      add DocXify::Element::Paragraph.new(text, options)
+    end
+
+    def add_table(headers, rows, options = {})
+      add DocXify::Element::Table.new(headers, rows, options)
+    end
+  end
+end