cqfn#390 refactor and separate report generation from calculus

src/main/java/org/jpeek/App.java

@@ -70,16 +70,13 @@
  *  and in `MetricsTest`).
  *  Once they are resolved add it to reports list.
  */
-@SuppressWarnings
-    (
-        {
-            "PMD.AvoidDuplicateLiterals",
-            "PMD.NPathComplexity",
-            "PMD.CyclomaticComplexity",
-            "PMD.StdCyclomaticComplexity",
-            "PMD.ModifiedCyclomaticComplexity"
-        }
-    )
+@SuppressWarnings({
+    "PMD.AvoidDuplicateLiterals",
+    "PMD.NPathComplexity",
+    "PMD.CyclomaticComplexity",
+    "PMD.StdCyclomaticComplexity",
+    "PMD.ModifiedCyclomaticComplexity"
+})
 public final class App {
 
     /**
@@ -172,115 +169,116 @@ public void analyze() throws IOException {
         final XSL chain = new XSLChain(layers);
         this.save(skeleton.toString(), "skeleton.xml");
         final Collection<Report> reports = new LinkedList<>();
+        final Calculus xsl = new XslCalculus();
         if (this.params.containsKey("LCOM")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "LCOM", this.params, 10.0d, -5.0d
+                    "LCOM", this.params, xsl, 10.0d, -5.0d
                 )
             );
         }
         if (this.params.containsKey("CAMC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "CAMC", this.params
+                    "CAMC", this.params, xsl
                 )
             );
         }
         if (this.params.containsKey("MMAC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "MMAC", this.params, 0.5d, 0.1d
+                    "MMAC", this.params, xsl, 0.5d, 0.1d
                 )
             );
         }
         if (this.params.containsKey("LCOM5")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "LCOM5", this.params, 0.5d, -0.1d
+                    "LCOM5", this.params, xsl, 0.5d, -0.1d
                 )
             );
         }
         if (this.params.containsKey("NHD")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "NHD"
+                    "NHD", xsl
                 )
             );
         }
         if (this.params.containsKey("LCOM2")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "LCOM2", this.params
+                    "LCOM2", this.params, xsl
                 )
             );
         }
         if (this.params.containsKey("LCOM3")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "LCOM3", this.params
+                    "LCOM3", this.params, xsl
                 )
             );
         }
         if (this.params.containsKey("SCOM")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "SCOM", this.params
+                    "SCOM", this.params, xsl
                 )
             );
         }
         if (this.params.containsKey("OCC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "OCC", this.params
+                    "OCC", this.params, xsl
                 )
             );
         }
         if (this.params.containsKey("PCC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "PCC"
+                    "PCC", xsl
                 )
             );
         }
         if (this.params.containsKey("TCC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "TCC"
+                    "TCC", xsl
                 )
             );
         }
         if (this.params.containsKey("LCC")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "LCC"
+                    "LCC", xsl
                 )
             );
         }
         if (this.params.containsKey("CCM")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "CCM"
+                    "CCM", xsl
                 )
             );
         }
         if (this.params.containsKey("MWE")) {
             reports.add(
                 new XslReport(
                     chain.transform(skeleton),
-                    "MWE"
+                    "MWE", xsl
                 )
             );
         }

src/main/java/org/jpeek/Calculus.java

@@ -0,0 +1,51 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017-2019 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.jpeek;
+
+import com.jcabi.xml.XML;
+import java.io.IOException;
+import java.util.Map;
+
+/**
+ * Metrics calculus interface.
+ * @since 0.1
+ * @todo #390:30min We have a separate interface to calculate XML metrics.
+ *  We should continue to the goal defined in #296 where we should have a java
+ *  implementation to calculate metrics. The motivation is to be able to make
+ *  calculations impossible or too difficult to implement in xsl. 
+ */
+public interface Calculus {
+
+    /**
+     * Produces {@link XML} representing metrics values.
+     * @param metric Desired metric to calculate
+     * @param params Params
+     * @param skeleton Package input
+     * @return XML document giving metrics values for classes
+     * @throws IOException If fails
+     */
+    XML node(String metric, Map<String, Object> params, XML skeleton)
+        throws IOException;
+
+}

src/main/java/org/jpeek/Report.java

@@ -29,10 +29,6 @@
 /**
  * Report interface.
  * @since 0.1
- * @todo #296:30min Now that we have the infrastructure to implement
- *  some metrics in other means than XSL transformations. We should try
- *  to implement some metrics with Java. We could start with LCOM4 metric that
- *  implies a graph traversal algorithm.
  */
 public interface Report {
 

src/main/java/org/jpeek/XslCalculus.java

@@ -0,0 +1,56 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017-2019 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.jpeek;
+
+import com.jcabi.xml.Sources;
+import com.jcabi.xml.XML;
+import com.jcabi.xml.XSLDocument;
+import java.io.IOException;
+import java.util.Map;
+import org.cactoos.io.ResourceOf;
+import org.cactoos.text.FormattedText;
+import org.cactoos.text.TextOf;
+
+/**
+ * Metrics xsl calculus. Use an xsl sheet to transform the input skeleton into
+ * the xml containing the calculation.
+ * @since 0.1
+ */
+public class XslCalculus implements Calculus {
+
+    @Override
+    public XML node(String metric, Map<String, Object> params, XML skeleton)
+        throws IOException {
+        return new XSLDocument(
+            new TextOf(
+                new ResourceOf(
+                    new FormattedText("org/jpeek/metrics/%s.xsl", metric)
+                )
+            ).asString(),
+            Sources.DUMMY,
+            params
+        ).transform(skeleton);
+    }
+
+}

src/main/java/org/jpeek/XslReport.java

@@ -25,7 +25,6 @@
 
 import com.jcabi.log.Logger;
 import com.jcabi.xml.ClasspathSources;
-import com.jcabi.xml.Sources;
 import com.jcabi.xml.StrictXML;
 import com.jcabi.xml.XML;
 import com.jcabi.xml.XMLDocument;
@@ -39,11 +38,8 @@
 import java.util.HashMap;
 import java.util.Map;
 import org.cactoos.collection.CollectionOf;
-import org.cactoos.io.ResourceOf;
 import org.cactoos.io.TeeInput;
 import org.cactoos.scalar.LengthOf;
-import org.cactoos.text.FormattedText;
-import org.cactoos.text.TextOf;
 import org.xembly.Directives;
 import org.xembly.Xembler;
 
@@ -95,6 +91,11 @@ final class XslReport implements Report {
      */
     private final String metric;
 
+    /**
+     * Calculus.
+     */
+    private final Calculus calculus;
+
     /**
      * Post processing XSLs.
      */
@@ -109,10 +110,11 @@ final class XslReport implements Report {
      * Ctor.
      * @param xml Skeleton
      * @param name Name of the metric
+     * @param calc Calculus
      */
-    XslReport(final XML xml, final String name) {
+    XslReport(final XML xml, final String name, final Calculus calc) {
         this(
-            xml, name, new HashMap<>(0),
+            xml, name, new HashMap<>(0), calc,
             XslReport.DEFAULT_MEAN, XslReport.DEFAULT_SIGMA
         );
     }
@@ -122,10 +124,12 @@ final class XslReport implements Report {
      * @param xml Skeleton
      * @param name Name of metric
      * @param args Params for XSL
+     * @param calc Calculus
      */
-    XslReport(final XML xml, final String name, final Map<String, Object> args) {
+    XslReport(final XML xml, final String name, final Map<String, Object> args,
+        final Calculus calc) {
         this(
-            xml, name, args,
+            xml, name, args, calc,
             XslReport.DEFAULT_MEAN, XslReport.DEFAULT_SIGMA
         );
     }
@@ -135,16 +139,18 @@ final class XslReport implements Report {
      * @param xml Skeleton
      * @param name Name of the metric
      * @param args Params for XSL
+     * @param calc Calculus
      * @param mean Mean
      * @param sigma Sigma
      * @checkstyle ParameterNumberCheck (10 lines)
      */
     XslReport(final XML xml, final String name,
-        final Map<String, Object> args,
+        final Map<String, Object> args, final Calculus calc,
         final double mean, final double sigma) {
         this.skeleton = xml;
         this.metric = name;
         this.params = args;
+        this.calculus = calc;
         this.post = new XSLChain(
             new CollectionOf<>(
                 new XSLDocument(
@@ -227,18 +233,9 @@ private XML xml() throws IOException {
                         XslReport.SCHEMA_FILE
                     )
             ).applyQuietly(
-                new XSLDocument(
-                    new TextOf(
-                        new ResourceOf(
-                            new FormattedText(
-                                "org/jpeek/metrics/%s.xsl",
-                                this.metric
-                            )
-                        )
-                    ).asString(),
-                    Sources.DUMMY,
-                    this.params
-                ).transform(this.skeleton).node()
+                this.calculus.node(
+                    this.metric, this.params, this.skeleton
+                ).node()
             )
         );
     }

src/test/java/org/jpeek/MetricsTest.java

@@ -249,7 +249,7 @@ public void testsTarget() throws Exception {
         final Path output = Files.createTempDirectory("");
         new XslReport(
             new Skeleton(new FakeBase(this.target)).xml(),
-            this.metric
+            this.metric, new XslCalculus()
         ).save(output);
         final String xpath;
         if (Double.isNaN(this.value)) {