Discussion

It is initialized to a copy of [GRMustacheConfiguration defaultConfiguration].

You can alter the repository’s configuration:

// All templates loaded from _repo_ will render text,
// and will not HTML-escape their input.
GRMustacheTemplateRepository *repo = [GRMustacheTemplateRepository templateRepositoryWithBundle:nil];
repo.configuration.contentType = GRMustacheContentTypeText;

You can also create a new configuration, and assign it to the repository:

// Create a configuration
GRMustacheConfiguration *configuration = [GRMustacheConfiguration configuration];
configuration.... // setup

GRMustacheTemplateRepository *repo = [GRMustacheTemplateRepository templateRepositoryWithBundle:nil];
repo.configuration = configuration;

Discussion

Until it is provided with a data source, it is unable to load template by names, and unable to process partial tags such as {{>partial}}:

GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepository];
NSError *error;

// Returns nil, and sets error to an NSError of domain
// GRMustacheErrorDomain, code GRMustacheErrorCodeTemplateNotFound.
[repository templateNamed:@"foo" error:&error];

// Returns nil, and sets error to an NSError of domain GRMustacheErrorDomain,
// code GRMustacheErrorCodeTemplateNotFound.
[repository templateFromString:@"{{>partial}}" error:&error];

It is, however, able to process Mustache template strings without any partial:

GRMustacheTemplate *template = [repository templateFromString:@"Hello {{name}}!" error:NULL];

You will give it a data source conforming to the GRMustacheTemplateRepositoryDataSource protocol in order to load template and partials by name:

repository.dataSource = ...;

// Returns a template built from the string provided by the dataSource.
[repository templateNamed:@"foo" error:NULL];

Discussion

For example:

// Creates a repository for templates stored in /path/to/templates
NSURL *baseURL = [NSURL fileURLWithPath:@"/path/to/templates"];
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithBaseURL:baseURL];

// Returns a template for the file stored in
// /path/to/templates/profile.mustache
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

A partial tag {{>partial}} loads a partial template stored in a file named partial.mustache, located in the enclosing template’s directory.

You may use the slash /, and .., in order to navigate the URL hierarchical system: {{>partials/achievements}} would load /path/to/templates/partials/achievements.mustache, if invoked from /path/to/templates/profile.mustache.

When you ask the repository to parse a raw template string, partials are loaded from the base URL:

// The partial would be loaded from
// /path/to/templates/partials/achievements.mustache
GRMustacheTemplate *template = [repository templateFromString:@"{{>partials/achievements}}" error:NULL];

Discussion

For example:

// Creates a repository for templates of extension `.txt` stored in
// /path/to/templates, encoded with NSMacOSRomanStringEncoding:
NSURL *baseURL = [NSURL fileURLWithPath:@"/path/to/templates"];
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithBaseURL:baseURL
                                                                                     templateExtension:@"txt"
                                                                                              encoding:NSMacOSRomanStringEncoding];

// Returns a template for the file stored in
// /path/to/templates/profile.txt
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

A partial tag {{>partial}} loads a partial template stored in a file named partial.txt, located in the enclosing template’s directory.

You may use the slash /, and .., in order to navigate the URL hierarchical system: {{>partials/achievements}} would load /path/to/templates/partials/achievements.txt, if invoked from /path/to/templates/profile.txt.

When you ask the repository to parse a raw template string, partials are loaded from the base URL:

// The partial would be loaded from
// /path/to/templates/partials/achievements.txt
GRMustacheTemplate *template = [repository templateFromString:@"{{>partials/achievements}}" error:NULL];

Discussion

For example:

// Creates a repository for templates stored in the main bundle:
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithBundle:[NSBundle mainBundle]];

// Returns a template for the resource profile.mustache
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

You may provide nil for the bundle parameter: the repository will use the main bundle.

A partial tag {{>partial}} loads a partial template from the partial.mustache resource in the bundle.

Discussion

For example:

// Creates a repository for templates of extension `.txt` stored in the
// main bundle, encoded with NSMacOSRomanStringEncoding:
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithBundle:[NSBundle mainBundle]
                                                                                    templateExtension:@"txt"
                                                                                             encoding:NSMacOSRomanStringEncoding];

// Returns a template for the resource profile.txt
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

You may provide nil for the bundle parameter: the repository will use the main bundle.

A partial tag {{>partial}} loads a partial template from the partial.txt resource in the bundle.

Discussion

For example:

NSDictionary *templates = @{ @"partial": @"It works." };
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithDictionary:templates];

// Two templates that render "It works."
GRMustacheTemplate *template1 = [repository templateNamed:@"partial" error:NULL];
GRMustacheTemplate *template2 = [repository templateFromString:@"{{> partial }}" error:NULL];

The dictionary is not copied, but retained: changes to the original dictionary may affect the loading of templates.

You can stay immune to any change by providing a copy of the dictionary.

Or you may embrace the changes, and invoke the reloadTemplates method whenever the changes should be applied.

Discussion

For example:

// Creates a repository for templates stored in /path/to/templates
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithDirectory:@"/path/to/templates"];

// Returns a template for the file stored in
// /path/to/templates/profile.mustache
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

A partial tag {{>partial}} loads a partial template stored in a file named partial.mustache, located in the enclosing template’s directory.

You may use the slash /, and .., in order to navigate the hierarchical file system: {{>partials/achievements}} would load /path/to/templates/partials/achievements.mustache, if invoked from /path/to/templates/profile.mustache.

When you ask the repository to parse a raw template string, partials are loaded from the base directory:

// The partial would be loaded from
// /path/to/templates/partials/achievements.mustache
GRMustacheTemplate *template = [repository templateFromString:@"{{>partials/achievements}}" error:NULL];

Discussion

For example:

// Creates a repository for templates of extension `.txt` stored in
// /path/to/templates, encoded with NSMacOSRomanStringEncoding:
GRMustacheTemplateRepository *repository = [GRMustacheTemplateRepository templateRepositoryWithDirectory:@"/path/to/templates"
                                                                                       templateExtension:@"txt"
                                                                                                encoding:NSMacOSRomanStringEncoding];

// Returns a template for the file stored in
// /path/to/templates/profile.txt
GRMustacheTemplate *template = [repository templateNamed:@"profile" error:NULL];

A partial tag {{>partial}} loads a partial template stored in a file named partial.txt, located in the enclosing template’s directory.

You may use the slash /, and .., in order to navigate the hierarchical file system: {{>partials/achievements}} would load /path/to/templates/partials/achievements.txt, if invoked from /path/to/templates/profile.txt.

When you ask the repository to parse a raw template string, partials are loaded from the base directory:

// The partial would be loaded from
// /path/to/templates/partials/achievements.txt
GRMustacheTemplate *template = [repository templateFromString:@"{{>partials/achievements}}" error:NULL];

Discussion

A template repository caches the parsing of its templates. This speeds up the loading of already parsed templates.

However, changes to the underlying template strings won’t be visible until you explicitely ask for a reloading:

// May reuse a cached parsing:
template = [repository templateNamed:@"profile" error:NULL];

// Forces the template reloading:
[repository reloadTemplates];
template = [repository templateNamed:@"profile" error:NULL];

Discussion

Depending on the way the repository has been created, partial tags such as {{>partial}} load partial templates from URLs, file paths, keys in a dictionary, or whatever is relevant to the repository’s data source.

Discussion

Depending on the way the repository has been created, the name identifies a URL, a file path, a key in a dictionary, or whatever is relevant to the repository’s data source.