Merge pull request #35 from k-kohey/fix/module_name

k-kohey · web-flow · commit 5d888b07f7e5 · 2023-06-03T20:21:52.000+09:00
Fix module name
diff --git a/.github/workflows/docc.yml b/.github/workflows/docc.yml
@@ -2,31 +2,31 @@ name: docc
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   deploy:
     runs-on: macos-12
     steps:
       - uses: actions/checkout@v3
-      - name: make directory docs/ 
+      - name: make directory docs/
         run: |
+          mkdir -p docs/ParchmentCore
           mkdir -p docs/Parchment
-          mkdir -p docs/ParchmentDefault
+      - name: run generate-documentation for ParchmentCore
+        run: swift package --allow-writing-to-directory docs/ParchmentCore
+          generate-documentation --target ParchmentCore
+          --disable-indexing
+          --transform-for-static-hosting
+          --hosting-base-path Parchment-swift/ParchmentCore
+          --output-path docs/ParchmentCore
       - name: run generate-documentation for Parchment
         run: swift package --allow-writing-to-directory docs/Parchment
           generate-documentation --target Parchment
           --disable-indexing
           --transform-for-static-hosting
           --hosting-base-path Parchment-swift/Parchment
           --output-path docs/Parchment
-      - name: run generate-documentation for ParchmentDefault
-        run: swift package --allow-writing-to-directory docs/ParchmentDefault
-          generate-documentation --target ParchmentDefault
-          --disable-indexing
-          --transform-for-static-hosting
-          --hosting-base-path Parchment-swift/ParchmentDefault
-          --output-path docs/ParchmentDefault
       - name: deploy to github pages
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.ref == 'refs/heads/main' }}
diff --git a/Demo.swiftpm/Package.resolved b/Demo.swiftpm/Package.resolved
diff --git a/Demo.swiftpm/Package.swift b/Demo.swiftpm/Package.swift
@@ -37,7 +37,6 @@ let package = Package(
             name: "AppModule",
             dependencies: [
                 .product(name: "Parchment", package: "Parchment"),
-                .product(name: "ParchmentDefault", package: "Parchment"),
             ]
         )
     ]
diff --git a/Demo.swiftpm/Sources/AppModule/Demo.swift b/Demo.swiftpm/Sources/AppModule/Demo.swift
@@ -1,6 +1,5 @@
 import SwiftUI
 import Parchment
-import ParchmentDefault
 
 extension LoggerComponentID {
     static let my: Self = .init("My")
diff --git a/EventGen/Package.swift b/EventGen/Package.swift
@@ -27,7 +27,7 @@ let package = Package(
             name: "EventGenKit",
             dependencies: [
                 .product(name: "Markdown", package: "swift-markdown"),
-                .product(name: "Parchment", package: "Parchment"),
+                .product(name: "ParchmentCore", package: "Parchment"),
                 .product(name: "SwiftSyntaxBuilder", package: "swift-syntax")
             ]
         ),
diff --git a/EventGen/Sources/EventGenKit/SwiftGenerator.swift b/EventGen/Sources/EventGenKit/SwiftGenerator.swift
@@ -6,7 +6,7 @@
 //
 
 import Foundation
-import Parchment
+import ParchmentCore
 import SwiftSyntax
 import SwiftSyntaxBuilder
 
@@ -55,7 +55,7 @@ public struct SwiftGenerator {
 
     private func generate(with definisions: [EventDefinision]) -> String {
         SourceFileSyntax {
-            ImportDeclSyntax(path: [.init(name: "Parchment")])
+            ImportDeclSyntax(path: [.init(name: "ParchmentCore")])
             generatedEventStructDecl
             extensionDecl(with: definisions)
         }.formatted().description
diff --git a/EventGen/Tests/EventGenKitTests/SwiftGeneratorTests.swift b/EventGen/Tests/EventGenKitTests/SwiftGeneratorTests.swift
@@ -48,7 +48,7 @@ final class SwiftGeneratorTests: XCTestCase {
         let result = try generator.run(with: def)
 
         let expected = """
-        import Parchment
+        import ParchmentCore
         struct GeneratedEvent: Loggable {
             let eventName: String
             let parameters: [String: Sendable]
diff --git a/Package.swift b/Package.swift
@@ -8,12 +8,12 @@ let package = Package(
     platforms: [.iOS(.v14), .macOS(.v11)],
     products: [
         .library(
-            name: "Parchment",
-            targets: ["Parchment"]
+            name: "ParchmentCore",
+            targets: ["ParchmentCore"]
         ),
         .library(
-            name: "ParchmentDefault",
-            targets: ["ParchmentDefault"]
+            name: "Parchment",
+            targets: ["Parchment"]
         ),
     ],
     dependencies: [
@@ -22,17 +22,17 @@ let package = Package(
     ],
     targets: [
         .target(
-            name: "Parchment",
+            name: "ParchmentCore",
             swiftSettings: [
                 .unsafeFlags([
                     "-strict-concurrency=complete"
                 ])
             ]
         ),
         .target(
-            name: "ParchmentDefault",
+            name: "Parchment",
             dependencies: [
-                .target(name: "Parchment"),
+                .target(name: "ParchmentCore"),
                 .product(name: "SQLite", package: "SQLite.swift")
             ],
             swiftSettings: [
@@ -42,16 +42,16 @@ let package = Package(
             ]
         ),
         .testTarget(
-            name: "ParchmentTests",
-            dependencies: ["Parchment", "TestSupport"]
+            name: "ParchmentCoreTests",
+            dependencies: ["ParchmentCore", "TestSupport"]
         ),
         .testTarget(
-            name: "ParchmentDefaultTests",
-            dependencies: ["ParchmentDefault", "TestSupport"]
+            name: "ParchmentTests",
+            dependencies: ["Parchment", "TestSupport"]
         ),
         .target(
             name: "TestSupport",
-            dependencies: ["Parchment"]
+            dependencies: ["ParchmentCore"]
         ),
     ]
 )
diff --git a/README.md b/README.md
@@ -17,21 +17,21 @@ If you are using the Swift Package Project, you can add a dependency for this Pa
 
 ```swift
 dependencies: [
-    .product(name: "Parchment", package: "Parchment"),
+    .product(name: "ParchmentCore", package: "Parchment"),
     // The following statements are optional
-    .product(name: "ParchmentDefault", package: "Parchment"),
+    .product(name: "Parchment", package: "Parchment"),
 ]
 ```
 
 ## Project Overview
 
-### Parchment
+### ParchmentCore
 
 It contains the main logic and definitions for logging processing and event logging definitions.
 
-### ParchmentDefault
+### Parchment
 
-Provides a stander implementation compliant with the Protocol provided by Parchment. If you implement your own buffer and scheduler, you do not need to add any dependencies.
+Provides a stander implementation compliant with the Protocol provided by ParchmentCore. If you implement your own buffer and scheduler, you do not need to add any dependencies.
 
 See the [Customization](#customization) section for more details.
 
@@ -142,8 +142,8 @@ await logger.send([\.eventName: "tapButton", \.parameters: ["ButtonID": 1]])
 
 Please see the API documentation below（WIP）.
 
-- https://k-kohey.github.io/Parchment-swift/Parchment/documentation/parchment/
-- https://k-kohey.github.io/Parchment-swift/ParchmentDefault/documentation/parchmentdefault/
+- https://k-kohey.github.io/Parchment-swift/ParchmentCore/documentation/parchmentcore/
+- https://k-kohey.github.io/Parchment-swift/Parchment/documentation/Parchment/
 
 ## Customization
 
@@ -159,7 +159,7 @@ To create the type and set it to logger, write as follows.
 
 ```swift
 
-// An implementation similar to this can be found in ParchmentDefault
+// An implementation similar to this can be found in Parchment
 
 struct DeviceDataMutation: Mutation {
     private let deviceParams = [
@@ -207,7 +207,7 @@ To create the type and set it to logger, write as follows.
 
 ```swift
 
-// An implementation similar to this can be found in ParchmentDefault
+// An implementation similar to this can be found in Parchment
 final class RegularlyPollingScheduler: BufferedEventFlushScheduler {
     public static let `default` = RegularlyPollingScheduler(timeInterval: 60)
 
@@ -270,6 +270,6 @@ let logger = LoggerBundler(
 
 TrackingEventBuffer is a buffer that saves the log.
 
-ParchmentDefault defines a class SQLiteBuffer that uses SQLite to store logs.
+Parchment defines a class SQLiteBuffer that uses SQLite to store logs.
 
 This implementation can be replaced by a class that is compatible with TrackingEventBuffer.
diff --git a/Sources/Parchment/DefaultBufferFlowController.swift b/Sources/Parchment/DefaultBufferFlowController.swift
@@ -6,7 +6,6 @@
 //
 
 import Foundation
-import Parchment
 
 public final class DefaultBufferFlowController: BufferFlowController, Sendable {
     let pollingInterval: UInt
diff --git a/Sources/Parchment/DeviceDataMutation.swift b/Sources/Parchment/DeviceDataMutation.swift
@@ -7,7 +7,6 @@
 
 #if canImport(UIKit)
 
-    import Parchment
     import UIKit
 
     public struct DeviceDataMutation: Mutation {
diff --git a/Sources/Parchment/Export.swift b/Sources/Parchment/Export.swift
@@ -0,0 +1,8 @@
+//
+//  Export.swift
+//  
+//
+//  Created by Kohei Kawaguchi on 2023/06/03.
+//
+
+@_exported import ParchmentCore
diff --git a/Sources/Parchment/LoggerBundler+.swift b/Sources/Parchment/LoggerBundler+.swift
@@ -5,8 +5,6 @@
 //  Created by k-kohey on 2021/12/29.
 //
 
-import Parchment
-
 private let standardInstance = LoggerBundler.make(components: [])
 
 public extension LoggerBundler {
diff --git a/Sources/Parchment/SQLiteBuffer.swift b/Sources/Parchment/SQLiteBuffer.swift
@@ -5,7 +5,7 @@
 //  Created by k-kohey on 2021/10/27.
 //
 
-@_spi(Parchment) import Parchment
+@_spi(ParchmentCore) import ParchmentCore
 import SQLite
 import Foundation
 
diff --git a/Sources/Parchment/Tracked.swift b/Sources/Parchment/Tracked.swift
@@ -5,8 +5,6 @@
 //  Created by Kohei Kawaguchi on 2023/05/17.
 //
 
-import Parchment
-
 /// Logs changes to a value.
 ///
 /// Mark the properties for which you wish to log changes as follows.
diff --git a/Sources/Parchment/View+track.swift b/Sources/Parchment/View+track.swift
@@ -6,7 +6,6 @@
 //
 
 import SwiftUI
-import Parchment
 
 public struct ImpletionEvent: Loggable {
     public var eventName = "ImpletionEvent"
diff --git a/Sources/ParchmentCore/AnyLoggable.swift b/Sources/ParchmentCore/AnyLoggable.swift
@@ -39,7 +39,7 @@ public struct AnyLoggable: Loggable {
     /// Recursively searches for the instance  `base` used to initialize this type and checks
     /// for the existence of an instance of the type passed as an argument.
     ///
-    /// This is useful for checking for lost type information, since type information is lost in conversions using `Parchment.Mutation`.
+    /// This is useful for checking for lost type information, since type information is lost in conversions using `ParchmentCore.Mutation`.
     @AnyLoggableActor
     public func isBased<T: Loggable>(_ type: T.Type) -> Bool {
         if findCache[id]?["\(T.self)"] == true {
diff --git a/Sources/ParchmentCore/BufferFlowController.swift b/Sources/ParchmentCore/BufferFlowController.swift
diff --git a/Sources/ParchmentCore/LogBuffer.swift b/Sources/ParchmentCore/LogBuffer.swift
diff --git a/Sources/ParchmentCore/Loggable.swift b/Sources/ParchmentCore/Loggable.swift
diff --git a/Sources/ParchmentCore/LoggableDictonary.swift b/Sources/ParchmentCore/LoggableDictonary.swift
diff --git a/Sources/ParchmentCore/LoggerBundler.swift b/Sources/ParchmentCore/LoggerBundler.swift
diff --git a/Sources/ParchmentCore/LoggerComponent.swift b/Sources/ParchmentCore/LoggerComponent.swift
diff --git a/Sources/ParchmentCore/Mutation.swift b/Sources/ParchmentCore/Mutation.swift
diff --git a/Sources/ParchmentCore/Payload.swift b/Sources/ParchmentCore/Payload.swift
diff --git a/Sources/ParchmentCore/osLogger.swift b/Sources/ParchmentCore/osLogger.swift
@@ -8,7 +8,7 @@
 import os
 import Foundation
 
-@_spi(Parchment) public let osLogger = Logger(subsystem: "com.k-kohey.parchment", category: "parchment")
+@_spi(ParchmentCore) public let osLogger = Logger(subsystem: "com.k-kohey.parchment", category: "parchment")
 
 public extension LoggerComponentID {
     static var debug: LoggerComponentID {
diff --git a/Sources/ParchmentDefault/osLogger.swift b/Sources/ParchmentDefault/osLogger.swift
diff --git a/Sources/TestSupport/Stub.swift b/Sources/TestSupport/Stub.swift
@@ -5,7 +5,7 @@
 //  Created by Kohei Kawaguchi on 2023/05/17.
 //
 
-import Parchment
+import ParchmentCore
 
 private extension LoggerComponentID {
     static let a = LoggerComponentID("A")
@@ -39,7 +39,7 @@ public final class EventQueueMock: LogBuffer, @unchecked Sendable {
         records += e
     }
 
-    public func dequeue(limit: Int?) async throws -> [Parchment.Payload] {
+    public func dequeue(limit: Int?) async throws -> [ParchmentCore.Payload] {
         let count: Int
         if let limit {
             count = limit
diff --git a/Tests/ParchmentCoreTests/AnyLoggableTests.swift b/Tests/ParchmentCoreTests/AnyLoggableTests.swift
@@ -5,7 +5,7 @@
 //  Created by Kohei Kawaguchi on 2023/05/23.
 //
 
-@testable import Parchment
+@testable import ParchmentCore
 import XCTest
 
 private struct HogeEvent: Loggable {
diff --git a/Tests/ParchmentCoreTests/BufferRecordTests.swift b/Tests/ParchmentCoreTests/BufferRecordTests.swift
@@ -6,7 +6,7 @@
 //
 
 import XCTest
-@testable import Parchment
+@testable import ParchmentCore
 
 class BufferRecordTests: XCTestCase {
     func testEcode() throws {
diff --git a/Tests/ParchmentCoreTests/LoggerBundlerTests.swift b/Tests/ParchmentCoreTests/LoggerBundlerTests.swift
@@ -5,7 +5,7 @@
 //  Created by k-kohey on 2021/11/22.
 //
 
-@testable import Parchment
+@testable import ParchmentCore
 @testable import TestSupport
 import XCTest
 
diff --git a/Tests/ParchmentCoreTests/MutationTests.swift b/Tests/ParchmentCoreTests/MutationTests.swift
@@ -5,7 +5,7 @@
 //  Created by Kohei Kawaguchi on 2023/05/18.
 //
 
-@testable import Parchment
+@testable import ParchmentCore
 import XCTest
 
 private struct MutationMock: Mutation, @unchecked Sendable {
diff --git a/Tests/ParchmentTests/DefaultBufferFlowControllerTests.swift b/Tests/ParchmentTests/DefaultBufferFlowControllerTests.swift
@@ -7,7 +7,6 @@
 
 import Foundation
 @testable import Parchment
-@testable import ParchmentDefault
 import XCTest
 
 final class EventQueueMock: LogBuffer, @unchecked Sendable {
@@ -17,7 +16,7 @@ final class EventQueueMock: LogBuffer, @unchecked Sendable {
         records += e
     }
 
-    func dequeue(limit: Int?) async throws -> [Parchment.Payload] {
+    func dequeue(limit: Int?) async throws -> [Payload] {
         let count: Int
         if let limit {
             count = limit
diff --git a/Tests/ParchmentTests/DeviceDataMutationTests.swift b/Tests/ParchmentTests/DeviceDataMutationTests.swift
@@ -6,7 +6,6 @@
 //
 
 @testable import Parchment
-@testable import ParchmentDefault
 import XCTest
 
 private enum Event: Loggable {
diff --git a/Tests/ParchmentTests/SQLiteBufferTests.swift b/Tests/ParchmentTests/SQLiteBufferTests.swift
diff --git a/Tests/ParchmentTests/TrackedTests.swift b/Tests/ParchmentTests/TrackedTests.swift

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,6 @@ let package = Package(`
`37`	`37`	`name: "AppModule",`
`38`	`38`	`dependencies: [`
`39`	`39`	`.product(name: "Parchment", package: "Parchment"),`
`40`		`- .product(name: "ParchmentDefault", package: "Parchment"),`
`41`	`40`	`]`
`42`	`41`	`)`
`43`	`42`	`]`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ let package = Package(`
`27`	`27`	`name: "EventGenKit",`
`28`	`28`	`dependencies: [`
`29`	`29`	`.product(name: "Markdown", package: "swift-markdown"),`
`30`		`- .product(name: "Parchment", package: "Parchment"),`
	`30`	`+ .product(name: "ParchmentCore", package: "Parchment"),`
`31`	`31`	`.product(name: "SwiftSyntaxBuilder", package: "swift-syntax")`
`32`	`32`	`]`
`33`	`33`	`),`