Migrate to GitHub Actions (#6)

* Migrate to GitHub Actions and update installation instructions.

* Update README.md

* Run CI on push / pull_request to master

* Upgrade psa to v0.8.0

* Update pulp to v0.15.0

* Update package.json

* Bump dev dependency versions

* Run (some) tests on CI

Co-authored-by: Cyril Sobierajewicz <[email protected]>

Author: thomashoneyman

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: purescript-contrib/setup-purescript@main
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "10"
+
+      - name: Install dependencies
+        run: |
+          npm install -g bower
+          npm install
+          bower install --production
+
+      - name: Build source
+        run: npm run-script build
+
+      - name: Run tests
+        run: |
+          bower install
+          npm run-script test --if-present

.gitignore

@@ -1,7 +1,7 @@
 /.*
 !/.gitignore
 !/.eslintrc.json
-!/.travis.yml
+!/.github/
 package-lock.json
 /bower_components/
 /node_modules/

.travis.yml

@@ -1,14 +1,15 @@
 # purescript-web-xpath
 
 [![Latest release](http://img.shields.io/github/release/purescript-web/purescript-web-dom-xpath.svg)](https://github.com/purescript-web/purescript-web-dom-xpath/releases)
-[![Build status](https://travis-ci.org/purescript-web/purescript-web-dom-xpath.svg?branch=master)](https://travis-ci.org/purescript-web/purescript-web-dom-xpath)
+[![Build status](https://github.com/purescript-web/purescript-web-dom-xpath/workflows/CI/badge.svg?branch=master)](https://github.com/purescript-web/purescript-web-dom-xpath/actions?query=workflow%3ACI+branch%3Amaster)
+[![Pursuit](https://pursuit.purescript.org/packages/purescript-web-dom-xpath/badge)](https://pursuit.purescript.org/packages/purescript-web-dom-xpath)
 
 Type definitions and low level interface implementations for the [W3C DOM XPath API](https://www.w3.org/TR/DOM-Level-3-XPath/).
 
 ## Installation
 
 ```
-bower install purescript-web-dom-xpath
+spago install web-dom-xpath
 ```
 
 ## Documentation

README.md

@@ -3,17 +3,16 @@
   "private": true,
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
-    "build": "bower install && eslint src && pulp build -- --censor-lib --strict",
-    "test": "npm run build && pulp test",
+    "build": "eslint src && pulp build -- --censor-lib --strict",
+    "test": "eslint src && pulp build -I \"test\" -- --censor-lib && node test/node.js",
     "testbrowser": "./scripts/testbrowser"
   },
   "devDependencies": {
-    "bower": "^1.8.8",
-    "eslint": "^4.19.1",
-    "parcel-bundler": "^1.12.3",
-    "pulp": "^13.0.0",
-    "purescript": "^0.13.0",
-    "purescript-psa": "^0.6.0",
-    "rimraf": "^2.6.2"
+    "eslint": "^7.15.0",
+    "jsdom": "^16.4.0",
+    "parcel-bundler": "^1.12.4",
+    "pulp": "^15.0.0",
+    "purescript-psa": "^0.8.0",
+    "rimraf": "^3.0.2"
   }
 }

package.json

@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 
-pulp build --main "Test.Main" --src-path "src" -I "test" \
-     -- --censor-lib && \
+eslint src && \
+pulp build -I "test" -- --censor-lib && \
 parcel build --public-url ./ test/index.html

scripts/testbrowser

@@ -80,8 +80,8 @@ mkCdYear doc node = liftEffect $ XP.evaluateString
   Nothing
   doc
 
-main :: Effect Unit
-main = runTest do
+main :: { browser :: Boolean } -> Effect Unit
+main { browser } = runTest do
   suite "non-namespaced tests" do
     test "note.xml and catalog.xml" do
       domParser <- liftEffect $ makeDOMParser
@@ -148,22 +148,23 @@ main = runTest do
       Assert.assertFalse "custom NS resolver shouldn't be null"
         (isNull $ unsafeToForeign customRes)
 
-      atomFeedDoc <-liftEffect $ parseAtomFeedDoc domParser
-      atomFeed <- pure $ toNode atomFeedDoc
+      when browser $ do
+        atomFeedDoc <- liftEffect $ parseAtomFeedDoc domParser
+        atomFeed <- pure $ toNode atomFeedDoc
 
-      createdNSResolver <- pure $ XP.createNSResolver atomFeed atomFeedDoc
-      Assert.assertFalse "created NS resolver shouldn't be undefined"
-        (isUndefined $ unsafeToForeign createdNSResolver)
-      Assert.assertFalse "created NS resolver shouldn't be null"
-        (isNull $ unsafeToForeign createdNSResolver)
+        createdNSResolver <- pure $ XP.createNSResolver atomFeed atomFeedDoc
+        Assert.assertFalse "created NS resolver shouldn't be undefined"
+          (isUndefined $ unsafeToForeign createdNSResolver)
+        Assert.assertFalse "created NS resolver shouldn't be null"
+          (isNull $ unsafeToForeign createdNSResolver)
 
-      defNSResolver <- liftEffect $ XP.defaultNSResolver atomFeed atomFeedDoc
-      Assert.assertFalse "default NS resolver shouldn't be undefined"
-        (isUndefined $ unsafeToForeign defNSResolver)
-      Assert.assertFalse "default NS resolver shouldn't be null"
-        (isNull $ unsafeToForeign defNSResolver)
+        defNSResolver <- liftEffect $ XP.defaultNSResolver atomFeed atomFeedDoc
+        Assert.assertFalse "default NS resolver shouldn't be undefined"
+          (isUndefined $ unsafeToForeign defNSResolver)
+        Assert.assertFalse "default NS resolver shouldn't be null"
+          (isNull $ unsafeToForeign defNSResolver)
 
-    test "atom.xml" do
+    test "atom.xml" $ when browser do
       domParser <- liftEffect $ makeDOMParser
 
       atomFeedDoc <-liftEffect $ parseAtomFeedDoc domParser
@@ -198,7 +199,7 @@ main = runTest do
       metajeloId <- liftEffect $ XP.stringValue metajeloIdRes
       tlog $ "got metajelo id" <> metajeloId
       Assert.equal RT.string_type (XP.resultType metajeloIdRes)
-      Assert.equal "OjlTjf" metajeloId
+      when browser $ Assert.equal "OjlTjf" metajeloId
 
       prod0pol0xpath <- pure $
         "/x:record/x:supplementaryProducts/x:supplementaryProduct[1]" <>
@@ -214,7 +215,7 @@ main = runTest do
       mjProd0Pol0 <- liftEffect $ XP.stringValue mjProd0Pol0Res
       tlog $ "got metajelo ref policy " <> mjProd0Pol0
       Assert.equal RT.string_type (XP.resultType mjProd0Pol0Res)
-      Assert.equal "http://skGHargw/" mjProd0Pol0
+      when browser $ Assert.equal "http://skGHargw/" mjProd0Pol0
       --
       mjProd0Pol0AppliesRes <- liftEffect $ XP.evaluate
         (prod0pol0xpath <>  "/@appliesToProduct")
@@ -226,7 +227,7 @@ main = runTest do
       mjProd0Pol0Applies <- liftEffect $ XP.stringValue mjProd0Pol0AppliesRes
       tlog $ "got metajelo policy appliesToProduct: " <> (show mjProd0Pol0Applies)
       Assert.equal RT.string_type (XP.resultType mjProd0Pol0AppliesRes)
-      Assert.equal "0" mjProd0Pol0Applies
+      when browser $ Assert.equal "0" mjProd0Pol0Applies
 
 tlog :: forall a. Show a => a -> Aff Unit
 tlog = liftEffect <<< logShow

test/Main.purs

@@ -1,2 +1,3 @@
 import Main from "../output/Test.Main/index.js";
-Main.main();
+
+Main.main({ browser: true })();

test/index.js test/browser.jstest/index.js renamed to test/browser.js

@@ -7,7 +7,7 @@
   <body>
     <script
       type="application/javascript"
-      src="./index.js"
+      src="./browser.js"
       charset="utf-8"></script>
     <p>To see test output: open your browser's web console and reload the page.</p>
   </body>

test/index.html

@@ -0,0 +1,6 @@
+const { JSDOM } = require("jsdom");
+const { XPathResult, DOMParser } = new JSDOM().window;
+
+Object.assign(global, { XPathResult, DOMParser })
+
+require("../output/Test.Main/index.js").main({ browser: false })();