aeson-match-qq: Declarative JSON matchers.

[ bsd2, library, web ] [ Propose Tags ]

See README.markdown


[Skip to Readme]
Versions [faq] 1.0.0, 1.1.0, 1.2.0
Change log CHANGELOG.markdown
Dependencies aeson, attoparsec, base (>=4.11 && <5), bytestring, either, haskell-src-meta, scientific, template-haskell, text, unordered-containers, vector [details]
License BSD-2-Clause
Copyright Matvey Aksenov 2020
Author
Maintainer matvey.aksenov@gmail.com
Category Web
Home page https://github.com/supki/aeson-match-qq#readme
Bug tracker https://github.com/supki/aeson-match-qq/issues
Source repo head: git clone https://github.com/supki/aeson-match-qq
Uploaded by MatveyAksenov at 2020-03-19T15:23:04Z
Distributions NixOS:1.2.0
Downloads 512 total (8 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 2020-03-19 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for aeson-match-qq-1.2.0

[back to package description]

aeson-match-qq

Build status

Declarative JSON matchers.

Motivation

When testing an HTTP service that spouts JSON documents, it's often inconvenient to write out the whole response as the expected value. Sometimes, you only care about a couple specific properties, or simply want to ensure that the response has certain structure. This package provides a quasiquoter to define declarative matchers using a variation of the familiar syntax.

Features

Basic JSON construction

Since this package is heavily inspired by aeson-qq, the parser tries to follow its behavior and has support for optional quotes for simple keys and the #{exp} syntax for Haskell expression interpolation. It currently does not support variable keys though and there are no plans to add them.

Spread-like syntax for arrays and objects

This syntax allows you to match only the part of the structure you care about:

[match| [1, 2, 3, ...] |] matches arrays starting with [1, 2, 3]
[match| {foo: 1, bar: 2, ...} |] matches objects that are supersets of {foo: 1, bar: 2}

Holes

Holes are placeholders that match anything:

[match| _ |] matches any JSON document
[match| {foo: _} |] matches any object that has the foo property.

If a hole is named, its value will be returned from match

[match| {foo: {bar: _n} |] will return {n: 4} if matched with {foo: {bar: 4}}