fix: fixed IgnoreCoding failing with didSet accessors (#54)

SwiftyLab · Jan 10, 2024 · bd881c9 · bd881c9
1 parent 9d20fbf
commit bd881c9
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 114 deletions.
diff --git a/.github/config/spellcheck.yaml b/.github/config/spellcheck.yaml
@@ -16,5 +16,5 @@ matrix:
       - code
       - pre
   sources:
-  - '**/*.md'
+  - '**/*.md|!CHANGELOG.md'
   default_encoding: utf-8
diff --git a/Plugins/MetaProtocolCodable/Config.swift b/Plugins/MetaProtocolCodable/Config.swift
@@ -1,3 +1,5 @@
+@_implementationOnly import Foundation
+
 /// The configuration data for plugin.
 ///
 /// Depending on the configuration data, source file check and
@@ -43,4 +45,16 @@ extension Config: Codable {
                 ScanMode.self, forKey: .scan
             ) ?? .target
     }
+
+    static func url(forFilePath filePath: String) -> URL {
+        #if canImport(Darwin)
+        if #available(macOS 13, iOS 16, macCatalyst 16, tvOS 16, watchOS 9, *) {
+            return URL(filePath: filePath)
+        } else {
+            return URL(fileURLWithPath: filePath)
+        }
+        #else
+        return URL(fileURLWithPath: filePath)
+        #endif
+    }
 }
diff --git a/Plugins/MetaProtocolCodable/Plugin.swift b/Plugins/MetaProtocolCodable/Plugin.swift
@@ -1,5 +1,5 @@
-import Foundation
-import PackagePlugin
+@_implementationOnly import Foundation
+@_implementationOnly import PackagePlugin
 
 /// Provides `protocol` decoding/encoding syntax generation.
 ///
@@ -31,16 +31,7 @@ struct MetaProtocolCodable: BuildToolPlugin {
         }
         guard let file else { return .init(scan: .target) }
         let pathStr = target.directory.appending([file]).string
-        #if canImport(Darwin)
-        let path =
-            if #available(macOS 13, *) {
-                URL(filePath: pathStr)
-            } else {
-                URL(fileURLWithPath: pathStr)
-            }
-        #else
-        let path = URL(fileURLWithPath: pathStr)
-        #endif
+        let path = Config.url(forFilePath: pathStr)
         let conf = try Data(contentsOf: path)
         let pConf = try? PropertyListDecoder().decode(Config.self, from: conf)
         let config = try pConf ?? JSONDecoder().decode(Config.self, from: conf)

diff --git a/Sources/PluginCore/Diagnostics/UninitializedVariableDecl.swift b/Sources/PluginCore/Diagnostics/UninitializedVariableDecl.swift
@@ -75,7 +75,8 @@ struct UninitializedVariableDecl<Attr: PropertyAttribute>: DiagnosticProducer {
                 // && !accessors.contains { decl in
                 //     decl.accessorKind.tokenKind == .keyword(.`init`)
                 // }
-                guard !computed else { continue }
+                guard computed else { fallthrough }
+                continue
             default:
                 guard binding.initializer == nil else { continue }
             }

diff --git a/Sources/ProtocolGen/Config.swift b/Sources/ProtocolGen/Config.swift
diff --git a/Sources/ProtocolGen/Config.swift b/Sources/ProtocolGen/Config.swift
@@ -0,0 +1 @@
+../../Plugins/MetaProtocolCodable/Config.swift
diff --git a/Sources/ProtocolGen/Fetch.swift b/Sources/ProtocolGen/Fetch.swift
@@ -25,16 +25,7 @@ extension ProtocolGen {
         /// Performs asynchronous config data fetch and
         /// prints to console in `JSON` format.
         func run() async throws {
-            #if canImport(Darwin)
-            let path =
-                if #available(macOS 13, *) {
-                    URL(filePath: path)
-                } else {
-                    URL(fileURLWithPath: path)
-                }
-            #else
-            let path = URL(fileURLWithPath: path)
-            #endif
+            let path = Config.url(forFilePath: path)
             let data = try Data(contentsOf: path)
             let config =
                 if let config = try? JSONDecoder().decode(

diff --git a/Sources/ProtocolGen/Generate.swift b/Sources/ProtocolGen/Generate.swift
@@ -285,16 +285,7 @@ extension ProtocolGen {
         /// Generates `HelperCoder` implementations
         /// for stored protocol datas.
         func run() async throws {
-            #if canImport(Darwin)
-            let inputs =
-                if #available(macOS 13, *) {
-                    inputs.map { URL(filePath: $0) }
-                } else {
-                    inputs.map { URL(fileURLWithPath: $0) }
-                }
-            #else
-            let inputs = inputs.map { URL(fileURLWithPath: $0) }
-            #endif
+            let inputs = inputs.map { Config.url(forFilePath: $0) }
 
             let data = try await fetchInputData(input: inputs)
             let context = BasicMacroExpansionContext()

diff --git a/Sources/ProtocolGen/Parse.swift b/Sources/ProtocolGen/Parse.swift
@@ -120,23 +120,8 @@ extension ProtocolGen {
         /// Performs parsing of swift source files and storing
         /// `SourceData` in JSON format in `output` file path.
         func run() async throws {
-            #if canImport(Darwin)
-            let input =
-                if #available(macOS 13, *) {
-                    URL(filePath: input)
-                } else {
-                    URL(fileURLWithPath: input)
-                }
-            let output =
-                if #available(macOS 13, *) {
-                    URL(filePath: output)
-                } else {
-                    URL(fileURLWithPath: output)
-                }
-            #else
-            let input = URL(fileURLWithPath: input)
-            let output = URL(fileURLWithPath: output)
-            #endif
+            let input = Config.url(forFilePath: input)
+            let output = Config.url(forFilePath: output)
             let sourceData = try Data(contentsOf: input)
             let sourceText = String(data: sourceData, encoding: .utf8)!
             let sourceFile = Parser.parse(source: sourceText)

diff --git a/Tests/MetaCodableTests/CodableTests.swift b/Tests/MetaCodableTests/CodableTests.swift
@@ -7,7 +7,6 @@ import SwiftSyntaxMacrosTestSupport
 import XCTest
 
 @testable import PluginCore
-@testable import MacroPlugin
 
 final class CodableTests: XCTestCase {
 
@@ -310,6 +309,42 @@ final class CodableTests: XCTestCase {
     }
 }
 
+#if canImport(MacroPlugin)
+@testable import MacroPlugin
+
+let allMacros: [String: Macro.Type] = [
+    "CodedAt": MacroPlugin.CodedAt.self,
+    "CodedIn": MacroPlugin.CodedIn.self,
+    "Default": MacroPlugin.Default.self,
+    "CodedBy": MacroPlugin.CodedBy.self,
+    "CodedAs": MacroPlugin.CodedAs.self,
+    "ContentAt": MacroPlugin.ContentAt.self,
+    "IgnoreCoding": MacroPlugin.IgnoreCoding.self,
+    "IgnoreDecoding": MacroPlugin.IgnoreDecoding.self,
+    "IgnoreEncoding": MacroPlugin.IgnoreEncoding.self,
+    "Codable": MacroPlugin.Codable.self,
+    "MemberInit": MacroPlugin.MemberInit.self,
+    "CodingKeys": MacroPlugin.CodingKeys.self,
+    "IgnoreCodingInitialized": MacroPlugin.IgnoreCodingInitialized.self,
+]
+#else
+let allMacros: [String: Macro.Type] = [
+    "CodedAt": CodedAt.self,
+    "CodedIn": CodedIn.self,
+    "Default": Default.self,
+    "CodedBy": CodedBy.self,
+    "CodedAs": CodedAs.self,
+    "ContentAt": ContentAt.self,
+    "IgnoreCoding": IgnoreCoding.self,
+    "IgnoreDecoding": IgnoreDecoding.self,
+    "IgnoreEncoding": IgnoreEncoding.self,
+    "Codable": Codable.self,
+    "MemberInit": MemberInit.self,
+    "CodingKeys": CodingKeys.self,
+    "IgnoreCodingInitialized": IgnoreCodingInitialized.self,
+]
+#endif
+
 func assertMacroExpansion(
     _ originalSource: String,
     expandedSource: String,
@@ -321,25 +356,10 @@ func assertMacroExpansion(
     file: StaticString = #file,
     line: UInt = #line
 ) {
-    let macros: [String: Macro.Type] = [
-        "CodedAt": MacroPlugin.CodedAt.self,
-        "CodedIn": MacroPlugin.CodedIn.self,
-        "Default": MacroPlugin.Default.self,
-        "CodedBy": MacroPlugin.CodedBy.self,
-        "CodedAs": MacroPlugin.CodedAs.self,
-        "ContentAt": MacroPlugin.ContentAt.self,
-        "IgnoreCoding": MacroPlugin.IgnoreCoding.self,
-        "IgnoreDecoding": MacroPlugin.IgnoreDecoding.self,
-        "IgnoreEncoding": MacroPlugin.IgnoreEncoding.self,
-        "Codable": MacroPlugin.Codable.self,
-        "MemberInit": MacroPlugin.MemberInit.self,
-        "CodingKeys": MacroPlugin.CodingKeys.self,
-        "IgnoreCodingInitialized": MacroPlugin.IgnoreCodingInitialized.self,
-    ]
     assertMacroExpansion(
         originalSource, expandedSource: expandedSource,
         diagnostics: diagnostics,
-        macroSpecs: macros.mapValues { value in
+        macroSpecs: allMacros.mapValues { value in
             return MacroSpec(type: value, conformances: conformances)
         },
         testModuleName: testModuleName, testFileName: testFileName,

diff --git a/Tests/MetaCodableTests/IgnoreCodingTests.swift b/Tests/MetaCodableTests/IgnoreCodingTests.swift
@@ -18,6 +18,12 @@ final class IgnoreCodingTests: XCTestCase {
                 var three: String { "some" }
                 @IgnoreDecoding
                 var four: String { get { "some" } }
+                @IgnoreCoding
+                var five: String = "some" {
+                    didSet {
+                        print(five)
+                    }
+                }
             }
             """,
             expandedSource:
@@ -27,6 +33,11 @@ final class IgnoreCodingTests: XCTestCase {
                     var two: String
                     var three: String { "some" }
                     var four: String { get { "some" } }
+                    var five: String = "some" {
+                        didSet {
+                            print(five)
+                        }
+                    }
                 }
 
                 extension SomeCodable: Decodable {