prosereflect 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4932ddc045360d00a528353acb8c741642588d3c0d180e62752d4090f47d28d
-  data.tar.gz: 646f972a327d8a8a735904bc31f64f2778232e077e6b1fcf6e888b1d6452ac25
+  metadata.gz: b84ac8ec1c9f76d0998f9b1be06b156f7ea6788f9c1d82fd2b2a34ef328263e0
+  data.tar.gz: 82c2549e3ae7a86cc6295e3b2230899638489743e4fa6d040a2a3f7fddbf8ffb
 SHA512:
-  metadata.gz: fd539de5ef42d23b9d1cb4ab07a6dc2f6ea0466e02230016b09ce6f6c90dc6ab947ceaa82ee5f0058030cb0fee82484d6a676ad5841b8d6207d45dec717f785a
-  data.tar.gz: 38e6f185405e0dd9fdd56aa9821253442f545aac7944c54e909a6e5c5ee430c7d610caac53d4d32e4de1fd5ebb7b125822e1465ce3d01e8aa745621efaae603e
+  metadata.gz: a7f45b590785499274eb6112a961e131af7af6a5c679a388eaf3bd01805a731f572fbf7d5efa938f5466e359e2c3dc81953816164ac3a3c0585ab9e98b97a220
+  data.tar.gz: dd99eed85e651b903869b53a09866a550e71b5fd29efbf8fa380b6f35bee33c2189675ca1897d10f11400975a45dbb13d798fef916a466b61181a9046fee5ff2

data/.rubocop_todo.yml

@@ -76,22 +76,31 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 201
+  Exclude:
+    - 'spec/prosereflect/input/html_spec.rb'
+  Max: 500
+
+# Offense count: 3
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/prosereflect/input/html.rb'
+    - 'lib/prosereflect/output/html.rb'
+    - 'lib/prosereflect/node.rb'
 
 # Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 30
+  Max: 50
 
 # Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 47
+  Max: 90
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 32
+  Max: 35
 
 # Offense count: 9
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
@@ -129,6 +138,16 @@ Style/Documentation:
     - 'lib/prosereflect/table_cell.rb'
     - 'lib/prosereflect/table_row.rb'
     - 'lib/prosereflect/text.rb'
+    - 'lib/prosereflect/heading.rb'
+    - 'lib/prosereflect/attribute.rb'
+    - 'lib/prosereflect/attribute/base.rb'
+    - 'lib/prosereflect/attribute/bold.rb'
+    - 'lib/prosereflect/attribute/href.rb'
+    - 'lib/prosereflect/attribute/id.rb'
+    - 'lib/prosereflect/input/html.rb'
+    - 'lib/prosereflect/output/html.rb'
+    - 'lib/prosereflect/mark.rb'
+    - 'lib/prosereflect/mark/base.rb'
 
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).

data/README.adoc

@@ -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/lib/prosereflect/attribute/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../attribute'
+
+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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Prosereflect
+  module Attribute
+    class Id < Base
+      PM_TYPE = 'id'
+
+      attribute :type, :string, default: -> { 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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+module Prosereflect
+  module Attribute
+  end
+end
+
+require_relative 'attribute/base'
+require_relative 'attribute/href'
+require_relative 'attribute/id'
+require_relative 'attribute/bold'

data/lib/prosereflect/blockquote.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'node'
+require_relative 'paragraph'
+
+module Prosereflect
+  # It can contain other block-level content like paragraphs, lists, etc.
+  class Blockquote < Node
+    PM_TYPE = 'blockquote'
+
+    attribute :type, :string, default: -> { 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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'node'
+require_relative 'list_item'
+
+module Prosereflect
+  # BulletList class represents an unordered list in ProseMirror.
+  class BulletList < Node
+    PM_TYPE = 'bullet_list'
+
+    attribute :type, :string, default: -> { 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 { |item| item.respond_to?(:text_content) ? item.text_content : '' }.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