#135 Added schema location to metric.xml

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

@@ -39,9 +39,13 @@
 import java.util.HashMap;
 import java.util.Map;
 import org.cactoos.collection.CollectionOf;
+import org.cactoos.io.InputOf;
 import org.cactoos.io.LengthOf;
 import org.cactoos.io.TeeInput;
+import org.cactoos.map.MapEntry;
+import org.cactoos.map.MapOf;
 import org.cactoos.text.TextOf;
+import org.cactoos.text.UncheckedText;
 
 /**
  * Single report.
@@ -63,11 +67,16 @@ final class Report {
      */
     private static final double DEFAULT_SIGMA = 0.1d;
 
+    /**
+     * Location to the schema file.
+     */
+    private static final String SCHEMA_FILE = "xsd/metric.xsd";
+
     /**
      * XSD schema.
      */
     private static final XSD SCHEMA = XSDDocument.make(
-        Report.class.getResourceAsStream("xsd/metric.xsd")
+        Report.class.getResourceAsStream(Report.SCHEMA_FILE)
     );
 
     /**
@@ -130,15 +139,37 @@ final class Report {
      * @param mean Mean
      * @param sigma Sigma
      * @checkstyle ParameterNumberCheck (10 lines)
+     * @todo #135:30min The current solution to add the reference to
+     *  'metric.xsd' in the generated 'metric.xml' is too complex for
+     *  the task at hand. Refactor towards a simpler solution that
+     *  ideally would just require one or two Xembly instructions to
+     *  add the required attribute.
      */
+    @SuppressWarnings("unchecked")
     Report(final XML xml, final String name,
         final Map<String, Object> args,
         final double mean, final double sigma) {
         this.skeleton = xml;
         this.metric = name;
-        this.params = args;
+        this.params = new MapOf<>(
+            args,
+            new MapEntry<>("schemaLocation", Report.SCHEMA_FILE)
+        );
         this.post = new XSLChain(
             new CollectionOf<>(
+                new XSLDocument(
+                    new UncheckedText(
+                        new TextOf(
+                            new InputOf(
+                                Report.class.getResourceAsStream(
+                                    "xsl/metric-post-schemaloc.xsl"
+                                )
+                            )
+                        )
+                    ).asString(),
+                    Sources.DUMMY,
+                    this.params
+                ),
                 new XSLDocument(
                     Report.class.getResourceAsStream(
                         "xsl/metric-post-colors.xsl"

src/main/resources/org/jpeek/xsd/index.xsd

@@ -26,6 +26,9 @@ SOFTWARE.
 @todo #134:30min Index.xsd: add `xsd:documentation` tags as per issue #134. We need to
  document the schemas in src/resources/org/jpeek/xsd so that the semantics of
  the generated XML documents is transparent for maintainers.
+@todo #135:30min Index.xsd: add a reference to this schema from the generated
+ index.xml. Schemas from src/resources/org/jpeek/xsd must be referenced in
+ generated XMLs.
 -->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="index">

src/main/resources/org/jpeek/xsd/matrix.xsd

@@ -26,6 +26,9 @@ SOFTWARE.
 @todo #134:30min Matrix.xsd: add `xsd:documentation` tags as per issue #134. We need to
  document the schemas in src/resources/org/jpeek/xsd so that the semantics of
  the generated XML documents is transparent for maintainers.
+@todo #135:30min Matrix.xsd: add a reference to this schema from the generated
+ matrix.xml. Schemas from src/resources/org/jpeek/xsd must be referenced in
+ generated XMLs.
 -->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="matrix">

src/main/resources/org/jpeek/xsd/skeleton.xsd

@@ -22,6 +22,11 @@ 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.
 -->
+<!--
+@todo #135:30min Skeleton.xsd: add a reference to this schema from the generated
+ skeleton.xml. Schemas from src/resources/org/jpeek/xsd must be referenced in
+ generated XMLs.
+-->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType name="class">
     <xs:all>

src/main/resources/org/jpeek/xsl/metric-post-schemaloc.xsl

@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<!--
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 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.
+-->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
+  <xsl:param name="schemaLocation"/>
+  <xsl:template match="metric">
+    <xsl:element name="metric">
+      <xsl:attribute name="xsi:noNamespaceSchemaLocation" namespace="http://www.w3.org/2001/XMLSchema-instance">
+        <xsl:value-of select="$schemaLocation"/>
+      </xsl:attribute>
+      <xsl:apply-templates select="node()|@*"/>
+    </xsl:element>
+  </xsl:template>
+  <xsl:template match="node()|@*">
+    <xsl:copy>
+      <xsl:apply-templates select="node()|@*"/>
+    </xsl:copy>
+  </xsl:template>
+</xsl:stylesheet>

src/test/java/org/jpeek/ReportTest.java

@@ -135,4 +135,18 @@ public void createsFullXmlReport() throws IOException {
         );
     }
 
+    @Test
+    public void setsCorrectschemaLocation() throws IOException {
+        final Path output = Files.createTempDirectory("");
+        new Report(new Skeleton(new FakeBase()).xml(), "LCOM").save(output);
+        MatcherAssert.assertThat(
+            XhtmlMatchers.xhtml(
+                new TextOf(output.resolve("LCOM.xml")).asString()
+            ),
+            XhtmlMatchers.hasXPaths(
+                // @checkstyle LineLength (1 line)
+                "/metric[@xsi:noNamespaceSchemaLocation = 'xsd/metric.xsd']"
+            )
+        );
+    }
 }