Merge pull request #3761 from maxonfjvipon/bug/#3757/braces-in-phi

bug(#3757): Conservative to-phi conversion
objectionary · Dec 25, 2024 · b967900 · b967900
2 parents a753bc2 + a6cc1e8
commit b967900
Show file tree

Hide file tree

Showing 37 changed files with 200 additions and 82 deletions.
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/PhiMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/PhiMojo.java
@@ -76,6 +76,12 @@ public final class PhiMojo extends SafeMojo {
     )
     private File phiOutputDir;
 
+    /**
+     * Print all the braces in sweet notation.
+     */
+    @SuppressWarnings("PMD.ImmutableField")
+    private boolean conservative = true;
+
     /**
      * Convert to PHI without syntax sugar.
      * @checkstyle MemberNameCheck (10 lines)
@@ -165,9 +171,9 @@ private String translated(final XML xml) throws ImpossibleToPhiTranslationExcept
         final String phi;
         try {
             if (this.phiNoSugar) {
-                phi = xmir.toPhiNoSugar();
+                phi = xmir.toSaltyPhi();
             } else {
-                phi = xmir.toPhi();
+                phi = xmir.toPhi(this.conservative);
             }
         } catch (final IndexOutOfBoundsException exception) {
             throw new ImpossibleToPhiTranslationException(

diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java b/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java
@@ -240,6 +240,7 @@ public <T extends AbstractMojo> FakeMaven execute(final Class<T> mojo) throws IO
             this.params.putIfAbsent("offline", false);
             this.params.putIfAbsent("phiNoSugar", false);
             this.params.putIfAbsent("phiSkipFailed", false);
+            this.params.putIfAbsent("conservative", false);
             this.params.putIfAbsent(
                 "phiInputDir",
                 this.workspace.absolute(

diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/PhiMojoTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/PhiMojoTest.java
@@ -195,12 +195,13 @@ void checksPhiPacksWithSugar(final String pack, @Mktmp final Path temp) throws E
             new TextOf(
                 new FakeMaven(temp)
                     .withProgram(xtory.map().get("input").toString())
+                    .with("conservative", xtory.map().get("conservative") != null)
                     .with("phiNoSugar", false)
                     .execute(new FakeMaven.Phi())
                     .result()
                     .get("target/phi/foo/x/main.phi")
             ).asString(),
-            Matchers.equalTo(xtory.map().get("with-sugar").toString())
+            Matchers.equalTo(xtory.map().get("sweet").toString())
         );
     }
 
@@ -219,7 +220,7 @@ void checksPhiPacksNoSugar(final String pack, @Mktmp final Path temp) throws Exc
                     .result()
                     .get("target/phi/foo/x/main.phi")
             ).asString(),
-            Matchers.equalTo(xtory.map().get("no-sugar").toString())
+            Matchers.equalTo(xtory.map().get("salty").toString())
         );
     }
 }
diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/UnphiMojoTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/UnphiMojoTest.java
@@ -235,7 +235,7 @@ void checksUnphiPacks(final String pack, @Mktmp final Path temp) throws Exceptio
     void convertsToXmirAndBack(final String pack, @Mktmp final Path temp) throws Exception {
         final Xtory xtory = new XtSticky(new XtYaml(pack));
         Assumptions.assumeTrue(xtory.map().get("skip") == null);
-        final String phi = xtory.map().get("with-sugar").toString();
+        final String phi = xtory.map().get("sweet").toString();
         final String main = "target/phi/main.phi";
         final Path path = Paths.get(main);
         new HmBase(temp).save(phi, path);
@@ -244,6 +244,7 @@ void convertsToXmirAndBack(final String pack, @Mktmp final Path temp) throws Exc
         final Path xmir = temp.resolve(String.format("target/%s/main.xmir", ParseMojo.DIR));
         maven.foreignTojos().add("name").withXmir(xmir);
         final Path result = maven
+            .with("conservative", xtory.map().get("conservative") != null)
             .execute(OptimizeMojo.class)
             .execute(PhiMojo.class)
             .result()

diff --git a/eo-parser/src/main/java/org/eolang/parser/Xmir.java b/eo-parser/src/main/java/org/eolang/parser/Xmir.java
@@ -59,6 +59,11 @@
  */
 @SuppressWarnings("PMD.TooManyMethods")
 public final class Xmir implements XML {
+    /**
+     * Unhex transformation.
+     */
+    private static final Shift UNHEX = new StUnhex();
+
     /**
      * Train of transformations that prepare XMIR for conversion to EO.
      */
@@ -175,7 +180,7 @@ public Collection<SAXParseException> validate(final XML xsd) {
 
     /**
      * Converts XMIR to EO.
-     * @return EO representation as {@code String}
+     * @return EO representation as {@link String}
      */
     public String toEO() {
         return this.converted(
@@ -185,7 +190,7 @@ public String toEO() {
 
     /**
      * Converts XMIR to EO, in reverse notation.
-     * @return EO representation as {@code String}
+     * @return EO representation as {@link String}
      */
     public String toReversedEO() {
         return this.converted(
@@ -195,14 +200,27 @@ public String toReversedEO() {
 
     /**
      * Converts XMIR to PHI.
-     * @return EO representation as {@code String}
+     * @return PHI representation as {@link String}
      */
     public String toPhi() {
+        return this.toPhi(false);
+    }
+
+    /**
+     * Converts XMIR to PHI.
+     * @param conservative Add empty braces to formations or not
+     * @return PHI representation as {@link  String}.
+     */
+    public String toPhi(final boolean conservative) {
         return this.converted(
             new TrJoined<>(
                 Xmir.FOR_PHI,
                 new TrDefault<>(
-                    new StUnhex(), new StClasspath("/org/eolang/parser/phi/to-phi.xsl")
+                    Xmir.UNHEX,
+                    new StClasspath(
+                        "/org/eolang/parser/phi/to-phi.xsl",
+                        String.format("conservative %b", conservative)
+                    )
                 )
             ),
             "program/phi/text()"
@@ -211,9 +229,9 @@ public String toPhi() {
 
     /**
      * Converts XMIR to PHI without any syntax sugar.
-     * @return EO representation as {@code String}
+     * @return PHI representation as {@link String}
      */
-    public String toPhiNoSugar() {
+    public String toSaltyPhi() {
         return this.converted(
             Xmir.FOR_PHI, "/org/eolang/parser/phi/to-phi-no-sugar.xsl", "program/phi/text()"
         );
@@ -224,7 +242,7 @@ public String toPhiNoSugar() {
      * @param train Train of transformations that prepares XMIR
      * @param xsl Final XSL transformation
      * @param xpath Xpath to retrieve the final result
-     * @return XMIR in other representation as {@code String}.
+     * @return XMIR in other representation as {@link String}.
      */
     private String converted(final Train<Shift> train, final String xsl, final String xpath) {
         return this.converted(new TrJoined<>(train.with(new StClasspath(xsl))), xpath);
@@ -234,7 +252,7 @@ private String converted(final Train<Shift> train, final String xsl, final Strin
      * Converts XMIR.
      * @param train Train of transformations that prepares XMIR
      * @param xpath Xpath to retrieve the final result
-     * @return XMIR in other representation as {@code String}.
+     * @return XMIR in other representation as {@link String}.
      */
     private String converted(final Train<Shift> train, final String xpath) {
         return new Xsline(train).pass(this.xml).xpath(xpath).get(0);

diff --git a/eo-parser/src/main/resources/org/eolang/parser/phi/to-phi.xsl b/eo-parser/src/main/resources/org/eolang/parser/phi/to-phi.xsl
@@ -22,9 +22,10 @@ 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.
 -->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:eo="https://www.eolang.org" id="to-phi" version="2.0">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:eo="https://www.eolang.org" id="to-phi" version="2.0">
   <xsl:import href="/org/eolang/parser/_funcs.xsl"/>
   <xsl:output encoding="UTF-8" method="text"/>
+  <xsl:param name="conservative" as="xs:boolean"/>
   <!-- Variables -->
   <xsl:variable name="aliases" select="program/metas/meta/part[last()]"/>
   <xsl:variable name="number-pattern" select="'^[0-9]+$'"/>
@@ -288,6 +289,10 @@ SOFTWARE.
           <xsl:when test="$has-package">
             <xsl:for-each select="$parts">
               <xsl:value-of select="."/>
+              <xsl:if test="$conservative">
+                <xsl:value-of select="$clb"/>
+                <xsl:value-of select="$crb"/>
+              </xsl:if>
               <xsl:value-of select="$arrow"/>
               <xsl:value-of select="$lb"/>
               <xsl:value-of select="eo:eol($tabs+position())"/>
@@ -511,7 +516,7 @@ SOFTWARE.
     <xsl:variable name="name" select="eo:specials(@name, true())"/>
     <xsl:if test="@name">
       <xsl:value-of select="$name"/>
-      <xsl:if test="count(o[eo:void(.)])&gt;0">
+      <xsl:if test="$conservative or count(o[eo:void(.)])&gt;0">
         <xsl:apply-templates select="." mode="inline-voids"/>
       </xsl:if>
       <xsl:value-of select="$arrow"/>
@@ -568,7 +573,7 @@ SOFTWARE.
           <xsl:value-of select="$position - 1"/>
         </xsl:otherwise>
       </xsl:choose>
-      <xsl:if test="eo:abstract(.) and o[eo:void(.)]">
+      <xsl:if test="eo:abstract(.) and ($conservative or o[eo:void(.)])">
         <xsl:apply-templates select="." mode="inline-voids"/>
       </xsl:if>
       <xsl:value-of select="$arrow"/>

diff --git a/eo-parser/src/test/java/org/eolang/parser/XmirTest.java b/eo-parser/src/test/java/org/eolang/parser/XmirTest.java
@@ -66,23 +66,24 @@ void printsToEoReversed(final String pack) throws IOException {
 
     @ParameterizedTest
     @ClasspathSource(value = "org/eolang/parser/phi-packs", glob = "**.yaml")
-    void convertsToPhi(final String pack) throws IOException {
+    void convertsToSweetPhi(final String pack) throws IOException {
         final Xtory xtory = new XtSticky(new XtYaml(pack));
+        final boolean conservative = xtory.map().containsKey("conservative");
         MatcherAssert.assertThat(
             "Result PHI should be equal to provided PHI with syntax sugar",
-            this.asXmir((String) xtory.map().get("input")).toPhi(),
-            Matchers.equalTo(xtory.map().get("with-sugar"))
+            this.asXmir((String) xtory.map().get("input")).toPhi(conservative),
+            Matchers.equalTo(xtory.map().get("sweet"))
         );
     }
 
     @ParameterizedTest
     @ClasspathSource(value = "org/eolang/parser/phi-packs", glob = "**.yaml")
-    void convertsToPhiNoSugar(final String pack) throws IOException {
+    void convertsToSaltyPhi(final String pack) throws IOException {
         final Xtory xtory = new XtSticky(new XtYaml(pack));
         MatcherAssert.assertThat(
             "Result PHI should be equal to provided PHI with syntax sugar",
-            this.asXmir((String) xtory.map().get("input")).toPhiNoSugar(),
-            Matchers.equalTo(xtory.map().get("no-sugar"))
+            this.asXmir((String) xtory.map().get("input")).toSaltyPhi(),
+            Matchers.equalTo(xtory.map().get("salty"))
         );
     }
 

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/as-phi.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/as-phi.yaml
@@ -27,13 +27,13 @@ input: |
       length.
         as-phi $
       $.greater-than 0
-with-sugar: |-
+sweet: |-
   {⟦
     prints-itself ↦ ⟦
       φ ↦ Φ̇.assert-that(Φ̇.as-phi(ξ).length, ξ.greater-than(0))
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       prints-itself ↦ ⟦

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/atoms.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/atoms.yaml
@@ -24,27 +24,28 @@ input: |
   # No comments.
   [] > main /int
   # No comments.
-  [] > outer
+  [x] > outer
     # No comments.
     [] > inner /bytes
-with-sugar: |-
+sweet: |-
   {⟦
     main ↦ ⟦
       λ ⤍ Lmain
     ⟧,
-    outer ↦ ⟦
+    outer(x) ↦ ⟦
       inner ↦ ⟦
         λ ⤍ Louter_inner
       ⟧
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       main ↦ ⟦
         λ ⤍ Lmain
       ⟧,
       outer ↦ ⟦
+        x ↦ ∅,
         inner ↦ ⟦
           λ ⤍ Louter_inner
         ⟧

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/auto-named.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/auto-named.yaml
@@ -26,7 +26,7 @@ input: |
     x > first
       [] >>
         01- > b
-with-sugar: |-
+sweet: |-
   {⟦
     object ↦ ⟦
       first ↦ Φ̇.x(ξ.auto-named-attr-at-4-6),
@@ -35,7 +35,7 @@ with-sugar: |-
       ⟧
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       object ↦ ⟦

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bindings.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bindings.yaml
@@ -27,7 +27,7 @@ input: |
       w > @
     5:five
     "hello":3
-with-sugar: |-
+sweet: |-
   {⟦
     xyz ↦ Φ̇.x(
       attr ↦ Φ̇.y,
@@ -38,7 +38,7 @@ with-sugar: |-
       α3 ↦ "hello"
     )
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       xyz ↦ Φ.org.eolang.x(

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bool-tests.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bool-tests.yaml
@@ -84,7 +84,7 @@ input: |
       01-.as-bytes.eq true
       00-.as-bytes.eq false
 
-with-sugar: |-
+sweet: |-
   {⟦
     org ↦ ⟦
       eolang ↦ ⟦
@@ -115,7 +115,7 @@ with-sugar: |-
       λ ⤍ Package
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       org ↦ ⟦

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bytes.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/bytes.yaml
@@ -82,7 +82,7 @@ input: |
     # the current and the provided one,
     # as a new sequence.
     [b] > concat /bytes
-with-sugar: |-
+sweet: |-
   {⟦
     org ↦ ⟦
       eolang ↦ ⟦
@@ -138,7 +138,7 @@ with-sugar: |-
       λ ⤍ Package
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       org ↦ ⟦

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/custom-alias.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/custom-alias.yaml
@@ -27,7 +27,7 @@ input: |
   # No comments.
   [y] > main
     x y > z
-with-sugar: |-
+sweet: |-
   {⟦
     foo ↦ ⟦
       bar ↦ ⟦
@@ -39,7 +39,7 @@ with-sugar: |-
       λ ⤍ Package
     ⟧
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       foo ↦ ⟦

diff --git a/eo-parser/src/test/resources/org/eolang/parser/phi-packs/data-dispatch.yaml b/eo-parser/src/test/resources/org/eolang/parser/phi-packs/data-dispatch.yaml
@@ -23,12 +23,12 @@
 input: |
   5.plus 5 > ten
   "Hello".concat "world" > greetings
-with-sugar: |-
+sweet: |-
   {⟦
     ten ↦ 5.plus(5),
     greetings ↦ "Hello".concat("world")
   ⟧}
-no-sugar: |-
+salty: |-
   {
     ⟦
       ten ↦ Φ.org.eolang.number(