rdoc-3.12 Documentation

Attributes

character_limit[R]: After this many characters the input will be cut off.
mask[R]: The attribute bitmask
paragraph_limit[R]: After this many paragraphs the input will be cut off.
paragraphs[R]: Count of paragraphs found

Public Class Methods

new(characters = 100, paragraphs = 3, markup = nil)

Creates a new ToHtmlSnippet formatter that will cut off the input on the next word boundary after the given number of characters or paragraphs of text have been encountered.

# File lib/rdoc/markup/to_html_snippet.rb, line 36
def initialize characters = 100, paragraphs = 3, markup = nil
  super markup

  @character_limit = characters
  @paragraph_limit = paragraphs

  @characters = 0
  @mask       = 0
  @paragraphs = 0

  @markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
end

Public Instance Methods

accept_heading(heading)

Adds heading to the output as a paragraph

# File lib/rdoc/markup/to_html_snippet.rb, line 52
def accept_heading heading
  @res << "<p>#{to_html heading.text}\n"

  add_paragraph
end

accept_list_item_end(list_item)

Finishes consumption of list_item

# File lib/rdoc/markup/to_html_snippet.rb, line 81
def accept_list_item_end list_item
end

accept_list_item_start(list_item)

Prepares the visitor for consuming list_item

# File lib/rdoc/markup/to_html_snippet.rb, line 87
def accept_list_item_start list_item
  @res << list_item_start(list_item, @list.last)
end

accept_list_start(list)

Prepares the visitor for consuming list

# File lib/rdoc/markup/to_html_snippet.rb, line 94
def accept_list_start list
  @list << list.type
  @res << html_list_name(list.type, true)
  @in_list_entry.push ''
end

accept_paragraph(paragraph)

# File lib/rdoc/markup/to_html_snippet.rb, line 68
def accept_paragraph paragraph
  para = @in_list_entry.last || "<p>"

  text = paragraph.text @hard_break

  @res << "#{para}#{wrap to_html text}\n"

  add_paragraph
end

accept_verbatim(verbatim)

Adds verbatim to the output

# File lib/rdoc/markup/to_html_snippet.rb, line 103
def accept_verbatim verbatim
  throw :done if @characters >= @character_limit
  input = verbatim.text.rstrip

  text = truncate input
  text << ' ...' unless text == input

  super RDoc::Markup::Verbatim.new text

  add_paragraph
end

add_paragraph()

Throws :done when #paragraph_limit paragraphs have been encountered

# File lib/rdoc/markup/to_html_snippet.rb, line 186
def add_paragraph
  @paragraphs += 1

  throw :done if @paragraphs >= @paragraph_limit
end

convert(content)

Marks up content

# File lib/rdoc/markup/to_html_snippet.rb, line 195
def convert content
  catch :done do
    return super
  end

  end_accepting
end

convert_flow(flow)

Converts flow items flow

# File lib/rdoc/markup/to_html_snippet.rb, line 206
def convert_flow flow
  throw :done if @characters >= @character_limit

  res = []
  @mask = 0

  flow.each do |item|
    case item
    when RDoc::Markup::AttrChanger then
      off_tags res, item
      on_tags  res, item
    when String then
      text = convert_string item
      res << truncate(text)
    when RDoc::Markup::Special then
      text = convert_special item
      res << truncate(text)
    else
      raise "Unknown flow element: #{item.inspect}"
    end

    if @characters >= @character_limit then
      off_tags res, RDoc::Markup::AttrChanger.new(0, @mask)
      break
    end
  end

  res << ' ...' if @characters >= @character_limit

  res.join
end

gen_url(url, text)

Returns just the text of link, url is only used to determine the link type.

# File lib/rdoc/markup/to_html_snippet.rb, line 159
def gen_url url, text
  if url =~ %r^rdoc-label:([^:]*)(?::(.*))?/ then
    type = "link"
  elsif url =~ %r([A-Za-z]+):(.*)/ then
    type = $1
  else
    type = "http"
  end

  if (type == "http" or type == "https" or type == "link") and
     url =~ %r\.(gif|png|jpg|jpeg|bmp)$/ then
    ''
  else
    text.sub(%r^#{type}:/*%, '')
  end
end

handle_special_CROSSREF(special)

Removes escaping from the cross-references in special

# File lib/rdoc/markup/to_html_snippet.rb, line 127
def handle_special_CROSSREF special
  special.text.sub(%r\A\\/, '')
end

html_list_name(list_type, open_tag)

In snippets, there are no lists

# File lib/rdoc/markup/to_html_snippet.rb, line 179
def html_list_name list_type, open_tag
  ''
end

list_item_start(list_item, list_type)

Lists are paragraphs, but notes and labels have a separator

# File lib/rdoc/markup/to_html_snippet.rb, line 134
def list_item_start list_item, list_type
  throw :done if @characters >= @character_limit

  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "<p>"
  when :LABEL, :NOTE then
    labels = Array(list_item.label).map do |label|
      to_html label
    end.join ', '

    labels << " &mdash; " unless labels.empty?

    start = "<p>#{labels}"
    @characters += 1 # try to include the label
    start
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end

off_tags(res, item)

Maintains a bitmask to allow HTML elements to be closed properly. See RDoc::Markup::Formatter.

# File lib/rdoc/markup/to_html_snippet.rb, line 252
def off_tags res, item
  @mask ^= item.turn_off

  super
end

on_tags(res, item)

Maintains a bitmask to allow HTML elements to be closed properly. See RDoc::Markup::Formatter.

# File lib/rdoc/markup/to_html_snippet.rb, line 242
def on_tags res, item
  @mask ^= item.turn_on

  super
end

start_accepting()

Prepares the visitor for HTML snippet generation

# File lib/rdoc/markup/to_html_snippet.rb, line 118
def start_accepting
  super

  @characters = 0
end

truncate(text)

Truncates text at the end of the first word after the character_limit.

# File lib/rdoc/markup/to_html_snippet.rb, line 261
def truncate text
  length = text.length
  characters = @characters
  @characters += length

  return text if @characters < @character_limit

  remaining = @character_limit - characters

  text =~ %r\A(.{#{remaining},}?)(\s|$)/ # TODO word-break instead of \s?

  $1
end

/	Search
?	Show this help

Keyboard Shortcuts