# Lite::Validators

[![Gem Version](https://badge.fury.io/rb/lite-validators.svg)](http://badge.fury.io/rb/lite-validators)
[![Build Status](https://travis-ci.org/drexed/lite-validators.svg?branch=master)](https://travis-ci.org/drexed/lite-validators)

Lite::Validators is a collection of validators useful for any Rails application.

**NOTE:** If you are coming from `ActiveValidation`, please read the [port](#port) section.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'lite-validators'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install lite-validators

## Table of Contents

* [Validators](#validators)
* [3rd-party](#3rd-party)
* [Port](#port)

## Validators

* [Alpha](https://github.com/drexed/lite-validators/blob/master/docs/ALPHA.md)
* [Alpha numeric](https://github.com/drexed/lite-validators/blob/master/docs/ALPHA_NUMERIC.md)
* [Base64](https://github.com/drexed/lite-validators/blob/master/docs/BASE64.md)
* [Boolean](https://github.com/drexed/lite-validators/blob/master/docs/BOOLEAN.md)
* [Compare](https://github.com/drexed/lite-validators/blob/master/docs/COMPARE.md)
* [Coordinates](https://github.com/drexed/lite-validators/blob/master/docs/COORDINATE.md)
* [Credit card](https://github.com/drexed/lite-validators/blob/master/docs/CREDIT_CARD.md)
* [Csv](https://github.com/drexed/lite-validators/blob/master/docs/CSV.md)
* [Currency](https://github.com/drexed/lite-validators/blob/master/docs/CURRENCY.md)
* [CUSIP](https://github.com/drexed/lite-validators/blob/master/docs/CUSIP.md)
* [Email](https://github.com/drexed/lite-validators/blob/master/docs/EMAIL.md)
* [EIN](https://github.com/drexed/lite-validators/blob/master/docs/EIN.md)
* [File content Type](https://github.com/drexed/lite-validators/blob/master/docs/FILE_CONTENT_TYPE.md)
* [File extension](https://github.com/drexed/lite-validators/blob/master/docs/FILE_EXTENSION.md)
* [File size](https://github.com/drexed/lite-validators/blob/master/docs/FILE_SIZE.md)
* [HEX](https://github.com/drexed/lite-validators/blob/master/docs/HEX.md)
* [IMEI](https://github.com/drexed/lite-validators/blob/master/docs/IMEI.md)
* [IP address](https://github.com/drexed/lite-validators/blob/master/docs/IP_ADDRESS.md)
* [ISBN](https://github.com/drexed/lite-validators/blob/master/docs/ISBN.md)
* [ISIN](https://github.com/drexed/lite-validators/blob/master/docs/ISIN.md)
* [List](https://github.com/drexed/lite-validators/blob/master/docs/LIST.md)
* [MAC address](https://github.com/drexed/lite-validators/blob/master/docs/MAC.md)
* [Name](https://github.com/drexed/lite-validators/blob/master/docs/NAME.md)
* [Password](https://github.com/drexed/lite-validators/blob/master/docs/PASSWORD.md)
* [Phone number](https://github.com/drexed/lite-validators/blob/master/docs/PHONE_NUMBER.md)
* [SEDOL](https://github.com/drexed/lite-validators/blob/master/docs/SEDOL.md)
* [Slug](https://github.com/drexed/lite-validators/blob/master/docs/SLUG.md)
* [SSN](https://github.com/drexed/lite-validators/blob/master/docs/SSN.md)
* [Time zone](https://github.com/drexed/lite-validators/blob/master/docs/TIME_ZONE.md)
* [Type](https://github.com/drexed/lite-validators/blob/master/docs/TYPE.md)
* [URL](https://github.com/drexed/lite-validators/blob/master/docs/URL.md)
* [Username](https://github.com/drexed/lite-validators/blob/master/docs/USERNAME.md)
* [UUID](https://github.com/drexed/lite-validators/blob/master/docs/UUID.md)

## 3rd-party

The following are highly recommended 3rd-party validators to supplement your workflow:

* **DateTime:** Validates Timeliness - https://github.com/adzap/validates_timeliness
* **Existence:** Validates Existence - https://github.com/perfectline/validates_existence
* **Group:** Group Validations - https://github.com/adzap/grouped_validations
* **Overlap:** Validates Overlap - https://github.com/robinbortlik/validates_overlap

## Port

`Lite::Validators` is a near compatible port of [ActiveValidation](https://github.com/drexed/active_validation).

The names for the following validators has been changed, so you will need to make the
appropriate changes: `equality #=> compare`, `phone #=> phone_number`

The syntax for the following validators has been reworked, so you will need to consult the docs
for making the appropriate changes: `csv`, `compare`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-validators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Lite::Validators project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-validators/blob/master/CODE_OF_CONDUCT.md).