Merge pull request #2 from lukepistrol/main

added static properties for type-safe access of custom symbols

Author: lukepistrol

Sources/CodeEditSymbols/CodeEditSymbols.swift

@@ -8,17 +8,36 @@ import SwiftUI
 
 public extension Image {
 
+    /// Creates an Image representing a custom SF Symbol
+    /// - Parameter symbol: The name of the symbol in `Symbols.xcassets`
     init(symbol: String) {
         self.init(symbol, bundle: Bundle.module)
     }
 
+    // MARK: - Symbols
+
+    static let vault: Image = .init(symbol: "vault")
+    static let vault_fill: Image = .init(symbol: "vault.fill")
+    static let commit: Image = .init(symbol: "commit")
+    static let checkout: Image = .init(symbol: "checkout")
+
 }
 
 
 public extension NSImage {
 
+    /// Returns a NSImage representing a custom SF Symbol
+    /// - Parameter named: The name of the symbol in `Symbols.xcassets`
+    /// - Returns: a NSImage
     static func symbol(named: String) -> NSImage {
         Bundle.module.image(forResource: named) ?? .init()
     }
 
+    // MARK: - Symbols
+
+    static let vault: NSImage = .symbol(named: "vault")
+    static let vault_fill: NSImage = .symbol(named: "vault.fill")
+    static let commit: NSImage = .symbol(named: "commit")
+    static let checkout: NSImage = .symbol(named: "checkout")
+
 }

Tests/CodeEditSymbolsTests/CodeEditSymbolsTests.swift

@@ -9,63 +9,65 @@ final class CodeEditSymbolsTests: XCTestCase {
 
     // MARK: VAULT
 
+    private let record: Bool = false
+
     func testCreateNSImageVault() {
-        let image = NSImage.symbol(named: "vault")
+        let image = NSImage.vault
         let view = NSImageView(image: image)
-        assertSnapshot(matching: view, as: .image)
+        assertSnapshot(matching: view, as: .image, record: record)
     }
 
     func testCreateNSImageVaultFill() {
-        let image = NSImage.symbol(named: "vault.fill")
+        let image = NSImage.vault_fill
         let view = NSImageView(image: image)
-        assertSnapshot(matching: view, as: .image)
+        assertSnapshot(matching: view, as: .image, record: record)
     }
 
     // MARK: COMMIT
 
     func testCreateNSImageCommit() {
-        let image = NSImage.symbol(named: "commit")
+        let image = NSImage.commit
         let view = NSImageView(image: image)
-        assertSnapshot(matching: view, as: .image)
+        assertSnapshot(matching: view, as: .image, record: record)
     }
 
     // MARK: CHECKOUT
 
     func testCreateNSImageCheckout() {
-        let image = Image(symbol: "checkout")
-        let view: NSView = NSHostingController(rootView: image).view
-        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
+        let image = NSImage.checkout
+        let view: NSView = NSImageView(image: image)
+        assertSnapshot(matching: view, as: .image, record: record)
     }
 
     // MARK: - Image Tests
 
     // MARK: VAULT
 
     func testCreateImageVault() {
-        let image = Image(symbol: "vault")
+        let image = Image.vault
         let view: NSView = NSHostingController(rootView: image).view
-        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
+        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize), record: record)
     }
 
     func testCreateImageVaultFill() {
-        let image = Image(symbol: "vault.fill")
+        let image = Image.vault_fill
         let view: NSView = NSHostingController(rootView: image).view
-        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
+        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize), record: record)
     }
 
     // MARK: COMMIT
 
     func testCreateImageCommit() {
-        let image = Image(symbol: "commit")
+        let image = Image.commit
         let view: NSView = NSHostingController(rootView: image).view
-        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
+        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize), record: record)
     }
 
     // MARK: CHECKOUT
 
     func testCreateImageCheckout() {
-        let image = Image(symbol: "checkout")
+        let image = Image.checkout
         let view: NSView = NSHostingController(rootView: image).view
-        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize))
+        assertSnapshot(matching: view, as: .image(size: view.intrinsicContentSize), record: record)
     }
 }