#1602 Discover with versions

eo-maven-plugin/src/main/java/org/eolang/maven/AssembleMojo.java

@@ -194,7 +194,7 @@ public void exec() throws IOException {
         if (this.central == null) {
             this.central = new Central(this.project, this.session, this.manager);
         }
-        String before = this.tojos.status();
+        String before = this.scopedTojos().status();
         int cycle = 0;
         final Moja<?>[] mojas = {
             new Moja<>(ParseMojo.class),
@@ -211,7 +211,7 @@ public void exec() throws IOException {
             for (final Moja<?> moja : mojas) {
                 moja.copy(this).execute();
             }
-            final String after = this.tojos.status();
+            final String after = this.scopedTojos().status();
             ++cycle;
             if (Logger.isInfoEnabled(this)) {
                 Logger.info(

eo-maven-plugin/src/main/java/org/eolang/maven/DiscoverMojo.java

@@ -31,6 +31,7 @@
 import java.nio.file.Path;
 import java.util.Collection;
 import java.util.HashSet;
+import java.util.List;
 import java.util.TreeSet;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
@@ -94,26 +95,33 @@ public void exec() throws IOException {
     private Collection<String> discover(final Path file)
         throws FileNotFoundException {
         final XML xml = new XMLDocument(file);
+        final List<String> base = new ListOf<>(
+            "//o[",
+            "not(starts-with(@base,'.'))",
+            "and @base != 'Q'",
+            "and @base != '^'",
+            "and @base != '$'",
+            "and @base != '&'",
+            "and not(@ref)"
+        );
+        final List<String> regular = new ListOf<>(base);
+        if (this.withVersions) {
+            regular.add("and not(@ver)");
+        }
+        regular.add("]/@base");
         final Collection<String> names = new TreeSet<>(
-            new ListOf<>(
-                new Filtered<>(
-                    obj -> !obj.isEmpty(),
-                    xml.xpath(
-                        String.join(
-                            " ",
-                            "//o[",
-                            "not(starts-with(@base,'.'))",
-                            " and @base != 'Q'",
-                            " and @base != '^'",
-                            " and @base != '$'",
-                            " and @base != '&'",
-                            " and not(@ref)",
-                            "]/@base"
-                        )
-                    )
-                )
-            )
+            DiscoverMojo.names(xml, regular)
         );
+        if (this.withVersions) {
+            final List<String> versioned = new ListOf<>(base);
+            versioned.addAll(
+                new ListOf<>(
+                    "and @ver",
+                    "]/concat(@base,'|',@ver)"
+                )
+            );
+            names.addAll(DiscoverMojo.names(xml, versioned));
+        }
         if (!xml.nodes("//o[@vararg]").isEmpty()) {
             names.add("org.eolang.tuple");
         }
@@ -131,4 +139,23 @@ private Collection<String> discover(final Path file)
         return names;
     }
 
+    /**
+     * Get list of object names from given XML by provided xpath.
+     * @param xml XML.
+     * @param xpath Xpath.
+     * @return List of object names.
+     */
+    private static List<String> names(final XML xml, final List<String> xpath) {
+        return new ListOf<>(
+            new Filtered<>(
+                obj -> !obj.isEmpty(),
+                xml.xpath(
+                    String.join(
+                        " ",
+                        xpath
+                    )
+                )
+            )
+        );
+    }
 }

eo-maven-plugin/src/main/java/org/eolang/maven/RegisterMojo.java

@@ -144,13 +144,6 @@ public void exec() throws IOException {
                 .withVersion(ParseMojo.ZERO)
                 .withVer(ParseMojo.ZERO);
             Logger.debug(this, "EO source %s registered", name);
-            if (this.external != null) {
-                this.externalTojos
-                    .add(name)
-                    .withSource(file.toAbsolutePath())
-                    .withVersion(ParseMojo.ZERO);
-                Logger.debug(this, "EO source %s registered (external)", name);
-            }
         }
         Logger.info(
             this, "Registered %d EO sources from %s to %s, included %s, excluded %s",

eo-maven-plugin/src/main/java/org/eolang/maven/SafeMojo.java

@@ -197,11 +197,26 @@ abstract class SafeMojo extends AbstractMojo {
     @Parameter(property = "eo.cache")
     protected Path cache = Paths.get(System.getProperty("user.home")).resolve(".eo");
 
+    /**
+     * Used for object versioning implementation.
+     * If set to TRUE, external tojos are used instead of foreign ones and all
+     * inherited Mojos behave a bit differently.
+     * @todo #1602:30min Remove the flag when objection versioned is
+     *  implemented. The variable is used for implementation of object
+     *  versioning. It allows to use external tojos instead of foreign in Mojos.
+     *  for the test purposes. When object versioning is implemented there
+     *  will be no need for that variable
+     * @checkstyle VisibilityModifierCheck (10 lines)
+     * @checkstyle MemberNameCheck (10 lines)
+     */
+    @Parameter(property = "eo.withVersions", defaultValue = "false")
+    protected boolean withVersions;
+
     /**
      * Cached tojos.
      * @checkstyle VisibilityModifierCheck (5 lines)
      */
-    protected final ForeignTojos tojos = new ForeignTojos(
+    private final ForeignTojos tojos = new ForeignTojos(
         () -> Catalogs.INSTANCE.make(this.foreign.toPath(), this.foreignFormat),
         () -> this.scope
     );
@@ -318,7 +333,13 @@ public final void execute() throws MojoFailureException, MojoExecutionException
      * @checkstyle AnonInnerLengthCheck (100 lines)
      */
     protected final ForeignTojos scopedTojos() {
-        return this.tojos;
+        final ForeignTojos tjs;
+        if (this.external != null && this.withVersions) {
+            tjs = this.externalTojos;
+        } else {
+            tjs = this.tojos;
+        }
+        return tjs;
     }
 
     /**

eo-maven-plugin/src/test/java/org/eolang/maven/DiscoverMojoTest.java

@@ -89,4 +89,72 @@ void discoversForDifferentScopes(@TempDir final Path tmp) throws IOException {
             Matchers.is(true)
         );
     }
+
+    @Test
+    void discoversWithVersions(@TempDir final Path tmp) throws IOException {
+        final FakeMaven maven = new FakeMaven(tmp)
+            .with("withVersions", true)
+            .withProgram(
+                "+alias org.eolang.txt.sprintf\n",
+                "[] > main",
+                "  seq > @",
+                "    QQ.io.stdout|0.29.1",
+                "      sprintf|0.28.5",
+                "        \"Hello world\"",
+                "          TRUE"
+            )
+            .execute(new FakeMaven.Discover());
+        final String sprintf = "org.eolang.txt.sprintf|0.28.5";
+        final String stdout = "org.eolang.io.stdout|0.29.1";
+        MatcherAssert.assertThat(
+            String.format(
+                "External tojos have to contain %s object after discovering, but they don't",
+                sprintf
+            ),
+            maven.externalTojos().contains(sprintf),
+            Matchers.is(true)
+        );
+        MatcherAssert.assertThat(
+            String.format(
+                "External tojos should not contain %s object after discovering, but they did",
+                stdout
+            ),
+            maven.externalTojos().contains(stdout),
+            Matchers.is(false)
+        );
+    }
+
+    @Test
+    void doesNotDiscoverWithVersions(@TempDir final Path tmp) throws IOException {
+        final FakeMaven maven = new FakeMaven(tmp)
+            .with("withVersions", false)
+            .withProgram(
+                "+alias org.eolang.txt.sprintf\n",
+                "[] > main",
+                "  seq > @",
+                "    QQ.io.stdout|0.29.1",
+                "      sprintf|0.28.5",
+                "        \"Hello world\"",
+                "          TRUE"
+            )
+            .execute(new FakeMaven.Discover());
+        final String sprintf = "org.eolang.txt.sprintf|0.28.5";
+        final String stdout = "org.eolang.io.stdout|0.29.1";
+        MatcherAssert.assertThat(
+            String.format(
+                "External tojos should not have contained %s object after discovering, but they did",
+                sprintf
+            ),
+            maven.externalTojos().contains(sprintf),
+            Matchers.is(false)
+        );
+        MatcherAssert.assertThat(
+            String.format(
+                "External tojos should not have contained %s object after discovering, but they did",
+                stdout
+            ),
+            maven.externalTojos().contains(stdout),
+            Matchers.is(false)
+        );
+    }
 }

eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java

@@ -201,7 +201,7 @@ public <T extends AbstractMojo> FakeMaven execute(final Class<T> mojo) throws IO
             this.params.putIfAbsent("transpiledFormat", "csv");
             this.params.putIfAbsent("skipZeroVersions", true);
             this.params.putIfAbsent("discoverSelf", false);
-            this.params.putIfAbsent("versioned", false);
+            this.params.putIfAbsent("withVersions", false);
             this.params.putIfAbsent("ignoreVersionConflict", false);
             this.params.putIfAbsent("ignoreTransitive", true);
             this.params.putIfAbsent("central", new DummyCentral());
@@ -339,12 +339,13 @@ FakeMaven withProgram(final Path path) throws IOException {
     }
 
     /**
-     * Specify hash for all foreign tojos.
+     * Specify hash for all foreign and external tojos.
      * @param hash Commit hash
      * @return The same maven instance.
      */
     FakeMaven allTojosWithHash(final CommitHash hash) {
         this.foreignTojos().all().forEach(tojo -> tojo.withHash(hash));
+        this.externalTojos().all().forEach(tojo -> tojo.withHash(hash));
         return this;
     }
 

eo-maven-plugin/src/test/java/org/eolang/maven/RegisterMojoTest.java

@@ -26,6 +26,7 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.NoSuchElementException;
 import org.cactoos.io.ResourceOf;
 import org.eolang.maven.util.Home;
 import org.hamcrest.MatcherAssert;
@@ -40,6 +41,15 @@
  * @since 0.11
  */
 final class RegisterMojoTest {
+    /**
+     * Parameter for source directory.
+     */
+    private static final String PARAM = "sourcesDir";
+
+    /**
+     * Source directory.
+     */
+    private static final String SOURCES = "src/eo";
 
     @Test
     void registersOkNames(@TempDir final Path temp) throws IOException {
@@ -48,7 +58,7 @@ void registersOkNames(@TempDir final Path temp) throws IOException {
             Paths.get("src/eo/org/eolang/maven/abc-def.eo")
         );
         final FakeMaven maven = new FakeMaven(temp)
-            .with("sourcesDir", temp.resolve("src/eo").toFile())
+            .with(RegisterMojoTest.PARAM, temp.resolve(RegisterMojoTest.SOURCES).toFile())
             .execute(new FakeMaven.Register());
         MatcherAssert.assertThat(
             maven.foreign().getById("org.eolang.maven.abc-def").exists("id"),
@@ -66,7 +76,7 @@ void failsWithDotNames(@TempDir final Path temp) throws IOException {
             IllegalStateException.class,
             () -> {
                 new FakeMaven(temp)
-                    .with("sourcesDir", temp.resolve("src/eo").toFile())
+                    .with(RegisterMojoTest.PARAM, temp.resolve(RegisterMojoTest.SOURCES).toFile())
                     .execute(new FakeMaven.Register());
             }
         );
@@ -83,7 +93,7 @@ void doesNotFailWhenNoStrictNames(@TempDir final Path temp) throws IOException {
             Paths.get("src/eo/org/eolang/maven/.abc.eo")
         );
         final FakeMaven maven = new FakeMaven(temp)
-            .with("sourcesDir", temp.resolve("src/eo").toFile())
+            .with(RegisterMojoTest.PARAM, temp.resolve(RegisterMojoTest.SOURCES).toFile())
             .with("strictFileNames", false)
             .execute(new FakeMaven.Register());
         MatcherAssert.assertThat(
@@ -99,25 +109,44 @@ void registersInExternal(@TempDir final Path temp) throws IOException {
             Paths.get("src/eo/org/eolang/maven/foo.eo")
         );
         final String name = "org.eolang.maven.foo";
-        final String source = "src/eo";
         final FakeMaven maven = new FakeMaven(temp)
-            .with("sourcesDir", temp.resolve(source).toFile())
+            .with(RegisterMojoTest.PARAM, temp.resolve(RegisterMojoTest.SOURCES).toFile())
+            .with("withVersions", true)
             .execute(new FakeMaven.Register());
         MatcherAssert.assertThat(
             String.format(
                 "Source object %s placed in %s should have been registered in external tojos but it didn't",
                 name,
-                source
+                RegisterMojoTest.SOURCES
             ),
             maven.external()
                 .getById(name)
                 .exists("id"),
             Matchers.is(true)
         );
         MatcherAssert.assertThat(
-            "External and foreign tojos should have the same status after registering because of identical behaviour at the step but they didn't",
+            "External and foreign tojos should not have the same status after registering because external should replace foreign but they didn't",
             maven.foreignTojos().status(),
-            Matchers.equalTo(maven.externalTojos().status())
+            Matchers.not(
+                Matchers.equalTo(
+                    maven.externalTojos().status()
+                )
+            )
+        );
+    }
+
+    @Test
+    void doesNotRegisterInExternal(@TempDir final Path temp) throws IOException {
+        new Home(temp).save(
+            new ResourceOf("org/eolang/maven/file-name/abc-def.eo"),
+            Paths.get("src/eo/org/eolang/maven/foo.eo")
+        );
+        final FakeMaven maven = new FakeMaven(temp)
+            .with(RegisterMojoTest.PARAM, temp.resolve(RegisterMojoTest.SOURCES).toFile())
+            .with("withVersions", false);
+        Assertions.assertThrows(
+            NoSuchElementException.class,
+            () -> maven.external().getById("org.eolang.maven.foo")
         );
     }