Cleanup file structure

danielsaidi · danielsaidi · commit 364d39796761 · 2025-04-03T13:58:35.000+02:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2024 Daniel Saidi
+Copyright (c) 2022-2025 Daniel Saidi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Sources/TagKit/Slugs.swift b/Sources/TagKit/Slugs.swift
@@ -1,13 +1,29 @@
 //
-//  SlugConfiguration.swift
+//  Slugs.swift
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-08-18.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import Foundation
 
+public extension String {
+
+    /// Create a slugified version of the string.
+    ///
+    /// - Parameters:
+    ///   - configuration: The configuration to use, by default ``SlugConfiguration/standard``.
+    func slugified(
+        with configuration: SlugConfiguration = .standard
+    ) -> String {
+        lowercased()
+            .components(separatedBy: configuration.notAllowedCharacterSet)
+            .filter { !$0.isEmpty }
+            .joined(separator: configuration.separator)
+    }
+}
+
 /// This configuration defines how ``Slugifiable`` types are
 /// slugified.
 ///
diff --git a/Sources/TagKit/String+Slugified.swift b/Sources/TagKit/String+Slugified.swift
diff --git a/Sources/TagKit/TagKit.docc/TagKit.md b/Sources/TagKit/TagKit.docc/TagKit.md
@@ -10,7 +10,7 @@ TagKit is a Swift SDK that makes it easy to work with tags and slugification in
 
 TagKit is a Swift SDK that makes it easy to work with tags and slugified strings in `Swift` and `SwiftUI`.
 
-You can slug and tag any type and customize the slug format, and use the built-in views to list and edit tags with minimum effort.
+You can slug and tag any type, customize the slug format, and use the built-in views to list and edit tags with ease.
 
 
 
@@ -85,14 +85,12 @@ TagKit is available under the MIT license.
 
 ## Topics
 
-### Articles
+### Slugs
 
-- <doc:Getting-Started>
+- ``SlugConfiguration``
 
-### Types
+### Tags
 
-- ``Slugifiable``
-- ``SlugConfiguration``
 - ``Taggable``
 
 ### Views
diff --git a/Sources/TagKit/Taggable+Collection.swift b/Sources/TagKit/Taggable+Collection.swift
diff --git a/Sources/TagKit/Tags.swift b/Sources/TagKit/Tags.swift
@@ -1,9 +1,9 @@
 //
-//  Taggable.swift
+//  Tags.swift
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-08-06.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import Foundation
@@ -60,7 +60,7 @@ public extension Taggable {
     func slugifiedTags(
         configuration: SlugConfiguration = .standard
     ) -> [String] {
-        tags.map { $0.slugified(configuration: configuration) }
+        tags.map { $0.slugified(with: configuration) }
     }
 
     /// Toggle a tag on the taggable type.
@@ -72,3 +72,19 @@ public extension Taggable {
         }
     }
 }
+
+public extension Collection where Element: Taggable {
+
+    /// Get all the slugified tags in the collection.
+    ///
+    /// Read more about slugified strings in ``Slugifiable``.
+    var allTags: [String] {
+        let slugs = flatMap { $0.slugifiedTags }
+        return Array(Set(slugs)).sorted()
+    }
+
+    /// Get all items in the collection with a certain tag.
+    func withTag(_ tag: String) -> [Element] {
+        filter { $0.hasTag(tag) }
+    }
+}
diff --git a/Sources/TagKit/Views/TagCapsule.swift b/Sources/TagKit/Views/TagCapsule.swift
@@ -3,7 +3,7 @@
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-08-19.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
diff --git a/Sources/TagKit/Views/TagCapsuleStyle.swift b/Sources/TagKit/Views/TagCapsuleStyle.swift
@@ -3,7 +3,7 @@
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-09-07.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
diff --git a/Sources/TagKit/Views/TagEditList.swift b/Sources/TagKit/Views/TagEditList.swift
@@ -3,7 +3,7 @@
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-08-19.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
diff --git a/Sources/TagKit/Views/TagList.swift b/Sources/TagKit/Views/TagList.swift
@@ -5,7 +5,7 @@
 //  Based on https://github.com/globulus/swiftui-flow-layout
 //
 //  Created by Daniel Saidi on 2022-08-18.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import SwiftUI
diff --git a/Sources/TagKit/_Deprecated/Slugifiable.swift b/Sources/TagKit/_Deprecated/Slugifiable.swift
@@ -3,7 +3,7 @@
 //  TagKit
 //
 //  Created by Daniel Saidi on 2022-08-18.
-//  Copyright © 2022-2024 Daniel Saidi. All rights reserved.
+//  Copyright © 2022-2025 Daniel Saidi. All rights reserved.
 //
 
 import Foundation
diff --git a/Tests/TagKitTests/SlugConfigurationTests.swift b/Tests/TagKitTests/SlugConfigurationTests.swift
diff --git a/Tests/TagKitTests/SlugifiableTests.swift b/Tests/TagKitTests/SlugifiableTests.swift
diff --git a/Tests/TagKitTests/SlugsTests.swift b/Tests/TagKitTests/SlugsTests.swift
@@ -0,0 +1,44 @@
+import TagKit
+import XCTest
+
+final class SlugConfigurationTests: XCTestCase {
+    
+    func testStringUsesStandardSlugConfigurationByDefault() {
+        let string = "I'd love a super-great AppleCar!"
+        let result = string.slugified()
+        let expected = "i-d-love-a-super-great-applecar"
+
+        XCTAssertEqual(result, expected)
+    }
+
+    func testStringCanUseCustomSlugConfiguration() {
+        let string = "I'd love a super-great AppleCar!"
+        let config = SlugConfiguration(
+            separator: "+",
+            allowedCharacters: "abc")
+        let result = string.slugified(with: config)
+        let expected = "a+a+a+ca"
+
+        XCTAssertEqual(result, expected)
+    }
+    
+    func testHasValidStandardSlugConfiguration() {
+        let config = SlugConfiguration.standard
+        let expected = "abcdefghijklmnopqrstuvwxyz0123456789-"
+
+        XCTAssertEqual(config.separator, "-")
+        XCTAssertEqual(config.allowedCharacters, expected)
+        XCTAssertEqual(config.allowedCharacterSet, NSCharacterSet(charactersIn: expected))
+    }
+
+    func testCanCreateCustomSlugConfiguration() {
+        let config = SlugConfiguration(
+            separator: "+",
+            allowedCharacters: "abc123")
+        let expected = "abc123+"
+
+        XCTAssertEqual(config.separator, "+")
+        XCTAssertEqual(config.allowedCharacters, expected)
+        XCTAssertEqual(config.allowedCharacterSet, NSCharacterSet(charactersIn: expected))
+    }
+}
diff --git a/Tests/TagKitTests/Taggable+CollectionTests.swift b/Tests/TagKitTests/Taggable+CollectionTests.swift
diff --git a/Tests/TagKitTests/TagsTests.swift b/Tests/TagKitTests/TagsTests.swift
@@ -65,4 +65,17 @@ final class TaggableItemTests: XCTestCase {
         item.toggleTag("tag2")
         XCTAssertEqual(item.tags, ["tag1", "tag2"])
     }
+    
+    private let items: [TestItem] = {
+        var item1 = TestItem(tags: ["item", "Item 1"])
+        var item2 = TestItem(tags: ["iTem", "item 2"])
+        var item3 = TestItem(tags: ["iteM", "item 3"])
+        return [item1, item2, item3]
+    }()
+
+    func test_allTagsRetursSlugifiedItems() {
+        let result = items.allTags
+
+        XCTAssertEqual(result, ["item", "item-1", "item-2", "item-3"])
+    }
 }
