Ruby 2.5 allows creating structs with keyword arguments

Prathamesh Sonpatki

Prathamesh Sonpatki

January 16, 2018

This blog is part of our  Ruby 2.5 series.

In Ruby, structs can be created using positional arguments.

1Customer = Struct.new(:name, :email)
2Customer.new("John", "[email protected]")

This approach works when the arguments list is short. When arguments list increases then it gets harder to track which position maps to which value.

Here if we pass keyword argument then we won't get any error. But the values are not what we wanted.

1Customer.new(name: "John", email: "[email protected]")
2=> #<struct Customer name={:name=>"John", :email=>"[email protected]"}, email=nil>

Ruby 2.5 introduced creating structs using keyword arguments. Relevant pull request is here.

However this introduces a problem. How do we indicate to Struct if we want to pass arguments using position or keywords.

Takashi Kokubun suggested to use keyword_argument as an identifier.

1Customer = Struct.new(:name, :email, keyword_argument: true)
2Customer.create(name: "John", email: "[email protected]")

Matz suggested to change the name to keyword_init.

So in Ruby 2.5 we can create structs using keywords as long as we are passing keyword_init.

1Customer = Struct.new(:name, :email, keyword_init: true)
2
3Customer.new(name: "John", email: "[email protected]")
4=> #<struct Customer name="John", email="[email protected]">

If this blog was helpful, check out our full blog archive.

Stay up to date with our blogs.

Subscribe to receive email notifications for new blog posts.