DC/dc-project
1
1
Fork 0
Code Issues 25 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Refactor constitution entity

Browse Source
This commit is contained in:
Fabrice Lecomte
2021-03-20 00:55:39 +01:00
parent 8701815288
commit c9ce2a9dc7
8 changed files with 131 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/kotlin/fr/dcproject/component/constitution/ConstitutionAccessControl.kt
View File

@@ -5,20 +5,20 @@ import fr.dcproject.common.entity.DeletedAt
import fr.dcproject.common.security.AccessControl import fr.dcproject.common.security.AccessControl
import fr.dcproject.common.security.AccessResponse import fr.dcproject.common.security.AccessResponse
import fr.dcproject.component.citizen.database.CitizenI import fr.dcproject.component.citizen.database.CitizenI
import fr.dcproject.component.constitution.database.ConstitutionForListing
import fr.dcproject.component.constitution.database.ConstitutionI
import fr.dcproject.component.constitution.database.ConstitutionRef import fr.dcproject.component.constitution.database.ConstitutionRef
import fr.dcproject.component.constitution.database.ConstitutionS
import fr.dcproject.component.constitution.database.ConstitutionSimple
class ConstitutionAccessControl : AccessControl() { class ConstitutionAccessControl : AccessControl() {
fun canCreate(subject: ConstitutionS, citizen: CitizenI?): AccessResponse = when { fun canCreate(subject: ConstitutionI, citizen: CitizenI?): AccessResponse = when {
citizen == null -> denied("You must be connected to create constitution", "constitution.create.notConnected") citizen == null -> denied("You must be connected to create constitution", "constitution.create.notConnected")
else -> granted() else -> granted()
} }
fun <S : ConstitutionSimple<*, *>> canView(subjects: List<S>, citizen: CitizenI?): AccessResponse = fun canView(subjects: List<ConstitutionForListing>, citizen: CitizenI?): AccessResponse =
canAll(subjects) { canView(it, citizen) } canAll(subjects) { canView(it, citizen) }
fun <S> canView(subject: S, citizen: CitizenI?): AccessResponse where S : DeletedAt, S : ConstitutionS = when { fun <S> canView(subject: S, citizen: CitizenI?): AccessResponse where S : DeletedAt, S : ConstitutionI = when {
subject.isDeleted() -> denied("You cannot view a deleted constitution", "constitution.view.deleted") subject.isDeleted() -> denied("You cannot view a deleted constitution", "constitution.view.deleted")
else -> granted() else -> granted()
} }

83
src/main/kotlin/fr/dcproject/component/constitution/database/Constitution.kt
View File

@@ -4,6 +4,7 @@ import fr.dcproject.common.entity.CreatedAt
import fr.dcproject.common.entity.CreatedBy import fr.dcproject.common.entity.CreatedBy
import fr.dcproject.common.entity.DeletedAt import fr.dcproject.common.entity.DeletedAt
import fr.dcproject.common.entity.Entity import fr.dcproject.common.entity.Entity
import fr.dcproject.common.entity.EntityI
import fr.dcproject.common.entity.TargetI import fr.dcproject.common.entity.TargetI
import fr.dcproject.common.entity.TargetRef import fr.dcproject.common.entity.TargetRef
import fr.dcproject.common.entity.VersionableId import fr.dcproject.common.entity.VersionableId
@@ -11,68 +12,68 @@ import fr.dcproject.component.article.database.ArticleForListing
import fr.dcproject.component.article.database.ArticleI import fr.dcproject.component.article.database.ArticleI
import fr.dcproject.component.citizen.database.CitizenCreator import fr.dcproject.component.citizen.database.CitizenCreator
import fr.dcproject.component.citizen.database.CitizenWithUserI import fr.dcproject.component.citizen.database.CitizenWithUserI
import fr.dcproject.component.constitution.database.ConstitutionSimple.TitleSimple import fr.dcproject.component.constitution.database.ConstitutionForUpdate.TitleForUpdate
import java.util.UUID import java.util.UUID
class Constitution( data class ConstitutionForView(
id: UUID = UUID.randomUUID(), override val id: UUID = UUID.randomUUID(),
title: String, val title: String,
anonymous: Boolean = true, val anonymous: Boolean = true,
titles: MutableList<TitleSimple<ArticleForListing>> = mutableListOf(), val titles: List<TitleForView> = listOf(),
draft: Boolean = false, val draft: Boolean = false,
lastVersion: Boolean = false, val lastVersion: Boolean = false,
override val createdBy: CitizenCreator override val createdBy: CitizenCreator,
) : ConstitutionSimple<CitizenCreator, TitleSimple<ArticleForListing>>( override val versionId: UUID = UUID.randomUUID(),
id, ) : ConstitutionRef(id),
title = title, VersionableId,
anonymous = anonymous, CreatedAt by CreatedAt.Imp(),
titles = titles, CreatedBy<CitizenCreator>,
draft = draft, DeletedAt by DeletedAt.Imp() {
lastVersion = lastVersion, data class TitleForView(
createdBy = createdBy override val id: UUID = UUID.randomUUID(),
) { val name: String,
val rank: Int,
class Title( val articles: MutableList<ArticleForListing> = mutableListOf(),
id: UUID = UUID.randomUUID(), ) : TitleRef(id)
name: String,
rank: Int? = null,
override val articles: MutableList<ArticleForListing> = mutableListOf()
) : TitleSimple<ArticleForListing>(id, name, rank)
} }
open class ConstitutionSimple<Cr : CitizenWithUserI, T : TitleSimple<*>>( data class ConstitutionForListing(
id: UUID = UUID.randomUUID(), override val id: UUID = UUID.randomUUID(),
val title: String,
override val createdBy: CitizenCreator,
override val versionId: UUID = UUID.randomUUID(),
) : ConstitutionRef(id),
VersionableId,
CreatedAt by CreatedAt.Imp(),
CreatedBy<CitizenCreator>,
DeletedAt by DeletedAt.Imp()
data class ConstitutionForUpdate<Cr : CitizenWithUserI, T : TitleForUpdate<*>>(
override val id: UUID = UUID.randomUUID(),
val title: String, val title: String,
val anonymous: Boolean = true, val anonymous: Boolean = true,
val titles: List<T> = listOf(), val titles: List<T> = listOf(),
val draft: Boolean = false, val draft: Boolean = false,
val lastVersion: Boolean = false, val lastVersion: Boolean = false,
override val createdBy: Cr, override val createdBy: Cr,
versionId: UUID = UUID.randomUUID() override val versionId: UUID = UUID.randomUUID()
) : ConstitutionRef(id), ) : ConstitutionRef(id),
VersionableId by VersionableId.Imp(versionId), VersionableId by VersionableId.Imp(versionId),
CreatedAt by CreatedAt.Imp(), CreatedAt by CreatedAt.Imp(),
CreatedBy<Cr> by CreatedBy.Imp(createdBy), CreatedBy<Cr> by CreatedBy.Imp(createdBy),
DeletedAt by DeletedAt.Imp() { DeletedAt by DeletedAt.Imp() {
init { data class TitleForUpdate<A : ArticleI>(
titles.forEachIndexed { index, title -> override val id: UUID = UUID.randomUUID(),
title.rank = index val name: String,
} val articles: List<A> = listOf()
}
open class TitleSimple<A : ArticleI>(
id: UUID = UUID.randomUUID(),
var name: String,
var rank: Int? = null,
open val articles: MutableList<A> = mutableListOf()
) : TitleRef(id) ) : TitleRef(id)
} }
open class ConstitutionRef(id: UUID? = null) : ConstitutionS(id ?: UUID.randomUUID()) { open class ConstitutionRef(id: UUID? = null) : TargetRef(id), ConstitutionI {
open class TitleRef( open class TitleRef(
id: UUID = UUID.randomUUID() id: UUID = UUID.randomUUID()
) : Entity(id) ) : Entity(id)
} }
sealed class ConstitutionS(id: UUID = UUID.randomUUID()) : TargetRef(id), TargetI interface ConstitutionI : EntityI, TargetI

9
src/main/kotlin/fr/dcproject/component/constitution/database/ConstitutionRepository.kt
View File

@@ -2,17 +2,16 @@ package fr.dcproject.component.constitution.database
import fr.dcproject.component.article.database.ArticleRef import fr.dcproject.component.article.database.ArticleRef
import fr.dcproject.component.citizen.database.CitizenWithUserI import fr.dcproject.component.citizen.database.CitizenWithUserI
import fr.dcproject.component.constitution.database.ConstitutionSimple.TitleSimple import fr.dcproject.component.constitution.database.ConstitutionForUpdate.TitleForUpdate
import fr.postgresjson.connexion.Paginated import fr.postgresjson.connexion.Paginated
import fr.postgresjson.connexion.Requester import fr.postgresjson.connexion.Requester
import fr.postgresjson.repository.RepositoryI import fr.postgresjson.repository.RepositoryI
import fr.postgresjson.repository.RepositoryI.Direction import fr.postgresjson.repository.RepositoryI.Direction
import net.pearx.kasechange.toSnakeCase import net.pearx.kasechange.toSnakeCase
import java.util.UUID import java.util.UUID
import fr.dcproject.component.constitution.database.Constitution as ConstitutionEntity
class ConstitutionRepository(override var requester: Requester) : RepositoryI { class ConstitutionRepository(override var requester: Requester) : RepositoryI {
fun findById(id: UUID): ConstitutionEntity? { fun findById(id: UUID): ConstitutionForView? {
val function = requester.getFunction("find_constitution_by_id") val function = requester.getFunction("find_constitution_by_id")
return function.selectOne("id" to id) return function.selectOne("id" to id)
} }
@@ -23,7 +22,7 @@ class ConstitutionRepository(override var requester: Requester) : RepositoryI {
sort: String? = null, sort: String? = null,
direction: Direction? = null, direction: Direction? = null,
search: String? = null search: String? = null
): Paginated<ConstitutionEntity> { ): Paginated<ConstitutionForListing> {
return requester return requester
.getFunction("find_constitutions") .getFunction("find_constitutions")
.select( .select(
@@ -35,7 +34,7 @@ class ConstitutionRepository(override var requester: Requester) : RepositoryI {
) )
} }
fun upsert(constitution: ConstitutionSimple<CitizenWithUserI, TitleSimple<ArticleRef>>): ConstitutionEntity? { fun upsert(constitution: ConstitutionForUpdate<CitizenWithUserI, TitleForUpdate<ArticleRef>>): ConstitutionForView? {
return requester return requester
.getFunction("upsert_constitution") .getFunction("upsert_constitution")
.selectOne("resource" to constitution) .selectOne("resource" to constitution)

90
src/main/kotlin/fr/dcproject/component/constitution/routes/CreateConstitution.kt
View File

@@ -1,6 +1,5 @@
package fr.dcproject.component.constitution.routes package fr.dcproject.component.constitution.routes
import fr.dcproject.common.entity.Entity
import fr.dcproject.common.security.assert import fr.dcproject.common.security.assert
import fr.dcproject.common.utils.receiveOrBadRequest import fr.dcproject.common.utils.receiveOrBadRequest
import fr.dcproject.component.article.database.ArticleRef import fr.dcproject.component.article.database.ArticleRef
@@ -9,12 +8,13 @@ import fr.dcproject.component.auth.citizenOrNull
import fr.dcproject.component.citizen.database.Citizen import fr.dcproject.component.citizen.database.Citizen
import fr.dcproject.component.citizen.database.CitizenWithUserI import fr.dcproject.component.citizen.database.CitizenWithUserI
import fr.dcproject.component.constitution.ConstitutionAccessControl import fr.dcproject.component.constitution.ConstitutionAccessControl
import fr.dcproject.component.constitution.database.ConstitutionForUpdate
import fr.dcproject.component.constitution.database.ConstitutionForUpdate.TitleForUpdate
import fr.dcproject.component.constitution.database.ConstitutionRepository import fr.dcproject.component.constitution.database.ConstitutionRepository
import fr.dcproject.component.constitution.database.ConstitutionSimple
import fr.dcproject.component.constitution.database.ConstitutionSimple.TitleSimple
import fr.dcproject.component.constitution.routes.CreateConstitution.PostConstitutionRequest.Input import fr.dcproject.component.constitution.routes.CreateConstitution.PostConstitutionRequest.Input
import fr.dcproject.component.constitution.routes.CreateConstitution.PostConstitutionRequest.Input.Title import fr.dcproject.component.constitution.routes.CreateConstitution.PostConstitutionRequest.Input.Title
import io.ktor.application.call import io.ktor.application.call
import io.ktor.http.HttpStatusCode
import io.ktor.locations.KtorExperimentalLocationsAPI import io.ktor.locations.KtorExperimentalLocationsAPI
import io.ktor.locations.Location import io.ktor.locations.Location
import io.ktor.locations.post import io.ktor.locations.post
@@ -27,30 +27,25 @@ object CreateConstitution {
@Location("/constitutions") @Location("/constitutions")
class PostConstitutionRequest { class PostConstitutionRequest {
class Input( class Input(
var title: String, val title: String,
var anonymous: Boolean = true, val anonymous: Boolean = true,
var titles: MutableList<Title> = mutableListOf(), val titles: MutableList<Title> = mutableListOf(),
var draft: Boolean = false, val draft: Boolean = false,
var lastVersion: Boolean = false, val versionId: UUID = UUID.randomUUID()
var versionId: UUID = UUID.randomUUID()
) { ) {
init {
titles.forEachIndexed { index, title ->
title.rank = index
}
}
class Title( class Title(
id: UUID = UUID.randomUUID(), val id: UUID = UUID.randomUUID(),
var name: String, val name: String,
var rank: Int? = null, val articles: List<ArticleRef> = listOf()
var articles: MutableList<ArticleRef> = mutableListOf() ) {
) : Entity(id) class ArticleRef(val id: UUID)
}
} }
} }
private fun getNewConstitution(input: Input, citizen: Citizen) = input.run { private fun getNewConstitution(input: Input, citizen: Citizen) = input.run {
ConstitutionSimple<CitizenWithUserI, TitleSimple<ArticleRef>>( ConstitutionForUpdate<CitizenWithUserI, TitleForUpdate<ArticleRef>>(
id = UUID.randomUUID(), id = UUID.randomUUID(),
title = title, title = title,
titles = titles.create(), titles = titles.create(),
@@ -59,23 +54,64 @@ object CreateConstitution {
) )
} }
private fun List<Title>.create(): MutableList<TitleSimple<ArticleRef>> = private fun List<Title>.create(): MutableList<TitleForUpdate<ArticleRef>> =
map { it.create() }.toMutableList() map { it.create() }.toMutableList()
private fun Title.create(): TitleSimple<ArticleRef> = private fun Title.create(): TitleForUpdate<ArticleRef> =
TitleSimple( TitleForUpdate(
id, id,
name, name,
rank, articles.map { ArticleRef(it.id) }
articles
) )
fun Route.createConstitution(repo: ConstitutionRepository, ac: ConstitutionAccessControl) { fun Route.createConstitution(repo: ConstitutionRepository, ac: ConstitutionAccessControl) {
post<PostConstitutionRequest> { post<PostConstitutionRequest> {
getNewConstitution(call.receiveOrBadRequest(), citizen).let { getNewConstitution(call.receiveOrBadRequest(), citizen).let {
ac.assert { canCreate(it, citizenOrNull) } ac.assert { canCreate(it, citizenOrNull) }
repo.upsert(it) val c = repo.upsert(it) ?: error("Unable to create Constitution")
call.respond(it) call.respond(
HttpStatusCode.Created,
object {
val id: UUID = c.id
val title: String = c.title
val titles: List<Any> = c.titles.map { t ->
object {
val id: UUID = t.id
val name: String = t.name
val rank: Int = t.rank
val articles: List<Any> = t.articles.map { a ->
val id = a.id
val title = a.title
val createdBy = a.createdBy.let { cr ->
object {
val id: UUID = cr.id
val name: Any = cr.name.let { n ->
object {
val firstName: String = n.firstName
val lastName: String = n.lastName
}
}
val user: Any = cr.user.let { u ->
object {
val username: String = u.username
}
}
}
}
val workgroup: Any? = a.workgroup?.let { w ->
object {
val id = w.id
val name = w.name
}
}
}
}
}
val anonymous: Boolean = c.anonymous
val draft: Boolean = c.draft
val versionId: UUID = c.versionId
}
)
} }
} }
} }

6
src/main/kotlin/fr/dcproject/component/follow/database/FollowRepository.kt
View File

@@ -5,6 +5,7 @@ import fr.dcproject.common.entity.TargetRef
import fr.dcproject.component.article.database.ArticleForView import fr.dcproject.component.article.database.ArticleForView
import fr.dcproject.component.article.database.ArticleRef import fr.dcproject.component.article.database.ArticleRef
import fr.dcproject.component.citizen.database.CitizenI import fr.dcproject.component.citizen.database.CitizenI
import fr.dcproject.component.constitution.database.ConstitutionForView
import fr.dcproject.component.constitution.database.ConstitutionRef import fr.dcproject.component.constitution.database.ConstitutionRef
import fr.postgresjson.connexion.Paginated import fr.postgresjson.connexion.Paginated
import fr.postgresjson.connexion.Requester import fr.postgresjson.connexion.Requester
@@ -12,7 +13,6 @@ import fr.postgresjson.repository.RepositoryI
import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.flow import kotlinx.coroutines.flow.flow
import java.util.UUID import java.util.UUID
import fr.dcproject.component.constitution.database.Constitution as ConstitutionEntity
sealed class FollowRepository<IN : TargetRef, OUT : TargetRef>(override var requester: Requester) : RepositoryI { sealed class FollowRepository<IN : TargetRef, OUT : TargetRef>(override var requester: Requester) : RepositoryI {
open fun findByCitizen( open fun findByCitizen(
@@ -120,12 +120,12 @@ class FollowArticleRepository(requester: Requester) : FollowRepository<ArticleRe
} }
} }
class FollowConstitutionRepository(requester: Requester) : FollowRepository<ConstitutionRef, ConstitutionEntity>(requester) { class FollowConstitutionRepository(requester: Requester) : FollowRepository<ConstitutionRef, ConstitutionForView>(requester) {
override fun findByCitizen( override fun findByCitizen(
citizenId: UUID, citizenId: UUID,
page: Int, page: Int,
limit: Int limit: Int
): Paginated<FollowForView<ConstitutionEntity>> { ): Paginated<FollowForView<ConstitutionForView>> {
return requester.run { return requester.run {
getFunction("find_follows_constitution_by_citizen") getFunction("find_follows_constitution_by_citizen")
.select( .select(

8
src/main/kotlin/fr/dcproject/component/vote/database/VoteRepositoryAbs.kt
View File

@@ -7,7 +7,7 @@ import fr.dcproject.component.article.database.ArticleForView
import fr.dcproject.component.citizen.database.CitizenCreatorI import fr.dcproject.component.citizen.database.CitizenCreatorI
import fr.dcproject.component.citizen.database.CitizenI import fr.dcproject.component.citizen.database.CitizenI
import fr.dcproject.component.comment.generic.database.CommentForView import fr.dcproject.component.comment.generic.database.CommentForView
import fr.dcproject.component.constitution.database.Constitution import fr.dcproject.component.constitution.database.ConstitutionForView
import fr.dcproject.component.vote.entity.VoteAggregation import fr.dcproject.component.vote.entity.VoteAggregation
import fr.postgresjson.connexion.Paginated import fr.postgresjson.connexion.Paginated
import fr.postgresjson.connexion.Requester import fr.postgresjson.connexion.Requester
@@ -116,16 +116,16 @@ class VoteCommentRepository(requester: Requester) : VoteRepositoryAbs<CommentFor
) )
} }
class VoteConstitutionRepository(requester: Requester) : VoteRepositoryAbs<Constitution>(requester) { class VoteConstitutionRepository(requester: Requester) : VoteRepositoryAbs<ConstitutionForView>(requester) {
fun findByCitizen( fun findByCitizen(
citizen: CitizenEntity, citizen: CitizenEntity,
page: Int = 1, page: Int = 1,
limit: Int = 50 limit: Int = 50
): Paginated<VoteEntity<Constitution>> = ): Paginated<VoteEntity<ConstitutionForView>> =
findByCitizen( findByCitizen(
citizen.id, citizen.id,
"constitution", "constitution",
object : TypeReference<List<VoteEntity<Constitution>>>() {}, object : TypeReference<List<VoteEntity<ConstitutionForView>>>() {},
page, page,
limit limit
) )

1
src/main/resources/sql/functions/constitution/find_constitutions.sql
View File

@@ -15,7 +15,6 @@ begin
select select
c.*, c.*,
find_citizen_by_id_with_user(c.created_by_id) as created_by, find_citizen_by_id_with_user(c.created_by_id) as created_by,
find_constitution_titles_by_id(c.id) as titles,
zdb.score(c.ctid) _score zdb.score(c.ctid) _score
from constitution as c from constitution as c
where _search is null or _search = '' or c ==> dsl.multi_match('{title^3, intro}', _search) where _search is null or _search = '' or c ==> dsl.multi_match('{title^3, intro}', _search)

20
src/test/kotlin/integration/steps/given/Constitution.kt
View File

@@ -5,17 +5,17 @@ import fr.dcproject.common.utils.toUUID
import fr.dcproject.component.article.database.ArticleRef import fr.dcproject.component.article.database.ArticleRef
import fr.dcproject.component.citizen.database.CitizenI.Name import fr.dcproject.component.citizen.database.CitizenI.Name
import fr.dcproject.component.citizen.database.CitizenWithUserI import fr.dcproject.component.citizen.database.CitizenWithUserI
import fr.dcproject.component.constitution.database.Constitution import fr.dcproject.component.constitution.database.ConstitutionForUpdate
import fr.dcproject.component.constitution.database.ConstitutionForUpdate.TitleForUpdate
import fr.dcproject.component.constitution.database.ConstitutionForView
import fr.dcproject.component.constitution.database.ConstitutionRepository import fr.dcproject.component.constitution.database.ConstitutionRepository
import fr.dcproject.component.constitution.database.ConstitutionSimple
import fr.dcproject.component.constitution.database.ConstitutionSimple.TitleSimple
import io.ktor.server.testing.TestApplicationEngine import io.ktor.server.testing.TestApplicationEngine
import org.koin.core.context.GlobalContext import org.koin.core.context.GlobalContext
import java.util.UUID import java.util.UUID
fun TestApplicationEngine.`Given I have constitution`( fun TestApplicationEngine.`Given I have constitution`(
id: String? = null, id: String? = null,
titles: List<TitleSimple<ArticleRef>>? = null, titles: List<TitleForUpdate<ArticleRef>>? = null,
createdBy: Name? = null createdBy: Name? = null
) { ) {
createConstitution(id?.toUUID(), titles, createdBy) createConstitution(id?.toUUID(), titles, createdBy)
@@ -29,26 +29,26 @@ fun TestApplicationEngine.`Given I have constitutions`(
} }
} }
fun createTitles(nbr: Int): List<TitleSimple<ArticleRef>> = sequence { fun createTitles(nbr: Int): List<TitleForUpdate<ArticleRef>> = sequence {
repeat(nbr) { repeat(nbr) {
yield(createTitle()) yield(createTitle())
} }
}.toList() }.toList()
fun createTitle(): TitleSimple<ArticleRef> { fun createTitle(): TitleForUpdate<ArticleRef> {
return TitleSimple(name = LoremIpsum().getTitle(3)) return TitleForUpdate(name = LoremIpsum().getTitle(3))
} }
fun createConstitution( fun createConstitution(
id: UUID? = null, id: UUID? = null,
titles: List<TitleSimple<ArticleRef>>? = null, titles: List<TitleForUpdate<ArticleRef>>? = null,
createdBy: Name? = null createdBy: Name? = null
): Constitution { ): ConstitutionForView {
val constitutionRepository: ConstitutionRepository by lazy { GlobalContext.get().koin.get() } val constitutionRepository: ConstitutionRepository by lazy { GlobalContext.get().koin.get() }
val creator: CitizenWithUserI = createCitizen(createdBy) val creator: CitizenWithUserI = createCitizen(createdBy)
val constitution = ConstitutionSimple( val constitution = ConstitutionForUpdate(
id = id ?: UUID.randomUUID(), id = id ?: UUID.randomUUID(),
title = LoremIpsum().getTitle(3), title = LoremIpsum().getTitle(3),
titles = titles ?: createTitles(5), titles = titles ?: createTitles(5),