swi

SwiftValidators

String (and more) validation for iOS

Showing:

Popularity

Downloads/wk

0

GitHub Stars

231

Maintenance

Last Commit

10mos ago

Contributors

2

Package

Dependencies

0

License

MIT

Categories

Readme

Swift Validators 🔶

String validation for iOS.

Contents

ReactiveSwift + SwiftValidators

Want to use SwiftValidators with ReactiveSwift? SwiftValidatorsReactiveExtensions provides a set of extensions that play well with ValidatingProperty.

Installation

SwiftValidators is available on CocoaPods for iOS 9.0+, Xcode 8 and Swift 3.0

use_frameworks!

target 'MyProject' do
...
pod 'SwiftValidators'
...
end

It is also available through SPM:

import PackageDescription

let package = Package(
name: "MyProject",
targets: [],
dependencies: [
.Package(url: "https://github.com/gkaimakas/SwiftValidators.git",
majorVersion: 6)
]
)

Walkthrough

Usage

Validation is done using the apply function of a Validator. You can create a Validator manually or you can use on of the already available via static functions in the Validator class.

A Validator's apply function accepts an input as a nullable value that conforms to the StringConvertible protocol. By default String, NSString, Int, Float, Double and Bool conform to StringConvertible.

You can specify the Validator's behaviour when it's input is nil if you are using the static Validator function by setting the nilResponse parameter to either true or false. By default nilResponse is set to false.

Validator.exactLength(3).apply("abc") //returns true

Validator.exactLength(3).apply(true) //returns false (the string representation of true is 'true')

Validator.exactLength(3).apply(nil) //returns false since `nilResponse` is set to false by default

Valuidator.exactLength(3, nilResponse: true).apply(nil) //returns true since we set nilResponse to true

For more examples on how to call each validator you can look at the unit tests.

Logical Operators

You can combine operators using the logical AND, logical OR and Logical NOT operators ( &&, || and ! respectively).

let combinedANDValidator = Validator.required() && Validator.isTrue()

The combinedANDValidator will be true only when the value is not empty and "true"

let combinedORValidator = Validator.isTrue() || Validators.isFalse()

The combinedORValidator will be true if the value is "true" or "false", otherwise it will be false.

let reversedValidator = !Validator.isTrue()

The reversedValidator will be false when the value equals "true" and true for all other values.

Available Validators

NameDescriptionTypeArgumentsExample
containschecks if it is contained in the seedfuncString, Bool(nilReponse=false)Validator.contains("some seed").apply("ee")
equalschecks if it equals anotherfuncString, Bool(nilReponse=false)Validator.equals("aa").apply("aa")
exactLengthchecks if it has the exact lengthfuncInt, Bool(nilReponse=false)Validator.exactLength(2).apply("aa")
isASCIIchecks if it is valid ascii stringfuncBool(nilReponse=false)Validator.isASCII().apply("SDGSFG")
isAfterchecks if it is after the datefuncString, String, Bool(nilReponse=false)Validator.isAfter("23/07/2015", format: "dd/MM/yyyy").apply("24/07/2015")
isAlphachecks if it has only lettersfuncBool(nilReponse=false)Validator.isAlpha().apply("abc")
isAlphanumericchecks if it has letters and numbers onlyfuncBool(nilReponse=false)Validator.isAlphanumeric().apply("abc123")
isBase64checks if it a valid base64 stringfuncBool(nilReponse=false)Validator.isBase64().apply("some string")
isBeforechecks if it is before the datefuncString, String, Bool(nilReponse=false)Validator.isBefore("25/09/1987", format: "dd/MM/yyyy").apply("29/03/1994")
isBoolchecks if it is booleanfuncBool(nilReponse=false)Validator.isBool().apply("true")
isCreditCardchecks if it is a credit card numberfuncBool(nilReponse=false)Validator.isCreditCard().apply("123")
isDatechecks if it is a valid datefuncString, Bool(nilReponse=false)Validator.isDate("dd/MM/yyyy").apply("25/09/1987")
isEmailchecks if it is an emailfuncBool(nilReponse=false)Validator.isEmail().apply("gkaimakas@gmail.com")
isEmptychecks if it is an empty stringfuncBool(nilReponse=false)Validator.isEmpty().apply("")
isFQDNchecks if it is fully qualified domain namefuncFQDNOptions or empty, Bool(nilReponse=false)Validator.isFQDN().apply("ABC")
isFalsechecks if it is falsefuncBool(nilReponse=false)Validator.isFalse().apply("false")
isFloatchecks if it is a float numberfuncBool(nilReponse=false)Validator.isFloat().apply("2.3e24")
isHexColorchecks if it is a valid hex colorfuncBool(nilReponse=false)Validator.isHexColor().apply("#fafafa")
isHexadecimalchecks if it is a hexadecimal valuefuncBool(nilReponse=false)Validator.isHexadecimal().apply("abcdef")
isIPchecks if it is a valid IP (4 |6)funcBool(nilReponse=false)Validator.isIP().apply("0.0.0.0")
isIPv4checks if it is a valid IPv4funcBool(nilReponse=false)Validator.isIPv4().apply("0.0.0.0")
isIPv6checks if it is a valid IPv6funcBool(nilReponse=false)Validator.isIPv6().apply("::")
isISBNchecks if it is a valid ISBNfuncISBN, Bool(nilReponse=false)Validator.isISBN(.v13).apply("asdf")
isInchecks if the value exists in the supplied arrayfuncArray, Bool(nilReponse=false)Validator.isIn(["a","b","c"]).apply("a")
isIntchecks if it is a valid integerfuncBool(nilReponse=false)Validator.isInt().apply("123")
isLowercasechecks if it only has lowercase charactersfuncBool(nilReponse=false)Validator.isLowercase().apply("asdf")
isMongoIdchecks if it a hexadecimal mongo idfuncBool(nilReponse=false)Validator.isMongoId()("adfsdffsg")
isNumericchecks if it is numericfuncBool(nilReponse=false)Validator.isNumeric().apply("+123")
isPhonechecks if it is a valid phonefuncPhone, Bool(nilReponse=false)Validator.isPhone(.el_GR).apply("6944848966")
isPostalCodechecks it is a valid postal codefuncPostalCode, Bool(nilResponse=false)Validator.isPostalCode(.GR).apply("30 006")
isTruechecks if it is truefuncBool(nilReponse=false)Validator.isTrue().apply("true")
isURLchecks if it is a valid URLfuncBool(nilReponse=false)Validator.isURL().apply("http://www.google.com")
isUUIDchecks if it is a valid UUIDfuncBool(nilReponse=false)Validator.isUUID().apply("243-124245-2235-123")
isUppercasechecks if has only uppercase letterfuncBool(nilReponse=false)Validator.isUppercase().apply("ABC")
maxLengthchecks if the length does not exceed the max lengthfuncInt, Bool(nilReponse=false)Validator.maxLength(2).apply("ab")
minLengthchecks if the length isn't lower thanfuncInt, Bool(nilReponse=false)Validator.minLength(1).apply("213")
requiredchecks if it is not an empty stringfuncBool(nilReponse=false)Validator.required().apply("")
regexchecks that the value matches the regex from start to finishfuncString, Bool(nilReponse=false)Validator.regex(pattern).apply("abcd")

*FQDNOptions is a class that is used on isFQDN for configuration purposes. It can be instantiated like this:

FQDNOptions(requireTLD: Bool, allowUnderscores: Bool, allowTrailingDot: Bool)

License MIT

Copyright (c) George Kaimakas gkaimakas@gmail.com

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100