feat(/series/add): suggest a category to a user.

Addressed to #517

Author: php-coder

NEWS.txt

@@ -23,6 +23,8 @@
 - (functionality)  user may specify how many stamps from a series in his/her collection
 - (functionality)  paid users may specify a price that he/she paid for a series
 - (infrastructure) use WireMock in integration tests for mocking external services
+- (functionality)  suggest a possible country on a series creation page (contributed by John Shkarin)
+- (functionality)  suggest a possible category on a series creation page
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

src/main/java/ru/mystamps/web/Url.java

@@ -57,6 +57,7 @@ public final class Url {
 	public static final String REQUEST_IMPORT_PAGE        = "/series/import/request/{id}";
 	public static final String LIST_IMPORT_REQUESTS_PAGE  = "/series/import/requests";
 
+	public static final String SUGGEST_SERIES_CATEGORY    = "/suggest/series_category";
 	public static final String SUGGEST_SERIES_COUNTRY     = "/suggest/series_country";
 
 	public static final String ADD_CATEGORY_PAGE     = "/category/add";
@@ -90,7 +91,7 @@ public final class Url {
 	public static final String ADD_SERIES_WITH_COUNTRY_PAGE   = "/series/add/country/{slug}";
 
 	// MUST be updated when any of our resources were modified
-	public static final String RESOURCES_VERSION      = "v0.3.10";
+	public static final String RESOURCES_VERSION      = "v0.3.11";
 
 	// CheckStyle: ignore LineLength for next 7 lines
 	public static final String MAIN_CSS               = "/static/" + RESOURCES_VERSION + "/styles/main.min.css";
@@ -163,6 +164,7 @@ public static Map<String, String> asMap(boolean production) {
 		map.put("SEARCH_SERIES_BY_CATALOG", SEARCH_SERIES_BY_CATALOG);
 		map.put("SITE_EVENTS_PAGE", SITE_EVENTS_PAGE);
 		map.put("SUGGEST_SERIES_COUNTRY", SUGGEST_SERIES_COUNTRY);
+		map.put("SUGGEST_SERIES_CATEGORY", SUGGEST_SERIES_CATEGORY);
 
 		if (serveContentFromSingleHost) {
 			// Constants sorted in an ascending order.

src/main/java/ru/mystamps/web/feature/category/CategoryConfig.java

@@ -47,6 +47,11 @@ public CategoryController categoryController() {
 			return new CategoryController(categoryService, seriesService);
 		}
 
+		@Bean
+		public SuggestionController suggestionCategoryController() {
+			return new SuggestionController(categoryService);
+		}
+		
 	}
 
 	@RequiredArgsConstructor

src/main/java/ru/mystamps/web/feature/category/CategoryDao.java

@@ -39,4 +39,5 @@ public interface CategoryDao {
 	List<LinkEntityDto> findAllAsLinkEntities(String lang);
 	LinkEntityDto findOneAsLinkEntity(String slug, String lang);
 	List<EntityWithParentDto> findCategoriesWithParents(String lang);
+	String findCategoryOfLastCreatedSeriesByUser(Integer userId);
 }

src/main/java/ru/mystamps/web/feature/category/CategoryService.java

@@ -39,4 +39,5 @@ public interface CategoryService {
 	long countAddedSince(Date date);
 	long countUntranslatedNamesSince(Date date);
 	List<Object[]> getStatisticsOf(Integer collectionId, String lang);
+	String suggestCategoryForUser(Integer userId);
 }

src/main/java/ru/mystamps/web/feature/category/CategoryServiceImpl.java

@@ -205,4 +205,28 @@ public List<Object[]> getStatisticsOf(Integer collectionId, String lang) {
 		return categoryDao.getStatisticsOf(collectionId, lang);
 	}
 
+	// @todo #517 Add integration tests for category suggestion
+	@Override
+	@Transactional(readOnly = true)
+	@PreAuthorize(HasAuthority.CREATE_SERIES)
+	public String suggestCategoryForUser(Integer userId) {
+		Validate.isTrue(userId != null, "User id must be non null");
+		
+		// if user created a series with a category, let's suggest this category to him
+		String slug = categoryDao.findCategoryOfLastCreatedSeriesByUser(userId);
+		if (slug != null) {
+			log.debug(
+				"Category {} has been suggested to user #{} from a recently created series",
+				slug,
+				userId
+			);
+			return slug;
+		}
+		
+		// @todo #517: CategoryService.suggestCategoryForUser(): suggest a last created category
+		// @todo #517: CategoryService.suggestCategoryForUser(): suggest the most popular category
+		
+		return null;
+	}
+	
 }

src/main/java/ru/mystamps/web/feature/category/JdbcCategoryDao.java

@@ -39,7 +39,7 @@
 import ru.mystamps.web.support.jdbc.RowMappers;
 
 @RequiredArgsConstructor
-@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods" })
+@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods", "PMD.TooManyFields" })
 public class JdbcCategoryDao implements CategoryDao {
 
 	private final NamedParameterJdbcTemplate jdbcTemplate;
@@ -87,6 +87,10 @@ public class JdbcCategoryDao implements CategoryDao {
 	@Value("${category.find_categories_with_parent_names}")
 	private String findCategoriesWithParentNamesSql;
 
+	@SuppressWarnings("PMD.LongVariable")
+	@Value("${category.find_from_last_created_series_by_user}")
+	private String findFromLastCreatedSeriesByUserSql;
+	
 	@Override
 	public Integer add(AddCategoryDbDto category) {
 		Map<String, Object> params = new HashMap<>();
@@ -240,4 +244,17 @@ public List<EntityWithParentDto> findCategoriesWithParents(String lang) {
 		);
 	}
 
+	@Override
+	public String findCategoryOfLastCreatedSeriesByUser(Integer userId) {
+		try {
+			return jdbcTemplate.queryForObject(
+				findFromLastCreatedSeriesByUserSql,
+				Collections.singletonMap("created_by", userId),
+				String.class
+			);
+		} catch (EmptyResultDataAccessException ignored) {
+			return null;
+		}
+	}
+	
 }

src/main/java/ru/mystamps/web/feature/category/SuggestionController.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2009-2018 Slava Semushin <slava.semushin@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.feature.category;
+
+import org.apache.commons.lang3.StringUtils;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import lombok.RequiredArgsConstructor;
+
+import ru.mystamps.web.Url;
+import ru.mystamps.web.controller.converter.annotation.CurrentUser;
+
+@RestController
+@RequiredArgsConstructor
+class SuggestionController {
+
+	private final CategoryService categoryService;
+	
+	@GetMapping(Url.SUGGEST_SERIES_CATEGORY)
+	public String suggestCategoryForUser(@CurrentUser Integer currentUserId) {
+		return StringUtils.defaultString(
+			categoryService.suggestCategoryForUser(currentUserId),
+			StringUtils.EMPTY
+		);
+	}
+	
+}
+

src/main/java/ru/mystamps/web/feature/country/CountryConfig.java

@@ -48,7 +48,7 @@ public CountryController countryController() {
 		}
 
 		@Bean
-		public SuggestionController suggestionController() {
+		public SuggestionController suggestionCountryController() {
 			return new SuggestionController(countryService);
 		}
 

src/main/javascript/series/add.js

@@ -3,7 +3,7 @@
 // You must update Url.RESOURCES_VERSION each time whenever you're modified this file!
 //
 
-function initPage(suggestCountryUrl) {
+function initPage(suggestCategoryUrl, suggestCountryUrl) {
 	$('#country').selectize();
 
 	$('.js-catalog-numbers').on('blur', function expandCatalogNumbers() {
@@ -28,6 +28,26 @@ function initPage(suggestCountryUrl) {
 		'placement': 'right'
 	});
 
+	if (suggestCategoryUrl != null) {
+		$.get(suggestCategoryUrl, function handleSuggestedCategory(slug) {
+			if (slug == '') {
+				return;
+			}
+
+			var suggestCategoryLink = $('#js-suggest-category-link');
+			suggestCategoryLink.click(function chooseSuggestedCategory() {
+				suggestCategoryLink.addClass('hidden');
+				chooseCategoryBySlug(slug);
+			});
+			
+			var categoryName = getCategoryNameBySlug(slug);
+			var newText = suggestCategoryLink.text().replace('%name%', categoryName);
+			suggestCategoryLink.text(newText);
+			
+			suggestCategoryLink.removeClass('hidden');
+		});
+	}
+
 	if (suggestCountryUrl != null) {
 		$.get(suggestCountryUrl, function handleSuggestedCountry(slug) {
 			if (slug == '') {
@@ -49,6 +69,15 @@ function initPage(suggestCountryUrl) {
 	}
 }
 
+
+function chooseCategoryBySlug(slug) {
+	$('#category').val(slug);
+}
+
+function getCategoryNameBySlug(slug) {
+	return $('#category option[value="' + slug + '"]').text();
+}
+
 function chooseCountryBySlug(slug) {
 	var countrySelectBox = $('#country').selectize();
 	var selectize = countrySelectBox[0].selectize;

src/main/resources/sql/category_dao_queries.properties

@@ -115,3 +115,12 @@ LEFT JOIN top_categories t \
                THEN CONCAT(COALESCE(t.name_ru, t.name), COALESCE(c.name_ru, c.name)) \
                ELSE CONCAT(t.name, c.name) \
                 END
+
+category.find_from_last_created_series_by_user = \
+   SELECT c.slug \
+     FROM series s \
+     JOIN categories c \
+       ON c.id = s.category_id \
+    WHERE s.created_by = :created_by \
+ ORDER BY s.created_at DESC \
+    LIMIT 1

src/main/webapp/WEB-INF/views/series/add.html

@@ -16,9 +16,9 @@
 		<link rel="stylesheet" href="../../static/styles/main.css" th:href="${MAIN_CSS}" />
 		<link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.12.4/css/selectize.bootstrap3.min.css" th:href="${SELECTIZE_CSS}" />
 	</head>
-	<body th:with="suggestCountryUrl=${addSeriesForm.country != null and addSeriesForm.country.slug != null ? 'null' : '''__@{${SUGGEST_SERIES_COUNTRY}}__'''}"
-		th:onload="|initPage(${suggestCountryUrl})|"
-		onload="initPage(null)">
+	<body th:with="suggestCountryUrl=${addSeriesForm.country != null and addSeriesForm.country.slug != null ? 'null' : '''__@{${SUGGEST_SERIES_COUNTRY}}__'''},suggestCategoryUrl=${addSeriesForm.category != null and addSeriesForm.category.slug != null ? 'null' : '''__@{${SUGGEST_SERIES_CATEGORY}}__'''}"
+		th:onload="|initPage(${suggestCategoryUrl}, ${suggestCountryUrl})|"
+		onload="initPage(null, null)">
 		<div class="container-fluid">
 			<div class="row" id="header">
 				<div id="logo" class="col-sm-9 vcenter">
@@ -138,6 +138,16 @@ <h3 th:text="${#strings.capitalize(add_series)}">
 								<span id="category.errors" class="help-block" th:if="${#fields.hasErrors('category')}" th:each="error : ${#fields.errors('category')}" th:text="${error}"></span>
 								/*/-->
 							</div>
+							
+							<small togglz:active="SHOW_SUGGESTION_LINK">
+								<a tabindex="-1"
+									th:text="#{t_pick_percent_name}"
+									href="javascript:$('#js-suggest-category-link').hide(); chooseCategoryBySlug('sport'); void(0)"
+									th:href="'javascript:void(0)'"
+									id="js-suggest-category-link"
+									class="link-vcenter"
+									th:classappend="hidden">Pick "Sport"</a>
+							</small>
 						</div>
 
 						<div class="form-group form-group-sm" th:classappend="${#fields.hasErrors('country') ? 'has-error' : ''}">

src/test/groovy/ru/mystamps/web/feature/category/CategoryServiceImplTest.groovy

@@ -453,5 +453,37 @@ class CategoryServiceImplTest extends Specification {
 		then:
 			1 * categoryDao.getStatisticsOf(expectedCollectionId, expectedLang) >> null
 	}
+	
+	//
+	// Tests for suggestCategoryForUser()
+	//
+	
+	def 'suggestCategoryForUser() should throw exception when user id is null'() {
+		when:
+			service.suggestCategoryForUser(null)
+		then:
+			thrown IllegalArgumentException
+	}
+	
+	def 'suggestCategoryForUser() should return category of the last created series'() {
+		given:
+			Integer expectedUserId = Random.userId()
+			String expectedSlug = Random.categorySlug()
+		when:
+			String slug = service.suggestCategoryForUser(expectedUserId)
+		then:
+			1 * categoryDao.findCategoryOfLastCreatedSeriesByUser(expectedUserId) >> expectedSlug
+		and:
+			slug == expectedSlug
+	}
+	
+	def 'suggestCategoryForUser() should return null when cannot suggest'() {
+		when:
+			String slug = service.suggestCategoryForUser(Random.userId())
+		then:
+			1 * categoryDao.findCategoryOfLastCreatedSeriesByUser(_ as Integer) >> null
+		and:
+			slug == null
+	}
 
 }

src/test/java/ru/mystamps/web/tests/Random.java

@@ -147,6 +147,10 @@ public static String categoryName() {
 		return name;
 	}
 
+	public static String categorySlug() {
+		return SlugUtils.slugify(categoryName());
+	}
+	
 	public static String countryName() {
 		String name = between(
 				ValidationRules.COUNTRY_NAME_MIN_LENGTH,