Merge pull request #167 from itsallcode/story/#143-refactor-tag-importer

Story/#143 unify short & long tag importer

Author: kaklakariada

src/main/java/org/itsallcode/openfasttrace/Converter.java

@@ -27,9 +27,7 @@
 import java.util.List;
 
 import org.itsallcode.openfasttrace.core.Newline;
-import org.itsallcode.openfasttrace.FilterSettings;
-import org.itsallcode.openfasttrace.importer.legacytag.LegacyTagImporterFactory;
-import org.itsallcode.openfasttrace.importer.legacytag.config.LegacyTagImporterConfig;
+import org.itsallcode.openfasttrace.importer.tag.config.TagImporterConfig;
 
 /**
  * Convert between different requirements formats (e.g. from ReqM2 to Markdown)
@@ -72,14 +70,14 @@ public interface Converter
     public Converter setNewline(Newline newline);
 
     /**
-     * Set the {@link LegacyTagImporterConfig} for the
+     * Set the {@link TagImporterConfig} for the
      * {@link LegacyTagImporterFactory}.
      * 
      * @param config
-     *            the {@link LegacyTagImporterConfig} to set.
+     *            the {@link TagImporterConfig} to set.
      * @return a <code>Converter</code> instance for fluent programming
      */
-    public Converter setLegacyTagImporterPathConfig(final LegacyTagImporterConfig config);
+    public Converter setLegacyTagImporterPathConfig(final TagImporterConfig config);
 
     /**
      * Convert the collected requirements into target requirement format

src/main/java/org/itsallcode/openfasttrace/Reporter.java

@@ -28,9 +28,7 @@
 
 import org.itsallcode.openfasttrace.core.Newline;
 import org.itsallcode.openfasttrace.core.Trace;
-import org.itsallcode.openfasttrace.FilterSettings;
-import org.itsallcode.openfasttrace.importer.legacytag.LegacyTagImporterFactory;
-import org.itsallcode.openfasttrace.importer.legacytag.config.LegacyTagImporterConfig;
+import org.itsallcode.openfasttrace.importer.tag.config.TagImporterConfig;
 import org.itsallcode.openfasttrace.report.ReportVerbosity;
 
 /**
@@ -83,14 +81,14 @@ public interface Reporter
     public Reporter setReportVerbosity(final ReportVerbosity verbosity);
 
     /**
-     * Set the {@link LegacyTagImporterConfig} for the
+     * Set the {@link TagImporterConfig} for the
      * {@link LegacyTagImporterFactory}.
      * 
      * @param config
-     *            the {@link LegacyTagImporterConfig} to set.
+     *            the {@link TagImporterConfig} to set.
      * @return a <code>Reporter</code> instance for fluent programming
      */
-    public Reporter setLegacyTagImporterPathConfig(final LegacyTagImporterConfig config);
+    public Reporter setLegacyTagImporterPathConfig(final TagImporterConfig config);
 
     /**
      * Run a trace on the input files

src/main/java/org/itsallcode/openfasttrace/importer/ImporterContext.java

@@ -23,15 +23,15 @@
  */
 import java.util.Objects;
 
-import org.itsallcode.openfasttrace.importer.legacytag.config.LegacyTagImporterConfig;
+import org.itsallcode.openfasttrace.importer.tag.config.TagImporterConfig;
 
 /**
  * Common context shared by all {@link ImporterFactory}s. This allows importers
  * to access common infrastructure, e.g. the {@link ImporterService}.
  */
 public class ImporterContext
 {
-    private final LegacyTagImporterConfig tagImporterConfig;
+    private final TagImporterConfig tagImporterConfig;
     private ImporterService importerService;
 
     /**
@@ -40,7 +40,7 @@ public class ImporterContext
      * @param tagImporterConfig
      *            importer specific configuration.
      */
-    public ImporterContext(final LegacyTagImporterConfig tagImporterConfig)
+    public ImporterContext(final TagImporterConfig tagImporterConfig)
     {
         this.tagImporterConfig = tagImporterConfig;
     }
@@ -72,7 +72,7 @@ public ImporterService getImporterService()
      * 
      * @return importer specific configuration.
      */
-    public LegacyTagImporterConfig getTagImporterConfig()
+    public TagImporterConfig getTagImporterConfig()
     {
         return this.tagImporterConfig;
     }

src/main/java/org/itsallcode/openfasttrace/importer/LineReader.java

@@ -50,7 +50,7 @@ public void readLines(final LineConsumer consumer)
             while ((line = reader.readLine()) != null)
             {
                 currentLineNumber = reader.getLineNumber();
-                consumer.readLine(currentLineNumber, line);
+                processLine(consumer, currentLineNumber, line);
             }
         }
         catch (final IOException exception)
@@ -60,6 +60,20 @@ public void readLines(final LineConsumer consumer)
         }
     }
 
+    private void processLine(final LineConsumer consumer, final int currentLineNumber,
+            final String line)
+    {
+        try
+        {
+            consumer.readLine(currentLineNumber, line);
+        }
+        catch (final Exception e)
+        {
+            throw new ImporterException("Error processing line " + this.file.getPath() + ":"
+                    + currentLineNumber + " (" + line + "): " + e.getMessage(), e);
+        }
+    }
+
     @FunctionalInterface
     public interface LineConsumer
     {

src/main/java/org/itsallcode/openfasttrace/importer/legacytag/LegacyTagImporterFactory.java

@@ -0,0 +1,42 @@
+package org.itsallcode.openfasttrace.importer.tag;
+
+/*-
+ * #%L
+ * OpenFastTrace
+ * %%
+ * Copyright (C) 2016 - 2018 itsallcode.org
+ * %%
+ * 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 3 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, see
+ * <http://www.gnu.org/licenses/gpl-3.0.html>.
+ * #L%
+ */
+import java.util.List;
+
+import org.itsallcode.openfasttrace.importer.LineReader.LineConsumer;
+
+class DelegatingLineConsumer implements LineConsumer
+{
+    private final List<LineConsumer> delegates;
+
+    DelegatingLineConsumer(final List<LineConsumer> delegates)
+    {
+        this.delegates = delegates;
+    }
+
+    @Override
+    public void readLine(final int lineNumber, final String line)
+    {
+        this.delegates.forEach(delegate -> delegate.readLine(lineNumber, line));
+    }
+}

src/main/java/org/itsallcode/openfasttrace/importer/tag/DelegatingLineConsumer.java

@@ -0,0 +1,86 @@
+package org.itsallcode.openfasttrace.importer.tag;
+
+/*-
+ * #%L
+ * OpenFastTrace
+ * %%
+ * Copyright (C) 2016 - 2018 itsallcode.org
+ * %%
+ * 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 3 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, see
+ * <http://www.gnu.org/licenses/gpl-3.0.html>.
+ * #L%
+ */
+import java.util.logging.Logger;
+import java.util.regex.Matcher;
+
+import org.itsallcode.openfasttrace.core.SpecificationItemId;
+import org.itsallcode.openfasttrace.importer.ChecksumCalculator;
+import org.itsallcode.openfasttrace.importer.ImportEventListener;
+import org.itsallcode.openfasttrace.importer.input.InputFile;
+
+// [impl->dsn~import.full-coverage-tag~1]
+class LongTagImportingLineConsumer extends RegexLineConsumer
+{
+    private static final Logger LOG = Logger
+            .getLogger(LongTagImportingLineConsumer.class.getName());
+
+    private static final String COVERING_ARTIFACT_TYPE_PATTERN = "\\p{Alpha}+";
+    private static final String TAG_PREFIX = "\\[";
+    private static final String TAG_SUFFIX = "\\]";
+    private static final String TAG_REGEX = TAG_PREFIX //
+            + "(" + COVERING_ARTIFACT_TYPE_PATTERN + ")" //
+            + "->" //
+            + "(" + SpecificationItemId.ID_PATTERN + ")" //
+            + TAG_SUFFIX;
+
+    private final InputFile file;
+    private final ImportEventListener listener;
+
+    LongTagImportingLineConsumer(final InputFile file, final ImportEventListener listener)
+    {
+        super(TAG_REGEX);
+        this.file = file;
+        this.listener = listener;
+    }
+
+    @Override
+    public void processMatch(final Matcher matcher, final int lineNumber, final int lineMatchCount)
+    {
+        this.listener.beginSpecificationItem();
+        this.listener.setLocation(this.file.getPath(), lineNumber);
+        final SpecificationItemId coveredId = SpecificationItemId.parseId(matcher.group(2));
+        final String generatedName = generateName(coveredId, lineNumber, lineMatchCount);
+        final SpecificationItemId generatedId = SpecificationItemId.createId(matcher.group(1),
+                generatedName, 0);
+
+        LOG.finest(() -> "File " + this.file + ":" + lineNumber + ": found '" + generatedId
+                + "' covering id '" + coveredId + "'");
+        this.listener.setId(generatedId);
+        this.listener.addCoveredId(coveredId);
+        this.listener.endSpecificationItem();
+    }
+
+    private String generateName(final SpecificationItemId coveredId, final int lineNumber,
+            final int counter)
+    {
+        final String uniqueName = new StringBuilder() //
+                .append(this.file.getPath()) //
+                .append(lineNumber) //
+                .append(counter) //
+                .append(coveredId) //
+                .toString();
+        final String checksum = Long.toString(ChecksumCalculator.calculateCrc32(uniqueName));
+        return coveredId.getName() + "-" + checksum;
+    }
+}

src/main/java/org/itsallcode/openfasttrace/importer/tag/LongTagImportingLineConsumer.java

@@ -0,0 +1,56 @@
+package org.itsallcode.openfasttrace.importer.tag;
+
+/*-
+ * #%L
+ * OpenFastTrace
+ * %%
+ * Copyright (C) 2016 - 2018 itsallcode.org
+ * %%
+ * 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 3 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, see
+ * <http://www.gnu.org/licenses/gpl-3.0.html>.
+ * #L%
+ */
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.itsallcode.openfasttrace.importer.LineReader.LineConsumer;
+
+abstract class RegexLineConsumer implements LineConsumer
+{
+    private final Pattern pattern;
+
+    RegexLineConsumer(final String patternRegex)
+    {
+        this(Pattern.compile(patternRegex));
+    }
+
+    private RegexLineConsumer(final Pattern pattern)
+    {
+        this.pattern = pattern;
+    }
+
+    @Override
+    public void readLine(final int lineNumber, final String line)
+    {
+        final Matcher matcher = this.pattern.matcher(line);
+        int counter = 0;
+        while (matcher.find())
+        {
+            this.processMatch(matcher, lineNumber, counter);
+            counter++;
+        }
+    }
+
+    abstract void processMatch(Matcher matcher, int lineNumber, int lineMatchCount);
+}