https://github.com/steve228uk/srformvalidator
A quick and dirty Laravel-style form validator in Swift.
https://github.com/steve228uk/srformvalidator
Last synced: 16 days ago
JSON representation
A quick and dirty Laravel-style form validator in Swift.
- Host: GitHub
- URL: https://github.com/steve228uk/srformvalidator
- Owner: steve228uk
- License: mit
- Created: 2015-09-09T11:51:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-22T08:44:06.000Z (about 9 years ago)
- Last Synced: 2025-04-12T13:56:03.408Z (17 days ago)
- Language: Ruby
- Size: 11.7 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SRFormValidator
A quick and dirty form validator in Swift. Inspired by [Laravel](http://laravel.com/docs/5.1/validation)
## Installation
Use cocoapods or install manually.
`pod 'SRFormValidator'`
## Usage
First, import `SRFormValidator` where you need it.
`import SRFormValidator`
Next, write your rules as a Dictionary. The key should be a keyPath to your field's values and the rules should be your dictionary's value. As it fetches the value using key path you can use variables or dictionaries freely. Below is an example using several rules and two dictionaries.
```swift
let rules = [
"personalDetails.emailAddress": "required|email",
"personalDetails.firstName": "required",
"personalDetails.lastName": "required",
"personalDetails.phone": "required|min:10|max:30",
"shippingDetails.address": "required",
"shippingDetails.city": "required",
"shippingDetails.state": "required",
"shippingDetails.zipCode": "required|alhanumeric|max:10"
]
```
You can validate your rules with the `isValid` class method. It'll return the fields that are erroring in an array or nil if the fields are valid.
```swift
let errors = SRFormValidator.isValid(rules, self)
if(errors != nil) {
println(valid)
}
```
## Rules
There are currently 5 rules that can be used to validate your fields. Multiple rules can be used in tandem when separated with a `|`. Some rules use a `:` to include arguments.
Rule | Effect
-----|-------
`required` | Checks if the field is `nil` or a blank string.
`email` | Checks if the field is a valid email address using regex.
`alphanumeric` | Checks if the field only contains a-z, A-Z, and 0-9 using regex.
`min:10` | Checks if the the field has a character length minimum to the value set or if an integer whether the value is >= to the rule.
`max:10` | Checks if the the field has a character length maximum to the value set or if an integer whether the value is <= to the rule.
## Notes
* **Swift 2.0 only.**
* Can only currently validate strings. It'll probably break if you try anything else but you can give it a go. Min and Max will try to parse ints.
* Messages aren't return, only that the field has failed.