Merge pull request #1082 from OrkhanAlikhanov/textfield

Added ErrorTextField validation

Material.xcodeproj/project.pbxproj

@@ -180,6 +180,7 @@
 		9DF352421FED20C900B2A11B /* BaseIconLayerButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352411FED20C900B2A11B /* BaseIconLayerButton.swift */; };
 		9DF352421FED20C900B2A11B /* BaseIconLayerButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352411FED20C900B2A11B /* BaseIconLayerButton.swift */; };
 		9DF352441FED20ED00B2A11B /* RadioButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352431FED20ED00B2A11B /* RadioButton.swift */; };
 		9DF352441FED20ED00B2A11B /* RadioButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352431FED20ED00B2A11B /* RadioButton.swift */; };
 		9DF352461FED210000B2A11B /* CheckButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352451FED210000B2A11B /* CheckButton.swift */; };
 		9DF352461FED210000B2A11B /* CheckButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF352451FED210000B2A11B /* CheckButton.swift */; };
+		9DF58CEE20C098C60098968D /* ErrorTextFieldValidator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9DF58CED20C098C60098968D /* ErrorTextFieldValidator.swift */; };
 /* End PBXBuildFile section */
 /* End PBXBuildFile section */
 
 
 /* Begin PBXContainerItemProxy section */
 /* Begin PBXContainerItemProxy section */
@@ -297,6 +298,7 @@
 		9DF352411FED20C900B2A11B /* BaseIconLayerButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BaseIconLayerButton.swift; sourceTree = "<group>"; };
 		9DF352411FED20C900B2A11B /* BaseIconLayerButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BaseIconLayerButton.swift; sourceTree = "<group>"; };
 		9DF352431FED20ED00B2A11B /* RadioButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RadioButton.swift; sourceTree = "<group>"; };
 		9DF352431FED20ED00B2A11B /* RadioButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RadioButton.swift; sourceTree = "<group>"; };
 		9DF352451FED210000B2A11B /* CheckButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CheckButton.swift; sourceTree = "<group>"; };
 		9DF352451FED210000B2A11B /* CheckButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CheckButton.swift; sourceTree = "<group>"; };
+		9DF58CED20C098C60098968D /* ErrorTextFieldValidator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ErrorTextFieldValidator.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 /* End PBXFileReference section */
 
 
 /* Begin PBXGroup section */
 /* Begin PBXGroup section */
@@ -315,6 +317,7 @@
 				96BCB79E1CB40DC500C806FE /* TextView.swift */,
 				96BCB79E1CB40DC500C806FE /* TextView.swift */,
 				96BCB79C1CB40DC500C806FE /* TextField.swift */,
 				96BCB79C1CB40DC500C806FE /* TextField.swift */,
 				961F18E71CD93E3E008927C5 /* ErrorTextField.swift */,
 				961F18E71CD93E3E008927C5 /* ErrorTextField.swift */,
+				9DF58CED20C098C60098968D /* ErrorTextFieldValidator.swift */,
 			);
 			);
 			name = Text;
 			name = Text;
 			sourceTree = "<group>";
 			sourceTree = "<group>";
@@ -1005,6 +1008,7 @@
 				965E80CE1DD4C50600D61E4B /* FABButton.swift in Sources */,
 				965E80CE1DD4C50600D61E4B /* FABButton.swift in Sources */,
 				965E80CF1DD4C50600D61E4B /* FlatButton.swift in Sources */,
 				965E80CF1DD4C50600D61E4B /* FlatButton.swift in Sources */,
 				965E80D01DD4C50600D61E4B /* RaisedButton.swift in Sources */,
 				965E80D01DD4C50600D61E4B /* RaisedButton.swift in Sources */,
+				9DF58CEE20C098C60098968D /* ErrorTextFieldValidator.swift in Sources */,
 				96A183631E0C6CE200083C30 /* FABMenu.swift in Sources */,
 				96A183631E0C6CE200083C30 /* FABMenu.swift in Sources */,
 				965E80D11DD4C50600D61E4B /* IconButton.swift in Sources */,
 				965E80D11DD4C50600D61E4B /* IconButton.swift in Sources */,
 				965E80D21DD4C50600D61E4B /* Color.swift in Sources */,
 				965E80D21DD4C50600D61E4B /* Color.swift in Sources */,

Sources/iOS/ErrorTextField.swift

@@ -31,18 +31,66 @@
 import UIKit
 import UIKit
 
 
 open class ErrorTextField: TextField {
 open class ErrorTextField: TextField {
-  /// Controls the visibility of detailLabel
+  
+  /// The errorLabel UILabel that is displayed.
+  @IBInspectable
+  open let errorLabel = UILabel()
+  
+  /// The errorLabel text value.
+  @IBInspectable
+  open var error: String? {
+    get {
+      return errorLabel.text
+    }
+    set(value) {
+      errorLabel.text = value
+      layoutSubviews()
+    }
+  }
+  
+  /// Error text color
+  @IBInspectable
+  open var errorColor = Color.red.base {
+    didSet {
+      errorLabel.textColor = errorColor
+    }
+  }
+  
+  /// Vertical distance for the errorLabel from the divider.
   @IBInspectable
   @IBInspectable
-  open var isErrorRevealed = false {
+  open var errorVerticalOffset: CGFloat = 8 {
     didSet {
     didSet {
-      detailLabel.isHidden = !isErrorRevealed
       layoutSubviews()
       layoutSubviews()
     }
     }
   }
   }
   
   
+  /// Hide or show error text.
+  open var isErrorRevealed: Bool {
+    get {
+      return !errorLabel.isHidden
+    }
+    set {
+      errorLabel.isHidden = !newValue
+      detailLabel.isHidden = newValue
+    }
+  }
+  
   open override func prepare() {
   open override func prepare() {
     super.prepare()
     super.prepare()
     isErrorRevealed = false
     isErrorRevealed = false
-    detailColor = Color.red.base
+    prepareErrorLabel()
+  }
+  
+  /// Prepares the errorLabel.
+  func prepareErrorLabel() {
+    errorLabel.font = RobotoFont.regular(with: 12)
+    errorLabel.numberOfLines = 0
+    errorColor = { errorColor }() // call didSet
+    addSubview(errorLabel)
+  }
+  
+  open override func layoutSubviews() {
+    super.layoutSubviews()
+    layoutBottomLabel(label: errorLabel, verticalOffset: errorVerticalOffset)
   }
   }
 }
 }

Sources/iOS/ErrorTextFieldValidator.swift

+/*
+ * Copyright (C) 2018, Daniel Dahan and CosmicMind, Inc. <http://cosmicmind.com>.
+ * All rights reserved.
+ *
+ * Original Inspiration & Author
+ * Copyright (C) 2018 Orkhan Alikhanov <orkhan.alikhanov@gmail.com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *  *  Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ *  *  Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ *  *  Neither the name of CosmicMind nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import UIKit
+import Motion
+
+/**
+ Validator plugin for ErrorTextField and subclasses.
+ Can be accessed via `textField.validator`
+ ### Example
+ ```swift
+ field.validator
+      .notEmpty(message: "Choose username")
+      .min(length: 3, message: "Minimum 3 characters")
+      .noWhitespaces(message: "Username cannot contain spaces")
+      .username(message: "Unallowed characters in username")
+ }
+ ```
+ */
+open class ErrorTextFieldValidator {
+  /// A typealias for validation closure.
+  public typealias ValidationClosure = (_ text: String) -> Bool
+  
+  /// Validation closures and their error messages.
+  open var closures: [(code: ValidationClosure, message: String)] = []
+  
+  /// A reference to the textField.
+  open weak var textField: ErrorTextField?
+  
+  /// Behavior for auto-validation.
+  open var autoValidationType: AutoValidationType = .default
+  
+  /**
+   A flag indicating if error message is shown at least once.
+   Used for `AutoValidationType.default`.
+   */
+  open var isErrorShownOnce = false
+  
+  /**
+   Initializes validator.
+   - Parameter textField: An ErrorTextField to validate.
+   */
+  public init(textField: ErrorTextField) {
+    self.textField = textField
+    prepare()
+  }
+  
+  /**
+   Prepares the validator instance when intialized. When subclassing,
+   it is recommended to override the prepare method
+   to initialize property values and other setup operations.
+   The super.prepare method should always be called immediately
+   when subclassing.
+   */
+  open func prepare() {
+    textField?.addTarget(self, action: #selector(autoValidate), for: .editingChanged)
+  }
+  
+  /**
+   Validates textField based on `autoValidationType`.
+   This method is called when textField.text changes.
+   */
+  @objc
+  private func autoValidate() {
+    guard let textField = textField else { return }
+    
+    switch autoValidationType {
+    case .none: break
+    case .custom(let closure):
+      closure(textField)
+    case .default:
+      guard isErrorShownOnce else { return }
+      textField.isValid()
+    case .always:
+      textField.isValid()
+    }
+  }
+  
+  /**
+   Validates textField.text against criteria defined in `closures`
+   and shows relevant error message on failure.
+   - Parameter isDeferred: Defer showing error message.
+   - Returns: Boolean indicating if validation passed.
+   */
+  @discardableResult
+  open func isValid(isDeferred: Bool) -> Bool {
+    guard let textField = textField else { return false }
+    for block in closures {
+      if !block.code(textField.text ?? "") {
+        if !isDeferred {
+          textField.error = block.message
+          textField.isErrorRevealed = true
+          isErrorShownOnce = true
+        }
+        return false
+      }
+    }
+    if !isDeferred { textField.isErrorRevealed = false }
+    return true
+  }
+  
+  
+  /** Adds provided closure and its error message to the validation chain.
+   - Parameter message: A message to be shown when validation fails.
+   - Parameter code: Closure to run for validation.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  open func validate(message: String, when code: @escaping ValidationClosure) -> Self {
+    closures.append((code, message))
+    return self
+  }
+  
+  
+  /**
+   Types for determining behaviour of auto-validation
+   which is run when textField.text changes.
+   */
+  public enum AutoValidationType {
+    /// Turn off.
+    case none
+    
+    /// Run validation only if error is shown once.
+    case `default`
+    
+    /// Always run validation.
+    case always
+    
+    /**
+     Custom auto-validation logic passed as closure
+     which accepts ErrorTextField. Closure is called
+     when `textField.text` changes.
+     */
+    case custom((ErrorTextField) -> Void)
+  }
+}
+
+/// Memory key pointer for `validator`.
+private var AssociatedInstanceKey: UInt8 = 0
+extension ErrorTextField {
+  /// A reference to validator.
+  open var validator: ErrorTextFieldValidator {
+    get {
+      return AssociatedObject.get(base: self, key: &AssociatedInstanceKey) {
+        return ErrorTextFieldValidator(textField: self)
+      }
+    }
+    set(value) {
+      AssociatedObject.set(base: self, key: &AssociatedInstanceKey, value: value)
+    }
+  }
+  
+  /**
+   Validates textField.text against criteria defined in `closures`
+   and shows relevant error message on failure.
+   - Parameter isDeferred: Defer showing error message. Default is false.
+   - Returns: Boolean indicating if validation passed.
+   */
+  @discardableResult
+  open func isValid(isDeferred: Bool = false) -> Bool {
+    return validator.isValid(isDeferred: isDeferred)
+  }
+}
+
+public extension ErrorTextFieldValidator {
+  /**
+   Validate that field contains correct email address.
+   - Parameter message: A message to show for incorrect emails.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func email(message: String) -> Self {
+    return regex(message: message, pattern: "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,64}")
+  }
+  
+  /**
+   Validate that field contains allowed usernames characters.
+   - Parameter message: A message to show for disallowed usernames.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func username(message: String) -> Self {
+    return regex(message: message, pattern: "^[a-zA-Z0-9]+([_\\s\\-\\.\\']?[a-zA-Z0-9])*$")
+  }
+  
+  /**
+   Validate that field text matches provided regex pattern.
+   - Parameter message: A message to show for unmatched texts.
+   - Parameter pattern: A regex pattern to match.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func regex(message: String, pattern: String) -> Self {
+    return validate(message: message) {
+      let pred = NSPredicate(format: "SELF MATCHES %@", pattern)
+      return pred.evaluate(with: $0)
+    }
+  }
+  
+  /**
+   Validate that field text has minimum `length`.
+   - Parameter length: Minimum allowed text length.
+   - Parameter message: A message to show when requirement is not met.
+   - Parameter trimmingSet: A trimming CharacterSet for trimming text before validation.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func min(length: Int, message: String, trimmingSet: CharacterSet? = .whitespacesAndNewlines) -> Self {
+    let trimmingSet = trimmingSet ?? .init()
+    return validate(message: message) {
+      $0.trimmingCharacters(in: trimmingSet).count >= length
+    }
+  }
+  
+  /**
+   Validate that field text has maximum `length`.
+   - Parameter length: Minimum allowed text length.
+   - Parameter message: A message to show when requirement is not met.
+   - Parameter trimmingSet: A trimming CharacterSet for trimming text before validation.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func max(length: Int, message: String, trimmingSet: CharacterSet? = .whitespacesAndNewlines) -> Self {
+    let trimmingSet = trimmingSet ?? .init()
+    return validate(message: message) {
+      $0.trimmingCharacters(in: trimmingSet).count <= length
+    }
+  }
+  
+  /**
+   Validate that field text is not empty.
+   - Parameter message: A message to show when requirement is not met.
+   - Parameter trimmingSet: A trimming CharacterSet for trimming text before validation.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func notEmpty(message: String, trimmingSet: CharacterSet? = .whitespacesAndNewlines) -> Self {
+    let trimmingSet = trimmingSet ?? .init()
+    return validate(message: message) {
+      $0.trimmingCharacters(in: trimmingSet).isEmpty == false
+    }
+  }
+  
+  
+  /**
+   Validate that field text contains no whitespaces.
+   - Parameter message: A message to show when requirement is not met.
+   - Parameter trimmingSet: A trimming CharacterSet for trimming text before validation.
+   - Returns: Validator itself to allow chaining.
+   */
+  @discardableResult
+  func noWhitespaces(message: String) -> Self {
+    return validate(message: message) {
+      $0.rangeOfCharacter(from: .whitespaces) == nil
+    }
+  }
+}

Sources/iOS/TextField.swift

@@ -268,7 +268,7 @@ open class TextField: UITextField {
   @IBInspectable
   @IBInspectable
   open var detailVerticalOffset: CGFloat = 8 {
   open var detailVerticalOffset: CGFloat = 8 {
     didSet {
     didSet {
-      layoutDetailLabel()
+      layoutSubviews()
     }
     }
   }
   }
   
   
@@ -407,7 +407,7 @@ open class TextField: UITextField {
     super.layoutSubviews()
     super.layoutSubviews()
     layoutShape()
     layoutShape()
     layoutPlaceholderLabel()
     layoutPlaceholderLabel()
-    layoutDetailLabel()
+    layoutBottomLabel(label: detailLabel, verticalOffset: detailVerticalOffset)
     layoutButton(button: clearIconButton)
     layoutButton(button: clearIconButton)
     layoutButton(button: visibilityIconButton)
     layoutButton(button: visibilityIconButton)
     layoutDivider()
     layoutDivider()
@@ -568,16 +568,7 @@ fileprivate extension TextField {
     
     
     placeholderLabel.frame.origin.y = -placeholderLabel.bounds.height + placeholderVerticalOffset
     placeholderLabel.frame.origin.y = -placeholderLabel.bounds.height + placeholderVerticalOffset
   }
   }
-  
-  /// Layout the detailLabel.
-  func layoutDetailLabel() {
-    let c = dividerContentEdgeInsets
-    detailLabel.frame.size.height = detailLabel.sizeThatFits(CGSize(width: bounds.width, height: .greatestFiniteMagnitude)).height
-    detailLabel.frame.origin.x = c.left
-    detailLabel.frame.origin.y = bounds.height + detailVerticalOffset
-    detailLabel.frame.size.width = bounds.width - c.left - c.right
-  }
-  
+
   /// Layout the a button.
   /// Layout the a button.
   func layoutButton(button: UIButton?) {
   func layoutButton(button: UIButton?) {
     button?.frame = CGRect(x: bounds.width - bounds.height, y: 0, width: bounds.height, height: bounds.height)
     button?.frame = CGRect(x: bounds.width - bounds.height, y: 0, width: bounds.height, height: bounds.height)
@@ -595,6 +586,17 @@ fileprivate extension TextField {
   }
   }
 }
 }
 
 
+internal extension TextField {
+  /// Layout given label at the bottom with the vertical offset provided.
+  func layoutBottomLabel(label: UILabel, verticalOffset: CGFloat) {
+    let c = dividerContentEdgeInsets
+    label.frame.origin.x = c.left
+    label.frame.origin.y = bounds.height + verticalOffset
+    label.frame.size.width = bounds.width - c.left - c.right
+    label.frame.size.height = label.sizeThatFits(CGSize(width: label.bounds.width, height: .greatestFiniteMagnitude)).height
+  }
+}
+
 fileprivate extension TextField {
 fileprivate extension TextField {
   /// Handles the text editing did begin state.
   /// Handles the text editing did begin state.
   @objc
   @objc