tiptap-ruby 0.9.18 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f80fc490b18b20992c6187a203bf0a95c15877fdf3fcf03a8251044c0f291a3
-  data.tar.gz: da90c78641f97b707c73c4cabb7417751e3a4464d86ad0559fb0e754fcec1cac
+  metadata.gz: 2745d7dc0e8cc41e8be3aca7a626fe0c20205ab6331768efe30d43a7dba967cd
+  data.tar.gz: cd62d869e49297848d9c27a647edc9992b78d55b3941ce04b73a930dbeb3fbc5
 SHA512:
-  metadata.gz: 5fa946d32ebd379a5ff23445b984fcd8fae6573156864d4c0542278af90f08dea4631b8f37ad34510b40ed70c68b9998ab125bb58a8f8290d50a1a8867760999
-  data.tar.gz: 4790cb500b05a7cb3fa900d8a7d73998511a148b6940d6e8ccb53aaeaa2f88bf2520c9ece3b3fb82e9e3844562741390cc91971323e10e8d818a66d0c606d4c7
+  metadata.gz: c49c2d3449cac786dcc90531dcfb25c010af8918302db6b6733fdcca8cc5ad52b0fd462684032405172647a9168e787ade66716074f7f74afeac74e249cc4ae2
+  data.tar.gz: 959a97bfe7556e49a36acf26a8a09a60338fc41d57bd1ead6d7111144d19735908e8f1af851709f383371ebf2cab6a1fcd8428954188044a3efbe60294723135

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.10.0] - 2025-09-19
+
+- Add support for rendering documents to markdown
+- Update rexml for CVE
+
 ## [0.9.16] - 2025-04-22
 
 - Update Nokogiri for CVE

data/README.md

@@ -68,6 +68,14 @@ document.to_h # => { type: 'doc', content: […nodes]}
 document.to_html # => <div class="tiptap-document"><h1><em>My Important Document</em></h1></div>
 ```
 
+### Markdown
+
+Generate GitHub-flavored Markdown that preserves nested lists, code blocks, tables, and inline marks.
+
+```ruby
+document.to_markdown # => "# My Important Document\n\n- Item one\n- Item two"
+```
+
 ### Plain Text
 
 Rendering to plain text is useful if you want to search the contents of your TipTap content.

data/lib/tip_tap/markdown_renderable.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module TipTap
+  module Markdown
+    # Rendering context for markdown serialization. Tracks indentation
+    # for nested blocks and whether we are currently inside a fenced
+    # code block so nodes can adjust formatting.
+    class Context
+      attr_reader :indent, :within_code_block
+
+      def initialize(indent: 0, within_code_block: false)
+        @indent = indent
+        @within_code_block = within_code_block
+      end
+
+      def self.root
+        new
+      end
+
+      def indentation
+        " " * indent
+      end
+
+      def increase_indent(amount)
+        self.class.new(indent: indent + amount, within_code_block: within_code_block)
+      end
+
+      def with_code_block
+        self.class.new(indent: indent, within_code_block: true)
+      end
+
+      def within_code_block?
+        within_code_block
+      end
+    end
+  end
+
+  module MarkdownRenderable
+    def to_markdown(context = Markdown::Context.root)
+      rendered_blocks = content.map { |node| node.to_markdown(context) }.reject(&:blank?)
+      rendered_blocks.join("\n\n").gsub(/\n{3,}/, "\n\n").rstrip
+    end
+  end
+end

data/lib/tip_tap/node.rb

@@ -4,6 +4,7 @@ require "tip_tap/registerable"
 require "tip_tap/html_renderable"
 require "tip_tap/json_renderable"
 require "tip_tap/plain_text_renderable"
+require "tip_tap/markdown_renderable"
 require "tip_tap/has_content"
 
 # This is the base class for all TipTap nodes.
@@ -16,5 +17,6 @@ module TipTap
     include HtmlRenderable
     include JsonRenderable
     include PlainTextRenderable
+    include MarkdownRenderable
   end
 end

data/lib/tip_tap/nodes/blockquote.rb

@@ -14,6 +14,15 @@ module TipTap
 
         add_content(Paragraph.new(&block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        inner = super(context)
+        lines = inner.split("\n", -1)
+        quoted = lines.map do |line|
+          line.strip.empty? ? ">" : "> #{line}"
+        end
+        quoted.join("\n")
+      end
     end
   end
 end

data/lib/tip_tap/nodes/bullet_list.rb

@@ -14,6 +14,10 @@ module TipTap
 
         add_content(ListItem.new(&block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        content.map { |node| node.to_markdown(context, marker: "- ") }.join("\n")
+      end
     end
   end
 end

data/lib/tip_tap/nodes/codeblock.rb

@@ -11,6 +11,15 @@ module TipTap
       def code(text)
         add_content(Text.new(text, marks: [{type: "code"}]))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        fence_language = attrs["language"].presence || attrs["lang"].presence
+        fence_header = "```#{fence_language}"
+        code_context = context.with_code_block
+        body = content.map { |node| node.to_markdown(code_context) }.join
+        body = "#{body}\n" unless body.end_with?("\n") || body.empty?
+        "#{fence_header}\n#{body}```"
+      end
     end
   end
 end

data/lib/tip_tap/nodes/hard_break.rb

@@ -14,6 +14,10 @@ module TipTap
       def to_html
         tag.br
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        "  \n"
+      end
     end
   end
 end

data/lib/tip_tap/nodes/heading.rb

@@ -15,6 +15,13 @@ module TipTap
       def level
         attrs["level"]
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        heading_level = [level.to_i, 1].max
+        prefix = "#" * heading_level
+        body = content.map { |node| node.to_markdown(context) }.join.strip
+        body.empty? ? prefix : "#{prefix} #{body}"
+      end
     end
   end
 end

data/lib/tip_tap/nodes/horizontal_rule.rb

@@ -14,6 +14,10 @@ module TipTap
       def to_html
         tag.hr
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        "---"
+      end
     end
   end
 end

data/lib/tip_tap/nodes/image.rb

@@ -15,6 +15,15 @@ module TipTap
         image_tag(src, alt: alt)
       end
 
+      def to_markdown(context = Markdown::Context.root)
+        return "" if src.blank?
+
+        alt_text = alt.to_s
+        escaped_alt = alt_text.gsub("[", "\\[").gsub("]", "\\]")
+        escaped_src = src.to_s.gsub("(", "\\(").gsub(")", "\\)")
+        "![#{escaped_alt}](#{escaped_src})"
+      end
+
       def alt
         attrs["alt"]
       end

data/lib/tip_tap/nodes/list_item.rb

@@ -14,6 +14,79 @@ module TipTap
 
         add_content(Paragraph.new(&block))
       end
+
+      def bullet_list(&block)
+        raise ArgumentError, "Block required" if block.nil?
+
+        add_content(BulletList.new(&block))
+      end
+
+      def ordered_list(&block)
+        raise ArgumentError, "Block required" if block.nil?
+
+        add_content(OrderedList.new(&block))
+      end
+
+      def task_list(&block)
+        raise ArgumentError, "Block required" if block.nil?
+
+        add_content(TaskList.new(&block))
+      end
+
+      def to_markdown(context = Markdown::Context.root, marker: "- ")
+        marker_length = marker.length
+        first_prefix = context.indentation + marker
+        rest_prefix = " " * (context.indent + marker_length)
+        child_context = context.increase_indent(marker_length)
+
+        segments = content.map do |node|
+          if list_node?(node)
+            {type: :list, text: node.to_markdown(child_context)}
+          elsif paragraph_node?(node)
+            {type: :inline, text: node.to_markdown(child_context)}
+          else
+            {type: :block, text: node.to_markdown(child_context)}
+          end
+        end
+
+        first_segment = segments.shift || {type: :inline, text: ""}
+        first_text = (first_segment[:type] == :list) ? "" : first_segment[:text]
+        result = format_block(first_text, first_prefix, rest_prefix)
+
+        segments.each do |segment|
+          case segment[:type]
+          when :list
+            result << "\n" unless result.end_with?("\n")
+            result << segment[:text]
+          else
+            result << "\n\n"
+            result << format_block(segment[:text], rest_prefix, rest_prefix)
+          end
+        end
+
+        result
+      end
+
+      private
+
+      def paragraph_node?(node)
+        node.is_a?(Paragraph)
+      end
+
+      def list_node?(node)
+        node.is_a?(BulletList) || node.is_a?(OrderedList) || node.is_a?(TaskList)
+      end
+
+      def format_block(text, first_prefix, rest_prefix)
+        lines = text.to_s.split("\n", -1)
+        return first_prefix if lines.empty?
+
+        formatted = "#{first_prefix}#{lines.first}"
+        lines[1..]&.each do |line|
+          formatted << "\n#{rest_prefix}#{line}"
+        end
+        formatted
+      end
     end
   end
 end

data/lib/tip_tap/nodes/ordered_list.rb

@@ -18,6 +18,16 @@ module TipTap
       def start
         attrs["start"]
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        starting_index = start.to_i
+        starting_index = 1 if starting_index <= 0
+
+        content.each_with_index.map do |node, index|
+          marker = "#{starting_index + index}. "
+          node.to_markdown(context, marker: marker)
+        end.join("\n")
+      end
     end
   end
 end

data/lib/tip_tap/nodes/paragraph.rb

@@ -12,6 +12,10 @@ module TipTap
         add_content(Text.new(text, marks: marks))
       end
 
+      def to_markdown(context = Markdown::Context.root)
+        content.map { |node| node.to_markdown(context) }.join
+      end
+
       # Override the default to_plain_text method to account for the nested Text nodes
       # we don't want to use the separator when joining the text nodes since it could
       # be a newline or some other character that we don't want to include in the plain text

data/lib/tip_tap/nodes/table.rb

@@ -13,6 +13,41 @@ module TipTap
 
         add_content(TableRow.new(&block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        rows_data = content.map { |row| row.to_markdown_row(context) }
+        return "" if rows_data.empty?
+
+        column_count = rows_data.map { |row| row[:cells].size }.max || 0
+        return "" if column_count.zero?
+
+        header_index = rows_data.index { |row| row[:is_header] }
+        header_cells = if header_index
+          rows_data.delete_at(header_index)[:cells]
+        else
+          Array.new(column_count, "")
+        end
+
+        header_cells = pad_cells(header_cells, column_count)
+        separator_cells = Array.new(column_count, "---")
+        body_rows = rows_data.map { |row| pad_cells(row[:cells], column_count) }
+
+        lines = []
+        lines << format_row(header_cells)
+        lines << format_row(separator_cells)
+        body_rows.each { |cells| lines << format_row(cells) }
+        lines.join("\n")
+      end
+
+      private
+
+      def pad_cells(cells, desired_size)
+        Array.new(desired_size) { |index| cells[index] || "" }
+      end
+
+      def format_row(cells)
+        "| #{cells.join(" | ")} |"
+      end
     end
   end
 end

data/lib/tip_tap/nodes/table_cell.rb

@@ -13,6 +13,12 @@ module TipTap
 
         add_content(Paragraph.new(&block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        values = content.map { |node| node.to_markdown(context) }.reject(&:blank?)
+        joined = values.join("<br>")
+        joined.gsub("\n\n", "<br><br>").gsub("\n", "<br>")
+      end
     end
   end
 end

data/lib/tip_tap/nodes/table_header.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "tip_tap/node"
+require "tip_tap/nodes/table_cell"
 
 module TipTap
   module Nodes
-    class TableHeader < Node
+    class TableHeader < TableCell
       self.type_name = "tableHeader"
       self.html_tag = :th
 

data/lib/tip_tap/nodes/table_row.rb

@@ -19,6 +19,18 @@ module TipTap
 
         add_content(TableHeader.new(&block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        row_data = to_markdown_row(context)
+        "| #{row_data[:cells].join(" | ")} |"
+      end
+
+      def to_markdown_row(context)
+        {
+          cells: content.map { |node| node.to_markdown(context) },
+          is_header: content.all? { |node| node.is_a?(TableHeader) }
+        }
+      end
     end
   end
 end

data/lib/tip_tap/nodes/task_item.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 
-require "tip_tap/node"
+require "tip_tap/nodes/list_item"
 
 module TipTap
   module Nodes
-    class TaskItem < Node
+    class TaskItem < ListItem
       self.type_name = "taskItem"
       self.html_tag = :li
       self.html_class_name = proc { class_names("task-item", {checked: checked?}) }
 
-      def paragraph(&block)
-        raise ArgumentError, "Block required" if block.nil?
-
-        add_content(Paragraph.new(&block))
-      end
-
       def checked?
         attrs["checked"]
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        marker = checked? ? "- [x] " : "- [ ] "
+        super(context, marker: marker)
+      end
     end
   end
 end

data/lib/tip_tap/nodes/task_list.rb

@@ -14,6 +14,10 @@ module TipTap
 
         add_content(TaskItem.new(checked: checked, &block))
       end
+
+      def to_markdown(context = Markdown::Context.root)
+        content.map { |node| node.to_markdown(context) }.join("\n")
+      end
     end
   end
 end

data/lib/tip_tap/nodes/text.rb

@@ -48,6 +48,27 @@ module TipTap
         text
       end
 
+      def to_markdown(context = Markdown::Context.root)
+        value = text.to_s
+        return "" if value.empty?
+
+        return value if context.within_code_block?
+
+        return wrap_with_backticks(value) if code?
+
+        value = escape_markdown(value)
+        value = apply_bold(value) if bold?
+        value = apply_italic(value) if italic?
+        value = apply_strike(value) if strike?
+        value = wrap_with_html_tag("u", value) if underline?
+        value = apply_highlight(value) if highlight?
+        value = apply_text_style(value) if text_style?
+        value = wrap_with_html_tag("sup", value) if superscript?
+        value = wrap_with_html_tag("sub", value) if subscript?
+        value = wrap_with_link(value) if link?
+        value
+      end
+
       def italic?
         has_mark_with_type?("italic")
       end
@@ -125,6 +146,83 @@ module TipTap
         end
         content_tag(:mark, text, data: data, style: inline_style_content(styles))
       end
+
+      def escape_markdown(value)
+        value.gsub(/([\\`*_{}\[\]()#+!><~-])/) { |char| "\\#{char}" }
+      end
+
+      def wrap_with_backticks(value)
+        max_tick_sequence = value.scan(/`+/).map(&:length).max || 0
+        wrapper = "`" * (max_tick_sequence + 1)
+        "#{wrapper}#{value}#{wrapper}"
+      end
+
+      def apply_bold(value)
+        "**#{value}**"
+      end
+
+      def apply_italic(value)
+        "_#{value}_"
+      end
+
+      def apply_strike(value)
+        "~~#{value}~~"
+      end
+
+      def apply_highlight(value)
+        attributes = {}
+        styles = {}
+        if highlight_color
+          attributes["data-color"] = highlight_color
+          styles["background-color"] = highlight_color
+          styles["color"] = "inherit"
+        end
+        wrap_with_html_tag("mark", value, attributes, styles)
+      end
+
+      def apply_text_style(value)
+        styles = text_styles || {}
+        return value if styles.empty?
+
+        wrap_with_html_tag("span", value, {}, styles)
+      end
+
+      def wrap_with_link(value)
+        href = link_href.to_s
+        return value if href.blank?
+
+        destination = escape_link_destination(href)
+        title = link_title
+        title_part = title.present? ? " \"#{escape_double_quotes(title)}\"" : ""
+        "[#{value}](#{destination}#{title_part})"
+      end
+
+      def wrap_with_html_tag(tag, value, attributes = {}, styles = {})
+        attr_segments = []
+        attributes.each do |key, attr_value|
+          next if attr_value.blank?
+          attr_segments << "#{key}=\"#{escape_double_quotes(attr_value)}\""
+        end
+        style_segment = inline_style_content(styles)
+        attr_segments << "style=\"#{escape_double_quotes(style_segment)}\"" if style_segment.present?
+        attributes_string = attr_segments.empty? ? "" : " #{attr_segments.join(" ")}"
+        "<#{tag}#{attributes_string}>#{value}</#{tag}>"
+      end
+
+      def escape_link_destination(href)
+        escaped = href.gsub("(", "\\(").gsub(")", "\\)")
+        escaped.gsub(/[\s]/) do |char|
+          (char == " ") ? "%20" : char
+        end
+      end
+
+      def escape_double_quotes(value)
+        value.to_s.gsub('"', "&quot;")
+      end
+
+      def link_title
+        marks.find { |mark| mark["type"] == "link" }&.dig("attrs", "title")
+      end
     end
   end
 end

data/lib/tip_tap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TipTap
-  VERSION = "0.9.18"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiptap-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.18
+  version: 0.10.0
 platform: ruby
 authors:
 - Chad Wilken
@@ -53,6 +53,7 @@ files:
 - lib/tip_tap/has_content.rb
 - lib/tip_tap/html_renderable.rb
 - lib/tip_tap/json_renderable.rb
+- lib/tip_tap/markdown_renderable.rb
 - lib/tip_tap/node.rb
 - lib/tip_tap/nodes/blockquote.rb
 - lib/tip_tap/nodes/bullet_list.rb