refactor(CategoryService.getStatisticsOf): change return value to Map.

Prerequisite for #1143

Author: php-coder

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

@@ -22,6 +22,7 @@
 
 import java.util.Date;
 import java.util.List;
+import java.util.Map;
 
 @SuppressWarnings("PMD.TooManyMethods")
 public interface CategoryDao {
@@ -33,7 +34,7 @@ public interface CategoryDao {
 	long countCategoriesOfCollection(Integer collectionId);
 	long countAddedSince(Date date);
 	long countUntranslatedNamesSince(Date date);
-	List<Object[]> getStatisticsOf(Integer collectionId, String lang);
+	Map<String, Integer> getStatisticsOf(Integer collectionId, String lang);
 	List<Integer> findIdsByNames(List<String> names);
 	List<Integer> findIdsByNamePattern(String pattern);
 	List<LinkEntityDto> findAllAsLinkEntities(String lang);

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

@@ -22,6 +22,7 @@
 
 import java.util.Date;
 import java.util.List;
+import java.util.Map;
 
 @SuppressWarnings("PMD.TooManyMethods")
 public interface CategoryService {
@@ -38,6 +39,6 @@ public interface CategoryService {
 	long countByNameRu(String name);
 	long countAddedSince(Date date);
 	long countUntranslatedNamesSince(Date date);
-	List<Object[]> getStatisticsOf(Integer collectionId, String lang);
+	Map<String, Integer> getStatisticsOf(Integer collectionId, String lang);
 	String suggestCategoryForUser(Integer userId);
 }

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

@@ -33,6 +33,7 @@
 import java.util.Date;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 @SuppressWarnings("PMD.TooManyMethods")
@@ -193,7 +194,7 @@ public long countUntranslatedNamesSince(Date date) {
 
 	@Override
 	@Transactional(readOnly = true)
-	public List<Object[]> getStatisticsOf(Integer collectionId, String lang) {
+	public Map<String, Integer> getStatisticsOf(Integer collectionId, String lang) {
 		Validate.isTrue(collectionId != null, "Collection id must be non null");
 
 		return categoryDao.getStatisticsOf(collectionId, lang);

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

@@ -21,6 +21,7 @@
 import org.apache.commons.lang3.Validate;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.dao.EmptyResultDataAccessException;
+import org.springframework.jdbc.core.ResultSetExtractor;
 import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
 import org.springframework.jdbc.support.GeneratedKeyHolder;
@@ -29,6 +30,7 @@
 import ru.mystamps.web.common.JdbcUtils;
 import ru.mystamps.web.common.LinkEntityDto;
 import ru.mystamps.web.common.RowMappers;
+import ru.mystamps.web.support.spring.jdbc.MapStringIntegerResultSetExtractor;
 
 import java.util.Collections;
 import java.util.Date;
@@ -40,6 +42,9 @@
 @SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods", "PMD.TooManyFields" })
 public class JdbcCategoryDao implements CategoryDao {
 
+	private static final ResultSetExtractor<Map<String, Integer>> NAME_COUNTER_EXTRACTOR =
+		new MapStringIntegerResultSetExtractor("name", "counter");
+	
 	private final NamedParameterJdbcTemplate jdbcTemplate;
 
 	@Value("${category.create}")
@@ -178,15 +183,15 @@ public long countUntranslatedNamesSince(Date date) {
 	}
 
 	@Override
-	public List<Object[]> getStatisticsOf(Integer collectionId, String lang) {
+	public Map<String, Integer> getStatisticsOf(Integer collectionId, String lang) {
 		Map<String, Object> params = new HashMap<>();
 		params.put("collection_id", collectionId);
 		params.put("lang", lang);
 
 		return jdbcTemplate.query(
 			countStampsByCategoriesSql,
 			params,
-			RowMappers::forNameAndCounter
+			NAME_COUNTER_EXTRACTOR
 		);
 	}
 

src/main/java/ru/mystamps/web/feature/collection/CollectionController.java

@@ -31,6 +31,7 @@
 import java.io.IOException;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 
 @Controller
 @RequiredArgsConstructor
@@ -75,7 +76,8 @@ public String showInfoBySlug(
 			long seriesCounter   = collectionService.countSeriesOf(collectionId);
 			long stampsCounter   = collectionService.countStampsOf(collectionId);
 
-			List<Object[]> categoriesStat = categoryService.getStatisticsOf(collectionId, lang);
+			Map<String, Integer> categoriesStat =
+				categoryService.getStatisticsOf(collectionId, lang);
 			List<Object[]> countriesStat  = getCountriesStatistics(collectionId, lang);
 
 			model.addAttribute("categoryCounter", categoryCounter);

src/main/java/ru/mystamps/web/feature/site/ResourceUrl.java

@@ -32,7 +32,7 @@ public final class ResourceUrl {
 	public static final String STATIC_RESOURCES_URL = "https://stamps.filezz.ru";
 
 	// MUST be updated when any of our resources were modified
-	public static final String RESOURCES_VERSION = "v0.4.1";
+	public static final String RESOURCES_VERSION = "v0.4.1.1";
 
 	// CheckStyle: ignore LineLength for next 10 lines
 	private static final String CATALOG_UTILS_JS    = "/public/js/" + RESOURCES_VERSION + "/CatalogUtils.min.js";

src/main/java/ru/mystamps/web/support/spring/jdbc/MapStringIntegerResultSetExtractor.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2009-2019 Slava Semushin <[email protected]>
+ *
+ * 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.support.spring.jdbc;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.dao.DataAccessException;
+import org.springframework.jdbc.core.ResultSetExtractor;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.util.HashMap;
+import java.util.Map;
+
+@RequiredArgsConstructor
+public class MapStringIntegerResultSetExtractor
+	implements ResultSetExtractor<Map<String, Integer>> {
+	
+	private final String keyFieldName;
+	private final String valueFieldName;
+	
+	@Override
+	public Map<String, Integer> extractData(ResultSet rs)
+		throws SQLException, DataAccessException {
+		
+		Map<String, Integer> result = new HashMap<>();
+		
+		while (rs.next()) {
+			String key = rs.getString(keyFieldName);
+			// NOTE: when value is NULL then 0 is returned
+			Integer value = rs.getInt(valueFieldName);
+			result.put(key, value);
+		}
+		
+		return result;
+	}
+	
+}

src/main/java/ru/mystamps/web/support/spring/jdbc/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Helpers and utilities to work with JDBC through Spring's JdbcTemplate.
+ */
+package ru.mystamps.web.support.spring.jdbc;

src/main/javascript/collection/info.js

@@ -24,6 +24,15 @@ function createDataTable(stat) {
 	var table = new google.visualization.DataTable();
 	table.addColumn('string', 'Category/Country');
 	table.addColumn('number', 'Quantity of stamps');
-	table.addRows(stat);
+	
+	if (Array.isArray(stat)) {
+		table.addRows(stat);
+	} else {
+		// {a: 5} => [a, 5]
+		Object.keys(stat).forEach(function transformToList(key) {
+			var value = stat[key];
+			table.addRow([key, value]);
+		});
+	}
 	return table;
 }

src/main/webapp/WEB-INF/views/collection/info.html

@@ -183,11 +183,11 @@ <h4 class="panel-title" th:text="#{t_stamps_by_categories}">Stamps by categories
 					+]*/
 
 					/*[- */
-					initPage([
-						['Animals', 94],
-						['Prehistoric animals', 37],
-						['Sport', 1]
-					], [
+					initPage({
+							'Animals': 94,
+							'Prehistoric animals': 37,
+							'Sport': 1
+						}, [
 						['Russia', 5],
 						['USA', 2],
 						['Australia', 11],

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

@@ -29,6 +29,7 @@ import spock.lang.Unroll
 
 import static io.qala.datagen.RandomShortApi.nullOr
 import static io.qala.datagen.RandomShortApi.nullOrBlank
+import static io.qala.datagen.RandomShortApi.positiveInteger
 import static io.qala.datagen.RandomValue.between
 import static io.qala.datagen.StringModifier.Impls.oneOf
 
@@ -479,15 +480,19 @@ class CategoryServiceImplTest extends Specification {
 			ex.message == 'Collection id must be non null'
 	}
 
-	def 'getStatisticsOf() should pass arguments to dao'() {
+	def 'getStatisticsOf() should invoke dao, pass arguments and return result from dao'() {
 		given:
 			Integer expectedCollectionId = Random.id()
 		and:
 			String expectedLang = Random.lang()
+		and:
+			Map<String, Integer> expectedResult = [ (Random.categoryName()) : positiveInteger() ]
 		when:
-			service.getStatisticsOf(expectedCollectionId, expectedLang)
+			Map<String, Integer> result = service.getStatisticsOf(expectedCollectionId, expectedLang)
 		then:
-			1 * categoryDao.getStatisticsOf(expectedCollectionId, expectedLang) >> null
+			1 * categoryDao.getStatisticsOf(expectedCollectionId, expectedLang) >> expectedResult
+		and:
+			result == expectedResult
 	}
 
 	//