hastache-0.6.1: Haskell implementation of Mustache templates

Safe HaskellNone
LanguageHaskell98

Text.Hastache

Description

Haskell implementation of Mustache templates

See homepage for examples of usage: http://github.com/lymar/hastache

Simplest example:

import           Text.Hastache
import           Text.Hastache.Context
import qualified Data.Text.Lazy.IO as TL

main = do 
    res <- hastacheStr defaultConfig (encodeStr template)  
        (mkStrContext context) 
    TL.putStrLn res 
  where 
    template = "Hello, {{name}}!\n\nYou have {{unread}} unread messages." 
    context "name" = MuVariable "Haskell"
    context "unread" = MuVariable (100 :: Int)

Result:

Hello, Haskell!

You have 100 unread messages.

Using Generics:

{-# LANGUAGE DeriveDataTypeable, OverloadedStrings #-}

import           Text.Hastache
import           Text.Hastache.Context
import qualified Data.Text.Lazy.IO as TL
import           Data.Data

data Info = Info {
    name    :: String,
    unread  :: Int
    } deriving (Data, Typeable)

main = do
    res <- hastacheStr defaultConfig template
        (mkGenericContext inf)
    TL.putStrLn res
  where
    template = "Hello, {{name}}!\n\nYou have {{unread}} unread messages."
    inf = Info "Haskell" 100

Synopsis

Documentation

hastacheStr

Arguments

:: MonadIO m 
=> MuConfig m

Configuration

-> Text

Template

-> MuContext m

Context

-> m Text 

Render Hastache template from Text

hastacheFile

Arguments

:: MonadIO m 
=> MuConfig m

Configuration

-> FilePath

Template file name

-> MuContext m

Context

-> m Text 

Render Hastache template from file

hastacheStrBuilder

Arguments

:: MonadIO m 
=> MuConfig m

Configuration

-> Text

Template

-> MuContext m

Context

-> m Builder 

Render Hastache template from Text

hastacheFileBuilder

Arguments

:: MonadIO m 
=> MuConfig m

Configuration

-> FilePath

Template file name

-> MuContext m

Context

-> m Builder 

Render Hastache template from file

type MuContext m

Arguments

 = Text

Variable name

-> m (MuType m)

Value

Data for Hastache variable

data MuType m

Constructors

forall a . MuVar a => MuVariable a 
MuList [MuContext m] 
MuBool Bool 
forall a . MuVar a => MuLambda (Text -> a) 
forall a . MuVar a => MuLambdaM (Text -> m a) 
MuNothing 

Instances

Show (MuType m) 
Monad m => Monoid (MuContext m) 

data MuConfig m

Constructors

MuConfig 

Fields

muEscapeFunc :: Text -> Text

Escape function (htmlEscape, emptyEscape etc.)

muTemplateFileDir :: Maybe FilePath

Directory for search partial templates ({{> templateName}})

muTemplateFileExt :: Maybe String

Partial template files extension

muTemplateRead :: FilePath -> m (Maybe Text)

Template retrieval function. Nothing indicates that the template could not be found.

class Show a => MuVar a where

Minimal complete definition

toLText

Methods

toLText :: a -> Text

Convert to lazy Text

isEmpty :: a -> Bool

Is empty variable (empty string, zero number etc.)

composeCtx :: Monad m => MuContext m -> MuContext m -> MuContext m

Left-leaning compoistion of contexts. Given contexts c1 and c2, the behaviour of (c1 <> c2) x is following: if c1 x produces MuNothing, then the result is c2 x. Otherwise the result is c1 x. Even if c1 x is MuNothing, the monadic effects of c1 are still to take place.

htmlEscape :: Text -> Text

Escape HTML symbols

emptyEscape :: Text -> Text

No escape

defaultConfig :: MonadIO m => MuConfig m

Default config: HTML escape function, current directory as template directory, template file extension not specified

encodeStr :: String -> Text

Convert String to Text

encodeStrLT :: String -> Text

Convert String to Lazy Text

decodeStr :: Text -> String

Convert Text to String

decodeStrLT :: Text -> String

Convert Lazy Text to String