# frozen_string_literal: false
require 'rubygems'
begin
gem 'minitest', '~> 4.0' unless defined?(Test::Unit)
rescue NoMethodError, Gem::LoadError
# for ruby tests
end
require 'minitest/autorun'
require 'minitest/benchmark' if ENV['BENCHMARK']
require 'fileutils'
require 'pp'
require 'tempfile'
require 'tmpdir'
require 'stringio'
require 'rdoc'
##
# 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:
#
# * A reset code-object tree
# * A reset markup preprocessor (RDoc::Markup::PreProcess)
# * The <code>@RM</code> alias of RDoc::Markup (for less typing)
# * <code>@pwd</code> containing the current working directory
# * FileUtils, pp, Tempfile, Dir.tmpdir and StringIO
class RDoc::TestCase < MiniTest::Unit::TestCase
##
# Abstract test-case setup
def setup
super
@top_level = nil
@have_encoding = Object.const_defined? :Encoding
@RM = RDoc::Markup
RDoc::Markup::PreProcess.reset
@pwd = Dir.pwd
@store = RDoc::Store.new
@rdoc = RDoc::RDoc.new
@rdoc.store = @store
@rdoc.options = RDoc::Options.new
g = Object.new
def g.class_dir() end
def g.file_dir() end
@rdoc.generator = g
end
##
# Asserts +path+ is a file
def assert_file path
assert File.file?(path), "#{path} is not a file"
end
##
# Asserts +path+ is a directory
def assert_directory path
assert File.directory?(path), "#{path} is not a directory"
end
##
# Refutes +path+ exists
def refute_file path
refute File.exist?(path), "#{path} exists"
end
##
# Shortcut for RDoc::Markup::BlankLine.new
def blank_line
@RM::BlankLine.new
end
##
# Shortcut for RDoc::Markup::BlockQuote.new with +contents+
def block *contents
@RM::BlockQuote.new(*contents)
end
##
# Creates an RDoc::Comment with +text+ which was defined on +top_level+.
# By default the comment has the 'rdoc' format.
def comment text, top_level = @top_level
RDoc::Comment.new text, top_level
end
##
# Shortcut for RDoc::Markup::Document.new with +contents+
def doc *contents
@RM::Document.new(*contents)
end
##
# Shortcut for RDoc::Markup::HardBreak.new
def hard_break
@RM::HardBreak.new
end
##
# Shortcut for RDoc::Markup::Heading.new with +level+ and +text+
def head level, text
@RM::Heading.new level, text
end
##
# Shortcut for RDoc::Markup::ListItem.new with +label+ and +parts+
def item label = nil, *parts
@RM::ListItem.new label, *parts
end
##
# Shortcut for RDoc::Markup::List.new with +type+ and +items+
def list type = nil, *items
@RM::List.new type, *items
end
##
# Enables pretty-print output
def mu_pp obj # :nodoc:
s = ''
s = PP.pp obj, s
s = s.force_encoding Encoding.default_external if defined? Encoding
s.chomp
end
##
# Shortcut for RDoc::Markup::Paragraph.new with +contents+
def para *a
@RM::Paragraph.new(*a)
end
##
# Shortcut for RDoc::Markup::Rule.new with +weight+
def rule weight
@RM::Rule.new weight
end
##
# Shortcut for RDoc::Markup::Raw.new with +contents+
def raw *contents
@RM::Raw.new(*contents)
end
##
# Creates a temporary directory changes the current directory to it for the
# duration of the block.
#
# Depends upon Dir.mktmpdir
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
##
# Shortcut for RDoc::Markup::Verbatim.new with +parts+
def verb *parts
@RM::Verbatim.new(*parts)
end
##
# run capture_io with setting $VERBOSE = true
def verbose_capture_io
capture_io do
begin
orig_verbose = $VERBOSE
$VERBOSE = true
yield
ensure
$VERBOSE = orig_verbose
end
end
end
end
# This hack allows autoload to work when Dir.pwd is changed for Ruby 1.8 since
# -I paths are not expanded.
$LOAD_PATH.each do |load_path|
break if load_path[0] == ?/
load_path.replace File.expand_path load_path
end if RUBY_VERSION < '1.9'
|