Allow passing of Array with brackets (eg. Array[String], Array[Integer])

[TySpring]

According to docs in Grape, you can pass a parameter of type array with a nested type, like so:

params do
  requires :my_param, type: Array[String], documentation: { param_type: 'body' }
end

(See https://github.com/ruby-grape/grape#custom-types-and-coercions section for example).

Before this PR, if you do this, the swagger JSON that is generated looks like this:

"my_param": {
    "type": "string",
    "description": "this is my param that is supposed to be an array of strings"
}

Now, it looks like this:

"my_param": {
    "type": "array",
    "description": "This is my param that is an array of strings",
    "items": {
        "type": "string"
    }
}

[dblock]

This seems a little hacky :) Maybe just a regex? What's the story with the ,?

[TySpring]

@dblock I could do a regex. The comma is because of a tricky situation. In Grape, you can specify type in 2 similar ways:

1. type: Array[String], meaning an array of strings, and
2. type: [String, Integer], meaning a multi-type param of either 'String' or 'Integer'

In the first case, once the options are within the realm of grape-swagger (at least from what I can tell), the Array prefix is stripped, and it just looks like '[String]'. The only way I could think to disambiguate '[String]' (array of type string) from '[String, Integer]' was to look for once vs. multiple items inside brackets, hence the ",". Open to other suggestions, but it's all I could think of.

[dblock]

I would make this more explicit. For example:

param_types = param_type.match(/^\[(.*)\]$/)
param_types = param_types[0].split(',') if param_types
# deal with param_types.size == 1
# deal with param_types.size > 1

[dblock]

Also make sure to add tests for the multiple types case.

[dblock]

This is great, thank you. Take a look at my comments, please, mostly minor.

[TySpring]

@dblock thanks for taking a look!

I addressed all the comments, except one (I wasn't sure exactly what you meant on moving the if on assignment)

[dblock]

You're parsing this twice, perpetuating the mess we have here and adding to it :) Refactor param_type_is_array into parse_param_type or something like that and return the array key. Nuke the whole possible_key = param.first.to_s.gsub('[', '[][') as well as part of that.

[LeFnord]

@dblock … the whole ('[', '[][') junk could be removed by avoiding the introducing of it here endpoint.rb#L224

I had to make a decision, should the name of the parameter indicating if it is a Hash, Array or not, this solution following the rails naming convention for form data

questions is, is it really needed … think removing it, could made many things easier

[TySpring]

so @LeFnord are you suggesting that the output for nested Arrays in formData would look like address[line1] as opposed to address[][line1] ?

Also @dblock are you saying you want me to remove the method param_type_is_array? altogether, and move the logic into parse_param_type? This seems contradictory to your comment here: #455 (comment).

@LeFnord @dblock Is your general goal just to "clean up the parsing code" without changing logic? Or is it actually to change the output of this parsing logic to remove the added [] for array types?

[dblock]

Just to loop the loop, I feel pretty strongly about that comment above on parsing, lets clean it up in this PR?

[dblock]

I'm merging this, @LeFnord might make more comments and we can iterate from here! Thanks @TySpring for hanging in here.

[TySpring]

Alright sounds great, happy to help more if I can. Thanks!

[LeFnord]

@TySpring … for the your work
@dblock … it's fine for me, Inwant to start a discussion, som, I don't have to decide it alone 😉