can-i-haz

Generic implementation of the Has pattern https://github.com/0xd34df00d/can-i-haz#readme

Version on this page:0.1.0.1
Stackage Nightly 2019-10-20:0.2.0.1
Latest on Hackage:0.2.0.1

See all snapshots can-i-haz appears in

BSD-3-Clause licensed by Georg Rudoy
Maintained by 0xd34df00d@gmail.com

Module documentation for 0.1.0.1

This version can be pinned in stack with:can-i-haz-0.1.0.1@sha256:47762eea4d4c28cf7668117c22ef55bf52fd089f57408a10d5c61129f44c9972,1472

can-i-haz

Build Status Hackage Stackage LTS Stackage Nightly

Generic implementation of the Has-pattern (mostly useful with MonadReader).

Motivation

Assume there are two types representing the MonadReader environments for different parts of an app:

data DbConfig = DbConfig { .. }
data WebConfig = WebConfig { .. }

as well as a single type containing both of those:

data AppEnv = AppEnv
  { dbConfig :: DbConfig
  , webConfig :: WebConfig
  }

What should be the MonadReader constraint of the DB module and web module respectively?

  1. It could be MonadReader AppEnv m for both, introducing unnecessary coupling.
  2. Or it could be MonadReader DbConfig m for the DB module and MonadReader WebConfig m for the web module respectively, but combining them becomes a pain.

Or, it could be MonadReader r m, Has DbConfig r for the DB module, where Has class allows projecting DbConfig out of some r, and similarly for the web module! This approach keeps both modules decoupled, while allowing using them in the same monad stack.

The only downside is that now one has to define the Has class and write tediuos instances for the AppEnv type (and potentially other types in case of tests).

The solution

This library saves you from this unnecessary boilerplate! The only thing you have to do is to append the deriving-clause:

data AppEnv = AppEnv
  { dbConfig :: DbConfig
  , webConfig :: WebConfig
  } deriving (Generic, Has DbConfig, Has WebConfig)

and use ask extract instead of ask (but this is something you’d have to do anyway).

Documentation

Perhaps the best source is the Haddock docs.

Changes

Changelog for can-i-haz

0.1.0.1

  • Added documentation.
  • Export the SearchSuccessful type which might aid hand-writing instances.

0.1.0.0

Initial release.

Depends on 1 package(full list with versions):
comments powered byDisqus