Implement TimedSiteParser.

Fix #801

No functional changes.

Author: php-coder

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

@@ -43,6 +43,7 @@
 import ru.mystamps.web.controller.event.*; // NOPMD: UnusedImports (false positive)
 import ru.mystamps.web.util.extractor.JsoupSiteParser;
 import ru.mystamps.web.util.extractor.SiteParser;
+import ru.mystamps.web.util.extractor.TimedSiteParser;
 
 @Configuration
 @RequiredArgsConstructor
@@ -108,7 +109,10 @@ public ApplicationListener<ParsingFailed> getParsingFailedEventListener() {
 		);
 	}
 
-	@SuppressWarnings("PMD.ModifiedCyclomaticComplexity") // TODO: deal with it someday
+	@SuppressWarnings({
+		"PMD.AvoidInstantiatingObjectsInLoops",
+		"PMD.ModifiedCyclomaticComplexity" // TODO: deal with it someday
+	})
 	private Map<Integer, SiteParser> createSiteParsers() {
 		boolean foundSiteParserProps = false;
 		Map<Integer, SiteParser> parsers = new HashMap<>();
@@ -141,8 +145,13 @@ private Map<Integer, SiteParser> createSiteParsers() {
 
 				Integer num = Integer.valueOf(strNum);
 				if (!parsers.containsKey(num)) {
+					// @todo #801 EventsConfig.createSiteParsers(): split the logic for properties
+					//  parsing and the object instantiation
 					SiteParser parser =
-						new JsoupSiteParser(); // NOPMD: AvoidInstantiatingObjectsInLoops
+						new TimedSiteParser(
+							LoggerFactory.getLogger(TimedSiteParser.class),
+							new JsoupSiteParser()
+						);
 					parsers.put(num, parser);
 				}
 

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

@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2009-2018 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.util.extractor;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.time.StopWatch;
+
+import org.slf4j.Logger;
+
+import lombok.RequiredArgsConstructor;
+
+// @todo #801 TimedSiteParser: add unit tests
+@RequiredArgsConstructor
+public class TimedSiteParser implements SiteParser {
+	
+	private final Logger log;
+	private final SiteParser parser;
+	
+	@Override
+	public boolean setField(String name, String value) {
+		return parser.setField(name, value);
+	}
+	
+	@Override
+	public boolean isFullyInitialized() {
+		return parser.isFullyInitialized();
+	}
+	
+	@Override
+	public boolean canParse(String url) {
+		return parser.canParse(url);
+	}
+	
+	@Override
+	public SeriesInfo parse(String htmlPage) {
+		// Why we don't use Spring's StopWatch?
+		// 1) because its javadoc says that it's not intended for production
+		// 2) because we don't want to have strong dependencies on the Spring Framework
+		StopWatch timer = new StopWatch();
+		
+		// start() and stop() may throw IllegalStateException and in this case it's possible
+		// that we won't generate anything or lose already generated result. I don't want to
+		// make method body too complicated by adding many try/catches and I believe that such
+		// exception will never happen because it would mean that we're using API in a wrong way.
+		timer.start();
+		SeriesInfo result = parser.parse(htmlPage);
+		timer.stop();
+		
+		if (result != null) {
+			log.debug(
+				"HTML page with {} characters has been parsed in {} msecs",
+				StringUtils.length(htmlPage),
+				timer.getTime()
+			);
+		}
+		
+		return result;
+	}
+	
+}