Performance profiling basics in Ruby - Mini Project: Build & Apply

Performance profiling basics

📖 Scenario: You are working on a Ruby program that processes a list of numbers. You want to understand which part of your code takes the most time so you can improve it.

🎯 Goal: Learn how to use Ruby's built-in performance profiling tools to measure how long parts of your code take to run.

📋 What You'll Learn

Create an array of numbers

Set up a variable to store the start time

Write a loop that processes the numbers

Print the total time taken to process

💡 Why This Matters

🌍 Real World

Measuring how long parts of your program take helps you find slow spots and make your code faster.

💼 Career

Performance profiling is a key skill for developers to optimize applications and improve user experience.

1

Create an array of numbers

Create a variable called numbers and set it to an array containing the numbers 1 through 5.

Ruby

# Create the array called numbers
# Your code here

Hint

Use square brackets [] to create an array with the numbers 1 to 5.

2

Set up start time variable

Create a variable called start_time and set it to the current time using Time.now.

Ruby

numbers = [1, 2, 3, 4, 5]
# Set start_time to current time
# Your code here

Hint

Use Time.now to get the current time.

3

Process the numbers with a loop

Use a for loop with the variable num to iterate over numbers. Inside the loop, calculate the square of num and store it in a variable called square.

Ruby

numbers = [1, 2, 3, 4, 5]
start_time = Time.now
# Loop over numbers and calculate square
# Your code here

Hint

Use for num in numbers to loop. Multiply num by itself to get square.

4

Calculate and print elapsed time

Create a variable called end_time and set it to Time.now. Then calculate the elapsed time by subtracting start_time from end_time and store it in elapsed_time. Finally, print the text "Elapsed time: " followed by elapsed_time.

Ruby

numbers = [1, 2, 3, 4, 5]
start_time = Time.now
for num in numbers
  square = num * num
end
# Calculate end_time and elapsed_time, then print elapsed time
# Your code here

Hint

Use Time.now again for end_time. Subtract start_time from end_time. Use puts with string interpolation to print.

Practice

1. What is the main purpose of performance profiling in Ruby?

easy

A. To find slow parts of the code that need optimization

B. To add new features to the Ruby program

C. To check syntax errors in the code

D. To convert Ruby code into another language

Solution

1. Step 1: Understand the goal of profiling

   Performance profiling is used to measure how long parts of code take to run.

2. Step 2: Identify the main use

   It helps find slow parts so you can improve them.

3. Final Answer:

   To find slow parts of the code that need optimization -> Option A

4. Quick Check:

   Profiling = Find slow code [OK]

Hint: Profiling = finding slow code parts to speed up [OK]

Common Mistakes:

• Confusing profiling with debugging syntax errors
• Thinking profiling adds features
• Believing profiling translates code

2. Which Ruby gem is commonly used for performance profiling?

easy

A. nokogiri

B. rails

C. ruby-prof

D. rspec

Solution

1. Step 1: Recall common Ruby gems

   Rails is a web framework, Nokogiri is for XML/HTML parsing, RSpec is for testing.

2. Step 2: Identify profiling gem

   ruby-prof is the gem designed for performance profiling.

3. Final Answer:

   ruby-prof -> Option C

4. Quick Check:

   Profiling gem = ruby-prof [OK]

Hint: ruby-prof gem is for profiling Ruby code [OK]

Common Mistakes:

• Choosing Rails as a profiling tool
• Confusing testing gem RSpec with profiling
• Picking unrelated gems like Nokogiri

3. Given this Ruby profiling output snippet:

Method       | Total Time | Self Time
calculate    | 0.50       | 0.40
process      | 0.30       | 0.10
render       | 0.20       | 0.20

Which method should you optimize first to improve performance?

medium

A. calculate

B. render

C. All methods equally

D. process

Solution

1. Step 1: Understand self time meaning

   Self time shows how much time the method itself takes, excluding calls to others.

2. Step 2: Compare self times

   calculate has the highest self time (0.40), so it is the slowest part to optimize.

3. Final Answer:

   calculate -> Option A

4. Quick Check:

   Highest self time = calculate [OK]

Hint: Optimize method with highest self time first [OK]

Common Mistakes:

• Choosing method with highest total time instead of self time
• Thinking all methods need equal optimization
• Ignoring self time importance

4. What is wrong with this Ruby profiling code snippet?

require 'ruby-prof'
ruby-prof.start
# some code here
result = RubyProf.stop
puts result

medium

A. Missing require statement for ruby-prof

B. Not starting the profiler before code

C. No code to profile

D. Using puts directly on result object

Solution

1. Step 1: Check require and start

   require 'ruby-prof' and ruby-prof.start are correctly used.

2. Step 2: Understand result object usage

   result is a RubyProf::Profile object; printing it directly with puts won't show readable output.

3. Final Answer:

   Using puts directly on result object -> Option D

4. Quick Check:

   Print profiling result properly, not with puts [OK]

Hint: Use printer classes to display profiling results, not puts [OK]

Common Mistakes:

• Printing result object directly
• Forgetting to start profiler
• Not requiring ruby-prof gem

5. You want to profile a Ruby method heavy_task and save the results to a file in a readable format. Which code snippet correctly does this?

hard

A. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
File.open('profile.txt', 'w') { |f| f.puts result }

B. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
printer = RubyProf::FlatPrinter.new(result)
File.open('profile.txt', 'w') { |f| printer.print(f) }

C. require 'ruby-prof'
result = RubyProf.profile { heavy_task }
File.write('profile.txt', result.to_s)

D. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
puts result.to_s > 'profile.txt'

Solution

1. Step 1: Understand profiling and printing

   ruby-prof returns a result object that needs a printer to format output.

2. Step 2: Check each option for correct usage

   require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop printer = RubyProf::FlatPrinter.new(result) File.open('profile.txt', 'w') { |f| printer.print(f) } uses FlatPrinter to format and writes to file correctly. require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop File.open('profile.txt', 'w') { |f| f.puts result } writes raw object, require 'ruby-prof' result = RubyProf.profile { heavy_task } File.write('profile.txt', result.to_s) misuses to_s, require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop puts result.to_s > 'profile.txt' misuses puts redirection.

3. Final Answer:

   Option B code snippet -> Option B

4. Quick Check:

   Use printer to save profiling output [OK]

Hint: Use RubyProf printers to save readable profiling results [OK]

Common Mistakes:

• Writing raw result object to file
• Using puts with redirection incorrectly
• Not using a printer to format output