WIP Crutches.Option module

[duijf]

Functions to turn this:

@function_name [
  valid_options: [:some, :option],
  default_options: [
    some: "foo"
    option: "bar"
  ]
]
def function_name(args, opts \\ @function_name[:default_options])
def function_name(args, opts) do
  Crutches.Keyword.validate_keys!(opts, @function_name[:valid_options])
  options = Keyword.merge(@function_name[:default_options], opts)

  ...
end

Into this:

@function_name [
  valid: [:some, :option],
  defaults: [
    some: "foo",
    option: "bar"
  ]
]
def function_name(args, opts \\ @function_name[:defaults])
def function_name(args, opts) do
  # This validates and merges the options, throwing on error.
  opts = Crutches.Options.combine!(opts, @function_name)

  ...
end

For more context, see #42.

Refactoring of the library to make use of these new functions is not going to happen in this PR, in order for everyone to be able to benefit from these functions as quickly as possible.

TODOs:

• Option.combine!(options, configuration) — throwing
• Option.combine(options, configuration) — non-throwing
• Option.combine!(options, configuration, combinator) — throwing, with custom combinator.
• Option.combine(options, configuration, combinator) — non-throwing, with custom combinator.
• Move the functions from Crutches.Keyword into Crutches.Option

[duijf]

Hmm, weird that the build is failing. Might have to do with other warnings, but I doubt that'd make it segfault. Temporarily fixing all warnings (will drop from commit history if unsuccessful).

[duijf]

That seems to have done it. If wanted, that commit could go somewhere else.

[CyrusOfEden]

Just call combine(args) instead of Crutches.Option.combine(args). Ditto for other occurrences.

P.S. Great work dude!

[duijf]

@KNRZ Incorporated your feedback. Currently working on the last checkbox.