Fix formatting behavior (#7)

* fix readme; cleanup

* improve formatting

* minor formatting fixes. cleaup examples

* bump version

* fix center alignment for phone textfield

* fixes text and placeholder positions

* cleanup

---------

Co-authored-by: Igor Vedeneev <[email protected]>

Author: ivedeneev

AGInputControls.podspec

@@ -1,22 +1,14 @@
-#
-# Be sure to run `pod lib lint IVCollectionKit.podspec' to ensure this is a
-# valid spec before submitting.
-#
-# Any lines starting with a # are optional, but their use is encouraged
-# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html
-#
-
 Pod::Spec.new do |s|
   s.name             = 'AGInputControls'
-  s.version          = '1.1.2'
+  s.version          = '1.1.3'
   s.summary          = 'Commonly used text input controls'
   s.description      = <<-DESC
 TODO: Add long description of the pod here.
                        DESC
 
   s.homepage         = 'https://github.com/ivedeneev/AGInputControls.git'
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
-  s.author           = { 'ivedeneev' => '[email protected]' }
+  s.author           = { 'ivedeneev' => '[email protected]' }
   s.source           = { :git => 'https://github.com/ivedeneev/AGInputControls.git', :tag => s.version.to_s }
 
   s.ios.deployment_target = '9.0'

AGInputControls/Source/FormattingTextField+Extension.swift

@@ -10,7 +10,8 @@ import UIKit
 extension FormattingTextField {
 
     internal func setCursorPosition(offset: Int) {
-        guard let newPosition = position(from: beginningOfDocument, in: .right, offset: offset) else {return }
+        let fixedOffset = max(offset, prefix.count)
+        guard let newPosition = position(from: beginningOfDocument, in: .right, offset: fixedOffset) else {return }
         selectedTextRange = textRange(from: newPosition, to: newPosition)
     }
 
@@ -27,16 +28,11 @@ extension FormattingTextField {
     }
 
     internal func sizeOfText(_ text: String) -> CGSize {
+        guard let font else { return .zero }
         return (text as NSString).boundingRect(
             with: UIScreen.main.bounds.size,
             options: [.usesFontLeading, .usesLineFragmentOrigin],
             attributes: [.font : font],
             context: nil).size
     }
-    
-    internal func assertForExampleMasksAndPrefix() {
-        guard let mask = exampleMask, !mask.isEmpty, let formattingMask = formattingMask, formatter != nil else { return }
-        assert(mask == formattedText(text: mask) && mask.count == formattingMask.count, "Formatting mask and example mask should be in same format. This is your responsibility as a developer\nExampleMask: \(mask)\nFormatting mask: \(formattingMask)")
-        assert(prefix.first(where: { $0.isLetter || $0.isNumber }) == nil || hasConstantPrefix, "You cannot have 'semi constant' prefixes at this point ")
-    }
 }

AGInputControls/Source/FormattingTextField.swift

@@ -30,6 +30,24 @@ open class FormattingTextField: UITextField {
         }
     }
 
+    open override var text: String? {
+        get {
+            super.text
+        }
+        
+        set {
+            let formatted = formattedText(text: newValue)
+            let pos = currentPosition()
+            super.text = formatted
+            notifyDelegate(text: text)
+            setCaretPositionAfterSettingText(
+                currentPosition: pos,
+                rawText: newValue,
+                formattedText: formatted
+            )
+        }
+    }
+    
     /// Formatter object in case you need your own formatting logic
     open var formatter: AGFormatter? { didSet { invalidateIntrinsicContentSize() } }
 
@@ -57,25 +75,27 @@ open class FormattingTextField: UITextField {
 
     //MARK: Overriden properties
     open override var intrinsicContentSize: CGSize {
-        guard let exampleMask = formattingMask ??
-              formattingMask?.replacingOccurrences(of: "#", with: "0"),
-              !exampleMask.isEmpty // in case of monospaced digit fonts calculatiing width againts only digit text produces more accurate results
+        guard let exampleMask = formattingMask?
+            .replacingOccurrences(of: "#", with: "0")
+            .replacingUnderscoresWithZeros(),
+            !exampleMask.isEmpty // in case of monospaced digit fonts calculatiing width againts only digit text produces more accurate results
         else {
             return super.intrinsicContentSize
         }
 
-        let font_ = font ?? UIFont.systemFont(ofSize: 17)
+        let font_ = font ?? UIFont.preferredFont(forTextStyle: .body)
         let height = font_.lineHeight
         let width = sizeOfText(exampleMask).width
 
         let caretWidth: CGFloat = caretRect(for: endOfDocument).width
+        let padding: CGFloat = 0
 
-        return CGSize(width: width + caretWidth, height: height)
+        return CGSize(width: width + caretWidth + padding * 2, height: height)
     }
 
     open override var font: UIFont? {
         didSet {
-            minimumFontSize = font?.pointSize ?? 17
+            minimumFontSize = font?.pointSize ?? UIFont.systemFontSize
             invalidateIntrinsicContentSize()
         }
     }
@@ -97,20 +117,7 @@ open class FormattingTextField: UITextField {
     }
 
     @objc internal func didChangeEditing() {
-        var pos = currentPosition()
-        let textCount = text?.count ?? 0
-        
-        let formatted = formattedText(text: text)
-        self.text = formatted
-        notifyDelegate(text: self.text)
-        guard let last = text?.prefix(pos).last else { return }
-        
-        if !last.isNumber {
-            pos = pos + 1 // не 1, а количество элементов до первой цифры с конца
-        }
-        if pos < textCount {
-            setCursorPosition(offset: pos)
-        }
+        self.text = text
     }
 
     //MARK: UITextField methods overrides
@@ -160,7 +167,7 @@ open class FormattingTextField: UITextField {
         if !range.isEmpty {
             if mask.contains("*") || mask.contains("?") {
                 let text = String(txt.prefix(currentPosition(forStartOfRange: true)))
-                setFormattedText(text)
+                self.text = text
                 return
             }
         } else if hasConstantPrefix && String(txt.prefix(cursorPosition - 1)) == prefix {
@@ -170,7 +177,7 @@ open class FormattingTextField: UITextField {
         if hasConstantPrefix && range.end == endOfDocument {
             let stringByRemovingPrefix = String(txt.prefix(cursorPosition).dropFirst(prefix.count))
             if stringByRemovingPrefix.filter({ $0.isLetter || $0.isNumber }).isEmpty {
-                setFormattedText(stringByRemovingPrefix)
+                self.text = stringByRemovingPrefix
                 return
             }
         }
@@ -184,16 +191,15 @@ open class FormattingTextField: UITextField {
 
             charsToRemove += 1
             txt.remove(at: .init(utf16Offset: cursorPosition - charsToRemove, in: txt))
-
-            setFormattedText(txt)
+            text = txt
             setCursorPosition(offset: cursorPosition - charsToRemove)
             return
         }
 
         if !isNumberOrLetter(txt.dropLast().last) && range.end == endOfDocument {
             let numberToDrop = min(txt.count, 2)  // what if last 2-3 symbols are invalid? is it possible?
             txt.removeLast(numberToDrop)
-            setFormattedText(txt)
+            text = txt
             setCursorPosition(offset: cursorPosition - numberToDrop)
             return
         }
@@ -206,7 +212,45 @@ open class FormattingTextField: UITextField {
         }
     }
 
+    open override func becomeFirstResponder() -> Bool {
+        if text.isEmptyOrTrue && !showsMaskIfEmpty && !_showsMask && formatter != nil {
+            _showsMask = true
+            setNeedsDisplay()
+        }
+        return super.becomeFirstResponder()
+    }
+    
+    open override func resignFirstResponder() -> Bool {
+        if text.isEmptyOrTrue && !showsMaskIfEmpty && _showsMask && formatter != nil {
+            _showsMask = false
+            setNeedsDisplay()
+        }
+        return super.resignFirstResponder()
+    }
+    
+    open override func textRect(forBounds bounds: CGRect) -> CGRect {
+        guard let exampleMask = exampleMask?.replacingUnderscoresWithZeros() else {
+            return super.editingRect(forBounds: bounds)
+        }
+        
+        let w = sizeOfText(exampleMask).width
+        let originX = (bounds.width - w) / 2
+        return CGRect(x: originX, y: 0, width: w, height: bounds.height)
+    }
+    
+    open override func editingRect(forBounds bounds: CGRect) -> CGRect {
+        guard let exampleMask = exampleMask?.replacingUnderscoresWithZeros() else {
+            return super.editingRect(forBounds: bounds)
+        }
+        
+        let caretWidth: CGFloat = caretRect(for: endOfDocument).width
+        let w = sizeOfText(exampleMask).width
+        let originX = (bounds.width - w) / 2
+        return CGRect(x: originX, y: 0, width: w + caretWidth, height: bounds.height)
+    }
+    
     //MARK: Public methods
+    @available(*, deprecated, renamed: "text", message: "Use regular text setter to set formatted text programmatically ")
     open func setFormattedText(_ text: String?) {
         self.text = formattedText(text: text)
         notifyDelegate(text: self.text)
@@ -218,12 +262,12 @@ open class FormattingTextField: UITextField {
 
     open func drawExampleMask(rect: CGRect) {
         assertForExampleMasksAndPrefix()
-        let text = self.text ?? ""
+        let text = text ?? ""
 
         guard let mask = exampleMask,
               !mask.isEmpty,
-              let font = self.font,
-              let textColor = self.textColor,
+              let font,
+              let textColor,
               !text.isEmpty || _showsMask
         else { return }
 
@@ -233,13 +277,22 @@ open class FormattingTextField: UITextField {
             .foregroundColor : placeholderColor
         ])
 
-        if hasConstantPrefix {
+        if !text.isEmpty {
+            textToDraw.addAttributes(
+                [.foregroundColor : UIColor.clear],
+                range: .init(location: 0, length: text.count)
+            )
+        } else if hasConstantPrefix {
             textToDraw.addAttributes(
                 [.foregroundColor : textColor],
                 range: .init(location: 0, length: prefix.count)
             )
         }
-        textToDraw.draw(at: CGPoint(x: 0, y: ((bounds.height - font.lineHeight) / 2)))
+        
+        let w = sizeOfText(mask.replacingUnderscoresWithZeros()).width
+        let originX = (bounds.width - w) / 2
+        
+        textToDraw.draw(at: CGPoint(x: originX, y: ((bounds.height - font.lineHeight) / 2)))
     }
 
     open func formattedText(text: String?) -> String? {
@@ -248,9 +301,7 @@ open class FormattingTextField: UITextField {
                 setNeedsDisplay()
             }
         }
-        guard let formatter = formatter else {
-            return text
-        }
+        guard let formatter else { return text }
 
         let result = formatter.formattedText(text: text)
         return result
@@ -271,19 +322,30 @@ open class FormattingTextField: UITextField {
         }
     }
 
-    open override func becomeFirstResponder() -> Bool {
-        if text.isEmptyOrTrue && !showsMaskIfEmpty && !_showsMask && formatter != nil {
-            _showsMask = true
-            setNeedsDisplay()
-        }
-        return super.becomeFirstResponder()
+    //MARK: Private & internal
+    internal func assertForExampleMasksAndPrefix() {
+        guard let mask = exampleMask, !mask.isEmpty, let formattingMask = formattingMask, formatter != nil else { return }
+        assert(mask == formattedText(text: mask) && mask.count == formattingMask.count, "Formatting mask and example mask should be in same format. This is your responsibility as a developer\nExampleMask: \(mask)\nFormatting mask: \(formattingMask)")
+        assert(prefix.first(where: { $0.isLetter || $0.isNumber }) == nil || hasConstantPrefix, "You cannot have 'semi constant' prefixes at this point ")
     }
 
-    open override func resignFirstResponder() -> Bool {
-        if text.isEmptyOrTrue && !showsMaskIfEmpty && _showsMask && formatter != nil {
-            _showsMask = false
-            setNeedsDisplay()
+    func setCaretPositionAfterSettingText(currentPosition: Int, rawText:String?, formattedText: String?) {
+        var pos = currentPosition
+        let textCount = rawText?.count ?? 0
+        guard let last = formattedText?.prefix(pos).last else { return }
+    
+        if !last.isNumber {
+            pos = pos + 1 // не 1, а количество элементов до первой цифры с конца
+        }
+        if pos < textCount {
+            setCursorPosition(offset: pos)
+        } else if let count = formattedText?.count {
+            let delta = count - textCount
+            if abs(delta) > 2 {
+                DispatchQueue.main.async { // async because it may interfere with setting cursor position initiated by system
+                    self.setCursorPosition(offset: pos + delta)
+                }
+            }
         }
-        return super.resignFirstResponder()
     }
 }

AGInputControls/Source/PhoneTextField.swift

@@ -19,6 +19,22 @@ open class PhoneTextField: FormattingTextField {
             formatter = PhoneNumberFormatter(mask: formattingMask)
         }
     }
+    
+    open override var textAlignment: NSTextAlignment {
+        get {
+            super.textAlignment
+        }
+        
+        set {
+            /// `.center` just doesnt make sense from UX perspective if mask is enabled. We would expect to gradually replace placeholder with text which doesnt work with center alignment
+            guard formattingMask != nil && newValue == .center else {
+                super.textAlignment = newValue
+                return
+            }
+            
+            super.textAlignment = .left //TODO: check RTL languages
+        }
+    }
 
     override public init(frame: CGRect) {
         super.init(frame: frame)
@@ -36,4 +52,14 @@ open class PhoneTextField: FormattingTextField {
         }
         keyboardType = .phonePad
     }
+    
+    override func assertForExampleMasksAndPrefix() {
+        guard let mask = exampleMask, !mask.isEmpty, let formattingMask = formattingMask, formatter != nil else { return }
+        
+        // It is common for phone fields to have _ 
+        let fixedMask = mask.replacingOccurrences(of: "_", with: "0")
+        
+        assert(fixedMask == formattedText(text: fixedMask) && fixedMask.count == formattingMask.count, "Formatting mask and example mask should be in same format. This is your responsibility as a developer\nExampleMask: \(mask)\nFormatting mask: \(formattingMask)")
+        assert(prefix.first(where: { $0.isLetter || $0.isNumber }) == nil || hasConstantPrefix, "You cannot have 'semi constant' prefixes at this point ")
+    }
 }

AGInputControls/Source/String+Extension.swift

@@ -35,6 +35,10 @@ extension String {
     func alphanumeric() -> String {
         components(separatedBy: CharacterSet.letters.inverted).joined()
     }
+    
+    func replacingUnderscoresWithZeros() -> String {
+        replacingOccurrences(of: "_", with: "0")
+    }
 }
 
 internal extension Optional where Wrapped == String {

AGInputControlsTests/AcceptedLettersTests.swift

@@ -27,21 +27,21 @@ class AcceptedLettersTests: XCTestCase {
     }
 
     func testUnacceptedLettersDelegateMethodCalled() {
-        textField.setFormattedText("gз")
+        textField.text = "gз"
         XCTAssertEqual(delegate.unacceptedCharCalled, 1)
     }
 
 
     func testNotifyingDelegateWithEmptyMaskAndNonEmptyString() {
         textField.formatter = EmptyMaskFormatter()
-        textField.setFormattedText("gfhdskjfhdskjfhds")
+        textField.text = "gfhdskjfhdskjfhds"
         XCTAssertEqual(delegate.isValidCalled, 1)
         XCTAssertEqual(delegate.isValid, true)
     }
 
     func testNotifyingDelegateWithEmptyMaskAndEmptyString() {
         textField.formatter = EmptyMaskFormatter()
-        textField.setFormattedText("")
+        textField.text = ""
         XCTAssertEqual(delegate.isValidCalled, 1)
         XCTAssertEqual(delegate.isValid, false)
     }