refactor(CountryUrl): move country-related values to the corresponding class.

php-coder · php-coder · commit 232d41e76308 · 2019-06-14T22:42:17.000+01:00
Addressed to #927 No functional changes.
diff --git a/src/main/java/ru/mystamps/web/Url.java b/src/main/java/ru/mystamps/web/Url.java
@@ -20,6 +20,7 @@
 import ru.mystamps.web.feature.account.AccountUrl;
 import ru.mystamps.web.feature.category.CategoryUrl;
 import ru.mystamps.web.feature.collection.CollectionUrl;
+import ru.mystamps.web.feature.country.CountryUrl;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -61,10 +62,6 @@ public final class Url {
 	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_COUNTRY_PAGE      = "/country/add";
-	public static final String GET_COUNTRIES_PAGE    = "/countries";
-	public static final String INFO_COUNTRY_PAGE     = "/country/{slug}";
-	
 	public static final String GET_IMAGE_PAGE         = "/image/{id}";
 	public static final String GET_IMAGE_PREVIEW_PAGE = "/image/preview/{id}";
 	
@@ -75,8 +72,6 @@ public final class Url {
 	public static final String INTERNAL_ERROR_PAGE   = "/error/500";
 	
 	// For backward compatibility
-	public static final String LIST_COUNTRIES_PAGE            = "/country/list";
-	public static final String INFO_COUNTRY_BY_ID_PAGE        = "/country/{id}/{slug}";
 	public static final String ADD_SERIES_WITH_CATEGORY_PAGE  = "/series/add/category/{slug}";
 	public static final String ADD_SERIES_WITH_COUNTRY_PAGE   = "/series/add/country/{slug}";
 	
@@ -129,7 +124,7 @@ public static Map<String, String> asMap(boolean production) {
 		Map<String, String> map = new HashMap<>();
 		map.put("ACTIVATE_ACCOUNT_PAGE", AccountUrl.ACTIVATE_ACCOUNT_PAGE);
 		map.put("ADD_CATEGORY_PAGE", CategoryUrl.ADD_CATEGORY_PAGE);
-		map.put("ADD_COUNTRY_PAGE", ADD_COUNTRY_PAGE);
+		map.put("ADD_COUNTRY_PAGE", CountryUrl.ADD_COUNTRY_PAGE);
 		map.put("ADD_IMAGE_SERIES_PAGE", ADD_IMAGE_SERIES_PAGE);
 		map.put("ADD_PARTICIPANT_PAGE", ADD_PARTICIPANT_PAGE);
 		map.put("ADD_SERIES_ASK_PAGE", ADD_SERIES_ASK_PAGE);
@@ -139,10 +134,10 @@ public static Map<String, String> asMap(boolean production) {
 		map.put("DAILY_STATISTICS", DAILY_STATISTICS);
 		map.put("ESTIMATION_COLLECTION_PAGE", CollectionUrl.ESTIMATION_COLLECTION_PAGE);
 		map.put("GET_CATEGORIES_PAGE", CategoryUrl.GET_CATEGORIES_PAGE);
-		map.put("GET_COUNTRIES_PAGE", GET_COUNTRIES_PAGE);
+		map.put("GET_COUNTRIES_PAGE", CountryUrl.GET_COUNTRIES_PAGE);
 		map.put("INFO_CATEGORY_PAGE", CategoryUrl.INFO_CATEGORY_PAGE);
 		map.put("INFO_COLLECTION_PAGE", CollectionUrl.INFO_COLLECTION_PAGE);
-		map.put("INFO_COUNTRY_PAGE", INFO_COUNTRY_PAGE);
+		map.put("INFO_COUNTRY_PAGE", CountryUrl.INFO_COUNTRY_PAGE);
 		map.put("INFO_SERIES_PAGE", INFO_SERIES_PAGE);
 		map.put("LIST_IMPORT_REQUESTS_PAGE", LIST_IMPORT_REQUESTS_PAGE);
 		map.put("IMPORT_SERIES_SALES", IMPORT_SERIES_SALES);
diff --git a/src/main/java/ru/mystamps/web/feature/country/CountryController.java b/src/main/java/ru/mystamps/web/feature/country/CountryController.java
@@ -30,7 +30,6 @@
 import org.springframework.web.servlet.View;
 import org.springframework.web.servlet.mvc.support.RedirectAttributes;
 import org.springframework.web.servlet.view.RedirectView;
-import ru.mystamps.web.Url;
 import ru.mystamps.web.common.LinkEntityDto;
 import ru.mystamps.web.common.LocaleUtils;
 import ru.mystamps.web.feature.series.SeriesInfoDto;
@@ -62,12 +61,12 @@ protected void initBinder(WebDataBinder binder) {
 		binder.registerCustomEditor(String.class, "nameRu", editor);
 	}
 	
-	@GetMapping(Url.ADD_COUNTRY_PAGE)
+	@GetMapping(CountryUrl.ADD_COUNTRY_PAGE)
 	public AddCountryForm showForm() {
 		return new AddCountryForm();
 	}
 	
-	@PostMapping(Url.ADD_COUNTRY_PAGE)
+	@PostMapping(CountryUrl.ADD_COUNTRY_PAGE)
 	public String processInput(
 		@Valid AddCountryForm form,
 		BindingResult result,
@@ -82,10 +81,10 @@ public String processInput(
 		
 		redirectAttributes.addFlashAttribute("justAddedCountry", true);
 		
-		return redirectTo(Url.INFO_COUNTRY_PAGE, slug);
+		return redirectTo(CountryUrl.INFO_COUNTRY_PAGE, slug);
 	}
 	
-	@GetMapping(Url.INFO_COUNTRY_PAGE)
+	@GetMapping(CountryUrl.INFO_COUNTRY_PAGE)
 	public String showInfoBySlug(
 		@Country @PathVariable("slug") LinkEntityDto country,
 		Model model,
@@ -114,7 +113,7 @@ public String showInfoBySlug(
 	/**
 	 * @author Aleksander Parkhomenko
 	 */
-	@GetMapping(Url.INFO_COUNTRY_BY_ID_PAGE)
+	@GetMapping(CountryUrl.INFO_COUNTRY_BY_ID_PAGE)
 	public View showInfoById(
 		@Country @PathVariable("slug") LinkEntityDto country,
 		HttpServletResponse response)
@@ -127,12 +126,12 @@ public View showInfoById(
 		
 		RedirectView view = new RedirectView();
 		view.setStatusCode(HttpStatus.MOVED_PERMANENTLY);
-		view.setUrl(Url.INFO_COUNTRY_PAGE);
+		view.setUrl(CountryUrl.INFO_COUNTRY_PAGE);
 		
 		return view;
 	}
 	
-	@GetMapping(Url.GET_COUNTRIES_PAGE)
+	@GetMapping(CountryUrl.GET_COUNTRIES_PAGE)
 	public String showCountries(Model model, Locale userLocale) {
 		String lang = LocaleUtils.getLanguageOrNull(userLocale);
 		List<LinkEntityDto> countries = countryService.findAllAsLinkEntities(lang);
@@ -142,11 +141,11 @@ public String showCountries(Model model, Locale userLocale) {
 		return "country/list";
 	}
 	
-	@GetMapping(Url.LIST_COUNTRIES_PAGE)
+	@GetMapping(CountryUrl.LIST_COUNTRIES_PAGE)
 	public View list() {
 		RedirectView view = new RedirectView();
 		view.setStatusCode(HttpStatus.MOVED_PERMANENTLY);
-		view.setUrl(Url.GET_COUNTRIES_PAGE);
+		view.setUrl(CountryUrl.GET_COUNTRIES_PAGE);
 		return view;
 	}
 	
diff --git a/src/main/java/ru/mystamps/web/feature/country/CountryUrl.java b/src/main/java/ru/mystamps/web/feature/country/CountryUrl.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2009-2019 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.country;
+
+/**
+ * Country-related URLs.
+ *
+ * Should be used everywhere instead of hard-coded paths.
+ *
+ * @author Slava Semushin
+ */
+@SuppressWarnings("PMD.CommentDefaultAccessModifier")
+public final class CountryUrl {
+	
+	public static final String ADD_COUNTRY_PAGE   = "/country/add";
+	public static final String GET_COUNTRIES_PAGE = "/countries";
+	public static final String INFO_COUNTRY_PAGE  = "/country/{slug}";
+	
+	// For backward compatibility
+	static final String LIST_COUNTRIES_PAGE     = "/country/list";
+	static final String INFO_COUNTRY_BY_ID_PAGE = "/country/{id}/{slug}";
+	
+	private CountryUrl() {
+	}
+	
+}
diff --git a/src/main/java/ru/mystamps/web/feature/site/RobotsTxtController.java b/src/main/java/ru/mystamps/web/feature/site/RobotsTxtController.java
@@ -24,6 +24,7 @@
 import ru.mystamps.web.Url;
 import ru.mystamps.web.feature.account.AccountUrl;
 import ru.mystamps.web.feature.category.CategoryUrl;
+import ru.mystamps.web.feature.country.CountryUrl;
 
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
@@ -48,7 +49,7 @@ public void getRobotsText(HttpServletResponse response) {
 			writer.println("Disallow: " + AccountUrl.ACTIVATE_ACCOUNT_PAGE);
 			writer.println("Disallow: " + AccountUrl.AUTHENTICATION_PAGE);
 			writer.println("Disallow: " + AccountUrl.LOGIN_PAGE);
-			writer.println("Disallow: " + Url.ADD_COUNTRY_PAGE);
+			writer.println("Disallow: " + CountryUrl.ADD_COUNTRY_PAGE);
 			writer.println("Disallow: " + Url.ADD_SERIES_PAGE);
 			writer.println("Disallow: " + CategoryUrl.ADD_CATEGORY_PAGE);
 			writer.println("Disallow: " + Url.FORBIDDEN_PAGE);
diff --git a/src/main/java/ru/mystamps/web/support/spring/security/SecurityConfig.java b/src/main/java/ru/mystamps/web/support/spring/security/SecurityConfig.java
@@ -46,6 +46,7 @@
 import ru.mystamps.web.feature.account.UserService;
 import ru.mystamps.web.feature.category.CategoryUrl;
 import ru.mystamps.web.feature.collection.CollectionUrl;
+import ru.mystamps.web.feature.country.CountryUrl;
 import ru.mystamps.web.feature.site.SiteService;
 
 import javax.servlet.Filter;
@@ -83,7 +84,7 @@ protected void configure(HttpSecurity http) throws Exception {
 		http
 			.authorizeRequests()
 				.mvcMatchers(CategoryUrl.ADD_CATEGORY_PAGE).hasAuthority(StringAuthority.CREATE_CATEGORY)
-				.mvcMatchers(Url.ADD_COUNTRY_PAGE).hasAuthority(StringAuthority.CREATE_COUNTRY)
+				.mvcMatchers(CountryUrl.ADD_COUNTRY_PAGE).hasAuthority(StringAuthority.CREATE_COUNTRY)
 				.mvcMatchers(Url.ADD_PARTICIPANT_PAGE).hasAuthority(StringAuthority.ADD_PARTICIPANT)
 				.mvcMatchers(Url.ADD_SERIES_PAGE).hasAuthority(StringAuthority.CREATE_SERIES)
 				.mvcMatchers(Url.REQUEST_IMPORT_SERIES_PAGE).hasAuthority(StringAuthority.IMPORT_SERIES)
