notare 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913db4066f434c9f4fa4dda05b007642c08a08e44aecaaf105d12e77c7ab724e
-  data.tar.gz: 013f0cb3ce077237d040583a8ea39ce1718b0db7ff5b9b8ff89954e4a6386c3f
+  metadata.gz: 97f9b8f11f3cbda0479fa7a05f428505475c572d46c8d0dfbad65af11740c3d5
+  data.tar.gz: 81a6c3ce45d3f3e8dece12d1c48f8bb3345760fdb6b8488ef5b9481860190367
 SHA512:
-  metadata.gz: b078513721fac08090157247172d5e4ce06cbb0d10770d07169e630a147a9cef688180544c550ec0e441e6cbadbcc810dffcb51029de2c61b0a4c577af80442f
-  data.tar.gz: 80af9a1ea5e9d585b41d516b3c49418d28f7fe8314549958d420109b24d402f0e7fdd57e9536fa350665e1d5da310a6ed8497425f0b8b291d95fd606f87abdd2
+  metadata.gz: 470684cd1e7a5ed4ee7169f3e01aa0547feee8ba13fe89c68bc7b556c50235d2c43b27e32dd0f66d97f16460a53a2b088e31d56e1c083a309ead256d14fd6d0d
+  data.tar.gz: bb58e3d474b6cea285fd548c6c87e9e3bfad55bce889ac4b2edb8cbdcdb9fb5557ff6d280992f29045338350522800b846ba6c99ede4143b14fb7ba45b4bfffd

data/README.md

@@ -58,6 +58,8 @@ Notare::Document.create("output.docx") do |doc|
     doc.i { doc.text "italic" }
     doc.text " and "
     doc.u { doc.text "underlined" }
+    doc.text " and "
+    doc.s { doc.text "strikethrough" }
   end
 
   # Nested formatting (bold + italic)
@@ -66,6 +68,13 @@ Notare::Document.create("output.docx") do |doc|
       doc.i { doc.text "bold and italic" }
     end
   end
+
+  # Show edits (strikethrough old, bold new)
+  doc.p do
+    doc.s { doc.text "old text" }
+    doc.text " "
+    doc.b { doc.text "new text" }
+  end
 end
 ```
 
@@ -146,10 +155,14 @@ end
 - `bold: true/false`
 - `italic: true/false`
 - `underline: true/false`
+- `strike: true/false` - strikethrough
+- `highlight: "yellow"` - text highlight (see colors below)
 - `color: "FF0000"` (hex RGB)
 - `size: 14` (points)
 - `font: "Arial"` (font family)
 
+**Highlight colors:** `black`, `blue`, `cyan`, `darkBlue`, `darkCyan`, `darkGray`, `darkGreen`, `darkMagenta`, `darkRed`, `darkYellow`, `green`, `lightGray`, `magenta`, `red`, `white`, `yellow`
+
 **Paragraph properties:**
 - `align: :left / :center / :right / :justify`
 - `indent: 720` (twips, 1 inch = 1440 twips)
@@ -182,6 +195,40 @@ Notare::Document.create("output.docx") do |doc|
 end
 ```
 
+#### Nested Lists
+
+Lists can be nested inside list items. Mixed types (bullets inside numbered or vice versa) are supported.
+
+```ruby
+Notare::Document.create("output.docx") do |doc|
+  doc.ol do
+    doc.li "First item"
+    doc.li "Second item" do
+      doc.ul do
+        doc.li "Nested bullet A"
+        doc.li "Nested bullet B"
+      end
+    end
+    doc.li "Third item"
+  end
+
+  # Deeply nested
+  doc.ul do
+    doc.li "Level 0"
+    doc.li "Has children" do
+      doc.ul do
+        doc.li "Level 1"
+        doc.li "Goes deeper" do
+          doc.ul do
+            doc.li "Level 2"
+          end
+        end
+      end
+    end
+  end
+end
+```
+
 ### Tables
 
 ```ruby
@@ -246,6 +293,91 @@ Notare::Document.create("output.docx") do |doc|
 end
 ```
 
+### Line Breaks
+
+Use `br` for soft line breaks within a paragraph (text continues in the same paragraph but on a new line):
+
+```ruby
+Notare::Document.create("output.docx") do |doc|
+  doc.p do
+    doc.text "Line one"
+    doc.br
+    doc.text "Line two (same paragraph)"
+    doc.br
+    doc.text "Line three"
+  end
+
+  # Useful for addresses
+  doc.p do
+    doc.b { doc.text "Address:" }
+    doc.br
+    doc.text "123 Main Street"
+    doc.br
+    doc.text "Anytown, ST 12345"
+  end
+end
+```
+
+### Page Breaks
+
+Use `page_break` to force content to start on a new page:
+
+```ruby
+Notare::Document.create("output.docx") do |doc|
+  doc.h1 "Chapter 1"
+  doc.p "Content of chapter 1..."
+
+  doc.page_break
+
+  doc.h1 "Chapter 2"
+  doc.p "This starts on a new page."
+end
+```
+
+### Hyperlinks
+
+Add clickable links with `link`:
+
+```ruby
+Notare::Document.create("output.docx") do |doc|
+  # Link with custom text
+  doc.p do
+    doc.text "Visit "
+    doc.link "https://example.com", "our website"
+    doc.text " for more info."
+  end
+
+  # Link showing the URL as text
+  doc.p do
+    doc.text "URL: "
+    doc.link "https://example.com"
+  end
+
+  # Link with formatted content
+  doc.p do
+    doc.link "https://github.com" do
+      doc.b { doc.text "GitHub" }
+    end
+  end
+
+  # Links in lists
+  doc.ul do
+    doc.li do
+      doc.link "https://ruby-lang.org", "Ruby"
+    end
+    doc.li do
+      doc.link "https://rubyonrails.org", "Rails"
+    end
+  end
+
+  # Email links
+  doc.p do
+    doc.text "Contact: "
+    doc.link "mailto:hello@example.com", "hello@example.com"
+  end
+end
+```
+
 ### Complete Example
 
 ```ruby
@@ -296,11 +428,17 @@ end
 | `b { }` | Bold formatting |
 | `i { }` | Italic formatting |
 | `u { }` | Underline formatting |
+| `s { }` | Strikethrough formatting |
+| `br` | Line break (soft break within paragraph) |
+| `page_break` | Page break (force new page) |
+| `link(url, text)` | Hyperlink with custom text |
+| `link(url) { }` | Hyperlink with block content |
 | `define_style(name, **props)` | Define a custom style |
-| `ul { }` | Bullet list |
-| `ol { }` | Numbered list |
+| `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 |
 | `tr { }` | Table row |
 | `td(text)` | Table cell with text |

data/lib/notare/builder.rb

@@ -60,6 +60,30 @@ module Notare
       with_format(:underline, &block)
     end
 
+    def s(&block)
+      with_format(:strike, &block)
+    end
+
+    def br
+      @current_target.add_run(Nodes::Break.new(type: :line))
+    end
+
+    def page_break
+      @nodes << Nodes::Break.new(type: :page)
+    end
+
+    def link(url, text = nil, &block)
+      hyperlink = register_hyperlink(url)
+      if block
+        with_target(hyperlink, &block)
+      elsif text
+        hyperlink.add_run(Nodes::Run.new(text, underline: true, color: "0000FF"))
+      else
+        hyperlink.add_run(Nodes::Run.new(url, underline: true, color: "0000FF"))
+      end
+      @current_target.add_run(hyperlink)
+    end
+
     def ul(&block)
       list(:bullet, &block)
     end
@@ -69,12 +93,10 @@ module Notare
     end
 
     def li(text = nil, &block)
-      item = Nodes::ListItem.new([], list_type: @current_list.type, num_id: @current_list.num_id)
-      if block
-        with_target(item, &block)
-      elsif text
-        item.add_run(Nodes::Run.new(text, **current_formatting))
-      end
+      current_type = @list_type_stack.last
+      item = Nodes::ListItem.new([], list_type: current_type, num_id: @current_list.num_id, level: @list_level)
+      item.add_run(Nodes::Run.new(text, **current_formatting)) if text
+      with_target(item, &block) if block
       @current_list.add_item(item)
     end
 
@@ -110,14 +132,31 @@ module Notare
 
     def list(type, &block)
       @num_id_counter ||= 0
-      @num_id_counter += 1
+      @list_level ||= 0
+      @list_type_stack ||= []
 
-      list_node = Nodes::List.new(type: type, num_id: @num_id_counter)
       previous_list = @current_list
-      @current_list = list_node
-      block.call
-      @current_list = previous_list
-      @nodes << list_node
+      nested = !previous_list.nil?
+
+      if nested
+        # Nested list: reuse parent list, push new type, increment level
+        @list_level += 1
+        @list_type_stack.push(type)
+        block.call
+        @list_type_stack.pop
+        @list_level -= 1
+      else
+        # Top-level list: new List node
+        @num_id_counter += 1
+        mark_has_lists!
+        list_node = Nodes::List.new(type: type, num_id: @num_id_counter)
+        @list_type_stack.push(type)
+        @current_list = list_node
+        block.call
+        @current_list = previous_list
+        @list_type_stack.pop
+        @nodes << list_node
+      end
     end
 
     def with_format(format, &block)
@@ -139,7 +178,8 @@ module Notare
       {
         bold: @format_stack.include?(:bold),
         italic: @format_stack.include?(:italic),
-        underline: @format_stack.include?(:underline)
+        underline: @format_stack.include?(:underline),
+        strike: @format_stack.include?(:strike)
       }
     end
 

data/lib/notare/document.rb

@@ -4,7 +4,7 @@ module Notare
   class Document
     include Builder
 
-    attr_reader :nodes, :styles
+    attr_reader :nodes, :styles, :hyperlinks
 
     def self.create(path, &block)
       doc = new
@@ -21,7 +21,9 @@ module Notare
       @current_table = nil
       @current_row = nil
       @num_id_counter = 0
+      @has_lists = false
       @images = {}
+      @hyperlinks = []
       @styles = {}
       register_built_in_styles
     end
@@ -42,10 +44,25 @@ module Notare
       @nodes.select { |n| n.is_a?(Nodes::List) }
     end
 
+    def uses_lists?
+      @has_lists
+    end
+
+    def mark_has_lists!
+      @has_lists = true
+    end
+
     def images
       @images.values
     end
 
+    def register_hyperlink(url)
+      rid = next_hyperlink_rid
+      hyperlink = Nodes::Hyperlink.new(url: url, rid: rid)
+      @hyperlinks << hyperlink
+      hyperlink
+    end
+
     def register_image(path, width: nil, height: nil)
       return @images[path] if @images[path]
 
@@ -61,11 +78,17 @@ module Notare
     def next_image_rid
       # rId1 = styles.xml (always present)
       # rId2 = numbering.xml (if lists present)
-      # rId3+ = images
-      base = lists.any? ? 3 : 2
+      # rId3+ = images, then hyperlinks
+      base = @has_lists ? 3 : 2
       "rId#{base + @images.size}"
     end
 
+    def next_hyperlink_rid
+      # Hyperlinks come after images
+      base = @has_lists ? 3 : 2
+      "rId#{base + @images.size + @hyperlinks.size}"
+    end
+
     def register_built_in_styles
       # Headings (spacing_before ensures they're rendered as paragraph styles)
       define_style :heading1, size: 24, bold: true, spacing_before: 240, spacing_after: 120

data/lib/notare/nodes/break.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Notare
+  module Nodes
+    class Break < Base
+      attr_reader :type
+
+      def initialize(type: :line)
+        super()
+        @type = type
+      end
+
+      def page?
+        type == :page
+      end
+    end
+  end
+end

data/lib/notare/nodes/hyperlink.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Notare
+  module Nodes
+    class Hyperlink < Base
+      attr_reader :url, :rid, :runs
+
+      def initialize(url:, rid:)
+        super()
+        @url = url
+        @rid = rid
+        @runs = []
+      end
+
+      def add_run(run)
+        @runs << run
+      end
+    end
+  end
+end

data/lib/notare/nodes/list_item.rb

@@ -3,13 +3,14 @@
 module Notare
   module Nodes
     class ListItem < Base
-      attr_reader :runs, :list_type, :num_id
+      attr_reader :runs, :list_type, :num_id, :level
 
-      def initialize(runs = [], list_type:, num_id:)
+      def initialize(runs = [], list_type:, num_id:, level: 0)
         super()
         @runs = runs
         @list_type = list_type
         @num_id = num_id
+        @level = level
       end
 
       def add_run(run)

data/lib/notare/nodes/run.rb

@@ -3,14 +3,18 @@
 module Notare
   module Nodes
     class Run < Base
-      attr_reader :text, :bold, :italic, :underline, :style
+      attr_reader :text, :bold, :italic, :underline, :strike, :highlight, :color, :style
 
-      def initialize(text, bold: false, italic: false, underline: false, style: nil)
+      def initialize(text, bold: false, italic: false, underline: false,
+                     strike: false, highlight: nil, color: nil, style: nil)
         super()
         @text = text
         @bold = bold
         @italic = italic
         @underline = underline
+        @strike = strike
+        @highlight = highlight
+        @color = color
         @style = style
       end
     end

data/lib/notare/package.rb

@@ -29,13 +29,17 @@ module Notare
     private
 
     def lists?
-      @document.lists.any?
+      @document.uses_lists?
     end
 
     def images
       @document.images
     end
 
+    def hyperlinks
+      @document.hyperlinks
+    end
+
     def content_types_xml
       Xml::ContentTypes.new(has_numbering: lists?, images: images, has_styles: true).to_xml
     end
@@ -45,7 +49,9 @@ module Notare
     end
 
     def document_relationships_xml
-      Xml::DocumentRelationships.new(has_numbering: lists?, images: images, has_styles: true).to_xml
+      Xml::DocumentRelationships.new(
+        has_numbering: lists?, images: images, hyperlinks: hyperlinks, has_styles: true
+      ).to_xml
     end
 
     def document_xml

data/lib/notare/style.rb

@@ -2,18 +2,24 @@
 
 module Notare
   class Style
-    attr_reader :name, :bold, :italic, :underline, :color, :size, :font,
+    attr_reader :name, :bold, :italic, :underline, :strike, :highlight, :color, :size, :font,
                 :align, :indent, :spacing_before, :spacing_after
 
     ALIGNMENTS = %i[left center right justify].freeze
+    HIGHLIGHT_COLORS = %w[
+      black blue cyan darkBlue darkCyan darkGray darkGreen darkMagenta
+      darkRed darkYellow green lightGray magenta red white yellow
+    ].freeze
 
-    def initialize(name, bold: nil, italic: nil, underline: nil, color: nil,
-                   size: nil, font: nil, align: nil, indent: nil,
-                   spacing_before: nil, spacing_after: nil)
+    def initialize(name, bold: nil, italic: nil, underline: nil, strike: nil,
+                   highlight: nil, color: nil, size: nil, font: nil, align: nil,
+                   indent: nil, spacing_before: nil, spacing_after: nil)
       @name = name
       @bold = bold
       @italic = italic
       @underline = underline
+      @strike = strike
+      @highlight = validate_highlight(highlight)
       @color = normalize_color(color)
       @size = size
       @font = font
@@ -36,7 +42,7 @@ module Notare
     end
 
     def text_properties?
-      !!(bold || italic || underline || color || size || font)
+      !!(bold || italic || underline || strike || highlight || color || size || font)
     end
 
     # Size in half-points for OOXML (14pt = 28 half-points)
@@ -61,5 +67,14 @@ module Notare
 
       raise ArgumentError, "Invalid alignment: #{align}. Use #{ALIGNMENTS.join(", ")}"
     end
+
+    def validate_highlight(highlight)
+      return nil if highlight.nil?
+
+      color = highlight.to_s
+      return color if HIGHLIGHT_COLORS.include?(color)
+
+      raise ArgumentError, "Invalid highlight color: #{highlight}. Use one of: #{HIGHLIGHT_COLORS.join(", ")}"
+    end
   end
 end

data/lib/notare/version.rb

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

data/lib/notare/xml/document_xml.rb

@@ -37,6 +37,16 @@ module Notare
           render_list(xml, node)
         when Nodes::Table
           render_table(xml, node)
+        when Nodes::Break
+          render_page_break(xml, node)
+        end
+      end
+
+      def render_page_break(xml, _node)
+        xml["w"].p do
+          xml["w"].r do
+            xml["w"].br("w:type" => "page")
+          end
         end
       end
 
@@ -59,7 +69,7 @@ module Notare
         xml["w"].p do
           xml["w"].pPr do
             xml["w"].numPr do
-              xml["w"].ilvl("w:val" => "0")
+              xml["w"].ilvl("w:val" => item.level.to_s)
               xml["w"].numId("w:val" => item.num_id.to_s)
             end
           end
@@ -71,19 +81,42 @@ module Notare
         case run
         when Nodes::Image
           render_image(xml, run)
+        when Nodes::Break
+          render_break(xml, run)
+        when Nodes::Hyperlink
+          render_hyperlink(xml, run)
         when Nodes::Run
           render_text_run(xml, run)
         end
       end
 
+      def render_hyperlink(xml, hyperlink)
+        xml["w"].hyperlink("r:id" => hyperlink.rid) do
+          hyperlink.runs.each { |run| render_run(xml, run) }
+        end
+      end
+
+      def render_break(xml, break_node)
+        xml["w"].r do
+          if break_node.page?
+            xml["w"].br("w:type" => "page")
+          else
+            xml["w"].br
+          end
+        end
+      end
+
       def render_text_run(xml, run)
         xml["w"].r do
-          if run.bold || run.italic || run.underline || run.style
+          if run.bold || run.italic || run.underline || run.strike || run.highlight || run.color || run.style
             xml["w"].rPr do
               xml["w"].rStyle("w:val" => run.style.style_id) if run.style
               xml["w"].b if run.bold
               xml["w"].i if run.italic
               xml["w"].u("w:val" => "single") if run.underline
+              xml["w"].strike if run.strike
+              xml["w"].highlight("w:val" => run.highlight) if run.highlight
+              xml["w"].color("w:val" => run.color) if run.color
             end
           end
           xml["w"].t(run.text, "xml:space" => "preserve")

data/lib/notare/xml/numbering.rb

@@ -4,6 +4,8 @@ module Notare
   module Xml
     class Numbering
       NAMESPACE = "http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+      BULLET_CHARS = ["•", "○", "■"].freeze
+      NUMBER_FORMATS = %w[decimal lowerLetter lowerRoman].freeze
 
       def initialize(lists)
         @lists = lists
@@ -28,13 +30,16 @@ module Notare
 
       def render_abstract_num(xml, list)
         xml["w"].abstractNum("w:abstractNumId" => list.num_id.to_s) do
-          xml["w"].lvl("w:ilvl" => "0") do
-            xml["w"].start("w:val" => "1")
-            xml["w"].numFmt("w:val" => num_format(list.type))
-            xml["w"].lvlText("w:val" => lvl_text(list.type))
-            xml["w"].lvlJc("w:val" => "left")
-            xml["w"].pPr do
-              xml["w"].ind("w:left" => "720", "w:hanging" => "360")
+          9.times do |level|
+            xml["w"].lvl("w:ilvl" => level.to_s) do
+              xml["w"].start("w:val" => "1")
+              xml["w"].numFmt("w:val" => num_format_for_level(list.type, level))
+              xml["w"].lvlText("w:val" => lvl_text_for_level(list.type, level))
+              xml["w"].lvlJc("w:val" => "left")
+              xml["w"].pPr do
+                left = 720 * (level + 1)
+                xml["w"].ind("w:left" => left.to_s, "w:hanging" => "360")
+              end
             end
           end
         end
@@ -46,12 +51,20 @@ module Notare
         end
       end
 
-      def num_format(type)
-        type == :bullet ? "bullet" : "decimal"
+      def num_format_for_level(type, level)
+        if type == :bullet
+          "bullet"
+        else
+          NUMBER_FORMATS[level % NUMBER_FORMATS.length]
+        end
       end
 
-      def lvl_text(type)
-        type == :bullet ? "•" : "%1."
+      def lvl_text_for_level(type, level)
+        if type == :bullet
+          BULLET_CHARS[level % BULLET_CHARS.length]
+        else
+          "%#{level + 1}."
+        end
       end
     end
   end

data/lib/notare/xml/relationships.rb

@@ -24,10 +24,12 @@ module Notare
       STYLES_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"
       NUMBERING_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering"
       IMAGE_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
+      HYPERLINK_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
 
-      def initialize(has_numbering: false, images: [], has_styles: false)
+      def initialize(has_numbering: false, images: [], hyperlinks: [], has_styles: false)
         @has_numbering = has_numbering
         @images = images
+        @hyperlinks = hyperlinks
         @has_styles = has_styles
       end
 
@@ -60,6 +62,16 @@ module Notare
                 Target: "media/#{image.filename}"
               )
             end
+
+            # Hyperlinks come after images
+            @hyperlinks.each do |hyperlink|
+              xml.Relationship(
+                Id: hyperlink.rid,
+                Type: HYPERLINK_TYPE,
+                Target: hyperlink.url,
+                TargetMode: "External"
+              )
+            end
           end
         end
         builder.to_xml

data/lib/notare/xml/styles_xml.rb

@@ -59,6 +59,8 @@ module Notare
           xml["w"].b if style.bold
           xml["w"].i if style.italic
           xml["w"].u("w:val" => "single") if style.underline
+          xml["w"].strike if style.strike
+          xml["w"].highlight("w:val" => style.highlight) if style.highlight
         end
       end
     end

data/lib/notare.rb

@@ -4,6 +4,8 @@ require "nokogiri"
 
 require_relative "notare/version"
 require_relative "notare/nodes/base"
+require_relative "notare/nodes/break"
+require_relative "notare/nodes/hyperlink"
 require_relative "notare/nodes/run"
 require_relative "notare/nodes/image"
 require_relative "notare/nodes/paragraph"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notare
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mathias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-02 00:00:00.000000000 Z
+date: 2025-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage
@@ -121,6 +121,8 @@ files:
 - lib/notare/document.rb
 - lib/notare/image_dimensions.rb
 - lib/notare/nodes/base.rb
+- lib/notare/nodes/break.rb
+- lib/notare/nodes/hyperlink.rb
 - lib/notare/nodes/image.rb
 - lib/notare/nodes/list.rb
 - lib/notare/nodes/list_item.rb