Feat/#2764/add hash in xml #2781

Yanich96 · 2024-01-15T11:39:27Z

Closes #2764

What was done:

Class StHash was created to add the program hash code to the XML file header.
Class StHashTest was created to check adding the program hash code to the XML file header.
The schema XML was changed to add the program hash code to the XML file header.
Added tests checking hash code presence in xml.

PR-Codex overview

This PR focuses on adding a new 'hash' attribute to the 'program' node in XML files.

Detailed summary

Added 'hash' attribute to the 'program' node in XMIR.xsd and EoSyntaxTest.java
Created StHash class to generate hash code using MD5 algorithm
Updated PhiSyntax.java and EoSyntax.java to use StHash for generating hash code
Added StHashTest.java to test the functionality of StHash class

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Yanich96 · 2024-01-15T12:03:18Z

@volodya-lombrozo check please

volodya-lombrozo

@Yanich96 Could you, please:

Link the current PR description with the issue you are trying to solve (https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
Close the previous similar PR (fix(#2764): caching logic changed, added StHash, StHashTest, fix tests #2771) if you aren't going to continue with it.

volodya-lombrozo · 2024-01-15T12:17:30Z

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

+ *
+ * @since 0.35.0
+ */
+public final class StHash extends StEnvelope {


@Yanich96 I have some doubts about the StHash implementation and if we need it. I believe you can set the hash function directly in XeEoListener during the parsing. What do you think?

@volodya-lombrozo Hash code computes from node 'objects'. There isn't this node in parsing stage.

@volodya-lombrozo Xembly directives will have to be run 2 times: 1 - to calculate the hash, 2 - to completely parse, and during the parsing process there may be XSD schema errors and parsing errors, as a result of which the hash calculation ceases to make sense.

@volodya-lombrozo Hash code computes from node 'objects'. There isn't this node in parsing stage.

@Yanich96 Would exitProgram help us here? It looks like the final parsing stage.

@volodya-lombrozo Xembly directives will have to be run 2 times: 1 - to calculate the hash, 2 - to completely parse, and during the parsing process there may be XSD schema errors and parsing errors, as a result of which the hash calculation ceases to make sense.

We anyway will need to read XML twice

@volodya-lombrozo I will write todo for it.

volodya-lombrozo · 2024-01-15T12:19:52Z

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"/>


@Yanich96 Returning to the discussion. Maybe we don't need the hash attribute? Especially if we will save hash as a file attribute.

@volodya-lombrozo
I don't understand how to save hash as a file attribute.

I've found this solution: https://stackoverflow.com/questions/18955475/add-custom-attribute-or-metadata-to-file-java
What do you think?

@volodya-lombrozo In OptCahed.java the method 'contains(final XML xml)' get XML, but not file. We should get hash code of program, because we can't have file attributes. This reason is saving hash code in XML.

@Yanich96 You can always calculate the hash on the fly, like hash(xml); and compare it with the cache file attribute.

@volodya-lombrozo ok

@volodya-lombrozo I have done todo. This line will be deleted after it.

volodya-lombrozo · 2024-01-15T12:23:07Z

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

@@ -47,6 +47,7 @@
 *
 * @since 0.1
 */
+@SuppressWarnings("PMD.TooManyMethods")


@Yanich96 I believe, you don't need that line. Could you please, remove the line and run the following command:

mvn qulice:check -Pqulice

I did it myself and the linter said nothing about methods number.

@volodya-lombrozo Test failed : PMD: eo-parser/src/test/java/org/eolang/parser/EoSyntaxTest.java[50-250]: This class has too many methods, consider refactoring it. (TooManyMethods)
I used this command.

@Yanich96 Ok. Let's leave it as is.

@volodya-lombrozo This line will be deleted in the next pr, when I will transfer hash code in file attributes.

volodya-lombrozo · 2024-01-15T12:24:23Z

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

+         * @return String hash of this XML.
+         * @throws NoSuchAlgorithmException If fails.
+         */
+        public String compute() throws NoSuchAlgorithmException {


@Yanich96 This method contains lots of redundant variables. https://www.yegor256.com/2015/09/01/redundant-variables-are-evil.html

@Yanich96 The method name looks a bit misleading. The method returns a value, but you use verb here. Maybe it's better to use a noun?

builders vs manipulators

Yanich96 · 2024-01-15T15:36:29Z

@volodya-lombrozo check please

Yanich96 · 2024-01-15T15:42:27Z

@volodya-lombrozo I have fixed redundant variables in method StHash.compute(). Other comments will be resolved in added issues.

volodya-lombrozo · 2024-01-16T07:19:08Z

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

+         * @return String hash of this XML.
+         * @throws NoSuchAlgorithmException If fails.
+         */
+        public String compute() throws NoSuchAlgorithmException {


@Yanich96 The method name looks a bit misleading. The method returns a value, but you use verb here. Maybe it's better to use a noun?

builders vs manipulators

volodya-lombrozo · 2024-01-16T07:20:04Z

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

+         * @throws NoSuchAlgorithmException If fails.
+         */
+        public String compute() throws NoSuchAlgorithmException {
+            final BigInteger number = new BigInteger(


@Yanich96 number is a redundant variable.

volodya-lombrozo · 2024-01-16T07:25:22Z

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

+                        this.xml.nodes(
+                            "/program/objects"
+                        )
+                            .toString().getBytes()


@Yanich96 Here you apply toString method to a List instance, which is "ok" in this case (since the list contains strings.) However, why don't you use just xml.toString ? It looks simpler and doesn't require additional computations like applying paths

@volodya-lombrozo I use '/program/objects' for creating the hash code. If 'xml.toString' is used, hash code will be created from all xml.

@volodya-lombrozo Using the entire xml will cause the hash code to be inconsistent.

@Yanich96 Why?

volodya-lombrozo · 2024-01-16T07:34:27Z

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

+                            .toString().getBytes()
+                    )
+            );
+            final StringBuilder hash = new StringBuilder(number.toString(16));


@Yanich96 Could you just use Hex.encodeHexString() from Apache?

https://stackoverflow.com/a/9655275/10423604

Seems, we have this library in the classpath.

Yanich96 added 2 commits January 15, 2024 14:34

feat(objectionary#2764):created hash attribute for XML file

9187674

feat(objectionary#2764):added hash in xml files and added test

ec17acd

volodya-lombrozo requested changes Jan 15, 2024

View reviewed changes

feat(objectionary#2764):added todo and fix method 'compute'

eda6d3e

volodya-lombrozo requested changes Jan 16, 2024

View reviewed changes

feat(objectionary#2764):added new issues

cee99b0

Yanich96 closed this Jan 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/#2764/add hash in xml #2781

Feat/#2764/add hash in xml #2781

Yanich96 commented Jan 15, 2024 •

edited by pr-codex bot

Loading

Yanich96 commented Jan 15, 2024

volodya-lombrozo left a comment

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

Yanich96 Jan 15, 2024 •

edited

Loading

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

Yanich96 Jan 15, 2024

volodya-lombrozo Jan 15, 2024

volodya-lombrozo Jan 16, 2024 •

edited

Loading

Yanich96 commented Jan 15, 2024

Yanich96 commented Jan 15, 2024

volodya-lombrozo Jan 16, 2024 •

edited

Loading

volodya-lombrozo Jan 16, 2024

volodya-lombrozo Jan 16, 2024

Yanich96 Jan 16, 2024

Yanich96 Jan 16, 2024

volodya-lombrozo Jan 16, 2024

volodya-lombrozo Jan 16, 2024

Feat/#2764/add hash in xml #2781

Feat/#2764/add hash in xml #2781

Conversation

Yanich96 commented Jan 15, 2024 • edited by pr-codex bot Loading

PR-Codex overview

Detailed summary

Yanich96 commented Jan 15, 2024

volodya-lombrozo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yanich96 Jan 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

volodya-lombrozo Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

Yanich96 commented Jan 15, 2024

Yanich96 commented Jan 15, 2024

volodya-lombrozo Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yanich96 commented Jan 15, 2024 •

edited by pr-codex bot

Loading

Yanich96 Jan 15, 2024 •

edited

Loading

volodya-lombrozo Jan 16, 2024 •

edited

Loading

volodya-lombrozo Jan 16, 2024 •

edited

Loading