[#21] PUT /articles/:slug

- Implements ArticleUpdateRequest

Author: raeperd

src/main/java/io/github/raeperd/realworld/application/article/ArticlePutRequestDTO.java

@@ -0,0 +1,29 @@
+package io.github.raeperd.realworld.application.article;
+
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import io.github.raeperd.realworld.domain.article.ArticleTitle;
+import io.github.raeperd.realworld.domain.article.ArticleUpdateRequest;
+import lombok.Value;
+
+import static com.fasterxml.jackson.annotation.JsonTypeInfo.As.WRAPPER_OBJECT;
+import static com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME;
+import static io.github.raeperd.realworld.domain.article.ArticleUpdateRequest.builder;
+import static java.util.Optional.ofNullable;
+
+@JsonTypeName("article")
+@JsonTypeInfo(include = WRAPPER_OBJECT, use = NAME)
+@Value
+class ArticlePutRequestDTO {
+
+ String title;
+ String description;
+ String body;
+
+ ArticleUpdateRequest toUpdateRequest() {
+ return builder().titleToUpdate(ofNullable(title).map(ArticleTitle::of).orElse(null))
+ .descriptionToUpdate(description)
+ .bodyToUpdate(body)
+ .build();
+ }
+}

src/main/java/io/github/raeperd/realworld/application/article/ArticleRestController.java

@@ -65,6 +65,14 @@ public ResponseEntity<ArticleModel> getArticleBySlug(@PathVariable String slug)
  .map(ArticleModel::fromArticle));
  }
 
+ @PutMapping("/articles/{slug}")
+ public ArticleModel putArticleBySlug(@AuthenticationPrincipal UserJWTPayload jwtPayload,
+ @PathVariable String slug,
+ @RequestBody ArticlePutRequestDTO dto) {
+ final var articleUpdated = articleService.updateArticle(jwtPayload.getUserId(), slug, dto.toUpdateRequest());
+ return ArticleModel.fromArticle(articleUpdated);
+ }
+
  @PostMapping("/articles/{slug}/favorite")
  public ArticleModel favoriteArticleBySlug(@AuthenticationPrincipal UserJWTPayload jwtPayload,
  @PathVariable String slug) {

src/main/java/io/github/raeperd/realworld/domain/article/Article.java

@@ -66,6 +66,10 @@ public Article afterUserUnFavoritesArticle(User user) {
  return updateFavoriteByUser(user);
  }
 
+ public void updateArticle(ArticleUpdateRequest updateRequest) {
+ contents.updateArticleContentsIfPresent(updateRequest);
+ }
+
  public User getAuthor() {
  return author;
  }

src/main/java/io/github/raeperd/realworld/domain/article/ArticleContents.java

@@ -53,6 +53,12 @@ public Set<Tag> getTags() {
  return tags;
  }
 
+ void updateArticleContentsIfPresent(ArticleUpdateRequest updateRequest) {
+ updateRequest.getTitleToUpdate().ifPresent(titleToUpdate -> title = titleToUpdate);
+ updateRequest.getDescriptionToUpdate().ifPresent(descriptionToUpdate -> description = descriptionToUpdate);
+ updateRequest.getBodyToUpdate().ifPresent(bodyToUpdate -> body = bodyToUpdate);
+ }
+
  public void setTags(Set<Tag> tags) {
  this.tags = tags;
  }

src/main/java/io/github/raeperd/realworld/domain/article/ArticleService.java

@@ -75,6 +75,13 @@ public Optional<Article> getArticleBySlug(String slug) {
  return articleRepository.findFirstByContentsTitleSlug(slug);
  }
 
+ @Transactional
+ public Article updateArticle(long userId, String slug, ArticleUpdateRequest request) {
+ return mapIfAllPresent(userFindService.findById(userId), getArticleBySlug(slug),
+ (user, article) -> user.updateArticle(article, request))
+ .orElseThrow(NoSuchElementException::new);
+ }
+
  @Transactional
  public Article favoriteArticle(long userId, String articleSlugToFavorite) {
  return mapIfAllPresent(

src/main/java/io/github/raeperd/realworld/domain/article/ArticleUpdateRequest.java

@@ -0,0 +1,61 @@
+package io.github.raeperd.realworld.domain.article;
+
+import java.util.Optional;
+
+import static java.util.Optional.ofNullable;
+
+public class ArticleUpdateRequest {
+
+ private final ArticleTitle titleToUpdate;
+ private final String descriptionToUpdate;
+ private final String bodyToUpdate;
+
+ public static ArticleUpdateRequestBuilder builder() {
+ return new ArticleUpdateRequestBuilder();
+ }
+
+ Optional<ArticleTitle> getTitleToUpdate() {
+ return ofNullable(titleToUpdate);
+ }
+
+ Optional<String> getDescriptionToUpdate() {
+ return ofNullable(descriptionToUpdate);
+ }
+
+ Optional<String> getBodyToUpdate() {
+ return ofNullable(bodyToUpdate);
+ }
+
+ private ArticleUpdateRequest(ArticleUpdateRequestBuilder builder) {
+ this(builder.titleToUpdate, builder.descriptionToUpdate, builder.bodyToUpdate);
+ }
+
+ private ArticleUpdateRequest(ArticleTitle titleToUpdate, String descriptionToUpdate, String bodyToUpdate) {
+ this.titleToUpdate = titleToUpdate;
+ this.descriptionToUpdate = descriptionToUpdate;
+ this.bodyToUpdate = bodyToUpdate;
+ }
+
+ public static class ArticleUpdateRequestBuilder {
+ private ArticleTitle titleToUpdate;
+ private String descriptionToUpdate;
+ private String bodyToUpdate;
+
+ public ArticleUpdateRequestBuilder titleToUpdate(ArticleTitle titleToUpdate) {
+ this.titleToUpdate = titleToUpdate;
+ return this;
+ }
+ public ArticleUpdateRequestBuilder descriptionToUpdate(String descriptionToUpdate) {
+ this.descriptionToUpdate = descriptionToUpdate;
+ return this;
+ }
+ public ArticleUpdateRequestBuilder bodyToUpdate(String bodyToUpdate) {
+ this.bodyToUpdate = bodyToUpdate;
+ return this;
+ }
+
+ public ArticleUpdateRequest build() {
+ return new ArticleUpdateRequest(this);
+ }
+ }
+}

src/main/java/io/github/raeperd/realworld/domain/user/User.java

@@ -2,6 +2,7 @@
 
 import io.github.raeperd.realworld.domain.article.Article;
 import io.github.raeperd.realworld.domain.article.ArticleContents;
+import io.github.raeperd.realworld.domain.article.ArticleUpdateRequest;
 import org.springframework.security.crypto.password.PasswordEncoder;
 
 import javax.persistence.*;
@@ -55,6 +56,14 @@ public Article writeArticle(ArticleContents contents) {
  return new Article(this, contents);
  }
 
+ public Article updateArticle(Article article, ArticleUpdateRequest request) {
+ if (article.getAuthor() != this) {
+ throw new IllegalAccessError("Not authorized to update this article");
+ }
+ article.updateArticle(request);
+ return article;
+ }
+
  public Article favoriteArticle(Article articleToFavorite) {
  articleFavorited.add(articleToFavorite);
  return articleToFavorite.afterUserFavoritesArticle(this);

src/test/java/io/github/raeperd/realworld/IntegrationTest.java

@@ -198,6 +198,18 @@ void get_single_article_by_slug() throws Exception {
  .andExpect(validSingleArticleModel());
  }
 
+ @Order(11)
+ @Test
+ void put_article() throws Exception {
+ mockMvc.perform(put("/articles/{slug}", "how-to-train-your-dragon")
+ .header(AUTHORIZATION, "Token " + token)
+ .contentType(APPLICATION_JSON)
+ .content("{\"article\":{\"body\":\"With two hands\"}}"))
+ .andExpect(status().isOk())
+ .andExpect(validSingleArticleModel())
+ .andExpect(jsonPath("article.body", is("With two hands")));
+ }
+
  @Order(12)
  @Test
  void post_favorite_article() throws Exception {

src/test/java/io/github/raeperd/realworld/domain/article/ArticleContentsTest.java

@@ -0,0 +1,62 @@
+package io.github.raeperd.realworld.domain.article;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import static io.github.raeperd.realworld.domain.article.ArticleUpdateRequest.builder;
+import static java.util.Collections.emptySet;
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith(MockitoExtension.class)
+class ArticleContentsTest {
+
+
+ @Test
+ void when_updateArticle_with_no_update_field_request_expect_not_changed() {
+ final var articleContents = sampleArticleContents();
+ final var emptyUpdateRequest = builder().build();
+
+ articleContents.updateArticleContentsIfPresent(emptyUpdateRequest);
+
+ assertThatEqualArticleContents(articleContents, sampleArticleContents());
+ }
+
+ @Test
+ void when_updateArticle_with_all_field_expect_changed(@Mock ArticleTitle titleToUpdate) {
+ final var articleContents = sampleArticleContents();
+ final var fullUpdateRequest = builder().titleToUpdate(titleToUpdate)
+ .descriptionToUpdate("descriptionToUpdate")
+ .bodyToUpdate("bodyToUpdate")
+ .build();
+
+ articleContents.updateArticleContentsIfPresent(fullUpdateRequest);
+
+ assertThat(articleContents.getTitle()).isEqualTo(titleToUpdate);
+ assertThat(articleContents.getDescription()).isEqualTo("descriptionToUpdate");
+ assertThat(articleContents.getBody()).isEqualTo("bodyToUpdate");
+ }
+
+ private ArticleContents sampleArticleContents() {
+ return new ArticleContents("description", ArticleTitle.of("title"), "body", emptySet());
+ }
+
+ private void assertThatEqualArticleContents(ArticleContents left, ArticleContents right) {
+ assertThat(equalsArticleContents(left, right)).isTrue();
+ }
+
+ private boolean equalsArticleContents(ArticleContents left, ArticleContents right) {
+ if (!left.getTitle().equals(right.getTitle())) {
+ return false;
+ }
+ if (!left.getDescription().equals(right.getDescription())) {
+ return false;
+ }
+ if (!left.getBody().equals(right.getBody())) {
+ return false;
+ }
+ return left.getTags().equals(right.getTags());
+ }
+
+}

src/test/java/io/github/raeperd/realworld/domain/article/ArticleUpdateRequestTest.java

@@ -0,0 +1,37 @@
+package io.github.raeperd.realworld.domain.article;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import static io.github.raeperd.realworld.domain.article.ArticleUpdateRequest.builder;
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith(MockitoExtension.class)
+class ArticleUpdateRequestTest {
+
+ @Test
+ void when_articleUpdateRequest_created_without_field_expect_get_return_empty() {
+ final var requestWithoutFields = builder().build();
+
+ assertThat(requestWithoutFields.getTitleToUpdate()).isEmpty();
+ assertThat(requestWithoutFields.getDescriptionToUpdate()).isEmpty();
+ assertThat(requestWithoutFields.getBodyToUpdate()).isEmpty();
+ }
+
+ @Test
+ void when_articleUpdateRequest_created_with_all_fields_expect_all_fields(@Mock ArticleTitle title) {
+ final var requestWithAllFields = builder()
+ .titleToUpdate(title)
+ .descriptionToUpdate("descriptionToUpdate")
+ .bodyToUpdate("bodyToUpdate")
+ .build();
+
+ assertThat(requestWithAllFields).hasNoNullFieldsOrProperties();
+ assertThat(requestWithAllFields.getTitleToUpdate()).contains(title);
+ assertThat(requestWithAllFields.getDescriptionToUpdate()).contains("descriptionToUpdate");
+ assertThat(requestWithAllFields.getBodyToUpdate()).contains("bodyToUpdate");
+ }
+
+}