Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonoel/plop
Imperative programming primitives for Clojure
https://github.com/leonoel/plop
clojure clojurescript
Last synced: 2 months ago
JSON representation
Imperative programming primitives for Clojure
- Host: GitHub
- URL: https://github.com/leonoel/plop
- Owner: leonoel
- License: epl-1.0
- Created: 2017-11-01T08:01:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-01T16:19:10.000Z (over 6 years ago)
- Last Synced: 2024-09-17T03:10:26.905Z (4 months ago)
- Topics: clojure, clojurescript
- Language: Clojure
- Size: 19.5 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# plop
Facilities for imperative programming in Clojure.
## Rationale
> There still is a role for that, and there will always be a role for that. And one way to talk about when that's appropriate is this notion of birthing process. A point in time where you're starting to create a new value, \[...\] and in setting up that value you need to manipulate memory for instance, you need to manipulate places. That's completely OK. I would never advocate languages that didn't let you, for instance, manipulate the contents of an array, because during this process, you need to be able to do that in order to write efficient programs. But this birthing process is a window that ends, and it ends whenever the thing that you've made is going to become visible to any other part of your program. At that point, it's become a fact, it's become perceptible, and then you have to stop doing place oriented programming, because \[...\] it's not a fit for the models we're trying to build. So, this use of place to create values, or this use of place to represent values under the hood is an implementation detail. Of course we have to use places, computers have memory and they have disks. But what's important is that a program is not about places, right ? It's Information Technology, it's not Technology Technology, right ? We've taken abstractions of the technology and raised them up to being what the program is about, and that's an error. There was a reason why we had to do it but we don't anymore. - Rich Hickey, [The value of values](https://www.infoq.com/presentations/Value-Values)
## Maturity
Alpha. Users should expect breaking changes in future versions.
## Installation
Artifacts are released to [clojars](https://clojars.org/plop).
Current coordinates : `[plop "a.4"]`
## Documentation
Single API namespace : `plop.core`.
```clj
(require '(plop.core :refer [place local setting]))
```
### place
Defines a set of lexically scoped variables. Variables are bound to optionally type-hinted symbols, hold a reference to a value, are implicitly dereferenced each time they are accessed, and are assignable with `set!`.
The state of variables is not synchronized. This is a dangerous, expert-only feature, and if the implications of unsynchronized mutable state publication are not obvious to you, you should not use this macro.
Syntax :
```clj
(place [symbol1 init-expression1
symbol2 init-expression2
,,,]
body-expression1
body-expression2
,,,)
```
A location is first created to store the current state of each variable. Then initialization expressions are evaluated sequentially, each result being assigned to its variable. Finally the body is evaluated and the result of last expression is returned.
Binding scope differs from `let` in that every variable defined in the block is scoped to the whole block. That is, a initialization expression may refer to its own variable or to another variable defined later in the block.
### local
Defines a set of thread local lexically scoped variables. Variables are bound to optionally type-hinted symbols, hold a reference to a value, are implicitly dereferenced each time they are accessed, and are assignable with `set!`.
Syntax :
```clj
(local [symbol1 init-expression1
symbol2 init-expression2
,,,]
body-expression1
body-expression2
,,,)
```
### setting
Captures current values of a set of variables, assigns them to new values, executes body, then reassigns them to old values and returns the result of body execution. Assignments are made with `set!`.
Syntax :
```clj
(setting [variable1 value1
variable2 value2
,,,]
body-expression1
body-expression2
,,,)
```
## License
Licensed under the [Eclipse Public License](http://www.eclipse.org/legal/epl-v10.html) (the same as Clojure)