Swiftpack.co - Package - lukaskubanek/OrderedDictionary

OrderedDictionary

OrderedDictionary is a lightweight implementation of an ordered dictionary data structure in Swift.

The OrderedDictionary struct is a generic collection which combines the features of Dictionary and Array from the Swift standard library. Like Dictionary it stores key-value pairs with each key being unique and maps each key to an associated value. Like Array it stores those pairs sorted and accessible by a zero-based integer index.

OrderedDictionary provides similar APIs like collections from the Swift standard library. This includes accessing contents by keys or indices, inserting and removing elements, iterating, sorting etc.

Internally, OrderedDictionary uses a backing store composed of an instance of Dictionary for storing the key-value pairs and an instance of Array for managing the ordered keys. This means it is not the most performant implementation possible, but it gets its job done by reusing most functionality from the Swift standard library.

Requirements

  • Swift 4.0-4.2
  • Xcode 9.2+
  • iOS 8.0+ / macOS 10.10+

Installation

The library is distributed as a Swift framework and can be integrated into your project in following ways:

Carthage

If you use Carthage for managing your dependencies, put OrderedDictionary into your Cartfile:

github "lukaskubanek/OrderedDictionary"

Then, drag either the OrderedDictionary.xcodeproj or the OrderedDictionary.framework into your project/workspace and link your target against the OrderedDictionary.framework. Also make sure that the framework gets copied to your application bundle.

Swift Package Manager

Another option is to use the Swift Package Manager. If you prefer this option, put OrderedDictionary as a dependency to your Package.swift:

.package(url: "https://github.com/lukaskubanek/OrderedDictionary.git", from: "2.1.0")

Git Submodules

Yet another option is using Git submodules and integrating the Xcode project OrderedDictionary.xcodeproj from the submodule directly to your Xcode workspace.

⚠️ Note About CocoaPods

Although there is high demand for CocoaPods support, this method won't be officially supported by this library. Since I'm not using CocoaPods myself and since I think this method will be once replaced by the Swift Package Manager, I don't want to put any effort in maintaining an official podspec. If you really want to include this library via CocoaPods, there is still a way by creating a custom podspec (see the last section of this post).

Usage & Docs

For the usage of this library please refer to the example playground. For documentation please refer to the documentation comments.

Changelog

The changelog is managed on the GitHub releases page.

Author

Lukas Kubanek // lukaskubanek.com // @kubanekl

License

OrderedDictionary is provided under the MIT License.

Github

link
Stars: 92
Help us keep the lights on

Dependencies

Used By

Total:

Releases

v2.1.0 - Jul 10, 2018

  • Added support for Swift Package Manager (thanks to @jnordberg)
  • Optimized lookup performace (thanks to @maicki)
  • Introduced Dictionary.sorted(by:)
  • Introduced popFirst(), popLast(), removeFirst(), removeLast() methods
  • Annotated sort methods with throws/rethrows keywords
  • Added note about no support for CocoaPods

v2.0.0 - May 22, 2018

  • Support for Swift 4.0 is still maintained
  • OrderedDictionary now conditionally conforms to Equatable and Codable
  • Used custom types for keys and values collections
  • Simplified the OrderedDictionarySlice type

v1.1.0 - Mar 27, 2018

  • Improved methods for insertion checks (aka OrderedDictionary.canInsert(...))
  • Added an initializer from regular Dictionary
  • Added support for moving key-value pairs to a new index

v1.0.0 - Sep 25, 2017

This is the official release of OrderedDictionary which supports Xcode 9 and Swift 4. 🎉

v1.0.0-beta.3 - Aug 12, 2017

  • Supports Xcode 9 β5
  • Added initial conformance to Swift's Codable
  • Added two new initializers for instantiating an OrderedDictionary from a sequence of values
  • Exposed unorderedDictionary property
  • Removed migration code
  • Version 1.0.0 will be released when the final version of Swift 4 arrives