Merge pull request #132 from Team-Ampersand/122-notice-detail-feature

🔀 :: [#122] 공지 상세 Feature 구현

Plugin/DependencyPlugin/ProjectDescriptionHelpers/Dependency+SPM.swift

@@ -5,6 +5,7 @@ public extension TargetDependency {
 }
 
 public extension TargetDependency.SPM {
+    static let Nuke = TargetDependency.external(name: "Nuke")
     static let Anim = TargetDependency.external(name: "Anim")
     static let CombineMiniature = TargetDependency.external(name: "CombineMiniature")
     static let AsyncNeiSwift = TargetDependency.external(name: "AsyncNeiSwift")

Plugin/DependencyPlugin/ProjectDescriptionHelpers/ModulePaths.swift

@@ -26,6 +26,7 @@ public extension ModulePaths {
 public extension ModulePaths {
     enum Feature: String, MicroTargetPathConvertable {
         case ProposeMusicFeature
+        case DetailNoticeFeature
         case MyViolationListFeature
         case SplashFeature
         case ConfirmationDialogFeature

Projects/App/Sources/Application/AppDelegate.swift

@@ -1,6 +1,7 @@
 import AuthDomain
 import ConfirmationDialogFeature
 import Database
+import DetailNoticeFeature
 import HomeFeature
 import IQKeyboardManagerSwift
 import JwtStore
@@ -48,6 +49,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             HomeAssembly(),
             MyViolationListAssembly(),
             NoticeAssembly(),
+            DetailNoticeAssembly(),
             SelfStudyAssembly(),
             ConfirmationDialogAssembly(),
             MassageAssembly(),

Projects/Domain/NoticeDomain/Interface/DataSource/RemoteNoticeDataSource.swift

@@ -1,3 +1,5 @@
 public protocol RemoteNoticeDataSource {
     func fetchNoticeList() async throws -> [NoticeEntity]
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity
+    func removeNotice(id: Int) async throws
 }

Projects/Domain/NoticeDomain/Interface/Entity/DetailNoticeEntity.swift

@@ -0,0 +1,40 @@
+import BaseDomainInterface
+import Foundation
+
+public struct DetailNoticeEntity: Equatable {
+    public let id: Int
+    public let title: String
+    public let content: String
+    public let role: UserRoleType
+    public let images: [NoticeImage]
+    public let createdDate: Date
+    public let modifiedDate: Date?
+
+    public init(
+        id: Int,
+        title: String,
+        content: String,
+        role: UserRoleType,
+        images: [DetailNoticeEntity.NoticeImage],
+        createdDate: Date,
+        modifiedDate: Date? = nil
+    ) {
+        self.id = id
+        self.title = title
+        self.content = content
+        self.role = role
+        self.images = images
+        self.createdDate = createdDate
+        self.modifiedDate = modifiedDate
+    }
+
+    public struct NoticeImage: Equatable {
+        public let id: Int
+        public let imageURL: String
+
+        public init(id: Int, imageURL: String) {
+            self.id = id
+            self.imageURL = imageURL
+        }
+    }
+}

Projects/Domain/NoticeDomain/Interface/Model/DetailNoticeModel.swift

@@ -0,0 +1 @@
+public typealias DetailNoticeModel = DetailNoticeEntity

Projects/Domain/NoticeDomain/Interface/Repository/NoticeRepository.swift

@@ -1,3 +1,5 @@
 public protocol NoticeRepository {
     func fetchNoticeList() async throws -> [NoticeEntity]
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity
+    func removeNotice(id: Int) async throws
 }

Projects/Domain/NoticeDomain/Interface/UseCase/FetchNoticeUseCase.swift

@@ -0,0 +1,3 @@
+public protocol FetchNoticeUseCase {
+    func callAsFunction(id: Int) async throws -> DetailNoticeModel
+}

Projects/Domain/NoticeDomain/Interface/UseCase/RemoveNoticeUseCase.swift

@@ -0,0 +1,3 @@
+public protocol RemoveNoticeUseCase {
+    func callAsFunction(id: Int) async throws
+}

Projects/Domain/NoticeDomain/Sources/Assembly/NoticeDomainAssembly.swift

@@ -18,5 +18,13 @@ public final class NoticeDomainAssembly: Assembly {
         container.register(FetchNoticeListUseCase.self) { resolver in
             FetchNoticeListUseCaseImpl(noticeRepository: resolver.resolve(NoticeRepository.self)!)
         }
+
+        container.register(FetchNoticeUseCase.self) { resolver in
+            FetchNoticeUseCaseImpl(noticeRepository: resolver.resolve(NoticeRepository.self)!)
+        }
+
+        container.register(RemoveNoticeUseCase.self) { resolver in
+            RemoveNoticeUseCaseImpl(noticeRepository: resolver.resolve(NoticeRepository.self)!)
+        }
     }
 }

Projects/Domain/NoticeDomain/Sources/DTO/Response/FetchNoticeResponseDTO.swift

@@ -0,0 +1,44 @@
+import BaseDomainInterface
+import DateUtility
+import Foundation
+import NoticeDomainInterface
+
+struct FetchNoticeResponseDTO: Decodable {
+    let id: Int
+    let title: String
+    let content: String
+    let role: UserRoleType
+    let boardImage: [BoardImage]
+    let createdDate: String
+    let modifiedDate: String?
+
+    struct BoardImage: Decodable {
+        let id: Int
+        let url: String
+
+        init(id: Int, url: String) {
+            self.id = id
+            self.url = url
+        }
+    }
+}
+
+extension FetchNoticeResponseDTO {
+    func toDomain() -> DetailNoticeEntity {
+        DetailNoticeEntity(
+            id: id,
+            title: title,
+            content: content,
+            role: role,
+            images: boardImage.map { $0.toDomain() },
+            createdDate: createdDate.toDateWithCustomFormat("yyyy-MM-dd'T'HH:mm:ss.SSS"),
+            modifiedDate: modifiedDate?.toDateWithCustomFormat("yyyy-MM-dd'T'HH:mm:ss.SSS")
+        )
+    }
+}
+
+extension FetchNoticeResponseDTO.BoardImage {
+    func toDomain() -> DetailNoticeEntity.NoticeImage {
+        .init(id: id, imageURL: url)
+    }
+}

Projects/Domain/NoticeDomain/Sources/DataSource/NoticeEndpoint.swift

@@ -3,6 +3,8 @@ import NetworkingInterface
 
 enum NoticeEndpoint {
     case fetchNoticeList
+    case fetchNotice(id: Int)
+    case removeNotice(id: Int)
 }
 
 extension NoticeEndpoint: DotoriEndpoint {
@@ -14,6 +16,12 @@ extension NoticeEndpoint: DotoriEndpoint {
         switch self {
         case .fetchNoticeList:
             return .get("")
+
+        case let .fetchNotice(id):
+            return .get("/\(id)")
+
+        case let .removeNotice(id):
+            return .delete("/\(id)")
         }
     }
 

Projects/Domain/NoticeDomain/Sources/DataSource/RemoteNoticeDataSourceImpl.swift

@@ -15,4 +15,16 @@ final class RemoteNoticeDataSourceImpl: RemoteNoticeDataSource {
         )
         .toDomain()
     }
+
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity {
+        try await networking.request(
+            NoticeEndpoint.fetchNotice(id: id),
+            dto: FetchNoticeResponseDTO.self
+        )
+        .toDomain()
+    }
+
+    func removeNotice(id: Int) async throws {
+        try await networking.request(NoticeEndpoint.removeNotice(id: id))
+    }
 }

Projects/Domain/NoticeDomain/Sources/Repository/NoticeRepositoryImpl.swift

@@ -10,4 +10,12 @@ final class NoticeRepositoryImpl: NoticeRepository {
     func fetchNoticeList() async throws -> [NoticeEntity] {
         try await remoteNoticeDataSource.fetchNoticeList()
     }
+
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity {
+        try await remoteNoticeDataSource.fetchNotice(id: id)
+    }
+
+    func removeNotice(id: Int) async throws {
+        try await remoteNoticeDataSource.removeNotice(id: id)
+    }
 }

Projects/Domain/NoticeDomain/Sources/UseCase/FetchNoticeUseCaseImpl.swift

@@ -0,0 +1,13 @@
+import NoticeDomainInterface
+
+struct FetchNoticeUseCaseImpl: FetchNoticeUseCase {
+    private let noticeRepository: any NoticeRepository
+
+    init(noticeRepository: any NoticeRepository) {
+        self.noticeRepository = noticeRepository
+    }
+
+    func callAsFunction(id: Int) async throws -> DetailNoticeModel {
+        try await noticeRepository.fetchNotice(id: id)
+    }
+}

Projects/Domain/NoticeDomain/Sources/UseCase/RemoveNoticeUseCaseImpl.swift

@@ -0,0 +1,13 @@
+import NoticeDomainInterface
+
+struct RemoveNoticeUseCaseImpl: RemoveNoticeUseCase {
+    private let noticeRepository: any NoticeRepository
+
+    init(noticeRepository: any NoticeRepository) {
+        self.noticeRepository = noticeRepository
+    }
+
+    func callAsFunction(id: Int) async throws {
+        try await noticeRepository.removeNotice(id: id)
+    }
+}

Projects/Domain/NoticeDomain/Testing/DataSource/RemoteNoticeDataSourceSpy.swift

@@ -1,3 +1,4 @@
+import BaseDomainInterface
 import NoticeDomainInterface
 
 final class RemoteNoticeDataSourceSpy: RemoteNoticeDataSource {
@@ -7,4 +8,27 @@ final class RemoteNoticeDataSourceSpy: RemoteNoticeDataSource {
         fetchNoticeListCallCount += 1
         return fetchNoticeListReturn
     }
+
+    var fetchNoticeCallCount = 0
+    var fetchNoticeHandler: (Int) async throws -> DetailNoticeEntity = { _ in
+            .init(
+                id: 1,
+                title: "",
+                content: "",
+                role: .member,
+                images: [],
+                createdDate: .init()
+            )
+    }
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity {
+        fetchNoticeCallCount += 1
+        return try await fetchNoticeHandler(id)
+    }
+
+    var removeNoticeCallCount = 0
+    var removeNoticeHandler: (Int) async throws -> Void = { _ in }
+    func removeNotice(id: Int) async throws {
+        removeNoticeCallCount += 1
+        try await removeNoticeHandler(id)
+    }
 }

Projects/Domain/NoticeDomain/Testing/Repository/NoticeRepositorySpy.swift

@@ -7,4 +7,27 @@ final class NoticeRepositorySpy: NoticeRepository {
         fetchNoticeListCallCount += 1
         return fetchNoticeListReturn
     }
+
+    var fetchNoticeCallCount = 0
+    var fetchNoticeHandler: (Int) async throws -> DetailNoticeEntity = { _ in
+            .init(
+                id: 1,
+                title: "",
+                content: "",
+                role: .member,
+                images: [],
+                createdDate: .init()
+            )
+    }
+    func fetchNotice(id: Int) async throws -> DetailNoticeEntity {
+        fetchNoticeCallCount += 1
+        return try await fetchNoticeHandler(id)
+    }
+
+    var removeNoticeCallCount = 0
+    var removeNoticeHandler: (Int) async throws -> Void = { _ in }
+    func removeNotice(id: Int) async throws {
+        removeNoticeCallCount += 1
+        try await removeNoticeHandler(id)
+    }
 }

Projects/Domain/NoticeDomain/Testing/UseCase/FetchNoticeUseCaseSpy.swift

@@ -0,0 +1,19 @@
+import NoticeDomainInterface
+
+final class FetchNoticeUseCaseSpy: FetchNoticeUseCase {
+    var fetchNoticeCallCount = 0
+    var fetchNoticeHandler: (Int) async throws -> DetailNoticeModel = { _ in
+            .init(
+                id: 1,
+                title: "",
+                content: "",
+                role: .member,
+                images: [],
+                createdDate: .init()
+            )
+    }
+    func callAsFunction(id: Int) async throws -> DetailNoticeModel {
+        fetchNoticeCallCount += 1
+        return try await fetchNoticeHandler(id)
+    }
+}

Projects/Domain/NoticeDomain/Testing/UseCase/RemoveNoticeUseCaseSpy.swift

@@ -0,0 +1,10 @@
+import NoticeDomainInterface
+
+final class RemoveNoticeUseCaseSpy: RemoveNoticeUseCase {
+    var removeNoticeCallCount = 0
+    var removeNoticeHandler: (Int) async throws -> Void = { _ in }
+    func callAsFunction(id: Int) async throws {
+        removeNoticeCallCount += 1
+        try await removeNoticeHandler(id)
+    }
+}

Projects/Domain/NoticeDomain/Tests/FetchNoticeUseCaseTests.swift

@@ -0,0 +1,39 @@
+import NoticeDomainInterface
+import XCTest
+@testable import NoticeDomain
+@testable import NoticeDomainTesting
+
+final class FetchNoticeUseCaseTests: XCTestCase {
+    var noticeRepository: NoticeRepositorySpy!
+    var sut: FetchNoticeUseCaseImpl!
+
+    override func setUp() {
+        noticeRepository = .init()
+        sut = .init(noticeRepository: noticeRepository)
+    }
+
+    override func tearDown() {
+        noticeRepository = nil
+        sut = nil
+    }
+
+    func testCallAsFunction() async throws {
+        let date = Date()
+        XCTAssertEqual(noticeRepository.fetchNoticeCallCount, 0)
+        let expected = DetailNoticeEntity(
+            id: 1,
+            title: "b",
+            content: "aj",
+            role: .councillor,
+            images: [],
+            createdDate: .init(),
+            modifiedDate: nil
+        )
+        noticeRepository.fetchNoticeHandler = { _ in expected }
+
+        let actual = try await sut(id: 1)
+
+        XCTAssertEqual(noticeRepository.fetchNoticeCallCount, 1)
+        XCTAssertEqual(actual, expected)
+    }
+}

Projects/Domain/NoticeDomain/Tests/NoticeRepositoryTests.swift

@@ -21,12 +21,32 @@ final class NoticeRepositoryTests: XCTestCase {
     func testFetchNoticeList() async throws {
         let date = Date()
         XCTAssertEqual(remoteNoticeDataSource.fetchNoticeListCallCount, 0)
-        let expected = [NoticeModel(id: 1, title: "title2", content: "contents", roles: .member, createdTime: date)]
+        let expected = [NoticeEntity(id: 1, title: "title2", content: "contents", roles: .member, createdTime: date)]
         remoteNoticeDataSource.fetchNoticeListReturn = expected
 
         let actual = try await sut.fetchNoticeList()
 
         XCTAssertEqual(remoteNoticeDataSource.fetchNoticeListCallCount, 1)
         XCTAssertEqual(actual, expected)
     }
+
+    func testFetchNotice() async throws {
+        let date = Date()
+        XCTAssertEqual(remoteNoticeDataSource.fetchNoticeCallCount, 0)
+        let expected = DetailNoticeEntity(id: 1, title: "title2", content: "contents", role: .member, images: [], createdDate: date)
+        remoteNoticeDataSource.fetchNoticeHandler = { _ in expected }
+
+        let actual = try await sut.fetchNotice(id: 1)
+
+        XCTAssertEqual(remoteNoticeDataSource.fetchNoticeCallCount, 1)
+        XCTAssertEqual(actual, expected)
+    }
+
+    func testRemoveNotice() async throws {
+        XCTAssertEqual(remoteNoticeDataSource.removeNoticeCallCount, 0)
+
+        try await sut.removeNotice(id: 1)
+
+        XCTAssertEqual(remoteNoticeDataSource.removeNoticeCallCount, 1)
+    }
 }