Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gkaimakas/swiftvalidatorsreactiveextensions
SwiftValidators that play nice with ReactiveSwift's ValidatingProperty
https://github.com/gkaimakas/swiftvalidatorsreactiveextensions
cocoapods ios pods swift swift-3 swift3 validation validator xcode
Last synced: 3 months ago
JSON representation
SwiftValidators that play nice with ReactiveSwift's ValidatingProperty
- Host: GitHub
- URL: https://github.com/gkaimakas/swiftvalidatorsreactiveextensions
- Owner: gkaimakas
- License: mit
- Archived: true
- Created: 2017-03-31T10:43:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-12T12:02:25.000Z (almost 6 years ago)
- Last Synced: 2024-09-28T22:20:57.590Z (3 months ago)
- Topics: cocoapods, ios, pods, swift, swift-3, swift3, validation, validator, xcode
- Language: Swift
- Homepage:
- Size: 70.3 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swift Validators Reactive Extensions :large_orange_diamond:
`ReactiveSwift`'s `ValidatingProperty` is the ideal place to apply SwiftValidators. `SwiftValidatorsReactiveExtensions` provides a set of extensions that make working with `ValidatingProperty` easy.
## Contents
+ [Installation](#installation)
+ [Walkthrough](#walkthrough)
+ [Usage](#usage)
+ [Available validators](#supported-functions)
+ [License](#license-mit)
### Installation
`SwiftValidatorsReactiveExtensions` is available on CocoaPods for iOS 9.0+, Xcode 8 and Swift 3.0
````
pod 'SwiftValidatorsReactiveExtensions'
````
### Walkthrough
#### Usage
`SwiftValidatorsReactiveExtensions` exposes a `reactive` property in `Validator` that maps each available validator to a `ReactiveValidator`. A `ReactiveValidator` can validate a value that conforms to `StringConvertible` and the result will be `ValidatorOutput`.
`ValidationError` is an enum that conform to `Swift.Error` and provides cases for all available validators in `SwiftValidators` and a special case `.notSpecified` for when the error is not specified.
```swift
Validator.reactive
.isEmail().apply("[email protected]") // returns .valid
Validator.reactive
.isEmail().apply("abcd") // returns .invalid(.isEmail)
```
For more examples on how to call each validator you can look at the [unit tests](https://github.com/gkaimakas/SwiftValidatorsReactiveExtensions/blob/master/Example/Tests/Tests.swift).
#### Logical Operators
`ReactiveValidator` exposes the `combine` function both as a `static` function and as an `instance` function. The `combine` function is equivalent to a logical and meaning that all validators must be `.valid` for the combined validator to be `.valid`.
```swift
ReactiveValidator.combine(
Validator.reactive.isEmail(),
Validator.reactive.isLowercase()
) // variadic function
ReactiveValidator
.combine([
Validator.reactive.isEmail(),
Validator.reactive.isLowercase()
]) // array arguments
Validator.reactive
.isEmail()
.combine(with: Validator.reactive.isLowercase()) // instance function
```
#### Mapping
`SwiftValidatorsReactiveExtensions` provide a `map` function to map the result of a `ReactiveValidator` ValidatorOutput to the exact ValidatorOutput that the `ValidatingProperty` expects.
```swift
email = ValidatingProperty(nil, { (value: String?) -> ValidatorOutput in
return ReactiveValidator.combine([
Validator.reactive.required(),
Validator.reactive.minLength(5),
Validator.reactive.maxLength(32),
Validator.reactive.isEmail()
])
.apply(value)
.map() { $0 as? String }
})
```
### Available Validators
All the Validators that are available in [`SwiftValidators`](https://github.com/gkaimakas/SwiftValidators#supported-functions).
### License MIT
````
Copyright (c) George Kaimakas [email protected]
Permission is hereby granted, free of charge, to any person obtaining
acopy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
````