feat: admin can add a release year to a series.

Implementation details: a release year can be added only if it isn't set yet. This is a protection
against possible race or other unforeseeable circumstances that might lead to data loss. A full
implementation of the editing can be added later so this can be considered as the first iteration.

Fix #1343

Author: php-coder

NEWS.txt

@@ -3,6 +3,7 @@
 - (feature)     series images can be replaced
 - (feature)     add preliminary support for hidden images
 - (feature)     admin can add a comment to a series
+- (feature)     admin can add a release year to a series
 - (improvement) on a country info page show the series with an image
 
 0.4.3

src/main/frontend/src/components/AddReleaseYearForm.js

@@ -55,8 +55,8 @@ class AddReleaseYearForm extends React.PureComponent {
 				const data = response.data;
 				if (data.hasOwnProperty('fieldErrors')) {
 					const fieldErrors = [];
-					if (data.fieldErrors.year) {
-						fieldErrors.push(...data.fieldErrors.year);
+					if (data.fieldErrors.value) {
+						fieldErrors.push(...data.fieldErrors.value);
 					}
 					this.setState({
 						isDisabled: false,
@@ -114,7 +114,7 @@ class AddReleaseYearFormView extends React.PureComponent {
 					</div>
 					<div className="form-group form-group-sm">
 						<label className="control-label col-sm-3">
-							{ l10n['t_release_year'] || 'Release year' }
+							{ l10n['t_year'] || 'Year' }
 						</label>
 						<div className="col-sm-6">
 							<select

src/main/java/ru/mystamps/web/feature/series/AddReleaseYearDbDto.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2009-2020 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.feature.series;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.Date;
+
+@Getter
+@Setter
+public class AddReleaseYearDbDto {
+	private Integer seriesId;
+	private Integer releaseYear;
+	private Date updatedAt;
+	private Integer updatedBy;
+}

src/main/java/ru/mystamps/web/feature/series/JdbcSeriesDao.java

@@ -51,6 +51,9 @@ public class JdbcSeriesDao implements SeriesDao {
 	@Value("${series.add_comment}")
 	private String addCommentSql;
 
+	@Value("${series.add_release_year}")
+	private String addReleaseYearSql;
+	
 	@Value("${series.mark_as_modified}")
 	private String markAsModifiedSql;
 
@@ -155,6 +158,24 @@ public void addComment(Integer seriesId, String comment) {
 		);
 	}
 
+	@Override
+	public void addReleaseYear(AddReleaseYearDbDto dto) {
+		Map<String, Object> params = new HashMap<>();
+		params.put("series_id", dto.getSeriesId());
+		params.put("release_year", dto.getReleaseYear());
+		params.put("updated_at", dto.getUpdatedAt());
+		params.put("updated_by", dto.getUpdatedBy());
+		
+		int affected = jdbcTemplate.update(addReleaseYearSql, params);
+		
+		// @todo #1343 Update series: handle refuse to update an existing release year gracefully
+		Validate.validState(
+			affected == 1,
+			"Unexpected number of affected rows after updating series: %d",
+			affected
+		);
+	}
+
 	/**
 	 * @author Sergey Chechenev
 	 */

src/main/java/ru/mystamps/web/feature/series/RestSeriesController.java

@@ -26,6 +26,7 @@
 import org.springframework.web.bind.annotation.RestController;
 import ru.mystamps.web.support.spring.mvc.PatchRequest;
 import ru.mystamps.web.support.spring.mvc.PatchRequest.Operation;
+import ru.mystamps.web.support.spring.security.CurrentUser;
 
 import javax.servlet.http.HttpServletResponse;
 import javax.validation.Valid;
@@ -42,11 +43,12 @@ class RestSeriesController {
 
 	// @todo #785 Update series: add integration test
 	// @todo #785 Update series: add validation for a comment
+	// @todo #1343 Update series: add validation for a release year
 	@PatchMapping(SeriesUrl.INFO_SERIES_PAGE)
-	@SuppressWarnings("PMD.TooFewBranchesForASwitchStatement")
 	public ResponseEntity<Void> updateSeries(
 		@PathVariable("id") Integer seriesId,
 		@RequestBody @Valid @NotEmpty List<@Valid PatchRequest> patches,
+		@CurrentUser Integer currentUserId,
 		HttpServletResponse response) throws IOException {
 
 		if (seriesId == null) {
@@ -69,6 +71,12 @@ public ResponseEntity<Void> updateSeries(
 				case "/comment":
 					seriesService.addComment(seriesId, patch.getValue());
 					break;
+				case "/release_year":
+					seriesService.addReleaseYear(
+						seriesId,
+						Integer.valueOf(patch.getValue()),
+						currentUserId);
+					break;
 				default:
 					// @todo #785 Update series: properly fail on invalid path
 					break;

src/main/java/ru/mystamps/web/feature/series/SeriesDao.java

@@ -25,6 +25,7 @@
 public interface SeriesDao {
 	Integer add(AddSeriesDbDto series);
 	void addComment(Integer seriesId, String comment);
+	void addReleaseYear(AddReleaseYearDbDto dto);
 	void markAsModified(Integer seriesId, Date updateAt, Integer updatedBy);
 	List<SitemapInfoDto> findAllForSitemap();
 	List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang);

src/main/java/ru/mystamps/web/feature/series/SeriesService.java

@@ -25,6 +25,7 @@
 public interface SeriesService {
 	Integer add(AddSeriesDto dto, Integer userId, boolean userCanAddComments);
 	void addComment(Integer seriesId, String comment);
+	void addReleaseYear(Integer seriesId, Integer year, Integer userId);
 	void addImageToSeries(AddImageDto dto, Integer seriesId, Integer userId);
 	void replaceImage(ReplaceImageDto dto, Integer seriesId, Integer userId);
 	long countAll();

src/main/java/ru/mystamps/web/feature/series/SeriesServiceImpl.java

@@ -135,6 +135,28 @@ public void addComment(Integer seriesId, String comment) {
 		log.info("Series #{}: a comment has been added", seriesId);
 	}
 
+	// @todo #1343 SeriesServiceImpl.addReleaseYear(): add unit tests
+	@Override
+	@Transactional
+	@PreAuthorize(HasAuthority.CREATE_SERIES)
+	public void addReleaseYear(Integer seriesId, Integer year, Integer userId) {
+		Validate.isTrue(seriesId != null, "Series id must be non null");
+		Validate.isTrue(year != null, "Release year must be non null");
+		Validate.isTrue(userId != null, "User id must be non null");
+		
+		AddReleaseYearDbDto dto = new AddReleaseYearDbDto();
+		dto.setSeriesId(seriesId);
+		dto.setReleaseYear(year);
+		dto.setUpdatedBy(userId);
+		
+		Date now = new Date();
+		dto.setUpdatedAt(now);
+		
+		seriesDao.addReleaseYear(dto);
+		
+		log.info("Series #{}: release year set to {}", seriesId, year);
+	}
+	
 	@Override
 	@Transactional
 	@PreAuthorize("isAuthenticated()")

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.3.10";
+	public static final String RESOURCES_VERSION = "v0.4.3.11";
 
 	// CheckStyle: ignore LineLength for next 15 lines
 	private static final String CATALOG_UTILS_JS      = "/public/js/" + RESOURCES_VERSION + "/CatalogUtils.min.js";

src/main/java/ru/mystamps/web/support/spring/security/SecurityConfig.java

@@ -109,7 +109,8 @@ protected void configure(HttpSecurity http) throws Exception {
 				.mvcMatchers(CountryUrl.ADD_COUNTRY_PAGE).hasAuthority(StringAuthority.CREATE_COUNTRY)
 				.mvcMatchers(ParticipantUrl.ADD_PARTICIPANT_PAGE).hasAuthority(StringAuthority.ADD_PARTICIPANT)
 				.mvcMatchers(SeriesUrl.ADD_SERIES_PAGE).hasAuthority(StringAuthority.CREATE_SERIES)
-				.mvcMatchers(HttpMethod.PATCH, SeriesUrl.INFO_SERIES_PAGE).hasAuthority(StringAuthority.ADD_COMMENTS_TO_SERIES)
+				.mvcMatchers(HttpMethod.PATCH, SeriesUrl.INFO_SERIES_PAGE)
+					.hasAnyAuthority(StringAuthority.CREATE_SERIES, StringAuthority.ADD_COMMENTS_TO_SERIES)
 				.mvcMatchers(SeriesImportUrl.REQUEST_IMPORT_SERIES_PAGE).hasAuthority(StringAuthority.IMPORT_SERIES)
 				.mvcMatchers(SiteUrl.SITE_EVENTS_PAGE).hasAuthority(StringAuthority.VIEW_SITE_EVENTS)
 				.mvcMatchers(CategoryUrl.SUGGEST_SERIES_CATEGORY).hasAuthority(StringAuthority.CREATE_SERIES)

src/main/resources/sql/series_dao_queries.properties

@@ -47,6 +47,14 @@ UPDATE series \
  WHERE id = :series_id \
    AND comment IS NULL
 
+series.add_release_year = \
+UPDATE series \
+   SET release_year = :release_year \
+     , updated_at = :updated_at \
+     , updated_by = :updated_by \
+ WHERE id = :series_id \
+   AND release_year IS NULL
+
 series.mark_as_modified = \
 UPDATE series \
    SET updated_at = :updated_at \

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

@@ -1049,9 +1049,14 @@ <h5 th:text="#{t_add_info_who_selling_series}">Add info about selling/buying thi
 			/*[# th:if="${series.releaseYear == null}"]*/
 			/*[+
 			var addReleaseYearProps = {
+				'url': [[ '__@{${INFO_SERIES_PAGE}(id=${series.id})}__' ]],
 				'csrfHeaderName': [[ ${_csrf.headerName} ]],
 				'csrfTokenValue': [[ ${_csrf.token} ]],
-				'l10n': {},
+				'l10n': {
+					't_server_error': [[ #{t_server_error} ]],
+					't_year':         [[ #{t_year} ]],
+					't_add':          [[ #{t_add} ]]
+				},
 				'sinceYear': [[ ${T(ru.mystamps.web.feature.series.SeriesValidation).MIN_RELEASE_YEAR} ]],
 				'tillYear': new Date().getFullYear()
 			};