OptionHashExample.rb

OptionExample.rb

# A method signature such as:
def blah(file, underscore_to_hyphen=true)

# will be called like so:
blah(file, true)
# where true could also be false

# this is a code smell, since it is impossible to tell 
# from the call what the boolean does

# in Ruby, the convention is to use options hashes to 
# 'name' method params, as follows:

def blah(file, options={})
  underscore_to_hyphen = options[:underscore_to_hyphen]

# with this method signature, the method is called as follows:
blah(file, :underscore_to_hyphen => true)

# now it is clear from the method call 
# what the boolean refers to.