Class: RubyProf::ProfileTask

Inherits:
Rake::TestTask
  • Object
show all
Defined in:
lib/ruby-prof/profiletask.rb

Overview

Create a profile task. All of the options provided by the Rake:TestTask are supported except the loader which is set to ruby-prof. For detailed information please refer to the Rake:TestTask documentation.

ruby-prof specific options include:

output_dir - For each file specified an output file with profile information will be written to the output directory. By default, the output directory is called “profile” and is created underneath the current working directory.

printer - Specifies the output printer. Valid values include :flat, :graph, and :graph_html.

min_percent - Methods that take less than the specified percent

will not be written out.

Example:

require 'ruby-prof/task'

ruby-prof::RubyProfTask.new do |t|
  t.test_files = FileList['test/test*.rb']

t.output_dir = “c:/temp” t.printer = :graph

  t.min_percent = 10
end

If the task is invoked with a “test=filename” command line option, then the list of test files will be overridden to include only the filename specified on the command line. This provides an easy way to run just one test.

If rake is invoked with a “options=options” command line option, then the given options are passed to ruby-prof.

If rake is invoked with a “ruby-profPATH=path/to/ruby-prof” command line option, then the given ruby-prof executable will be used; otherwise the one in your PATH will be used.

Examples:

rake ruby-prof                           # profiles all unit tests
rake ruby-prof TEST=just_one_file.rb     # profiles one unit test
rake ruby-prof PATTERN=*.rb    					 # profiles all files

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = :profile) {|_self| ... } ⇒ ProfileTask

Returns a new instance of ProfileTask.

Yields:

  • (_self)

Yield Parameters:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ruby-prof/profiletask.rb', line 62

def initialize(name=:profile)
  @name = name
  @libs = ["lib"]
  @pattern = nil
  @options = Array.new
  @test_files = nil
  @verbose = false
  @warning = false
  @loader = :ruby_prof
  @ruby_opts = []
  @output_dir =  File.join(Dir.getwd, "profile")
  @printer = :graph
  @min_percent = 0
  yield self if block_given?
  @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
  define
end

Instance Attribute Details

#min_percent=(value) ⇒ Object (writeonly)

Sets the attribute min_percent

Parameters:

  • value —

    the value to set the attribute min_percent to.



59
60
61
 
# File 'lib/ruby-prof/profiletask.rb', line 59

def min_percent=(value)
  @min_percent = value
end

#output_dir=(value) ⇒ Object (writeonly)

Sets the attribute output_dir

Parameters:

  • value —

    the value to set the attribute output_dir to.



58
59
60
 
# File 'lib/ruby-prof/profiletask.rb', line 58

def output_dir=(value)
  @output_dir = value
end

#printer=(value) ⇒ Object (writeonly)

Sets the attribute printer

Parameters:

  • value —

    the value to set the attribute printer to.



60
61
62
 
# File 'lib/ruby-prof/profiletask.rb', line 60

def printer=(value)
  @printer = value
end

Instance Method Details

#create_output_directory ⇒ Object 



139
140
141
142
143
 
# File 'lib/ruby-prof/profiletask.rb', line 139

def create_output_directory
  if not File.exist?(output_directory)
  	Dir.mkdir(output_directory)
  end
end

#define ⇒ Object

Create the tasks defined by this task lib.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ruby-prof/profiletask.rb', line 81

def define
  create_output_directory
  
  lib_path = @libs.join(File::PATH_SEPARATOR)
  desc "Profile" + (@name==:profile ? "" : " for #{@name}")
  
  task @name do
	@ruby_opts.unshift( "-I#{lib_path}" )
	@ruby_opts.unshift( "-w" ) if @warning
@ruby_opts.push("-S ruby-prof")
@ruby_opts.push("--printer #{@printer}")
@ruby_opts.push("--min_percent #{@min_percent}")

    file_list.each do |file_path|	 
      run_script(file_path)
    end
	end
  self
end

#option_list ⇒ Object

:nodoc:



145
146
147
 
# File 'lib/ruby-prof/profiletask.rb', line 145

def option_list # :nodoc:
  ENV['TESTOPTS'] || @options.join(" ") || ""
end

#output_directory ⇒ Object 



135
136
137
 
# File 'lib/ruby-prof/profiletask.rb', line 135

def output_directory
  File.expand_path(@output_dir)
end

#run_script(script_path) ⇒ Object

Run script



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
 
# File 'lib/ruby-prof/profiletask.rb', line 102

def run_script(script_path)
			run_code = ''
			RakeFileUtils.verbose(@verbose) do
file_name = File.basename(script_path, File.extname(script_path))
case @printer
	when :flat, :graph
		file_name += ".txt"
	when :graph_html
		file_name += ".html"
	else
		file_name += ".txt"
end
		
output_file_path = File.join(output_directory, file_name)
	
command_line = @ruby_opts.join(" ") + 
              " --file=" + output_file_path +
              " " + script_path

puts "ruby " + command_line	
# We have to catch the exeption to continue on.  However,
# the error message will have been output to STDERR
# already by the time we get here so we don't have to
# do that again
begin
	ruby command_line
   	rescue
    end
    puts ""
    puts ""
			end
end