GRMustache

GRMustache is a production-ready implementation of Mustache templates for MacOS Cocoa and iOS.

September 12th, 2012: GRMustache 5.0.0 is out. Release notes

iPhone5 development: use the iPhone5 branch. It includes the armv7s slice.

Breaking news on Twitter: http://twitter.com/GRMustache

How To

1. Download and add to your Xcode project

$ git clone https://github.com/groue/GRMustache.git

For MacOS development, add include/GRMustache.h and lib/libGRMustache5-MacOS.a to your project.
For iOS development, add include/GRMustache.h and lib/libGRMustache5-iOS.a to your project.

Alternatively, you may use CocoaPods: append pod 'GRMustache', '~> 5.0' to your Podfile.

GRMustache targets MacOS down to 10.6 Snow Leopard, iOS down to version 4, and only depends on the Foundation framework.

2. Start rendering templates

#import "GRMustache.h"

// Renders "Hello Arthur!"
NSString *rendering = [GRMustacheTemplate renderObject:[Person personWithName:@"Arthur"]
                                            fromString:@"Hello {{name}}!"
                                                 error:NULL];

// Renders a document from the `Profile.mustache` resource
NSString *rendering = [GRMustacheTemplate renderObject:[Person personWithName:@"Arthur"]
                                          fromResource:@"Profile"
                                                bundle:nil
                                                 error:NULL];

Documentation

Documentation starts here: Guides/introduction.md.

FAQ

Q: How do I render array indexes?

A: Check Guides/sample_code/indexes.md
Q: How do I format numbers and dates?

A: Check Guides/sample_code/number_formatting.md
Q: How do I localize templates?

A: Check Guides/sample_code/localization.md
Q: How do I render default values for missing keys?

A: Check Guides/delegate.md.
Q: Does GRMustache provide any layout facility?

A: No. But there is a sample Xcode project that demonstrates how to do that.
Q: What is this NSUndefinedKeyException stuff?

A: When GRMustache has to try several objects until it finds the one that provides a {{key}}, several NSUndefinedKeyException are raised and caught. Let us double guess you: it's likely that you wish Xcode would stop breaking on those exceptions. This use case is covered in Guides/runtime/context_stack.md.
Q: Why does GRMustache need JRSwizzle?

A: GRMustache does not need it. However, you may happy having GRMustache swizzle valueForUndefinedKey: in the NSObject and NSManagedObject classes when you invoke [GRMustache preventNSUndefinedKeyExceptionAttack]. The use case is described in Guides/runtime/context_stack.md.

Contribution wish-list

I wish somebody would review my non-native English, and clean up the guides, if you ask.

Forking

Please fork. You'll learn useful information in Guides/forking.md.

License

Released under the MIT License.

briandeweese/GRMustache