Skip to content

Commit b87b125

Browse files
yevhenii-nadtochiiyevhenii-nadtochii
committed
Polish code of GoesPolicy 
1 parent a74e5b6 commit b87b125

File tree

4 files changed

+153
-69
lines changed

4 files changed

+153
-69
lines changed

‎model/src/main/kotlin/io/spine/validation/FieldIds.kt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/*
2+
* Copyright 2025, TeamDev. All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Redistribution and use in source and/or binary forms, with or without
11+
* modification, must retain the above copyright notice and the following
12+
* disclaimer.
13+
*
14+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25+
*/
26+
27+
package io.spine.validation
28+
29+
import io.spine.protodata.ast.Field
30+
31+
/**
32+
* Creates a new instance of [FieldId] for this [Field].
33+
*/
34+
public fun Field.id(): FieldId = fieldId {
35+
type = declaringType
36+
name = this@id.name
37+
}

‎model/src/main/kotlin/io/spine/validation/GoesPolicy.kt

+39-69
Original file line numberDiff line numberDiff line change
@@ -31,128 +31,98 @@ import io.spine.core.Where
3131
import io.spine.option.GoesOption
3232
import io.spine.protodata.Compilation
3333
import io.spine.protodata.ast.Field
34+
import io.spine.protodata.ast.FieldType
3435
import io.spine.protodata.ast.File
3536
import io.spine.protodata.ast.MessageType
3637
import io.spine.protodata.ast.PrimitiveType.TYPE_BYTES
3738
import io.spine.protodata.ast.PrimitiveType.TYPE_STRING
38-
import io.spine.protodata.ast.Span
3939
import io.spine.protodata.ast.event.FieldOptionDiscovered
4040
import io.spine.protodata.ast.field
4141
import io.spine.protodata.ast.qualifiedName
42-
import io.spine.protodata.ast.toPath
4342
import io.spine.protodata.ast.unpack
43+
import io.spine.protodata.check
4444
import io.spine.protodata.plugin.Policy
45-
import io.spine.server.event.NoReaction
45+
import io.spine.server.event.Just
4646
import io.spine.server.event.React
47-
import io.spine.server.event.asA
48-
import io.spine.server.tuple.EitherOf2
47+
import io.spine.server.event.just
4948
import io.spine.validation.event.GoesFieldDiscovered
5049
import io.spine.validation.event.goesFieldDiscovered
50+
import io.spine.validation.protodata.findField
51+
import io.spine.validation.protodata.message
5152

5253
/**
53-
* A policy to add a validation rule to a type whenever the `(goes)` field option
54-
* is discovered.
54+
* Controls whether a field should be validated with the `(goes)` option.
5555
*
56-
* This option, when being applied to a target field `A`, declares a dependency to
57-
* a field `B`. So, whenever `A` is set, `B` also must be set.
56+
* Whenever a filed marked with `(goes)` option is discovered,
57+
* emits [GoesFieldDiscovered] if the following conditions are met:
5858
*
59-
* Upon discovering a field with the mentioned option, the police emits the following
60-
* composite rule for `A`: `(A isNot Set) OR (B is Set)`.
59+
* 1. The field type is supported by the option.
60+
* 2. The companion field is present in the message.
61+
* 3. The companion field and the target field are different fields.
62+
* 4. The companion field type is supported by the option.
6163
*
62-
* Please note, this police relies on implementation of `required` option to determine
63-
* whether the field is set. Thus, inheriting its behavior regarding the supported
64-
* field types and specification about when a field of a specific type is considered
65-
* to be set.
64+
* Ant violation of the above conditions leads to a compilation error.
6665
*/
6766
internal class GoesPolicy : Policy<FieldOptionDiscovered>() {
6867

69-
// TODO:2025-02-18:yevhenii.nadtochii: Make non-nullable in ProtoData.
7068
override val typeSystem by lazy { super.typeSystem!! }
7169

7270
@React
7371
override fun whenever(
7472
@External @Where(field = OPTION_NAME, equals = GOES)
7573
event: FieldOptionDiscovered
76-
): EitherOf2<GoesFieldDiscovered, NoReaction> {
74+
): Just<GoesFieldDiscovered> {
7775
val field = event.subject
7876
val file = event.file
7977
checkFieldType(field, file)
8078

81-
// TODO:2025-02-18:yevhenii.nadtochii: Use a shortcut for `defaultMessage`.
8279
val option = event.option.unpack<GoesOption>()
83-
val declaringType = field.declaringType
84-
val declaringMessage = typeSystem.findMessage(declaringType)!!.first
80+
val declaringMessage = typeSystem.message(field.declaringType)
8581
val companionName = option.with
8682
checkFieldExists(declaringMessage, companionName, field, file)
8783

8884
val companionField = declaringMessage.field(companionName)
89-
checkDistinct(field, companionField, file)
85+
checkFieldsDistinct(field, companionField, file)
9086
checkCompanionType(companionField, file)
9187

92-
val message = option.errorMsg.ifEmpty { DefaultErrorMessage.from(option.descriptorForType) }
88+
val message = option.errorMsg.ifEmpty { option.descriptorForType.defaultMessage }
9389
return goesFieldDiscovered {
9490
id = field.id()
9591
errorMessage = message
9692
companion = companionField
9793
subject = field
98-
}.asA()
94+
}.just()
9995
}
10096
}
10197

102-
public fun Field.id(): FieldId = fieldId {
103-
type = declaringType
104-
name = this@id.name
105-
}
106-
107-
private fun checkFieldType(field: Field, file: File) {
108-
val type = field.type
109-
if (type.isPrimitive && type.primitive !in SUPPORTED_PRIMITIVES) {
110-
compilationError(file, field.span) {
111-
"The field type `${field.type}` of the `${field.qualifiedName}` field " +
112-
"is not supported by the `($GOES)` option."
113-
}
98+
private fun checkFieldType(field: Field, file: File) =
99+
Compilation.check(field.type.isSupported(), file, field.span) {
100+
"The field type `${field.type}` of the `${field.qualifiedName}` field " +
101+
"is not supported by the `($GOES)` option."
114102
}
115-
}
116103

117-
private fun checkCompanionType(field: Field, file: File) {
118-
val type = field.type
119-
if (type.isPrimitive && type.primitive !in SUPPORTED_PRIMITIVES) {
120-
compilationError(file, field.span) {
121-
"The field type `${field.type}` of the companion `${field.qualifiedName}` field " +
122-
"is not supported by the `($GOES)` option."
123-
}
104+
private fun checkCompanionType(companion: Field, file: File) =
105+
Compilation.check(companion.type.isSupported(), file, companion.span) {
106+
"The field type `${companion.type}` of the companion `${companion.qualifiedName}` field " +
107+
"is not supported by the `($GOES)` option."
124108
}
125-
}
126109

127-
private fun checkFieldExists(message: MessageType, companion: String, field: Field, file: File) {
128-
if (message.fieldList.find { it.name.value == companion } == null) {
129-
compilationError(file, field.span) {
130-
"The message `${message.name.qualifiedName}` does not have `$companion` field " +
131-
"declared as companion of `${field.name.value}` by the `($GOES)` option."
132-
}
110+
private fun checkFieldExists(message: MessageType, companion: String, field: Field, file: File) =
111+
Compilation.check(message.findField(companion) != null, file, field.span) {
112+
"The message `${message.name.qualifiedName}` does not have `$companion` field " +
113+
"declared as companion of `${field.name.value}` by the `($GOES)` option."
133114
}
134-
}
135115

136-
/**
137-
* Checks that the given [field] and its [companion] are distinct fields.
138-
*/
139-
private fun checkDistinct(field: Field, companion: Field, file: File) {
140-
if (field == companion) {
141-
compilationError(file, field.span) {
142-
"The `($GOES)` option can not use the marked field as its own companion. " +
143-
"Self-referencing is prohibited. Please specify another field. " +
144-
"The invalid field: `${field.qualifiedName}`."
145-
}
116+
private fun checkFieldsDistinct(field: Field, companion: Field, file: File) =
117+
Compilation.check(field != companion, file, field.span) {
118+
"The `($GOES)` option can not use the marked field as its own companion. " +
119+
"Self-referencing is prohibited. Please specify another field. " +
120+
"The invalid field: `${field.qualifiedName}`."
146121
}
147-
}
122+
123+
private fun FieldType.isSupported(): Boolean =
124+
!isPrimitive || primitive in SUPPORTED_PRIMITIVES
148125

149126
private val SUPPORTED_PRIMITIVES = listOf(
150127
TYPE_STRING, TYPE_BYTES
151128
)
152-
153-
private fun compilationError(file: File, span: Span, message: () -> String): Nothing =
154-
Compilation.error(
155-
file.toPath().toFile(),
156-
span.startLine, span.startColumn,
157-
message()
158-
)

‎model/src/main/kotlin/io/spine/validation/protodata/MessageTypes.kt

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2025, TeamDev. All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Redistribution and use in source and/or binary forms, with or without
11+
* modification, must retain the above copyright notice and the following
12+
* disclaimer.
13+
*
14+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25+
*/
26+
27+
package io.spine.validation.protodata
28+
29+
import io.spine.protodata.ast.Field
30+
import io.spine.protodata.ast.MessageType
31+
32+
/**
33+
* Looks up for a field with the given [name] in this [MessageType].
34+
*
35+
* @return the found [Field], or `null` if this [MessageType] does not have such a field.
36+
*/
37+
public fun MessageType.findField(name: String): Field? =
38+
fieldList.find { it.name.value == name }

‎model/src/main/kotlin/io/spine/validation/protodata/TypeSystem.kt

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* Copyright 2025, TeamDev. All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Redistribution and use in source and/or binary forms, with or without
11+
* modification, must retain the above copyright notice and the following
12+
* disclaimer.
13+
*
14+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25+
*/
26+
27+
package io.spine.validation.protodata
28+
29+
import io.spine.protodata.ast.MessageType
30+
import io.spine.protodata.ast.TypeName
31+
import io.spine.protodata.type.TypeSystem
32+
33+
/**
34+
* Returns a message type by its name.
35+
*
36+
* @throws IllegalArgumentException if the requested type is unknown for this [TypeSystem].
37+
*/
38+
public fun TypeSystem.message(type: TypeName): MessageType =
39+
findMessage(type)?.first ?: throw IllegalArgumentException("Message type not found: `$type`.")

0 commit comments

Comments
 (0)