Allow accessing enum value names via methods #5206
Conversation
There was a problem hiding this comment.
Hey, thanks so much for this contribution and sorry I didn't get back to you til now. I'm definitely open to this change. I think the next few things to work out are:
-
What if the value's
graphql_name.downcaseconflicts with an existing method onSchema::Enum, likevalue,kind, orinherited? I think we should emit some kind of warning that the method generation was skipped and provide an override option likevalue_method:, whose value will be used instead ofgraphql_name.downcase. -
In case this causes some problems for people who are already using the gem, I'd like to have some way for them to turn it off. For example, if a
value_method:option was added,value_method: falsecould disable creating these methods, and they could set that option by default in their base enum value classes.
Thanks, and let me know what you think!
| You can get the GraphQL name of the enum value using the method matching its downcased name: | ||
|
|
||
| ```ruby | ||
| Types::MediaCategory.audio # => "Audio" |
| @@ -67,6 +67,7 @@ class << self | |||
| def value(*args, **kwargs, &block) | |||
| kwargs[:owner] = self | |||
| value = enum_value_class.new(*args, **kwargs, &block) | |||
| singleton_class.define_method(value.graphql_name.downcase) { value.graphql_name } | |||
There was a problem hiding this comment.
Implementation-wise, calling define_method with a block will result in the binding of this method staying in memory for the lifetime of the application. I'd like to avoid that memory "bloat", and we could probably do it with something like
instance_eval("def #{value.graphql_name.downcase}; #{value.graphql_name.inspect}; end;")It would create the method that returns the string, but without retaining a reference of the binding.
This is a pretty minor change, but might be helpful: now you can grab GraphQL name of the enum value using the method instead of a complex spell.
Before:
Jazz::Family.values["STRING"].graphql_nameNow:
Jazz::Family.string