diff --git a/README.md b/README.md index d86f007..c4525a1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,4 @@ SwiftValidator -=============== - -[![Build Status](https://travis-ci.org/jpotts18/SwiftValidator.svg?branch=travis-ci)](https://travis-ci.org/jpotts18/SwiftValidator) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) -[![Coverage Status](https://coveralls.io/repos/github/davepatterson/SwiftValidator/badge.svg?branch=master)](https://coveralls.io/github/davepatterson/SwiftValidator?branch=travis-edit) - ======= [![Build Status](https://travis-ci.org/jpotts18/SwiftValidator.svg?branch=travis-ci)](https://travis-ci.org/jpotts18/SwiftValidator) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![codecov.io](https://codecov.io/github/jpotts18/SwiftValidator/coverage.svg?branch=master)](https://codecov.io/github/jpotts18/SwiftValidator?branch=master) diff --git a/SwiftValidator/Core/Validator.swift b/SwiftValidator/Core/Validator.swift index 7b4123a..afc7895 100644 --- a/SwiftValidator/Core/Validator.swift +++ b/SwiftValidator/Core/Validator.swift @@ -11,7 +11,7 @@ import UIKit /** Class that makes `Validator` objects. Should be added as a parameter to ViewController that will display validation fields. - */ +*/ public class Validator { /// Dictionary to hold all fields (and accompanying rules) that will undergo validation. public var validations = [UITextField:ValidationRule]() @@ -54,6 +54,7 @@ public class Validator { } } } + /** This method is used to validate all fields registered to Validator. If validation is unsuccessful, field gets added to errors dictionary. Completion closure is used to validator know when all fields @@ -83,6 +84,7 @@ public class Validator { } } } + /** This method is used to validate a field that will need to also be validated via remote request. - parameter textField: TextField of field that is being validated. @@ -92,12 +94,10 @@ public class Validator { */ private func validateRemoteField(textField: UITextField, completion: (status: Bool) -> Void) { if let fieldRule = validations[textField] { - // Carry on with validation as remote validation passed + // Carry on with validation as regular validation passed if self.validateRegularField(fieldRule.textField) { delegate!.remoteValidationRequest!(textField.text!, urlString: fieldRule.remoteInfo!.urlString, completion: { result -> Void in if result { - // Carry on with validation as remote validation passed - //self.validateRegularField(fieldRule.textField) if let transform = self.successStyleTransform { transform(validationRule: fieldRule) } @@ -110,21 +110,23 @@ public class Validator { transform(validationError: error) } } + // Validation is over, so let validateAllFields(completion: (status: Bool)) know completion(status: true) }) } else { - // Fail validation + // Validation is over, so let validateAllFields(completion: (status: Bool)) know completion(status: true) } } } + /** Method used to validate a regular field (non-remote). - parameter: TextField of field that is undergoing validation - returns: A Bool that represents whether the validation was a success or failure, returns true for the former and false for the latter. - */ + */ private func validateRegularField(textField: UITextField) -> Bool { if let fieldRule = validations[textField] { if let error = fieldRule.validateField() { @@ -192,7 +194,7 @@ public class Validator { - parameter textField: field that is to be validated. - parameter Rule: An array which holds different rules to validate against textField. - returns: No return value - */ + */ public func registerField(textField:UITextField, rules:[Rule], remoteInfo: (String, String)? = nil) { validations[textField] = ValidationRule(textField: textField, rules: rules, errorLabel: nil, remoteInfo: remoteInfo) } @@ -204,8 +206,7 @@ public class Validator { - parameter errorLabel: A UILabel that holds error label data - parameter rules: A Rule array that holds different rules that apply to said textField. - returns: No return value - */ - + */ public func registerField(textField:UITextField, errorLabel:UILabel, rules:[Rule], remoteInfo: (String, String)? = nil) { validations[textField] = ValidationRule(textField: textField, rules:rules, errorLabel:errorLabel, remoteInfo: remoteInfo) } @@ -215,7 +216,7 @@ public class Validator { - parameter textField: field used to locate and remove textField from validator. - returns: No return value - */ + */ public func unregisterField(textField:UITextField) { validations.removeValueForKey(textField) errors.removeValueForKey(textField) @@ -225,7 +226,7 @@ public class Validator { This method checks to see if all fields in validator are valid. - returns: No return value. - */ + */ public func validate(delegate:ValidationDelegate) { self.validateAllFields() @@ -238,6 +239,10 @@ public class Validator { } + /** + This method attempts to validate all fields registered to Validator(). + - returns: No return value. + */ public func validate() { self.validateAllFields { finished -> Void in if self.errors.isEmpty { @@ -253,12 +258,12 @@ public class Validator { } /** - This method validates all fields in validator and sets any errors to errors parameter of callback. + This method validates all fields in validator and sets any errors to errors parameter of closure. - parameter callback: A closure which is called with errors, a dictionary of type UITextField:ValidationError. - returns: No return value. - */ + */ public func validate(callback:(errors:[UITextField:ValidationError])->Void) -> Void { self.validateAllFields() diff --git a/Validator/ViewController.swift b/Validator/ViewController.swift index c2d22ca..697ec73 100644 --- a/Validator/ViewController.swift +++ b/Validator/ViewController.swift @@ -50,8 +50,7 @@ class ViewController: UIViewController , ValidationDelegate, UITextFieldDelegate }) validator.registerField(fullNameTextField, errorLabel: fullNameErrorLabel , rules: [RequiredRule(), FullNameRule()]) - //validator.registerField(emailTextField, errorLabel: emailErrorLabel, rules: [RequiredRule(), EmailRule()], remoteURLString: "www.yourdomain.com/path/to/emails/") - validator.registerField(emailTextField, errorLabel: emailErrorLabel, rules: [RequiredRule(), EmailRule()], remoteInfo: (urlString: "http://localhost:8000/", error: "Email already taken")) + validator.registerField(emailTextField, errorLabel: emailErrorLabel, rules: [RequiredRule(), EmailRule()], remoteInfo: (urlString: "http://localhost:8000/emails/", error: "Email already in use")) validator.registerField(emailConfirmTextField, errorLabel: emailConfirmErrorLabel, rules: [RequiredRule(), ConfirmationRule(confirmField: emailTextField)]) validator.registerField(phoneNumberTextField, errorLabel: phoneNumberErrorLabel, rules: [RequiredRule(), MinLengthRule(length: 9)]) validator.registerField(zipcodeTextField, errorLabel: zipcodeErrorLabel, rules: [RequiredRule(), ZipCodeRule()]) @@ -64,6 +63,7 @@ class ViewController: UIViewController , ValidationDelegate, UITextFieldDelegate } func simulateRemoteRequest(seconds: Int64, completion: (result: Bool) -> Void) { + print("Simulating \(seconds) second server request...") // Set number of seconds before "request" is finished let triggerTime = (Int64(NSEC_PER_SEC) * seconds) dispatch_after(dispatch_time(DISPATCH_TIME_NOW, triggerTime), dispatch_get_main_queue(), { () -> Void in @@ -76,6 +76,10 @@ class ViewController: UIViewController , ValidationDelegate, UITextFieldDelegate } }) } + + func hideKeyboard(){ + self.view.endEditing(true) + } // MARK: ValidationDelegate Methods @@ -87,22 +91,19 @@ class ViewController: UIViewController , ValidationDelegate, UITextFieldDelegate self.presentViewController(alert, animated: true, completion: nil) } + func validationFailed(errors:[UITextField:ValidationError]) { print("Validation FAILED!") } func remoteValidationRequest(text: String, urlString: String, completion: (result: Bool) -> Void) { - simulateRemoteRequest(5) { result -> Void in + simulateRemoteRequest(2) { result -> Void in // Set result to true if field was validated server-side // Set to false if field was not validated server-side completion(result: result) } } - func hideKeyboard(){ - self.view.endEditing(true) - } - // MARK: Validate single field // Don't forget to use UITextFieldDelegate func textFieldShouldReturn(textField: UITextField) -> Bool {