docxify 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6c9076520d0776ed132e2abbc42166a6ff0106fce181d5d178ecf3abff1a96
-  data.tar.gz: 042d1e27e5572cd0b4868eb9af065d1b3831e25d80569eafd2086bda130ab7b1
+  metadata.gz: c43501f65a265d3e8ce49ae0c5081d425c838465e31392b8e17c66c5d32214f9
+  data.tar.gz: efff6888d11c6ba8d9984150c0589d57e960b0e04fdc3daa79a2a458517b0fdd
 SHA512:
-  metadata.gz: 83ee99a55280b56efd7f571c00c8cb09eb026345b821173c389f40f3bffb907bc2f4b57ce08d6d587a0bc653cdbc4efc630a1400dd48e3dee78f005bf574469e
-  data.tar.gz: 62a9965149dde87c65db3877642fff5e6cf0cc8f02f373ab59422b78ca9a645522c2df45125268140f8b1e36b29a105b500ea06489f0fc5fee6056bff740bd6a
+  metadata.gz: c8dae5642665518f3c8be12d9a3d16a54ab626e3601b0b1073583f5c6f67cc80e31215e045f9ce593e520db7e35349d55363fee1f4713be4bb8eb7a704081780
+  data.tar.gz: 2d6aca43dba5dbe008f58e83a7bac426d6edb43aac83ba9812dc3eb1ab9bbe9218d128f88d6dfbd78fafaef38f8be32b1a97a47ba1519d13f4c86b81417c62c7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.8
+
+Features:
+
+- Allow changing of following section's page layout
+
 ## 0.0.7
 
 Features:

data/README.md

@@ -41,26 +41,26 @@ gem install docxify
 
 @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.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
+]
+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
 
 docx_binary_data = @docx.render
 # or

data/lib/docxify/document.rb

@@ -1,6 +1,6 @@
 module DocXify
   class Document
-    attr_accessor :font, :size, :color, :background
+    attr_accessor :font, :size, :color, :background, :margins, :page_layout
     attr_reader :content, :relationships, :width
 
     def initialize(options = {})
@@ -8,11 +8,12 @@ module DocXify
       @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
@@ -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

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/page_layout.rb

@@ -0,0 +1,34 @@
+# Word PageLayouts are a weird concept; instead of a wrapping element or a
+# "this applies to content from here on down", it's applied retrospectively
+# to the content that came before it.
+module DocXify
+  module Element
+    class PageLayout < Base
+      attr_accessor :width, :height, :orientation
+
+      def initialize(options = {})
+        super()
+        @document = options[:document]
+        @margins = @document.margins
+        @width = options[:width] || @document&.width || DocXify::A4_PORTRAIT_WIDTH
+        @height = options[:height] || @document&.height || DocXify::A4_PORTRAIT_HEIGHT
+        @orientation = options[:orientation] || :portrait
+      end
+
+      def to_s(_container = nil)
+        <<~XML
+          <w:p>
+            <w:pPr>
+              <w:sectPr>
+                <w:pgSz w:w="#{@width}" w:h="#{@height}" w:orient="#{@orientation}"/>
+                <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:pPr>
+          </w:p>
+        XML
+      end
+    end
+  end
+end

data/lib/docxify/version.rb

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

data/lib/docxify.rb

@@ -8,6 +8,7 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docxify
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -46,6 +46,7 @@ files:
 - lib/docxify/element/file.rb
 - lib/docxify/element/image.rb
 - lib/docxify/element/page_break.rb
+- lib/docxify/element/page_layout.rb
 - lib/docxify/element/paragraph.rb
 - lib/docxify/element/table.rb
 - lib/docxify/element/table_cell.rb
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: DocXify is a gem to help you generate Word documents from Ruby.