notare 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f9b8f11f3cbda0479fa7a05f428505475c572d46c8d0dfbad65af11740c3d5
-  data.tar.gz: 81a6c3ce45d3f3e8dece12d1c48f8bb3345760fdb6b8488ef5b9481860190367
+  metadata.gz: 1dd4e9ab394b198d4a9ddd59eb40fac35c865159e527fe14a90113bba1071fd0
+  data.tar.gz: e10d211085e797c80850ab3433b8802270df96bc01cd3d2ac348da6f17c675ec
 SHA512:
-  metadata.gz: 470684cd1e7a5ed4ee7169f3e01aa0547feee8ba13fe89c68bc7b556c50235d2c43b27e32dd0f66d97f16460a53a2b088e31d56e1c083a309ead256d14fd6d0d
-  data.tar.gz: bb58e3d474b6cea285fd548c6c87e9e3bfad55bce889ac4b2edb8cbdcdb9fb5557ff6d280992f29045338350522800b846ba6c99ede4143b14fb7ba45b4bfffd
+  metadata.gz: ba2c27ab7d6ad5a6f5b5239f54504e8352a5fee52374685f7e09d61284781ba93e9353a0c75f07a3e047571cc55d598c3764beb3c1d08663e54d11119e515fa5
+  data.tar.gz: b42bc57c20a639882a8912b1da7759b2c131443ce840f3d901a1a29a70a86e4f8238ce0b9d38ed688e0332fb99b77f7c5edcebffc611302273ede404c2a72197

data/README.md

@@ -105,6 +105,21 @@ Notare includes built-in styles and supports custom style definitions.
 
 #### Built-in Styles
 
+| Style | Properties |
+|-------|------------|
+| `:title` | 26pt, bold, centered |
+| `:subtitle` | 15pt, italic, gray (#666666) |
+| `:quote` | italic, gray (#666666), indented |
+| `:code` | Courier New, 10pt |
+| `:heading1` | 24pt, bold |
+| `:heading2` | 18pt, bold |
+| `:heading3` | 14pt, bold |
+| `:heading4` | 12pt, bold |
+| `:heading5` | 11pt, bold, italic |
+| `:heading6` | 10pt, bold, italic |
+
+Note: `h1` through `h6` methods use the corresponding heading styles automatically.
+
 ```ruby
 Notare::Document.create("output.docx") do |doc|
   doc.p "This is a title", style: :title
@@ -246,6 +261,77 @@ Notare::Document.create("output.docx") do |doc|
 end
 ```
 
+#### Table Styles
+
+Define reusable table styles with borders, shading, cell margins, and alignment:
+
+```ruby
+Notare::Document.create("output.docx") do |doc|
+  # Define a custom table style
+  doc.define_table_style :fancy,
+    borders: { style: "double", color: "0066CC", size: 6 },
+    shading: "E6F2FF",
+    cell_margins: 100,
+    align: :center
+
+  # Apply the style to a table
+  doc.table(style: :fancy) do
+    doc.tr do
+      doc.td "Product"
+      doc.td "Price"
+    end
+    doc.tr do
+      doc.td "Widget"
+      doc.td "$10.00"
+    end
+  end
+end
+```
+
+#### Table Style Properties
+
+| Property | Description | Example |
+|----------|-------------|---------|
+| `borders` | Border configuration | `{ style: "single", color: "000000", size: 4 }` |
+| `shading` | Background color (hex) | `"EEEEEE"` |
+| `cell_margins` | Cell padding (twips) | `100` or `{ top: 50, bottom: 50, left: 100, right: 100 }` |
+| `align` | Table alignment | `:left`, `:center`, `:right` |
+
+**Border styles:** `single`, `double`, `dotted`, `dashed`, `triple`, `none`
+
+**Border configuration options:**
+
+```ruby
+# All borders the same
+borders: { style: "single", color: "000000", size: 4 }
+
+# Per-edge borders
+borders: {
+  top: { style: "double", color: "FF0000", size: 8 },
+  bottom: { style: "single", color: "000000", size: 4 },
+  left: { style: "none" },
+  right: { style: "none" },
+  insideH: { style: "dotted", color: "CCCCCC", size: 2 },
+  insideV: { style: "dotted", color: "CCCCCC", size: 2 }
+}
+
+# No borders
+borders: :none
+```
+
+#### Built-in Table Styles
+
+| Style | Description |
+|-------|-------------|
+| `:grid` | Standard black single-line borders |
+| `:borderless` | No borders |
+
+```ruby
+doc.table(style: :borderless) do
+  doc.tr { doc.td "No borders here" }
+end
+```
+
 ### Images
 
 Images can be added to paragraphs, table cells, and list items. Supports PNG and JPEG formats.
@@ -434,12 +520,13 @@ end
 | `link(url, text)` | Hyperlink with custom text |
 | `link(url) { }` | Hyperlink with block content |
 | `define_style(name, **props)` | Define a custom style |
+| `define_table_style(name, **props)` | Define a custom table style |
 | `ul { }` | Bullet list (can be nested) |
 | `ol { }` | Numbered list (can be nested) |
 | `li(text)` | List item with text |
 | `li { }` | List item with block content |
 | `li(text) { }` | List item with text and nested content |
-| `table { }` | Table |
+| `table(style:) { }` | Table with optional style |
 | `tr { }` | Table row |
 | `td(text)` | Table cell with text |
 | `td { }` | Table cell with block content |

data/lib/notare/builder.rb

@@ -100,8 +100,8 @@ module Notare
       @current_list.add_item(item)
     end
 
-    def table(&block)
-      tbl = Nodes::Table.new
+    def table(style: nil, &block)
+      tbl = Nodes::Table.new(style: resolve_table_style(style))
       previous_table = @current_table
       @current_table = tbl
       block.call
@@ -198,5 +198,12 @@ module Notare
 
       style(style_or_name) || raise(ArgumentError, "Unknown style: #{style_or_name}")
     end
+
+    def resolve_table_style(style_or_name)
+      return nil if style_or_name.nil?
+      return style_or_name if style_or_name.is_a?(TableStyle)
+
+      table_style(style_or_name) || raise(ArgumentError, "Unknown table style: #{style_or_name}")
+    end
   end
 end

data/lib/notare/document.rb

@@ -4,7 +4,7 @@ module Notare
   class Document
     include Builder
 
-    attr_reader :nodes, :styles, :hyperlinks
+    attr_reader :nodes, :styles, :table_styles, :hyperlinks
 
     def self.create(path, &block)
       doc = new
@@ -25,7 +25,9 @@ module Notare
       @images = {}
       @hyperlinks = []
       @styles = {}
+      @table_styles = {}
       register_built_in_styles
+      register_built_in_table_styles
     end
 
     def define_style(name, **properties)
@@ -36,6 +38,14 @@ module Notare
       @styles[name]
     end
 
+    def define_table_style(name, **properties)
+      @table_styles[name] = TableStyle.new(name, **properties)
+    end
+
+    def table_style(name)
+      @table_styles[name]
+    end
+
     def save(path)
       Package.new(self).save(path)
     end
@@ -104,5 +114,13 @@ module Notare
       define_style :quote, italic: true, color: "666666", indent: 720
       define_style :code, font: "Courier New", size: 10
     end
+
+    def register_built_in_table_styles
+      define_table_style :grid,
+                         borders: { style: "single", color: "000000", size: 4 }
+
+      define_table_style :borderless,
+                         borders: :none
+    end
   end
 end

data/lib/notare/nodes/table.rb

@@ -3,11 +3,12 @@
 module Notare
   module Nodes
     class Table < Base
-      attr_reader :rows
+      attr_reader :rows, :style
 
-      def initialize
-        super
+      def initialize(style: nil)
+        super()
         @rows = []
+        @style = style
       end
 
       def add_row(row)

data/lib/notare/package.rb

@@ -59,7 +59,7 @@ module Notare
     end
 
     def styles_xml
-      Xml::StylesXml.new(@document.styles).to_xml
+      Xml::StylesXml.new(@document.styles, @document.table_styles).to_xml
     end
 
     def numbering_xml

data/lib/notare/table_style.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Notare
+  class TableStyle
+    attr_reader :name, :borders, :shading, :cell_margins, :align
+
+    BORDER_STYLES = %w[single double dotted dashed triple none nil].freeze
+    BORDER_POSITIONS = %i[top bottom left right insideH insideV].freeze
+    ALIGNMENTS = %i[left center right].freeze
+
+    def initialize(name, borders: nil, shading: nil, cell_margins: nil, align: nil)
+      @name = name
+      @borders = normalize_borders(borders)
+      @shading = normalize_color(shading)
+      @cell_margins = normalize_cell_margins(cell_margins)
+      @align = validate_align(align)
+    end
+
+    def style_id
+      name.to_s.split("_").map(&:capitalize).join
+    end
+
+    def display_name
+      name.to_s.split("_").map(&:capitalize).join(" ")
+    end
+
+    private
+
+    def normalize_borders(borders)
+      return nil if borders.nil?
+      return :none if borders == :none
+
+      # Check if it's a per-edge configuration
+      if borders.keys.any? { |k| BORDER_POSITIONS.include?(k) }
+        borders.transform_values { |v| normalize_single_border(v) }
+      else
+        # Single border config applied to all edges
+        normalize_single_border(borders)
+      end
+    end
+
+    def normalize_single_border(border)
+      return :none if border == :none || border[:style] == "none"
+
+      style = border[:style] || "single"
+      unless BORDER_STYLES.include?(style)
+        raise ArgumentError, "Invalid border style: #{style}. Use #{BORDER_STYLES.join(", ")}"
+      end
+
+      {
+        style: style,
+        color: normalize_color(border[:color]) || "000000",
+        size: border[:size] || 4
+      }
+    end
+
+    def normalize_color(color)
+      return nil if color.nil?
+
+      hex = color.to_s.sub(/^#/, "").upcase
+      return hex if hex.match?(/\A[0-9A-F]{6}\z/)
+
+      raise ArgumentError, "Invalid color: #{color}. Use 6-digit hex (e.g., 'FF0000')"
+    end
+
+    def normalize_cell_margins(margins)
+      return nil if margins.nil?
+
+      if margins.is_a?(Hash)
+        margins.slice(:top, :bottom, :left, :right)
+      else
+        margins.to_i
+      end
+    end
+
+    def validate_align(align)
+      return nil if align.nil?
+      return align if ALIGNMENTS.include?(align)
+
+      raise ArgumentError, "Invalid alignment: #{align}. Use #{ALIGNMENTS.join(", ")}"
+    end
+  end
+end

data/lib/notare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Notare
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/notare/xml/document_xml.rb

@@ -169,9 +169,13 @@ module Notare
         xml["w"].tbl do
           xml["w"].tblPr do
             xml["w"].tblW("w:w" => "5000", "w:type" => "pct")
-            xml["w"].tblBorders do
-              %w[top left bottom right insideH insideV].each do |border|
-                xml["w"].send(border, "w:val" => "single", "w:sz" => "4", "w:space" => "0", "w:color" => "000000")
+            if table.style
+              xml["w"].tblStyle("w:val" => table.style.style_id)
+            else
+              xml["w"].tblBorders do
+                %w[top left bottom right insideH insideV].each do |border|
+                  xml["w"].send(border, "w:val" => "single", "w:sz" => "4", "w:space" => "0", "w:color" => "000000")
+                end
               end
             end
           end

data/lib/notare/xml/styles_xml.rb

@@ -12,8 +12,15 @@ module Notare
         justify: "both"
       }.freeze
 
-      def initialize(styles)
+      TABLE_ALIGNMENT_MAP = {
+        left: "left",
+        center: "center",
+        right: "right"
+      }.freeze
+
+      def initialize(styles, table_styles = {})
         @styles = styles
+        @table_styles = table_styles
       end
 
       def to_xml
@@ -24,6 +31,10 @@ module Notare
             @styles.each_value do |style|
               render_style(xml, style)
             end
+
+            @table_styles.each_value do |style|
+              render_table_style(xml, style)
+            end
           end
         end
         builder.to_xml
@@ -63,6 +74,59 @@ module Notare
           xml["w"].highlight("w:val" => style.highlight) if style.highlight
         end
       end
+
+      def render_table_style(xml, style)
+        xml["w"].style("w:type" => "table", "w:styleId" => style.style_id) do
+          xml["w"].name("w:val" => style.display_name)
+
+          xml["w"].tblPr do
+            render_table_borders(xml, style.borders) if style.borders
+            render_table_shading(xml, style.shading) if style.shading
+            render_table_cell_margins(xml, style.cell_margins) if style.cell_margins
+            xml["w"].jc("w:val" => TABLE_ALIGNMENT_MAP[style.align]) if style.align
+          end
+        end
+      end
+
+      def render_table_borders(xml, borders)
+        xml["w"].tblBorders do
+          %i[top left bottom right insideH insideV].each do |pos|
+            border = borders == :none ? :none : (borders[pos] || borders)
+            render_single_border(xml, pos, border)
+          end
+        end
+      end
+
+      def render_single_border(xml, position, border)
+        if border == :none
+          xml["w"].send(position, "w:val" => "nil")
+        else
+          xml["w"].send(position,
+                        "w:val" => border[:style],
+                        "w:sz" => border[:size].to_s,
+                        "w:space" => "0",
+                        "w:color" => border[:color])
+        end
+      end
+
+      def render_table_shading(xml, color)
+        xml["w"].shd("w:val" => "clear", "w:color" => "auto", "w:fill" => color)
+      end
+
+      def render_table_cell_margins(xml, margins)
+        xml["w"].tblCellMar do
+          if margins.is_a?(Hash)
+            xml["w"].top("w:w" => margins[:top].to_s, "w:type" => "dxa") if margins[:top]
+            xml["w"].left("w:w" => margins[:left].to_s, "w:type" => "dxa") if margins[:left]
+            xml["w"].bottom("w:w" => margins[:bottom].to_s, "w:type" => "dxa") if margins[:bottom]
+            xml["w"].right("w:w" => margins[:right].to_s, "w:type" => "dxa") if margins[:right]
+          else
+            %i[top left bottom right].each do |side|
+              xml["w"].send(side, "w:w" => margins.to_s, "w:type" => "dxa")
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/notare.rb

@@ -16,6 +16,7 @@ require_relative "notare/nodes/table_row"
 require_relative "notare/nodes/table_cell"
 require_relative "notare/image_dimensions"
 require_relative "notare/style"
+require_relative "notare/table_style"
 require_relative "notare/xml/content_types"
 require_relative "notare/xml/relationships"
 require_relative "notare/xml/document_xml"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notare
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mathias
@@ -133,6 +133,7 @@ files:
 - lib/notare/nodes/table_row.rb
 - lib/notare/package.rb
 - lib/notare/style.rb
+- lib/notare/table_style.rb
 - lib/notare/version.rb
 - lib/notare/xml/content_types.rb
 - lib/notare/xml/document_xml.rb