api-tuner 0.4.1 → 0.5.1

package/index.js

@@ -1,13 +1,16 @@
 import * as url from 'node:url';
 import * as childProcess from 'node:child_process';
-import { PassThrough } from 'node:stream';
-import { resolve } from 'node:path';
+import { PassThrough, Readable } from 'node:stream';
+import { resolve, dirname } from 'node:path';
 import { program } from 'commander';
 import getStream from 'get-stream';
+import mergeStreams from '@sindresorhus/merge-streams';
+import rdf from '@zazuko/env-node';
 import packageJson from './package.json' with { type: 'json' };
 import parseTestCase from './lib/parse-test-case.js';
 import summariseResults from './lib/summarise-results.js';
 const eyePvmPath = url.fileURLToPath(new URL('eye/lib/eye.pvm', import.meta.url));
+const tuner = rdf.namespace('https://api-tuner.described.at/');
 program
     .name('api-tuner')
     .option('--lib <lib>', 'Specify rules to include in all tests. Can be used multiple times. Make sure to surround globs in quotes to prevent expansion.', (lib, arr) => [...arr, lib], [])
@@ -47,7 +50,6 @@ const levelIcon = {
 };
 async function processPath(path) {
     return new Promise(resolve => {
-        const testCaseStream = parseTestCase(path, options.baseIri);
         const eyeProc = childProcess.spawn('swipl', [
             '-x',
             eyePvmPath,
@@ -59,7 +61,10 @@ async function processPath(path) {
         ], {
             shell: true,
         });
-        testCaseStream.pipe(eyeProc.stdin);
+        mergeStreams([
+            parseTestCase(path, options.baseIri),
+            tunerParams({ path }),
+        ]).pipe(eyeProc.stdin);
         const stdout = new PassThrough();
         const stderr = new PassThrough();
         eyeProc.on('exit', (code) => {
@@ -73,6 +78,14 @@ async function processPath(path) {
         eyeProc.stderr.pipe(stderr);
     });
 }
+function tunerParams({ path }) {
+    const rdfString = rdf.clownface()
+        .blankNode()
+        .addOut(tuner.scriptPath, dirname(resolve(path)))
+        .dataset
+        .toCanonical();
+    return Readable.from(rdfString);
+}
 const testSuites = program.args.map(async (path) => {
     const absolutePath = resolve(process.cwd(), path);
     const result = await processPath(path);

package/lib/download-eye.js

@@ -0,0 +1,32 @@
+#! /usr/bin/env node
+/* eslint-disable no-console */
+import fs from 'node:fs'
+import { Readable } from 'node:stream'
+import * as tar from 'tar'
+
+async function main() {
+  const EYE_VERSION = process.env.EYE_VERSION
+  const url = `https://github.com/eyereasoner/eye/archive/refs/tags/v${EYE_VERSION}.tar.gz`
+
+  // Download and extract tarball directly from stream
+  const res = await fetch(url)
+  if (!res.ok) throw new Error(`Failed to download: ${res.statusText}`)
+  await new Promise((resolve, reject) => {
+    Readable.fromWeb(res.body)
+      .pipe(tar.x())
+      .on('finish', resolve)
+      .on('error', reject)
+  })
+
+  // Remove existing 'eye' directory if it exists
+  if (fs.existsSync('eye')) {
+    fs.rmSync('eye', { recursive: true, force: true })
+  }
+  // Rename extracted folder
+  fs.renameSync(`eye-${EYE_VERSION}`, 'eye')
+}
+
+main().catch(err => {
+  console.error(err)
+  process.exit(1)
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tuner",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "main": "index.js",
   "type": "module",
   "license": "MIT",
@@ -8,7 +8,7 @@
     "api-tuner": "./bin/tuner.sh"
   },
   "scripts": {
-    "download-eye": "EYE_VERSION=11.16.4 ./lib/download-eye.sh",
+    "download-eye": "EYE_VERSION=11.16.4 ./lib/download-eye.js",
     "postinstall": "([ -d eye ] || npm run download-eye) && eye/install.sh --prefix=eye",
     "prepare": "husky",
     "lint": "eslint . --quiet --ignore-path .gitignore",
@@ -30,13 +30,15 @@
   "dependencies": {
     "@changesets/cli": "^2.29.7",
     "@jeswr/pretty-turtle": "^1.5.0",
+    "@sindresorhus/merge-streams": "^4.0.0",
     "@zazuko/env-node": "^2.1.4",
     "commander": "^13.1.0",
     "get-stream": "^9.0.1",
     "is-absolute-url": "^4.0.1",
     "jsonld": "^8.3.3",
     "rdf-validate-shacl": "^0.5.6",
-    "replacestream": "^4.0.3"
+    "replacestream": "^4.0.3",
+    "tar": "^7.5.2"
   },
   "devDependencies": {
     "@rdfjs/types": "^1",
@@ -59,5 +61,8 @@
     "*.{js,ts}": [
       "eslint --fix --quiet"
     ]
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }

package/rules/files.n3

@@ -1,3 +1,4 @@
+PREFIX tuner: <https://api-tuner.described.at/>
 prefix e: <http://eulersharp.sourceforge.net/2003/03swap/log-rules#>
 prefix string: <http://www.w3.org/2000/10/swap/string#>
 prefix log: <http://www.w3.org/2000/10/swap/log#>
@@ -49,5 +50,9 @@ prefix file: <http://www.w3.org/2000/10/swap/file#>
   ?fileUri string:startsWith "file:" .
   ( ?fileUri 6 ) string:substring ?relative .
 
-  ( "@$(pwd)/" ?relative ) string:concatenation ?ref .
+  [
+      tuner:scriptPath ?scriptPath
+  ] .
+
+  ( "@'" ?scriptPath "/" ?relative "'" ) string:concatenation ?ref .
 } .

package/lib/download-eye.sh

@@ -1,6 +0,0 @@
-curl -sL https://github.com/eyereasoner/eye/archive/refs/tags/v"${EYE_VERSION}".tar.gz -o eye.tar.gz
-
-tar -xvzf eye.tar.gz
-rm eye.tar.gz
-
-mv eye-"${EYE_VERSION}" eye