Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vladfaust/validations.cr

Validations module for Crystal ✅
https://github.com/vladfaust/validations.cr

Last synced: 15 days ago
JSON representation

Validations module for Crystal ✅

Host: GitHub
URL: https://github.com/vladfaust/validations.cr
Owner: vladfaust
License: mit
Created: 2018-08-26T11:15:23.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2020-06-10T16:56:35.000Z (over 4 years ago)
Last Synced: 2024-08-01T17:36:55.962Z (3 months ago)
Language: Crystal
Homepage: https://github.vladfaust.com/validations.cr
Size: 72.3 KB
Stars: 13
Watchers: 3
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-crystal - validations - Validations mixin (Validation)
awesome-crystal - validations - Validations mixin (Validation)

README

        # Validations

[![Built with Crystal](https://img.shields.io/badge/built%20with-crystal-000000.svg?style=flat-square)](https://crystal-lang.org/)

[![Build status](https://img.shields.io/travis/vladfaust/validations.cr/master.svg?style=flat-square)](https://travis-ci.org/vladfaust/validations.cr)

[![API Docs](https://img.shields.io/badge/api_docs-online-brightgreen.svg?style=flat-square)](https://github.vladfaust.com/validations.cr)

[![Releases](https://img.shields.io/github/release/vladfaust/validations.cr.svg?style=flat-square)](https://github.com/vladfaust/validations.cr/releases)

[![Awesome](https://awesome.re/badge-flat2.svg)](https://github.com/veelenga/awesome-crystal)

[![vladfaust.com](https://img.shields.io/badge/style-.com-lightgrey.svg?longCache=true&style=flat-square&label=vladfaust&colorB=0a83d8)](https://vladfaust.com)

[![Patrons count](https://img.shields.io/badge/dynamic/json.svg?label=patrons&url=https://www.patreon.com/api/user/11296360&query=$.included[0].attributes.patron_count&style=flat-square&colorB=red&maxAge=86400)](https://www.patreon.com/vladfaust)

[![Gitter chat](https://img.shields.io/badge/chat%20on-gitter-green.svg?colorB=ED1965&logo=gitter&style=flat-square)](https://gitter.im/vladfaust/Lobby)

A validations module for [Crystal](https://crystal-lang.org/).

## Supporters

Thanks to all my patrons, I can continue working on beautiful Open Source Software! 🙏

[Lauri Jutila](https://github.com/ljuti), [Alexander Maslov](https://seendex.ru), Dainel Vera, Anton Yordanov

*You can become a patron too in exchange of prioritized support and other perks*

[![Become Patron](https://vladfaust.com/img/patreon-small.svg)](https://www.patreon.com/vladfaust)

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  validations:

    github: vladfaust/validations.cr

    version: ~> 0.2.0

```

This shard follows [Semantic Versioning 2.0.0](https://semver.org/), so see [releases](https://github.com/vladfaust/callbacks.cr/releases) and change the `version` accordingly.

## Usage

This shards allows validation composition (i.e. inclusion of modules with custom validations and rules).

```crystal

require "validations"

module CustomValidations

  include Validations

  rule :email do |attr, value, rule|

    invalidate(attr, "must be an email") unless /@/.match(value)

  end

end

struct User

  include Validations

  include CustomValidations

  property name : String

  property email : String

  @age : UInt8?

  @nilable : String?

  def initialize(@name, @email, @age : UInt8? = nil, @nilable : String? = nil)

  end

  validate name, size: (1..16), presence: true

  validate email, size: (6..64), email: true

  validate @age, gte: 18

  # Will not be run if `@nilable.nil?`

  validate @nilable, size: (5..10)

  # Custom validations are allowed

  def validate

    previous_def

    invalidate("name", "must not be equal to Vadim") if name == "Vadim"

  end

end

user = User.new("Vadim", "e-mail", 17)

user.valid? # false

pp user.invalid_attributes

# {

#   "name" => ["must have size in (1..16)", "must not be equal to Vadim"],

#   "email" => ["must have size in (6..64)", "must be an email"],

#   "@age" => ["must be greater than or equal to 18"]

# }

```

### List of currently implemented rules

* `is: Object` - check if `attribute == object`

* `presence: Bool` - check unless `attribute.nil?`

* `gte: Comparable` - check if `attribute >= comparable`

* `lte: Comparable` - check if `attribute <= comparable`

* `gt: Comparable` - check if `attribute > comparable`

* `lt: Comparable` - check if `attribute < comparable`

* `in: Enumerable` - check if `enumerable.includes?(attribute)`

* `size: Enumerable` - check if `enumerable.includes?(attribute.size)`

* `size: Int` - check if `attribute.size == int`

* `regex: Regex` - check if `regex.match(attribute)`

#### Rules which need to be explicitly required

Some rules are not required with `require "validations"`, you have to require them explicitly.

* `require "validations/rules/scheme"` *(related to URI scheme)*

  * `scheme: String` - check if `attribute.scheme == string`

  * `scheme: Enumerable` - check if `enumerable.includes?(attribute.scheme)`

## Contributing

1. Fork it ()

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

## Contributors

- [@vladfaust](https://github.com/vladfaust) Vlad Faust - creator, maintainer