Class: Tightknit::Utils::HtmlFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/tightknit/utils/html_formatter.rb

Overview

The HtmlFormatter class provides utilities for converting Slack blocks to HTML. This is useful for displaying event descriptions that are stored in Slack block format.

Examples:

Convert Slack blocks to HTML

blocks = [
  {
    type: "rich_text",
    elements: [
      {
        type: "rich_text_section",
        elements: [
          {
            type: "text",
            text: "Hello, world!"
          }
        ]
      }
    ]
  }
]

html = Tightknit::Utils::HtmlFormatter.slack_blocks_to_html(blocks)
# => "<p class='mb-4'>Hello, world!</p>"

Class Method Summary collapse

Class Method Details

.process_text_element(element) ⇒ String (private)

Process a text element from Slack blocks

This method takes a text element from Slack blocks and converts it to HTML. It supports various text styles like bold, italic, strikethrough, and code.

Parameters:

  • element (Hash) —

    Text element to process

Returns:

  • (String) —

    HTML representation of the text element



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/tightknit/utils/html_formatter.rb', line 102

def process_text_element(element)
  return "" unless element.is_a?(Hash)

  if element[:type] == "text"
    text = element[:text].to_s

    if element[:style]
      if element[:style][:bold]
        return "<strong>#{text}</strong>"
      elsif element[:style][:italic]
        return "<em>#{text}</em>"
      elsif element[:style][:strike]
        return "<del>#{text}</del>"
      elsif element[:style][:code]
        return "<code>#{text}</code>"
      end
    end

    return text
  elsif element[:type] == "link"
    return "<a href='#{element[:url]}' target='_blank' class='text-primary hover:underline'>#{element[:text]}</a>"
  end

  ""
end

.slack_blocks_to_html(blocks) ⇒ String

Convert Slack blocks to HTML

This method takes an array of Slack blocks and converts them to HTML. It supports rich text sections, lists, and various text styles.

Parameters:

  • blocks (Array) —

    Slack blocks to convert

Returns:

  • (String) —

    HTML representation of the Slack blocks



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/tightknit/utils/html_formatter.rb', line 39

def slack_blocks_to_html(blocks)
  return "" unless blocks.is_a?(Array)

  html = ""

  blocks.each do |block|
    next unless block.is_a?(Hash) && block[:type] == "rich_text" && block[:elements].is_a?(Array)

    block[:elements].each do |element|
      if element[:type] == "rich_text_section" && element[:elements].is_a?(Array)
        # Add a paragraph with margin for spacing
        html += "<p class='mb-4'>"
        element[:elements].each do |text_element|
          processed_text = process_text_element(text_element)
          # Replace newlines with <br> tags for proper line breaks
          html += processed_text.to_s.gsub("\n", "<br>")
        end
        html += "</p>"
      elsif element[:type] == "rich_text_list" && element[:elements].is_a?(Array)
        # Add margin before and after lists
        if element[:style] == "bullet"
          html += "<ul class='list-disc pl-5 my-4'>"
          element[:elements].each do |list_item|
            html += "<li class='mb-2'>"
            if list_item[:elements].is_a?(Array)
              list_item[:elements].each do |item_element|
                processed_text = process_text_element(item_element)
                html += processed_text.to_s.gsub("\n", "<br>")
              end
            end
            html += "</li>"
          end
          html += "</ul>"
        elsif element[:style] == "ordered"
          html += "<ol class='list-decimal pl-5 my-4'>"
          element[:elements].each do |list_item|
            html += "<li class='mb-2'>"
            if list_item[:elements].is_a?(Array)
              list_item[:elements].each do |item_element|
                processed_text = process_text_element(item_element)
                html += processed_text.to_s.gsub("\n", "<br>")
              end
            end
            html += "</li>"
          end
          html += "</ol>"
        end
      end
    end
  end

  html
end