Feat/#2764/add hash in xml

eo-parser/src/main/java/org/eolang/parser/EoSyntax.java

@@ -26,6 +26,7 @@
 import com.jcabi.log.Logger;
 import com.jcabi.xml.XML;
 import com.jcabi.xml.XMLDocument;
+import com.yegor256.xsline.Xsline;
 import java.io.IOException;
 import java.util.List;
 import org.antlr.v4.runtime.CommonTokenStream;
@@ -70,7 +71,7 @@ public EoSyntax(final String nme, final Input ipt) {
     }
 
     /**
-     * Compile it to XML and save.
+     * Compile it to XML.
      *
      * <p>No exception will be thrown if the syntax is invalid. In any case, XMIR will
      * be generated and saved. Read it in order to find the errors,
@@ -92,10 +93,12 @@ public XML parsed() throws IOException {
         parser.addErrorListener(spy);
         final XeEoListener xel = new XeEoListener(this.name);
         new ParseTreeWalker().walk(xel, parser.program());
-        final XML dom = new XMLDocument(
-            new Xembler(
-                new Directives(xel).append(spy)
-            ).domQuietly()
+        final XML dom = new Xsline(new StHash()).pass(
+            new XMLDocument(
+                new Xembler(
+                    new Directives(xel).append(spy)
+                ).domQuietly()
+            )
         );
         new Schema(dom).check();
         if (spy.size() == 0) {

eo-parser/src/main/java/org/eolang/parser/PhiSyntax.java

@@ -26,6 +26,7 @@
 import com.jcabi.log.Logger;
 import com.jcabi.xml.XML;
 import com.jcabi.xml.XMLDocument;
+import com.yegor256.xsline.Xsline;
 import java.io.IOException;
 import org.antlr.v4.runtime.CharStreams;
 import org.antlr.v4.runtime.CommonTokenStream;
@@ -84,10 +85,12 @@ public XML parsed() throws IOException {
         parser.removeErrorListeners();
         parser.addErrorListener(spy);
         new ParseTreeWalker().walk(xel, parser.program());
-        final XML dom = new XMLDocument(
-            new Xembler(
-                new Directives(xel).append(spy)
-            ).domQuietly()
+        final XML dom = new Xsline(new StHash()).pass(
+            new XMLDocument(
+                new Xembler(
+                    new Directives(xel).append(spy)
+                ).domQuietly()
+            )
         );
         new Schema(dom).check();
         if (spy.size() == 0) {

eo-parser/src/main/java/org/eolang/parser/StHash.java

@@ -0,0 +1,119 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016-2023 Objectionary.com
+ *
+ * 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.eolang.parser;
+
+import com.jcabi.xml.XML;
+import com.jcabi.xml.XMLDocument;
+import com.yegor256.xsline.StEnvelope;
+import com.yegor256.xsline.StLambda;
+import java.math.BigInteger;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import org.xembly.Directives;
+import org.xembly.Xembler;
+
+/**
+ * Add attribute 'hash' in node 'program' in XML.
+ * Returns already XML with hash.
+ *
+ * @since 0.35.0
+ *
+ * @todo #2764:30min Replace the hash code entry
+ *  from the XML file node attribute to the file attribute.
+ *  This is necessary to increase the speed of searching for a cached file.
+ *  The hash code entry should be deleted from EoSyntax.java and PhiSyntax.java.
+ *  Hash code should save to the file attribute in ParseMojo.java and UnphiMojo.
+ *  Delete tests containsHash() from EoSyntaxTest.java and PhiSyntaxTest.java.
+ * @todo #2764:30min Is it possible set the hash function directly
+ *  in XeEoListener during the parsing? Now hash code is generated in class StHash.java.
+ *  Maybe it will be better generating hash code in class XeEoListener.
+ */
+public final class StHash extends StEnvelope {
+
+    /**
+     * Returns XML with attribute 'hash'.
+     */
+    public StHash() {
+        super(
+            new StLambda((
+                position,
+                xml) ->
+                new XMLDocument(
+                    new Xembler(
+                        new Directives().xpath("//program").attr("hash", new Hash(xml).compute())
+                    ).apply(xml.node())
+                )
+            )
+        );
+    }
+
+    /**
+     * Hash is generated by MD5 using node '/program/objects'.
+     * Returns program hash.
+     *
+     * @since 0.35.0
+     */
+    public static final class Hash {
+
+        /**
+         * XML for which the hash code will be made.
+         */
+        private final XML xml;
+
+        /**
+         * The constructor.
+         *
+         * @param xml XML for which the hash code will be made.
+         */
+        public Hash(final XML xml) {
+            this.xml = xml;
+        }
+
+        /**
+         * Return program hash using node "/program/objects".
+         *
+         * @return String hash of this XML.
+         * @throws NoSuchAlgorithmException If fails.
+         */
+        public String compute() throws NoSuchAlgorithmException {
+            final BigInteger number = new BigInteger(
+                1,
+                MessageDigest
+                    .getInstance("MD5")
+                    .digest(
+                        this.xml.nodes(
+                            "/program/objects"
+                        )
+                            .toString().getBytes()
+                    )
+            );
+            final StringBuilder hash = new StringBuilder(number.toString(16));
+            while (hash.length() < 32) {
+                hash.insert(0, "0");
+            }
+            return hash.toString();
+        }
+    }
+}
+

eo-parser/src/main/resources/XMIR.xsd

@@ -113,6 +113,7 @@ SOFTWARE.
     <xs:attribute name="version" type="xs:string" use="required"/>
     <xs:attribute name="revision" type="xs:string" use="required"/>
     <xs:attribute name="dob" type="xs:dateTime" use="required"/>
+    <xs:attribute name="hash" type="xs:string" use="required"/>
     <xs:attribute name="source" type="xs:string"/>
   </xs:complexType>
   <xs:element name="program" type="program"/>

eo-parser/src/test/java/org/eolang/parser/EoSyntaxTest.java

@@ -47,6 +47,7 @@
  *
  * @since 0.1
  */
+@SuppressWarnings("PMD.TooManyMethods")
 final class EoSyntaxTest {
     @Test
     void parsesSimpleCode() throws Exception {
@@ -175,6 +176,18 @@ void parsesDefinition() throws IOException {
         );
     }
 
+    @Test
+    void containsHash() throws IOException {
+        MatcherAssert.assertThat(
+            "XML file should have 'hash' attribute on program node, but didn't",
+            new EoSyntax(
+                "test-it-5",
+                new InputOf("[v] > p\n  f.write > @\n")
+            ).parsed(),
+            XhtmlMatchers.hasXPath("/program/@hash")
+        );
+    }
+
     @Test
     void parsesMethodCalls() throws IOException {
         MatcherAssert.assertThat(

eo-parser/src/test/java/org/eolang/parser/PhiSyntaxTest.java

@@ -46,4 +46,15 @@ void addsError() throws IOException {
             )
         );
     }
+
+    @Test
+    void containsHash() throws IOException {
+        MatcherAssert.assertThat(
+            "Result XML must contain hash",
+            new PhiSyntax(
+                "empty ↦ Φ.org.eolang.bytes"
+            ).parsed(),
+            XhtmlMatchers.hasXPath("/program/@hash")
+        );
+    }
 }

eo-parser/src/test/java/org/eolang/parser/StHashTest.java

@@ -0,0 +1,77 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016-2023 Objectionary.com
+ *
+ * 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.eolang.parser;
+
+import com.jcabi.matchers.XhtmlMatchers;
+import com.jcabi.xml.XML;
+import com.jcabi.xml.XMLDocument;
+import com.yegor256.xsline.Xsline;
+import java.security.NoSuchAlgorithmException;
+import org.hamcrest.MatcherAssert;
+import org.junit.jupiter.api.Test;
+import org.xembly.Directives;
+import org.xembly.Xembler;
+
+/**
+ * Test case for {@link StHash}.
+ *
+ * @since 0.35.0
+ */
+final class StHashTest {
+
+    @Test
+    void isHashInXml() {
+        MatcherAssert.assertThat(
+            "We should get XML, which has new attribute 'hash', but didn't",
+            new Xsline(new StHash()).pass(program()),
+            XhtmlMatchers.hasXPath("/program/@hash")
+        );
+    }
+
+    @Test
+    void checksHash() throws NoSuchAlgorithmException {
+        MatcherAssert.assertThat(
+            "We should get the same hash code, but didn't",
+            new Xsline(new StHash()).pass(program()),
+            XhtmlMatchers.hasXPath("/program/@hash", new StHash.Hash(program()).compute())
+        );
+    }
+
+    /**
+     * Generates EO program for tests with specified time and context.
+     * @return XML representation of program.
+     */
+    private static XML program() {
+        return new XMLDocument(
+            new Xembler(
+                new Directives()
+                    .add("program")
+                    .attr("name", "main")
+                    .add("objects")
+                    .attr("object", "10")
+                    .up()
+            ).xmlQuietly()
+        );
+    }
+}