Text.Hastache

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.ByteString.Lazy.Char8 as LZ 

main = do 
    res <- hastacheStr defaultConfig (encodeStr template)  
        (mkStrContext context) 
    LZ.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:

import Text.Hastache 
import Text.Hastache.Context 
import qualified Data.ByteString.Lazy.Char8 as LZ 
import Data.Data 
import Data.Generics 

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

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

Documentation

hastacheStr

Arguments

:: MonadIO m

=> MuConfig m

Configuration

-> ByteString

Template

-> MuContext m

Context

-> m ByteString

Render Hastache template from ByteString

hastacheFile

Arguments

:: MonadIO m

=> MuConfig m

Configuration

-> FilePath

Template file name

-> MuContext m

Context

-> m ByteString

Render Hastache template from file

hastacheStrBuilder

Arguments

:: MonadIO m

=> MuConfig m

Configuration

-> ByteString

Template

-> MuContext m

Context

-> m Builder

Render Hastache template from ByteString

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

 = ByteString

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 (ByteString -> a)

forall a . MuVar a => MuLambdaM (ByteString -> m a)

MuNothing

Instances

Show (MuType m)

data MuConfig m

Constructors

MuConfig

Fields

muEscapeFunc :: ByteString -> ByteString

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 ByteString)

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

class Show a => MuVar a where

Methods

toLByteString :: a -> ByteString

Convert to Lazy ByteString

isEmpty :: a -> Bool

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

Instances

MuVar Char

MuVar Double

MuVar Float

MuVar Int

MuVar Int8

MuVar Int16

MuVar Int32

MuVar Int64

MuVar Integer

MuVar Word

MuVar Word8

MuVar Word16

MuVar Word32

MuVar Word64

MuVar Text

MuVar Text

MuVar ByteString

MuVar ByteString

MuVar [Char]

(Show [a], MuVar a) => MuVar [a]

htmlEscape :: ByteString -> ByteString

Escape HTML symbols

emptyEscape :: ByteString -> ByteString

No escape

defaultConfig :: MonadIO m => MuConfig m

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

encodeStr :: String -> ByteString

Convert String to UTF-8 Bytestring

encodeStrLBS :: String -> ByteString

Convert String to UTF-8 Lazy Bytestring

decodeStr :: ByteString -> String

Convert UTF-8 Bytestring to String

decodeStrLBS :: ByteString -> String

Convert UTF-8 Lazy Bytestring to String