less-arbitrary: Linear time testing with variant of Arbitrary class that always terminates.

[ bsd3, library, web ] [ Propose Tags ]

Ever found non-terminating Arbitrary instance? Ever wondered what would be a runtime cost of particular Arbitrary instance?

Never let it bother you again: this variant of Arbitrary is automatically generating instances, and allows you to see predictable linear time generators for most types (providing that you have any terminating constructor, that is constructor that does not go deeper into the data structure.)

Usage:

import Test.LessArbitrary

data MyDataType = ...
  deriving (Show, Generic)

instance LessArbitrary MyDataType
instance Arbitrary where
 arbitrary = fasterArbitrary

[Skip to Readme]
Versions [RSS] [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.1.0, 0.1.2.0, 0.1.3.0, 0.1.4.0, 0.1.5.0, 0.1.6.0, 0.1.7.0
Change log CHANGELOG.md
Dependencies base (>=4.5 && <=4.15), containers, email-validate, generic-arbitrary, genvalidity, genvalidity-hspec, genvalidity-property, hashable, hspec, mtl, QuickCheck, quickcheck-classes, random, scientific, text, time, transformers, unordered-containers, validity, vector [details]
License BSD-3-Clause
Author Michał J. Gajda <mjgajda@migamake.com>
Maintainer Michał J. Gajda <mjgajda@migamake.com>
Category Web
Home page https://github.com/mgajda/less-arbitrary#readme
Bug tracker https://github.com/mgajda/less-arbitrary/issues
Source repo head: git clone https://github.com/mgajda/less-arbitrary
Uploaded by MichalGajda at 2021-01-12T16:49:26Z
Distributions NixOS:0.1.7.0
Downloads 412 total (20 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-01-12 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for less-arbitrary-0.1.7.0

[back to package description]

Introduction

This is way to write arbitrary instances that should terminate in linear time with respect to budget, or throw an error instead when they go over budget and it is unclear how to terminate data structure.

Usage

Just try:

import Test.LessArbitrary

data MyDataType = ...
  deriving (Generic)

instance LessArbitrary MyDataType
instance Arbitrary MyDataType where
  arbitrary = fasterArbitrary

How it is done?

It is simply putting a monad that tracks the cost of constructors generated so far, and throw an error when it goes too far. Goes for mutually recursive data structures with at least one terminating constructor available.

Not to be used on non-terminating lazy data structures.

Documentation build

To build detailed article on implementation, you would need:

  • pandoc
  • xelatex with standard science article packages
    • easiest to get as MacTeX on Mac
    • apt-get install -y texlive-recommended on Ubuntu
  • pandoc-hide-codeblocks filter to hide unnecessary code blocks (optional)

Hacker's guide

Entire Haskell code is in literate markdown less-arbitrary.md. In order to work with it you will need entangled literate programming daemon that synchronizes source files with the literate source.

It is bidirectional.

git clone https://github.com/entangled/entangled --branch develop
cd entangled;
cabal install # or stack install
entangled daemon