Merge pull request #1 from RakuyoKit/feature/add-tools

Add toolchains and more

Author: rakuyoMo

.github/workflows/build.yaml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Swift Build
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Xcode ${{ matrix.xcode }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-14]
+        xcode: ["15"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: ${{ matrix.xcode }}
+      - name: Lint
+        run: rake swift:lint
+      - name: Test
+        run: rake swift:test

.gitignore

@@ -1,3 +1,39 @@
+# Created by https://www.toptal.com/developers/gitignore/api/macos,objective-c,swift,swiftpackagemanager,xcode
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,objective-c,swift,swiftpackagemanager,xcode
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Objective-C ###
 # Xcode
 #
 # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
@@ -30,37 +66,73 @@ DerivedData/
 *.dSYM.zip
 *.dSYM
 
+# CocoaPods
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# Pods/
+# Add this line if you want to avoid checking in source code from the Xcode workspace
+# *.xcworkspace
+
+# Carthage
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+
+Carthage/Build/
+
+# fastlane
+# It is recommended to not store the screenshots in the git repo.
+# Instead, use fastlane to re-generate the screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/#source-control
+
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots/**/*.png
+fastlane/test_output
+
+# Code Injection
+# After new code Injection tools there's a generated folder /iOSInjectionProject
+# https://github.com/johnno1962/injectionforxcode
+
+iOSInjectionProject/
+
+### Objective-C Patch ###
+
+### Swift ###
+# Xcode
+# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
+
+
+
+
+
+
 ## Playgrounds
 timeline.xctimeline
 playground.xcworkspace
 
 # Swift Package Manager
-#
 # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
 # Packages/
 # Package.pins
 # Package.resolved
 # *.xcodeproj
-#
 # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
 # hence it is not needed unless you have added a package configuration file to your project
-# .swiftpm
 
+.swiftpm
 .build/
 
 # CocoaPods
-#
 # We recommend against adding the Pods directory to your .gitignore. However
 # you should judge for yourself, the pros and cons are mentioned at:
 # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-Pods/
-#
+# Pods/
 # Add this line if you want to avoid checking in source code from the Xcode workspace
 # *.xcworkspace
 
 # Carthage
-#
 # Add this line if you want to avoid checking in source code from Carthage dependencies.
 # Carthage/Checkouts
 
@@ -71,30 +143,38 @@ Dependencies/
 .accio/
 
 # fastlane
-#
 # It is recommended to not store the screenshots in the git repo.
 # Instead, use fastlane to re-generate the screenshots whenever they are needed.
 # For more information about the recommended setup visit:
 # https://docs.fastlane.tools/best-practices/source-control/#source-control
 
-fastlane/report.xml
-fastlane/Preview.html
-fastlane/screenshots/**/*.png
-fastlane/test_output
 
 # Code Injection
-#
 # After new code Injection tools there's a generated folder /iOSInjectionProject
 # https://github.com/johnno1962/injectionforxcode
 
-iOSInjectionProject/
-.DS_Store
 
-# For SPM
+### SwiftPackageManager ###
+Packages
+xcuserdata
+*.xcodeproj
+
+
+### Xcode ###
+
+## Xcode 8 and earlier
+
+### Xcode Patch ###
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcodeproj/project.xcworkspace/
+!*.xcworkspace/contents.xcworkspacedata
+/*.gcno
+**/xcshareddata/WorkspaceSettings.xcsettings
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,objective-c,swift,swiftpackagemanager,xcode
 
-/.build
-/Packages
-/*.xcodeproj
-.swiftpm/config/registries.json
-.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
-.netrc
+### Projects ###
+*.xcodeproj
+*.xcworkspace

.mise.toml

@@ -0,0 +1,2 @@
+[tools]
+pre-commit = "3.7.0"

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+default_install_hook_types: [pre-commit, pre-push]
+fail_fast: true
+
+repos:
+-   repo: local
+    hooks:
+    - id: lint
+      name: Run Lint
+      language: system
+      entry: rake swift:lint
+      stages: [pre-commit]
+      verbose: true
+    - id: test
+      name: Run Test
+      language: system
+      entry: rake swift:test
+      stages: [pre-push]
+      verbose: true

Demo.playground/Pages/Advanced.xcplaygroundpage/Contents.swift

@@ -6,16 +6,17 @@ import Foundation
 
 import APIWrapper
 
-/*:
- The `RaAPIWrapper` is extremely extensible.
- You can work with the `userInfo` property to customize the api parameters you need.
- 
- The `RaAPIWrapper/AF` module then takes advantage of this feature and supports the `ParameterEncoding` field of `Alamofire`.
- 
- The following code demonstrates how to add a custom parameter to `API`:
- */
-
-// will be used later as a custom parameter of the api.
+// MARK: - VerificationType
+
+/// :
+/// The `RaAPIWrapper` is extremely extensible.
+/// You can work with the `userInfo` property to customize the api parameters you need.
+///
+/// The `RaAPIWrapper/AF` module then takes advantage of this feature and supports the `ParameterEncoding` field of `Alamofire`.
+///
+/// The following code demonstrates how to add a custom parameter to `API`:
+
+/// will be used later as a custom parameter of the api.
 enum VerificationType: Hashable {
     case normal
     case special
@@ -35,12 +36,13 @@ extension API {
     }
 }
 
+// MARK: - AdvancedAPI
+
 enum AdvancedAPI {
     /// Finally, the new initialization method declared above is called on
     /// the property wrapper to complete the interface definition.
     @GET("/api", verification: .normal)
     static var testAPI: APIParameterBuilder<()>? = nil
 }
 
-
 //: [Next](@next)

Demo.playground/Pages/Basic.xcplaygroundpage/Contents.swift

@@ -4,11 +4,12 @@ import Foundation
 
 import APIWrapper
 
-/*:
- This example uses [Postman Echo](https://www.postman.com/postman/workspace/published-postman-templates/documentation/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65?ctx=documentation) as the sample api.
- 
- The return value of this api depends on the parameters and will return the parameters, headers and other data as is.
- */
+// MARK: - BasicAPI
+
+/// :
+/// This example uses [Postman Echo](https://www.postman.com/postman/workspace/published-postman-templates/documentation/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65?ctx=documentation) as the sample api.
+///
+/// The return value of this api depends on the parameters and will return the parameters, headers and other data as is.
 
 //: To begin by showing some of the most basic uses, look at how the api is defined.
 
@@ -26,12 +27,12 @@ enum BasicAPI {
 do {
     // Requests the api and parses the return value of the interface. Note the use of the `$` character.
     let response = try await BasicAPI.$get.request(to: PostManResponse<Arg>.self)
-    
+
     // You can also ignore the return value and focus only on the act of requesting the api itself.
     try await BasicAPI.$get.request()
-    
+
 } catch {
-    print("❌ get request failure: \(error)")
+    Log.log("❌ get request failure: \(error)")
 }
 
 //: The api with parameters is a little more complicated to define:
@@ -45,10 +46,10 @@ extension BasicAPI {
     static var postWithTuple: APIParameterBuilder<(foo1: String, foo2: Int?)>? = .init {
         [
             "foo1": $0.foo1,
-            "foo2": $0.foo2
+            "foo2": $0.foo2,
         ]
     }
-    
+
     /// This is an api for requests using the **POST** method.
     ///
     /// The full api address is: [](https://postman-echo.com/post) .
@@ -59,18 +60,19 @@ extension BasicAPI {
 
 do {
     // Request the api and parse the return value.
-    let tupleAPIResponse = try await BasicAPI.$postWithTuple.request(with: (foo1: "foo1", foo2: nil), to: PostManResponse<Arg>.self)
-    
-    /**
-     *  If you look at the return value, you will see that `foo2` is not passed to the server.
-     *  This is because `RaAPIWrapper` filters out all parameters with the value `nil`.
-     */
-    
+    let tupleAPIResponse = try await BasicAPI.$postWithTuple.request(
+        with: (foo1: "foo1", foo2: nil),
+        to: PostManResponse<Arg>.self
+    )
+
+    ///  If you look at the return value, you will see that `foo2` is not passed to the server.
+    ///  This is because `RaAPIWrapper` filters out all parameters with the value `nil`.
+
     // Try using model as a parameter and you will get the same result.
     let modelAPIResponse = try await BasicAPI.$postWithModel.request(with: .init(foo2: "foo2"), to: PostManResponse<Arg>.self)
-    
+
 } catch {
-    print("❌ post request failure: \(error)")
+    Log.log("❌ post request failure: \(error)")
 }
 
 //: [Next](@next)