eyeling 1.5.16 → 1.5.18

package/README.md

@@ -100,7 +100,7 @@ npm run test:packlist
 ```
 
 - `test:api` runs an independent JS API test suite (does not rely on `examples/`).
-- `test:examples` runs the `examples/test` runner and compares against the golden outputs in `examples/output`.
+- `test:examples` runs the examples in `examples` directory and compares against the golden outputs in `examples/output`.
 - `test:package` does a “real consumer” smoke test: `npm pack` → install tarball into a temp project → run API + CLI + examples.
 - `test:packlist` sanity-checks what will be published in the npm tarball (and the CLI shebang/bin wiring).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyeling",
-  "version": "1.5.16",
+  "version": "1.5.18",
   "description": "A minimal Notation3 (N3) reasoner in JavaScript.",
   "main": "./index.js",
   "keywords": [
@@ -31,8 +31,10 @@
   "scripts": {
     "test:packlist": "node test/packlist.test.js",
     "test:api": "node test/api.test.js",
-    "test:examples": "bash -lc 'cd examples && ./test'",
-    "test:package": "bash test/package-smoke.sh",
-    "test": "npm run test:packlist && npm run test:api && npm run test:examples"
+    "test:examples": "node test/examples.test.js",
+    "test:package": "node test/package.test.js",
+    "test": "npm run test:packlist && npm run test:api && npm run test:examples",
+    "preversion": "npm test",
+    "postversion": "git push origin HEAD --follow-tags"
   }
 }

package/test/api.test.js

@@ -556,6 +556,7 @@ let passed = 0;
 let failed = 0;
 
 (async function main() {
+  const suiteStart = Date.now();
   info(`Running ${cases.length} API tests (independent of examples/)`);
 
   for (const tc of cases) {
@@ -602,6 +603,8 @@ let failed = 0;
   }
 
   console.log('');
+  const suiteMs = Date.now() - suiteStart;
+  console.log(`${C.y}==${C.n} Total elapsed: ${suiteMs} ms`);
   if (failed === 0) {
     ok(`All API tests passed (${passed}/${cases.length})`);
     process.exit(0);

package/test/examples.test.js

@@ -0,0 +1,247 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+const cp = require('node:child_process');
+
+const TTY = process.stdout.isTTY;
+const C = TTY
+  ? { g: '\x1b[32m', r: '\x1b[31m', y: '\x1b[33m', dim: '\x1b[2m', n: '\x1b[0m' }
+  : { g: '', r: '', y: '', dim: '', n: '' };
+
+function ok(msg)   { console.log(`${C.g}OK${C.n}  ${msg}`); }
+function fail(msg) { console.error(`${C.r}FAIL${C.n} ${msg}`); }
+function info(msg) { console.log(`${C.y}==${C.n} ${msg}`); }
+
+function run(cmd, args, opts = {}) {
+  return cp.spawnSync(cmd, args, {
+    encoding: 'utf8',
+    maxBuffer: 200 * 1024 * 1024,
+    ...opts,
+  });
+}
+
+function hasGit() {
+  const r = run('git', ['--version']);
+  return r.status === 0;
+}
+
+function inGitWorktree(cwd) {
+  if (!hasGit()) return false;
+  const r = run('git', ['rev-parse', '--is-inside-work-tree'], { cwd });
+  return r.status === 0 && String(r.stdout).trim() === 'true';
+}
+
+// Expectation logic:
+// 1) If file contains:  # expect-exit: N  -> use N
+// 2) Else, if it contains "=> false" -> expect exit 2
+// 3) Else -> expect exit 0
+function expectedExitCode(n3Text) {
+  const m = n3Text.match(/^[ \t]*#[: ]*expect-exit:[ \t]*([0-9]+)\b/m);
+  if (m) return parseInt(m[1], 10);
+  if (/=>\s*false\b/.test(n3Text)) return 2;
+  return 0;
+}
+
+function getEyelingVersion(nodePath, eyelingJsPath, cwd) {
+  const r = run(nodePath, [eyelingJsPath, '-v'], { cwd });
+  const s = (r.stdout || r.stderr || '').trim();
+  return s || 'eyeling (unknown version)';
+}
+
+function mkTmpDir() {
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'eyeling-examples-'));
+  return dir;
+}
+
+function rmrf(p) {
+  try { fs.rmSync(p, { recursive: true, force: true }); } catch {}
+}
+
+function showDiff({ IN_GIT, examplesDir, expectedPath, generatedPath, relExpectedPosix }) {
+  if (hasGit()) {
+    if (IN_GIT) {
+      // Show repo diff for the overwritten golden file
+      const d = run('git', ['diff', '--', relExpectedPosix], { cwd: examplesDir });
+      if (d.stdout) process.stdout.write(d.stdout);
+      if (d.stderr) process.stderr.write(d.stderr);
+    } else {
+      // Show no-index diff between packaged golden and generated tmp
+      const d = run('git', ['diff', '--no-index', expectedPath, generatedPath], { cwd: examplesDir });
+      // Replace tmp path in output (nice UX)
+      if (d.stdout) process.stdout.write(String(d.stdout).replaceAll(generatedPath, 'generated'));
+      if (d.stderr) process.stderr.write(String(d.stderr).replaceAll(generatedPath, 'generated'));
+    }
+  } else {
+    // Fallback: diff -u
+    const d = run('diff', ['-u', expectedPath, generatedPath], { cwd: examplesDir });
+    if (d.stdout) process.stdout.write(d.stdout);
+    if (d.stderr) process.stderr.write(d.stderr);
+  }
+}
+
+function main() {
+  const suiteStart = Date.now();
+
+  // test/examples.test.js -> repo root is one level up
+  const root = path.resolve(__dirname, '..');
+  const examplesDir = path.join(root, 'examples');
+  const outputDir = path.join(examplesDir, 'output');
+  const eyelingJsPath = path.join(root, 'eyeling.js');
+  const nodePath = process.execPath;
+
+  if (!fs.existsSync(examplesDir)) {
+    fail(`Cannot find examples directory: ${examplesDir}`);
+    process.exit(1);
+  }
+  if (!fs.existsSync(eyelingJsPath)) {
+    fail(`Cannot find eyeling.js: ${eyelingJsPath}`);
+    process.exit(1);
+  }
+
+  const IN_GIT = inGitWorktree(root);
+
+  const files = fs.readdirSync(examplesDir)
+    .filter(f => f.endsWith('.n3'))
+    .sort((a, b) => a.localeCompare(b));
+
+  info(
+    `Running ${files.length} examples tests (${IN_GIT ? 'git worktree mode' : 'npm-installed mode'})`
+  );
+  console.log(`${C.dim}${getEyelingVersion(nodePath, eyelingJsPath, root)}; node ${process.version}${C.n}`);
+
+  if (files.length === 0) {
+    ok('No .n3 files found in examples/');
+    process.exit(0);
+  }
+
+  // In maintainer mode we overwrite tracked goldens in examples/output/
+  if (IN_GIT) fs.mkdirSync(outputDir, { recursive: true });
+
+  let passed = 0;
+  let failed = 0;
+
+  for (let i = 0; i < files.length; i++) {
+    const idx = String(i + 1).padStart(2, '0');
+    const file = files[i];
+
+    const start = Date.now();
+
+    const filePath = path.join(examplesDir, file);
+    const expectedPath = path.join(outputDir, file);
+    const relExpectedPosix = path.posix.join('output', file); // for git diff inside examplesDir
+
+    let n3Text;
+    try {
+      n3Text = fs.readFileSync(filePath, 'utf8');
+    } catch (e) {
+      const ms = Date.now() - start;
+      fail(`${idx} ${file} (${ms} ms)`);
+      fail(`Cannot read input: ${e.message}`);
+      failed++;
+      continue;
+    }
+
+    const expectedRc = expectedExitCode(n3Text);
+
+    // Decide where generated output goes
+    let tmpDir = null;
+    let generatedPath = expectedPath;
+
+    if (!IN_GIT) {
+      // npm-installed / no .git: never modify output/ in node_modules
+      if (!fs.existsSync(expectedPath)) {
+        const ms = Date.now() - start;
+        fail(`${idx} ${file} (${ms} ms)`);
+        fail(`Missing expected output/${file}`);
+        failed++;
+        continue;
+      }
+      tmpDir = mkTmpDir();
+      generatedPath = path.join(tmpDir, 'generated.n3');
+    }
+
+    // Run eyeling on this file (cwd examplesDir so relative behavior matches old script)
+    const r = run(nodePath, [eyelingJsPath, file], { cwd: examplesDir });
+    const rc = (r.status == null) ? 1 : r.status;
+
+    // Write stdout to file (expectedPath in git mode; tmp in npm mode)
+    try {
+      fs.writeFileSync(generatedPath, r.stdout || '', 'utf8');
+    } catch (e) {
+      const ms = Date.now() - start;
+      fail(`${idx} ${file} (${ms} ms)`);
+      fail(`Cannot write output: ${e.message}`);
+      failed++;
+      if (tmpDir) rmrf(tmpDir);
+      continue;
+    }
+
+    const ms = Date.now() - start;
+
+    // Compare output
+    let diffOk = false;
+    if (IN_GIT) {
+      const d = run('git', ['diff', '--quiet', '--', relExpectedPosix], { cwd: examplesDir });
+      diffOk = (d.status === 0);
+    } else {
+      if (hasGit()) {
+        const d = run('git', ['diff', '--no-index', '--quiet', expectedPath, generatedPath], { cwd: examplesDir });
+        diffOk = (d.status === 0);
+      } else {
+        const d = run('diff', ['-u', expectedPath, generatedPath], { cwd: examplesDir });
+        diffOk = (d.status === 0);
+      }
+    }
+
+    const rcOk = (rc === expectedRc);
+
+    if (diffOk && rcOk) {
+      if (expectedRc === 0) {
+        ok(`${idx} ${file} (${ms} ms)`);
+      } else {
+        ok(`${idx} ${file} (expected exit ${expectedRc}, ${ms} ms)`);
+      }
+      passed++;
+    } else {
+      fail(`${idx} ${file} (${ms} ms)`);
+      if (!rcOk) {
+        fail(`Exit code ${rc}, expected ${expectedRc}`);
+      }
+      if (!diffOk) {
+        fail('Output differs');
+      }
+
+      // Show diffs (both modes), because this is a test runner
+      showDiff({
+        IN_GIT,
+        examplesDir,
+        expectedPath,
+        generatedPath,
+        relExpectedPosix,
+      });
+
+      failed++;
+    }
+
+    if (tmpDir) rmrf(tmpDir);
+  }
+
+  console.log('');
+  const suiteMs = Date.now() - suiteStart;
+  info(`Total elapsed: ${suiteMs} ms (${(suiteMs / 1000).toFixed(2)} s)`);
+
+  if (failed === 0) {
+    ok(`All examples tests passed (${passed}/${files.length})`);
+    process.exit(0);
+  } else {
+    fail(`Some examples tests failed (${passed}/${files.length})`);
+    // keep exit code 2 (matches historical behavior of examples/test)
+    process.exit(2);
+  }
+}
+
+main();
+

package/test/package.test.js

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+const cp = require('node:child_process');
+
+const TTY = process.stdout.isTTY;
+const C = TTY
+  ? { g: '\x1b[32m', r: '\x1b[31m', y: '\x1b[33m', dim: '\x1b[2m', n: '\x1b[0m' }
+  : { g: '', r: '', y: '', dim: '', n: '' };
+
+function info(msg) { console.log(`${C.y}==${C.n} ${msg}`); }
+function ok(msg)   { console.log(`${C.g}OK${C.n}  ${msg}`); }
+function fail(msg) { console.error(`${C.r}FAIL${C.n} ${msg}`); }
+
+function isWin() { return process.platform === 'win32'; }
+function npmCmd() { return isWin() ? 'npm.cmd' : 'npm'; }
+
+function rmrf(p) {
+  try { fs.rmSync(p, { recursive: true, force: true }); } catch {}
+}
+
+function run(cmd, args, opts = {}) {
+  const res = cp.spawnSync(cmd, args, {
+    encoding: 'utf8',
+    maxBuffer: 200 * 1024 * 1024,
+    ...opts,
+  });
+  return res;
+}
+
+function runChecked(cmd, args, opts = {}) {
+  // Print the command in a dim style
+  console.log(`${C.dim}$ ${cmd} ${args.join(' ')}${C.n}`);
+  const res = run(cmd, args, opts);
+  if (res.error) throw res.error;
+  if (res.status !== 0) {
+    const err = new Error(`Command failed (${cmd} ${args.join(' ')}), exit ${res.status}`);
+    err.code = res.status;
+    err.stdout = res.stdout;
+    err.stderr = res.stderr;
+    throw err;
+  }
+  return res;
+}
+
+function packTarball(root) {
+  // `npm pack --silent` prints the filename (usually one line)
+  const res = runChecked(npmCmd(), ['pack', '--silent'], { cwd: root });
+  const out = String(res.stdout || '').trim().split(/\r?\n/).filter(Boolean);
+  if (out.length === 0) throw new Error('npm pack produced no output');
+  return out[out.length - 1].trim(); // tarball filename in root
+}
+
+function main() {
+  const suiteStart = Date.now();
+  const root = path.resolve(__dirname, '..');
+
+  const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'eyeling-smoke-'));
+  const cleanup = () => rmrf(tmp);
+
+  let tgzInRoot = null;
+
+  try {
+    info('Building tarball (npm pack)');
+    tgzInRoot = packTarball(root);
+    const srcTgz = path.join(root, tgzInRoot);
+    const dstTgz = path.join(tmp, tgzInRoot);
+
+    fs.renameSync(srcTgz, dstTgz);
+
+    info('Creating temp project + installing tarball');
+    runChecked(npmCmd(), ['init', '-y'], { cwd: tmp, stdio: 'ignore' });
+    runChecked(npmCmd(), ['install', `./${tgzInRoot}`, '--no-audit', '--no-fund'], { cwd: tmp, stdio: 'inherit' });
+
+    info('API smoke test');
+    // Run a tiny API check via node -e
+    const apiCode = `
+      const { reason } = require('eyeling');
+      const input = \`
+{ <http://example.org/s> <http://example.org/p> <http://example.org/o>. }
+  => { <http://example.org/s> <http://example.org/q> <http://example.org/o>. }.
+
+<http://example.org/s> <http://example.org/p> <http://example.org/o>.
+\`;
+      const out = reason({ proofComments: false }, input);
+      const re = /<http:\\/\\/example\\.org\\/s>\\s+<http:\\/\\/example\\.org\\/q>\\s+<http:\\/\\/example\\.org\\/o>\\s*\\./;
+      if (!re.test(out)) {
+        console.error('Unexpected output:\\n' + out);
+        process.exit(1);
+      }
+      console.log('OK: API works');
+    `;
+    runChecked(process.execPath, ['-e', apiCode], { cwd: tmp, stdio: 'inherit' });
+    ok('API works');
+
+    info('CLI smoke test');
+    const bin = isWin()
+      ? path.join(tmp, 'node_modules', '.bin', 'eyeling.cmd')
+      : path.join(tmp, 'node_modules', '.bin', 'eyeling');
+    runChecked(bin, ['-v'], { cwd: tmp, stdio: 'inherit' });
+    ok('CLI works');
+
+    info('Examples test (installed package)');
+    const examplesRunner = path.join(tmp, 'node_modules', 'eyeling', 'test', 'examples.test.js');
+    runChecked(process.execPath, [examplesRunner], { cwd: tmp, stdio: 'inherit' });
+    ok('Installed examples test passed');
+
+    const suiteMs = Date.now() - suiteStart;
+    console.log('');
+    ok(`Packaged install smoke test passed ${C.dim}(${suiteMs} ms, ${(suiteMs / 1000).toFixed(2)} s)${C.n}`);
+    process.exit(0);
+  } catch (e) {
+    console.log('');
+    fail(e && e.stack ? e.stack : String(e));
+    process.exit(1);
+  } finally {
+    // If rename failed and the tarball still exists in root, try to delete it
+    if (tgzInRoot) {
+      const maybe = path.join(root, tgzInRoot);
+      if (fs.existsSync(maybe)) {
+        try { fs.unlinkSync(maybe); } catch {}
+      }
+    }
+    cleanup();
+  }
+}
+
+main();
+

package/test/packlist.test.js

@@ -45,7 +45,6 @@ try {
     'LICENSE.md',
     'eyeling.js',
     'index.js',
-    'examples/test',
   ];
 
   for (const p of mustHave) assert.ok(paths.has(p), `missing from npm pack: ${p}`);

package/examples/test

@@ -1,154 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-
-RED="\e[31m"
-GREEN="\e[32m"
-YELLOW="\e[33m"
-NORMAL="\e[0;39m"
-
-OK=0
-DIFF=0
-
-pad() {
-  # pad "text" width
-  local s="$1" w="$2"
-  printf "%-${w}s" "$s"
-}
-
-now_ms() {
-  echo $(( $(date +%s%N) / 1000000 ))
-}
-
-in_git_worktree() {
-  command -v git >/dev/null 2>&1 && git rev-parse --is-inside-work-tree >/dev/null 2>&1
-}
-
-# Expectation logic:
-# 1) If the .n3 contains a comment like:  # expect-exit: 2  -> use that
-# 2) Else, if it contains "=> false" -> expect exit 2
-# 3) Else -> expect exit 0
-expected_exit_code() {
-  local file="$1"
-  local line
-  if line=$(grep -Em1 '^[[:space:]]*#[: ]*expect-exit:[[:space:]]*[0-9]+' "$file" 2>/dev/null); then
-    if [[ "$line" =~ ([0-9]+) ]]; then
-      echo "${BASH_REMATCH[1]}"
-      return
-    fi
-  fi
-  if grep -Eq '=>[[:space:]]*false\b' "$file"; then
-    echo 2
-  else
-    echo 0
-  fi
-}
-
-echo -e "${YELLOW}-------------------------------------------------${NORMAL}"
-echo -e "${YELLOW}running eyeling examples${NORMAL}"
-echo -e "${YELLOW}using $(../eyeling.js -v) and node $(node --version)${NORMAL}"
-echo -e "${YELLOW}-------------------------------------------------${NORMAL}"
-echo ""
-
-IN_GIT=0
-if in_git_worktree; then IN_GIT=1; fi
-
-# In maintainer mode we write expected outputs (tracked) to output/
-if [[ $IN_GIT -eq 1 ]]; then
-  mkdir -p output
-fi
-
-begin="$(now_ms)"
-
-for file in *.n3; do
-  printf "%s" "$(pad "$file" 36)"
-  start="$(now_ms)"
-
-  expected_rc="$(expected_exit_code "$file")"
-
-  # Decide where we write generated output
-  tmp=""
-  generated=""
-  expected="output/${file}"
-
-  if [[ $IN_GIT -eq 1 ]]; then
-    generated="$expected"            # overwrite expected output in working tree
-  else
-    # npm-installed / no .git: never modify output/ in node_modules
-    if [[ ! -f "$expected" ]]; then
-      end="$(now_ms)"
-      ms=$((end-start))
-      echo -en "${YELLOW}$(pad "${ms} ms" 10)${NORMAL} "
-      echo -e "${RED}MISSING expected ${expected}${NORMAL}"
-      ((++DIFF))
-      continue
-    fi
-    tmp="$(mktemp)"
-    generated="$tmp"
-  fi
-
-  # Run eyeling, capture exit code without breaking the loop
-  rc=0
-  if ../eyeling.js "$file" > "$generated"; then
-    rc=0
-  else
-    rc=$?
-  fi
-
-  end="$(now_ms)"
-  ms=$((end-start))
-  echo -en "${YELLOW}$(pad "${ms} ms" 10)${NORMAL} "
-
-  # Compare output
-  diff_ok=0
-  if [[ $IN_GIT -eq 1 ]]; then
-    if git diff --quiet -- "$expected"; then diff_ok=1; fi
-  else
-    if command -v git >/dev/null 2>&1; then
-      if git diff --no-index --quiet -- "$expected" "$generated" >/dev/null 2>&1; then diff_ok=1; fi
-    else
-      if diff -u "$expected" "$generated" >/dev/null 2>&1; then diff_ok=1; fi
-    fi
-  fi
-
-  # Decide pass/fail
-  if [[ $diff_ok -eq 1 && $rc -eq $expected_rc ]]; then
-    if [[ $rc -eq 0 ]]; then
-      echo -e "${GREEN}OK${NORMAL}"
-    else
-      echo -e "${GREEN}OK${NORMAL} (exit ${rc})"
-    fi
-    ((++OK))
-  else
-    if [[ $rc -ne $expected_rc ]]; then
-      echo -e "${RED}DIFF${NORMAL} (exit ${rc}, expected ${expected_rc})"
-    else
-      echo -e "${RED}DIFF${NORMAL}"
-    fi
-    ((++DIFF))
-
-    # In npm mode, show a git-style diff when available (nice UX)
-    if [[ $IN_GIT -eq 0 ]]; then
-      if command -v git >/dev/null 2>&1; then
-        git diff --no-index -- "$expected" "$generated" || true
-      else
-        diff -u "$expected" "$generated" || true
-      fi
-    fi
-  fi
-
-  # cleanup tmp file
-  if [[ -n "$tmp" ]]; then rm -f "$tmp"; fi
-done
-
-end="$(now_ms)"
-total=$((end-begin))
-
-echo ""
-echo -e "${YELLOW}${total} ms${NORMAL} ${GREEN}${OK} OK${NORMAL} ${RED}${DIFF} DIFF${NORMAL}"
-
-if [[ ${DIFF} -eq 0 ]]; then
-  exit 0
-else
-  exit 2
-fi
-

package/test/package-smoke.sh

@@ -1,55 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-if [ -t 1 ]; then
-  RED=$'\e[31m'; GREEN=$'\e[32m'; YELLOW=$'\e[33m'; NORMAL=$'\e[0m'
-else
-  RED=""; GREEN=""; YELLOW=""; NORMAL=""
-fi
-
-say() { echo -e "${YELLOW}== $* ==${NORMAL}"; }
-ok()  { echo -e "${GREEN}OK${NORMAL} $*"; }
-
-ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
-TMP="$(mktemp -d)"
-cleanup() { rm -rf "$TMP"; }
-trap cleanup EXIT
-
-cd "$ROOT"
-
-say "Building tarball"
-TGZ="$(npm pack --silent)"
-mv "$TGZ" "$TMP/"
-cd "$TMP"
-
-say "Installing tarball into temp project"
-npm init -y >/dev/null 2>&1
-npm install "./$TGZ" >/dev/null 2>&1
-
-say "API smoke test"
-node - <<'NODE'
-const { reason } = require('eyeling');
-const input = `
-{ <http://example.org/s> <http://example.org/p> <http://example.org/o>. }
-  => { <http://example.org/s> <http://example.org/q> <http://example.org/o>. }.
-
-<http://example.org/s> <http://example.org/p> <http://example.org/o>.
-`;
-const out = reason({ proofComments: false }, input);
-if (!/<http:\/\/example\.org\/s>\s+<http:\/\/example\.org\/q>\s+<http:\/\/example\.org\/o>\s*\./.test(out)) {
-  console.error("Unexpected output:\n" + out);
-  process.exit(1);
-}
-NODE
-ok "API works"
-
-say "CLI smoke test"
-./node_modules/.bin/eyeling -v
-ok "CLI works"
-
-say "Examples test (installed package)"
-cd node_modules/eyeling/examples
-./test
-
-ok "packaged install smoke test passed"
-