[CT-4] 차트게임 기능 domain 레이어 작성 (+ktlint 설정 변경)

buildSrc/src/main/kotlin/Dependency.kt

@@ -2,6 +2,7 @@ object Dependency {
     const val HILT = "com.google.dagger:hilt-android:2.44"
     const val HILT_COMPILER = "com.google.dagger:hilt-android-compiler:2.44"
     const val JAVAX_INJECT = "javax.inject:javax.inject:1"
+    const val KOTLINX_COROUTINSE = "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1"
 
     const val ANDROIDX_CORE = "androidx.core:core-ktx:1.9.0" // 1.13.1
 

domain/build.gradle.kts

@@ -13,4 +13,5 @@ java {
 
 dependencies {
     implementation(Dependency.JAVAX_INJECT)
+    implementation(Dependency.KOTLINX_COROUTINSE)
 }

domain/src/main/java/com/yessorae/domain/entity/Chart.kt

@@ -0,0 +1,16 @@
+package com.yessorae.domain.entity
+
+import com.yessorae.domain.entity.tick.Tick
+import java.time.LocalDateTime
+
+data class Chart(
+    val id: Int,
+    // ex. AAPL
+    val tickerSymbol: String,
+    // 차트 시작 날짜
+    val startDateTime: LocalDateTime,
+    // 차트 끝 날짜
+    val endDateTime: LocalDateTime,
+    // 차트 데이터
+    val ticks: List<Tick>,
+)

domain/src/main/java/com/yessorae/domain/entity/ChartGame.kt

@@ -0,0 +1,92 @@
+package com.yessorae.domain.entity
+
+import com.yessorae.domain.entity.tick.Tick
+import com.yessorae.domain.entity.trade.Trade
+import com.yessorae.domain.entity.value.Money
+
+data class ChartGame(
+    val id: Int,
+    // 차트 데이터
+    val chart: Chart,
+    // 거래 내역
+    val trades: List<Trade>,
+    // 현재 턴
+    val currentTurn: Int,
+    // 전체 턴
+    val totalTurn: Int,
+    // 게임 전 잔고
+    val startBalance: Money,
+    // 현재 잔고
+    val currentBalance: Money,
+    // 유저의 게임 강제 종료 여부
+    val isQuit: Boolean,
+) {
+    val totalProfit: Money = currentBalance - startBalance
+
+    val rateOfProfit: Double = (totalProfit / startBalance).value * 100
+
+    val tradeCount: Int = trades.size
+
+    val totalCommission: Money = Money(trades.sumOf { trade -> trade.commission.value })
+
+    val visibleTicks: List<Tick> =
+        chart.ticks
+            .sortedBy { it.startTimestamp }
+            .subList(0, chart.ticks.size - totalTurn + currentTurn - 1)
+
+    // 게임 모든 턴을 끝까지 완료한 경우 true
+    val isGameComplete: Boolean = currentTurn == totalTurn
+
+    // 정상종료이든 강제종료이든 종료된 경우 true
+    val isGameEnd: Boolean = isQuit || isGameComplete
+
+    internal fun getNextTurn(): ChartGame {
+        val nextTurn = currentTurn + 1
+        return this.copy(
+            currentTurn = nextTurn,
+        )
+    }
+
+    internal fun createFromNewChart(newChart: Chart): ChartGame {
+        return copy(
+            chart = newChart,
+            currentTurn = START_TURN,
+            trades = emptyList(),
+            currentBalance = startBalance,
+        )
+    }
+
+    internal fun createFromNewTrade(newTrade: Trade): ChartGame {
+        return copy(
+            trades = trades + newTrade,
+            currentBalance = currentBalance + newTrade.profit,
+        )
+    }
+
+    internal fun createFromQuit(): ChartGame {
+        return copy(
+            isQuit = true,
+        )
+    }
+
+    companion object {
+        private const val START_TURN = 1
+
+        fun new(
+            chart: Chart,
+            totalTurn: Int,
+            startBalance: Money,
+        ): ChartGame {
+            return ChartGame(
+                id = 0,
+                chart = chart,
+                trades = emptyList(),
+                currentTurn = START_TURN,
+                totalTurn = totalTurn,
+                startBalance = startBalance,
+                currentBalance = startBalance,
+                isQuit = false,
+            )
+        }
+    }
+}

domain/src/main/java/com/yessorae/domain/entity/User.kt

@@ -0,0 +1,14 @@
+package com.yessorae.domain.entity
+
+import com.yessorae.domain.entity.value.Money
+
+data class User(
+    val balance: Money,
+    val winCount: Int,
+    val loseCount: Int,
+    val averageRateOfProfit: Double,
+//    TODO::LATER 아래 프로퍼티는 로그인 피쳐할 때 추가
+//    val isAnonnymous: Boolean,
+//    val profileImg: String?,
+//    val nickname: String,
+)

domain/src/main/java/com/yessorae/domain/entity/tick/Tick.kt

@@ -0,0 +1,29 @@
+package com.yessorae.domain.entity.tick
+
+import java.time.LocalDateTime
+
+data class Tick(
+    // 시가
+    val openPrice: Double,
+    // 최고가
+    val maxPrice: Double,
+    // 최저가
+    val minPrice: Double,
+    // 종가
+    val closePrice: Double,
+    // 거래 횟수
+    val transactionCount: Int,
+    // The Unix Msec timestamp for the start of the aggregate window.
+    val startTimestamp: LocalDateTime,
+    // 거래량. The trading volume of the symbol in the given time period.
+    val tradingVolume: Int,
+    // 거래량가중평균가격.
+    // Volume Weighted Average Price의 약어로,
+    // 조회 대상 종목의 거래일에 발생한 전체 거래대금을 전체 거래량으로 나눈 가격을 의미
+    val volumeWeightedAveragePrice: Double,
+    // 장외거래(場外去來, Over-the-counter)는
+    // 주식, 채권, 상품선물, 파생금융상품과 같은 투자자산을 거래소(exchange)를 거치지 않고,
+    // 양 당사자가 직접 거래하는 것을 의미
+    val isOverTheCounter: Boolean,
+    val unit: TickUnit,
+)

domain/src/main/java/com/yessorae/domain/entity/tick/TickUnit.kt

@@ -0,0 +1,7 @@
+package com.yessorae.domain.entity.tick
+
+enum class TickUnit {
+    Day,
+    Hour,
+    // TODO::LATER 분 단위 지원
+}

domain/src/main/java/com/yessorae/domain/entity/trade/Trade.kt

@@ -0,0 +1,52 @@
+package com.yessorae.domain.entity.trade
+
+import com.yessorae.domain.entity.value.Money
+
+data class Trade(
+    // 차트게임 아이디
+    val gameId: Long,
+    // 현재 가지고 있는 가격
+    val ownedAverageStockPrice: Money,
+    // 1 주당 가격
+    val stockPrice: Money,
+    // 거래량
+    val count: Int,
+    // 거래한 턴
+    val turn: Int,
+    // 매수/매도
+    val type: TradeType,
+    // 수수료율
+    val commissionRate: Double,
+    // TODO::LATER 세금
+) {
+    // 총 거래금
+    val totalTradeMoney: Money = stockPrice * count
+
+    // 수수료
+    val commission: Money = totalTradeMoney * commissionRate
+
+    // 실현 손익
+    val profit: Money = ((stockPrice - ownedAverageStockPrice) * count) - commission
+
+    companion object {
+        internal fun new(
+            gameId: Long,
+            ownedAverageStockPrice: Money,
+            stockPrice: Money,
+            count: Int,
+            turn: Int,
+            type: TradeType,
+            commissionRate: Double,
+        ): Trade {
+            return Trade(
+                gameId = gameId,
+                ownedAverageStockPrice = ownedAverageStockPrice,
+                stockPrice = stockPrice,
+                count = count,
+                turn = turn,
+                type = type,
+                commissionRate = commissionRate,
+            )
+        }
+    }
+}

domain/src/main/java/com/yessorae/domain/entity/trade/TradeType.kt

@@ -0,0 +1,6 @@
+package com.yessorae.domain.entity.trade
+
+enum class TradeType {
+    Buy,
+    Sell,
+}

domain/src/main/java/com/yessorae/domain/entity/value/Money.kt

@@ -0,0 +1,31 @@
+package com.yessorae.domain.entity.value
+
+data class Money(
+    val value: Double,
+) {
+    // TODO::LATER 화폐단위 바꿔주는 함수 추가
+
+    operator fun plus(other: Money): Money {
+        return Money(value + other.value)
+    }
+
+    operator fun times(other: Money): Money {
+        return Money(value * other.value)
+    }
+
+    operator fun times(count: Int): Money {
+        return Money(value * count)
+    }
+
+    operator fun times(count: Double): Money {
+        return Money(value * count)
+    }
+
+    operator fun minus(other: Money): Money {
+        return Money(value - other.value)
+    }
+
+    operator fun div(other: Money): Money {
+        return Money(value / other.value)
+    }
+}

domain/src/main/java/com/yessorae/domain/exception/ChartGameException.kt

@@ -0,0 +1,15 @@
+package com.yessorae.domain.exception
+
+sealed class ChartGameException(override val message: String = "") : Exception(message) {
+    data class CanNotChangeChartException(
+        override val message: String,
+    ) : ChartGameException(message = message)
+
+    data class CanNotUpdateNextTickException(
+        override val message: String,
+    ) : ChartGameException(message = message)
+
+    data class CanNotChangeTradeException(
+        override val message: String,
+    ) : ChartGameException(message = message)
+}

domain/src/main/java/com/yessorae/domain/repository/ChartGameRepository.kt

@@ -0,0 +1,16 @@
+package com.yessorae.domain.repository
+
+import com.yessorae.domain.entity.ChartGame
+import kotlinx.coroutines.flow.Flow
+
+interface ChartGameRepository {
+    fun saveChartGame(chartGame: ChartGame): Long
+
+    fun fetchChartFlowStream(gameId: Long): Flow<ChartGame>
+
+    suspend fun fetchChartGame(gameId: Long): ChartGame
+
+    suspend fun updateChartGame(chartGame: ChartGame)
+
+    suspend fun deleteChartGame(gameId: Long)
+}

domain/src/main/java/com/yessorae/domain/repository/ChartRepository.kt

@@ -0,0 +1,7 @@
+package com.yessorae.domain.repository
+
+import com.yessorae.domain.entity.Chart
+
+interface ChartRepository {
+    suspend fun fetchNewChartRandomly(): Chart
+}

domain/src/main/java/com/yessorae/domain/repository/TradeRepository.kt

@@ -0,0 +1,9 @@
+package com.yessorae.domain.repository
+
+import com.yessorae.domain.entity.trade.Trade
+
+interface TradeRepository {
+    suspend fun saveTradeHistory(trade: Trade)
+
+    suspend fun deleteTradeHistoryAt(gameId: Long)
+}

domain/src/main/java/com/yessorae/domain/repository/UserRepository.kt

@@ -0,0 +1,11 @@
+package com.yessorae.domain.repository
+
+import com.yessorae.domain.entity.value.Money
+
+interface UserRepository {
+    suspend fun fetchCommissionRateConfig(): Double
+
+    suspend fun fetchTotalTurnConfig(): Int
+
+    suspend fun fetchCurrentBalance(): Money
+}

domain/src/main/java/com/yessorae/domain/usecase/ChangeChartUseCase.kt

@@ -0,0 +1,30 @@
+package com.yessorae.domain.usecase
+
+import com.yessorae.domain.exception.ChartGameException
+import com.yessorae.domain.repository.ChartGameRepository
+import com.yessorae.domain.repository.ChartRepository
+import javax.inject.Inject
+
+class ChangeChartUseCase
+    @Inject
+    constructor(
+        private val chartRepository: ChartRepository,
+        private val chartGameRepository: ChartGameRepository,
+    ) {
+        suspend operator fun invoke(gameId: Long) {
+            val oldChartGame = chartGameRepository.fetchChartGame(gameId = gameId)
+
+            if (oldChartGame.isGameEnd) {
+                throw ChartGameException.CanNotChangeChartException(
+                    message = "can't change chart because game has been end",
+                )
+            }
+
+            chartGameRepository.updateChartGame(
+                chartGame =
+                    oldChartGame.createFromNewChart(
+                        newChart = chartRepository.fetchNewChartRandomly(),
+                    ),
+            )
+        }
+    }

domain/src/main/java/com/yessorae/domain/usecase/QuitChartGameUseCase.kt

@@ -0,0 +1,15 @@
+package com.yessorae.domain.usecase
+
+import com.yessorae.domain.repository.ChartGameRepository
+import javax.inject.Inject
+
+class QuitChartGameUseCase
+    @Inject
+    constructor(
+        private val chartGameRepository: ChartGameRepository,
+    ) {
+        suspend operator fun invoke(gameId: Long) {
+            val oldChartGame = chartGameRepository.fetchChartGame(gameId = gameId)
+            chartGameRepository.updateChartGame(chartGame = oldChartGame.createFromQuit())
+        }
+    }