Browse Source

Set up testing with Ava

master
Glen Whitney 2 years ago
parent
commit
c3995d6fcb
  1. 3
      .gitignore
  2. 6
      coffeetest/external.coffee
  3. 3843
      package-lock.json
  4. 34
      package.json
  5. 14
      src/dyna3.litcoffee
  6. 15
      src/helpers/pkglock_to_externals.litcoffee

3
.gitignore

@ -1,4 +1,7 @@
node_modules
site
docbuild
__tests__
coverage
dyna3.zip
*~

6
coffeetest/external.coffee

@ -0,0 +1,6 @@
import test from 'ava'
import {three, threeLoaded} from '../site/externals.js'
test "load three", (t) ->
await threeLoaded
t.not(three, null, 'three loaded successfully')

3843
package-lock.json

File diff suppressed because it is too large

34
package.json

@ -2,25 +2,22 @@
"name": "dyna3",
"version": "0.1.0",
"description": "Constraint-based three-dimensional dynamic geometry",
"private": "true",
"private": "true",
"main": "dyna3.js",
"scripts": {
"clean": "rm -rf site docbuild",
"doc:extra":
"mkdir -p docbuild && coffee src/helpers/pkglock_to_externals.litcoffee --doc > docbuild/extlist.md",
"doc:collate":
"mkdir -p site/doc && coffee doc/gendoc.litcoffee > site/doc/dyna3.md",
"clean": "rm -rf site docbuild dyna3.zip",
"doc:extra": "mkdir -p docbuild && coffee src/helpers/pkglock_to_externals.litcoffee --doc > docbuild/extlist.md",
"doc:collate": "mkdir -p site/doc && coffee doc/gendoc.litcoffee > site/doc/dyna3.md",
"doc": "npm run doc:extra && npm run doc:collate",
"prebuild": "npm run clean",
"build:coffee": "coffee -o site -c -m src/*.litcoffee",
"build:ext":
"coffee src/helpers/pkglock_to_externals.litcoffee > site/externals.js",
"build:doc":
"npm run doc && pandoc -s --toc site/doc/dyna3.md > site/doc/dyna3.html",
"build:ext": "coffee src/helpers/pkglock_to_externals.litcoffee > site/externals.js",
"build:doc": "npm run doc && pandoc -s --toc site/doc/dyna3.md > site/doc/dyna3.html",
"build:copy": "cp src/*.html site && cp -r node_modules site",
"build":
"npm run build:coffee && npm run build:ext && npm run build:doc && npm run build:copy",
"test": "qunit"
"build": "npm run build:coffee && npm run build:ext && npm run build:doc && npm run build:copy",
"dist": "npm run build && zip -r dyna3.zip site",
"pretest": "npm run build && coffee -o __tests__ -c -m coffeetest/*.coffee",
"test": "ava"
},
"repository": {
"type": "git",
@ -35,5 +32,14 @@
"dependencies": {
"three": "latest"
},
"//": "See doc/tech.md for an overview of the technical structure of dyna3"
"//": "See doc/tech.md for an overview of the technical structure of dyna3",
"devDependencies": {
"ava": "^2.4.0",
"esm": "^3.2.25"
},
"ava": {
"require": [
"esm"
]
}
}

14
src/dyna3.litcoffee

@ -5,23 +5,23 @@ When you load dyna3, you should initially see a three-dimensional coordinate sys
import {threeLoaded, three as J3} from './externals.js'
main = () ->
main = ->
renderer = new J3.WebGLRenderer()
rwd = window.innerWidth
rht = window.innerHeight
renderer.setSize(rwd, rht)
renderer.setSize rwd, rht
document.body.appendChild renderer.domElement
scene = new J3.Scene()
geometry = new J3.SphereBufferGeometry(1, 5, 5)
geometry = new J3.SphereBufferGeometry 1,5,5
material = new J3.MeshBasicMaterial {color: 0xff00ff}
ball = new J3.Mesh(geometry, material)
ball = new J3.Mesh geometry, material
scene.add ball
camera = new J3.PerspectiveCamera(75, rwd/rht, 0.1, 1000)
camera = new J3.PerspectiveCamera 75, rwd/rht, 0.1, 1000
camera.position.z = 5
renderer.render(scene, camera)
renderer.render scene, camera
threeLoaded.then(main)
threeLoaded.then main
```

15
src/helpers/pkglock_to_externals.litcoffee

@ -2,14 +2,15 @@
### External dependencies
The dyna3 program depends on some externally-maintained JavaScript libraries/modules. The package uses npm to track these external dependencies. A module externals.js is automatically generated from the package_lock.json file created by npm to load the necessary modules at runtime.
The dyna3 program depends on some externally-maintained JavaScript libraries/modules. The package uses npm to track these external dependencies. A module externals.js is automatically generated from the package.json and package_lock.json files created by npm to load the necessary modules at runtime.
The generation is performed by pkglock_to_externals.litcoffee, which also records the main importable file within the library, as there does not seem to be a systematic way to generate that filename from the module name.
Specific packages/implementation approaches for components of dyna3 include the following items. All packages are obtained from npm unless otherwise noted.
- for conversion of markdown to HTML: pandoc
- For a test harness for the package: QUnit
- For a test harness for the package: Ava
- When a point is reached at which there is a need to test in-browser behavior, ava can call Puppeteer as per https://github.com/avajs/ava/blob/master/docs/recipes/puppeteer.md
- For WebGL rendering of the 3D view of the geometry: three
```javascript
@ -31,9 +32,9 @@ And here is the current complete list of external libraries on which operation o
"""
process.stdout.write header
fs = require 'fs'
pl = fs.readFileSync 'package-lock.json'
pdata = JSON.parse pl
for dep in Object.keys pdata.dependencies
pkdata = JSON.parse fs.readFileSync 'package.json'
pldata = JSON.parse fs.readFileSync 'package-lock.json'
for dep in Object.keys pkdata.dependencies
if process.argv.length > 2
process.stdout.write "- #{dep}\n"
else
@ -43,10 +44,11 @@ And here is the current complete list of external libraries on which operation o
export var #{dep}Loaded = new Promise(async function(resolve, reject) {
var success = false;
try {
#{dep} = await import('https://cdn.jsdelivr.net/npm/#{dep}@#{pdata.dependencies[dep].version}/#{importable[dep]}');
#{dep} = await import('https://cdn.jsdelivr.net/npm/#{dep}@#{pldata.dependencies[dep].version}/#{importable[dep]}');
console.log('CDN import of #{dep} module OK');
success = true;
} catch(err) {
console.log('CDN import of #{dep} failed: ' + JSON.stringify(err));
try {
#{dep} = await import('./node_modules/#{dep}/#{importable[dep]}');
success = true;
@ -56,7 +58,6 @@ And here is the current complete list of external libraries on which operation o
}
if (success) { resolve(); } else { reject(); }
});
"""
process.stdout.write block

Loading…
Cancel
Save