merge

yegor256 · yegor256 · commit 6f9ca7016a27 · 2025-03-02T08:53:03.000+03:00
diff --git a/.github/workflows/jmh-benchmark-action.yml b/.github/workflows/jmh-benchmark-action.yml
@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: Performance Regression Check
+on:
+  pull_request:
+    branches:
+      - master
+jobs:
+  benchmark:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Run JMH Benchmark Action
+        uses: volodya-lombrozo/jmh-benchmark-action@main
+        with:
+          java-version: "11"
+          base-ref: "master"
+          benchmark-command: |
+            mvn jmh:benchmark -Djmh.rf=json -Djmh.rff=benchmark.json
+          benchmark-file: "benchmark.json"
diff --git a/.github/workflows/post-comment.yml b/.github/workflows/post-comment.yml
@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: Post Benchmark Comment
+on:
+  workflow_run:
+    workflows: [ "Performance Regression Check" ]
+    types:
+      - completed
+
+jobs:
+  post-comment:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+      - name: Download PR Number and Benchmark Comment
+        uses: actions/download-artifact@v4
+        with:
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Read and display PR Number
+        run: |
+          PR_NUMBER=$(cat pr-number/pr-number)
+          echo "PR_NUMBER=$PR_NUMBER" >> "$GITHUB_ENV"
+          echo "The PR number is $PR_NUMBER"
+      - name: Post Comment on PR
+        uses: mshick/add-pr-comment@v2
+        with:
+          issue: ${{ env.PR_NUMBER }}
+          message-path: |
+            benchmark-comment/benchmark-comment.md
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -5,5 +5,7 @@
 .idea
 .idea/
 node_modules/
-target
 target/
+!src/it/eo-to-bytecode/target
+!src/it/fails-if-bytecode-broken/target
+.aider*
diff --git a/README.md b/README.md
@@ -65,7 +65,7 @@ configuration to your `pom.xml` file:
     <plugin>
       <groupId>org.eolang</groupId>
       <artifactId>jeo-maven-plugin</artifactId>
-      <version>0.7.5</version>
+      <version>0.8.0</version>
       <executions>
         <execution>
           <id>bytecode-to-eo</id>
diff --git a/pom.xml b/pom.xml
@@ -176,7 +176,7 @@
     <dependency>
       <groupId>org.eolang</groupId>
       <artifactId>eo-parser</artifactId>
-      <version>0.51.6</version>
+      <version>0.52.0</version>
     </dependency>
     <dependency>
       <groupId>com.github.volodya-lombrozo</groupId>
@@ -225,6 +225,18 @@
       <version>0.2.0</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.openjdk.jmh</groupId>
+      <artifactId>jmh-core</artifactId>
+      <version>1.37</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.openjdk.jmh</groupId>
+      <artifactId>jmh-generator-annprocess</artifactId>
+      <version>1.37</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <build>
     <testResources>
@@ -242,6 +254,11 @@
       </testResource>
     </testResources>
     <plugins>
+      <plugin>
+        <groupId>pw.krejci</groupId>
+        <artifactId>jmh-maven-plugin</artifactId>
+        <version>0.2.2</version>
+      </plugin>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <executions>
diff --git a/src/it/annotations/pom.xml b/src/it/annotations/pom.xml
@@ -48,7 +48,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-eo</id>
diff --git a/src/it/bytecode-to-eo/pom.xml b/src/it/bytecode-to-eo/pom.xml
@@ -54,7 +54,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-phi</id>
@@ -82,7 +82,7 @@
           <plugin>
             <groupId>org.eolang</groupId>
             <artifactId>eo-maven-plugin</artifactId>
-            <version>0.51.6</version>
+            <version>0.52.0</version>
             <executions>
               <execution>
                 <id>convert-xmir-to-eo</id>
diff --git a/src/it/custom-transformations/pom.xml b/src/it/custom-transformations/pom.xml
@@ -48,7 +48,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <!--
             @todo #610:30min Enable EO Printing in 'custom-transformations' it.
diff --git a/src/it/exceptions/pom.xml b/src/it/exceptions/pom.xml
@@ -66,7 +66,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-eo</id>
diff --git a/src/it/generics/pom.xml b/src/it/generics/pom.xml
@@ -48,7 +48,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-eo</id>
diff --git a/src/it/jna/pom.xml b/src/it/jna/pom.xml
@@ -204,7 +204,7 @@
           <plugin>
             <groupId>org.eolang</groupId>
             <artifactId>eo-maven-plugin</artifactId>
-            <version>0.51.6</version>
+            <version>0.52.0</version>
             <executions>
               <execution>
                 <id>xmir-to-phi</id>
diff --git a/src/it/phi-unphi/pom.xml b/src/it/phi-unphi/pom.xml
@@ -69,7 +69,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>xmir-to-phi</id>
diff --git a/src/it/spring/pom.xml b/src/it/spring/pom.xml
@@ -68,7 +68,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-phi</id>
diff --git a/src/it/takes/pom.xml b/src/it/takes/pom.xml
@@ -64,7 +64,7 @@
       <plugin>
         <groupId>org.eolang</groupId>
         <artifactId>eo-maven-plugin</artifactId>
-        <version>0.51.6</version>
+        <version>0.52.0</version>
         <executions>
           <execution>
             <id>convert-xmir-to-phi</id>
diff --git a/src/main/java/org/eolang/jeo/Assembler.java b/src/main/java/org/eolang/jeo/Assembler.java
@@ -15,7 +15,7 @@
  * This class is used to assemble the project's EO source files to bytecode.
  * @since 0.2
  */
-final class Assembler {
+public final class Assembler {
 
     /**
      * Input folder with "xmir" files.
@@ -32,7 +32,7 @@ final class Assembler {
      * @param input Input folder with "xmir" files.
      * @param output Output folder for the assembled classes.
      */
-    Assembler(final Path input, final Path output) {
+    public Assembler(final Path input, final Path output) {
         this.input = input;
         this.output = output;
     }
@@ -41,7 +41,7 @@ final class Assembler {
      * Assemble all "xmir" files.
      * @since 0.2
      */
-    void assemble() {
+    public void assemble() {
         final String assembling = "Assembling";
         final String assembled = "assembled";
         final Stream<Path> all = new Summary(
diff --git a/src/main/java/org/eolang/jeo/representation/xmir/JcabiXmlNode.java b/src/main/java/org/eolang/jeo/representation/xmir/JcabiXmlNode.java
@@ -7,12 +7,9 @@
 import com.jcabi.xml.XML;
 import com.jcabi.xml.XMLDocument;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Optional;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
@@ -138,23 +135,9 @@ public boolean hasAttribute(final String name, final String value) {
 
     @Override
     public void validate() {
-        //@checkstyle MethodBodyCommentsCheck (10 lines)
-        // @todo #965:30min Remove 'object-does-not-match-filename' from the ignore list.
-        //  This is a temporary solution to ignore the 'object-does-not-match-filename' defect.
-        //  Most probably, this check will be removed at all:
-        //  https://github.com/objectionary/lints/issues/352
-        //  If so, we should remove the ignore list after the issue is resolved.
-        //  Otherwise we need to fix filenames.
-        final Collection<String> ignore = new HashSet<>(
-            Arrays.asList(
-                "object-does-not-match-filename"
-            )
+        final Collection<Defect> defects = new ArrayList<>(
+            new Program(new StrictXmir(this.doc)).defects()
         );
-        final Collection<Defect> defects = new Program(new StrictXmir(this.doc))
-            .defects()
-            .stream()
-            .filter(defect -> !ignore.contains(defect.rule()))
-            .collect(Collectors.toList());
         if (!defects.isEmpty()) {
             throw new IllegalStateException(
                 String.format(
diff --git a/src/test/java/benchmark/AssembleBenchmark.java b/src/test/java/benchmark/AssembleBenchmark.java
@@ -0,0 +1,87 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2016-2025 Objectionary.com
+ * SPDX-License-Identifier: MIT
+ */
+package benchmark;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Comparator;
+import java.util.stream.Stream;
+import org.eolang.jeo.Assembler;
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.Fork;
+import org.openjdk.jmh.annotations.Level;
+import org.openjdk.jmh.annotations.Measurement;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.Setup;
+import org.openjdk.jmh.annotations.State;
+import org.openjdk.jmh.annotations.TearDown;
+import org.openjdk.jmh.annotations.Warmup;
+import org.openjdk.jmh.runner.Runner;
+import org.openjdk.jmh.runner.RunnerException;
+import org.openjdk.jmh.runner.options.OptionsBuilder;
+
+/**
+ * Assemble benchmark.
+ * @since 0.8
+ * @checkstyle DesignForExtensionCheck (500 lines)
+ */
+@Fork(1)
+@Warmup(iterations = 1, time = 2)
+@Measurement(iterations = 1, time = 3)
+@State(Scope.Benchmark)
+@SuppressWarnings("PMD.JUnit4TestShouldUseAfterAnnotation")
+public class AssembleBenchmark {
+
+    /**
+     * Temporary directory.
+     */
+    private Path dir;
+
+    /**
+     * Assembler.
+     */
+    private Assembler assembler;
+
+    /**
+     * This method is used to run the benchmark from IDE.
+     * Don't remove it.
+     * @param args Arguments.
+     * @throws RunnerException If something goes wrong.
+     */
+    @SuppressWarnings("PMD.ProhibitPublicStaticMethods")
+    public static void main(final String[] args) throws RunnerException {
+        new Runner(
+            new OptionsBuilder()
+                .include(AssembleBenchmark.class.getSimpleName())
+                .build()
+        ).run();
+    }
+
+    @Setup(Level.Trial)
+    public void init() throws IOException {
+        this.dir = Files.createTempDirectory("assemble");
+        final Path input = this.dir.resolve("input");
+        this.dir.toFile().deleteOnExit();
+        Files.createDirectories(input);
+        Files.write(input.resolve("test.xmir"), new Representation().disassemble());
+        this.assembler = new Assembler(input, this.dir);
+    }
+
+    @Benchmark
+    public void assemble() {
+        this.assembler.assemble();
+    }
+
+    @TearDown(Level.Trial)
+    public void tearDown() {
+        try (Stream<Path> files = Files.walk(this.dir).sorted(Comparator.reverseOrder())) {
+            files.map(Path::toFile).forEach(File::delete);
+        } catch (final IOException ioex) {
+            throw new IllegalStateException("Failed to delete assemble temporary directory", ioex);
+        }
+    }
+}
diff --git a/src/test/java/benchmark/DisassembleBenchmark.java b/src/test/java/benchmark/DisassembleBenchmark.java
diff --git a/src/test/java/benchmark/Representation.java b/src/test/java/benchmark/Representation.java
diff --git a/src/test/java/benchmark/package-info.java b/src/test/java/benchmark/package-info.java
