Yesod.GitRepo

Documentation

data GitRepo a

A combination of Yesod subsite to be used for creating a refresh route, as well as action to extract the current value of the content and force a refresh.

Since 0.1.0

Instances

Eq (Route (GitRepo a))

Read (Route (GitRepo a))

Show (Route (GitRepo a))

RenderRoute (GitRepo a)

ParseRoute (GitRepo a)

YesodSubDispatch (GitRepo a) (HandlerT site IO)

data Route (GitRepo a) = GitRepoRoute

grRefresh :: GitRepo a -> IO ()

Force a refresh of the content. Usually this is done automatically via a POST request to the subsite route.

Since 0.1.0

grContent :: GitRepo a -> IO a

Get the current value of the content.

Since 0.1.0

gitRepo

Arguments

:: Text

URL

-> Text

branch name

-> (FilePath -> IO a)

what to do on clone/refresh

-> IO (GitRepo a)

Create a new GitRepo value that can be used as a refresh subsite, as well as to extract the current value of the content.

Note that if the initial clone or user action fails, this function will throw an exception. For subsequent refreshes, the exception will be stored as an impure exception for future grContent calls.

Since 0.1.0

gitRepoDev :: FilePath -> (FilePath -> IO a) -> IO (GitRepo a)

Like gitRepo, but intended to be used in a dev environment. It just uses a hard-coded FilePath and reloads the contents on each request.

Since 0.1.1

data family Route a

The type-safe URLs associated with a site argument.

Instances

Eq (Route WaiSubsite)

Eq (Route (GitRepo a))

Ord (Route WaiSubsite)

Read (Route WaiSubsite)

Read (Route (GitRepo a))

Show (Route WaiSubsite)

Show (Route (GitRepo a))

data Route WaiSubsite = WaiSubsiteRoute [Text] [(Text, Text)]

data Route (GitRepo a) = GitRepoRoute