Merge pull request #52 from codewars/packaging

Author: kazk

.dockerignore

@@ -0,0 +1,3 @@
+*
+!workspace/
+workspace/node_modules/

.github/workflows/publish-image.yml

@@ -0,0 +1,41 @@
+# Manually trigger image build and push.
+# This must be done after publishing a new version of the package
+# and updating `workspace/package.json` to use it.
+name: Push Image
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Tag for the new image
+        required: true
+jobs:
+  build-and-push-image:
+    if: ${{ github.repository == 'codewars/lambda-calculus' }}
+    name: Build Images
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Login to GitHub Container Registry
+      uses: docker/login-action@v1
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and push image
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        push: true
+        tags: |
+          ghcr.io/${{ github.repository_owner }}/lambda-calculus:latest
+          ghcr.io/${{ github.repository_owner }}/lambda-calculus:${{ github.event.inputs.tag }}
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

.github/workflows/publish-package.yml

@@ -0,0 +1,29 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          cache: 'npm'
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          cache: 'npm'
+          registry-url: https://npm.pkg.github.com/
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:16.13-alpine3.15
+
+RUN set -ex; \
+    adduser -D codewarrior; \
+    mkdir -p /workspace; \
+    chown codewarrior:codewarrior /workspace;
+
+COPY --chown=codewarrior:codewarrior workspace/package.json /workspace/package.json
+COPY --chown=codewarrior:codewarrior workspace/package-lock.json /workspace/package-lock.json
+COPY --chown=codewarrior:codewarrior workspace/files.js /workspace/files.js
+
+USER codewarrior
+WORKDIR /workspace
+RUN npm install

README.md

@@ -5,32 +5,31 @@
 
 Written by [Kacarott](https://github.com/Kacarott) and [JohanWiltink](https://github.com/JohanWiltink)
 
+### Install
 
-### Running example tests
-
-**Requirements:**
-- `node`
-- `npm`
-
-From within this directory:
-
-1. Install dependancies with `npm install`
-2. Run tests with `npm test`
+```bash
+$ npm i --save @codewars/lambda-calculus
+```
 
 ### Usage
 
+> NOTE: When writing tests on Codewars, you can use the predefined wrapper module "./files.js" to get
+> the solution file instead of using `fs` like below.
+
 ```javascript
+import { readFileSync } from "fs";
 // Import module
-const LC = require("./src/lambda-calculus.js");
+import * as LC from "@codewars/lambda-calculus";
 
 // Set config options
 LC.config.purity = "Let";
 LC.config.numEncoding = "Church";
 
+const code = readFileSync("solution.lc", {encoding: "utf8"});
 // Compile
-const solution = compile().TRUE;
+const solution = compile(code).TRUE;
 // or
-const {TRUE,FALSE} = compile();
+const {TRUE,FALSE} = compile(code);
 
 // Use
 console.log(solution(true)(false)); // true
@@ -43,13 +42,10 @@ console.log(TRUE(true)(false)) // true
 
 ---
 
-`compile :: String? -> {String: (Term -> Term)}`
+`compile :: String -> {String: (Term -> Term)}`
 
 `compile` is the main entry point of the module. Compiles the specified text according the current `config` options, and returns an object binding all defined terms to their corresponding functions.
 
-If called without an argument, will try open a file called `solution.txt` in the same directory, and parse its contents.
-
-
 ---
 
 `config :: {String: String}`
@@ -64,3 +60,23 @@ If called without an argument, will try open a file called `solution.txt` in the
 | `numEncoding` | `None` | No number encoding. Use of number literals will cause an error. |
 |  | `Church`<br>`Scott`<br>`BinaryScott` | Number literals will be automatically converted to corresponding LC terms, according to the encoding chosen. |
 | `verbosity` | `Calm`<br>`Concise`<br>`Loquacious`<br>`Verbose` | Controls the amount of information that will be reported during compilation. |
+
+### Container Image
+
+The container image used by the Code Runner is available on [GHCR](https://github.com/codewars/lambda-calculus/pkgs/container/lambda-calculus).
+
+```bash
+docker pull ghcr.io/codewars/lambda-calculus:latest
+```
+
+#### Building
+
+The image can be built from this repository:
+
+```bash
+docker build -t ghcr.io/codewars/lambda-calculus:latest .
+```
+
+#### Usage
+
+See [example/](./example/) to learn how to use the image to test locally.

example/README.md

@@ -0,0 +1,3 @@
+Minimal example with a solution and tests.
+
+Use `./test.sh` to run this in a container.

example/solution.lc

@@ -0,0 +1,11 @@
+# Kacarott
+
+true  = \ a b . a
+false = \ a b . b
+
+zero = false
+succ = \ n f x . f (n f x)
+
+y = \ f . (\ x . f (x x)) (\ x . f (x x))
+
+counter = y (\ count n b . b (count (succ n)) (n) ) zero

example/test.js

@@ -0,0 +1,21 @@
+import { assert, config as chaiConfig } from "chai";
+chaiConfig.truncateThreshold = 0;
+
+import * as LC from "@codewars/lambda-calculus";
+import { solution } from "./files.js"; // /workspace/files.js
+
+LC.config.purity = "Let";
+LC.config.numEncoding = "Church";
+const toInt = LC.toIntWith(LC.config);
+const { counter } = LC.compile(solution());
+
+const T = t => _ => t;
+const F = _ => f => f;
+
+describe("counter", () => {
+  it("fixed tests", () => {
+    assert.strictEqual(toInt(counter(T)(T)(T)(F)), 3);
+    assert.strictEqual(toInt(counter(T)(F)), 1);
+    assert.strictEqual(toInt(counter(T)(T)(T)(T)(T)(T)(T)(F)), 7);
+  });
+});

example/test.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# Test example in a container similar to the runner
+W=/workspace/
+C=$(docker container create --rm -w $W ghcr.io/codewars/lambda-calculus:latest npx mocha)
+docker container cp ./solution.lc $C:$W
+docker container cp ./test.js $C:$W
+docker container start --attach $C

kata/submit-tests.js

@@ -1,13 +1,12 @@
 {
   "name": "@codewars/lambda-calculus",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.0-rc.1",
   "description": "Lambda Calculus evaluator for Codewars",
   "main": "src/lambda-calculus.js",
-  "directories": {
-    "example": "example",
-    "test": "tests"
-  },
+  "files": [
+    "src/"
+  ],
   "scripts": {
     "test": "mocha --reporter spec ./tests/*/test.js",
     "repl": "node ./src/LC-REPL.js"

package-lock.json

@@ -0,0 +1,10 @@
+The `/workspace` directory where the submitted solution is tested in.
+
+```text
+├─ files.js         a wrapper module to load submitted solution and preloaded
+├─ preloaded.lc     optional preloaded file
+├─ solution.lc      submitted solution file
+└─ test.js          tests
+```
+
+See `Dockerfile` and `examples/`.

package.json

@@ -0,0 +1,9 @@
+import { readFileSync } from "fs";
+
+const read = (path) => readFileSync(new URL(path, import.meta.url), {encoding: "utf8"});
+
+/** Return the contents of the solution file */
+export const solution = () => read("./solution.lc");
+
+/** Return the contents of the optional preloaded file */
+export const preloaded = () => read("./preloaded.lc");