feat(#165): `reserved-name` lint #440

h1alexbel · 2025-03-28T17:30:07Z

In this PR I've implemented new lint: reserved-name, that issues defect with warning severity if object uses name, already reserved by object in org.eolang.* package.

closes #165
History:

feat(prohibit reserved names #165): start
feat(prohibit reserved names #165): more tests
feat(prohibit reserved names #165): deep test case, naming check
feat(prohibit reserved names #165): no args
feat(prohibit reserved names #165): parsing stream, more tests
feat(prohibit reserved names #165): nested
feat(prohibit reserved names #165): pull
feat(prohibit reserved names #165): motive
feat(prohibit reserved names #165): report object

h1alexbel · 2025-04-02T10:52:55Z

@volodya-lombrozo updated. Take a look, please

volodya-lombrozo · 2025-04-03T07:16:02Z

src/main/java/org/eolang/lints/LtReservedName.java

+    private static final Pattern NON_UNIX = Pattern.compile("\\\\");
+
+    /**
+     * Reserved names.


@h1alexbel I was reading this file and asked myself several times what the keys and values are. I guess a key here is an object name and a value is an object path. Am I right? If so, it would be better to clarify this in the Javadocs.

volodya-lombrozo · 2025-04-03T07:26:20Z

src/main/java/org/eolang/lints/LtReservedName.java

+     * @checkstyle IllegalCatchCheck (15 lines)
+     */
+    @SuppressWarnings("PMD.AvoidCatchingGenericException")
+    private static Consumer<Path> jar(final Map<String, String> names) {


@h1alexbel What is the difference between file and jar methods? Aren't they the same?

This code looks similar to me:

parsed = new EoSyntax( "reserved", new UncheckedInput(new InputOf(eo.toFile())) ).parsed();

and

InputStream input = Files.newInputStream(eo) parsed = new EoSyntax( "reserved", new TextOf(input).asString() ).parsed();

Moreover, under the hood EoSyntax will wrap the string from the last example to the same Input:

public EoSyntax(final String nme, final String ipt) { this(nme, new InputOf(ipt)); }

Maybe I'm missing something?

@volodya-lombrozo in the jar method, we need to read the content from the input first, and only then parse it, otherwise we are getting:

Caused by: java.io.EOFException: Unexpected end of ZLIB input stream at jdk.zipfs/jdk.nio.zipfs.ZipFileSystem$2.fill(ZipFileSystem.java:2275) at java.base/java.util.zip.InflaterInputStream.read(InflaterInputStream.java:175) at org.cactoos.io.TeeInputStream.read(TeeInputStream.java:61) at org.cactoos.io.TeeInputStream.read(TeeInputStream.java:55) at org.cactoos.bytes.InputAsBytes.asBytes(InputAsBytes.java:63) at org.cactoos.bytes.BytesOf.asBytes(BytesOf.java:732) at org.cactoos.text.TextOf.lambda$new$0(TextOf.java:272) at org.cactoos.text.TextOfScalar.asString(TextOfScalar.java:39) at org.cactoos.text.TextEnvelope.asString(TextEnvelope.java:32) at org.cactoos.text.Split.lambda$new$0(Split.java:108) at org.cactoos.scalar.Checked.value(Checked.java:56) at org.cactoos.scalar.IoChecked.value(IoChecked.java:44) at org.cactoos.scalar.Unchecked.value(Unchecked.java:37) ... 34 more

Also, we cannot convert Path in jar to file:

Caused by: java.lang.UnsupportedOperationException at jdk.zipfs/jdk.nio.zipfs.ZipPath.toFile(ZipPath.java:673) at org.eolang.lints.LtReservedName.lambda$jar$3(LtReservedName.java:199) at java.base/java.util.stream.ForEachOps$ForEachOp$OfRef.accept(ForEachOps.java:184) at java.base/java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:179) at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197) at java.base/java.util.Iterator.forEachRemaining(Iterator.java:133) at java.base/java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1939) at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:509) at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:499) at java.base/java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151) at java.base/java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174) at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) at java.base/java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:596) at org.eolang.lints.LtReservedName.home(LtReservedName.java:148) at org.eolang.lints.LtReservedName.<init>(LtReservedName.java:61) at org.eolang.lints.MonoLints.<clinit>(MonoLints.java:35) ... 6 more

volodya-lombrozo · 2025-04-03T07:47:10Z

src/main/java/org/eolang/lints/LtReservedName.java

+     * @param names Names
+     * @return File consumer from path
+     */
+    private static Consumer<Path> file(final Map<String, String> names) {


@h1alexbel To be honest, I have some doubts about the design of file(), jar(), and processXmir(). In all of these methods, you pass a final Map<String, String> names to populate it. This approach works well and is efficient. However, it feels a bit overcomplicated to me and relies on indirection through Consumer<Path>.

Could we transform these methods from manipulators to builders (similar to the home() method)? What I mean is that it might be better to change their signatures from

Consumer<Path> file(final Map<String, String> names)

to something like
Map<String, String> file(final Path path)

or
Entry<Map<String, String>> file(final Path path)

Then, instead of the following code:

Files.walk(Paths.get(resource.toURI())) .filter(sources) .forEach(LtReservedName.file(names));

You could use something like:

Files.walk(Paths.get(resource.toURI())) .filter(sources) .map(LtReservedName::file) .toMap()

What do you think?

@volodya-lombrozo yes, indeed it overcomplicated, refactoring to Map<String, String> namesInFile(Path path) now.

h1alexbel · 2025-04-03T10:14:36Z

@volodya-lombrozo updated. Take a look, please

volodya-lombrozo

@h1alexbel Thank you for the changes. Now it's much better. I've left one more question.

volodya-lombrozo · 2025-04-04T08:02:06Z

src/main/java/org/eolang/lints/LtReservedName.java

+                        .toString().replace("\\", "/")
+            );
+        };
+        if ("jar".equals(resource.getProtocol())) {


@h1alexbel Can you somehow get a jar here? As I understood, you copy all the .eo files from https://github.com/objectionary/home.git and then just look object inside of them. Please, correct me if I'm wrong. Thus, how can you can get a jar here? Moreover, you have the only one constructor:

LtReservedName() { this(LtReservedName.home(Paths.get("cloned", "home").toString())); }

@volodya-lombrozo during the build of the lints project, we are cloning home using git clone https://github.com/objectionary/home.git to clone it to the build directory: ${project.build.directory}/cloned/home. Then, to be able reuse those files outside of lints, when we are importing lints project - we copy ${project.build.directory}/cloned/home to classes in lints JAR: ${project.build.directory}/classes/cloned/home.

This expression if ("jar".equals(resource.getProtocol())) { returns true, when dependent on lint project executes linting via Program. Such example is our invoker integration test. While, in local tests, cloned home repo will be accessed as normal file.

Both methods depend on the same directory, which we pass in the ctor: cloned/home, the only difference in the term of access - for JAR we need to "mount" the file system using java.nio.file.FileSystem.

@h1alexbel I see, thank you for the comprehensive explanation. Now it's clear. Could you add this explanation to the JavaDocs, please? It will greatly help other developers to understand what is going on.

Also I would highly recommend simplifying the solution. For example, you can generate a list of objects during the lints build and just reuse it in runtime. Yes, it's a less dynamic approach and each time when eo changes we will need to rebuild and release lints, but it's much more reliable solution (KISS principle). However, It's better to discuss in a separate issue. What do you think?

@volodya-lombrozo yes, I will add this information to the JavaDocs. About simplification, let's discuss in a separate issue.

volodya-lombrozo · 2025-04-04T08:33:46Z

src/main/java/org/eolang/lints/LtReservedName.java

+                        .toString().replace("\\", "/")
+            );
+        };
+        if ("jar".equals(resource.getProtocol())) {


@h1alexbel I see, thank you for the comprehensive explanation. Now it's clear. Could you add this explanation to the JavaDocs, please? It will greatly help other developers to understand what is going on.

Also I would highly recommend simplifying the solution. For example, you can generate a list of objects during the lints build and just reuse it in runtime. Yes, it's a less dynamic approach and each time when eo changes we will need to rebuild and release lints, but it's much more reliable solution (KISS principle). However, It's better to discuss in a separate issue. What do you think?

h1alexbel · 2025-04-04T10:03:22Z

@volodya-lombrozo added JavaDoc. Take a look, please

volodya-lombrozo

@h1alexbel Looks good to me. Thanks.

h1alexbel · 2025-04-04T10:08:37Z

@yegor256 take a look, please

yegor256 · 2025-04-04T10:56:15Z

pom.xml

+            <configuration>
+              <executable>git</executable>
+              <arguments>
+                <argument>clone</argument>


@h1alexbel maybe a shallow copy will be enough? Full git clone is very time/space expensive.

yegor256 · 2025-04-04T10:57:16Z

pom.xml

+              <arguments>
+                <argument>clone</argument>
+                <argument>https://github.com/objectionary/home.git</argument>
+                <argument>${project.build.directory}/cloned/home</argument>


@h1alexbel try to do this: mvn clean install && mvn install and see the result

@h1alexbel maybe it's better to use git submodule instead of git clone? Or maybe just wget to download master from home in ZIP archive?

@yegor256 wget will fail on windows. Am I understood correctly that we should add home repo as Git submodule to the lints repo?

@h1alexbel this one can do the same as wget: https://github.com/download-maven-plugin/download-maven-plugin

yegor256 · 2025-04-04T10:58:49Z

@h1alexbel many thanks for the contribution! See a few comments above.

h1alexbel · 2025-04-04T13:50:25Z

@yegor256 updated. Take a look, please

yegor256 · 2025-04-04T14:13:38Z

@rultor merge

rultor · 2025-04-04T14:15:20Z

@rultor merge

@yegor256 OK, I'll try to merge now. You can check the progress of the merge here.

rultor · 2025-04-04T14:32:04Z

@rultor merge

@yegor256 Done! FYI, the full log is here (took me 15min).

h1alexbel added 9 commits March 27, 2025 15:55

feat(objectionary#165): start

e36d3dc

feat(objectionary#165): more tests

72e2a40

feat(objectionary#165): deep test case, naming check

f351214

feat(objectionary#165): no args

f0874f8

feat(objectionary#165): parsing stream, more tests

ded3b31

feat(objectionary#165): nested

66a2d5e

feat(objectionary#165): pull

a43e0ff

feat(objectionary#165): motive

8ba90fc

feat(objectionary#165): report object

e773102

h1alexbel changed the title ~~feat(#165): reserved-name lint~~ feat(#165): reserved-name lint Mar 28, 2025

h1alexbel marked this pull request as draft March 28, 2025 17:51

h1alexbel added 18 commits April 1, 2025 13:04

feat(objectionary#165): jgit

beeb3f3

feat(objectionary#165): jgit off

808b0e7

feat(objectionary#165): clean for qulice

00037bd

feat(objectionary#165): clean

458c581

feat(objectionary#165): file separator

034b933

feat(objectionary#165): Paths.get

4dd3de8

feat(objectionary#165): no separators

4f4d40f

feat(objectionary#165): no separators

dd74876

feat(objectionary#165): getFile().toPath()

cfaf9b7

feat(objectionary#165): toURI()

493ab69

feat(objectionary#165): sources filter

050cea5

Merge branch 'master' into 165

83b0361

feat(objectionary#165): off from Mono

583d7e1

feat(objectionary#165): clean up

47abcd1

feat(objectionary#165): org.eolang

ba6e633

feat(objectionary#165): order

9e8a24e

feat(objectionary#165): 90secs

b27bc9a

feat(objectionary#165): pit exclude

5b73487

h1alexbel marked this pull request as ready for review April 1, 2025 15:35

feat(objectionary#165): to pattern

dc45923

h1alexbel requested a review from volodya-lombrozo April 2, 2025 10:52

volodya-lombrozo suggested changes Apr 3, 2025

View reviewed changes

h1alexbel added 5 commits April 3, 2025 11:28

Merge branch 'master' into 165

e60fe2a

feat(objectionary#165): kv

86ee6e1

feat(objectionary#165): line

29a752f

feat(objectionary#165): builders

b661492

feat(objectionary#165): clean for qulice

b9fce7b

h1alexbel requested a review from volodya-lombrozo April 3, 2025 10:14

volodya-lombrozo suggested changes Apr 4, 2025

View reviewed changes

feat(objectionary#165): JAR explanation

4209c2e

h1alexbel requested a review from volodya-lombrozo April 4, 2025 10:03

volodya-lombrozo approved these changes Apr 4, 2025

View reviewed changes

yegor256 reviewed Apr 4, 2025

View reviewed changes

feat(objectionary#165): wget

454eb68

h1alexbel requested a review from yegor256 April 4, 2025 13:50

yegor256 approved these changes Apr 4, 2025

View reviewed changes

rultor merged commit f56b643 into objectionary:master Apr 4, 2025
17 checks passed

h1alexbel deleted the 165 branch April 4, 2025 14:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(#165): `reserved-name` lint #440

feat(#165): `reserved-name` lint #440

h1alexbel commented Mar 28, 2025

h1alexbel commented Apr 2, 2025

volodya-lombrozo Apr 3, 2025

volodya-lombrozo Apr 3, 2025

h1alexbel Apr 3, 2025 •

edited

Loading

volodya-lombrozo Apr 3, 2025

h1alexbel Apr 3, 2025 •

edited

Loading

h1alexbel commented Apr 3, 2025

volodya-lombrozo left a comment

volodya-lombrozo Apr 4, 2025

h1alexbel Apr 4, 2025 •

edited

Loading

volodya-lombrozo Apr 4, 2025

h1alexbel Apr 4, 2025

volodya-lombrozo Apr 4, 2025

h1alexbel commented Apr 4, 2025

volodya-lombrozo left a comment

h1alexbel commented Apr 4, 2025

yegor256 Apr 4, 2025

yegor256 Apr 4, 2025

yegor256 Apr 4, 2025

h1alexbel Apr 4, 2025

yegor256 Apr 4, 2025

yegor256 commented Apr 4, 2025

h1alexbel commented Apr 4, 2025

yegor256 commented Apr 4, 2025

rultor commented Apr 4, 2025

rultor commented Apr 4, 2025

feat(#165): reserved-name lint #440

feat(#165): reserved-name lint #440

Conversation

h1alexbel commented Mar 28, 2025

h1alexbel commented Apr 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h1alexbel Apr 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h1alexbel Apr 3, 2025 • edited Loading

Choose a reason for hiding this comment

h1alexbel commented Apr 3, 2025

volodya-lombrozo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h1alexbel Apr 4, 2025 • 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

h1alexbel commented Apr 4, 2025

volodya-lombrozo left a comment

Choose a reason for hiding this comment

h1alexbel commented Apr 4, 2025

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

yegor256 commented Apr 4, 2025

h1alexbel commented Apr 4, 2025

yegor256 commented Apr 4, 2025

rultor commented Apr 4, 2025

rultor commented Apr 4, 2025

feat(#165): `reserved-name` lint #440

feat(#165): `reserved-name` lint #440

h1alexbel Apr 3, 2025 •

edited

Loading

h1alexbel Apr 3, 2025 •

edited

Loading

h1alexbel Apr 4, 2025 •

edited

Loading