Merge pull request #14 from nenadjakic/feature/add-code-to-entities

Added 'code' field to entities, update DTOs and converters, adjust sq…

Author: nenadjakic

.scripts/002-test-data.sql

@@ -13,17 +13,17 @@ VALUES ((SELECT id FROM "security"."user" WHERE username = 'admin@eav.eav'), (SE
 INSERT INTO "security"."user_role" (user_id, role_id)
 VALUES ((SELECT id FROM "security"."user" WHERE username = 'reader@eav.eav'), (SELECT id from "security"."role" WHERE "name" = 'READER'));
 
-INSERT INTO "public"."entity_type" (id, "name", "description") VALUES (nextval('public.entity_type_id_seq'), 'car', NULL);
-INSERT INTO "public"."entity_type" (id, "name", "description") VALUES (nextval('public.entity_type_id_seq'), 'book', NULL);
+INSERT INTO "public"."entity_type" (id, "code", "name", "description") VALUES (nextval('public.entity_type_id_seq'), 'C', 'car', NULL);
+INSERT INTO "public"."entity_type" (id, "code", "name", "description") VALUES (nextval('public.entity_type_id_seq'), 'B', 'book', NULL);
 
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'make', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'model', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'color', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'MAK', NULL, 'make', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'MOD', NULL, 'model', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'COL', NULL, 'color', (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
 
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'isbn', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'author', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'title', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
-INSERT INTO "public"."attribute" (id, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), NULL, 'publish_year', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'ISBN', NULL, 'isbn', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'AUT', NULL, 'author', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'TIT', NULL, 'title', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
+INSERT INTO "public"."attribute" (id, code, description, "name", entity_type_id) VALUES(nextval('public.attribute_id_seq'), 'PYE', NULL, 'publish_year', (SELECT id FROM "public"."entity_type" WHERE "name" = 'book'));
 
 INSERT INTO public.metadata (id, data_type, max_length, max_value, min_length, min_value, "repeatable", required, sub_attribute_ids)
 VALUES((SELECT id FROM "public"."attribute" WHERE "name" = 'make' AND entity_type_id =  (SELECT id FROM "public"."entity_type" WHERE "name" = 'car')), 'STRING', NULL, NULL, NULL, NULL, false, true, '[]'::jsonb);
@@ -60,7 +60,8 @@ VALUES('["READ", "CREATE", "UPDATE", "DELETE"]'::jsonb, (SELECT id FROM "public"
 INSERT INTO "security"."attribute_permission" (actions, attribute_id, role_id)
 VALUES('["READ", "CREATE", "DELETE"]'::jsonb, (SELECT id FROM "public"."attribute" WHERE "name" = 'color' AND entity_type_id =  (SELECT id FROM "public"."entity_type" WHERE "name" = 'car')), (SELECT id FROM "security"."role" WHERE "name" = 'ADMINISTRATOR'));
 
-INSERT INTO "public"."entity" (id, entity_type_id) VALUES (nextval('public.entity_id_seq'), (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'));
+INSERT INTO "public"."entity" (id, entity_type_id, code, description)
+VALUES (nextval('public.entity_id_seq'), (SELECT id FROM "public"."entity_type" WHERE "name" = 'car'), 'C1', NULL);
 
 INSERT INTO "public"."attribute_value" (value, "position", attribute_id, entity_id)
 VALUES('Ford', NULL, (SELECT id FROM "public"."attribute" WHERE "name" = 'make' AND entity_type_id = (SELECT id FROM "public"."entity_type" WHERE "name" = 'car')), (SELECT id from "public"."entity" LIMIT 1));

src/main/kotlin/com/github/nenadjakic/eav/controller/EavReadController.kt

@@ -3,6 +3,7 @@ package com.github.nenadjakic.eav.controller
 import org.springframework.data.domain.Page
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+import org.springframework.security.access.prepost.PostAuthorize
 import org.springframework.security.access.prepost.PreAuthorize
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PathVariable
@@ -17,6 +18,7 @@ import org.springframework.web.bind.annotation.RequestParam
 interface EavReadController<RE> {
 
     @PreAuthorize("hasRole('READER')")
+    //@PostAuthorize("@attributeSecurityService.canRead(1L)")
     @GetMapping(produces = [MediaType.APPLICATION_JSON_VALUE])
     fun findAll(): ResponseEntity<List<RE>>
 

src/main/kotlin/com/github/nenadjakic/eav/dto/AttributeAddRequest.kt

@@ -2,13 +2,18 @@ package com.github.nenadjakic.eav.dto
 
 import jakarta.validation.Valid
 import jakarta.validation.constraints.NotNull
+import jakarta.xml.bind.annotation.XmlElement
 
 class AttributeAddRequest {
     @NotNull
     var entityTypeId: Long? = null
 
+    @NotNull
+    lateinit var code: String
+
     @NotNull
     lateinit var name: String
+
     var description: String? = null
 
     @NotNull

src/main/kotlin/com/github/nenadjakic/eav/dto/AttributeResponse.kt

@@ -2,6 +2,7 @@ package com.github.nenadjakic.eav.dto
 
 data class AttributeResponse(
     val id: Long,
+    val code: String,
     val name: String,
     val description: String?,
     val metadata: MetadataResponse

src/main/kotlin/com/github/nenadjakic/eav/dto/AttributeUpdateRequest.kt

@@ -7,8 +7,12 @@ class AttributeUpdateRequest {
     @NotNull
     var id: Long? = null
 
+    @NotNull
+    lateinit var code: String
+
     @NotNull
     lateinit var name: String
+
     var description: String? = null
 
     @NotNull

src/main/kotlin/com/github/nenadjakic/eav/dto/AttributeValueResponse.kt

@@ -2,11 +2,15 @@ package com.github.nenadjakic.eav.dto
 
 data class EntitySimpleResponse(
     val entityId: Long,
+    val code: String,
+    val description: String?
 )
 
 data class AttributeSimpleResponse(
     val attributeId: Long,
+    val code: String,
     val attributeName: String,
+    val description: String?
 )
 
 data class AttributeValueSimpleResponse(

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityAddRequest.kt

@@ -5,4 +5,9 @@ import jakarta.validation.constraints.NotNull
 class EntityAddRequest {
     @NotNull
     var entityTypeId: Long? = null
+
+    @NotNull
+    lateinit var code: String
+
+    var description: String? = null
 }

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityResponse.kt

@@ -3,5 +3,7 @@ package com.github.nenadjakic.eav.dto
 data class EntityResponse(
     val id: Long,
     val entityType: EntityTypeSimpleResponse,
+    val code: String,
+    val description: String?,
     val attributeValues: List<AttributeValueSimpleResponse>
-)
+)

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityTypeAddRequest.kt

@@ -9,6 +9,10 @@ import jakarta.xml.bind.annotation.XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlRootElement(name="EntityTypeAddRequest")
 class EntityTypeAddRequest {
+    @NotNull
+    @XmlElement(name = "Code")
+    lateinit var code: String
+
     @NotNull
     @XmlElement(name = "Name")
     lateinit var name: String

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityTypeResponse.kt

@@ -2,6 +2,7 @@ package com.github.nenadjakic.eav.dto
 
 data class EntityTypeResponse(
     val id: Long,
+    val code: String?,
     val name: String,
     val description: String?,
     val attributes: List<AttributeResponse>

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityTypeSimpleResponse.kt

@@ -2,6 +2,7 @@ package com.github.nenadjakic.eav.dto
 
 data class EntityTypeSimpleResponse(
     val id: Long,
+    val code: String,
     val name: String,
     val description: String?,
 )

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityTypeUpdateRequest.kt

@@ -6,7 +6,11 @@ class EntityTypeUpdateRequest {
     @NotNull
     var id: Long? = null
 
+    @NotNull
+    lateinit var code: String
+
     @NotNull
     lateinit var name: String
+
     var description: String? = null
 }

src/main/kotlin/com/github/nenadjakic/eav/dto/EntityUpdateRequest.kt

@@ -7,7 +7,11 @@ class EntityUpdateRequest {
     @NotNull
     var id: Long? = null
 
+    @NotNull
+    lateinit var code: String
+
     @NotNull
     lateinit var name: String
+
     var description: String? = null
 }

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/AttributeAddRequestToAttributeConverter.kt

@@ -11,6 +11,7 @@ class AttributeAddRequestToAttributeConverter : AbstractConverter<AttributeAddRe
         val destination = Attribute()
         destination.entityType = EntityType()
         destination.entityType.id = source!!.entityTypeId!!
+        destination.code = source.code
         destination.name = source.name
         destination.description = source.description
 

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/AttributeToAttributeResponseConverter.kt

@@ -20,6 +20,7 @@ class AttributeToAttributeResponseConverter : AbstractConverter<Attribute, Attri
         )
         return AttributeResponse(
             source.id!!,
+            source.code,
             source.name,
             source.description,
             metadataResponse)

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/AttributeUpdateRequestToAttributeConverter.kt

@@ -9,6 +9,7 @@ class AttributeUpdateRequestToAttributeConverter : AbstractConverter<AttributeUp
     override fun convert(source: AttributeUpdateRequest?): Attribute {
         val destination: Attribute = Attribute()
         destination.id = source!!.id
+        destination.code = source.code
         destination.name = source.name
         destination.description = source.description
 

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/AttributeValueToAttributeValueResponseConverter.kt

@@ -10,10 +10,16 @@ class AttributeValueToAttributeValueResponseConverter : AbstractConverter<Attrib
     override fun convert(source: AttributeValue?): AttributeValueResponse {
 
         return AttributeValueResponse(
-            EntitySimpleResponse(source!!.entity.id!!),
+            EntitySimpleResponse(
+                source!!.entity.id!!,
+                source.entity.code,
+                source.entity.description
+            ),
             AttributeSimpleResponse(
                 source.attribute.id!!,
-                source.attribute.name
+                source.attribute.code,
+                source.attribute.name,
+                source.attribute.description
             ),
             source.value!!.toString())
     }

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/EntityToEntityResponseConverter.kt

@@ -11,16 +11,25 @@ class EntityToEntityResponseConverter : AbstractConverter<Entity, EntityResponse
     override fun convert(source: Entity?): EntityResponse {
         val attibuteValues: MutableList<AttributeValueSimpleResponse> = mutableListOf()
         source!!.attributeValues.forEach { attibuteValues.add(AttributeValueSimpleResponse(
-            AttributeSimpleResponse(it.attribute.id!!, it.attribute.name),
-            it.value
-        )) }
+                AttributeSimpleResponse(
+                    it.attribute.id!!,
+                    it.attribute.code,
+                    it.attribute.name,
+                    it.attribute.description
+                ),
+                it.value
+            ))
+        }
         return EntityResponse(
             source.id!!,
             EntityTypeSimpleResponse(
                 source.entityType.id!!,
+                source.entityType.code,
                 source.entityType.name,
                 source.entityType.description
             ),
+            source.code,
+            source.description,
             attibuteValues
         )
     }

src/main/kotlin/com/github/nenadjakic/eav/dto/converter/EntityTypeToEntityTypeResponseConverter.kt

@@ -11,6 +11,7 @@ class EntityTypeToEntityTypeResponseConverter : AbstractConverter<EntityType, En
         val attributeResponses: MutableList<AttributeResponse> = mutableListOf()
         source!!.attributes.forEach { attributeResponses.add(AttributeResponse(
             it.id!!,
+            it.code,
             it.name,
             it.description,
             MetadataResponse(
@@ -26,6 +27,7 @@ class EntityTypeToEntityTypeResponseConverter : AbstractConverter<EntityType, En
         )) }
         return EntityTypeResponse(
             source.id!!,
+            source.code,
             source.name,
             source.description,
             attributeResponses

src/main/kotlin/com/github/nenadjakic/eav/entity/Attribute.kt

@@ -12,6 +12,7 @@ import jakarta.persistence.Entity
     schema = "public",
     name = "attribute",
     uniqueConstraints = [
+        UniqueConstraint(name = "uq_attribute_code", columnNames = [ "code" ]),
         UniqueConstraint(name = "uq_attribute_entity_type_id_name", columnNames = ["entity_type_id", "name"])
     ])
 class Attribute : AbstractEntityId<Long>() {
@@ -25,6 +26,9 @@ class Attribute : AbstractEntityId<Long>() {
     @JoinColumn(name = "entity_type_id", nullable = false, updatable = false)
     lateinit var entityType: EntityType
 
+    @Column(name = "code", nullable = false, unique = true, length = 25)
+    lateinit var code: String
+
     @Column(name = "name", nullable = false, unique = true, length = 100)
     lateinit var name: String
 

src/main/kotlin/com/github/nenadjakic/eav/entity/Entity.kt

@@ -8,7 +8,12 @@ import jakarta.persistence.Entity
  * This class is mapped to the "entity" table in the "public" schema.
  */
 @Entity
-@Table(schema = "public", name = "entity")
+@Table(
+    schema = "public",
+    name = "entity",
+    uniqueConstraints = [
+        UniqueConstraint(name = "uq_entity_entity_type_id_code", columnNames = [ "entity_type_id", "code"])
+    ])
 class Entity  : AbstractEntityId<Long>() {
     @Id
     @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "entity_id_seq")
@@ -21,6 +26,12 @@ class Entity  : AbstractEntityId<Long>() {
     @JoinColumn(name = "entity_type_id", nullable = false, updatable = false)
     lateinit var entityType: EntityType
 
+    @Column(name = "code", nullable = false)
+    lateinit var code: String
+
+    @Column(name = "description", length = 1000)
+    var description: String? = null
+
     @OneToMany(mappedBy = "entity")
     private val _attributeValues: MutableList<AttributeValue> = mutableListOf()
 

src/main/kotlin/com/github/nenadjakic/eav/entity/EntityType.kt

@@ -8,6 +8,7 @@ import jakarta.persistence.Entity
     schema = "public",
     name = "entity_type",
     uniqueConstraints = [
+        UniqueConstraint(name = "uq_entity_type_code", columnNames = [ "code" ]),
         UniqueConstraint(name = "uq_entity_type_name", columnNames = [ "name" ])
     ])
 class EntityType : AbstractEntityId<Long>() {
@@ -18,6 +19,9 @@ class EntityType : AbstractEntityId<Long>() {
     @Column(name = "id")
     override var id: Long? = null
 
+    @Column(name = "code", nullable = false, unique = true, length = 25)
+    lateinit var code: String
+
     @Column(name = "name", nullable = false, unique = true, length = 100)
     lateinit var name: String
 

src/test/kotlin/com/github/nenadjakic/eav/controller/EntityControllerTest.kt

@@ -109,6 +109,7 @@ class EntityControllerTest {
     fun create() {
         val body = EntityAddRequest()
         body.entityTypeId = 10001
+        body.code = "ET1"
 
         val postResponse = restTemplate.exchange(
             "/entity",
@@ -131,6 +132,7 @@ class EntityControllerTest {
     fun update() {
         val body = EntityUpdateRequest()
         body.id = 10001
+        body.code = "ET1"
         body.name = "new_name_updated"
         body.description = "new_description"
         val putResponse = restTemplate.exchange(

src/test/kotlin/com/github/nenadjakic/eav/controller/EntityTypeControllerTest.kt

@@ -116,6 +116,7 @@ class EntityTypeControllerTest {
     @DisplayName("Create new entity type.")
     fun create() {
         val body = EntityTypeAddRequest()
+        body.code = "ET1"
         body.name = "new_name_added"
         body.description = "new_description"
         val postResponse = restTemplate.exchange<Void>(
@@ -140,6 +141,7 @@ class EntityTypeControllerTest {
     fun update() {
         val body = EntityTypeUpdateRequest()
         body.id = 10001
+        body.code = "001"
         body.name = "new_name_updated"
         body.description = "new_description"
         val putResponse = restTemplate.exchange(