Skip to content
This repository was archived by the owner on Feb 12, 2022. It is now read-only.

Commit

Permalink
raml-for-jax-rs-295 - Discriminator field is 'null' in subtype (#295)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jpbelang
jpbelang committed Aug 22, 2017
1 parent 94d6180 commit 7c3f2ff
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 31 deletions.
3 changes: 2 additions & 1 deletion raml-to-jaxrs/jaxrs-code-generator/src/main/java/org/raml/jaxrs/generator/v10/V10GType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.raml.jaxrs.generator.v10;

import com.google.common.base.Optional;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.TypeName;
import org.raml.jaxrs.generator.CurrentBuild;
Expand Down Expand Up @@ -82,7 +83,7 @@ public interface V10GType extends GType {

String discriminator();

String discriminatorValue();
Optional<String> discriminatorValue();


Collection<V10GType> childClasses(String typeName);
Expand Down
59 changes: 36 additions & 23 deletions ...src/main/java/org/raml/jaxrs/generator/v10/typegenerators/SimpleInheritanceExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.raml.jaxrs.generator.v10.typegenerators;

import com.google.common.base.Supplier;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.FieldSpec;
import com.squareup.javapoet.MethodSpec;
Expand All @@ -28,7 +29,6 @@
import org.raml.jaxrs.generator.builders.BuildPhase;
import org.raml.jaxrs.generator.builders.JavaPoetTypeGenerator;
import org.raml.jaxrs.generator.builders.TypeGenerator;
import org.raml.jaxrs.generator.extension.types.MethodExtension;
import org.raml.jaxrs.generator.extension.types.MethodType;
import org.raml.jaxrs.generator.extension.types.PredefinedFieldType;
import org.raml.jaxrs.generator.extension.types.PredefinedMethodType;
Expand Down Expand Up @@ -131,16 +131,16 @@ private TypeSpec.Builder buildTypeImplementation(TypeContext context, V10GType o
return typeSpec;
}

private void buildPropertiesForImplementation(TypeContext context, V10GType objectType,
TypeSpec.Builder typeSpec, List<PropertyInfo> properties) {
for (PropertyInfo propertyInfo : properties) {
private void buildPropertiesForImplementation(final TypeContext context, final V10GType objectType,
final TypeSpec.Builder typeSpec, List<PropertyInfo> properties) {
for (final PropertyInfo propertyInfo : properties) {

FieldSpec.Builder fieldSpec =
FieldSpec.builder(propertyInfo.resolve(context), Names.variableName(propertyInfo.getName()))
.addModifiers(Modifier.PRIVATE);

if (propertyInfo.getName().equals(objectType.discriminator())) {
fieldSpec.initializer("$S", objectType.discriminatorValue());
fieldSpec.initializer("$S", objectType.discriminatorValue().or(calculateValue(context, objectType, typeSpec, propertyInfo)));
}

fieldSpec =
Expand All @@ -165,9 +165,9 @@ private void buildPropertiesForImplementation(TypeContext context, V10GType obje

getSpec.returns(propertyInfo.resolve(context));
getSpec =
runMethodExtensions(context, objectType, typeSpec, getSpec, Collections.<ParameterSpec.Builder>emptyList(),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.IMPLEMENTATION, PredefinedMethodType.GETTER,
Annotations.ON_TYPE_METHOD_CREATION);
runPropertyExtensions(context, objectType, typeSpec, getSpec, Collections.<ParameterSpec.Builder>emptyList(),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.IMPLEMENTATION, PredefinedMethodType.GETTER
);

if (getSpec != null) {
typeSpec.addMethod(getSpec.build());
Expand All @@ -187,9 +187,9 @@ private void buildPropertiesForImplementation(TypeContext context, V10GType obje
setSpec.addParameter(parameterSpec.build());

setSpec =
runMethodExtensions(context, objectType, typeSpec, setSpec, Collections.singletonList(parameterSpec),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.IMPLEMENTATION,
PredefinedMethodType.SETTER, Annotations.ON_TYPE_METHOD_CREATION);
runPropertyExtensions(context, objectType, typeSpec, setSpec, Collections.singletonList(parameterSpec),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.IMPLEMENTATION,
PredefinedMethodType.SETTER);

if (setSpec != null) {
typeSpec.addMethod(setSpec.build());
Expand All @@ -198,6 +198,19 @@ private void buildPropertiesForImplementation(TypeContext context, V10GType obje
}
}

private Supplier<String> calculateValue(final TypeContext context, final V10GType objectType, final TypeSpec.Builder typeSpec, final PropertyInfo propertyInfo) {
return new Supplier<String>() {
@Override
public String get() {
if (propertyInfo.resolve(context).toString().equals("java.lang.String")) {
return typeSpec.build().name;
} else {
throw new GenerationException("while generating type " + objectType.name() + " discriminatorValue not defined and not of type string ( can't map java type name to anything but string )" );
}
}
};
}

private TypeSpec.Builder buildDeclaration(TypeContext context, V10GType objectType) {

List<V10GType> parentTypes = originalType.parentTypes();
Expand Down Expand Up @@ -275,9 +288,9 @@ private void buildPropertiesForInterface(TypeContext context, V10GType objectTyp
getSpec.returns(propertyInfo.resolve(context));

getSpec =
runMethodExtensions(context, objectType, typeSpec, getSpec, Collections.<ParameterSpec.Builder>emptyList(),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.INTERFACE, PredefinedMethodType.GETTER,
Annotations.ON_TYPE_METHOD_CREATION);
runPropertyExtensions(context, objectType, typeSpec, getSpec, Collections.<ParameterSpec.Builder>emptyList(),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.INTERFACE, PredefinedMethodType.GETTER
);

if (getSpec != null) {
typeSpec.addMethod(getSpec.build());
Expand All @@ -294,9 +307,9 @@ private void buildPropertiesForInterface(TypeContext context, V10GType objectTyp
parameterSpec.build());

setSpec =
runMethodExtensions(context, objectType, typeSpec, setSpec, Collections.singletonList(parameterSpec),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.INTERFACE, PredefinedMethodType.SETTER,
Annotations.ON_TYPE_METHOD_CREATION);
runPropertyExtensions(context, objectType, typeSpec, setSpec, Collections.singletonList(parameterSpec),
(V10GProperty) propertyInfo.getProperty(), BuildPhase.INTERFACE, PredefinedMethodType.SETTER
);

if (setSpec != null) {
typeSpec.addMethod(setSpec.build());
Expand Down Expand Up @@ -329,16 +342,16 @@ private static TypeGenerator inlineTypeBuild(V10TypeRegistry registry, CurrentBu
throw new GenerationException("don't know what to do with type " + type.getDeclaredType());
}

private MethodSpec.Builder runMethodExtensions(TypeContext context, V10GType objectType, TypeSpec.Builder typeSpec,
MethodSpec.Builder getSpec, List<ParameterSpec.Builder> parameters,
V10GProperty property,
BuildPhase phase,
MethodType methodType, Annotations<MethodExtension> annotations) {
private MethodSpec.Builder runPropertyExtensions(TypeContext context, V10GType objectType, TypeSpec.Builder typeSpec,
MethodSpec.Builder getSpec, List<ParameterSpec.Builder> parameters,
V10GProperty property,
BuildPhase phase,
MethodType methodType) {

MethodSpec.Builder builder = context.onMethod(context, typeSpec, getSpec, parameters,
objectType, property, phase, methodType);

builder = currentBuild.getMethodExtension(annotations, objectType)
builder = currentBuild.getMethodExtension(Annotations.ON_TYPE_METHOD_CREATION, objectType)
.onMethod(context, typeSpec, builder, parameters, objectType, property, phase, methodType);
return builder;
}
Expand Down
5 changes: 3 additions & 2 deletions ...jaxrs-code-generator/src/main/java/org/raml/jaxrs/generator/v10/types/V10GTypeHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.raml.jaxrs.generator.v10.types;

import com.google.common.base.Optional;
import com.squareup.javapoet.TypeName;
import org.raml.jaxrs.generator.CurrentBuild;
import org.raml.jaxrs.generator.GObjectType;
Expand Down Expand Up @@ -106,8 +107,8 @@ public String discriminator() {
}

@Override
public String discriminatorValue() {
return null;
public Optional<String> discriminatorValue() {
return Optional.absent();
}

@Override
Expand Down
5 changes: 3 additions & 2 deletions ...jaxrs-code-generator/src/main/java/org/raml/jaxrs/generator/v10/types/V10GTypeObject.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.raml.jaxrs.generator.v10.types;

import com.google.common.base.Optional;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.TypeName;
import org.raml.jaxrs.generator.CurrentBuild;
Expand Down Expand Up @@ -143,8 +144,8 @@ public String discriminator() {
}

@Override
public String discriminatorValue() {
return ((ObjectTypeDeclaration) typeDeclaration).discriminatorValue();
public Optional<String> discriminatorValue() {
return Optional.fromNullable(((ObjectTypeDeclaration) typeDeclaration).discriminatorValue());
}

public Collection<V10GType> childClasses(String typeName) {
Expand Down
11 changes: 11 additions & 0 deletions ...xrs-code-generator/src/test/java/org/raml/jaxrs/generator/matchers/FieldSpecMatchers.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ protected String featureValueOf(FieldSpec actual) {
};
}

public static Matcher<FieldSpec> initializer(Matcher<String> match) {

return new FeatureMatcher<FieldSpec, String>(match, "field initializer", "field initializer") {

@Override
protected String featureValueOf(FieldSpec actual) {
return actual.initializer.toString();
}
};
}

public static <T extends TypeName> Matcher<FieldSpec> fieldType(Matcher<T> match) {

return new FeatureMatcher<FieldSpec, T>(match, "type name", "type name") {
Expand Down
73 changes: 70 additions & 3 deletions ...test/java/org/raml/jaxrs/generator/v10/typegenerators/SimpleInheritanceExtensionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,22 @@
*/
package org.raml.jaxrs.generator.v10.typegenerators;

import com.google.common.base.Optional;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.FieldSpec;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.ParameterSpec;
import com.squareup.javapoet.TypeName;
import com.squareup.javapoet.TypeSpec;
import org.hamcrest.Matchers;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.raml.jaxrs.generator.CurrentBuild;
import org.raml.jaxrs.generator.GenerationException;
import org.raml.jaxrs.generator.builders.BuildPhase;
import org.raml.jaxrs.generator.extension.types.FieldExtension;
import org.raml.jaxrs.generator.extension.types.MethodExtension;
Expand All @@ -48,9 +51,7 @@
import java.util.Collections;
import java.util.List;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.*;
import static org.hamcrest.core.AllOf.allOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
Expand Down Expand Up @@ -172,6 +173,72 @@ public void withParentTypeImplementation() throws Exception {
}

@Test
public void withParentTypeImplementationAndDiscriminatorNoValue() throws Exception {

setupMocking(BuildPhase.IMPLEMENTATION);

when(type.parentTypes()).thenReturn(Collections.singletonList(parentType));

when(type.properties()).thenReturn(Collections.singletonList(property));
when(property.name()).thenReturn("Mimi");
when(property.type()).thenReturn(parameterType);
when(parameterType.defaultJavaTypeName("pack")).thenReturn(ClassName.get(String.class));
when(currentBuild.getMethodExtension(Annotations.ON_TYPE_METHOD_CREATION, type)).thenReturn(methodExtension);
when(currentBuild.getFieldExtension(Annotations.ON_TYPE_FIELD_CREATION, type)).thenReturn(fieldExtension);
mockMethodCreation(BuildPhase.IMPLEMENTATION);

when(type.discriminator()).thenReturn("Mimi");
when(type.discriminatorValue()).thenReturn(Optional.<String>absent());

when(parentType.defaultJavaTypeName("pack")).thenReturn(ClassName.bestGuess("pack.Daddy"));

SimpleInheritanceExtension ext = new SimpleInheritanceExtension(type, registry, currentBuild);
TypeSpec.Builder builder = ext.onType(typeContext, null, type, BuildPhase.IMPLEMENTATION);

assertNotNull(builder);
assertThat(builder.build(),
allOf(
TypeSpecMatchers.methods(
contains(
MethodSpecMatchers.methodName(equalTo("getMimi"))
)
),
TypeSpecMatchers.fields(
containsInAnyOrder(
allOf(
FieldSpecMatchers.fieldName(equalTo("mimi")),
FieldSpecMatchers.fieldType(equalTo(ClassName.get(String.class))),
FieldSpecMatchers.initializer(equalTo("\"Foo\""))
)
)
)));
}

@Test(expected = GenerationException.class)
public void withParentTypeImplementationAndDiscriminatorNoValueBadType() throws Exception {

setupMocking(BuildPhase.IMPLEMENTATION);

when(type.parentTypes()).thenReturn(Collections.singletonList(parentType));

when(type.properties()).thenReturn(Collections.singletonList(property));
when(property.name()).thenReturn("Mimi");
when(property.type()).thenReturn(parameterType);
when(parameterType.defaultJavaTypeName("pack")).thenReturn(ClassName.get(Integer.class));
when(currentBuild.getMethodExtension(Annotations.ON_TYPE_METHOD_CREATION, type)).thenReturn(methodExtension);
when(currentBuild.getFieldExtension(Annotations.ON_TYPE_FIELD_CREATION, type)).thenReturn(fieldExtension);
mockMethodCreation(BuildPhase.IMPLEMENTATION);

when(type.discriminator()).thenReturn("Mimi");
when(type.discriminatorValue()).thenReturn(Optional.<String>absent());

when(parentType.defaultJavaTypeName("pack")).thenReturn(ClassName.bestGuess("pack.Daddy"));

SimpleInheritanceExtension ext = new SimpleInheritanceExtension(type, registry, currentBuild);
TypeSpec.Builder builder = ext.onType(typeContext, null, type, BuildPhase.IMPLEMENTATION);
}

@Test
public void withProperty() throws Exception {

setupMocking(BuildPhase.INTERFACE);
Expand Down

0 comments on commit 7c3f2ff

Please sign in to comment.