Text.Glabrous

A minimalistic Mustache-like syntax, truly logic-less, pure Text template library

• Use only the simplest Mustache tag {{name}} called a variable.
• HTML agnostic

Template

data Template

Constructors

Template

Fields

content :: ![Token]

Instances

Eq Template

Show Template

type Tag = Text

Get a Template

fromText :: Text -> Either String Template

Build a Template from a Text.

λ>fromText "Glabrous templates use only the simplest Mustache tag: {{name}}."
Right (Template {content = [Literal "Glabrous templates use only the simplest Mustache tag: ",Tag "name",Literal "."]})

readTemplateFile :: FilePath -> IO (Either String Template)

Get a Template from a file.

Template operations

toText :: Template -> Text

Output the content of the given Template as it is, with its Tags, if they exist (no Context is processed).

isFinal :: Template -> Bool

True if a Template has no more Tag inside and can be used as a final Text.

tagsOf :: Template -> [Tag]

Get the list of Tags in the given Template.

tagsRename :: [(Text, Text)] -> Template -> Template

compress :: Template -> Template

Optimize a Template content after (many) partialProcess(') rewriting(s).

writeTemplateFile :: FilePath -> Template -> IO ()

Write a Template to a file.

Context

data Context

Constructors

Context

Fields

variables :: HashMap Text Text

Instances

Eq Context

Show Context

ToJSON Context

FromJSON Context

Get a Context

initContext :: Context

Build an empty Context.

fromList :: [(Text, Text)] -> Context

Build a Context from a list of Tags and replacement Texts.

λ>fromList [("something","something else"), ("etc.","...")]
Context {variables = fromList [("etc.","..."),("something","something else")]}

fromTemplate :: Template -> Context

Extract Tags from a Template and build a Context with all its variables empty.

Context operations

setVariables :: [(Text, Text)] -> Context -> Context

Populate with variables and/or update variables in the given Context.

λ>setVariables [("something","something new"), ("about","Haskell")] context
Context {variables = fromList [("etc.","..."),("about","Haskell"),("something","something new"),("name","")]}

deleteVariables :: [Text] -> Context -> Context

Delete variables from a Context by these names.

λ>deleteVariables ["something"] context
Context {variables = fromList [("etc.","..."),("about","Haskell"),("name","")]}

unsetContext :: Context -> Maybe Context

Build Just a (sub)Context made of unset variables of the given context, or Nothing.

λ>unsetContext context
Just (Context {variables = fromList [("name","")]})

JSON Context file

readContextFile :: FilePath -> IO (Maybe Context)

Get a Context from a file.

writeContextFile :: FilePath -> Context -> IO ()

Write a Context to a file.

{
    "something": "something else",
    "etc.": "..."
}

initContextFile :: FilePath -> Context -> IO ()

Based on the given Context, write a Context file with all its variables empty.

{
    "something": "",
    "etc.": ""
}

Processing

process :: Template -> Context -> Text

Process, discard Tags which are not in the Context and leave them without replacement text in the final Text.

processWithDefault

Arguments

:: Text

Default replacement text

-> Template

-> Context

-> Text

Process and replace missing variables in Context with the given default replacement Text.

partialProcess :: Template -> Context -> Template

Process a (sub)Context present in the given template, leaving untouched, if they exist, other Tags, to obtain a new template.

data Result

Constructors

Final !Text

Partial

Fields

template :: !Template

tags :: ![Tag]

Instances

Eq Result

Show Result

partialProcess' :: Template -> Context -> Result

Process a (sub)Context present in the given template, and get either a Final Text or a new Template with the list of its Tags.

λ>partialProcess' template context
Partial {template = Template {content = [Literal "Some ",Tag "tags",Literal " are unused in this ",Tag "text",Literal "."]}, tags = ["tags","text"]}