[ruby-core:53304] [ruby-trunk - Bug #8040] Unexpect behavior when using keyword arguments

Issue #8040 has been updated by marcandre (Marc-Andre Lafortune).


mame (Yusuke Endoh) wrote:
> But, it may be good that we consider the hash for a keyword *only when* the number of arguments is more than the expected mandatory parameters.

+1

----------------------------------------
Bug #8040: Unexpect behavior when using keyword arguments
https://bugs.ruby-lang.org/issues/8040#change-37482

Author: pabloh (Pablo Herrero)
Status: Assigned
Priority: Normal
Assignee: matz (Yukihiro Matsumoto)
Category: 
Target version: 
ruby -v: 2.0.0-p0


=begin
There is an odd behavior when calling methods with the new keyword arguments syntax, when you have a method defined with mandatory arguments that also takes options, like this:

  def foo value, **keywords
    puts [value,keywords].inspect
  end
  
  foo("somthing") #This works
  foo("somthing", key: 'value') #This also works
  
  foo(Hash.new(something: 'else')) #This raises 'ArgumentError: wrong number of arguments (0 for 1)'

This feels weird regardless the fact that keyword arguments are a Hash at the bottom, since you ARE PASSING an argument.

Other side effect from this, is that when you call the method ((|foo|)) with a single argument, you can't anticipate how many argument you will be actually passing at runtime unless you know beforehand the argument's class.

What's maybe even more concerning is the fact than this happens even when you pass an argument which class derives from Hash:

  class MyDirectory < Hash; end
   
  foo(MyDirectory.new(something: 'else')) #This also raises 'ArgumentError: wrong number of arguments (0 for 1)'


Besides finding this behavior surprising, I think this could also possibly lead to old code been unexpectedly broken when updating old methods that takes options to the new syntax.

For example if you have this code:

  def foo_with_options argument, options = {}
    #Do some stuff with options
  end
  
  
  #And at someplace else...
  
  my_hash_thingy = Hash.new
  foo_with_options(my_hash_thingy) #Only passing mandatory argument, with no options, works fine.


When updating to the new syntax:

  def foo_with_options argument, an_option: 'value1', another_option: 'value2'
    #Do some stuff with options
  end
  
  
  
  #And at someplace else...
  
  my_hash_thingy = Hash.new
  foo_with_options(my_hash_thingy) #Only passing mandatory argument, with no options, doesn't work anymore.
=end


-- 
http://bugs.ruby-lang.org/