Provincial

Latest	0.1.3
Homepage	https://github.com/JoshHrach/Provincial
License	MIT
Platforms	ios 8.0
Authors	Josh Hrach

Provincial is a small library to quickly get a list of states or provinces from various countries.

Goal

Ultimately, the goal of Provincial was to provide a quick way to get a list of US states and Canadian provinces. Instead of hardcoding a list of strings in an array, this library can provide a list of State objects that give basic information about each.

Requirements

None.

Installation

Provincial is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod "Provincial"

Usage

At the top of your .swift file:

import Provincial

To get a list of all US states:

let states = Provincial.states(in: .usa)

This returns a list of PoliticalEntity objects representing states.

The PoliticalEntity protocol requires each to provide a State computed property. This State struct includes the name and abbreviation of each state. Thus, to print the name of all 50 US States, you could write:

for state in states {
  print(state.info.name)
}

States are listed by means of an enum. This can allow you to either check for specifics states while looping through a set, or to get individual information for a particular state.

let arizona = USState.arizona
print(arizona.name)
print(arizona.abbreviation)

It’s also possible to filter or sort the array using Swift’s built in .filter and .sorted methods.

let newestStates = states.sorted { $0.info.date > $1.info.date }

Planned Features and Improvements

• [ ] All North American states and provinces (currently only US and Canada)
• [ ] Convenience methods for sorting results
• [ ] Better storage of data

Feature suggestions and pull requests are welcome!

Author

Josh Hrach, [email protected]

License

Provincial is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "Provincial",
    "version": "0.1.3",
    "summary": "A small library to quickly get states and provinces for various countries.",
    "description": "Provincial makes it quick to get a list of states or provinces for various countries.",
    "homepage": "https://github.com/JoshHrach/Provincial",
    "license": {
        "type": "MIT",
        "file": "LICENSE.md"
    },
    "authors": {
        "Josh Hrach": "[email protected]"
    },
    "source": {
        "git": "https://github.com/JoshHrach/Provincial.git",
        "tag": "0.1.3"
    },
    "social_media_url": "https://twitter.com/JoshHrach",
    "platforms": {
        "ios": "8.0"
    },
    "swift_version": "4.1",
    "source_files": "Provincial/**/*",
    "module_name": "Provincial"
}

Sat, 23 Jun 2018 22:20:04 +0000