Skip to content

Commit

Permalink
Word count for markdown updated with test (halo-dev#1354)
Browse files Browse the repository at this point in the history 
* Word count for markdown updated with test

* HTML word count updated with test

* Convert pattern to static final variable

* More HTML test added

* Workaround URL added

* CS304 issue link URL added

* Pure HTML Test added, checkstyle checked

Co-authored-by: MasterWanna <[email protected]>
  • Loading branch information
@MasterWanna
MasterWanna and MasterWanna authored May 2, 2021
1 parent c2f382b commit 15381e6
Show file tree
Hide file tree
Showing 2 changed files with 166 additions and 7 deletions.
46 changes: 39 additions & 7 deletions src/main/java/run/halo/app/service/impl/BasePostServiceImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import static org.springframework.data.domain.Sort.Direction.ASC;
import static org.springframework.data.domain.Sort.Direction.DESC;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
Expand Down Expand Up @@ -55,7 +54,9 @@ public abstract class BasePostServiceImpl<POST extends BasePost>

private final OptionService optionService;

private final Pattern summaryPattern = Pattern.compile("\t|\r|\n");
private static final Pattern summaryPattern = Pattern.compile("\t|\r|\n");

private static final Pattern BLANK_PATTERN = Pattern.compile("\\s");

public BasePostServiceImpl(BasePostRepository<POST> basePostRepository,
OptionService optionService) {
Expand Down Expand Up @@ -274,21 +275,27 @@ public void increaseLike(Integer postId) {
increaseLike(1L, postId);
}

/**
* @param post post for article
* @return post with handled data
*/
@Override
@Transactional
public POST createOrUpdateBy(POST post) {
Assert.notNull(post, "Post must not be null");

String originalContent = post.getOriginalContent();
originalContent = HaloUtils.cleanHtmlTag(originalContent);

post.setWordCount((long) originalContent.length());

// Render content
// CS304 issue link : https://github.com/halo-dev/halo/issues/1224
// Render content and set word count
if (post.getEditorType().equals(PostEditorType.MARKDOWN)) {
post.setFormatContent(MarkdownUtils.renderHtml(post.getOriginalContent()));

post.setWordCount(htmlFormatWordCount(post.getFormatContent()));
} else {
post.setFormatContent(post.getOriginalContent());
post.setFormatContent(originalContent);

post.setWordCount(htmlFormatWordCount(originalContent));
}

// Create or update post
Expand Down Expand Up @@ -527,4 +534,29 @@ protected String generateSummary(@NonNull String htmlContent) {

return StringUtils.substring(text, 0, summaryLength);
}

// CS304 issue link : https://github.com/halo-dev/halo/issues/1224

/**
* @param htmlContent the markdown style content
* @return word count except space and line separator
*/

public static long htmlFormatWordCount(String htmlContent) {
if (htmlContent == null) {
return 0;
}

String cleanContent = HaloUtils.cleanHtmlTag(htmlContent);

Matcher matcher = BLANK_PATTERN.matcher(cleanContent);

int count = 0;

while (matcher.find()) {
count++;
}

return cleanContent.length() - count;
}
}
127 changes: 127 additions & 0 deletions src/test/java/run/halo/app/service/impl/HTMLWordCountTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
package run.halo.app.service.impl;

import static org.junit.jupiter.api.Assertions.assertEquals;

import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import run.halo.app.utils.MarkdownUtils;

// CS304 issue link : https://github.com/halo-dev/halo/issues/1224

@Slf4j
public class HTMLWordCountTest {

String markdownWithPicture = "图片字数测试\n" +
"![image.png](http://127.0.0.1:8090/upload/2021/04/image-51142fdc369c48698dd75c24f6049738" +
".png)";

String markdownWithTitle = "# 标题字数测试";

String markdownWithFontType = "++~~***字体样式字数测试***~~++";

String markdownWithCodeType = "`代码样式字数测试`";

String markdownWithLink = "[链接字数测试](https://www.baidu.com)";

String markdownWithTable =
"|表格|字数|测试|\n" +
"|-------|-------|-------|\n" +
"|表格|字数|测试|\n";

String plainText = "纯文本字数测试";

String complexText = "# 复杂文本测试\n\n" +
"![图片不算字数](http://127.0.0.1:8090/upload/2021/04/image-51142fdc369c48698dd75c24f6049738)\n\n" +
"++~~***复杂文本测试***~~++ `复杂文本测试` [复杂文本测试](https://halo.run)\n\n" +
"|复杂|文本|测试|\n" +
"|-------|-------|-------|\n" +
"|复杂|文本|测试|\n\n" +
"## 复杂文本测试\n";

String htmlText =
"<body><h1>复杂文本测试 </h1>\n" +
"<p><img src=\"http://127.0.0.1:8090/upload/2021/04/image-51142fdc369c48698dd75c24f6049738\" " +
"referrerpolicy=\"no-referrer\" alt=\"图片不算字数\"> \n" +
"<del><strong><em>复杂文本测试</em></strong></del> <code>复杂文本测试</code> <a href='https://halo" +
".run'>复杂文本测试</a> </p>\n" +
"<figure><table>\n" +
"<thead>\n" +
"<tr><th>复杂</th><th>文本</th><th>测试</th></tr></thead>\n" +
"<tbody><tr><td>复杂</td><td>文本</td><td>测试</td></tr></tbody>\n" +
"</table></figure>\n" +
"<h2>复杂文本测试</h2>\n" +
"</body>\n" +
"</html>";

String nullString = null;

String emptyString = "";

@Test
void pictureTest() {
assertEquals("图片字数测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithPicture)));
}

@Test
void titleTest() {
assertEquals("标题字数测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithTitle)));
}

@Test
void fontTypeTest() {
assertEquals("字体样式字数测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithFontType)));
}

@Test
void codeTypeTest() {
assertEquals("代码样式字数测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithCodeType)));
}

@Test
void linkTest() {
assertEquals("链接字数测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithLink)));
}

@Test
void tableTest() {
assertEquals("表格字数测试".length() * 2,
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(markdownWithTable)));
}

@Test
void plainTextTest() {
assertEquals(plainText.length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(plainText)));
}

@Test
void complexTextTest() {
assertEquals("复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(complexText)));
}

@Test
void htmlTest() {
assertEquals("复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试复杂文本测试".length(),
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(htmlText)));
}

@Test
void nullTest() {
assertEquals(0,
BasePostServiceImpl.htmlFormatWordCount(null));
assertEquals(0,
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(nullString)));
}

@Test
void emptyTest() {
assertEquals(0,
BasePostServiceImpl.htmlFormatWordCount(MarkdownUtils.renderHtml(emptyString)));
}
}

0 comments on commit 15381e6

Please sign in to comment.