The snap-core package

[Tags:bsd3, library, test]

Snap is a simple and fast web development framework and server written in Haskell. For more information or to download the latest version, you can visit the Snap project website at http://snapframework.com/.

This library contains the core definitions and types for the Snap framework, including:

1. Primitive types and functions for HTTP (requests, responses, cookies, post/query parameters, etc)

2. Type aliases and helper functions for Iteratee I/O

3. A monad for programming web handlers called "Snap", which allows:

Quick start: The Snap monad and HTTP definitions are in Snap.Core, some iteratee utilities are in Snap.Iteratee.


[Skip to Readme]

Properties

Versions 0.1.1, 0.1.2, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.2.7, 0.2.7.1, 0.2.8, 0.2.8.1, 0.2.9, 0.2.10, 0.2.11, 0.2.12, 0.2.13, 0.2.14, 0.2.15, 0.2.15.1, 0.2.16, 0.3.0, 0.3.1, 0.3.1.1, 0.4.0, 0.4.0.1, 0.4.0.2, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.5.1, 0.5.1.1, 0.5.1.2, 0.5.1.3, 0.5.1.4, 0.5.2, 0.5.3, 0.5.3.1, 0.5.4, 0.5.5, 0.6.0, 0.6.0.1, 0.7, 0.7.0.1, 0.8.0, 0.8.0.1, 0.8.1, 0.9.0, 0.9.2, 0.9.2.1, 0.9.2.2, 0.9.3, 0.9.3.1, 0.9.4.0, 0.9.4.1, 0.9.5.0, 0.9.6.0, 0.9.6.1, 0.9.6.2, 0.9.6.3, 0.9.6.4, 0.9.7.0, 0.9.7.2, 0.9.8.0, 1.0.0.0
Dependencies attoparsec (>=0.10 && <0.12), attoparsec-enumerator (==0.3.*), base (>=4 && <4.7), blaze-builder (>=0.2.1.4 && <0.4), blaze-builder-enumerator (==0.2.*), bytestring (>=0.9 && <0.11), bytestring-mmap (>=0.2.2 && <0.3), case-insensitive (>=0.3 && <1.2), containers (>=0.3 && <1.0), deepseq (>=1.1 && <1.4), directory (==1.*), enumerator (>=0.4.15 && <0.5), filepath (>=1.1 && <2.0), hashable (==1.1.* || >=1.2.1 && <1.3), HUnit (>=1.2 && <2), MonadCatchIO-transformers (>=0.2.1 && <0.4), mtl (>=2.0 && <2.2), old-locale (==1.*), random (==1.*), regex-posix (>=0.95 && <1), text (>=0.11 && <1.2), time (>=1.0 && <1.5), unix (>=2.4 && <3.0), unix-compat (>=0.2 && <0.5), unordered-containers (>=0.1.4.3 && <0.3), vector (>=0.6 && <0.11), zlib-enum (>=0.2.1 && <0.3) [details]
License BSD3
Author James Sanders, Shu-yu Guo, Gregory Collins, Doug Beardsley
Maintainer snap@snapframework.com
Stability Unknown
Category Web, Snap
Home page http://snapframework.com/
Source repository head: git clone git://github.com/snapframework/snap-core.git
Uploaded Mon Jan 13 16:13:05 UTC 2014 by GregoryCollins
Updated Thu Jan 8 07:23:29 UTC 2015 by HerbertValerioRiedel to revision 1
Distributions Debian:0.9.8.0, Fedora:0.9.6.4, FreeBSD:0.9.7.2, LTSHaskell:0.9.8.0, NixOS:1.0.0.0, Stackage:1.0.0.0, Tumbleweed:0.9.8.0
Downloads 40568 total (222 in the last 30 days)
Votes
2 []
Status Docs available [build log]
Successful builds reported [all 1 reports]

Modules

[Index]

Flags

NameDescriptionDefaultType
portableCompile in cross-platform mode. No platform-specific code or optimizations such as C routines will be used.DisabledAutomatic
debugEnable debug logging code. With this flag, Snap will test the DEBUG environment variable to decide whether to do logging, and this introduces a tiny amount of overhead (a call into a function pointer) because the calls to 'debug' cannot be inlined.DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for snap-core

Readme for snap-core-0.9.6.0

Snap Framework Core

Snap is a web framework for Haskell, based on iteratee I/O (as popularized by Oleg Kiselyov). For more information about Snap, read the README.SNAP.md or visit the Snap project website at http://www.snapframework.com/.

Library contents

This is the snap-core library, which contains:

  • primitive types and functions for HTTP (requests, responses, cookies, post/query parameters, etc).

  • type aliases and helper functions for Iteratee I/O.

  • a "Snap" monad interface, inspired by happstack's, for programming web handlers, which allows:

    • stateful access to the HTTP request and response objects.

    • monadic failure (i.e. MonadPlus/Alternative instances) for declining to handle requests and chaining handlers together.

    • early termination of the computation if you know early what you want to return and want to prevent further monadic processing.

  • Some useful utilities for web handlers, including gzip/zlib compression.

Building snap-core

The snap-core library is built using Cabal and Hackage. Just run

cabal install

from the snap-core toplevel directory.

Building the Haddock Documentation

The haddock documentation can be built using the supplied haddock.sh shell script:

./haddock.sh

The docs get put in dist/doc/html/.

Building the testsuite

Snap is still in its very early stages, so most of the "action" (and a big chunk of the code) right now is centred on the test suite. Snap aims for 100% test coverage, and we're trying hard to stick to that.

To build the test suite, cd into the test/ directory and run

$ cabal configure
$ cabal build

From here you can invoke the testsuite by running:

$ ./runTestsAndCoverage.sh 

The testsuite generates an hpc test coverage report in test/dist/hpc.