Merge pull request #5 from lmirabal/clearer-naming

Clearer naming

Author: lmirabal

…main/kotlin/lmirabal/bank/BankService.kt …c/main/kotlin/lmirabal/bank/BankLogic.ktdomain/src/main/kotlin/lmirabal/bank/BankService.kt renamed to domain/src/main/kotlin/lmirabal/bank/BankLogic.kt domain/src/main/kotlin/lmirabal/bank/BankService.kt renamed to domain/src/main/kotlin/lmirabal/bank/BankLogic.kt

@@ -8,26 +8,25 @@ import lmirabal.bank.model.BankAccount
 import lmirabal.bank.model.BankAccountId
 import lmirabal.bank.model.NotEnoughFunds
 
-class BankService(
-    private val accountRepository: BankAccountRepository,
+class BankLogic(
+    private val repository: BankAccountRepository,
     private val idFactory: () -> BankAccountId = { BankAccountId.random() }
 ) : Bank {
-    override fun createAccount(): BankAccount {
-        return BankAccount(idFactory(), Amount.ZERO)
-            .also { newAccount -> accountRepository.add(newAccount) }
-    }
+    override fun createAccount(): BankAccount =
+        BankAccount(idFactory(), Amount.ZERO)
+            .also { newAccount -> repository.add(newAccount) }
 
-    override fun listAccounts(): List<BankAccount> = accountRepository.list()
+    override fun listAccounts(): List<BankAccount> = repository.list()
 
     override fun deposit(id: BankAccountId, amount: Amount): BankAccount {
-        val account = accountRepository.list().first { it.id == id }
+        val account = repository.list().first { it.id == id }
         return account.deposit(amount)
-            .also { updatedAccount -> accountRepository.update(updatedAccount) }
+            .also { updatedAccount -> repository.update(updatedAccount) }
     }
 
     override fun withdraw(id: BankAccountId, amount: Amount): Result<BankAccount, NotEnoughFunds> {
-        val account = accountRepository.list().first { it.id == id }
+        val account = repository.list().first { it.id == id }
         return account.withdraw(amount)
-            .peek { updatedAccount -> accountRepository.update(updatedAccount) }
+            .peek { updatedAccount -> repository.update(updatedAccount) }
     }
 }

domain/src/main/kotlin/lmirabal/bank/model/BankAccount.kt

@@ -12,7 +12,7 @@ data class BankAccount(val id: BankAccountId, val balance: Amount) {
 
     fun withdraw(amount: Amount): Result<BankAccount, NotEnoughFunds> {
         return if (amount <= balance) Success(copy(balance = balance - amount))
-        else Failure(NotEnoughFunds(id, balance, amount - balance))
+        else Failure(NotEnoughFunds(id, balance, additionalFundsRequired = amount - balance))
     }
 }
 

…/kotlin/lmirabal/bank/BankServiceTest.kt …st/kotlin/lmirabal/bank/BankLogicTest.ktdomain/src/test/kotlin/lmirabal/bank/BankServiceTest.kt renamed to domain/src/test/kotlin/lmirabal/bank/BankLogicTest.kt domain/src/test/kotlin/lmirabal/bank/BankServiceTest.kt renamed to domain/src/test/kotlin/lmirabal/bank/BankLogicTest.kt

@@ -8,9 +8,9 @@ import lmirabal.bank.model.BankAccount
 import lmirabal.bank.model.BankAccountId
 import org.junit.jupiter.api.Test
 
-class BankServiceTest : BankTest() {
+class BankLogicTest : BankContract() {
     private val idFactory = RecordingIdFactory()
-    override val bank = BankService(InMemoryBankAccountRepository(), idFactory)
+    override val bank = BankLogic(InMemoryBankAccountRepository(), idFactory)
 
     @Test
     fun createsAnAccount() {

…ixtures/kotlin/lmirabal/bank/BankTest.kt …res/kotlin/lmirabal/bank/BankContract.ktdomain/src/testFixtures/kotlin/lmirabal/bank/BankTest.kt renamed to domain/src/testFixtures/kotlin/lmirabal/bank/BankContract.kt domain/src/testFixtures/kotlin/lmirabal/bank/BankTest.kt renamed to domain/src/testFixtures/kotlin/lmirabal/bank/BankContract.kt

@@ -9,7 +9,7 @@ import lmirabal.bank.model.Amount
 import lmirabal.bank.model.NotEnoughFunds
 import org.junit.jupiter.api.Test
 
-abstract class BankTest {
+abstract class BankContract {
     abstract val bank: Bank
 
     @Test

http/src/main/kotlin/lmirabal/bank/http/BankHttp.kt

@@ -3,7 +3,7 @@ package lmirabal.bank.http
 import dev.forkhandles.result4k.map
 import dev.forkhandles.result4k.recover
 import lmirabal.bank.Bank
-import lmirabal.bank.BankService
+import lmirabal.bank.BankLogic
 import lmirabal.bank.data.InMemoryBankAccountRepository
 import lmirabal.bank.model.Amount
 import lmirabal.bank.model.BankAccount
@@ -23,7 +23,7 @@ import org.http4k.routing.bind
 import org.http4k.routing.routes
 import java.util.UUID
 
-fun bankHttp() = bankHttp(BankService(InMemoryBankAccountRepository()))
+fun bankHttp() = bankHttp(BankLogic(InMemoryBankAccountRepository()))
 
 internal const val BANK_ACCOUNTS_BASE_URL = "/bank/accounts"
 internal const val BANK_ACCOUNT_DEPOSIT_PATH = "/{id}/deposit"

http/src/test/kotlin/lmirabal/bank/http/BankHttpIntegrationTest.kt

@@ -1,6 +1,6 @@
 package lmirabal.bank.http
 
-import lmirabal.bank.BankTest
+import lmirabal.bank.BankContract
 import org.http4k.client.JavaHttpClient
 import org.http4k.core.Uri
 import org.http4k.core.then
@@ -10,7 +10,7 @@ import org.http4k.server.asServer
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
 
-class BankHttpIntegrationTest : BankTest() {
+class BankHttpIntegrationTest : BankContract() {
     private val server = bankHttp().asServer(SunHttp())
     override val bank = BankHttpClient(
         SetBaseUriFrom(Uri.of("http://localhost:${server.port()}")).then(JavaHttpClient())

http/src/test/kotlin/lmirabal/bank/http/BankHttpTest.kt

@@ -1,7 +1,7 @@
 package lmirabal.bank.http
 
-import lmirabal.bank.BankTest
+import lmirabal.bank.BankContract
 
-class BankHttpTest : BankTest() {
+class BankHttpTest : BankContract() {
     override val bank = BankHttpClient(bankHttp())
 }

web/src/test/kotlin/lmirabal/bank/web/BankWebTest.kt

@@ -4,7 +4,7 @@ import dev.forkhandles.result4k.Failure
 import dev.forkhandles.result4k.Result
 import dev.forkhandles.result4k.Success
 import lmirabal.bank.Bank
-import lmirabal.bank.BankTest
+import lmirabal.bank.BankContract
 import lmirabal.bank.http.BankHttpClient
 import lmirabal.bank.http.bankHttp
 import lmirabal.bank.model.Amount
@@ -22,7 +22,7 @@ import org.openqa.selenium.WebElement
 import java.math.BigDecimal
 import java.util.UUID
 
-class BankWebTest : BankTest() {
+class BankWebTest : BankContract() {
     private val http: HttpHandler = bankHttp()
     private val httpClient: Bank = BankHttpClient(http)
     private val web: HttpHandler = bankWeb(httpClient)