generate type with Hashable and Equatable conformance

liamnichols · Jul 26, 2024 · 638d847 · 638d847
1 parent f9dfc7d
commit 638d847
Show file tree

Hide file tree

Showing 18 changed files with 276 additions and 26 deletions.
diff --git a/Sources/StringGenerator/Extensions/TokenSyntax+Types.swift b/Sources/StringGenerator/Extensions/TokenSyntax+Types.swift
@@ -22,6 +22,10 @@ extension TokenSyntax {
         case LocalizedStringKey
         case Text
         case Sendable
+        case Hasher
+        case Bool
+        case Equatable
+        case Hashable
     }
 
     static func type(_ value: MetaType) -> TokenSyntax {

diff --git a/...nerator/Snippets/String/StringsTable/Argument/StringStringsTableArgumentEnumSnippet.swift b/...nerator/Snippets/String/StringsTable/Argument/StringStringsTableArgumentEnumSnippet.swift
@@ -20,7 +20,7 @@ struct StringStringsTableArgumentEnumSnippet: Snippet {
     }
 
     var inheritanceClause: InheritanceClauseSyntax? {
-        InheritanceClauseSyntax(.Sendable)
+        InheritanceClauseSyntax(.Equatable, .Hashable, .Sendable)
     }
 }
 

diff --git a/...gGenerator/Snippets/String/StringsTable/StringStringsTableComparisonFunctionSnippet.swift b/...gGenerator/Snippets/String/StringsTable/StringStringsTableComparisonFunctionSnippet.swift
@@ -0,0 +1,59 @@
+import SwiftSyntax
+import SwiftSyntaxBuilder
+
+struct StringStringsTableComparisonFunctionSnippet: Snippet {
+    let stringsTable: SourceFile.StringExtension.StringsTableStruct
+    let leftArg: TokenSyntax = "lhs"
+    let rightArg: TokenSyntax = "rhs"
+
+    var syntax: some DeclSyntaxProtocol {
+        FunctionDeclSyntax(
+            modifiers: modifiers,
+            name: .binaryOperator("=="),
+            signature: FunctionSignatureSyntax(
+                parameterClause: FunctionParameterClauseSyntax {
+                    FunctionParameterSyntax(
+                        firstName: leftArg,
+                        type: IdentifierTypeSyntax(name: stringsTable.type)
+                    )
+                    FunctionParameterSyntax(
+                        firstName: rightArg,
+                        type: IdentifierTypeSyntax(name: stringsTable.type)
+                    )
+                },
+                returnClause: ReturnClauseSyntax(type: .identifier(.Bool))
+            ),
+            body: CodeBlockSyntax(statements: body)
+        )
+    }
+
+    @DeclModifierListBuilder
+    var modifiers: DeclModifierListSyntax {
+        DeclModifierSyntax(name: stringsTable.accessLevel.token)
+        DeclModifierSyntax(name: .keyword(.static))
+    }
+
+    var body: CodeBlockItemListSyntax {
+        // Array of `lhs.foo == rhs.foo`
+        var comparisons = stringsTable.comparableProperties.map { property in
+            InfixOperatorExprSyntax(
+                leftOperand: MemberAccessExprSyntax(leftArg, property.name),
+                operator: BinaryOperatorExprSyntax(operator: .binaryOperator("==")),
+                rightOperand: MemberAccessExprSyntax(rightArg, property.name)
+            )
+        }
+
+        var next = comparisons.removeLast()
+        while !comparisons.isEmpty {
+            let left = comparisons.removeLast()
+
+            next = InfixOperatorExprSyntax(
+                leftOperand: left,
+                operator: BinaryOperatorExprSyntax(operator: .binaryOperator("&&")),
+                rightOperand: next
+            )
+        }
+
+        return [CodeBlockItemSyntax(item: .expr(ExprSyntax(next)))]
+    }
+}
diff --git a/...ingGenerator/Snippets/String/StringsTable/StringStringsTableHashIntoFunctionSnippet.swift b/...ingGenerator/Snippets/String/StringsTable/StringStringsTableHashIntoFunctionSnippet.swift
@@ -0,0 +1,43 @@
+import SwiftSyntax
+import SwiftSyntaxBuilder
+
+struct StringStringsTableHashIntoFunctionSnippet: Snippet {
+    let stringsTable: SourceFile.StringExtension.StringsTableStruct
+    let hasherToken: TokenSyntax = "hasher"
+
+    var syntax: some DeclSyntaxProtocol {
+        FunctionDeclSyntax(
+            modifiers: modifiers,
+            name: "hash",
+            signature: FunctionSignatureSyntax(
+                parameterClause: FunctionParameterClauseSyntax {
+                    FunctionParameterSyntax(
+                        firstName: "into",
+                        secondName: hasherToken,
+                        type: AttributedTypeSyntax(
+                            specifiers: TypeSpecifierListSyntax {
+                                SimpleTypeSpecifierSyntax(specifier: .keyword(.inout))
+                            },
+                            baseType: IdentifierTypeSyntax(name: .type(.Hasher))
+                        )
+                    )
+                }
+            ),
+            body: CodeBlockSyntax(statements: body)
+        )
+    }
+
+    @DeclModifierListBuilder
+    var modifiers: DeclModifierListSyntax {
+        DeclModifierSyntax(name: stringsTable.accessLevel.token)
+    }
+
+    @CodeBlockItemListBuilder
+    var body: CodeBlockItemListSyntax {
+        for property in stringsTable.comparableProperties {
+            FunctionCallExprSyntax(callee: MemberAccessExprSyntax(hasherToken, "combine")) {
+                LabeledExprSyntax(expression: DeclReferenceExprSyntax(baseName: property.name))
+            }
+        }
+    }
+}
diff --git a/Sources/StringGenerator/Snippets/String/StringsTable/StringStringsTableStructSnippet.swift b/Sources/StringGenerator/Snippets/String/StringsTable/StringStringsTableStructSnippet.swift
@@ -22,7 +22,7 @@ struct StringStringsTableStructSnippet: Snippet {
     }
 
     var inheritanceClause: InheritanceClauseSyntax? {
-        InheritanceClauseSyntax(.Sendable)
+        InheritanceClauseSyntax(.Equatable, .Hashable, .Sendable)
     }
 
     var memberBlock: MemberBlockSyntax {
@@ -112,6 +112,20 @@ struct StringStringsTableStructSnippet: Snippet {
             StringStringsTableUnderscoredKeyComputedPropertySnippet(
                 stringsTable: stringsTable
             )
+            .syntax
+            .with(\.trailingTrivia, .newlines(2))
+
+            // func hash(into hasher: Hasher) { ... }
+            StringStringsTableHashIntoFunctionSnippet(
+                stringsTable: stringsTable
+            )
+            .syntax
+            .with(\.trailingTrivia, .newlines(2))
+
+            // static func ==(lhs: Localizable, rhs: Localizable) -> Bool { ... }
+            StringStringsTableComparisonFunctionSnippet(
+                stringsTable: stringsTable
+            )
         }
     }
 

diff --git a/Tests/PluginTests/PluginTests.swift b/Tests/PluginTests/PluginTests.swift
@@ -65,4 +65,14 @@ final class PluginTests: XCTestCase {
             "Hello John, I have 1 plural"
         )
     }
+
+    func testComparisons() {
+        let foo1 = String.Localizable.demoBasic
+        let foo2 = String.Localizable.demoBasic
+        XCTAssertEqual(foo1, foo2)
+
+        let bar1 = String.Localizable.multiline(1)
+        let bar2 = String.Localizable.multiline(2)
+        XCTAssertNotEqual(bar1, bar2)
+    }
 }
diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.FormatSpecifiers.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.FormatSpecifiers.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct FormatSpecifiers: Sendable {
+    internal struct FormatSpecifiers: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -335,6 +335,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: FormatSpecifiers, rhs: FormatSpecifiers) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(formatSpecifiers: FormatSpecifiers, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Localizable.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Localizable.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Localizable: Sendable {
+    internal struct Localizable: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -196,6 +196,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Localizable, rhs: Localizable) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(localizable: Localizable, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Multiline.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Multiline.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Multiline: Sendable {
+    internal struct Multiline: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -142,6 +142,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Multiline, rhs: Multiline) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(multiline: Multiline, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Positional.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Positional.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Positional: Sendable {
+    internal struct Positional: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -174,6 +174,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Positional, rhs: Positional) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(positional: Positional, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Simple.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Simple.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Simple: Sendable {
+    internal struct Simple: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -137,6 +137,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Simple, rhs: Simple) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(simple: Simple, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Substitution.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Substitution.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Substitution: Sendable {
+    internal struct Substitution: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -141,6 +141,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Substitution, rhs: Substitution) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(substitution: Substitution, locale: Locale? = nil) {

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Variations.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Variations.swift
@@ -47,13 +47,13 @@ extension String {
     /// ```
     ///
     /// - SeeAlso: [XCStrings Tool Documentation - Using the generated source code](https://swiftpackageindex.com/liamnichols/xcstrings-tool/0.5.2/documentation/documentation/using-the-generated-source-code)
-    internal struct Variations: Sendable {
+    internal struct Variations: Equatable, Hashable, Sendable {
         #if !SWIFT_PACKAGE
         private class BundleLocator {
         }
         #endif
 
-        enum Argument: Sendable {
+        enum Argument: Equatable, Hashable, Sendable {
             case int(Int)
             case uint(UInt)
             case float(Float)
@@ -152,6 +152,16 @@ extension String {
         fileprivate var _key: String {
             String(describing: key)
         }
+
+        internal func hash(into hasher: inout Hasher) {
+            hasher.combine(_key)
+            hasher.combine(arguments)
+            hasher.combine(table)
+        }
+
+        internal static func ==(lhs: Variations, rhs: Variations) -> Bool {
+            lhs._key == rhs._key && lhs.arguments == rhs.arguments && lhs.table == rhs.table
+        }
     }
 
     internal init(variations: Variations, locale: Locale? = nil) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,7 @@ struct StringStringsTableArgumentEnumSnippet: Snippet { @@
         }
         var inheritanceClause: InheritanceClauseSyntax? {
-            InheritanceClauseSyntax(.Sendable)
+            InheritanceClauseSyntax(.Equatable, .Hashable, .Sendable)
         }
     }
@@ Expand Down @@