https://github.com/arximboldi/heterarchy
Cooperative multiple inheritance for CoffeeScript, à-la Python. http://sinusoid.es/heterarchy/
https://github.com/arximboldi/heterarchy
c3 coffeescript heterarchy linearization multiple-inheritance python
Last synced: 11 months ago
JSON representation
Cooperative multiple inheritance for CoffeeScript, à-la Python. http://sinusoid.es/heterarchy/
- Host: GitHub
- URL: https://github.com/arximboldi/heterarchy
- Owner: arximboldi
- License: mit
- Created: 2015-05-25T18:39:27.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-10T09:04:51.000Z (about 9 years ago)
- Last Synced: 2025-03-31T20:12:05.010Z (about 1 year ago)
- Topics: c3, coffeescript, heterarchy, linearization, multiple-inheritance, python
- Language: CoffeeScript
- Homepage:
- Size: 304 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
heterarchy
==========
Cooperative multiple inheritance for CoffeeScript, à-la Python.
Adds multiple inheritance support to CoffeeScript (and JavaScript).
It uses the C3 linearization algorithm as described in the [famous
Dylan paper](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.19.3910&rep=rep1&type=pdf).
Example
-------
The library handles multiple inheritance and chains calls to `super`
in a linear order, solving the diamond problem and allowing for
[cooperative methods](http://www.artima.com/weblogs/viewpost.jsp?thread=281127). For
example, the following class heterarchy:
Can be implemented with the following code.
```coffee
{multi} = require 'heterarchy'
class A
method: -> "A"
class B extends A
method: -> "B > #{super}"
class C extends A
method: -> "C > #{super}"
class D extends multi B, C
method: -> "D > #{super}"
```
Calling `method` on a `D` instance would return the string `D > B > C > A`
showing the class linearization.
Documentation
-------------
### API
* [heterarchy][heterarchy]
GitHub: [heterarchy.litcoffee](https://github.com/arximboldi/heterarchy/blob/master/heterarchy.litcoffee)
### Tests
* [spec.heterarchy][spec.heterarchy]
GitHub: [heterarchy.spec.coffee](https://github.com/arximboldi/heterarchy/blob/master/test/heterarchy.spec.coffee)
[heterarchy]: http://sinusoid.es/heterarchy/heterarchy.html
[spec.heterarchy]: http://sinusoid.es/heterarchy/test/heterarchy.spec.html
Installation
------------
This is a standard [Node.JS](http://nodejs.org) module. One may
install the library with:
> npm install heterarchy
### Usage in the browser
After cloning or downloading the repository
you can build all necessary files with
> make
This will create `heterarchy.js` in the `lib/` folder. Including that
file in the browser will result in a global `heterarchy` variable that
contains the normally exported functions.
Since the library requires `underscorejs` you must include it before
`heterarchy`. The functions that are used from `underscorejs` are (in
case you don't need the entire library):
```
head, tail, map, find, some, without, isEmpty,
every, memoize, reject, isEqual, reduce
```
#### Example
```html
```
where `my_app.coffee` could be
```coffee
class A
method: -> "A"
class B extends A
method: -> "B > #{super}"
class C extends A
method: -> "C > #{super}"
# note the heterarchy namespace
class D extends heterarchy.multi B, C
method: -> "D > #{super}"
```
Contributors
------------
This library is maintained by [**Juanpe Bolivar**](http://sinusoid.es),
with the help of these outstanding contributors:
- **Jim Neuedorf** [@jneuendorf](https://github.com/jneuendorf)
Added support for class methods, global exports in the browser and
fixed various issues.
License
-------
*Heterarchy* is [Free Software][free-software] and is distributed
under the MIT license (see LICENSE).
[free-software]: http://www.gnu.org/philosophy/free-sw.html
> Copyright (c) 2013, 2015 Juan Pedro Bolivar Puente
>
> 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.