RubyGems - prosereflect - Versions diffs - 0.1.0 → 0.2.0 - Mend

prosereflect 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

checksums.yaml +4 -4
data/.github/workflows/rake.yml +4 -0
data/.github/workflows/release.yml +5 -0
data/.rubocop.yml +19 -1
data/.rubocop_todo.yml +143 -174
data/CLAUDE.md +78 -0
data/Gemfile +8 -4
data/README.adoc +193 -12
data/Rakefile +3 -3
data/lib/prosereflect/attribute/base.rb +32 -0
data/lib/prosereflect/attribute/bold.rb +18 -0
data/lib/prosereflect/attribute/href.rb +22 -0
data/lib/prosereflect/attribute/id.rb +24 -0
data/lib/prosereflect/attribute.rb +10 -0
data/lib/prosereflect/blockquote.rb +84 -0
data/lib/prosereflect/bullet_list.rb +84 -0
data/lib/prosereflect/code_block.rb +135 -0
data/lib/prosereflect/code_block_wrapper.rb +65 -0
data/lib/prosereflect/document.rb +93 -26
data/lib/prosereflect/hard_break.rb +13 -11
data/lib/prosereflect/heading.rb +63 -0
data/lib/prosereflect/horizontal_rule.rb +70 -0
data/lib/prosereflect/image.rb +126 -0
data/lib/prosereflect/input/html.rb +484 -0
data/lib/prosereflect/input.rb +7 -0
data/lib/prosereflect/list_item.rb +64 -0
data/lib/prosereflect/mark/base.rb +47 -0
data/lib/prosereflect/mark/bold.rb +13 -0
data/lib/prosereflect/mark/code.rb +12 -0
data/lib/prosereflect/mark/italic.rb +13 -0
data/lib/prosereflect/mark/link.rb +16 -0
data/lib/prosereflect/mark/strike.rb +13 -0
data/lib/prosereflect/mark/subscript.rb +13 -0
data/lib/prosereflect/mark/superscript.rb +13 -0
data/lib/prosereflect/mark/underline.rb +13 -0
data/lib/prosereflect/mark.rb +15 -0
data/lib/prosereflect/node.rb +181 -32
data/lib/prosereflect/ordered_list.rb +86 -0
data/lib/prosereflect/output/html.rb +376 -0
data/lib/prosereflect/output.rb +7 -0
data/lib/prosereflect/paragraph.rb +29 -20
data/lib/prosereflect/parser.rb +101 -33
data/lib/prosereflect/table.rb +42 -12
data/lib/prosereflect/table_cell.rb +36 -11
data/lib/prosereflect/table_header.rb +92 -0
data/lib/prosereflect/table_row.rb +34 -11
data/lib/prosereflect/text.rb +15 -19
data/lib/prosereflect/user.rb +63 -0
data/lib/prosereflect/version.rb +1 -1
data/lib/prosereflect.rb +27 -11
data/prosereflect.gemspec +17 -15
data/spec/prosereflect/document_spec.rb +477 -75
data/spec/prosereflect/hard_break_spec.rb +226 -30
data/spec/prosereflect/input/html_spec.rb +797 -0
data/spec/prosereflect/node_spec.rb +307 -137
data/spec/prosereflect/output/html_spec.rb +369 -0
data/spec/prosereflect/paragraph_spec.rb +458 -82
data/spec/prosereflect/parser_spec.rb +311 -93
data/spec/prosereflect/table_cell_spec.rb +282 -71
data/spec/prosereflect/table_row_spec.rb +218 -48
data/spec/prosereflect/table_spec.rb +415 -82
data/spec/prosereflect/text_spec.rb +231 -72
data/spec/prosereflect/user_spec.rb +76 -0
data/spec/prosereflect_spec.rb +30 -23
data/spec/spec_helper.rb +6 -6
data/spec/support/matchers.rb +6 -6
data/spec/support/shared_examples.rb +79 -50
metadata +53 -6
data/debug_loading.rb +0 -34
data/spec/prosereflect/version_spec.rb +0 -11

data/README.adoc CHANGED Viewed

@@ -80,7 +80,7 @@ tables = document.tables
 paragraphs = document.paragraphs
 # Access the first table
-first_table = document.first_table
+first_table = document.find_first('table')
 # Access header row and data rows in a table
 header = first_table.header_row
@@ -119,7 +119,97 @@ tables = document.find_all('table')
 text_nodes = document.find_all('text')
 # Find child nodes of a specific type
-table_cells = table.find_children('table_cell')
+table_cells = table.find_children(TableCell)
+----
+=== HTML Conversion
+The gem provides functionality to convert between HTML and ProseMirror document models.
+==== From HTML
+[source,ruby]
+----
+require 'prosereflect'
+# Parse from HTML string
+html_content = '<p>This is a <strong>bold</strong> text in a paragraph.</p>'
+document = Prosereflect::Input::Html.parse(html_content)
+# Access the document structure
+paragraph = document.paragraphs.first
+text_content = paragraph.text_content # "This is a bold text in a paragraph."
+----
+==== User Mentions
+The gem supports user mentions in documents, which can be useful for social features or collaborative editing.
+[source,ruby]
+----
+# Create a document with user mentions
+document = Prosereflect::Document.create
+paragraph = document.add_paragraph('Hello ')
+# Add a user mention
+user = Prosereflect::User.new
+user.id = '123'
+paragraph.add_child(user)
+paragraph.add_text('!')
+# Convert to HTML
+html = Prosereflect::Output::Html.convert(document)
+# => "<p>Hello <user-mention data-id=\"123\"></user-mention>!</p>"
+# Parse HTML with user mentions
+html_content = '<p>Hello <user-mention data-id="123"></user-mention>!</p>'
+document = Prosereflect::Input::Html.parse(html_content)
+# Access user mentions
+user_mentions = document.find_all('user')
+first_user = user_mentions.first
+user_id = first_user.id # => "123"
+----
+User mentions are represented as `<user-mention>` elements in HTML with a `data-id` attribute containing the user's identifier. When parsing HTML, these elements are converted to `User` nodes in the document model.
+Common use cases:
+- Mentioning users in comments or messages
+- Tagging users in collaborative documents
+- Tracking user references in content
+==== To HTML
+[source,ruby]
+----
+require 'prosereflect'
+# Create a document
+document = Prosereflect::Document.create
+paragraph = document.add_paragraph('Plain text')
+paragraph.add_text(' with bold', [Prosereflect::Mark::Bold.new])
+# Convert to HTML
+html = Prosereflect::Output::Html.convert(document)
+# => "<html><body><p>Plain text<strong> with bold</strong></p></body></html>"
+----
+==== Round-trip Conversion
+[source,ruby]
+----
+# Start with HTML
+original_html = '<p>This is <em>styled</em> text.</p>'
+# Convert to document model
+document = Prosereflect::Input::Html.parse(original_html)
+# Modify the document if needed
+document.paragraphs.first.add_text(' with additions')
+# Convert back to HTML
+modified_html = Prosereflect::Output::Html.convert(document)
 ----
 == Data model
@@ -145,12 +235,12 @@ objects.
 | +content          |
 +-------------------+
          |
-    +----+----+---------------------+
-    |         |                     |
-+---v---+ +---v----------+  +-------v--------+
-|Table  | |  Paragraph   |  |     Text       |
-|       | |              |  |                |
-+---+---+ +--------------+  +----------------+
+    +----+----+---------------------+-------------+
+    |         |                     |             |
++---v---+ +---v----------+  +-------v--------+  +-v-----+
+|Table  | |  Paragraph   |  |     Text       |  | User  |
+|       | |              |  |                |  |       |
++---+---+ +--------------+  +----------------+  +-------+
     |
     |
 +---v-----------+
@@ -193,14 +283,105 @@ Represents a text node.
 `text`:: The text content of the node
+=== User
+Represents a user mention in the document.
+`id`:: The unique identifier of the referenced user
+`type`:: Always set to "user"
+`content`:: Always empty (user mentions cannot have child nodes)
 === Table
 Represents a table structure.
-`rows`:: All table rows
-`header_row`:: The first row (assumed to be the header)
-`data_rows`:: All rows except the header
-`cell_at(row_index, col_index)`:: Access a specific cell by position
+`rows`:: Collection of table rows
+`header_row`:: First row if it contains header cells
+`data_rows`:: All non-header rows
+=== Heading
+Represents a heading element (h1-h6).
+`level`:: The heading level (1-6)
+`text_content`:: Returns the combined text content of all child text nodes
+`content`:: Collection of child nodes (text, styled text, etc.)
+=== Image
+Represents an image element.
+`src`:: The image source URL
+`alt`:: Alternative text description
+`title`:: Image tooltip text
+`width`:: Image width in pixels
+`height`:: Image height in pixels
+=== HorizontalRule
+Represents a horizontal rule (hr) element.
+`style`:: Border style (solid, dashed, dotted)
+`width`:: Rule width (px or %)
+`thickness`:: Border thickness in pixels
+=== BulletList
+Represents an unordered list.
+`bullet_style`:: List style type (disc, circle, square)
+`items`:: Collection of list items
+=== OrderedList
+Represents an ordered list.
+`start`:: Starting number for the list
+`items`:: Collection of list items
+=== ListItem
+Represents a list item within ordered or unordered lists.
+`content`:: Collection of child nodes (can contain paragraphs, nested lists, etc.)
+`text_content`:: Returns the combined text content
+=== Blockquote
+Represents a blockquote element.
+`citation`:: Optional citation URL
+`blocks`:: Collection of content blocks within the quote
+=== CodeBlockWrapper
+Container for code blocks with additional attributes.
+`line_numbers`:: Whether to display line numbers
+`highlight_lines`:: Array of line numbers to highlight
+`code_blocks`:: Collection of code blocks
+=== CodeBlock
+Represents a code block with syntax highlighting.
+`content`:: The code content
+`language`:: Programming language for syntax highlighting
+=== Mark
+Base class for text formatting marks.
+==== Available Mark Types
+`Bold`:: Bold text formatting
+`Italic`:: Italic text formatting
+`Code`:: Inline code formatting
+`Link`:: Hyperlink with href attribute
+`Strike`:: Strikethrough text
+`Subscript`:: Subscript text
+`Superscript`:: Superscript text
+`Underline`:: Underlined text
 === TableRow

data/Rakefile CHANGED Viewed

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 RuboCop::RakeTask.new

data/lib/prosereflect/attribute/base.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Prosereflect
+  module Attribute
+    class Base < Lutaml::Model::Serializable
+      PM_TYPE = "attribute"
+      attribute :type, :string, default: lambda {
+        begin
+          self.class.const_get(:PM_TYPE)
+        rescue StandardError
+          "attribute"
+        end
+      }
+      attribute :value, :string
+      key_value do
+        map "type", to: :type, render_default: true
+        map "value", to: :value
+      end
+      def self.create(type, value)
+        new(type: type, value: value)
+      end
+      # Convert to hash for serialization
+      def to_h
+        { type => value }
+      end
+    end
+  end
+end

data/lib/prosereflect/attribute/bold.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Prosereflect
+  module Attribute
+    class Bold < Base
+      PM_TYPE = "bold"
+      def initialize(options = {})
+        super
+        self.type = "bold"
+      end
+      def attrs
+        nil
+      end
+    end
+  end
+end

data/lib/prosereflect/attribute/href.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Prosereflect
+  module Attribute
+    class Href < Base
+      PM_TYPE = "href"
+      attribute :type, :string, default: -> { PM_TYPE }
+      attribute :href, :string
+      def initialize(options = {})
+        if options.is_a?(String)
+          super()
+          self.value = options
+        else
+          super
+          self.value = options[:href] if options[:href]
+        end
+      end
+    end
+  end
+end

data/lib/prosereflect/attribute/id.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Prosereflect
+  module Attribute
+    class Id < Base
+      PM_TYPE = "id"
+      attribute :type, :string, default: -> {
+        self.class.send(:const_get, "PM_TYPE")
+      }
+      attribute :id, :string
+      key_value do
+        map "type", to: :type, render_default: true
+        map "id", to: :id
+      end
+      # Convert to hash for serialization
+      def to_h
+        { "id" => id }
+      end
+    end
+  end
+end

data/lib/prosereflect/attribute.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Prosereflect
+  module Attribute
+    autoload :Base, "#{__dir__}/attribute/base"
+    autoload :Href, "#{__dir__}/attribute/href"
+    autoload :Id, "#{__dir__}/attribute/id"
+    autoload :Bold, "#{__dir__}/attribute/bold"
+  end
+end

data/lib/prosereflect/blockquote.rb ADDED Viewed

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+module Prosereflect
+  # It can contain other block-level content like paragraphs, lists, etc.
+  class Blockquote < Node
+    PM_TYPE = "blockquote"
+    attribute :type, :string, default: -> {
+      self.class.send(:const_get, "PM_TYPE")
+    }
+    attribute :citation, :string
+    attribute :attrs, :hash
+    key_value do
+      map "type", to: :type, render_default: true
+      map "content", to: :content
+      map "attrs", to: :attrs
+    end
+    def initialize(attributes = {})
+      attributes[:content] ||= []
+      super
+    end
+    def self.create(attrs = nil)
+      new(attrs: attrs, content: [])
+    end
+    # Get all content blocks within the blockquote
+    def blocks
+      return [] unless content
+      content
+    end
+    # Add a content block to the blockquote
+    def add_block(content)
+      add_child(content)
+    end
+    # Add multiple content blocks at once
+    def add_blocks(blocks_content)
+      blocks_content.each do |block_content|
+        add_block(block_content)
+      end
+    end
+    # Get block at specific position
+    def block_at(index)
+      return nil if index.negative?
+      blocks[index]
+    end
+    # Update citation/source for the blockquote
+    def citation=(source)
+      self.attrs ||= {}
+      attrs["citation"] = source
+    end
+    # Get citation/source of the blockquote
+    def citation
+      attrs&.[]("citation")
+    end
+    # Check if blockquote has a citation
+    def citation?
+      !citation.nil? && !citation.empty?
+    end
+    # Remove citation
+    def remove_citation
+      self.attrs ||= {}
+      attrs.delete("citation")
+    end
+    def add_paragraph(text)
+      paragraph = Paragraph.new
+      paragraph.add_text(text)
+      add_child(paragraph)
+      paragraph
+    end
+  end
+end

data/lib/prosereflect/bullet_list.rb ADDED Viewed

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+module Prosereflect
+  # BulletList class represents an unordered list in ProseMirror.
+  class BulletList < Node
+    PM_TYPE = "bullet_list"
+    attribute :type, :string, default: -> {
+      self.class.send(:const_get, "PM_TYPE")
+    }
+    attribute :bullet_style, :string
+    attribute :attrs, :hash
+    key_value do
+      map "type", to: :type, render_default: true
+      map "attrs", to: :attrs
+      map "content", to: :content
+    end
+    def initialize(attributes = {})
+      attributes[:content] ||= []
+      attributes[:attrs] ||= { "bullet_style" => nil }
+      super
+    end
+    def self.create(attrs = nil)
+      new(attrs: attrs)
+    end
+    def bullet_style=(value)
+      @bullet_style = value
+      self.attrs ||= {}
+      attrs["bullet_style"] = value
+    end
+    def bullet_style
+      @bullet_style || attrs&.[]("bullet_style")
+    end
+    def add_item(text)
+      item = ListItem.new
+      item.add_paragraph(text)
+      add_child(item)
+      item
+    end
+    def items
+      return [] unless content
+      content
+    end
+    # Add multiple items at once
+    def add_items(items_content)
+      items_content.each do |item_content|
+        add_item(item_content)
+      end
+    end
+    # Get item at specific position
+    def item_at(index)
+      return nil if index.negative?
+      items[index]
+    end
+    # Get text content with proper formatting
+    def text_content
+      return "" unless content
+      content.map do |item|
+        item.respond_to?(:text_content) ? item.text_content : ""
+      end.join("\n")
+    end
+    # Override to_h to exclude empty attrs
+    def to_h
+      hash = super
+      hash["attrs"] ||= {}
+      hash["attrs"]["bullet_style"] = bullet_style
+      hash
+    end
+  end
+end

data/lib/prosereflect/code_block.rb ADDED Viewed

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+module Prosereflect
+  # CodeBlock class represents a code block in ProseMirror.
+  class CodeBlock < Node
+    PM_TYPE = "code_block"
+    attribute :type, :string, default: -> {
+      self.class.send(:const_get, "PM_TYPE")
+    }
+    attribute :language, :string
+    attribute :line_numbers, :boolean
+    attribute :attrs, :hash
+    key_value do
+      map "type", to: :type, render_default: true
+      map "attrs", to: :attrs
+      map "content", to: :content
+    end
+    def initialize(attributes = {})
+      attributes[:attrs] ||= {
+        "content" => nil,
+        "language" => nil,
+      }
+      super
+    end
+    def self.create(attrs = nil)
+      new(attrs: attrs)
+    end
+    def language=(value)
+      @language = value
+      self.attrs ||= {}
+      attrs["language"] = value
+    end
+    def language
+      @language || attrs&.[]("language")
+    end
+    def line_numbers=(value)
+      @line_numbers = value
+      self.attrs ||= {}
+      attrs["line_numbers"] = value
+    end
+    def line_numbers
+      @line_numbers || attrs&.[]("line_numbers") || false
+    end
+    def content=(value)
+      @content = value
+      self.attrs ||= {}
+      attrs["content"] = value
+    end
+    def content
+      @content || attrs&.[]("content")
+    end
+    attr_reader :highlight_lines_str
+    def highlight_lines=(lines)
+      @highlight_lines_str = if lines.is_a?(Array)
+                               lines.join(",")
+                             else
+                               lines.to_s
+                             end
+    end
+    def highlight_lines
+      return [] unless @highlight_lines_str
+      @highlight_lines_str.split(",").map(&:to_i)
+    end
+    def text_content
+      content.to_s
+    end
+    def to_h
+      hash = super
+      hash["attrs"] = {
+        "content" => content,
+        "language" => language,
+      }
+      hash["attrs"]["line_numbers"] = line_numbers if line_numbers
+      hash.delete("content")
+      hash
+    end
+    # Get code block attributes as a hash
+    def attributes
+      {
+        language: language,
+        line_numbers: line_numbers,
+        highlight_lines: highlight_lines,
+      }.compact
+    end
+    # Add a line of code
+    def add_line(text)
+      text_node = Text.new(text: text)
+      add_child(text_node)
+    end
+    # Add multiple lines of code
+    def add_lines(lines)
+      lines.each { |line| add_line(line) }
+    end
+    private
+    def normalize_content(content)
+      lines = content.split("\n")
+      return content if lines.empty?
+      min_indent = lines.reject(&:empty?)
+        .map { |line| line[/^\s*/].length }
+        .min || 0
+      normalized_lines = lines.map do |line|
+        if line.empty?
+          line
+        else
+          line[min_indent..] || ""
+        end
+      end
+      normalized_lines.join("\n")
+    end
+  end
+end