Going back to our discussion in #2040 (comment), I've found it a bit tedious dealing with optional Array[Integer], Array[String], etc. types. Suppose I have an API with an optional parameter:
optional :values, type: Array[String], coerce_with: ->(val) { val.split(',').map(&:strip) }
I have four cases to consider for a PUT request:
Parameter provided Value Intended behavior Y nil Clear all values Y [] Clear all values N N/A Leaving existing values alone Y ["test", "foo"] Update existing valuesThe first two cases are identical, but we have hundreds of API calls, and I'd rather not fix all the supporting code because nil is now a valid input.
For optional parameters, I can't use default: [] because this always includes the parameter, even though it's optional. Adding the default value will cause us to clear out the values when I only want to coerce the value if the parameter is provided.
In Grape v1.3.x, the coercion method is not run for nil, so I can't even manually coerce nil to some other value with a custom method. To upgrade to Grape v1.3.x, I have to do the coercion within the API handler with this helper function:
def coerce_nil_param_to_array(params, key)
params.tap do |params|
params[key] = [] if params.key?(key) && params[key].nil?
end
end
For example:
update_params = declared_params(include_missing: false)
update_params = coerce_nil_param_to_array(declared_params, :values)
This isn't ideal; I could iterate through the options inside the route, but that doesn't feel right.
Now I'm wondering whether the coercion method should be run for nil types? Or make that an option?
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4