Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

implement Comparable interface for TagObject and ExternalDocumentation #1589

Merged
merged 1 commit into from
Jan 25, 2023
Merged

implement Comparable interface for TagObject and ExternalDocumentation #1589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion smithy-openapi/src/main/java/software/amazon/smithy/openapi/model/ExternalDocumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,19 @@

package software.amazon.smithy.openapi.model;

import java.util.Comparator;
import java.util.Optional;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

public final class ExternalDocumentation extends Component implements ToSmithyBuilder<ExternalDocumentation> {
public final class ExternalDocumentation extends Component
implements ToSmithyBuilder<ExternalDocumentation>, Comparable<ExternalDocumentation> {

private static final Comparator<String> STRING_COMPARATOR = Comparator
.nullsFirst(String::compareTo);

private final String description;
private final String url;

Expand Down Expand Up @@ -58,6 +64,13 @@ protected ObjectNode.Builder createNodeBuilder() {
.withMember("url", url);
}

@Override
public int compareTo(ExternalDocumentation that) {
return Comparator.comparing(ExternalDocumentation::getUrl, STRING_COMPARATOR)
.thenComparing(ed -> ed.description, STRING_COMPARATOR)
.compare(this, that);
}

public static final class Builder extends Component.Builder<Builder, ExternalDocumentation> {
private String description;
private String url;
Expand Down
17 changes: 16 additions & 1 deletion smithy-openapi/src/main/java/software/amazon/smithy/openapi/model/TagObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,20 @@

package software.amazon.smithy.openapi.model;

import java.util.Comparator;
import java.util.Optional;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;

public final class TagObject extends Component implements ToSmithyBuilder<TagObject> {
public final class TagObject extends Component implements ToSmithyBuilder<TagObject>, Comparable<TagObject> {
private static final Comparator<String> STRING_COMPARATOR = Comparator
.nullsFirst(String::compareToIgnoreCase);

private static final Comparator<ExternalDocumentation> EXTERNAL_DOCUMENTATION_COMPARATOR = Comparator
.nullsFirst(ExternalDocumentation::compareTo);

private final String name;
private final String description;
private final ExternalDocumentation externalDocs;
Expand Down Expand Up @@ -66,6 +73,14 @@ protected ObjectNode.Builder createNodeBuilder() {
.withOptionalMember("externalDocs", getExternalDocs().map(ExternalDocumentation::toNode));
}

@Override
public int compareTo(TagObject that) {
return Comparator.comparing(TagObject::getName, STRING_COMPARATOR)
.thenComparing(to -> to.description, STRING_COMPARATOR)
.thenComparing(to -> to.externalDocs, EXTERNAL_DOCUMENTATION_COMPARATOR)
.compare(this, that);
}

public static final class Builder extends Component.Builder<Builder, TagObject> {
private String name;
private String description;
Expand Down
35 changes: 35 additions & 0 deletions ...openapi/src/test/java/software/amazon/smithy/openapi/model/ExternalDocumentationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package software.amazon.smithy.openapi.model;

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.util.stream.Stream;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;

class ExternalDocumentationTest {
private static final ExternalDocumentation DOC_1 =
ExternalDocumentation.builder()
.url("url1")
.description("description1")
.build();

private static Stream<Arguments> testData() {
return Stream.of(
Arguments.of(ExternalDocumentation.builder().url("url1").description("description1").build(), 0),
Arguments.of(ExternalDocumentation.builder().url("url1").description("description0").build(), 1),
Arguments.of(ExternalDocumentation.builder().url("url1").description("description2").build(), -1),
Arguments.of(ExternalDocumentation.builder().url("url0").description("description1").build(), 1),
Arguments.of(ExternalDocumentation.builder().url("url2").description("description1").build(), -1),
Arguments.of(ExternalDocumentation.builder().url("url1").build(), 1)
);
}

@ParameterizedTest
@MethodSource("testData")
void testCompareTo(ExternalDocumentation doc2, int expected) {
assertThat(DOC_1.compareTo(doc2), equalTo(expected));
}
}
38 changes: 38 additions & 0 deletions smithy-openapi/src/test/java/software/amazon/smithy/openapi/model/TagObjectTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package software.amazon.smithy.openapi.model;

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.util.stream.Stream;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;

class TagObjectTest {
private static final TagObject TAG_OBJECT_1 =
TagObject.builder()
.name("tag1")
.description("description1")
.externalDocs(ExternalDocumentation.builder().url("url1").build())
.build();

private static Stream<Arguments> testData() {
return Stream.of(
Arguments.of("tag1", "description1", ExternalDocumentation.builder().url("url1").build(), 0),
Arguments.of("tag0", "description1", ExternalDocumentation.builder().url("url1").build(), 1),
Arguments.of("tag1", "description1", ExternalDocumentation.builder().url("url2").build(), -1),
Arguments.of("tag2", "description1", ExternalDocumentation.builder().url("url1").build(), -1),
Arguments.of("tag1", "description2", ExternalDocumentation.builder().url("url1").build(), -1),
Arguments.of("tag1", null, ExternalDocumentation.builder().url("url1").build(), 1),
Arguments.of("tag1", "description1", null, 1)
);
}

@ParameterizedTest
@MethodSource("testData")
void testCompareTo(String name, String description, ExternalDocumentation doc, int expected) {
TagObject tagObject2 = TagObject.builder().name(name).description(description).externalDocs(doc).build();
assertThat(TAG_OBJECT_1.compareTo(tagObject2), equalTo(expected));
}
}