Merge pull request #30 from x-0o0/jaesung/feature/keyword-based-search

String keyword-based search

Package.swift

@@ -1,23 +1,26 @@
-// swift-tools-version:5.4
-// The swift-tools-version declares the minimum version of Swift required to build this package.
+// swift-tools-version:5.9
 
 import PackageDescription
 
 let package = Package(
     name: "SwiftyChords",
     platforms: [.iOS(.v13), .macOS(.v11)],
     products: [
-        // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "SwiftyChords",
-            targets: ["SwiftyChords"]),
+            targets: ["SwiftyChords"]
+        ),
     ],
-    dependencies: [],
     targets: [
         .target(
             name: "SwiftyChords",
-            dependencies: [],
             resources: [.process("Resources")]
         ),
+        .testTarget(
+            name: "SwiftyChordsTests",
+            dependencies: [
+                "SwiftyChords"
+            ]
+        )
     ]
 )

README.md

@@ -60,6 +60,14 @@ Returns all suspended chords in the database along with their variants such as s
 Chords.guitar.matching(group: .suspended)
 ```
 
+### Filter by String Keyword
+Returns all Dsus4 chords. This works the same as filtering by key and suffix.
+
+```swift
+Chords.guitar.matching(keyword: "Dsus4") // same as Chords.guitar.matching(key: .d).matching(suffix: .sus4)
+```
+
+
 ## Display
 Swifty Chords suports a number of alternative texts you can use in your UI including an accessibility text-to-speech friendly variant.
 Display texts from both Key and Suffix properties can be combined to complete the chord name.

Sources/SwiftyChords/Array+Chords.swift

@@ -29,4 +29,41 @@ public extension Array where Element == ChordPosition {
         return self.filter { $0.suffix.group == group }
     }
 
+    func matching(keyword: String) -> [ChordPosition] {
+        // check keyword invalidation...
+        let trimmedKeyword = keyword.trimmingCharacters(in: .whitespaces)
+        if trimmedKeyword.isEmpty { return [] }
+
+        // If the keyword has 1 or 0 character, returns the matching `ChordPosition`s immediately
+        if trimmedKeyword.count < 2 {
+            guard let key = Chords.Key(rawValue: trimmedKeyword) else { return [] }
+            return self.matching(key: key)
+        }
+
+        // Get second character
+        let sharpOrFlat = trimmedKeyword[trimmedKeyword.index(trimmedKeyword.startIndex, offsetBy: 1)]
+        let hasSharpOrFlat = (sharpOrFlat == "b") || (sharpOrFlat == "#") // C#, Bb, Eb, D#, ...
+
+        // Get string for key
+        let keyString = String(trimmedKeyword.prefix(hasSharpOrFlat ? 2 : 1))
+
+        // If the string for key is invalid, returns immediately
+        guard let key = Chords.Key(rawValue: keyString) else { return [] }
+
+        // Get string for suffix
+        var suffixString = String(trimmedKeyword.dropFirst(hasSharpOrFlat ? 2 : 1))
+
+        // If the string for suffix is empty, assigns "major" instead.
+        // If the string for suffix is "m", assigns "minor" instead.
+        if suffixString.isEmpty {
+            suffixString = "major"
+        } else if suffixString == "m" {
+            suffixString = "minor"
+        }
+
+        guard let suffix = Chords.Suffix(rawValue: suffixString) else { return [] }
+
+        // Returns the matching chord positions
+        return self.matching(key: key).matching(suffix: suffix)
+    }
 }

Tests/SwiftyChordsTests/ArrayExtensionTests.swift

@@ -0,0 +1,27 @@
+//
+//  ArrayExtensionTests.swift
+//  
+//
+//  Created on 7/28/24.
+//
+
+#if canImport(Testing)
+import Testing
+@testable import SwiftyChords
+
+@Suite
+struct ArrayExtensionTests {
+    @Test(
+        "Tests 'matching(keyword:)'",
+        arguments: Chord.allCases
+    )
+    func matchingKeyword(chord: Chord) throws {
+        let chords = Chords.guitar
+        let positions = chords.matching(keyword: chord.keyword)
+
+        #expect(positions.filter { $0.key.rawValue != chord.key.rawValue }.isEmpty)
+        #expect(positions.filter { $0.suffix.rawValue != chord.suffix.rawValue }.isEmpty)
+    }
+}
+#endif
+

Tests/SwiftyChordsTests/Chord.Tests.swift

@@ -0,0 +1,45 @@
+//
+//  Chord.Tests.swift
+//  
+//
+//  Created on 7/28/24.
+//
+
+enum Chord: CaseIterable {
+    case cSharpMajor, aMinor, cBasedG, dSus4, g7
+
+    var keyword: String {
+        switch self {
+        case .cSharpMajor:
+            "C#"
+        case .aMinor:
+            "Am"
+        case .cBasedG:
+            "C/G"
+        case .dSus4:
+            "Dsus4"
+        case .g7:
+            "G7"
+        }
+    }
+    var key: Chords.Key {
+        switch self {
+        case .cSharpMajor: Chords.Key.cSharp
+        case .aMinor: Chords.Key.a
+        case .cBasedG: Chords.Key.c
+        case .dSus4: Chords.Key.d
+        case .g7: Chords.Key.g
+        }
+    }
+
+    var suffix: Chords.Suffix {
+        switch self {
+        case .cSharpMajor: Chords.Suffix.major
+        case .aMinor: Chords.Suffix.minor
+        case .cBasedG: Chords.Suffix.slashG
+        case .dSus4: Chords.Suffix.susFour
+        case .g7: Chords.Suffix.seven
+        }
+    }
+}
+