fix: fixed failure in structs with static members (by @Midbin) (#37)

Sources/CodableMacroPlugin/Attributes/CodedBy.swift

@@ -38,6 +38,8 @@ struct CodedBy: PropertyAttribute {
     /// The following conditions are checked by the
     /// built diagnoser:
     /// * Attached declaration is a variable declaration.
+    /// * Attached declaration is not a static variable
+    ///   declaration
     /// * Macro usage is not duplicated for the same
     ///   declaration.
     /// * This attribute isn't used combined with
@@ -47,6 +49,7 @@ struct CodedBy: PropertyAttribute {
     func diagnoser() -> DiagnosticProducer {
         return AggregatedDiagnosticProducer {
             expect(syntax: VariableDeclSyntax.self)
+            attachedToNonStaticVariable()
             cantDuplicate()
             cantBeCombined(with: IgnoreCoding.self)
         }

Sources/CodableMacroPlugin/Attributes/Default.swift

@@ -37,6 +37,8 @@ struct Default: PropertyAttribute {
     /// The following conditions are checked by the
     /// built diagnoser:
     /// * Attached declaration is a variable declaration.
+    /// * Attached declaration is not a static variable
+    ///   declaration
     /// * Macro usage is not duplicated for the same
     ///   declaration.
     /// * This attribute isn't used combined with
@@ -46,6 +48,7 @@ struct Default: PropertyAttribute {
     func diagnoser() -> DiagnosticProducer {
         return AggregatedDiagnosticProducer {
             expect(syntax: VariableDeclSyntax.self)
+            attachedToNonStaticVariable()
             cantDuplicate()
             cantBeCombined(with: IgnoreCoding.self)
         }

Sources/CodableMacroPlugin/Attributes/KeyPath/CodedAt.swift

@@ -37,13 +37,16 @@ struct CodedAt: PropertyAttribute {
     ///   declaration.
     /// * Attached declaration is not a grouped variable
     ///   declaration.
+    /// * Attached declaration is not a static variable
+    ///   declaration
     /// * This attribute isn't used combined with `CodedIn`
     ///   and `IgnoreCoding` attribute.
     ///
     /// - Returns: The built diagnoser instance.
     func diagnoser() -> DiagnosticProducer {
         return AggregatedDiagnosticProducer {
             attachedToUngroupedVariable()
+            attachedToNonStaticVariable()
             cantDuplicate()
             cantBeCombined(with: CodedIn.self)
             cantBeCombined(with: IgnoreCoding.self)

Sources/CodableMacroPlugin/Attributes/KeyPath/CodedIn.swift

@@ -48,6 +48,8 @@ struct CodedIn: PropertyAttribute {
     /// * Attached declaration is a variable declaration.
     /// * Macro usage is not duplicated for the same
     ///   declaration.
+    /// * Attached declaration is not a static variable
+    ///   declaration
     /// * This attribute isn't used combined with `CodedAt`
     ///   and `IgnoreCoding` attribute.
     ///
@@ -56,6 +58,7 @@ struct CodedIn: PropertyAttribute {
         return AggregatedDiagnosticProducer {
             expect(syntax: VariableDeclSyntax.self)
             cantDuplicate()
+            attachedToNonStaticVariable()
             cantBeCombined(with: CodedAt.self)
             cantBeCombined(with: IgnoreCoding.self)
         }

Sources/CodableMacroPlugin/Attributes/RegistrationAttribute.swift

@@ -42,6 +42,14 @@ extension RegistrationAttribute {
             guard let decl = member.decl.as(VariableDeclSyntax.self)
             else { return }
 
+            // The Macro fails to compile if the decl.modifiers.contains
+            // is directly used in the guard statement. Otherwise it should
+            // be used as a second condition in guard block above.
+            let isStatic = decl.modifiers.contains {
+                $0.name.tokenKind == .keyword(.static)
+            }
+            guard !isStatic else { return }
+
             // builder
             let builder =
                 CodingKeys(from: declaration)

Sources/CodableMacroPlugin/Diagnostics/StaticVariableDeclaration.swift

@@ -0,0 +1,72 @@
+@_implementationOnly import SwiftDiagnostics
+@_implementationOnly import SwiftSyntax
+@_implementationOnly import SwiftSyntaxMacros
+
+/// A diagnostic producer type that can validate passed syntax is not a static
+/// variable declaration.
+///
+/// This producer can be used for macro-attributes that must be attached to
+/// non static variable declarations.
+struct StaticVariableDeclaration<Attr: PropertyAttribute>: DiagnosticProducer {
+    /// The attribute for which
+    /// validation performed.
+    ///
+    /// Uses this attribute name
+    /// in generated diagnostic
+    /// messages.
+    let attr: Attr
+
+    /// Creates a static variable declaration validation instance
+    /// with provided attribute.
+    ///
+    /// - Parameter attr: The attribute for which
+    ///   validation performed.
+    /// - Returns: Newly created diagnostic producer.
+    init(_ attr: Attr) {
+        self.attr = attr
+    }
+
+    /// Validates and produces diagnostics for the passed syntax
+    /// in the macro expansion context provided.
+    ///
+    /// Checks whether provided syntax is a non static variable declaration,
+    /// for static variable declarations error diagnostics
+    /// are generated.
+    ///
+    /// - Parameters:
+    ///   - syntax: The syntax to validate and produce diagnostics for.
+    ///   - context: The macro expansion context diagnostics produced in.
+    ///
+    /// - Returns: True if syntax fails validation, false otherwise.
+    @discardableResult
+    func produce(
+        for syntax: some SyntaxProtocol,
+        in context: some MacroExpansionContext
+    ) -> Bool {
+        // The Macro fails to compile if the .modifiers.contains
+        // is directly used in the guard statement.
+        let isStatic = syntax.as(VariableDeclSyntax.self)?
+            .modifiers.contains { $0.name.tokenKind == .keyword(.static) }
+        guard isStatic ?? false else { return false }
+        let message = attr.node.diagnostic(
+            message:
+                "@\(attr.name) can't be used with static variables declarations",
+            id: attr.misuseMessageID,
+            severity: .error
+        )
+        context.diagnose(attr: attr, message: message)
+        return true
+    }
+}
+
+extension PropertyAttribute {
+    /// Indicates attribute must be attached to non static variable declaration.
+    ///
+    /// The created diagnostic producer produces error diagnostic,
+    /// if attribute is attached to static variable declarations.
+    ///
+    /// - Returns: Static variable declaration validation diagnostic producer.
+    func attachedToNonStaticVariable() -> StaticVariableDeclaration<Self> {
+        return .init(self)
+    }
+}

Tests/MetaCodableTests/CodableTests.swift

@@ -72,6 +72,47 @@ final class CodableTests: XCTestCase {
         )
     }
 
+    func testWithoutAnyCustomizationWithStaticVar() throws {
+        assertMacroExpansion(
+            """
+            @Codable
+            struct SomeCodable {
+                let value: String
+                static let otherValue: String
+                public private(set) static var valueWithModifiers: String
+            }
+            """,
+            expandedSource:
+                """
+                struct SomeCodable {
+                    let value: String
+                    static let otherValue: String
+                    public private(set) static var valueWithModifiers: String
+                }
+
+                extension SomeCodable: Decodable {
+                    init(from decoder: any Decoder) throws {
+                        let container = try decoder.container(keyedBy: CodingKeys.self)
+                        self.value = try container.decode(String.self, forKey: CodingKeys.value)
+                    }
+                }
+
+                extension SomeCodable: Encodable {
+                    func encode(to encoder: any Encoder) throws {
+                        var container = encoder.container(keyedBy: CodingKeys.self)
+                        try container.encode(self.value, forKey: CodingKeys.value)
+                    }
+                }
+
+                extension SomeCodable {
+                    enum CodingKeys: String, CodingKey {
+                        case value = "value"
+                    }
+                }
+                """
+        )
+    }
+
     func testOnlyDecodeConformance() throws {
         assertMacroExpansion(
             """

Tests/MetaCodableTests/CodedAtTests.swift

@@ -56,6 +56,82 @@ final class CodedAtTests: XCTestCase {
         )
     }
 
+    func testMisuseOnStaticVariableDeclaration() throws {
+        assertMacroExpansion(
+            """
+            struct SomeCodable {
+                @CodedAt
+                static let value: String
+            }
+            """,
+            expandedSource:
+                """
+                struct SomeCodable {
+                    static let value: String
+                }
+                """,
+            diagnostics: [
+                .init(
+                    id: CodedAt.misuseID,
+                    message:
+                        "@CodedAt can't be used with static variables declarations",
+                    line: 2, column: 5,
+                    fixIts: [
+                        .init(message: "Remove @CodedAt attribute")
+                    ]
+                )
+            ]
+        )
+    }
+
+    func testMisuseOnStaticWithCodedByDefaultVariableDeclaration() throws {
+        assertMacroExpansion(
+            """
+            struct SomeCodable {
+                @Default("some")
+                @CodedBy(Since1970DateCoder())
+                @CodedAt
+                static let value: String
+            }
+            """,
+            expandedSource:
+                """
+                struct SomeCodable {
+                    static let value: String
+                }
+                """,
+            diagnostics: [
+                .init(
+                    id: Default.misuseID,
+                    message:
+                        "@Default can't be used with static variables declarations",
+                    line: 2, column: 5,
+                    fixIts: [
+                        .init(message: "Remove @Default attribute")
+                    ]
+                ),
+                .init(
+                    id: CodedBy.misuseID,
+                    message:
+                        "@CodedBy can't be used with static variables declarations",
+                    line: 3, column: 5,
+                    fixIts: [
+                        .init(message: "Remove @CodedBy attribute")
+                    ]
+                ),
+                .init(
+                    id: CodedAt.misuseID,
+                    message:
+                        "@CodedAt can't be used with static variables declarations",
+                    line: 4, column: 5,
+                    fixIts: [
+                        .init(message: "Remove @CodedAt attribute")
+                    ]
+                ),
+            ]
+        )
+    }
+
     func testMisuseInCombinationWithCodedInMacro() throws {
         assertMacroExpansion(
             """

Tests/MetaCodableTests/CodedInTests.swift

@@ -35,6 +35,34 @@ final class CodedInTests: XCTestCase {
         )
     }
 
+    func testMisuseOnStaticVariableDeclaration() throws {
+        assertMacroExpansion(
+            """
+            struct SomeCodable {
+                @CodedIn
+                static let value: String
+            }
+            """,
+            expandedSource:
+                """
+                struct SomeCodable {
+                    static let value: String
+                }
+                """,
+            diagnostics: [
+                .init(
+                    id: CodedIn.misuseID,
+                    message:
+                        "@CodedIn can't be used with static variables declarations",
+                    line: 2, column: 5,
+                    fixIts: [
+                        .init(message: "Remove @CodedIn attribute")
+                    ]
+                )
+            ]
+        )
+    }
+
     func testDuplicatedMisuse() throws {
         assertMacroExpansion(
             """