RDoc::

TestCase

class

RDoc::TestCase is an abstract TestCase to provide common setup and teardown across all RDoc tests. The test case uses minitest, so all the assertions of minitest may be used.

The testcase provides the following:

Public Instance Methods

blank_line()

Shortcut for RDoc::Markup::BlankLine.new

# File lib/rdoc/test_case.rb, line 47
def blank_line
  @RM::BlankLine.new
end
block(*contents)

Shortcut for RDoc::Markup::Raw.new with contents

# File lib/rdoc/test_case.rb, line 54
def block *contents
  @RM::BlockQuote.new(*contents)
end
comment(text, top_level = @top_level)

Creates an RDoc::Comment with text which was defined on top_level. By default the comment has the ‘rdoc’ format.

# File lib/rdoc/test_case.rb, line 62
def comment text, top_level = @top_level
  RDoc::Comment.new text, top_level
end
doc(*contents)

Shortcut for RDoc::Markup::Document.new with contents

# File lib/rdoc/test_case.rb, line 69
def doc *contents
  @RM::Document.new(*contents)
end
hard_break()

Shortcut for RDoc::Markup::HardBreak.new

# File lib/rdoc/test_case.rb, line 76
def hard_break
  @RM::HardBreak.new
end
head(level, text)

Shortcut for RDoc::Markup::Heading.new with level and text

# File lib/rdoc/test_case.rb, line 83
def head level, text
  @RM::Heading.new level, text
end
item(label = nil, *parts)

Shortcut for RDoc::Markup::ListItem.new with label and parts

# File lib/rdoc/test_case.rb, line 90
def item label = nil, *parts
  @RM::ListItem.new label, *parts
end
list(type = nil, *items)

Shortcut for RDoc::Markup::List.new with type and items

# File lib/rdoc/test_case.rb, line 97
def list type = nil, *items
  @RM::List.new type, *items
end
para(*a)

Shortcut for RDoc::Markup::Raw.new with contents

# File lib/rdoc/test_case.rb, line 104
def para *a
  @RM::Paragraph.new(*a)
end
raw(*contents)

Shortcut for RDoc::Markup::Raw.new with contents

# File lib/rdoc/test_case.rb, line 118
def raw *contents
  @RM::Raw.new(*contents)
end
rule(weight)

Shortcut for RDoc::Markup::Rule.new with weight

# File lib/rdoc/test_case.rb, line 111
def rule weight
  @RM::Rule.new weight
end
setup()

Abstract test-case setup

# File lib/rdoc/test_case.rb, line 31
def setup
  super

  @top_level = nil

  @RM = RDoc::Markup

  RDoc::RDoc.reset
  RDoc::Markup::PreProcess.reset

  @pwd = Dir.pwd
end
temp_dir() { |temp_dir| ... }

Creates a temporary directory changes the current directory to it for the duration of the block.

Depends upon Dir.mktmpdir

# File lib/rdoc/test_case.rb, line 128
def temp_dir
  skip "No Dir::mktmpdir, upgrade your ruby" unless Dir.respond_to? :mktmpdir

  Dir.mktmpdir do |temp_dir|
    Dir.chdir temp_dir do
      yield temp_dir
    end
  end
end
verb(*parts)

Shortcut for RDoc::Markup::Raw.new with parts

# File lib/rdoc/test_case.rb, line 141
def verb *parts
  @RM::Verbatim.new(*parts)
end