Keyword arguments in Ruby

Introduction

Keyword arguments let you give names to inputs when calling a method. This makes your code easier to read and understand.

When a method needs many inputs and you want to avoid confusion about their order.

When you want to make some inputs optional with default values.

When you want to clearly show what each input means in your code.

When you want to improve code readability for others or your future self.

Syntax

Ruby

def method_name(arg1:, arg2: default_value)
  # method body
end

method_name(arg1: value1, arg2: value2)

Keyword arguments are written with a colon after the name in the method definition.

You call the method by naming each argument, like arg1: value.

Examples

This method requires both name and age as keyword arguments.

Ruby

def greet(name:, age:)
  puts "Hello, #{name}! You are #{age} years old."
end

greet(name: "Alice", age: 30)

Here, age has a default value of 18, so you can skip it when calling.

Ruby

def greet(name:, age: 18)
  puts "Hello, #{name}! You are #{age} years old."
end

greet(name: "Bob")

This method shows how to use a default value for size.

Ruby

def order(drink:, size: "medium")
  puts "You ordered a #{size} #{drink}."
end

order(drink: "coffee")

Sample Program

This program defines a method to book a flight using keyword arguments. It shows how to use default values and how to call the method with different arguments.

Ruby

def book_flight(destination:, date:, seat_class: "economy")
  puts "Booking a #{seat_class} seat to #{destination} on #{date}."
end

book_flight(destination: "Paris", date: "2024-07-01")
book_flight(destination: "Tokyo", date: "2024-08-15", seat_class: "business")

Important Notes

If you forget to provide a required keyword argument, Ruby will raise an error.

Keyword arguments improve code clarity by naming each input explicitly.

Summary

Keyword arguments let you name inputs when calling methods.

You can set default values to make some arguments optional.

This makes your code easier to read and less error-prone.

Practice

1. What is the purpose of keyword arguments in Ruby methods?

easy

A. To convert all arguments into strings automatically

B. To force all arguments to be passed in order

C. To make arguments optional without default values

D. To allow passing arguments by name for clarity and flexibility

Solution

1. Step 1: Understand keyword arguments

   Keyword arguments let you pass values to a method by naming them, not just by position.

2. Step 2: Identify the benefit

   This makes code clearer and lets you skip or reorder arguments easily.

3. Final Answer:

   To allow passing arguments by name for clarity and flexibility -> Option D

4. Quick Check:

   Keyword arguments = named, clear, flexible [OK]

Hint: Keyword arguments are named for clarity and order freedom [OK]

Common Mistakes:

• Thinking keyword arguments force order
• Confusing keyword arguments with positional arguments
• Assuming keyword arguments convert types automatically

2. Which of the following is the correct syntax to define a method with keyword arguments in Ruby?

easy

A. def greet(name =>, age =>); puts "Hello #{name}, you are #{age}"; end

B. def greet(name, age); puts "Hello #{name}, you are #{age}"; end

C. def greet(name:, age:); puts "Hello #{name}, you are #{age}"; end

D. def greet(name =:, age =:); puts "Hello #{name}, you are #{age}"; end

Solution

1. Step 1: Review Ruby keyword argument syntax

   Keyword arguments are defined with a colon after the argument name, like name:.

2. Step 2: Check each option

   def greet(name:, age:); puts "Hello #{name}, you are #{age}"; end uses correct syntax with name: and age:. Others use invalid symbols or positional arguments.

3. Final Answer:

   def greet(name:, age:); puts "Hello #{name}, you are #{age}"; end -> Option C

4. Quick Check:

   Keyword args use colon after name [OK]

Hint: Keyword args end with colon in method definition [OK]

Common Mistakes:

• Using => instead of : for keyword arguments
• Defining keyword arguments without colons
• Confusing positional and keyword argument syntax

3. What will be the output of the following Ruby code?

def info(name:, age: 30)
  "Name: #{name}, Age: #{age}"
end

puts info(name: "Alice")

medium

A. Name: Alice, Age: 30

B. Name: Alice, Age:

C. ArgumentError: missing keyword: age

D. Name: , Age: 30

Solution

1. Step 1: Analyze method parameters

   The method info has a required keyword argument name: and an optional keyword argument age: with default 30.

2. Step 2: Check method call

   The call passes name: "Alice" but no age, so default 30 is used.

3. Final Answer:

   Name: Alice, Age: 30 -> Option A

4. Quick Check:

   Default keyword argument used when missing [OK]

Hint: Missing keyword uses default if provided [OK]

Common Mistakes:

• Expecting error when optional keyword is missing
• Confusing positional defaults with keyword defaults
• Ignoring default values in keyword arguments

4. Identify the error in the following Ruby method call:

def order(item:, quantity:)
  "Order: #{quantity} x #{item}"
end

puts order(quantity: 3, "apple")

medium

A. ArgumentError: missing keyword: item

B. SyntaxError due to positional argument after keyword argument

C. No error, prints 'Order: 3 x apple'

D. TypeError: wrong argument type String (expected Symbol)

Solution

1. Step 1: Examine method call arguments

   The call uses quantity: 3 (keyword) then "apple" (positional).

2. Step 2: Understand Ruby argument rules

   In Ruby, positional arguments cannot come after keyword arguments in a call; this causes a syntax error.

3. Final Answer:

   SyntaxError due to positional argument after keyword argument -> Option B

4. Quick Check:

   Positional args must come before keyword args [OK]

Hint: Positional args cannot follow keyword args in calls [OK]

Common Mistakes:

• Passing positional argument after keyword argument
• Assuming Ruby allows mixed order without error
• Confusing missing keyword with syntax error

5. Given this method:
<pre>def build_profile(name:, age:, city: "Unknown", **extras) profile = {name: name, age: age, city: city} profile.merge!(extras) profile end What will be the result of build_profile(name: "Bob", age: 25, hobby: "guitar", pet: "dog")?

hard

A. {:name=>"Bob", :age=>25, :city=>"Unknown", :hobby=>"guitar", :pet=>"dog"}

B. {:name=>"Bob", :age=>25, :city=>"Unknown"}

C. ArgumentError: unknown keyword: hobby

D. {:name=>"Bob", :age=>25, :city=>"Unknown", :extras=>{:hobby=>"guitar", :pet=>"dog"}}

Solution

1. Step 1: Understand method parameters

   The method requires name and age, has optional city with default, and collects extra keyword arguments into extras.

2. Step 2: Analyze method call

   The call passes name, age, and extra keywords hobby and pet. These extras are merged into the profile hash.

3. Step 3: Determine final hash

   The returned hash includes all keys: name, age, default city, plus hobby and pet from extras.

4. Final Answer:

   {:name=>"Bob", :age=>25, :city=>"Unknown", :hobby=>"guitar", :pet=>"dog"} -> Option A

5. Quick Check:

   Extras merged into hash with defaults [OK]

Hint: Use **extras to capture and merge extra keyword args [OK]

Common Mistakes:

• Expecting error on unknown keywords with **extras
• Forgetting to merge extras into profile
• Assuming extras stored under :extras key