RubyDev - The Home for Ruby Developers

Ruby OpenStruct Mastery

OpenStruct provides a flexible way to create objects with arbitrary attributes. It's perfect for dynamic data structures, configuration objects, and when you need the flexibility of a hash with the convenience of object notation.

OpenStruct Basics & Creation

OpenStruct: OpenStruct creates objects with arbitrary attributes that can be set and accessed dynamically. It's like a hash but with object notation, perfect for flexible data structures and configuration objects.

Creating OpenStruct Objects

# Require the OpenStruct library
require
'ostruct'

# Create OpenStruct from hash
person = OpenStruct.new(name: "Alice", age: 25, city: "New York")
puts
person.name
# "Alice"
puts
person.age
# 25
puts
person.city
# "New York"

# Create empty OpenStruct and add attributes
config = OpenStruct.new
config.database_url = "postgres://localhost:5432/myapp"
config.api_key = "abc123"
config.debug = true

puts
config.database_url
# "postgres://localhost:5432/myapp"
puts
config.debug
# true

Key Feature: OpenStruct allows you to create objects with arbitrary attributes dynamically, making it perfect for configuration objects, data transformation, and flexible data structures.

Dynamic Attributes & Methods

Adding and Modifying Attributes

# Dynamic attribute assignment
user = OpenStruct.new
user.name = "Bob"
user.email = "bob@example.com"
user.age = 30

# Modify existing attributes
user.age = 31
user.role = "admin"

# Access attributes
puts
user.name
# "Bob"
puts
user.role
# "admin"

# Check if attribute exists
puts
user.respond_to?(:name)
# true
puts
user.respond_to?(:salary)
# false

Nested OpenStruct Objects

# Nested structures
company = OpenStruct.new
company.name = "TechCorp"
company.address = OpenStruct.new
company.address.street = "123 Main St"
company.address.city = "San Francisco"
company.address.zip = "94105"

puts
company.name
# "TechCorp"
puts
company.address.city
# "San Francisco"

# Complex nested data
product = OpenStruct.new(
  name: "Laptop",
  price: 999.99,
  specs: OpenStruct.new(
    cpu: "Intel i7",
    ram: "16GB",
    storage: "512GB SSD"
  )
)

puts
product.specs.cpu
# "Intel i7"

OpenStruct Methods & Operations

Built-in OpenStruct Methods

# OpenStruct utility methods
person = OpenStruct.new(name: "Alice", age: 25, city: "NYC")

# Get all attributes as hash
puts
person.to_h
# {:name=>"Alice", :age=>25, :city=>"NYC"}

# Get attribute names
puts
person.each_pair.to_a
# [[:name, "Alice"], [:age, 25], [:city, "NYC"]]

# Delete attributes
person.delete_field(:city)
puts
person.to_h
# {:name=>"Alice", :age=>25}

# Check if attribute exists
puts
person.respond_to?(:name)
# true
puts
person.respond_to?(:city)
# false

Iteration and Enumeration

# Iterating over OpenStruct
config = OpenStruct.new(
  database: "postgres",
  port: 5432,
  debug: true,
  timeout: 30
)

# Iterate over key-value pairs
config.each_pair
do
|key, value|
  puts "#{key}: #{value}"
end

# Convert to array of pairs
puts
config.each_pair.to_a

# Filter attributes
numeric_config = config.each_pair.select { |k, v| v.is_a?(Numeric) }
puts
numeric_config.to_h
# {:port=>5432, :timeout=>30}

Interactive Practice: OpenStruct

Practice Time: Try these OpenStruct examples and experiment with different dynamic attribute patterns. Understanding OpenStruct will make you a more effective Ruby programmer.

Interactive Code Runner

Ruby Code Editor

# Try these comprehensive OpenStruct examples!
require 'ostruct'

# 1. Basic OpenStruct creation
person = OpenStruct.new(name: "Alice", age: 25, city: "New York")
puts "Person: #{person.name}, #{person.age}, #{person.city}"

# 2. Dynamic attribute assignment
config = OpenStruct.new
config.database_url = "postgres://localhost:5432/myapp"
config.api_key = "abc123"
config.debug = true
config.timeout = 30

puts "\nConfig:"
puts "Database: #{config.database_url}"
puts "Debug: #{config.debug}"
puts "Timeout: #{config.timeout}"

# 3. Nested OpenStruct objects
company = OpenStruct.new
company.name = "TechCorp"
company.address = OpenStruct.new
company.address.street = "123 Main St"
company.address.city = "San Francisco"
company.address.zip = "94105"

puts "\nCompany:"
puts "Name: #{company.name}"
puts "Address: #{company.address.street}, #{company.address.city} #{company.address.zip}"

# 4. Complex nested data
product = OpenStruct.new(
  name: "Laptop",
  price: 999.99,
  specs: OpenStruct.new(
    cpu: "Intel i7",
    ram: "16GB",
    storage: "512GB SSD",
    display: OpenStruct.new(
      size: "15.6 inch",
      resolution: "1920x1080"
    )
  )
)

puts "\nProduct:"
puts "Name: #{product.name}"
puts "Price: $#{product.price}"
puts "CPU: #{product.specs.cpu}"
puts "Display: #{product.specs.display.size} #{product.specs.display.resolution}"

# 5. OpenStruct utility methods
user = OpenStruct.new(name: "Bob", email: "bob@example.com", role: "admin")

puts "\nUser methods:"
puts "to_h: #{user.to_h}"
puts "respond_to?(:name): #{user.respond_to?(:name)}"
puts "respond_to?(:salary): #{user.respond_to?(:salary)}"

# 6. Iteration over OpenStruct
settings = OpenStruct.new(
  theme: "dark",
  language: "en",
  notifications: true,
  auto_save: false,
  max_file_size: 10
)

puts "\nSettings iteration:"
settings.each_pair do |key, value|
  puts "  #{key}: #{value}"
end

# 7. Filtering and transformation
puts "\nNumeric settings:"
numeric_settings = settings.each_pair.select { |k, v| v.is_a?(Numeric) }
puts numeric_settings.to_h

puts "\nBoolean settings:"
boolean_settings = settings.each_pair.select { |k, v| v.is_a?(TrueClass) || v.is_a?(FalseClass) }
puts boolean_settings.to_h

# 8. Dynamic attribute modification
user.age = 30
user.department = "Engineering"
user.salary = 75000

puts "\nUpdated user:"
puts "Age: #{user.age}"
puts "Department: #{user.department}"
puts "Salary: $#{user.salary}"

# 9. Delete attributes
user.delete_field(:salary)
puts "\nAfter deleting salary:"
puts "respond_to?(:salary): #{user.respond_to?(:salary)}"
puts "to_h: #{user.to_h}"

# 10. Practical example: API response parsing
api_response = OpenStruct.new(
  status: "success",
  data: OpenStruct.new(
    users: [
      OpenStruct.new(id: 1, name: "Alice", email: "alice@example.com"),
      OpenStruct.new(id: 2, name: "Bob", email: "bob@example.com")
    ],
    total: 2,
    page: 1
  ),
  message: "Users retrieved successfully"
)

puts "\nAPI Response:"
puts "Status: #{api_response.status}"
puts "Message: #{api_response.message}"
puts "Total users: #{api_response.data.total}"
puts "First user: #{api_response.data.users.first.name} (#{api_response.data.users.first.email})"

# Add your own OpenStruct experiments below!

Output will appear here when you run the code...

OpenStruct Best Practices

✅ Do This

Use OpenStruct for configuration objects
Leverage for dynamic data structures
Use for API response parsing
Apply for flexible data containers
Use for prototyping and testing

❌ Avoid This

Using OpenStruct for performance-critical code
Overusing when structs or classes are more appropriate
Forgetting that attributes are mutable
Using for complex business logic
Ignoring memory overhead

Ruby OpenStruct Mastery Checklist

Basic Creation: Create OpenStruct objects from hashes or empty
Dynamic Attributes: Add and modify attributes at runtime
Nested Structures: Create complex nested OpenStruct objects
Utility Methods: Use to_h, delete_field, respond_to?
Iteration: Iterate over attributes with each_pair
Configuration: Use for flexible configuration objects
API Responses: Parse dynamic API response data
Performance: Understand when to use vs avoid

Next Steps: Practice with OpenStruct for configuration management, API response parsing, and dynamic data structures. OpenStruct is perfect when you need the flexibility of a hash with the convenience of object notation!

Ruby OpenStruct Mastery

Ruby OpenStruct Mastery

OpenStruct Basics & Creation

Creating OpenStruct Objects

Dynamic Attributes & Methods

Adding and Modifying Attributes

Nested OpenStruct Objects

OpenStruct Methods & Operations

Built-in OpenStruct Methods

Iteration and Enumeration

Interactive Practice: OpenStruct

Interactive Code Runner

Ruby Code Editor

OpenStruct Best Practices

✅ Do This

❌ Avoid This

Ruby OpenStruct Mastery Checklist

Quick Navigation

Related Topics

Video Tutorial

Ruby Language

Rails Framework

Production Ready

Ruby OpenStruct Mastery

Ruby OpenStruct Mastery

OpenStruct Basics & Creation

Creating OpenStruct Objects

Dynamic Attributes & Methods

Adding and Modifying Attributes

Nested OpenStruct Objects

OpenStruct Methods & Operations

Built-in OpenStruct Methods

Iteration and Enumeration

Interactive Practice: OpenStruct

Interactive Code Runner

Ruby Code Editor

OpenStruct Best Practices

✅ Do This

❌ Avoid This

Ruby OpenStruct Mastery Checklist

Quick Navigation

Related Topics

Video Tutorial