Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 581 Bytes

README.md

File metadata and controls

26 lines (15 loc) · 581 Bytes

RequiredOptions

DESCRIPTION

Guard your methods against those slacker options that 'forget' to come to class.

INSTALLATION

Add gem to your project.

If using bundler

gem 'required_options'

USAGE

Just declare which components of your options hash that you can't live without

def some_method_with_options(arg, opts = {})
  required_options opts, :track_name, :band_name

  # do some really smart work here
end

If a required option is not passed into the method, it will raise a MissingOptions exception that displays the forgotten option.