Home Classes Methods

In Files

rdoc/markup/formatter_test_case.rb

Parent

RDoc::TestCase

Methods

::add_visitor_tests
#setup
#test_accept_blank_line
#test_accept_block_quote
#test_accept_document
#test_accept_heading
#test_accept_heading_1
#test_accept_heading_2
#test_accept_heading_3
#test_accept_heading_4
#test_accept_heading_b
#test_accept_heading_suppressed_crossref
#test_accept_list_end_bullet
#test_accept_list_end_label
#test_accept_list_end_lalpha
#test_accept_list_end_note
#test_accept_list_end_number
#test_accept_list_end_ualpha
#test_accept_list_item_end_bullet
#test_accept_list_item_end_label
#test_accept_list_item_end_lalpha
#test_accept_list_item_end_note
#test_accept_list_item_end_number
#test_accept_list_item_end_ualpha
#test_accept_list_item_start_bullet
#test_accept_list_item_start_label
#test_accept_list_item_start_lalpha
#test_accept_list_item_start_note
#test_accept_list_item_start_note_2
#test_accept_list_item_start_note_multi_description
#test_accept_list_item_start_note_multi_label
#test_accept_list_item_start_number
#test_accept_list_item_start_ualpha
#test_accept_list_start_bullet
#test_accept_list_start_label
#test_accept_list_start_lalpha
#test_accept_list_start_note
#test_accept_list_start_number
#test_accept_list_start_ualpha
#test_accept_paragraph
#test_accept_paragraph_b
#test_accept_paragraph_br
#test_accept_paragraph_break
#test_accept_paragraph_i
#test_accept_paragraph_plus
#test_accept_paragraph_star
#test_accept_paragraph_underscore
#test_accept_raw
#test_accept_rule
#test_accept_verbatim
#test_end_accepting
#test_list_nested
#test_list_verbatim
#test_start_accepting

Class/Module Index

RDoc::Markup::FormatterTestCase

Test case for creating new RDoc::Markup formatters. See test/test_rdoc_markup_to_*.rb for examples.

This test case adds a variety of tests to your subclass when add_visitor_tests is called. Most tests set up a scenario then call a method you will provide to perform the assertion on the output.

Your subclass must instantiate a visitor and assign it to @to.

For example, #test_accept_blank_line sets up a RDoc::Markup::BlockLine then calls accept_blank_line on your visitor. You are responsible for asserting that the output is correct.

Example:

class TestRDocMarkupToNewFormat < RDoc::Markup::FormatterTestCase

  add_visitor_tests

  def setup
    super

    @to = RDoc::Markup::ToNewFormat.new
  end

  def accept_blank_line
    assert_equal :junk, @to.res.join
  end

  # ...

end

Public Class Methods

add_visitor_tests() click to toggle source

Call to add the visitor tests to your test case

 
               # File rdoc/markup/formatter_test_case.rb, line 88
def self.add_visitor_tests
  class_eval do

    ##
    # Calls start_accepting which needs to verify startup state

    def test_start_accepting
      @to.start_accepting

      start_accepting
    end

    ##
    # Calls end_accepting on your test case which needs to call
    # <tt>@to.end_accepting</tt> and verify document generation

    def test_end_accepting
      @to.start_accepting
      @to.res << 'hi'

      end_accepting
    end

    ##
    # Calls accept_blank_line

    def test_accept_blank_line
      @to.start_accepting

      @to.accept_blank_line @RM::BlankLine.new

      accept_blank_line
    end

    ##
    # Calls accept_block_quote

    def test_accept_block_quote
      @to.start_accepting

      @to.accept_block_quote block para 'quote'

      accept_block_quote
    end
    ##
    # Test case that calls <tt>@to.accept_document</tt>

    def test_accept_document
      @to.start_accepting
      @to.accept_document @RM::Document.new @RM::Paragraph.new 'hello'

      accept_document
    end

    ##
    # Calls accept_heading with a level 5 RDoc::Markup::Heading

    def test_accept_heading
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(5, 'Hello')

      accept_heading
    end

    ##
    # Calls accept_heading_1 with a level 1 RDoc::Markup::Heading

    def test_accept_heading_1
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(1, 'Hello')

      accept_heading_1
    end

    ##
    # Calls accept_heading_2 with a level 2 RDoc::Markup::Heading

    def test_accept_heading_2
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(2, 'Hello')

      accept_heading_2
    end

    ##
    # Calls accept_heading_3 with a level 3 RDoc::Markup::Heading

    def test_accept_heading_3
      # HACK this doesn't belong here
      skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars

      @to.start_accepting

      @to.accept_heading @RM::Heading.new(3, 'Hello')

      accept_heading_3
    end

    ##
    # Calls accept_heading_4 with a level 4 RDoc::Markup::Heading

    def test_accept_heading_4
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(4, 'Hello')

      accept_heading_4
    end

    ##
    # Calls accept_heading_b with a bold level 1 RDoc::Markup::Heading

    def test_accept_heading_b
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(1, '*Hello*')

      accept_heading_b
    end

    ##
    # Calls accept_heading_suppressed_crossref with a level 1
    # RDoc::Markup::Heading containing a suppressed crossref

    def test_accept_heading_suppressed_crossref # HACK to_html_crossref test
      @to.start_accepting

      @to.accept_heading @RM::Heading.new(1, '\Hello')

      accept_heading_suppressed_crossref
    end

    ##
    # Calls accept_paragraph

    def test_accept_paragraph
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('hi')

      accept_paragraph
    end

    ##
    # Calls accept_paragraph_b with a RDoc::Markup::Paragraph containing
    # bold words

    def test_accept_paragraph_b
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('reg <b>bold words</b> reg')

      accept_paragraph_b
    end

    ##
    # Calls accept_paragraph_br with a RDoc::Markup::Paragraph containing
    # a \<br>

    def test_accept_paragraph_br
      @to.start_accepting

      @to.accept_paragraph para 'one<br>two'

      accept_paragraph_br
    end

    ##
    # Calls accept_paragraph with a Paragraph containing a hard break

    def test_accept_paragraph_break
      @to.start_accepting

      @to.accept_paragraph para('hello', hard_break, 'world')

      accept_paragraph_break
    end

    ##
    # Calls accept_paragraph_i with a RDoc::Markup::Paragraph containing
    # emphasized words

    def test_accept_paragraph_i
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('reg <em>italic words</em> reg')

      accept_paragraph_i
    end

    ##
    # Calls accept_paragraph_plus with a RDoc::Markup::Paragraph containing
    # teletype words

    def test_accept_paragraph_plus
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('reg +teletype+ reg')

      accept_paragraph_plus
    end

    ##
    # Calls accept_paragraph_star with a RDoc::Markup::Paragraph containing
    # bold words

    def test_accept_paragraph_star
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('reg *bold* reg')

      accept_paragraph_star
    end

    ##
    # Calls accept_paragraph_underscore with a RDoc::Markup::Paragraph
    # containing emphasized words

    def test_accept_paragraph_underscore
      @to.start_accepting

      @to.accept_paragraph @RM::Paragraph.new('reg _italic_ reg')

      accept_paragraph_underscore
    end

    ##
    # Calls accept_verbatim with a RDoc::Markup::Verbatim

    def test_accept_verbatim
      @to.start_accepting

      @to.accept_verbatim @RM::Verbatim.new("hi\n", "  world\n")

      accept_verbatim
    end

    ##
    # Calls accept_raw with a RDoc::Markup::Raw

    def test_accept_raw
      @to.start_accepting

      @to.accept_raw @RM::Raw.new("<table>",
                                  "<tr><th>Name<th>Count",
                                  "<tr><td>a<td>1",
                                  "<tr><td>b<td>2",
                                  "</table>")

      accept_raw
    end

    ##
    # Calls accept_rule with a RDoc::Markup::Rule

    def test_accept_rule
      @to.start_accepting

      @to.accept_rule @RM::Rule.new(4)

      accept_rule
    end

    ##
    # Calls accept_list_item_start_bullet

    def test_accept_list_item_start_bullet
      @to.start_accepting

      @to.accept_list_start @bullet_list

      @to.accept_list_item_start @bullet_list.items.first

      accept_list_item_start_bullet
    end

    ##
    # Calls accept_list_item_start_label

    def test_accept_list_item_start_label
      @to.start_accepting

      @to.accept_list_start @label_list

      @to.accept_list_item_start @label_list.items.first

      accept_list_item_start_label
    end

    ##
    # Calls accept_list_item_start_lalpha

    def test_accept_list_item_start_lalpha
      @to.start_accepting

      @to.accept_list_start @lalpha_list

      @to.accept_list_item_start @lalpha_list.items.first

      accept_list_item_start_lalpha
    end

    ##
    # Calls accept_list_item_start_note

    def test_accept_list_item_start_note
      @to.start_accepting

      @to.accept_list_start @note_list

      @to.accept_list_item_start @note_list.items.first

      accept_list_item_start_note
    end

    ##
    # Calls accept_list_item_start_note_2

    def test_accept_list_item_start_note_2
      list = list(:NOTE,
               item('<tt>teletype</tt>',
                 para('teletype description')))

      @to.start_accepting

      list.accept @to

      @to.end_accepting

      accept_list_item_start_note_2
    end

    ##
    # Calls accept_list_item_start_note_multi_description

    def test_accept_list_item_start_note_multi_description
      list = list(:NOTE,
               item(%w[label],
                 para('description one')),
               item(nil, para('description two')))

      @to.start_accepting

      list.accept @to

      @to.end_accepting

      accept_list_item_start_note_multi_description
    end

    ##
    # Calls accept_list_item_start_note_multi_label

    def test_accept_list_item_start_note_multi_label
      list = list(:NOTE,
               item(%w[one two],
                 para('two headers')))

      @to.start_accepting

      list.accept @to

      @to.end_accepting

      accept_list_item_start_note_multi_label
    end

    ##
    # Calls accept_list_item_start_number

    def test_accept_list_item_start_number
      @to.start_accepting

      @to.accept_list_start @number_list

      @to.accept_list_item_start @number_list.items.first

      accept_list_item_start_number
    end

    ##
    # Calls accept_list_item_start_ualpha

    def test_accept_list_item_start_ualpha
      @to.start_accepting

      @to.accept_list_start @ualpha_list

      @to.accept_list_item_start @ualpha_list.items.first

      accept_list_item_start_ualpha
    end

    ##
    # Calls accept_list_item_end_bullet

    def test_accept_list_item_end_bullet
      @to.start_accepting

      @to.accept_list_start @bullet_list

      @to.accept_list_item_start @bullet_list.items.first

      @to.accept_list_item_end @bullet_list.items.first

      accept_list_item_end_bullet
    end

    ##
    # Calls accept_list_item_end_label

    def test_accept_list_item_end_label
      @to.start_accepting

      @to.accept_list_start @label_list

      @to.accept_list_item_start @label_list.items.first

      @to.accept_list_item_end @label_list.items.first

      accept_list_item_end_label
    end

    ##
    # Calls accept_list_item_end_lalpha

    def test_accept_list_item_end_lalpha
      @to.start_accepting

      @to.accept_list_start @lalpha_list

      @to.accept_list_item_start @lalpha_list.items.first

      @to.accept_list_item_end @lalpha_list.items.first

      accept_list_item_end_lalpha
    end

    ##
    # Calls accept_list_item_end_note

    def test_accept_list_item_end_note
      @to.start_accepting

      @to.accept_list_start @note_list

      @to.accept_list_item_start @note_list.items.first

      @to.accept_list_item_end @note_list.items.first

      accept_list_item_end_note
    end

    ##
    # Calls accept_list_item_end_number

    def test_accept_list_item_end_number
      @to.start_accepting

      @to.accept_list_start @number_list

      @to.accept_list_item_start @number_list.items.first

      @to.accept_list_item_end @number_list.items.first

      accept_list_item_end_number
    end

    ##
    # Calls accept_list_item_end_ualpha

    def test_accept_list_item_end_ualpha
      @to.start_accepting

      @to.accept_list_start @ualpha_list

      @to.accept_list_item_start @ualpha_list.items.first

      @to.accept_list_item_end @ualpha_list.items.first

      accept_list_item_end_ualpha
    end

    ##
    # Calls accept_list_start_bullet

    def test_accept_list_start_bullet
      @to.start_accepting

      @to.accept_list_start @bullet_list

      accept_list_start_bullet
    end

    ##
    # Calls accept_list_start_label

    def test_accept_list_start_label
      @to.start_accepting

      @to.accept_list_start @label_list

      accept_list_start_label
    end

    ##
    # Calls accept_list_start_lalpha

    def test_accept_list_start_lalpha
      @to.start_accepting

      @to.accept_list_start @lalpha_list

      accept_list_start_lalpha
    end

    ##
    # Calls accept_list_start_note

    def test_accept_list_start_note
      @to.start_accepting

      @to.accept_list_start @note_list

      accept_list_start_note
    end

    ##
    # Calls accept_list_start_number

    def test_accept_list_start_number
      @to.start_accepting

      @to.accept_list_start @number_list

      accept_list_start_number
    end

    ##
    # Calls accept_list_start_ualpha

    def test_accept_list_start_ualpha
      @to.start_accepting

      @to.accept_list_start @ualpha_list

      accept_list_start_ualpha
    end

    ##
    # Calls accept_list_end_bullet

    def test_accept_list_end_bullet
      @to.start_accepting

      @to.accept_list_start @bullet_list

      @to.accept_list_end @bullet_list

      accept_list_end_bullet
    end

    ##
    # Calls accept_list_end_label

    def test_accept_list_end_label
      @to.start_accepting

      @to.accept_list_start @label_list

      @to.accept_list_end @label_list

      accept_list_end_label
    end

    ##
    # Calls accept_list_end_lalpha

    def test_accept_list_end_lalpha
      @to.start_accepting

      @to.accept_list_start @lalpha_list

      @to.accept_list_end @lalpha_list

      accept_list_end_lalpha
    end

    ##
    # Calls accept_list_end_number

    def test_accept_list_end_number
      @to.start_accepting

      @to.accept_list_start @number_list

      @to.accept_list_end @number_list

      accept_list_end_number
    end

    ##
    # Calls accept_list_end_note

    def test_accept_list_end_note
      @to.start_accepting

      @to.accept_list_start @note_list

      @to.accept_list_end @note_list

      accept_list_end_note
    end

    ##
    # Calls accept_list_end_ualpha

    def test_accept_list_end_ualpha
      @to.start_accepting

      @to.accept_list_start @ualpha_list

      @to.accept_list_end @ualpha_list

      accept_list_end_ualpha
    end

    ##
    # Calls list_nested with a two-level list

    def test_list_nested
      doc = @RM::Document.new(
              @RM::List.new(:BULLET,
                @RM::ListItem.new(nil,
                  @RM::Paragraph.new('l1'),
                  @RM::List.new(:BULLET,
                    @RM::ListItem.new(nil,
                      @RM::Paragraph.new('l1.1')))),
                @RM::ListItem.new(nil,
                  @RM::Paragraph.new('l2'))))

      doc.accept @to

      list_nested
    end

    ##
    # Calls list_verbatim with a list containing a verbatim block

    def test_list_verbatim # HACK overblown
      doc =
        doc(
          list(:BULLET,
            item(nil,
              para('list stuff'),
              blank_line,
              verb("* list\n",
                   "  with\n",
                   "\n",
                   "  second\n",
                   "\n",
                   "  1. indented\n",
                   "  2. numbered\n",
                   "\n",
                   "  third\n",
                   "\n",
                   "* second\n"))))

      doc.accept @to

      list_verbatim
    end
  end
end

Public Instance Methods

setup() click to toggle source

Call setup when inheriting from this test case.

Provides the following instance variables:

+@m+: RDoc::Markup.new
+@RM+: RDoc::Markup # to reduce typing
+@bullet_list+: @RM::List.new :BULLET, # …
+@label_list+: @RM::List.new :LABEL, # …
+@lalpha_list+: @RM::List.new :LALPHA, # …
+@note_list+: @RM::List.new :NOTE, # …
+@number_list+: @RM::List.new :NUMBER, # …
+@ualpha_list+: @RM::List.new :UALPHA, # …

 
               # File rdoc/markup/formatter_test_case.rb, line 53
def setup
  super

  @options = RDoc::Options.new

  @m = @RM.new

  @bullet_list = @RM::List.new(:BULLET,
    @RM::ListItem.new(nil, @RM::Paragraph.new('l1')),
    @RM::ListItem.new(nil, @RM::Paragraph.new('l2')))

  @label_list = @RM::List.new(:LABEL,
    @RM::ListItem.new('cat', @RM::Paragraph.new('cats are cool')),
    @RM::ListItem.new('dog', @RM::Paragraph.new('dogs are cool too')))

  @lalpha_list = @RM::List.new(:LALPHA,
    @RM::ListItem.new(nil, @RM::Paragraph.new('l1')),
    @RM::ListItem.new(nil, @RM::Paragraph.new('l2')))

  @note_list = @RM::List.new(:NOTE,
    @RM::ListItem.new('cat', @RM::Paragraph.new('cats are cool')),
    @RM::ListItem.new('dog', @RM::Paragraph.new('dogs are cool too')))

  @number_list = @RM::List.new(:NUMBER,
    @RM::ListItem.new(nil, @RM::Paragraph.new('l1')),
    @RM::ListItem.new(nil, @RM::Paragraph.new('l2')))

  @ualpha_list = @RM::List.new(:UALPHA,
    @RM::ListItem.new(nil, @RM::Paragraph.new('l1')),
    @RM::ListItem.new(nil, @RM::Paragraph.new('l2')))
end

test_accept_blank_line() click to toggle source

Calls accept_blank_line

 
               # File rdoc/markup/formatter_test_case.rb, line 114
def test_accept_blank_line
  @to.start_accepting

  @to.accept_blank_line @RM::BlankLine.new

  accept_blank_line
end

test_accept_block_quote() click to toggle source

Calls accept_block_quote

 
               # File rdoc/markup/formatter_test_case.rb, line 125
def test_accept_block_quote
  @to.start_accepting

  @to.accept_block_quote block para 'quote'

  accept_block_quote
end

test_accept_document() click to toggle source

Test case that calls @to.accept_document

 
               # File rdoc/markup/formatter_test_case.rb, line 135
def test_accept_document
  @to.start_accepting
  @to.accept_document @RM::Document.new @RM::Paragraph.new 'hello'

  accept_document
end

test_accept_heading() click to toggle source

Calls accept_heading with a level 5 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 145
def test_accept_heading
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(5, 'Hello')

  accept_heading
end

test_accept_heading_1() click to toggle source

Calls accept_heading_1 with a level 1 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 156
def test_accept_heading_1
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(1, 'Hello')

  accept_heading_1
end

test_accept_heading_2() click to toggle source

Calls accept_heading_2 with a level 2 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 167
def test_accept_heading_2
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(2, 'Hello')

  accept_heading_2
end

test_accept_heading_3() click to toggle source

Calls accept_heading_3 with a level 3 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 178
def test_accept_heading_3
  # HACK this doesn't belong here
  skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars

  @to.start_accepting

  @to.accept_heading @RM::Heading.new(3, 'Hello')

  accept_heading_3
end

test_accept_heading_4() click to toggle source

Calls accept_heading_4 with a level 4 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 192
def test_accept_heading_4
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(4, 'Hello')

  accept_heading_4
end

test_accept_heading_b() click to toggle source

Calls accept_heading_b with a bold level 1 RDoc::Markup::Heading

 
               # File rdoc/markup/formatter_test_case.rb, line 203
def test_accept_heading_b
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(1, '*Hello*')

  accept_heading_b
end

test_accept_heading_suppressed_crossref() click to toggle source

Calls accept_heading_suppressed_crossref with a level 1 RDoc::Markup::Heading containing a suppressed crossref

 
               # File rdoc/markup/formatter_test_case.rb, line 215
def test_accept_heading_suppressed_crossref # HACK to_html_crossref test
  @to.start_accepting

  @to.accept_heading @RM::Heading.new(1, '\Hello')

  accept_heading_suppressed_crossref
end

test_accept_list_end_bullet() click to toggle source

Calls accept_list_end_bullet

 
               # File rdoc/markup/formatter_test_case.rb, line 643
def test_accept_list_end_bullet
  @to.start_accepting

  @to.accept_list_start @bullet_list

  @to.accept_list_end @bullet_list

  accept_list_end_bullet
end

test_accept_list_end_label() click to toggle source

Calls accept_list_end_label

 
               # File rdoc/markup/formatter_test_case.rb, line 656
def test_accept_list_end_label
  @to.start_accepting

  @to.accept_list_start @label_list

  @to.accept_list_end @label_list

  accept_list_end_label
end

test_accept_list_end_lalpha() click to toggle source

Calls accept_list_end_lalpha

 
               # File rdoc/markup/formatter_test_case.rb, line 669
def test_accept_list_end_lalpha
  @to.start_accepting

  @to.accept_list_start @lalpha_list

  @to.accept_list_end @lalpha_list

  accept_list_end_lalpha
end

test_accept_list_end_note() click to toggle source

Calls accept_list_end_note

 
               # File rdoc/markup/formatter_test_case.rb, line 695
def test_accept_list_end_note
  @to.start_accepting

  @to.accept_list_start @note_list

  @to.accept_list_end @note_list

  accept_list_end_note
end

test_accept_list_end_number() click to toggle source

Calls accept_list_end_number

 
               # File rdoc/markup/formatter_test_case.rb, line 682
def test_accept_list_end_number
  @to.start_accepting

  @to.accept_list_start @number_list

  @to.accept_list_end @number_list

  accept_list_end_number
end

test_accept_list_end_ualpha() click to toggle source

Calls accept_list_end_ualpha

 
               # File rdoc/markup/formatter_test_case.rb, line 708
def test_accept_list_end_ualpha
  @to.start_accepting

  @to.accept_list_start @ualpha_list

  @to.accept_list_end @ualpha_list

  accept_list_end_ualpha
end

test_accept_list_item_end_bullet() click to toggle source

Calls accept_list_item_end_bullet

 
               # File rdoc/markup/formatter_test_case.rb, line 487
def test_accept_list_item_end_bullet
  @to.start_accepting

  @to.accept_list_start @bullet_list

  @to.accept_list_item_start @bullet_list.items.first

  @to.accept_list_item_end @bullet_list.items.first

  accept_list_item_end_bullet
end

test_accept_list_item_end_label() click to toggle source

Calls accept_list_item_end_label

 
               # File rdoc/markup/formatter_test_case.rb, line 502
def test_accept_list_item_end_label
  @to.start_accepting

  @to.accept_list_start @label_list

  @to.accept_list_item_start @label_list.items.first

  @to.accept_list_item_end @label_list.items.first

  accept_list_item_end_label
end

test_accept_list_item_end_lalpha() click to toggle source

Calls accept_list_item_end_lalpha

 
               # File rdoc/markup/formatter_test_case.rb, line 517
def test_accept_list_item_end_lalpha
  @to.start_accepting

  @to.accept_list_start @lalpha_list

  @to.accept_list_item_start @lalpha_list.items.first

  @to.accept_list_item_end @lalpha_list.items.first

  accept_list_item_end_lalpha
end

test_accept_list_item_end_note() click to toggle source

Calls accept_list_item_end_note

 
               # File rdoc/markup/formatter_test_case.rb, line 532
def test_accept_list_item_end_note
  @to.start_accepting

  @to.accept_list_start @note_list

  @to.accept_list_item_start @note_list.items.first

  @to.accept_list_item_end @note_list.items.first

  accept_list_item_end_note
end

test_accept_list_item_end_number() click to toggle source

Calls accept_list_item_end_number

 
               # File rdoc/markup/formatter_test_case.rb, line 547
def test_accept_list_item_end_number
  @to.start_accepting

  @to.accept_list_start @number_list

  @to.accept_list_item_start @number_list.items.first

  @to.accept_list_item_end @number_list.items.first

  accept_list_item_end_number
end

test_accept_list_item_end_ualpha() click to toggle source

Calls accept_list_item_end_ualpha

 
               # File rdoc/markup/formatter_test_case.rb, line 562
def test_accept_list_item_end_ualpha
  @to.start_accepting

  @to.accept_list_start @ualpha_list

  @to.accept_list_item_start @ualpha_list.items.first

  @to.accept_list_item_end @ualpha_list.items.first

  accept_list_item_end_ualpha
end

test_accept_list_item_start_bullet() click to toggle source

Calls accept_list_item_start_bullet

 
               # File rdoc/markup/formatter_test_case.rb, line 357
def test_accept_list_item_start_bullet
  @to.start_accepting

  @to.accept_list_start @bullet_list

  @to.accept_list_item_start @bullet_list.items.first

  accept_list_item_start_bullet
end

test_accept_list_item_start_label() click to toggle source

Calls accept_list_item_start_label

 
               # File rdoc/markup/formatter_test_case.rb, line 370
def test_accept_list_item_start_label
  @to.start_accepting

  @to.accept_list_start @label_list

  @to.accept_list_item_start @label_list.items.first

  accept_list_item_start_label
end

test_accept_list_item_start_lalpha() click to toggle source

Calls accept_list_item_start_lalpha

 
               # File rdoc/markup/formatter_test_case.rb, line 383
def test_accept_list_item_start_lalpha
  @to.start_accepting

  @to.accept_list_start @lalpha_list

  @to.accept_list_item_start @lalpha_list.items.first

  accept_list_item_start_lalpha
end

test_accept_list_item_start_note() click to toggle source

Calls accept_list_item_start_note

 
               # File rdoc/markup/formatter_test_case.rb, line 396
def test_accept_list_item_start_note
  @to.start_accepting

  @to.accept_list_start @note_list

  @to.accept_list_item_start @note_list.items.first

  accept_list_item_start_note
end

test_accept_list_item_start_note_2() click to toggle source

Calls accept_list_item_start_note_2

 
               # File rdoc/markup/formatter_test_case.rb, line 409
def test_accept_list_item_start_note_2
  list = list(:NOTE,
           item('<tt>teletype</tt>',
             para('teletype description')))

  @to.start_accepting

  list.accept @to

  @to.end_accepting

  accept_list_item_start_note_2
end

test_accept_list_item_start_note_multi_description() click to toggle source

Calls accept_list_item_start_note_multi_description

 
               # File rdoc/markup/formatter_test_case.rb, line 426
def test_accept_list_item_start_note_multi_description
  list = list(:NOTE,
           item(%w[label],
             para('description one')),
           item(nil, para('description two')))

  @to.start_accepting

  list.accept @to

  @to.end_accepting

  accept_list_item_start_note_multi_description
end

test_accept_list_item_start_note_multi_label() click to toggle source

Calls accept_list_item_start_note_multi_label

 
               # File rdoc/markup/formatter_test_case.rb, line 444
def test_accept_list_item_start_note_multi_label
  list = list(:NOTE,
           item(%w[one two],
             para('two headers')))

  @to.start_accepting

  list.accept @to

  @to.end_accepting

  accept_list_item_start_note_multi_label
end

test_accept_list_item_start_number() click to toggle source

Calls accept_list_item_start_number

 
               # File rdoc/markup/formatter_test_case.rb, line 461
def test_accept_list_item_start_number
  @to.start_accepting

  @to.accept_list_start @number_list

  @to.accept_list_item_start @number_list.items.first

  accept_list_item_start_number
end

test_accept_list_item_start_ualpha() click to toggle source

Calls accept_list_item_start_ualpha

 
               # File rdoc/markup/formatter_test_case.rb, line 474
def test_accept_list_item_start_ualpha
  @to.start_accepting

  @to.accept_list_start @ualpha_list

  @to.accept_list_item_start @ualpha_list.items.first

  accept_list_item_start_ualpha
end

test_accept_list_start_bullet() click to toggle source

Calls accept_list_start_bullet

 
               # File rdoc/markup/formatter_test_case.rb, line 577
def test_accept_list_start_bullet
  @to.start_accepting

  @to.accept_list_start @bullet_list

  accept_list_start_bullet
end

test_accept_list_start_label() click to toggle source

Calls accept_list_start_label

 
               # File rdoc/markup/formatter_test_case.rb, line 588
def test_accept_list_start_label
  @to.start_accepting

  @to.accept_list_start @label_list

  accept_list_start_label
end

test_accept_list_start_lalpha() click to toggle source

Calls accept_list_start_lalpha

 
               # File rdoc/markup/formatter_test_case.rb, line 599
def test_accept_list_start_lalpha
  @to.start_accepting

  @to.accept_list_start @lalpha_list

  accept_list_start_lalpha
end

test_accept_list_start_note() click to toggle source

Calls accept_list_start_note

 
               # File rdoc/markup/formatter_test_case.rb, line 610
def test_accept_list_start_note
  @to.start_accepting

  @to.accept_list_start @note_list

  accept_list_start_note
end

test_accept_list_start_number() click to toggle source

Calls accept_list_start_number

 
               # File rdoc/markup/formatter_test_case.rb, line 621
def test_accept_list_start_number
  @to.start_accepting

  @to.accept_list_start @number_list

  accept_list_start_number
end

test_accept_list_start_ualpha() click to toggle source

Calls accept_list_start_ualpha

 
               # File rdoc/markup/formatter_test_case.rb, line 632
def test_accept_list_start_ualpha
  @to.start_accepting

  @to.accept_list_start @ualpha_list

  accept_list_start_ualpha
end

test_accept_paragraph() click to toggle source

Calls accept_paragraph

 
               # File rdoc/markup/formatter_test_case.rb, line 226
def test_accept_paragraph
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('hi')

  accept_paragraph
end

test_accept_paragraph_b() click to toggle source

Calls accept_paragraph_b with a RDoc::Markup::Paragraph containing bold words

 
               # File rdoc/markup/formatter_test_case.rb, line 238
def test_accept_paragraph_b
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('reg <b>bold words</b> reg')

  accept_paragraph_b
end

test_accept_paragraph_br() click to toggle source

Calls accept_paragraph_br with a RDoc::Markup::Paragraph containing a <br>

 
               # File rdoc/markup/formatter_test_case.rb, line 250
def test_accept_paragraph_br
  @to.start_accepting

  @to.accept_paragraph para 'one<br>two'

  accept_paragraph_br
end

test_accept_paragraph_break() click to toggle source

Calls accept_paragraph with a Paragraph containing a hard break

 
               # File rdoc/markup/formatter_test_case.rb, line 261
def test_accept_paragraph_break
  @to.start_accepting

  @to.accept_paragraph para('hello', hard_break, 'world')

  accept_paragraph_break
end

test_accept_paragraph_i() click to toggle source

Calls accept_paragraph_i with a RDoc::Markup::Paragraph containing emphasized words

 
               # File rdoc/markup/formatter_test_case.rb, line 273
def test_accept_paragraph_i
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('reg <em>italic words</em> reg')

  accept_paragraph_i
end

test_accept_paragraph_plus() click to toggle source

Calls accept_paragraph_plus with a RDoc::Markup::Paragraph containing teletype words

 
               # File rdoc/markup/formatter_test_case.rb, line 285
def test_accept_paragraph_plus
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('reg +teletype+ reg')

  accept_paragraph_plus
end

test_accept_paragraph_star() click to toggle source

Calls accept_paragraph_star with a RDoc::Markup::Paragraph containing bold words

 
               # File rdoc/markup/formatter_test_case.rb, line 297
def test_accept_paragraph_star
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('reg *bold* reg')

  accept_paragraph_star
end

test_accept_paragraph_underscore() click to toggle source

Calls accept_paragraph_underscore with a RDoc::Markup::Paragraph containing emphasized words

 
               # File rdoc/markup/formatter_test_case.rb, line 309
def test_accept_paragraph_underscore
  @to.start_accepting

  @to.accept_paragraph @RM::Paragraph.new('reg _italic_ reg')

  accept_paragraph_underscore
end

test_accept_raw() click to toggle source

Calls accept_raw with a RDoc::Markup::Raw

 
               # File rdoc/markup/formatter_test_case.rb, line 331
def test_accept_raw
  @to.start_accepting

  @to.accept_raw @RM::Raw.new("<table>",
                              "<tr><th>Name<th>Count",
                              "<tr><td>a<td>1",
                              "<tr><td>b<td>2",
                              "</table>")

  accept_raw
end

test_accept_rule() click to toggle source

Calls accept_rule with a RDoc::Markup::Rule

 
               # File rdoc/markup/formatter_test_case.rb, line 346
def test_accept_rule
  @to.start_accepting

  @to.accept_rule @RM::Rule.new(4)

  accept_rule
end

test_accept_verbatim() click to toggle source

Calls accept_verbatim with a RDoc::Markup::Verbatim

 
               # File rdoc/markup/formatter_test_case.rb, line 320
def test_accept_verbatim
  @to.start_accepting

  @to.accept_verbatim @RM::Verbatim.new("hi\n", "  world\n")

  accept_verbatim
end

test_end_accepting() click to toggle source

Calls end_accepting on your test case which needs to call @to.end_accepting and verify document generation

 
               # File rdoc/markup/formatter_test_case.rb, line 104
def test_end_accepting
  @to.start_accepting
  @to.res << 'hi'

  end_accepting
end

test_list_nested() click to toggle source

Calls list_nested with a two-level list

 
               # File rdoc/markup/formatter_test_case.rb, line 721
def test_list_nested
  doc = @RM::Document.new(
          @RM::List.new(:BULLET,
            @RM::ListItem.new(nil,
              @RM::Paragraph.new('l1'),
              @RM::List.new(:BULLET,
                @RM::ListItem.new(nil,
                  @RM::Paragraph.new('l1.1')))),
            @RM::ListItem.new(nil,
              @RM::Paragraph.new('l2'))))

  doc.accept @to

  list_nested
end

test_list_verbatim() click to toggle source

Calls list_verbatim with a list containing a verbatim block

 
               # File rdoc/markup/formatter_test_case.rb, line 740
def test_list_verbatim # HACK overblown
  doc =
    doc(
      list(:BULLET,
        item(nil,
          para('list stuff'),
          blank_line,
          verb("* list\n",
               "  with\n",
               "\n",
               "  second\n",
               "\n",
               "  1. indented\n",
               "  2. numbered\n",
               "\n",
               "  third\n",
               "\n",
               "* second\n"))))

  doc.accept @to

  list_verbatim
end

test_start_accepting() click to toggle source

Calls start_accepting which needs to verify startup state

 
               # File rdoc/markup/formatter_test_case.rb, line 94
def test_start_accepting
  @to.start_accepting

  start_accepting
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.