Hash as named parameters pattern in Ruby

Introduction

This pattern helps you pass many options to a method clearly and flexibly using a hash. It makes your code easier to read and change.

When a method needs many optional settings.

When you want to call a method with clear labels for each argument.

When you want to add new options later without changing the method call everywhere.

When you want to group related parameters together.

When you want to avoid remembering the order of many arguments.

Syntax

Ruby

def method_name(options = {})
  # use options[:key] to access values
end

# calling the method
method_name(key1: value1, key2: value2)

The method receives a hash named options with keys and values.

You access each option inside the method using options[:key].

Examples

This method uses a hash to get the name. If no name is given, it says "friend".

Ruby

def greet(options = {})
  name = options[:name] || "friend"
  puts "Hello, #{name}!"
end

greet(name: "Alice")
greet

Here, the method uses two named parameters inside a hash with defaults.

Ruby

def order_drink(options = {})
  size = options[:size] || "medium"
  type = options[:type] || "coffee"
  puts "Ordering a #{size} #{type}."
end

order_drink(size: "large", type: "tea")
order_drink(type: "juice")

Sample Program

This program shows a method that takes a hash as named parameters to book flights. It uses default values if some keys are missing.

Ruby

def book_flight(options = {})
  from = options[:from] || "Unknown"
  to = options[:to] || "Unknown"
  date = options[:date] || "Anytime"
  puts "Booking flight from #{from} to #{to} on #{date}."
end

book_flight(from: "NYC", to: "LA", date: "2024-07-01")
book_flight(to: "Paris")

Important Notes

You can use options.fetch(:key, default) to provide defaults more cleanly.

Since Ruby 2.0, you can also use real named parameters, but hashes are still useful for flexible options.

Summary

Use a hash to pass named parameters for clarity and flexibility.

Access options inside the method with options[:key].

Provide default values to handle missing keys.

Practice

1. What is the main advantage of using a hash as named parameters in a Ruby method?

easy

A. It improves the method's execution speed significantly.

B. It forces the method to accept only one argument.

C. It makes the method call clearer by naming each argument explicitly.

D. It prevents any default values from being used.

Solution

1. Step 1: Understand named parameters purpose

   Named parameters improve code readability by explicitly naming each argument passed to a method.

2. Step 2: Compare with other options

   Options B, C, and D are incorrect because using a hash does not limit argument count to one, does not speed up execution notably, and does not prevent default values.

3. Final Answer:

   It makes the method call clearer by naming each argument explicitly. -> Option C

4. Quick Check:

   Named parameters = clearer calls [OK]

Hint: Named parameters improve clarity by naming each argument [OK]

Common Mistakes:

• Thinking it limits arguments to one
• Assuming it speeds up code
• Believing it disables default values

2. Which of the following is the correct syntax to define a method using a hash for named parameters in Ruby?

easy

A. def greet(name: options = {})

B. def greet(name, options = {})

C. def greet(options: {})

D. def greet(options = [])

Solution

1. Step 1: Identify correct method parameter syntax

   In Ruby, to accept named parameters as a hash, you define the method with a parameter defaulting to an empty hash, like options = {}.

2. Step 2: Check each option

   def greet(name, options = {}) uses options = {} correctly. def greet(name: options = {}) uses invalid syntax. def greet(options: {}) tries to use keyword arguments incorrectly. def greet(options = []) uses an array instead of a hash.

3. Final Answer:

   def greet(name, options = {}) -> Option B

4. Quick Check:

   Hash parameter = options = {} [OK]

Hint: Use options = {} to accept named parameters as a hash [OK]

Common Mistakes:

• Using square brackets [] instead of curly braces {}
• Confusing keyword arguments with hash parameters
• Incorrect syntax like name: options = {}

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

def info(options = {})
  "Name: #{options[:name]}, Age: #{options[:age]}"
end

puts info(name: "Alice", age: 30)

medium

A. Name: , Age:

B. Error: wrong number of arguments

C. Name: {:name=>"Alice"}, Age: {:age=>30}

D. Name: Alice, Age: 30

Solution

1. Step 1: Understand method call with hash named parameters

   The method info accepts a hash options. The call info(name: "Alice", age: 30) passes a hash with keys :name and :age.

2. Step 2: Evaluate string interpolation

   The method returns a string with values from the hash accessed by options[:name] and options[:age], which are "Alice" and 30 respectively.

3. Final Answer:

   Name: Alice, Age: 30 -> Option D

4. Quick Check:

   options[:name], options[:age] = Alice, 30 [OK]

Hint: Access hash keys with options[:key] inside method [OK]

Common Mistakes:

• Expecting error due to multiple arguments
• Confusing hash keys with string keys
• Not using symbol keys for access

4. Identify the error in the following Ruby method using hash named parameters:

def display(options = {})
  puts "Title: #{options[:title]}"
  puts "Author: #{options[:author]}"
end

display(title: "Ruby Guide")

medium

A. It prints Title but prints nothing for Author without error.

B. It raises an error because :author key is missing in options.

C. Syntax error due to missing parentheses in method call.

D. No error; it prints Title and Author correctly.

Solution

1. Step 1: Analyze method call and parameters

   The method display is called with a hash containing only :title. The :author key is missing.

2. Step 2: Understand Ruby hash access behavior

   Accessing a missing key like options[:author] returns nil, which prints as empty string without error.

3. Final Answer:

   It prints Title but prints nothing for Author without error. -> Option A

4. Quick Check:

   Missing key returns nil, no error [OK]

Hint: Missing hash keys return nil, print empty string [OK]

Common Mistakes:

• Expecting a runtime error for missing keys
• Thinking missing keys print 'nil' string
• Assuming syntax error without parentheses

5. Given the method below, how can you modify it to provide a default value of 18 for the :age key if it is not passed?

def person_info(options = {})
  "Name: #{options[:name]}, Age: #{options[:age]}"
end

puts person_info(name: "Bob")

hard

A. Use options[:age] || 18 inside the string interpolation.

B. Set default value in method definition like def person_info(options = {age: 18}).

C. Raise an error if :age is missing to force passing it.

D. Use options.fetch(:age) without default to get 18.

Solution

1. Step 1: Understand default value requirement

   We want to show 18 if :age is missing in options.

2. Step 2: Use Ruby's || operator for default

   Using options[:age] || 18 returns options[:age] if present, otherwise 18.

3. Step 3: Check other options

   Set default value in method definition like def person_info(options = {age: 18}). sets default hash but can be overridden incorrectly. Raise an error if :age is missing to force passing it. raises error, not default. Use options.fetch(:age) without default to get 18. fetch without default raises error if missing.

4. Final Answer:

   Use options[:age] || 18 inside the string interpolation. -> Option A

5. Quick Check:

   Default with || operator = 18 [OK]

Hint: Use options[:key] || default_value for defaults [OK]

Common Mistakes:

• Setting default hash in parameter incorrectly
• Using fetch without default causing error
• Raising error instead of providing default