Merge pull request #54 from daangn/feature/elon/IOS-1269-add-AddComponentModifier-macro

IOS-1269 feat: add AddComponentModifier Macro

Author: ElonPark

.github/workflows/ci-sampleapp.yml

@@ -11,7 +11,7 @@ on:
   workflow_dispatch:
 
 concurrency:
-  group: ${{ github.head_ref || github.run_id }}
+  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}-${{ github.job }}"
   cancel-in-progress: true
 
 jobs:
@@ -29,9 +29,13 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Setup Xcode Version
-        run: sudo xcode-select --switch /Applications/Xcode_16.4.app/Contents/Developer
+        run: sudo xcode-select --switch /Applications/Xcode_16.4.app
         shell: bash
 
+      - name: Set Swift Syntax Prebuilts
+        run: |
+          defaults write com.apple.dt.Xcode IDEPackageEnablePrebuilts YES
+
       - name: Run `build-for-testing`
         run: |
           set -o pipefail && xcodebuild build-for-testing \

.github/workflows/ci.yml

@@ -10,12 +10,17 @@ on:
   workflow_dispatch:
 
 concurrency:
-  group: ${{ github.head_ref || github.run_id }}
+  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}-${{ github.job }}"
   cancel-in-progress: true
 
 jobs:
   build_and_test:
+    name: Build and Test
     runs-on: macos-15
+    strategy:
+      matrix:
+        xcode: ['16.4']
+        config: ['Debug', 'Release']
 
     env:
       SCHEME: KarrotListKit
@@ -24,22 +29,38 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Xcode Version
-        run: sudo xcode-select --switch /Applications/Xcode_16.4.app/Contents/Developer
+      - name: Setup Xcode ${{ matrix.xcode }}
+        run: sudo xcode-select --switch /Applications/Xcode_${{ matrix.xcode }}.app
         shell: bash
 
+      - name: Set Swift Syntax Prebuilts
+        run: |
+          defaults write com.apple.dt.Xcode IDEPackageEnablePrebuilts YES
+
       - name: Run `build-for-testing`
         run: |
           set -o pipefail && xcodebuild build-for-testing \
             -scheme "$SCHEME" \
             -destination "$DESTINATION" \
-            -configuration Debug \
+            -configuration ${{ matrix.config }} \
+            ENABLE_TESTABILITY=YES \
             | xcbeautify --renderer github-actions
 
       - name: Run `test-without-building`
         run: |
           set -o pipefail && xcodebuild test-without-building \
             -scheme "$SCHEME" \
             -destination "$DESTINATION" \
-            -configuration Debug \
+            -configuration ${{ matrix.config }} \
+            ENABLE_TESTABILITY=YES \
             | xcbeautify --renderer github-actions
+
+  check-macro-compatibility:
+    name: Check Macro Compatibility
+    runs-on: macos-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run Swift Macro Compatibility Check
+        uses: Matejkob/swift-macro-compatibility-check@v1

Examples/KarrotListKitSampleApp/KarrotListKitSampleApp.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -10,6 +10,18 @@ struct VerticalLayoutItemComponent: Component {
 
   let viewModel: ViewModel
 
+  @AddComponentModifier
+  var onTapButtonHandler: (() -> Void)?
+
+  @AddComponentModifier
+  var onTapButtonWithValueHandler: ((Int) -> Void)?
+
+  @AddComponentModifier
+  var onTapButtonWithValuesHandler: ((Int, String) -> Void)?
+
+  @AddComponentModifier
+  var onTapButtonWithNamedValuesHandler: ((_ intValue: Int, _ stringValue: String) -> Void)?
+
   init(viewModel: ViewModel) {
     self.viewModel = viewModel
   }

Examples/KarrotListKitSampleApp/KarrotListKitSampleApp/Samples/VerticalLayout/VerticalLayoutItemComponent.swift

@@ -1,18 +1,20 @@
-// swift-tools-version: 5.5
+// swift-tools-version: 5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
+import CompilerPluginSupport
 import PackageDescription
 
 let package = Package(
   name: "KarrotListKit",
-  platforms: [.iOS(.v13)],
+  platforms: [.iOS(.v13), .macOS(.v10_15)],
   products: [
     .library(
       name: "KarrotListKit",
       targets: ["KarrotListKit"]
     ),
   ],
   dependencies: [
+    .package(url: "https://github.com/swiftlang/swift-syntax.git", "509.0.0"..<"602.0.0"),
     .package(
       url: "https://github.com/ra1028/DifferenceKit.git",
       .upToNextMajor(from: "1.0.0")
@@ -23,11 +25,26 @@ let package = Package(
       name: "KarrotListKit",
       dependencies: [
         "DifferenceKit",
+        "KarrotListKitMacros",
+      ]
+    ),
+    .macro(
+      name: "KarrotListKitMacros",
+      dependencies: [
+        .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
+        .product(name: "SwiftCompilerPlugin", package: "swift-syntax"),
       ]
     ),
     .testTarget(
       name: "KarrotListKitTests",
       dependencies: ["KarrotListKit"]
     ),
+    .testTarget(
+      name: "KarrotListKitMacrosTests",
+      dependencies: [
+        "KarrotListKitMacros",
+        .product(name: "SwiftSyntaxMacrosTestSupport", package: "swift-syntax"),
+      ]
+    ),
   ]
 )

Package.resolved

@@ -3,10 +3,11 @@
 //
 
 import Combine
-import UIKit
-
 import DifferenceKit
 
+#if canImport(UIKit)
+import UIKit
+
 /// An adapter for `UICollectionView`
 ///
 /// The `CollectionViewAdapter` object serves as an adapter between the `UIColletionView` logic and the `KarrotListKit` logic
@@ -772,3 +773,4 @@ extension CollectionViewAdapter: UICollectionViewDataSource {
     }
   }
 }
+#endif

Package.swift

@@ -2,6 +2,7 @@
 //  Copyright (c) 2024 Danggeun Market Inc.
 //
 
+#if canImport(UIKit)
 import UIKit
 
 /// The configuration for the CollectionViewAdapter object.
@@ -67,3 +68,4 @@ extension CollectionViewAdapterConfiguration {
     }
   }
 }
+#endif

Sources/KarrotListKit/Adapter/CollectionViewAdapter.swift

@@ -2,6 +2,7 @@
 //  Copyright (c) 2024 Danggeun Market Inc.
 //
 
+#if canImport(UIKit)
 import UIKit
 
 /// A protocol that manage data and size information for List
@@ -88,3 +89,4 @@ public class CollectionViewLayoutAdapter: CollectionViewLayoutAdaptable {
     )
   }
 }
+#endif

Sources/KarrotListKit/Adapter/CollectionViewAdapterConfiguration.swift

@@ -4,6 +4,9 @@
 
 import Foundation
 
+#if canImport(UIKit)
+import CoreGraphics
+
 /// A protocol that defines the functionality for storing the sizes of components.
 public protocol ComponentSizeStorage {
 
@@ -79,3 +82,4 @@ final class ComponentSizeStorageImpl: ComponentSizeStorage {
     footerSizeStore[hash] = size
   }
 }
+#endif