Skip to content

funky-monkey/Valide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Valide

Version License Platform

Installation

Valide is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Valide"

Usage

From your ViewController set up everything first. Start with the validation names for the fields.

struct ValidationNames {
    static let nameField: String = "nameField"
    static let emailField: String = "emailField"
    static let nonEmptyField: String = "nonEmptyField"
}

Set up the rules you need. (You can create your own rules as well). Fields can have multiple rules to adhere to.

let requiredRule = RequiredRule()
let emailRule = EmailRule()
let emptyFieldRule = NonEmptyFieldRule()
    
let minCharsRule = MinCharsRule()
minCharsRule.minChars = 3
    
let maxCharsRule = MaxCharsRule()
maxCharsRule.maxChars = 50

Set validation name to field and add rules:

self.name.validationName = ValidationNames.nameField
self.name.addRule(requiredRule)
self.name.addRule(minCharsRule)
self.name.addRule(maxCharsRule)

self.emailField.validationName = ValidationNames.emailField
self.emailField.addRule(requiredRule)
self.emailField.addRule(emailRule)

self.nonEmptyField.validationName = ValidationNames.nonEmptyField
self.nonEmptyField.addRule(emptyFieldRule)
self.nonEmptyField.addRule(requiredRule)

When handling validation, usually by pressing a button, call the validate() method. This returns a closure with a success and error.

Upon receiving an error, the name of the field is returned as well as the error defined in the *Rule file. These can also be customised to your liking.

self.name.validate({
        print("namefield validates")
    }, error: { (validationName, error) -> () in
        print("\(validationName) handle: \(error)")
})
    
self.emailField.validate({
        print("emailField validates")
    }, error: { (validationName, error) -> () in
        print("\(validationName) handle: \(error)")
})
    
self.nonEmptyField.validate({
        print("nonEmptyField validates")
    }, error: { (validationName, error) -> () in
        print("\(validationName) handle: \(error)")
})

For now; start with validating of the last element in your UI. So the last validation you code, is the first element on screen. I have not found a better way to do this. (If you do - please let me know)

You can then check the .isValid() on the field you are validating. This returns a tuple with three properties.

func isValid() -> (isValid:Bool, validationName: String, error: String?)

So then you can check self.nonEmptyField.isValid().isValid property.

if self.nonEmptyField.isValid().isValid {
	print("Field validates!")
	// Do something...
}

Author

Sidney de Koning, sidney.dekoning@gmail.com

License

Valide is available under the MIT license. See the LICENSE file for more info.

About

Something that helps you with the validity of the content of UITextField's by adding rules to them.

Resources

License

Stars

Watchers

Forks

Packages

No packages published