This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Prop

Properties utilities for Crystal lang.

Mixin module that should be included in a class or a struct. This module improves the std's accessor macros (getter, getter!, getter?, property, ...). It provide a kind of IoC (Inversion Of Control).

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     prop:
       github: nicolab/crystal-prop

2. Run shards install

Usage

📘 API doc.

If you are looking for a validator to validate data before instantiating a class or a struct, you may be interested by validator. This validator shard uses Prop internally to define and handle validation rules on each instance variable.

Development

Install dev dependencies:

shards install

Run:

crystal spec

Clean before commit:

crystal tool format
./bin/ameba

Contributing

1. Fork it (https://github.com/Nicolab/crystal-prop/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

LICENSE

MIT (c) 2021, Nicolas Talle.

Author

Nicolas Talle