SiteParser: introduce an interface.

Addressed to #801

No functional changes.

Author: php-coder

src/main/java/ru/mystamps/web/config/EventsConfig.java

@@ -42,6 +42,7 @@
 // CheckStyle: ignore AvoidStarImportCheck for next 1 line
 import ru.mystamps.web.controller.event.*; // NOPMD: UnusedImports (false positive)
 import ru.mystamps.web.util.extractor.JsoupSiteParser;
+import ru.mystamps.web.util.extractor.SiteParser;
 
 @Configuration
 @RequiredArgsConstructor
@@ -56,10 +57,10 @@ public class EventsConfig {
 
 	@PostConstruct
 	public void init() {
-		Map<Integer, JsoupSiteParser> parsers = createSiteParsers();
-		for (Map.Entry<Integer, JsoupSiteParser> entry : parsers.entrySet()) {
+		Map<Integer, SiteParser> parsers = createSiteParsers();
+		for (Map.Entry<Integer, SiteParser> entry : parsers.entrySet()) {
 			Integer num = entry.getKey();
-			JsoupSiteParser parser = entry.getValue();
+			SiteParser parser = entry.getValue();
 			if (!parser.isFullyInitialized()) {
 				LOG.warn("Ignored non-fully initialized site parser (app.site-parser[{}])", num);
 				continue;
@@ -89,7 +90,7 @@ public ApplicationListener<DownloadingFailed> getDownloadingFailedEventListener(
 
 	@Bean
 	public ApplicationListener<DownloadingSucceeded> getDownloadingSucceededEventListener(
-		List<JsoupSiteParser> siteParsers) {
+		List<SiteParser> siteParsers) {
 
 		return new DownloadingSucceededEventListener(
 			LoggerFactory.getLogger(DownloadingSucceededEventListener.class),
@@ -108,9 +109,9 @@ public ApplicationListener<ParsingFailed> getParsingFailedEventListener() {
 	}
 
 	@SuppressWarnings("PMD.ModifiedCyclomaticComplexity") // TODO: deal with it someday
-	private Map<Integer, JsoupSiteParser> createSiteParsers() {
+	private Map<Integer, SiteParser> createSiteParsers() {
 		boolean foundSiteParserProps = false;
-		Map<Integer, JsoupSiteParser> parsers = new HashMap<>();
+		Map<Integer, SiteParser> parsers = new HashMap<>();
 
 		for (PropertySource<?> source : env.getPropertySources()) {
 			// while we expect that properties will be in PropertiesPropertySource, we use
@@ -140,7 +141,7 @@ private Map<Integer, JsoupSiteParser> createSiteParsers() {
 
 				Integer num = Integer.valueOf(strNum);
 				if (!parsers.containsKey(num)) {
-					JsoupSiteParser parser =
+					SiteParser parser =
 						new JsoupSiteParser(); // NOPMD: AvoidInstantiatingObjectsInLoops
 					parsers.put(num, parser);
 				}
@@ -152,7 +153,7 @@ private Map<Integer, JsoupSiteParser> createSiteParsers() {
 					continue;
 				}
 
-				JsoupSiteParser parser = parsers.get(num);
+				SiteParser parser = parsers.get(num);
 				boolean validProperty = parser.setField(fieldName, propertyValue);
 				if (!validProperty) {
 					LOG.warn("Ignored property '{}': unknown or unsupported", name);

src/main/java/ru/mystamps/web/controller/event/DownloadingSucceededEventListener.java

@@ -31,7 +31,7 @@
 import ru.mystamps.web.service.SeriesImportService;
 import ru.mystamps.web.service.dto.RawParsedDataDto;
 import ru.mystamps.web.util.extractor.SeriesInfo;
-import ru.mystamps.web.util.extractor.JsoupSiteParser;
+import ru.mystamps.web.util.extractor.SiteParser;
 
 /**
  * Listener of the @{link DownloadingSucceeded} event.
@@ -44,7 +44,7 @@ public class DownloadingSucceededEventListener
 
 	private final Logger log;
 	private final SeriesImportService importService;
-	private final List<JsoupSiteParser> siteParsers;
+	private final List<SiteParser> siteParsers;
 	private final ApplicationEventPublisher eventPublisher;
 
 	@PostConstruct
@@ -66,8 +66,8 @@ public void onApplicationEvent(DownloadingSucceeded event) {
 		}
 
 		String url = event.getUrl();
-		JsoupSiteParser parser = null;
-		for (JsoupSiteParser candidate : siteParsers) {
+		SiteParser parser = null;
+		for (SiteParser candidate : siteParsers) {
 			if (candidate.canParse(url)) {
 				parser = candidate;
 				break;

src/main/java/ru/mystamps/web/util/extractor/JsoupSiteParser.java

@@ -35,7 +35,7 @@
 // Getters/setters are being used in unit tests
 @Getter(AccessLevel.PROTECTED)
 @Setter(AccessLevel.PROTECTED)
-public class JsoupSiteParser {
+public class JsoupSiteParser implements SiteParser {
 	private static final Logger LOG = LoggerFactory.getLogger(JsoupSiteParser.class);
 
 	// When you're adding a new field don't forget to also update:
@@ -51,6 +51,7 @@ public class JsoupSiteParser {
 	private String imageUrlAttribute;
 	private String issueDateLocator;
 
+	@Override
 	public boolean setField(String name, String value) {
 		Validate.validState(StringUtils.isNotBlank(name), "Field name must be non-blank");
 		Validate.validState(StringUtils.isNotBlank(value), "Field value must be non-blank");
@@ -99,6 +100,7 @@ public boolean setField(String name, String value) {
 		return valid;
 	}
 
+	@Override
 	public boolean isFullyInitialized() {
 		return name != null
 			&& matchedUrl != null
@@ -111,6 +113,7 @@ public boolean isFullyInitialized() {
 			);
 	}
 
+	@Override
 	public boolean canParse(String url) {
 		Validate.validState(url != null, "Site URL must be non-null");
 		Validate.validState(matchedUrl != null, "Matched URL must be set");
@@ -123,6 +126,7 @@ public boolean canParse(String url) {
 	 *
 	 * @return info about a series from the document
 	 */
+	@Override
 	public SeriesInfo parse(String htmlPage) {
 		Validate.isTrue(StringUtils.isNotBlank(htmlPage), "Page content must be non-blank");
 

src/main/java/ru/mystamps/web/util/extractor/SiteParser.java

@@ -0,0 +1,25 @@
+/*
+ * 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.util.extractor;
+
+public interface SiteParser {
+	boolean setField(String name, String value);
+	boolean isFullyInitialized();
+	boolean canParse(String url);
+	SeriesInfo parse(String htmlPage);
+}