Skip to content

Instantly share code, notes, and snippets.

@SamuelFolledo
Last active July 30, 2020 01:23
Show Gist options
  • Save SamuelFolledo/a7cf2ece469366eaa0ff7753b8fd375a to your computer and use it in GitHub Desktop.
Save SamuelFolledo/a7cf2ece469366eaa0ff7753b8fd375a to your computer and use it in GitHub Desktop.

[TOC]

Countries Controller for any Phone TextFields

Lightweight solution on getting all the countries and its phone extension code with their names and emoji flags

Demo

Code

Country.swift

struct Country {
    let countryCode: String
    let name: String
    let currencyCode: String
    let currencySymbol: String
    let flag: String
    let phoneCode: String
}

CountriesController.swift

class CountriesController: UIViewController {
    
    // MARK: - Type Aliases
    
    typealias SelectedCountryCompletion = (_ country: Country?) -> Void
    
    // MARK: - Handlers
    
    var selectedCountryCompletion: SelectedCountryCompletion?
    
    //MARK: Properties
    var countries: [Country] = []
    var filteredCountries: [Country] = []
    var allCountriesGrouped: [String: [Country]] = [:]
    var sectionTitleList: [String] = []
    
    //MARK: Views
    private lazy var tableView: UITableView = {
        let tableView = UITableView.init(frame: .zero)
        tableView.delegate = self
        tableView.dataSource = self
        tableView.tableFooterView = UIView()
        tableView.registerCell(CountryCell.self)
        return tableView
    }()
    lazy var searchController: UISearchController = {
        let searchController = UISearchController(searchResultsController: nil)
        searchController.searchResultsUpdater = self
        searchController.obscuresBackgroundDuringPresentation = false
        self.definesPresentationContext = true
        return searchController
    }()
    
    //MARK: App Life Cycle
    override func viewDidLoad() {
        super.viewDidLoad()
        setupViews()
    }
    
    //MARK: Private Methods
    fileprivate func setupViews() {
        setupNavigationBar()
        addCountries()
        constraintViews()
    }
    
    func addCountries() {
        //loop through each country code, turn data to Country, and create an array of Country
        countries = NSLocale.isoCountryCodes.compactMap { code in
            let id = NSLocale.localeIdentifier(fromComponents: [NSLocale.Key.countryCode.rawValue: code])
            let locale = NSLocale(localeIdentifier: id)
            guard let name = NSLocale(localeIdentifier: "en_US").displayName(forKey: NSLocale.Key.identifier, value: id),
                let countryCode = locale.object(forKey: NSLocale.Key.countryCode) as? String,
                let currencyCode = locale.object(forKey: NSLocale.Key.currencyCode) as? String,
                let currencySymbol = locale.object(forKey: NSLocale.Key.currencySymbol) as? String,
                let flagEmoji = String.flag(for: code)
            else { //AQ's and CP's currencyCode are nil, I chose not to support those countries
                return nil
            }
            //create country
            let country = Country(countryCode: countryCode,
                                  name: name, currencyCode: currencyCode,
                                  currencySymbol: currencySymbol,
                                  flag: flagEmoji,
                                  phoneCode: NSLocale().phoneCode(countryCode: countryCode))
            return country
        }
        //sort countries by country's name
        countries.sort { $0.name < $1.name }
        for country in countries {
            let firstChar = "\(country.name.first!)"
            if !sectionTitleList.contains(firstChar) { //if new first character
                self.sectionTitleList.append(firstChar)
                self.allCountriesGrouped[firstChar] = []
            }
            self.allCountriesGrouped[firstChar]?.append(country)
        }
        self.tableView.reloadData()
    }
    
    fileprivate func setupNavigationBar() {
        navigationItem.title = "Select Country"
        navigationItem.searchController = searchController
        navigationItem.hidesSearchBarWhenScrolling = false
        definesPresentationContext = true
    }
    
    fileprivate func constraintViews() {
        view.addSubview(tableView)
        tableView.snp.makeConstraints { (make) in
            make.top.left.right.bottom.equalToSuperview()
        }
    }
    
    //MARK: Helpers
}

//MARK: Extensions

extension CountriesController: UITableViewDelegate {
    func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
        let country: Country!
        if searchController.isActive && searchController.searchBar.text != "" {
            country = filteredCountries[indexPath.row]
        } else {
            let sectionTitle = self.sectionTitleList[indexPath.section]
            let groupedCountries = self.allCountriesGrouped[sectionTitle]
            country = groupedCountries![indexPath.row]
        }
        selectedCountryCompletion!(country)
    }
}

extension CountriesController: UITableViewDataSource {
    func numberOfSections(in tableView: UITableView) -> Int {
        if searchController.isActive && searchController.searchBar.text != "" {
            return 1
        } else {
            return allCountriesGrouped.count
        }
    }
    
    func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        if searchController.isActive && searchController.searchBar.text != "" {
            return filteredCountries.count
        } else {
            let sectionTitle = self.sectionTitleList[section]
            let groupedCountries = self.allCountriesGrouped[sectionTitle]
            return groupedCountries!.count
        }
    }
    
    func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        let cell = tableView.dequeueReusableCell(forIndexPath: indexPath) as CountryCell
        let country: Country!
        if searchController.isActive && searchController.searchBar.text != "" {
            country = filteredCountries[indexPath.row]
        } else {
            let sectionTitle = self.sectionTitleList[indexPath.section]
            let groupedCountries = self.allCountriesGrouped[sectionTitle]
            country = groupedCountries![indexPath.row]
        }
        cell.populateViews(country: country)
        return cell
    }
    
    //Setup first character headers pt. 1
    func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
        if searchController.isActive && searchController.searchBar.text != "" {
            return ""
        } else { //when not searching, apply first character of name as headers
            return sectionTitleList[section]
        }
    }
    
    //Setup first character headers pt. 2
    func sectionIndexTitles(for tableView: UITableView) -> [String]? {
        if searchController.isActive && searchController.searchBar.text != "" {
            return nil
        } else {
            return self.sectionTitleList
        }
    }
    
    //To jump to the cell as user search
    func tableView(_ tableView: UITableView, sectionForSectionIndexTitle title: String, at index: Int) -> Int {
        return index
    }
}

extension CountriesController: UISearchResultsUpdating {
    func updateSearchResults(for searchController: UISearchController) {
        filterContentForSearchText(searchText: searchController.searchBar.text!)
    }
    
    //MARK: Private Search Method
    func filterContentForSearchText(searchText: String, scope: String = "All") {
        filteredCountries = countries.filter({ (country) -> Bool in
            return country.name.lowercased().contains(searchText.lowercased()) ||
                   country.phoneCode.lowercased().contains(searchText.lowercased())
        })
        tableView.reloadData()
    }
}

String+Extensions.swift

extension String {
    ///returns a Country's flag emoji
    static func flag(for code: String) -> String? {
        ///convert string to lowercase
        func isLowerCaseASCIIScalar(_ scalar: Unicode.Scalar) -> Bool {
            return scalar.value >= 0x61 && scalar.value <= 0x7A
        }
        
        ///find the scaling, then find the symbol
        func regionalIndicatorSymbol(for scalar: Unicode.Scalar) -> Unicode.Scalar {
            precondition(isLowerCaseASCIIScalar(scalar))
            return Unicode.Scalar(scalar.value + (0x1F1E6 - 0x61))!
        }
        
        let lowerCasedCode = code.lowercased()
        guard lowerCasedCode.count == 2 else { return nil }
        guard lowerCasedCode.unicodeScalars.reduce(true, { accum, scalar in
            accum && isLowerCaseASCIIScalar(scalar)})
            else { return nil }
        let indicatorSymbols = lowerCasedCode.unicodeScalars.map({ regionalIndicatorSymbol(for: $0) })
        return String(indicatorSymbols.map({ Character($0) }))
    }
}

NSLocale+Extensions.swift

//MARK: Find the Country Code
extension NSLocale {
    ///Country's phone code
    func phoneCode(countryCode : String) -> String {
        let countryDialingCode = prefixCodes[countryCode] ?? "0000"
        return countryDialingCode
    }
}

Constants.swift

let prefixCodes = ["AC" : "247", "AF": "93", "AE": "971", "AL": "355", "AN": "599", "AS":"1", "AD": "376", "AO": "244", "AI": "1", "AG":"1", "AR": "54","AM": "374", "AW": "297", "AU":"61", "AT": "43","AZ": "994", "BS": "1", "BH":"973", "BF": "226","BI": "257", "BD": "880", "BB": "1", "BY": "375", "BE":"32","BZ": "501", "BJ": "229", "BM": "1", "BT":"975", "BA": "387", "BW": "267", "BR": "55", "BG": "359", "BO": "591", "BL": "590", "BN": "673", "CC": "61", "CD":"243","CI": "225", "KH":"855", "CM": "237", "CA": "1", "CV": "238", "KY":"345", "CF":"236", "CH": "41", "CL": "56", "CN":"86","CX": "61", "CO": "57", "KM": "269", "CG":"242", "CK": "682", "CR": "506", "CU":"53", "CY":"537","CZ": "420", "DE": "49", "DK": "45", "DJ":"253", "DM": "1", "DO": "1", "DZ": "213", "EC": "593", "EG":"20", "ER": "291", "EE":"372","ES": "34", "ET": "251", "FM": "691", "FK": "500", "FO": "298", "FJ": "679", "FI":"358", "FR": "33", "GB":"44", "GF": "594", "GA":"241", "GS": "500", "GM":"220", "GE":"995","GH":"233", "GI": "350", "GQ": "240", "GR": "30", "GG": "44", "GL": "299", "GD":"1", "GP": "590", "GU": "1", "GT": "502", "GN":"224","GW": "245", "GY": "595", "HT": "509", "HR": "385", "HN":"504", "HU": "36", "HK": "852", "IR": "98", "IM": "44", "IL": "972", "IO":"246", "IS": "354", "IN": "91", "ID":"62", "IQ":"964", "IE": "353","IT":"39", "JM":"1", "JP": "81", "JO": "962", "JE":"44", "KP": "850", "KR": "82","KZ":"77", "KE": "254", "KI": "686", "KW": "965", "KG":"996","KN":"1", "LC": "1", "LV": "371", "LB": "961", "LK":"94", "LS": "266", "LR":"231", "LI": "423", "LT": "370", "LU": "352", "LA": "856", "LY":"218", "MO": "853", "MK": "389", "MG":"261", "MW": "265", "MY": "60","MV": "960", "ML":"223", "MT": "356", "MH": "692", "MQ": "596", "MR":"222", "MU": "230", "MX": "52","MC": "377", "MN": "976", "ME": "382", "MP": "1", "MS": "1", "MA":"212", "MM": "95", "MF": "590", "MD":"373", "MZ": "258", "NA":"264", "NR":"674", "NP":"977", "NL": "31","NC": "687", "NZ":"64", "NI": "505", "NE": "227", "NG": "234", "NU":"683", "NF": "672", "NO": "47","OM": "968", "PK": "92", "PM": "508", "PW": "680", "PF": "689", "PA": "507", "PG":"675", "PY": "595", "PE": "51", "PH": "63", "PL":"48", "PN": "872","PT": "351", "PR": "1","PS": "970", "QA": "974", "RO":"40", "RE":"262", "RS": "381", "RU": "7", "RW": "250", "SM": "378", "SA":"966", "SN": "221", "SC": "248", "SL":"232","SG": "65", "SK": "421", "SI": "386", "SB":"677", "SH": "290", "SD": "249", "SR": "597","SZ": "268", "SE":"46", "SV": "503", "ST": "239","SO": "252", "SJ": "47", "SY":"963", "TW": "886", "TZ": "255", "TL": "670", "TD": "235", "TJ": "992", "TH": "66", "TG":"228", "TK": "690", "TO": "676", "TT": "1", "TN":"216","TR": "90", "TM": "993", "TC": "1", "TV":"688", "UG": "256", "UA": "380", "US": "1", "UY": "598","UZ": "998", "VA":"379", "VE":"58", "VN": "84", "VG": "1", "VI": "1","VC":"1", "VU":"678", "WS": "685", "WF": "681", "YE": "967", "YT": "262","ZA": "27" , "ZM": "260", "ZW":"263", "AQ" : "672", "AX" : "358", "BQ" : "599", "CW": "599", "BV": "55", "DG": "246", "EH": "212", "HM": "672", "IC": "34", "EA": "34", "SS": "211", "SX": "1", "TA": "290", "TF": "262", "UM": "1", "XK": "383"]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment