Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xsc/stateful
Stateful Generators for Clojure's test.check
https://github.com/xsc/stateful
Last synced: 27 days ago
JSON representation
Stateful Generators for Clojure's test.check
- Host: GitHub
- URL: https://github.com/xsc/stateful
- Owner: xsc
- License: mit
- Created: 2016-12-29T12:41:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-21T23:50:16.000Z (over 7 years ago)
- Last Synced: 2024-04-13T20:55:22.272Z (7 months ago)
- Language: Clojure
- Homepage: https://xsc.github.io/stateful/
- Size: 78.1 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stateful
__[Documentation](https://xsc.github.io/stateful/)__
__stateful__ is an extension to Clojure's [test.check][test-check], providing a
way to communicate state between generators. This allows you to more easily
generate data with internal dependencies or track properties of generated
values.
[](https://travis-ci.org/xsc/stateful)
[](https://clojars.org/xsc/stateful)
Note that, just like with `bind`, shrinking efficiency might suffer in cases
where you depend on the state influenced by other generators to generate new
values. This means that this library should mainly be used to track generation
metadata, like building the expected return value of some function together with
its input.
[test-check]: https://github.com/clojure/test.check
## Quickstart
__stateful__ allows you to have an implicit state value available in your
test.check generators by wrapping them using `stateful/generator`.
```clojure
(require '[stateful.core :as stateful]
'[clojure.test.check.generators :as gen])
```
You can manipulate the state using e.g. `stateful/return` and its variants:
```clojure
(def ascending-integers
(stateful/generator
(gen/vector
(gen/let [delta gen/s-pos-int
previous (stateful/value [:previous])]
(let [value (+ delta previous)]
(stateful/return value {:previous value}))))
{:previous 0}))
```
The above example will use the state's `:previous` key (initialized with `0`) to
remember the previous value, increasing it by `delta` for each new vector
element:
```clojure
(gen/generate ascending-integers)
;; => [30 60 82 96 120 140 167 191 220 236 267 291 314 336 349 369 379 392]
```
You can use the `state` and `value` generators to inspect the state, e.g. to
return the whole map as part of a value/state tuple:
```clojure
(gen/generate
(stateful/generator
(gen/tuple ascending-integers (stateful/state))
{:top-level? true}))
;; => [[6 29] {:previous 29, :top-level? true}]
```
As you can see here, the scopes of nested stateful generators merge, so you
might want to use namespaced keywords to avoid clashes within the state.
## License
```
MIT License
Copyright (c) 2016 Yannick Scherer
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.
```