diff --git a/SwiftValidator/Core/ValidationDelegate.swift b/SwiftValidator/Core/ValidationDelegate.swift index 7e70372..b43ed95 100644 --- a/SwiftValidator/Core/ValidationDelegate.swift +++ b/SwiftValidator/Core/ValidationDelegate.swift @@ -14,11 +14,13 @@ import UIKit @objc public protocol ValidationDelegate { /** This method will be called on delegate object when validation is successful. + - returns: No return value. */ func validationSuccessful() /** This method will be called on delegate object when validation fails. + - returns: No return value. */ func validationFailed(errors: [UITextField:ValidationError]) diff --git a/SwiftValidator/Core/ValidationError.swift b/SwiftValidator/Core/ValidationError.swift index f962c95..d01ef51 100644 --- a/SwiftValidator/Core/ValidationError.swift +++ b/SwiftValidator/Core/ValidationError.swift @@ -19,6 +19,7 @@ public class ValidationError: NSObject { /** Initializes `ValidationError` object with a textField and error. + - parameter textField: UITextField that holds textField. - parameter errorMessage: String that holds error message. - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. @@ -29,7 +30,8 @@ public class ValidationError: NSObject { } /** - Initializes ValidationError object with a textField, errorLabel, and errorMessage. + Initializes `ValidationError` object with a textField, errorLabel, and errorMessage. + - parameter textField: UITextField that holds textField. - parameter errorLabel: UILabel that holds error label. - parameter errorMessage: String that holds error message. diff --git a/SwiftValidator/Core/Validator.swift b/SwiftValidator/Core/Validator.swift index a600b2d..d095628 100644 --- a/SwiftValidator/Core/Validator.swift +++ b/SwiftValidator/Core/Validator.swift @@ -29,6 +29,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. + - returns: No return value. */ private func validateAllFields() { @@ -58,6 +59,7 @@ public class Validator { /** This method is used to validate a single field registered to Validator. If validation is unsuccessful, field gets added to errors dictionary. + - parameter textField: Holds validator field data. - returns: No return value. */ @@ -149,7 +151,6 @@ public class Validator { This method validates all fields in validator and sets any errors to errors parameter of callback. - 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 { diff --git a/SwiftValidator/Rules/AlphaNumericRule.swift b/SwiftValidator/Rules/AlphaNumericRule.swift index 6a7f202..d21dfe8 100644 --- a/SwiftValidator/Rules/AlphaNumericRule.swift +++ b/SwiftValidator/Rules/AlphaNumericRule.swift @@ -8,7 +8,18 @@ import Foundation +/** + `AlphaNumericRule` is a subclass of `CharacterSetRule`. It is used to verify that a field has a + valid list of alphanumeric characters. + */ public class AlphaNumericRule: CharacterSetRule { + + /** + Initializes a `AlphaNumericRule` object to verify that field has valid set of alphanumeric characters. + + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. + */ public init(message: String = "Enter valid numeric characters") { super.init(characterSet: NSCharacterSet.alphanumericCharacterSet(), message: message) } diff --git a/SwiftValidator/Rules/AlphaRule.swift b/SwiftValidator/Rules/AlphaRule.swift index 8c31a82..963ea8c 100644 --- a/SwiftValidator/Rules/AlphaRule.swift +++ b/SwiftValidator/Rules/AlphaRule.swift @@ -8,7 +8,18 @@ import Foundation +/** + `AlphaRule` is a subclass of `CharacterSetRule`. It is used to verify that a field has a + valid list of alpha characters. + */ public class AlphaRule: CharacterSetRule { + + /** + Initializes an `AlphaRule` object to verify that a field has valid set of alpha characters. + + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason. + */ public init(message: String = "Enter valid alphabetic characters") { super.init(characterSet: NSCharacterSet.letterCharacterSet(), message: message) } diff --git a/SwiftValidator/Rules/CharacterSetRule.swift b/SwiftValidator/Rules/CharacterSetRule.swift index f29aaec..36875ca 100644 --- a/SwiftValidator/Rules/CharacterSetRule.swift +++ b/SwiftValidator/Rules/CharacterSetRule.swift @@ -8,16 +8,33 @@ import Foundation +/** + `CharacterSetRule` is a subclass of `Rule`. It is used to validate IPV4 address fields. + */ public class CharacterSetRule: Rule { - + /// NSCharacter that hold set of valid characters to hold private let characterSet: NSCharacterSet + /// String that holds error message private var message: String + /** + Initializes a `CharacterSetRule` object to verify that field has valid set of characters. + + - parameter characterSet: NSCharacterSet that holds group of valid characters. + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. + */ public init(characterSet: NSCharacterSet, message: String = "Enter valid alpha") { self.characterSet = characterSet self.message = message } + /** + Used to validate field. + + - parameter value: String to checked for validation. + - returns: Boolean value. True if validation is successful; False if validation fails. + */ public func validate(value: String) -> Bool { for uni in value.unicodeScalars { if !characterSet.longCharacterIsMember(uni.value) { @@ -27,6 +44,11 @@ public class CharacterSetRule: Rule { return true } + /** + Displays error message when text field fails validation. + + - returns: String of error message. + */ public func errorMessage() -> String { return message } diff --git a/SwiftValidator/Rules/HexColorRule.swift b/SwiftValidator/Rules/HexColorRule.swift index 1464984..10c5fa7 100644 --- a/SwiftValidator/Rules/HexColorRule.swift +++ b/SwiftValidator/Rules/HexColorRule.swift @@ -8,9 +8,19 @@ import Foundation +/** + `HexColorRule` is a subclass of `RegexRule`. It is used to verify whether a field is a hexadecimal color. + */ public class HexColorRule: RegexRule { + /// Regular expression string that is used to verify hexadecimal static let regex = "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" + /** + Initializes a `HexaColorRule` object to verify that field has text in hexadecimal color format. + + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. + */ public init(message: String = "Invalid regular expression") { super.init(regex: HexColorRule.regex, message: message) } diff --git a/SwiftValidator/Rules/IPV4Rule.swift b/SwiftValidator/Rules/IPV4Rule.swift index 44df5eb..5c024bd 100644 --- a/SwiftValidator/Rules/IPV4Rule.swift +++ b/SwiftValidator/Rules/IPV4Rule.swift @@ -8,10 +8,19 @@ import Foundation +/** + `IPV4Rule` is a subclass of RegexRule that defines how a IPV4 address validated. + */ public class IPV4Rule: RegexRule { - + /// Regular expression string that is used to verify IPV4 address. static let regex = "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" - + + /** + Initializes a `IPV4Rule` object to verify that field has text is an IPV4Rule address. + + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. + */ public init(message: String = "Must be a valid IPV4 address") { super.init(regex: IPV4Rule.regex, message: message) } diff --git a/SwiftValidator/Rules/ISBNRule.swift b/SwiftValidator/Rules/ISBNRule.swift index 9ea8cfb..493ab01 100644 --- a/SwiftValidator/Rules/ISBNRule.swift +++ b/SwiftValidator/Rules/ISBNRule.swift @@ -8,14 +8,30 @@ import Foundation +/** + `ISBNRule` is a subclass of `Rule`. It is used to verify whether a field is a valid ISBN number. + */ public class ISBNRule: Rule { + /// String that holds error message private let message: String + /** + Initializes a `ISBNRule` object to verify that field has text that is a ISBN number. + + - parameter message: String of error message. + - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. + */ public init(message: String = "Enter valid ISBN number") { self.message = message } + /** + Method used to validate text field. + + - parameter value: String to checked for validation. + - returns: Boolean value. True if validation is successful; False if validation fails. + */ public func validate(value: String) -> Bool { guard let regex = try? NSRegularExpression(pattern: "[\\s-]", options: []) else { @@ -27,25 +43,75 @@ public class ISBNRule: Rule { return ISBN10Validator().verify(sanitized) || ISBN13Validator().verify(sanitized) } + /** + Method used to dispaly error message when text field fails validation. + + - returns: String of error message. + */ public func errorMessage() -> String { return message; } } +/** + `ISBNValidator` defines the protocol that objects adopting it must implement. +*/ private protocol ISBNValidator { + /// Regular expression string var regex: String { get } + /** + Method that actually verifies a ISBN number. + + - parameter input: String that is to be validated against `ISBNRule` + - returns: A `Bool` that represents what happened during verification. `false` is returned if + it fails, `true` is returned if it was a success. + */ func verify(input: String) -> Bool + /** + Method that verifies regular expression is valid. + + - parameter input: String that holds ISBN number being validated. + - returns: A `Bool` that represents the status of the ISBN number. `false` if ISBN number + was not valid, `true` if it was valid. + */ func checkRegex(input: String) -> Bool + + /** + Method that verifies `ISBN` being validated is itself valid. It has to be either ISBN10 + or ISBN13. + + - parameter input: String that holds ISBN number being validated. + - returns: A `Bool` that represents the status of the ISBN number. `false` if ISBN number + was not valid, `true` if it was valid. + */ func verifyChecksum(input: String) -> Bool } +/** + `ISBNValidator` defines the extensions that are added to `ISBNValidator`. + */ extension ISBNValidator { + /** + Method that actually verifies a ISBN number. + + - parameter input: String that is to be validated against `ISBNRule` + - returns: A `Bool` that represents what happened during verification. `false` is returned if + it fails, `true` is returned if it was a success. + */ func verify(input: String) -> Bool { return checkRegex(input) && verifyChecksum(input) } + /** + Method that verifies `ISBN` being validated is itself valid. It has to be either ISBN10 + or ISBN13. + + - parameter input: String that holds ISBN number being validated. + - returns: A `Bool` that represents the status of the ISBN number. `false` if ISBN number + was not valid, `true` if it was valid. + */ func checkRegex(input: String) -> Bool { guard let _ = input.rangeOfString(regex, options: [.RegularExpressionSearch, .AnchoredSearch]) else { return false @@ -55,9 +121,21 @@ extension ISBNValidator { } } +/** + `ISBN10Validator` is a struct that adopts the `ISBNValidator` protocol. Used to validate that + a field is an ISBN10 number. +*/ private struct ISBN10Validator: ISBNValidator { + /// Regular expression used to validate ISBN10 number let regex = "^(?:[0-9]{9}X|[0-9]{10})$" + + /** + Checks that a string is an ISBN10 number. + + - parameter input: String that is checked for ISBN10 validation. + - returns: `true` if string is a valid ISBN10 and `false` if it is not. + */ private func verifyChecksum(input: String) -> Bool { var checksum = 0 @@ -79,9 +157,20 @@ private struct ISBN10Validator: ISBNValidator { } } +/** + `ISBN13Validator` is a struct that adopts the `ISBNValidator` protocol. Used to validate that + a field is an ISBN13 number. +*/ private struct ISBN13Validator: ISBNValidator { + /// Regular expression used to validate ISBN13 number. let regex = "^(?:[0-9]{13})$" + /** + Checks that a string is an ISBN13 number. + + - parameter input: String that is checked for ISBN13 validation. + - returns: `true` if string is a valid ISBN13 and `false` if it is not. + */ private func verifyChecksum(input: String) -> Bool { let factor = [1, 3] var checksum = 0 diff --git a/SwiftValidator/Rules/MaxLengthRule.swift b/SwiftValidator/Rules/MaxLengthRule.swift index 4bec299..e01e6cd 100644 --- a/SwiftValidator/Rules/MaxLengthRule.swift +++ b/SwiftValidator/Rules/MaxLengthRule.swift @@ -19,7 +19,8 @@ public class MaxLengthRule: Rule { public init(){} /** - Initializes a `MaxLengthRule` object that is to validate the length of the text of a text field + Initializes a `MaxLengthRule` object that is to validate the length of the text of a text field. + - parameter length: Maximum character length. - parameter message: String of error message. - returns: An initialized object, or nil if an object could not be created for some reason that would not result in an exception. diff --git a/SwiftValidator/Rules/MinLengthRule.swift b/SwiftValidator/Rules/MinLengthRule.swift index 2f63ab0..8b03241 100644 --- a/SwiftValidator/Rules/MinLengthRule.swift +++ b/SwiftValidator/Rules/MinLengthRule.swift @@ -21,7 +21,8 @@ public class MinLengthRule: Rule { public init(){} /** - Initializes a `MaxLengthRule` object that is to validate the length of the text of a text field + Initializes a `MaxLengthRule` object that is to validate the length of the text of a text field. + - parameter length: Minimum character length. - parameter message: String of error message. - returns: An initialized `MinLengthRule` object, or nil if an object could not be created for some reason that would not result in an exception. diff --git a/SwiftValidator/Rules/PhoneNumberRule.swift b/SwiftValidator/Rules/PhoneNumberRule.swift index fc26ef0..e8dd546 100644 --- a/SwiftValidator/Rules/PhoneNumberRule.swift +++ b/SwiftValidator/Rules/PhoneNumberRule.swift @@ -17,7 +17,8 @@ public class PhoneNumberRule: RegexRule { static let regex = "^\\d{10}$" /** - Method used to initialize `PhoneNumberRule` object. + Initializes a `PhoneNumberRule` object. Used to validate that a field has a valid phone number. + - parameter message: Error message that is displayed if validation fails. - returns: An initialized `PasswordRule` object, or nil if an object could not be created for some reason that would not result in an exception. */ diff --git a/SwiftValidator/Rules/RequiredRule.swift b/SwiftValidator/Rules/RequiredRule.swift index 1a25b43..cb71889 100644 --- a/SwiftValidator/Rules/RequiredRule.swift +++ b/SwiftValidator/Rules/RequiredRule.swift @@ -16,6 +16,8 @@ public class RequiredRule: Rule { private var message : String /** + Initializes `RequiredRule` object with error message. Used to validate a field that requires text. + - parameter message: String of error message. - returns: An initialized `RequiredRule` object, or nil if an object could not be created for some reason that would not result in an exception. */ diff --git a/docs/Classes.html b/docs/Classes.html index 57ca096..8b7f89c 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -29,6 +29,15 @@
  • Classes +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    + diff --git a/docs/Classes/AlphaRule.html b/docs/Classes/AlphaRule.html new file mode 100644 index 0000000..71f1d81 --- /dev/null +++ b/docs/Classes/AlphaRule.html @@ -0,0 +1,192 @@ + + + + AlphaRule Class Reference + + + + + + + + + + +
    +
    +

    SwiftValidator Docs (100% documented)

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    AlphaRule

    +
    +
    + 
    public class AlphaRule: CharacterSetRule
    + +
    +
    +

    AlphaRule is a subclass of CharacterSetRule. It is used to verify that a field has a +valid list of alpha characters.

    + +
    +
    +
    +
      +
    • +
      + + + + init(message:) + +
      +
      +
      +
      +
      +
      +

      Initializes an AlphaRule object to verify that a field has valid set of alpha characters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(message: String = "Enter valid alphabetic characters")
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + message + + +
      +

      String of error message.

      + +
      +
      +
      +
      +

      Return Value

      +

      An initialized object, or nil if an object could not be created for some reason.

      + +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Classes/CharacterSetRule.html b/docs/Classes/CharacterSetRule.html new file mode 100644 index 0000000..c472ede --- /dev/null +++ b/docs/Classes/CharacterSetRule.html @@ -0,0 +1,288 @@ + + + + CharacterSetRule Class Reference + + + + + + + + + + +
    +
    +

    SwiftValidator Docs (100% documented)

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    CharacterSetRule

    +
    +
    + 
    public class CharacterSetRule: Rule
    + +
    +
    +

    CharacterSetRule is a subclass of Rule. It is used to validate IPV4 address fields.

    + +
    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Initializes a CharacterSetRule object to verify that field has valid set of characters.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public init(characterSet: NSCharacterSet, message: String = "Enter valid alpha")
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + characterSet + + +
      +

      NSCharacterSet that holds group of valid characters.

      + +
      +
      + + message + + +
      +

      String of error message.

      + +
      +
      +
      +
      +

      Return Value

      +

      An initialized object, or nil if an object could not be created for some reason that would not result in an exception.

      + +
      +
      +
      +
      • +
    • +
      + + + + validate(_:) + +
      +
      +
      +
      +
      +
      +

      Used to validate field.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func validate(value: String) -> Bool
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + value + + +
      +

      String to checked for validation.

      + +
      +
      +
      +
      +

      Return Value

      +

      Boolean value. True if validation is successful; False if validation fails.

      + +
      +
      +
      +
      • +
    • +
      + + + + errorMessage() + +
      +
      +
      +
      +
      +
      +

      Displays error message when text field fails validation.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func errorMessage() -> String
      + +
      +
      +
      +

      Return Value

      +

      String of error message.

      + +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Classes/ConfirmationRule.html b/docs/Classes/ConfirmationRule.html index 9bc59da..265e6c1 100644 --- a/docs/Classes/ConfirmationRule.html +++ b/docs/Classes/ConfirmationRule.html @@ -30,6 +30,15 @@
  • Classes