Replace positional arguments with keyword arguments

[vbrazo]

Issue

This PR is related to #1356 and #1651.

Description

Replacing positional arguments with keywords arguments.

[bpleslie]

Looks good to me! I like this move to keyword arguments. Complex interfaces are more intuitive now.

[mashedkeyboard]

Apologies for bumping an old PR - thought it better than opening a new issue about this.

Complex interfaces are more intuitive now.

This is true in most cases - however, it doesn't make sense in all, and the "one-size-fits-all" approach that's been applied here could be improved, I think.

For instance:

# Boundary numbers are inclusive
# Keyword arguments: from, to
Faker::Number.between(from: 1, to: 10) #=> 7

# Min and Max boundaries of range are inclusive
# Keyword arguments: range
Faker::Number.within(range: 1..10) #=> 7

There's no reason for the from and two kwargs in the call to Number.between - the syntax is obvious, and it just ends up adding unnecessary extra keywords into what was already perfectly clear code. And anything that only takes one argument clearly doesn't need kwargs - that's just producing inefficiency.

The move to kwargs is a sensible one overall, but I think there might be some design decisions worth revisiting in a future update. I defer to your much greater experience building Faker than mine, though!

[byronbowerman]

anything that only takes one argument clearly doesn't need kwargs - that's just producing inefficiency.

Came here to say this as well.

[Zeragamba]

I agree here as well. .words(number: 3) is not as nice as .words(3)

[vbrazo]

Yeah! We should probably centralize this discussion in an issue.

[mashedkeyboard]

Have created #1692 to discuss this.