PartialParameters

Make your partials reusable and self-documented by validating the given parameters in development and test environments. If a required parameter is missing or an unknown parameter is given, an exception will be raised.

Add this line to your application's Gemfile:

gem 'partial_parameters'

And then execute:

$ bundle

Or install it yourself as:

$ gem install partial_parameters

And you are ready to go!

At the top of your partials, simply call the method partial_parameters and list your required and optional parameters:

Erb example:

  <% partial_parameters { required(:name); required(:age); optional(:height) }%>

Slim example:

  - partial_parameters do
    - required(:name)
    - required(:age)
    - optional(:height)

By default strict mode is enabled and an error will be raised if an unknown parameter has been passed to the partial. Of course, you can disable the strict mode:

  - partial_parameters(strict: false) do
    - required(:name)
    - required(:age)
    - optional(:height)

Bug reports and pull requests are welcome on GitHub at https://github.com/julien-meichelbeck/partial_parameters.

The gem is available as open source under the terms of the MIT License.