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

Commit

Permalink
Initial commmit
Browse files Browse the repository at this point in the history
  • Loading branch information
robotlolita committed Nov 26, 2013
0 parents commit 24be0ea
Show file tree
Hide file tree
Showing 12 changed files with 420 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*.orig
node_modules
lib
dist
npm-debug.log
docs/literate
7 changes: 7 additions & 0 deletions .hgignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
syntax: glob
*.orig
node_modules
lib
dist
npm-debug.log
docs/literate
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
language: node_js
node_js:
- "0.10"
- "0.8"
- "0.6"
21 changes: 21 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License

Copyright (c) 2013 Quildreen Motta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
63 changes: 63 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
bin = $(shell npm bin)
lsc = $(bin)/lsc
browserify = $(bin)/browserify
groc = $(bin)/groc
uglify = $(bin)/uglifyjs
VERSION = $(shell node -e 'console.log(require("./package.json").version)')


lib: src/*.ls
$(lsc) -o lib -c src/*.ls

dist:
mkdir -p dist

dist/control.async.umd.js: compile dist
$(browserify) lib/index.js --standalone Async > $@

dist/control.async.umd.min.js: dist/control.async.umd.js
$(uglify) --mangle - < $^ > $@

# ----------------------------------------------------------------------
bundle: dist/control.async.umd.js

minify: dist/control.async.umd.min.js

compile: lib

documentation:
$(groc) --index "README.md" \
--out "docs/literate" \
src/*.ls test/*.ls test/specs/**.ls README.md

clean:
rm -rf dist build lib

test:
$(lsc) test/tap.ls

package: compile documentation bundle minify
mkdir -p dist/control.async-$(VERSION)
cp -r docs/literate dist/control.async-$(VERSION)/docs
cp -r lib dist/control.async-$(VERSION)
cp dist/*.js dist/control.async-$(VERSION)
cp package.json dist/control.async-$(VERSION)
cp README.md dist/control.async-$(VERSION)
cp LICENCE dist/control.async-$(VERSION)
cd dist && tar -czf control.async-$(VERSION).tar.gz control.async-$(VERSION)

publish: clean
npm install
npm publish

bump:
node tools/bump-version.js $$VERSION_BUMP

bump-feature:
VERSION_BUMP=FEATURE $(MAKE) bump

bump-major:
VERSION_BUMP=MAJOR $(MAKE) bump


.PHONY: test
106 changes: 106 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
control.async
=============

[![Build Status](https://secure.travis-ci.org/folktale/control.async.png?branch=master)](https://travis-ci.org/folktale/control.async)
[![NPM version](https://badge.fury.io/js/control.async.png)](http://badge.fury.io/js/control.async)
[![Dependencies Status](https://david-dm.org/folktale/control.async.png)](https://david-dm.org/folktale/control.async)
[![experimental](http://hughsk.github.io/stability-badges/dist/experimental.svg)](http://github.com/hughsk/stability-badges)


Operations for asynchronous control flow.


## Example

```js
( ... )
```


## Installing

The easiest way is to grab it from NPM. If you're running in a Browser
environment, you can use [Browserify][]

$ npm install control.async


### Using with CommonJS

If you're not using NPM, [Download the latest release][release], and require
the `control.async.umd.js` file:

```js
var Async = require('control.async')
```


### Using with AMD

[Download the latest release][release], and require the `control.async.umd.js`
file:

```js
require(['control.async'], function(Async) {
( ... )
})
```


### Using without modules

[Download the latest release][release], and load the `control.async.umd.js`
file. The properties are exposed in the global `Async` object:

```html
<script src="/path/to/control.async.umd.js"></script>
```


### Compiling from source

If you want to compile this library from the source, you'll need [Git][],
[Make][], [Node.js][], and run the following commands:

$ git clone git://github.com/folktale/control.async.git
$ cd control.async
$ npm install
$ make bundle

This will generate the `dist/control.async.umd.js` file, which you can load in
any JavaScript environment.


## Documentation

You can [read the documentation online][docs] or build it yourself:

$ git clone git://github.com/folktale/monads.maybe.git
$ cd monads.maybe
$ npm install
$ make documentation

Then open the file `docs/literate/index.html` in your browser.


## Platform support

This library assumes an ES5 environment, but can be easily supported in ES3
platforms by the use of shims. Just include [es5-shim][] :)


## Licence

Copyright (c) 2013 Quildreen Motta.

Released under the [MIT licence](https://github.com/folktale/control.async/blob/master/LICENCE).

<!-- links -->
[Fantasy Land]: https://github.com/fantasyland/fantasy-land
[Browserify]: http://browserify.org/
[release]: https://github.com/folktale/control.async/releases/download/v0.0.0/control.async-0.0.0.tar.gz
[Git]: http://git-scm.com/
[Make]: http://www.gnu.org/software/make/
[Node.js]: http://nodejs.org/
[es5-shim]: https://github.com/kriskowal/es5-shim
[docs]: http://folktale.github.io/control.async
33 changes: 33 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"name": "control.async",
"version": "0.0.0",
"description": "Operations for asynchronous control flow.",
"main": "lib/index.js",
"scripts": {
"test": "make test",
"prepublish": "make compile"
},
"repository": {
"type": "git",
"url": "https://github.com/folktale/control.async"
},
"keywords": [
"fantasy-land",
"folktale"
],
"author": "Quildreen Motta",
"license": "MIT",
"bugs": {
"url": "https://github.com/folktale/control.async/issues"
},
"dependencies": {},
"devDependencies": {
"browserify": "~2.35.4",
"groc": "git://github.com/killdream/groc#patch-livescript",
"LiveScript": "~1.2.0",
"hifive-tap": "~0.1.0",
"hifive": "~0.1.0",
"uglify-js": "~2.4.3",
"laws": "~0.2.0"
}
}
26 changes: 26 additions & 0 deletions src/index.ls
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# # control.async

/** ^
* Copyright (c) 2013 Quildreen Motta
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

# Operations for asynchronous control flow.
30 changes: 30 additions & 0 deletions test/specs/index.ls
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# # Entry point for the specifications

/** ^
* Copyright (c) 2013 Quildreen Motta
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

module.exports = [
# The specification objects go here
# See: http://hifivejs.github.io/hifive/getting-started.html
require './monad-laws'
]
70 changes: 70 additions & 0 deletions test/specs/monad-laws.ls
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# # Specification for the monadic laws

/** ^
* Copyright (c) 2013 Quildreen Motta
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation files
* (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge,
* publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

# Before we define the specification, we need to set up the specs
# libraries, and grab a hold of our data structure and the laws we want
# to verify.
spec = (require 'hifive')!
laws = require 'laws'
Async = require '../../src/'

# And to use the laws, we need to provide a constructor function, that
# given a single argument will return a new data structure containing
# that argument. We also make sure that the constructor for our
# semigroup implementation lifts the value into a non empty list, so we
# can concatenate the values.
make = (a) -> new Async a
make-nel = (a) -> new Async [a]

# Then we provide the specification for the test runner. As we're using
# Hifive here, it expects that each definition for the specification to
# have a function that will throw exceptions on failures. We use the
# `asTest` property from Claire that returns exactly what Hifive (and
# Mocha & other testing libraries) expect.
module.exports = spec 'Algebraic laws' (o, spec) ->

spec ': Semigroup' (o) ->
o '1. Associativity' laws.semigroup.associativity(make-nel).as-test!

spec ': Monoid' (o) ->
o '1. Right identity' laws.monoid.right-identity(make).as-test!
o '2. Left identity' laws.monoid.left-identity(make).as-test!

spec ': Functor' (o) ->
o '1. Identity' laws.functor.identity(make).as-test!
o '2. Composition' laws.functor.composition(make).as-test!

spec ': Applicative' (o) ->
o '1. Identity' laws.applicative.identity(make).as-test!
o '2. Composition' laws.applicative.composition(make).as-test!
o '3. Homomorphism' laws.applicative.homomorphism(make).as-test!
o '4. Interchange' laws.applicative.interchange(make).as-test!

spec ': Chain' (o) ->
o '1. Associativity' laws.chain.associativity(make).as-test!

spec ': Monad' (o) ->
o '1. Left identity' laws.monad.left-identity(make).as-test!
o '2. Right identity' laws.monad.right-identity(make).as-test!
Loading

0 comments on commit 24be0ea

Please sign in to comment.