[TEMPURA-2186] Custom icons support (#2132)

* allow custom name and bundle for icons

* add test for custom icons

* Record snapshots

* update BPKIcon template

* Update BPKIcons.swift

* record snapshots

* Updated snapshots

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Backpack-SwiftUI/Icons/Classes/BPKIcon.swift

@@ -15,9 +15,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import Backpack_Common
 
 public struct BPKIcon {
     public let name: String
+    let bundle: Bundle
+
+    init (name: String, bundle: Bundle = BPKCommonBundle.iconsBundle) {
+        self.name = name
+        self.bundle = bundle
+    }
 
     public enum Size {
         case large, small

Backpack-SwiftUI/Icons/Classes/BPKIconView.swift

@@ -83,11 +83,10 @@ private extension BPKIcon.Size {
 private extension Image {
     init(icon: BPKIcon, size: BPKIcon.Size = .small, shouldEnableAccessibility: Bool) {
         let iconName = "\(icon.name)-\(size.suffix)"
-        let bundle = BPKCommonBundle.iconsBundle
         if shouldEnableAccessibility {
-            self.init(iconName, bundle: bundle)
+            self.init(iconName, bundle: icon.bundle)
         } else {
-            self.init(decorative: iconName, bundle: bundle)
+            self.init(decorative: iconName, bundle: icon.bundle)
         }
     }
 }

Backpack-SwiftUI/Icons/Classes/Generated/BPKIcons.swift

@@ -298,7 +298,12 @@ public extension BPKIcon {
 
 public extension BPKIcon {
     // swiftlint:disable function_body_length cyclomatic_complexity
-    static func named(_ iconName: String) -> BPKIcon? {
+    static func named(_ iconName: String, bundle: Bundle? = nil) -> BPKIcon? {
+
+        if let bundle {
+            return BPKIcon(name: iconName, bundle: bundle)
+        }
+
         switch iconName {
         case "accessibility": return .accessibility
         case "account--add": return .accountAdd

Backpack-SwiftUI/Tests/Icons/BPKIconViewTests.swift

@@ -53,4 +53,14 @@ class BPKIconViewTests: XCTestCase {
     func testAutoMirrorSmallIcon() {
         assertSnapshot(BPKIconView(.arrowLeft, size: .small))
     }
+
+    func testCustomSmallIcon() {
+        let bundle = Bundle(for: BPKIconViewTests.self)
+        assertSnapshot(BPKIconView(BPKIcon(name: "custom-icon", bundle: TestsBundle.bundle!), size: .small))
+    }
+
+    func testCustomLargeIcon() {
+        let bundle = Bundle(for: BPKIconViewTests.self)
+        assertSnapshot(BPKIconView(BPKIcon(name: "custom-icon", bundle: TestsBundle.bundle!), size: .large))
+    }
 }

Backpack-SwiftUI/Tests/Images.xcassets/custom-icon-lg.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "custom-icon-lg.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Backpack-SwiftUI/Tests/Images.xcassets/custom-icon-sm.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "custom-icon-sm.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

templates/swiftui/BPKIcons.njk

@@ -25,7 +25,12 @@ public extension BPKIcon {
 
 public extension BPKIcon {
     // swiftlint:disable function_body_length cyclomatic_complexity
-    static func named(_ iconName: String) -> BPKIcon? {
+    static func named(_ iconName: String, bundle: Bundle? = nil) -> BPKIcon? {
+
+        if let bundle {
+            return BPKIcon(name: iconName, bundle: bundle)
+        }
+
         switch iconName {
         {% for icon in icons -%}
         case "{{icon.file}}": return .{{icon.name}}