Contents

wrkstrm/wrkstrm-main

---

🔑 Key Features

  • 🌐 Extended Swift Library: Enhancements for string manipulation and collection processing.
  • 🚀 Performance Oriented: Optimized for efficiency and speed.
  • 🔧 Versatile and Flexible: Adaptable to a wide range of development needs.

Compatibility

WrkstrmMain requires Swift 6.1 or later and supports:

  • iOS 16+
  • macOS 13+
  • macCatalyst 13+
  • tvOS 16+
  • visionOS 1+
  • watchOS 9+
  • Linux

📦 Installation

To integrate WrkstrmMain into your project, follow these steps:

🛠 Swift Package Manager

Add WrkstrmMain as a dependency in your Package.swift file:

dependencies: [
    .package(url: "https://github.com/wrkstrm/wrkstrm-main.git", .upToNextMajor(from: "3.0.0"))
]

Include WrkstrmMain in your target dependencies:

targets: [
    .target(name: "YourTarget", dependencies: ["WrkstrmMain"]),
]

📚 Usage

Import WrkstrmMain and utilize its extensions:

  1. 📥 Import the Library:

``swift import WrkstrmMain ``

  1. 🔨 Utilize Extensions: Leverage various extensions for enhanced functionality:

Example Extensions:

String Extensions

  • camelCaseToKebabCase(): Convert a camelCase string to kebab-case.
  • containsUniqueChars(): Check if a string contains all unique characters.
  • isPermutation(_:): Check if a string is a permutation of another string using a frequency-based

comparison.

  • * operator: Repeat a string by multiplying it with an integer.

Collection Extensions

  • search(key:): Binary search in a collection.
  • mergeSort(): Perform a merge sort on a collection.

Protocol AnyFlattenable

  • flattened(): Unwrap and flatten any value, potentially to nil.

Optional Comparable Extension

  • Optional<T> where T: Comparable: Adds < and > comparison operators for optional values

without requiring a full Comparable conformance.

Random String Utilities

See Random.swift.

let ascii = Random.printableASCII(length: 8)
// For emoji and mixed strings, add the WrkstrmEmoji package and
// call EmojiRandomizer.emojiString(length:) or `.mixedString(...)`.

JSON Helpers

See DocC: open the "WrkstrmMain" documentation in Xcode or swift-docc and start with the JSON Types Index. The JSON namespace is split into small files for clarity.

KeyedDecodingContainer+FuzzyDecoding.swift adds helpers for dealing with inconsistent API responses:

  • decodeAllowingNullOrEmptyObject maps null, the string "null", or {} to nil.
  • decodeArrayAllowingNullOrSingle normalizes null, a single object, or an array into an optional

array.

These functions prevent decoding failures for "no data" placeholders while still throwing when a value has an unexpected shape.

let object: JSON.AnyDictionary = ["name": "Alice", "age": 30]

struct Wrapper: Decodable {
    let item: Item?
    let items: [Item]?

    enum CodingKeys: String, CodingKey { case item, items }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        item = try container.decodeAllowingNullOrEmptyObject(Item.self, forKey: .item)
        items = try container.decodeArrayAllowingNullOrSingle(Item.self, forKey: .items)
    }
}
Bridged Writers (via WrkstrmFoundation)

WrkstrmFoundation extends this JSON namespace with human‑friendly writers and formatting:

  • JSON.Formatting.humanEncoder / JSON.Formatting.humanOptions
  • JSON.FileWriter.write(:,to:) and .writeJSONObject(:,to:)

Import WrkstrmFoundation alongside WrkstrmMain to access these APIs.

🏁 Flagship + Docs

WrkstrmMain is a flagship library: we pressure‑test best practices here (API design, DocC, tests, observability). Explore the DocC articles under sources/wrkstrm-main/Documentation.docc/ for symbol topics and indices.

Path Utilities

Filter arrays of path strings using the sourceFiles, nibFiles, baseLocalizedNibFiles, and unlocalizedNibFiles properties.

See the Source File Filters documentation for more examples.

let paths = ["View.swift", "Main.storyboard", "Base.lproj/Main.storyboard"]
let sources = paths.sourceFiles      // ["View.swift"]
let nibs = paths.nibFiles            // ["Main.storyboard", "Base.lproj/Main.storyboard"]

Custom Collections

Custom collection types are available in BinaryTree.swift, SortedArray.swift and IndexedCollection.swift.

let tree = BinaryTree(5)
tree.insert(3)
tree.insert(7)

var numbers = SortedArray(unsorted: [3, 1, 2])
numbers.insert(5)

for (index, element) in ["a", "b"].indexed() {
    print(index, element)
}

Injectable Protocol Usage

See Injectable.swift.

struct NetworkService { }

final class UserViewModel: Injectable {
    typealias Resource = NetworkService
    private var service: NetworkService?

    func inject(_ resource: NetworkService) { service = resource }
    func assertDependencies() { precondition(service != nil) }
}

let vm = UserViewModel()
vm.inject(NetworkService())
vm.assertDependencies()

🎨 Customization

WrkstrmMain is built with extension in mind. You can tailor it to fit your project by tapping into a few key extension points:

  • Random generators – Extend the Random namespace with custom routines for generating

domain‑specific strings.

``swift extension Random { /// Random hexadecimal string public static func hex(length: Int) -> String { let hex = "0123456789ABCDEF" return String((0..<length).map { _ in hex.randomElement()! }) } } ``

  • Custom collection types – Build domain‑specific collections by composing existing types such

as SortedArray or by conforming to Swift's Collection protocols.

These hooks make WrkstrmMain easy to integrate with project‑specific types and behaviors.

🧩 Dependency Injection

Adopt the Injectable protocol to keep dependencies loosely coupled. Conforming types can accept resources from the outside and verify that everything is wired correctly.

struct NetworkService {
    func request(_ path: String) { /* ... */ }
}

final class UserViewModel: Injectable {
    typealias Resource = NetworkService
    private var service: NetworkService?

    func inject(_ resource: NetworkService) {
        service = resource
    }

    func assertDependencies() {
        precondition(service != nil, "NetworkService must be injected")
    }
}

See the Injectable documentation for a deeper explanation and more examples.

🧪 Testing

Automated tests protect this library from regressions and document its expected behavior. They surface edge cases—like the permutation bug captured by our failing regression test—and give contributors confidence when refactoring. Please run swift test before submitting changes to ensure the codebase remains stable.

🤝 Contributing

🌟 Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📜 License

📄 Distributed under the MIT License. See LICENSE for more information.

📬 Contact

🔗 Project Link: https://github.com/wrkstrm/WrkstrmMain

💖 Acknowledgments

  • Developed by github.com/@rismay

Package Metadata

Repository: wrkstrm/wrkstrm-main

Default branch: main

README: README.md