File: html2text.rb

package info (click to toggle)
ruby-html2text 0.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,336 kB
  • sloc: ruby: 267; makefile: 8
file content (266 lines) | stat: -rw-r--r-- 6,501 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
92
93
94
95
96
97
98
99
100
101
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# frozen_string_literal: true

require 'nokogiri'

class Html2Text
  attr_reader :doc

  def initialize(doc)
    @doc = doc
  end

  def self.convert(html)
    html = html.to_s

    if office_document?(html)
      # Emulate the CSS rendering of Office documents
      html = html.gsub('<p class=MsoNormal>', '<br>')
                 .gsub('<o:p>&nbsp;</o:p>', '<br>')
                 .gsub('<o:p></o:p>', '')
    end

    unless html.include?('<html')
      # Stop Nokogiri from inserting in <p> tags
      html = "<div>#{html}</div>"
    end

    html = fix_newlines(replace_entities(html))
    doc = Nokogiri::HTML(html)

    new(doc).convert
  end

  def self.fix_newlines(text)
    # rubocop:disable Performance/StringReplacement
    text.gsub("\r\n", "\n").gsub("\r", "\n")
    # rubocop:enable Performance/StringReplacement
  end

  def self.replace_entities(text)
    # rubocop:disable Performance/StringReplacement
    text.gsub('&nbsp;', ' ').gsub("\u00a0", ' ').gsub('&zwnj;', '')
    # rubocop:enable Performance/StringReplacement
  end

  def convert
    output = iterate_over(doc)
    output = remove_leading_and_trailing_whitespace(output)
    output = remove_unnecessary_empty_lines(output)
    output.strip
  end

  DO_NOT_TOUCH_WHITESPACE = '<do-not-touch-whitespace>'

  def remove_leading_and_trailing_whitespace(text)
    # ignore any <pre> blocks, which we don't want to interact with
    pre_blocks = text.split(DO_NOT_TOUCH_WHITESPACE)

    output = []
    pre_blocks.each.with_index do |block, index|
      output << if index.even?
                  block.gsub(/[ \t]*\n[ \t]*/im, "\n").gsub(/ *\t */im, "\t")
                else
                  block
                end
    end

    output.join
  end

  private_class_method def self.office_document?(text)
    text.include?('urn:schemas-microsoft-com:office')
  end

  private

  def remove_unnecessary_empty_lines(text)
    text.gsub(/\n\n\n*/im, "\n\n")
  end

  def trimmed_whitespace(text)
    # Replace whitespace characters with a space (equivalent to \s)
    # and force any text encoding into UTF-8
    if text.valid_encoding?
      text.gsub(/[\t\n\f\r ]+/im, ' ')
    else
      text.force_encoding('WINDOWS-1252')
      trimmed_whitespace(text.encode('UTF-16be', invalid: :replace, replace: '?').encode('UTF-8'))
    end
  end

  def iterate_over(node)
    return "\n" if node.name.downcase == 'br' && next_node_is_text?(node)

    return trimmed_whitespace(node.text) if node.text?

    return '' if %w[style head title meta script].include?(node.name.downcase)

    return "\n#{DO_NOT_TOUCH_WHITESPACE}#{node.text}#{DO_NOT_TOUCH_WHITESPACE}" if node.name.downcase == 'pre'

    output = []

    output << prefix_whitespace(node)
    output += node.children.map do |child|
      iterate_over(child) unless child.name.nil?
    end
    output << suffix_whitespace(node)

    output = output.compact.join || ''

    unless node.name.nil?
      if node.name.downcase == 'a'
        output = wrap_link(node, output)
      elsif node.name.downcase == 'img'
        output = image_text(node)
      end
    end

    output
  end

  # rubocop:disable Lint/DuplicateBranch
  def prefix_whitespace(node)
    case node.name.downcase
    when 'hr'
      "\n---------------------------------------------------------------\n"

    when 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'ol', 'ul'
      "\n\n"

    when 'p'
      "\n\n"

    when 'tr'
      "\n"

    when 'div'
      if node.parent.name == 'div' && (node.parent.text.strip == node.text.strip)
        ''
      else
        "\n"
      end

    when 'td', 'th'
      "\t"

    when 'li'
      '- '
    end
  end
  # rubocop:enable Lint/DuplicateBranch

  # rubocop:disable Lint/DuplicateBranch
  def suffix_whitespace(node)
    case node.name.downcase
    when 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'
      # add another line
      "\n\n"

    when 'p'
      "\n\n"

    when 'br'
      "\n" if next_node_name(node) != 'div' && !next_node_name(node).nil?

    when 'li'
      "\n"

    when 'div'
      if next_node_is_text?(node)
        "\n"
      elsif next_node_name(node) != 'div' && !next_node_name(node).nil?
        "\n"
      end
    end
  end
  # rubocop:enable Lint/DuplicateBranch

  # links are returned in [text](link) format
  def wrap_link(node, output)
    href = node.attribute('href')
    name = node.attribute('name')

    output = output.strip

    # remove double [[ ]]s from linking images
    if output[0] == '[' && output[-1] == ']'
      output = output[1, output.length - 2]

      # for linking images, the title of the <a> overrides the title of the <img>
      output = node.attribute('title').to_s if node.attribute('title')
    end

    # if there is no link text, but a title attr
    output = node.attribute('title').to_s if output.empty? && node.attribute('title')

    if href.nil?
      output = "[#{output}]" unless name.nil?
    else
      href = href.to_s

      if href != output && href != "mailto:#{output}" &&
         href != "http://#{output}" && href != "https://#{output}"
        output = if output.empty?
                   href
                 else
                   "[#{output}](#{href})"
                 end
      end
    end

    case next_node_name(node)
    when 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'
      output += "\n"
    end

    output
  end

  def image_text(node)
    if node.attribute('title')
      "[#{node.attribute('title')}]"
    elsif node.attribute('alt')
      "[#{node.attribute('alt')}]"
    else
      ''
    end
  end

  def next_node_name(node)
    next_node = node.next_sibling
    until next_node.nil?
      break if next_node.element?

      next_node = next_node.next_sibling
    end

    return unless next_node&.element?

    next_node.name.downcase
  end

  def next_node_is_text?(node)
    !node.next_sibling.nil? && node.next_sibling.text? && !node.next_sibling.text.strip.empty?
  end

  def previous_node_name(node)
    previous_node = node.previous_sibling
    until previous_node.nil?
      break if previous_node.element?

      previous_node = previous_node.previous_sibling
    end

    return unless previous_node&.element?

    previous_node.name.downcase
  end

  def previous_node_is_text?(node)
    !node.previous_sibling.nil? && node.previous_sibling.text? && !node.previous_sibling.text.strip.empty?
  end

  # def previous_node_is_not_text?(node)
  #   return node.previous_sibling.nil? || !node.previous_sibling.text? || node.previous_sibling.text.strip.empty?
  # end
end