How to set a default value for a splat argument in Ruby

Question

Setting a default value for a splat argument gives an error:

1.9.3-p374 :001 > def a b, *c = nil
1.9.3-p374 :002?>   end
SyntaxError: (irb):1: syntax error, unexpected '=', expecting ';' or '\n'
def a b, *c = nil
             ^
    from /Users/me/.rvm/rubies/ruby-1.9.3-p374/bin/irb:16:in `<main>'

Some variations I tried that don't work either:

1.9.3-p374 :003 > def a b, *c = []
1.9.3-p374 :005 > def a b, (*c) = nil
1.9.3-p374 :007 > def a b, (*c = [])
1.9.3-p374 :009 > def a b, (*c = [1,2,3])
1.9.3-p374 :011 > def a b, *c = [1,2,3]

I don't see an indeterminacy issue here, so it seems like it should be possible.

Related: Why non-explicit splat param plus default param is wrong syntax for method definition in Ruby 1.9?

Answer 1

Your attempted usage is counter the conventions around splat usage. Splats are supposed (at least in Ruby) to take up all extra (0, 1 or more) values.

If you know that you want the second value in your method arguments list to have a default value, you could take it out of the splat and list it just before the splat with a default value like this:

def a b, c=nil, *d 
  # rest of code omitted
end

EDIT: To make the answer to your question of why it doesn't work perfectly clear. It's a design decision by the language designer. Matz never intended the splat operator to work with defaults. This seems pretty sensible to me since it is intended to be used for catching an indeterminate number of variables and because the method I described reads more clearly than the possibilities you described and because all of the problems your examples solve are solvable in other ways.

Answer 2

You could set the default value in the method itself knowing that the default splat returns an empty array.

def test(a, *b)
  b = "default b" if b == [] # edited as per Tin Man's recommendation
  puts [a, b].inspect
end

test("Test", 1, 2)
# => ["Test", [1, 2]]
test("Test")
# => ["Test", "default b"]

In Rails, you could check for b.present? as an empty array is considered blank. Hope that helps.

Answer 3

A splat argument defaults to an empty array, without your having to do anything special.

def a(b, *c)
  c
end

a("foo")
#=> []

Answer 4

This is very convenient:

def initialize(*response_names)
  @response_names = response_names.presence || %w(default values)
end