RSpec describe and it blocks in Ruby - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the describe block in RSpec?

The <code>describe</code> block groups related tests together. It usually wraps tests for a specific class or method, helping organize and explain what is being tested.

beginner

What does an it block represent in RSpec?

An it block defines a single example or test case. It describes a specific behavior or expectation that should be true.

beginner

How do describe and it blocks work together?

The describe block groups tests, and inside it, multiple it blocks define individual tests. This structure makes tests clear and organized.

beginner

Why should it block descriptions be written in plain language?

Writing it block descriptions in plain language helps anyone reading the tests understand what behavior is expected, making tests like documentation.

beginner

Example: What does this RSpec code test?

describe 'Calculator' do
  it 'adds two numbers' do
    expect(1 + 2).to eq(3)
  end
end

This code tests that adding 1 and 2 results in 3. The describe block groups tests for 'Calculator', and the it block checks the addition behavior.

What is the main role of the describe block in RSpec?

A To group related tests

B To run a test

C To define a variable

D To skip a test

The describe block groups related tests together for better organization.

Which block in RSpec defines a single test case?

A it

B context

C describe

D before

The it block defines one example or test case.

Inside which block do you place multiple it blocks?

A it

B describe

C expect

D let

Multiple it blocks go inside a describe block.

What should the description inside an it block explain?

A The test framework version

B The file location

C The code implementation details

D The expected behavior being tested

The it description explains the expected behavior or outcome.

What does this code check?

describe 'Array' do
  it 'is empty when created' do
    expect([].empty?).to be true
  end
end

A That an array has elements when created

B That an array is nil

C That an array is empty when created

D That an array raises an error

It checks that a new array is empty.

Explain how describe and it blocks help organize tests in RSpec.

Think about grouping and individual checks.

Write a simple RSpec test using describe and it blocks to check if 2 + 2 equals 4.

Use expect(2 + 2).to eq(4) inside it.

Practice

1. What is the main purpose of the describe block in RSpec?

easy

A. To set up test data before tests run

B. To define a single test case

C. To run the tests automatically

D. To group related test cases together

Solution

1. Step 1: Understand the role of describe

   The describe block is used to group related tests, making the test suite organized.

2. Step 2: Differentiate from it block

   The it block defines individual test cases, not grouping.

3. Final Answer:

   To group related test cases together -> Option D

4. Quick Check:

   describe groups tests = D [OK]

Hint: Remember: describe groups, it tests one thing [OK]

Common Mistakes:

• Confusing describe with it
• Thinking describe runs tests
• Assuming describe sets up data

2. Which of the following is the correct syntax to define a test case inside a describe block in RSpec?

easy

A. describe 'Calculator' do it 'adds numbers' { expect(1 + 1).to eq(2) end

B. describe 'Calculator' do
it 'adds numbers' do
expect(1 + 1).to eq(2)
end
end

C. describe 'Calculator' do it 'adds numbers' do expect(1 + 1).to eq(2) end

D. describe 'Calculator' do
test 'adds numbers' do
expect(1 + 1).to eq(2)
end
end

Solution

1. Step 1: Check Ruby block syntax

   RSpec uses do ... end blocks for describe and it. Curly braces are less common for multi-line blocks.

2. Step 2: Verify correct keywords

   it defines test cases, not test. describe 'Calculator' do test 'adds numbers' do expect(1 + 1).to eq(2) end end uses wrong keyword.

3. Final Answer:

   describe 'Calculator' do it 'adds numbers' do expect(1 + 1).to eq(2) end end -> Option B

4. Quick Check:

   Correct Ruby block syntax = A [OK]

Hint: Use do...end for multi-line it blocks [OK]

Common Mistakes:

• Using curly braces for multi-line blocks
• Using wrong keyword like test instead of it
• Missing do or end keywords

3. What will be the output when running this RSpec test?

describe 'Math' do
  it 'checks addition' do
    expect(2 + 2).to eq(4)
  end

  it 'checks subtraction' do
    expect(5 - 3).to eq(1)
  end
end

medium

A. 1 test passed, 1 test failed

B. 2 tests passed

C. 2 tests failed

D. Syntax error

Solution

1. Step 1: Evaluate first test case

   expect(2 + 2).to eq(4) is true, so first test passes.

2. Step 2: Evaluate second test case

   expect(5 - 3).to eq(1) is false because 5 - 3 equals 2, not 1, so second test fails.

3. Final Answer:

   1 test passed, 1 test failed -> Option A

4. Quick Check:

   2+2=4 (pass), 5-3=2≠1 (fail) = B [OK]

Hint: Check math inside expect carefully [OK]

Common Mistakes:

• Assuming both tests pass without checking math
• Confusing expected and actual values
• Ignoring test failure details

4. Identify the error in this RSpec test code:

describe 'String' do
  it 'checks length' do
    expect('hello'.length).to eq 5
  end
end

medium

A. Syntax error due to missing do keyword

B. Incorrect use of describe block

C. No error, code is correct

D. Missing parentheses in expect call

Solution

1. Step 1: Check syntax of expect

   The syntax expect('hello'.length).to eq 5 is valid in Ruby; parentheses are optional here.

2. Step 2: Verify describe and it blocks

   Both describe and it blocks have correct do ... end syntax.

3. Final Answer:

   No error, code is correct -> Option C

4. Quick Check:

   Code syntax valid = A [OK]

Hint: Parentheses optional in expect calls [OK]

Common Mistakes:

• Thinking parentheses are mandatory
• Confusing describe and it syntax
• Assuming missing do keyword

5. You want to test a method greet(name) that returns "Hello, <name>!". How do you organize your RSpec test using describe and it blocks for clarity and good practice?

hard

A. describe 'greet method' do
it 'returns greeting with given name' do
expect(greet('Alice')).to eq('Hello, Alice!')
end
end

B. it 'returns greeting with given name' do
expect(greet('Alice')).to eq('Hello, Alice!')
end

C. describe 'greet method' do
expect(greet('Alice')).to eq('Hello, Alice!')
end

D. describe 'greet method' do
it 'returns greeting with given name' { expect(greet('Alice')).to eq('Hello, Alice!') end

Solution

1. Step 1: Use describe to group tests

   The describe block groups related tests for the greet method.

2. Step 2: Use it for individual test cases

   The it block defines specific test cases. Expect statements directly in describe or standalone it lack proper structure.

3. Step 3: Prefer do...end for readability

   Use do ... end for multi-line blocks over { ... }.

4. Final Answer:

   describe 'greet method' do it 'returns greeting with given name' do expect(greet('Alice')).to eq('Hello, Alice!') end end -> Option A

5. Quick Check:

   describe groups, it tests, do...end blocks = C [OK]

Hint: Use describe for grouping, it for each test [OK]

Common Mistakes:

• Skipping describe block
• Writing expect outside it block
• Using curly braces for multi-line it block