Skip to content
This repository has been archived by the owner on Dec 16, 2023. It is now read-only.

Latest commit

 

History

History
94 lines (61 loc) · 2.86 KB

guts.md

File metadata and controls

94 lines (61 loc) · 2.86 KB
Raw

guts-zombie.js(1) -- The Guts

Hacking

To get started hacking on Zombie.js you'll need Node.js, NPM and CoffeeScript:

$ brew install node npm
$ npm install coffee-script

If you're installing Zombie as an NPM module and want both runtime and development dependencies, run npm install zombie --dev.

If you prefer to work from the source directory, you can use cake setup:

$ git clone git@github.com:assaf/zombie.git
$ cd zombie
$ cake setup

To help isolate your development environment, cake setup installs all runtime and development dependencies into the directory node_modules by running npm bundle. To see which dependencies are installed, run npm bundle list installed (not npm list installed).

To run the test suite:

$ cake test

If you're hacking on Zombie and testing it in a different project, you can "install" your working directory using npm link. Keep in mind, though, Zombie is written in CoffeeScript ad your project is loading the compiled JavaScript. You need to keep both synchronized by running cake build or cake watch.

Install the working directory and have all changes compiled in real-time:

$ npm link && cake watch

To generate the documentation:

$ cake doc:pages
$ open html/index.html

Grocking

Zombie.js is written in CoffeeScript, a language that mixes the best parts of Python and Ruby and compiles one-to-one into JavaScript.

The DOM implementation is JSDOM, which provides an emulation of DOM Level 3. There are some issues and some features Zombie.js needs but JSDOM doesn't care for. Those are patched onto JSDOM in lib/zombie/jsdom_patches.coffee and lib/zombie/forms.coffee.

HTML5 parsing is handled by HTML5.

DOM selectors are provided by JSDOM using Sizzle.js.

Testing

Zombie.js is tested using Vows.

Since we're testing a Web browser, we also need a Web server, so it spins up an instance of Express. Spinning up Express and making sure it doesn't power down before all tests are done (Vows is asynchronous, like everything in Node) is the responsibility of spec/helper.coffee.

To stress Zombie.js, we have test cases that use Sammy.js and jQuery. The scripts themselves are contained in the spec/.scripts directory. The dot is necessary to hide these JS files from Vows.

Documenting

Zombie.js documentation is written in Markdown.

Everything you need to know to get started is covered by README.md, so it shows up when you visit the Github page.

Additional documentation lives in the doc directory. Annotated source code generated using Docco.