Merge pull request #344 from GSM-MSG/343-feat/ktlint-for-code-formatting

🔀 :: 343 feat/ktlint for code formatting

Author: KimTaeO

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = false
+tab_width = 4
+
+[*.kt]
+ij_kotlin_packages_to_use_import_on_demand = unset
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false

build.gradle.kts

@@ -4,12 +4,14 @@ plugins {
     id("org.springframework.boot") version PluginVersion.SPRING_BOOT_VERSION
     id("io.spring.dependency-management") version PluginVersion.DEPENDENCY_MANAGER_VERSION
     id("com.ewerk.gradle.plugins.querydsl") version PluginVersion.QUERY_DSL_PLUGIN_VERSION
+    id("org.jlleitschuh.gradle.ktlint") version "10.2.0"
 
     kotlin("jvm") version PluginVersion.JVM_VERSION
     kotlin("plugin.spring") version PluginVersion.SPRING_PLUGIN_VERSION
     kotlin("plugin.jpa") version PluginVersion.JPA_PLUGIN_VERSION
     kotlin("kapt") version PluginVersion.KAPT_VERSION
     idea
+    application
 }
 
 group = "com.msg"
@@ -78,7 +80,6 @@ dependencies {
     implementation(Dependencies.PROMETHEUS_MICROMETER)
 }
 
-
 tasks.withType<KotlinCompile> {
     kotlinOptions {
         freeCompilerArgs = listOf("-Xjsr305=strict")
@@ -97,3 +98,18 @@ idea {
 tasks.withType<Test> {
     useJUnitPlatform()
 }
+
+application {
+    mainClass.set("com.msg.gauth.GauthBackendApplicationKt")
+}
+
+ktlint {
+    verbose.set(true)
+    android.set(false)
+    outputToConsole.set(true)
+    coloredOutput.set(false)
+    ignoreFailures.set(false)
+    enableExperimentalRules.set(false)
+
+    disabledRules.set(setOf("no-wildcard-imports", "import-ordering"))
+}

settings.gradle.kts

@@ -1 +1 @@
-rootProject.name = "gauth"
+rootProject.name = "gauth"

src/main/kotlin/com/msg/gauth/GauthBackendApplication.kt

@@ -12,4 +12,4 @@ class GauthBackendApplication
 fun main(args: Array<String>) {
     TimeZone.setDefault(TimeZone.getTimeZone("Asia/Seoul"))
     runApplication<GauthBackendApplication>(*args)
-}
+}

src/main/kotlin/com/msg/gauth/domain/admin/service/ExcelParsingService.kt

@@ -20,12 +20,12 @@ class ExcelParsingService(
     private val userRepository: UserRepository,
 ) {
 
-    fun execute(file: MultipartFile){
+    fun execute(file: MultipartFile) {
         val tika = Tika()
         val detect = tika.detect(file.bytes)
         val extension = FileNameUtils.getExtension(file.originalFilename)
 
-        if(!ExcelUtil.isExcel(detect, extension))
+        if (!ExcelUtil.isExcel(detect, extension))
             throw FileExtensionInvalidException()
 
         val workBook: Workbook =
@@ -34,10 +34,10 @@ class ExcelParsingService(
             else
                 HSSFWorkbook(file.inputStream)
 
-        val workSheet:Sheet = workBook.getSheetAt(0)
+        val workSheet: Sheet = workBook.getSheetAt(0)
         val map = hashMapOf<String, UpdateDto>()
 
-        for(i in 1 until workSheet.physicalNumberOfRows){
+        for (i in 1 until workSheet.physicalNumberOfRows) {
             val row = workSheet.getRow(i)
             val email = row.getCell(4).stringCellValue
 

src/main/kotlin/com/msg/gauth/domain/auth/handler/AuthEventHandler.kt

@@ -10,8 +10,6 @@ import org.springframework.http.HttpEntity
 import org.springframework.http.HttpHeaders
 import org.springframework.http.MediaType
 import org.springframework.stereotype.Component
-import org.springframework.transaction.event.TransactionPhase
-import org.springframework.transaction.event.TransactionalEventListener
 import org.springframework.web.client.RestTemplate
 
 @Component
@@ -51,4 +49,4 @@ class AuthEventHandler(
         val entity = HttpEntity(jsonObject.toString(), headers)
         restTemplate.postForObject(discordProperties.url, entity, String::class.java)
     }
-}
+}

src/main/kotlin/com/msg/gauth/domain/auth/presentation/AuthController.kt

@@ -66,7 +66,6 @@ class AuthController(
         return ResponseEntity.ok(result)
     }
 
-
     @PatchMapping("/password/initialize")
     fun initPassword(@Valid @RequestBody initPasswordRequestDto: InitPasswordRequestDto): ResponseEntity<Void> {
         initPasswordService.execute(initPasswordRequestDto)
@@ -84,5 +83,4 @@ class AuthController(
         signUpEmailVerificationService.execute(email)
         return ResponseEntity.ok().build()
     }
-
 }

src/main/kotlin/com/msg/gauth/domain/auth/presentation/dto/request/SignUpV2RequestDto.kt

@@ -4,7 +4,7 @@ import javax.validation.constraints.NotBlank
 import javax.validation.constraints.NotNull
 import javax.validation.constraints.Pattern
 
-data class SignUpV2RequestDto (
+data class SignUpV2RequestDto(
     @field:NotBlank
     @field:Pattern(regexp = "^[a-zA-Z0-9.]+@gsm.hs.kr$")
     val email: String,

src/main/kotlin/com/msg/gauth/domain/auth/repository/RefreshTokenRepository.kt

@@ -4,6 +4,6 @@ import com.msg.gauth.global.util.count.auth.RefreshToken
 import org.springframework.data.repository.CrudRepository
 
 interface RefreshTokenRepository : CrudRepository<RefreshToken, Long> {
-    
+
     fun findByToken(token: String): RefreshToken?
 }

src/main/kotlin/com/msg/gauth/domain/auth/service/InitPasswordService.kt

@@ -20,7 +20,7 @@ class InitPasswordService(
         val emailAuth = emailAuthRepository.findByIdOrNull(initPasswordRequestDto.email)
             ?: throw EmailNotVerifiedException()
 
-        if(!emailAuth.authentication)
+        if (!emailAuth.authentication)
             throw EmailNotVerifiedException()
 
         val user = userRepository.findByEmail(initPasswordRequestDto.email)

src/main/kotlin/com/msg/gauth/domain/auth/service/RefreshService.kt

@@ -28,7 +28,8 @@ class RefreshService(
             throw InvalidRefreshTokenException()
 
         val (access, refresh) = jwtTokenProvider.run {
-            generateAccessToken(email) to generateRefreshToken(email)}
+            generateAccessToken(email) to generateRefreshToken(email)
+        }
 
         val newRefreshToken = RefreshToken(
             userId = existingRefreshToken.userId,

src/main/kotlin/com/msg/gauth/domain/auth/service/SignInService.kt

@@ -38,7 +38,7 @@ class SignInService(
             throw PasswordMismatchException()
         }
 
-        if(user.state == UserState.PENDING)
+        if (user.state == UserState.PENDING)
             throw UserIsPendingException()
 
         tempUserUtil.resetWrongPasswordCount(user)

src/main/kotlin/com/msg/gauth/domain/auth/service/SignUpImageUploadService.kt

@@ -18,10 +18,10 @@ class SignUpImageUploadService(
         val emailAuth = emailAuthRepository.findByIdOrNull(email)
             ?: throw AuthCodeExpiredException()
 
-        if(!emailAuth.authentication)
+        if (!emailAuth.authentication)
             throw AuthCodeNotVerificationException()
 
-        if(previousUrl != null)
+        if (previousUrl != null)
             s3Util.deleteImage(previousUrl)
 
         return SignUpImageResDto(s3Util.imageUpload(image))

src/main/kotlin/com/msg/gauth/domain/auth/service/SignUpMemberV2Service.kt

@@ -23,7 +23,7 @@ class SignUpMemberV2Service(
 ) {
 
     fun execute(signUpV2RequestDto: SignUpV2RequestDto) {
-        if(userRepository.existsByEmail(signUpV2RequestDto.email))
+        if (userRepository.existsByEmail(signUpV2RequestDto.email))
             throw DuplicateEmailException()
 
         if (userRepository.existsByGradeAndClassNumAndNum(signUpV2RequestDto.grade, signUpV2RequestDto.classNum, signUpV2RequestDto.num))

src/main/kotlin/com/msg/gauth/domain/client/presentation/dto/request/ClientUpdateReqDto.kt

@@ -18,7 +18,7 @@ data class ClientUpdateReqDto(
 
     @Enumerated(EnumType.STRING)
     val serviceScope: ServiceScope = ServiceScope.PUBLIC,
-    
+
     val serviceImgUrl: String = ""
 ) {
 

src/main/kotlin/com/msg/gauth/domain/client/presentation/dto/response/ClientDetailResDto.kt

@@ -14,7 +14,7 @@ data class ClientDetailResDto(
     val serviceImgUrl: String
 ) {
 
-    constructor(client: Client): this(
+    constructor(client: Client) : this(
         id = client.id,
         clientId = client.clientId,
         clientSecret = client.clientSecret,

src/main/kotlin/com/msg/gauth/domain/client/presentation/dto/response/ClientRegisterResDto.kt

@@ -14,7 +14,7 @@ data class ClientRegisterResDto(
     val serviceImgUrl: String
 ) {
 
-    constructor(client: Client): this(
+    constructor(client: Client) : this(
         id = client.id,
         clientId = client.clientId,
         clientSecret = client.clientSecret,

src/main/kotlin/com/msg/gauth/domain/client/presentation/dto/response/ClientResDto.kt

@@ -12,7 +12,7 @@ data class ClientResDto(
     val serviceImgUrl: String
 ) {
 
-    constructor(client: Client): this(
+    constructor(client: Client) : this(
         clientId = client.id,
         serviceName = client.serviceName,
         serviceUri = client.serviceUri,

src/main/kotlin/com/msg/gauth/domain/client/presentation/dto/response/SingleClientResDto.kt

@@ -12,7 +12,7 @@ data class SingleClientResDto(
     val serviceImgUrl: String
 ) {
 
-    constructor(client: Client): this(
+    constructor(client: Client) : this(
         id = client.id,
         clientId = client.clientId,
         serviceName = client.serviceName,

src/main/kotlin/com/msg/gauth/domain/client/repository/ClientRepository.kt

@@ -6,7 +6,6 @@ import com.msg.gauth.domain.user.User
 import org.springframework.data.domain.Page
 import org.springframework.data.domain.Pageable
 import org.springframework.data.jpa.repository.JpaRepository
-import org.springframework.data.jpa.repository.Query
 import java.util.*
 
 interface ClientRepository : JpaRepository<Client, Long>, CustomClientRepository {

src/main/kotlin/com/msg/gauth/domain/client/repository/CustomClientRepositoryImpl.kt

@@ -8,7 +8,7 @@ import org.springframework.stereotype.Repository
 @Repository
 class CustomClientRepositoryImpl(
     private val jpaQueryFactory: JPAQueryFactory
-): CustomClientRepository {
+) : CustomClientRepository {
 
     override fun deleteAllByIdsAndCreatedBy(ids: List<Long>, createdBy: User) {
         jpaQueryFactory.delete(client)

src/main/kotlin/com/msg/gauth/domain/client/service/DelegateOwnerService.kt

@@ -24,7 +24,7 @@ class DelegateOwnerService(
         val user = userUtil.fetchCurrentUser()
 
         if (delegateUserId == user.id)
-        throw BadDelegateUserIdRequestException()
+            throw BadDelegateUserIdRequestException()
 
         val client = clientRepository.findByIdOrNull(clientId)
             ?: throw ClientNotFindException()

src/main/kotlin/com/msg/gauth/domain/client/service/DeleteClientService.kt

@@ -13,11 +13,11 @@ class DeleteClientService(
     private val userUtil: UserUtil,
 ) {
 
-    fun execute(id: Long){
+    fun execute(id: Long) {
         val client = clientRepository.findByIdOrNull(id)
             ?: throw ClientNotFindException()
 
-        if(client.createdBy != userUtil.fetchCurrentUser())
+        if (client.createdBy != userUtil.fetchCurrentUser())
             throw UserNotMatchException()
 
         clientRepository.delete(client)

src/main/kotlin/com/msg/gauth/domain/client/service/UpdateClientService.kt

@@ -12,7 +12,7 @@ class UpdateClientService(
     private val userUtil: UserUtil
 ) {
 
-    fun updateClient(id: Long, clientUpdateReqDto: ClientUpdateReqDto){
+    fun updateClient(id: Long, clientUpdateReqDto: ClientUpdateReqDto) {
         val client = clientRepository.findByIdAndCreatedBy(id, userUtil.fetchCurrentUser())
             ?: throw ClientNotFindException()
 

src/main/kotlin/com/msg/gauth/domain/email/EmailAuthEntity.kt

@@ -1,6 +1,5 @@
 package com.msg.gauth.domain.email
 
-import org.hibernate.annotations.ColumnDefault
 import org.hibernate.validator.constraints.Length
 import org.springframework.data.annotation.Id
 import org.springframework.data.redis.core.RedisHash
@@ -30,7 +29,7 @@ class EmailAuthEntity(
         return EmailAuthEntity(
             email = this.email,
             authentication = this.authentication,
-            attemptCount = this.attemptCount+1,
+            attemptCount = this.attemptCount + 1,
             randomValue = uuid,
         )
     }

src/main/kotlin/com/msg/gauth/domain/email/presentation/EmailController.kt

@@ -33,5 +33,4 @@ class EmailController(
         checkMailVerificationService.execute(email)
         return ResponseEntity.ok().build()
     }
-
 }

src/main/kotlin/com/msg/gauth/domain/email/service/CheckMailVerificationService.kt

@@ -14,7 +14,7 @@ class CheckMailVerificationService(
         val authEntity = emailAuthRepository.findByIdOrNull(email)
             ?: throw AuthCodeNotVerificationException()
 
-        if(!authEntity.authentication)
+        if (!authEntity.authentication)
             throw AuthCodeNotVerificationException()
     }
 }

src/main/kotlin/com/msg/gauth/domain/email/service/SendMailService.kt

@@ -35,7 +35,7 @@ class SendMailService(
                 attemptCount = 0
             )
 
-        if(authEntity.authentication)
+        if (authEntity.authentication)
             throw AlreadyAuthenticatedEmailException()
 
         if (authEntity.attemptCount >= 5)
@@ -65,7 +65,7 @@ class SendMailService(
     private fun createMailTemplate(email: String, code: String): String {
         val context = Context()
 
-        val url = "https://port-0-gauth-backend-85phb42bluutn9a7.sel5.cloudtype.app/email/authentication?email=${email}&uuid=${code}"
+        val url = "https://port-0-gauth-backend-85phb42bluutn9a7.sel5.cloudtype.app/email/authentication?email=$email&uuid=$code"
 
         context.setVariables(
             mapOf(

src/main/kotlin/com/msg/gauth/domain/oauth/exception/UserStatePendingException.kt

@@ -3,6 +3,6 @@ package com.msg.gauth.domain.oauth.exception
 import com.msg.gauth.global.exception.ErrorCode
 import com.msg.gauth.global.exception.exceptions.BasicException
 
-class UserStatePendingException: BasicException(
+class UserStatePendingException : BasicException(
     ErrorCode.USER_STATE_PENDING
 )

src/main/kotlin/com/msg/gauth/domain/oauth/presentation/OauthController.kt

@@ -23,7 +23,7 @@ class OauthController(
 ) {
 
     @PostMapping("/code")
-    fun generateOauthCode(@Valid @RequestBody oauthCodeRequestDto : OauthCodeRequestDto): ResponseEntity<OauthCodeResponseDto> {
+    fun generateOauthCode(@Valid @RequestBody oauthCodeRequestDto: OauthCodeRequestDto): ResponseEntity<OauthCodeResponseDto> {
         val result = generateOauthCodeService.execute(oauthCodeRequestDto)
         return ResponseEntity.ok(result)
     }

src/main/kotlin/com/msg/gauth/domain/oauth/presentation/dto/request/OauthLoginReqDto.kt

@@ -13,4 +13,4 @@ data class OauthLoginReqDto(
 
     @field:NotBlank
     val password: String
-)
+)

src/main/kotlin/com/msg/gauth/domain/oauth/service/GenerateOauthCodeService.kt

@@ -39,7 +39,7 @@ class GenerateOauthCodeService(
             throw PasswordMismatchException()
         }
 
-        if(user.state == UserState.PENDING)
+        if (user.state == UserState.PENDING)
             throw UserStatePendingException()
 
         tempUserUtil.resetOAuthWrongPasswordCount(user)
@@ -58,7 +58,7 @@ class GenerateOauthCodeService(
         tempUserUtil.isUserBan(user)
         tooManyOAuthRequestValidUtil.validRequest(user.email)
 
-        if(user.state == UserState.PENDING)
+        if (user.state == UserState.PENDING)
             throw UserStatePendingException()
 
         val code = UUID.randomUUID().toString().split(".")[0]