Anonymous Struct Literals Might Be Coming To Ruby
Tags: ruby, rails
Published: 2020-07-07 15:38:44

---
title: "Anonymous Struct Literals Might Be Coming To Ruby"
published: true
description: "What do you think of the new literal syntax Koichi Sasada and Matz have been discussing adding to Ruby?"
tags: ruby, rails
cover_image: "https://dev-to-uploads.s3.amazonaws.com/i/qwi46kbfx73m6xzj0lhk.jpg"
canonical_url: "https://supergood.software/ruby-anonymous-struct-literals/"
---

There's been some really interesting discussion in the Ruby community about adding anonymous struct literals to the language. My Japanese isn't very good (I don't speak Japanese), but Koichi Sasada and Matz had a little Twitter exchange about the idea and that's now turned into [a proposal](https://bugs.ruby-lang.org/issues/16986) on the Ruby tracker where there's been further discussion.

{% twitter 1276055259241046016 %}

## What's a Struct?

Ruby provides [Structs](https://ruby-doc.org/core-2.7.1/Struct.html) as a convenient way to create classes that group together a set of fields without forcing you to explicitly define a class with all the accessor methods.

For example, if you needed to pass around a representation of a dog but didn't need any additional behaviour you might do something like this:

```ruby
[1] pry(main)> Dog = Struct.new(:name, :breed, :age)
=> Dog
[2] pry(main)> roxie = Dog.new("Roxie", "whippet-cross", 4)
=> #<struct Dog name="Roxie", breed="whippet-cross", age=4>
[3] pry(main)> roxie.name
=> "Roxie"
[4] pry(main)> roxie.breed
=> "whippet-cross"
[5] pry(main)> roxie.age
=> 4
[6] pry(main)> roxie.age = 5
=> 5
[7] pry(main)> roxie2 = Dog.new("Roxie", "whippet-cross", 5)
=> #<struct Dog name="Roxie", breed="whippet-cross", age=5>
[8] pry(main)> roxie == roxie2
=> true
```

Because instances of Structs are equal if their attributes are all equal, it makes them a great solution for defining [value objects](https://martinfowler.com/bliki/ValueObject.html).

## What does the proposal add?

There's some disagreement on the syntax, but the idea is to add a syntax for defining anonymous instances of Structs in-line. Today, you might write this:

```ruby
roxie = Struct.new(:name, :breed).new(
  "Roxie",
  "whippet-cross"
)
```

With this proposal you'd be able to simply write something like this instead:

```ruby
roxie = ${name: "Roxie", breed: "whippet-cross"}
```

This would create an instance of an anonymous Struct class without having to explicitly define and instantiate the class.

## Why is that useful?

There are actually a number of benefits to this, but let's start with why anonymous Structs are useful regardless of the syntax.

### Structs avoid typos

In Ruby we often use hashes for passing around things like configuration options and other structured data. Structs allow us to do this without allowing arbitrary properties.

In our dog example above, `roxie.breeed = "pug"` will cause an error because we spelled "breed" incorrectly and the Struct doesn't have a member called "breeed". If were using a Hash instead then we'd be able to accidentally assign `roxie[:breeed] = "pug"` without any errors, accidentally creating a new typoed key in the Hash.

There are many cases where you need arbitrary properties, but for those cases you can use OpenStruct or a Hash. When accepting configuration from a user or any other situation where you know the possible fields in advance Structs work great.

### Anonymous Structs communicate intent

Writing code that communicates its own intent clearly is useful for helping future developers understand and modify that code. Using an anonymous Struct rather than a Hash or OpenStruct communicates to the person reading the code that the fields the object is defined with are the _only_ fields that object supports.

### Structs are simpler to access

This is admittedly a small improvement, but it's simpler to type `roxie.breed` than `roxie[:breed]`. In this example `roxie` doesn't represent an arbitrary mapping of keys to values, but a dog, so if we're following conventional object-oriented design practices, then `roxie` should be an object that responds to messages about itself.

Using Structs over Hashes also means that refactoring the code to use a real Class won't mean you need to change everywhere its data is accessed.

### OpenStruct is slow

OpenStruct is another class in the standard library that provides the ability to create objects that are basically like Structs, but are "open" to creating new attributes like Hashes are.

This is extremely useful if you need to support arbitrary attributes on the object, but if you don't you're just opening yourself up to the same issue as using a Hash:

```ruby
[1] pry(main)> roxie = OpenStruct.new(name: "Roxie", breed: "whippet-cross")
=> #<OpenStruct name="Roxie", breed="whippet-cross">
[2] pry(main)> roxie.breeed = "french bulldog"
=> "french bulldog"
[3] pry(main)> roxie
=> #<OpenStruct name="Roxie", breed="whippet-cross", breeed="french bulldog">
```

Additionally, while OpenStructs are definitely great when you need their "open" functionality, they are much slower than regular Structs. Koichi Sasada [notes this](https://bugs.ruby-lang.org/issues/16986#Performance) in the performance section of his proposal.

## But it says in the proposal that Hashes are faster!

One interesting detail that the proposal brings up is that Hashes are currently faster than Structs for this kind of usage. This is true, but Hashes have seen plenty of optimization because of how heavily we rely on them.

You would think that Structs would be faster than Hashes since their behaviour is simpler. Well, that's not the case but Koichi Sasada is confident that it _could_ be the case with some optimization.

This proposal also enables a whole new optimization that is only briefly mentioned:

> Thanks to this spec, we can specify anonymous Struct classes at compile time. We don't need to find or create Struct classes at runtime.

Because the attributes of the Structs is known at _parse_ time rather than _run_ time, it is possible to define the anonymous classes at compile time so that using this syntax incurs only the overhead of instantiating the anonymous class without having to define it too.

## What does it mean for you?

For now, not much. We can't use this in our programs yet, but we are free to use anonymous Structs in our code without the special syntax. If you're creating value objects, want to limit the attributes on your object, or just want to make refactoring easier, this isn't a bad idea.

That said, keep an eye on this proposal. Switching to this syntax in your applications when it becomes available could have performance benefits, save on typos, and make your code clearer.

What do you think about this new syntax? Let me know [on Twitter!](https://twitter.com/SuperGoodJared/status/1280509476861288449)