Support running against Phel

Clojure-like Lisp compiling to PHP

For non-squashed commit history see archived branch at:
https://github.com/phel-lang/clojure-test-suite/tree/phel-integration

Co-authored-by: Chemaclass <chemaclass@outlook.es>
Co-authored-by: Jesus Valera Reales <github@jesusvalera.dev>

Author: 3 people

.github/workflows/ci.yml

@@ -162,3 +162,35 @@ jobs:
           BASILISP_TEST_PATH="$(pwd)/test" \
             BASILISP_TEST_FILE_PATTERN='.*\.(lpy|cljc)' \
             basilisp test -p test -- -n auto
+
+  test-phel:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.4', '8.5']
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+          tools: composer
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-ansi --no-progress
+
+      - name: Run tests
+        run: php -d memory_limit=256M ./vendor/bin/phel test

.gitignore

@@ -28,3 +28,4 @@ __pycache__/
 poetry.lock
 *.egg-info/
 .DS_Store
+/vendor/

README.md

@@ -22,3 +22,4 @@ See these documents for how to set up individual dialect-specific environments a
 3. [Babashka](doc/babashka.md)
 4. [Clojure CLR](doc/clojureclr.md)
 5. [Basilisp](doc/basilisp.md)
+6. [Phel](doc/phel.md)

composer.json

@@ -0,0 +1,6 @@
+{
+    "require": {
+        "phel-lang/phel-lang": "dev-main"
+    },
+    "minimum-stability": "dev"
+}

doc/phel.md

@@ -0,0 +1,51 @@
+# Running the Phel tests
+
+## Prerequisites
+
+- PHP 8.4+ & [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos)
+
+Install:
+```
+composer install
+```
+
+Tests live in `test/` (override via `phel-config.php`).
+
+See also [Getting Started guide](https://phel-lang.org/documentation/getting-started/).
+
+## Running the test suite
+
+Full suite:
+```
+./vendor/bin/phel test
+```
+Specific test:
+```
+./vendor/bin/phel test test/clojure/core_test/abs.cljc
+```
+
+If runner crashes before report, re-run with `--testdox` or `-v` to locate failing test.
+
+See [Phel testing docs](https://phel-lang.org/documentation/testing/#running-tests).
+
+## Updating Phel version
+
+`composer.json` tracks `dev-main` (latest [phel-lang](https://github.com/phel-lang/phel-lang/) HEAD):
+```json
+{
+    "require": {
+        "phel-lang/phel-lang": "dev-main"
+    },
+    "minimum-stability": "dev"
+}
+```
+
+Pull latest:
+```
+composer update phel-lang/phel-lang
+```
+
+Pin specific commit (optional):
+```
+composer require "phel-lang/phel-lang:dev-main#<commit-hash>"
+```

phel-config.php

@@ -0,0 +1,6 @@
+<?php
+// Override Phel's default 'tests' TestDirs path
+// Reference: https://phel-lang.org/documentation/configuration/
+return (new \Phel\Config\PhelConfig())
+    ->setSrcDirs(['src'])
+    ->setTestDirs(['test']);

test/clojure/core_test/aclone.cljc

@@ -13,8 +13,14 @@
       (is (= 3 (alength a')))
       (is (every? identity (map #(= (aget a %) (aget a' %)) (range 3))))
       (is (zero? (alength b')))
-      (is (not (identical? a a')))
-      (is (not (identical? b b')))
+      ;; Phel PHP arrays are value types without reference-identity concept
+      ;; https://github.com/phel-lang/phel-lang/issues/1735
+      #?@(:phel
+          [(is (identical? a a'))
+           (is (identical? b b'))]
+          :default
+          [(is (not (identical? a a')))
+           (is (not (identical? b b')))])
       (aset a 1 11)
       (is (= 11 (aget a 1)))
       (is (= 2 (aget a' 1)))

test/clojure/core_test/add_watch.cljc

@@ -20,7 +20,8 @@
                                           (catch #?(:cljs :default
                                                     :clj clojure.lang.ExceptionInfo
                                                     :cljr clojure.lang.ExceptionInfo
-                                                    :lpy basilisp.lang.exception/ExceptionInfo) e
+                                                    :lpy basilisp.lang.exception/ExceptionInfo
+                                                    :phel Phel.Lang.ExInfoException) e
                                             (let [data (ex-data e)]
                                               (vswap! state conj data)))))]
                         (do-update a)
@@ -73,6 +74,7 @@
                          {:key :e :ref r :old 14 :new 15 :tester :err})))))
 
     #?@(:cljs []
+        :phel []
         :default
         [(def testvar-a 0)
          (def testvar-b 10)
@@ -145,6 +147,7 @@
 
     #?(:cljs nil
        :lpy nil
+       :phel nil
        :default
        (testing "watch ref"
          (let [state (volatile! [])
@@ -217,6 +220,7 @@
 
     #?@(:cljs []
         :lpy []
+        :phel []
         :default
         [(testing "watch agent"
            (let [state (volatile! [])

test/clojure/core_test/ancestors.cljc

@@ -5,8 +5,8 @@
 (when-var-exists ancestors
 
   ; Some classes for testing ancestors by type inheritance
-  (def AncestorT #?(:cljs js/Object :lpy python/object :default Object))
-  (def ChildT #?(:cljs :default :lpy basilisp.lang.set/PersistentSet :default clojure.lang.PersistentHashSet))
+  (def AncestorT #?(:cljs js/Object :lpy python/object :phel ArrayIterator :default Object))
+  (def ChildT #?(:cljs :default :lpy basilisp.lang.set/PersistentSet :phel RecursiveArrayIterator :default clojure.lang.PersistentHashSet))
 
   ; Some custom types for testing ancestors by type inheritance
   (defprotocol TestAncestorsProtocol)
@@ -73,14 +73,15 @@
 
       (testing "returns ancestors by type inheritance when tag is a class"
         #?(:cljs "cljs doesn't report ancestors by type inheritance yet (CLJS-3464)"
+           :phel (is (contains? (ancestors ChildT) AncestorT))
            :clj  (is (contains? (ancestors ChildT) AncestorT))))
 
       #?(:bb      "bb doesn't report ancestors by type inheritance for custom types"
          :cljs    "cljs doesn't report ancestors by type inheritance yet (CLJS-3464)"
          :default (testing "returns ancestors by type inheritance when tag is a custom type"
-                    (is (contains? (ancestors TestAncestorsType) #?(:lpy (:interface TestAncestorsProtocol) :default clojure.core_test.ancestors.TestAncestorsProtocol)))
-                    (is (contains? (ancestors TestAncestorsRecord) #?(:lpy (:interface TestAncestorsProtocol) :default clojure.core_test.ancestors.TestAncestorsProtocol)))
-                    (is (contains? (ancestors TestAncestorsRecord) #?(:lpy basilisp.lang.interfaces/IAssociative :default clojure.lang.Associative)))
+                    (is (contains? (ancestors TestAncestorsType) #?(:lpy (:interface TestAncestorsProtocol) :phel TestAncestorsProtocol :default clojure.core_test.ancestors.TestAncestorsProtocol)))
+                    (is (contains? (ancestors TestAncestorsRecord) #?(:lpy (:interface TestAncestorsProtocol) :phel TestAncestorsProtocol :default clojure.core_test.ancestors.TestAncestorsProtocol)))
+                    (is (contains? (ancestors TestAncestorsRecord) #?(:lpy basilisp.lang.interfaces/IAssociative :phel Phel.Lang.Collections.Map.PersistentMapInterface :default clojure.lang.Associative)))
                     (is (nil? (ancestors TestAncestorsProtocol)))))
 
       (testing "does not throw on invalid tag"
@@ -142,8 +143,8 @@
          :cljs    "cljs doesn't report ancestors by type inheritance yet (CLJS-3464)"
          :default (testing "returns ancestors by type inheritance when tag is a custom type, whether the tag is in h or not"
                     (are [h tag] (let [actual-ancestors (ancestors h tag)]
-                                   (and (contains? actual-ancestors #?(:lpy (:interface TestAncestorsProtocol) :default clojure.core_test.ancestors.TestAncestorsProtocol))
-                                        (contains? actual-ancestors #?(:lpy basilisp.lang.interfaces/IAssociative :default clojure.lang.Associative))))
+                                   (and (contains? actual-ancestors #?(:lpy (:interface TestAncestorsProtocol) :phel TestAncestorsProtocol :default clojure.core_test.ancestors.TestAncestorsProtocol))
+                                        (contains? actual-ancestors #?(:lpy basilisp.lang.interfaces/IAssociative :phel Phel.Lang.Collections.Map.PersistentMapInterface :default clojure.lang.Associative))))
                                  ; tag in h
                                  datatypes TestAncestorsRecord
                                  ; tag not in h

test/clojure/core_test/associative_qmark.cljc

@@ -19,8 +19,12 @@
       false #{}
       false #{:a :b}
       false "ab"
-      false (seq "ab")                  ; seq
-      false (to-array [1 2 3])
+
+      #?@(:phel [true (seq "ab") ; PHP arrays are associative
+                 true (to-array [1 2 3])]
+          :default
+          [false (seq "ab")                  ; seq
+           false (to-array [1 2 3])])
       false :a
       false 'a
       false 1