https://github.com/cmeiklejohn/shafty

ClojureScript functional reactive programming library.
https://github.com/cmeiklejohn/shafty

Last synced: about 2 months ago
JSON representation

ClojureScript functional reactive programming library.

• Host: GitHub
• URL: https://github.com/cmeiklejohn/shafty
• Owner: cmeiklejohn
• License: epl-1.0
• Created: 2012-11-06T23:50:14.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-06-07T18:13:19.000Z (over 11 years ago)
• Last Synced: 2024-10-06T17:01:33.939Z (3 months ago)
• Language: Clojure
• Homepage: http://cmeiklejohn.github.io/shafty/
• Size: 647 KB
• Stars: 49
• Watchers: 11
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.html

Awesome Lists containing this project

README

        
# shafty

ClojureScript functional reactive programming library inspired by [Flapjax](http://www.flapjax-lang.com/).  Shafty provides the core abstractions provided by Flapjax for dataflow programming with reactive values, however does not provide the DOM manipulation abstractions provided by Flapjax.

## Disclaimer

Shafty is currently under development and the API is subject to change.

Get in touch if you are interested in helping out.

## Motivation

Shafty aims to bring a native implementation of composable behaviours and event streams to ClojureScript as a micro-library which can be used to build larger reactive applications.  The long-term goal is to provide a Clojure implementation which can be used in both server-side and client-side applications.

## Concepts

### Events

Events represent time-varying functions which have a finite set of

occurences over time.

### Behaviours

Behaviours are time-varying functions which constantly have a value.

Derive a behaviour from an event, or generate a receiver to watch a

particular DOM element, such as an input field.

## API Reference

As Shafty is heavily inspired by Flapjax, provided below is an API reference outlining which parts of the Flapjax API have been implemented and what the equivalent function name is in Shafty.  Some of the functions have similar mappings leveraging Clojure's protocols.

The combinators below appear in the order of the appearance of each in the Flapjax implementation.

F.Event         | shafty.core.Event | F.Behavior   | shafty.core.Behaviour

--------------- | ----------------- | ------------ | ---------------------

sendEvent       | send!             | startsWith   | hold!

mergeE          | merge!            | valueNow     | cljs.core.deref

constantE       | constant!         | changes      | changes!

bindE           | bind!             | switchB      | switch!

mapE            | map!              | timerB       | timer! / hold!

notE            | not!              | delayB       | delay!

filterE         | filter!           | sendBehavior | send!

onceE           | once!             | liftB        | lift!

skipFirstE      | skip-first!       | notB         | not!

collectE        | collect!          | blindB       | blind!

switchE         | switch!           | calmB        | calm!

delayE          | delay!

snapshotE       | snapshot!

filterRepeatsE  | filter-repeats!

calmE           | calm!

blindE          | blind!

timerE          | timer!

## References

* Elliott, [_Push-Pull Functional Reactive Programming_](http://dl.acm.org/citation.cfm?id=1596643)

* Meyerovich, [_Flapjax: Functional Reactive Web Programming_](http://www.cs.brown.edu/research/pubs/theses/ugrad/2007/lmeyerov.pdf)

* Meyerovich, Guha, Baskin, Cooper, Greenberg, Bromfield,  Krishnamurthi, [_Flapjax: A Programming Language for Ajax Applications_](http://dl.acm.org/citation.cfm?id=1640091)

## The Name

* [Shafty, Island Tour, '98, Providence, RI.](http://www.youtube.com/watch?v=AZO2_u0jmZk)

## License

Copyright (C) 2012 Christopher Meiklejohn.

Distributed under the Eclipse Public License, the same as Clojure.