Minor modernizations: CI, Clojure version, test organization (#182)

* Clean up test ns structure

* Upgrade to Clojure 1.11

* Fix broken test helper (and thus a failing test)

* Add basic CI

* Fix Java setup on CI

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build-clj:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: "Setup Java 17"
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'temurin'
+        java-version: '17'
+    - name: Setup Clojure
+      uses: DeLaGuardo/setup-clojure@12.1
+      with:
+        lein: 2.10.0
+    - name: Cache dependencies
+      uses: actions/cache@v3
+      with:
+        path: ~/.m2/repository
+        key: "m2-${{ hashFiles('project.clj') }}"
+    - name: Run tests
+      run: lein test

project.clj

@@ -2,7 +2,7 @@
   :description "lightweight literate programming for clojure -- inspired by [docco](http://jashkenas.github.com/docco/)"
 ;;  :main marginalia.main
   :dependencies
-  [[org.clojure/clojure "1.7.0"]
+  [[org.clojure/clojure "1.11.1"]
    [org.clojure/clojurescript "1.7.228"]
    [org.clojure/tools.namespace "0.2.10"]
    [org.clojure/tools.cli "0.3.3"]

test/marginalia/core_test.clj

@@ -0,0 +1,7 @@
+(ns marginalia.core-test
+  (:require
+   [clojure.test :refer :all]
+   [marginalia.core :as core]))
+
+(deftest parse-project-file-simple
+  (is (= "project-name" (:name (marginalia.core/parse-project-file "test/marginalia/resources/multi-def-project.clj.txt")))))

test/marginalia/multidoc_test.clj

@@ -0,0 +1,14 @@
+(ns marginalia.multidoc-test
+  (:require
+   [clojure.test :refer :all]
+   [marginalia.core :as core]
+   [marginalia.test.helpers :refer :all]))
+
+(deftest multi-page-test
+  (with-project "multi_page"
+    (fn [source-dir output-dir metadata]
+      (core/multidoc! output-dir
+                      (find-clojure-file-paths source-dir)
+                      metadata))
+
+    (is (= 3 number-of-generated-pages))))

test/marginalia/test/parse.clj → test/marginalia/parse_test.clj

@@ -1,7 +1,8 @@
-(ns marginalia.test.parse
+(ns marginalia.parse-test
   "This module does stuff"
-  (:use clojure.test)
-  (:require [marginalia.parser :as p]))
+  (:require
+   [clojure.test :refer :all]
+   [marginalia.parser :as p]))
 
 (deftest test-inline-literals
   (is (= (count (marginalia.parser/parse "(ns test)")) 1))

test/marginalia/test/helpers.clj

@@ -1,7 +1,9 @@
 (ns marginalia.test.helpers
-  (:use clojure.test)
-  (:use [clojure.java.io :only (file delete-file)])
-  (:require marginalia.core))
+  (:require
+   [clojure.java.io :refer [file delete-file]]
+   [clojure.test :refer :all]
+   [marginalia.core :as core]
+   [marginalia.html :as html]))
 
 
 ;; copied from http://clojuredocs.org/clojure_contrib/clojure.contrib.io/delete-file-recursively
@@ -17,7 +19,7 @@
     (delete-file f silently)))
 
 (defn find-clojure-file-paths [source-dir]
-  (marginalia.core/find-processable-file-paths source-dir #(re-find #"\.clj$" %)))
+  (core/find-processable-file-paths source-dir #(re-find #"clj$" %)))
 
 (defn files-in [dir]
   (seq (.listFiles (file dir))))
@@ -50,7 +52,7 @@
     `(do
        (delete-file-recursively ~test-project-target true)
        (.mkdirs (file ~test-project-target))
-       (binding [marginalia.html/*resources* ""]
+       (binding [html/*resources* ""]
          (~doc-generator ~test-project-src ~test-project-target ~test-metadata))
        (let [~'number-of-generated-pages (count (files-in ~test-project-target))]
          ;; We need to `deftest` in order for test runners (e.g. `lein test`) to pick up failures

test/marginalia/uberdoc_test.clj

@@ -0,0 +1,15 @@
+(ns marginalia.uberdoc-test
+  (:require
+   [clojure.java.io :as io]
+   [clojure.test :refer :all]
+   [marginalia.core :as core]
+   [marginalia.test.helpers :refer :all]))
+
+(deftest single-page-test
+  (with-project "single_page"
+    (fn [source-dir output-dir metadata]
+      (marginalia.core/uberdoc! (io/file output-dir "index.html")
+                                (find-clojure-file-paths source-dir)
+                                metadata))
+
+    (is (= 1 number-of-generated-pages))))