v1.8.2

groue · Oct 9, 2011 · 8abbac9 · 8abbac9
1 parent df3aeea
commit 8abbac9
Show file tree

Hide file tree

Showing 15 changed files with 1,018 additions and 81 deletions.
diff --git a/Classes/GRMustacheVersion.h b/Classes/GRMustacheVersion.h
@@ -40,5 +40,5 @@
  
  @since v1.0.0
  */
-#define GRMUSTACHE_PATCH_VERSION 1
+#define GRMUSTACHE_PATCH_VERSION 2
 
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,13 +1,57 @@
 GRMustache Release Notes
 ========================
 
+## v1.8.2
+
+Better testing of public API thanks to availability macros.
+
 ## v1.8.1
 
 Bug fixes
 
 ## v1.8
 
-**GRMustache now supports [mustache/spec v1.1.2](https://github.com/mustache/spec).**
+**GRMustache now supports the [Mustache specification v1.1.2](https://github.com/mustache/spec).**
+
+New type and enum:
+
+    enum {
+        GRMustacheTemplateOptionNone = 0,
+        GRMustacheTemplateOptionMustacheSpecCompatibility = 0x01,
+    };
+
+    typedef NSUInteger GRMustacheTemplateOptions;
+
+New GRMustache methods:
+
+- `+ (GRMustacheTemplateOptions)defaultTemplateOptions;`
+- `+ (void)setDefaultTemplateOptions:(GRMustacheTemplateOptions)templateOptions;`
+
+New GRMustacheTemplate methods:
+
+- `+ (id)parseString:(NSString *)templateString options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (id)parseContentsOfURL:(NSURL *)url options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (id)parseContentsOfFile:(NSString *)path options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (id)parseResource:(NSString *)name bundle:(NSBundle *)bundle options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (id)parseResource:(NSString *)name withExtension:(NSString *)ext bundle:(NSBundle *)bundle options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (NSString *)renderObject:(id)object fromString:(NSString *)templateString options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (NSString *)renderObject:(id)object fromContentsOfURL:(NSURL *)url options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (NSString *)renderObject:(id)object fromContentsOfFile:(NSString *)path options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (NSString *)renderObject:(id)object fromResource:(NSString *)name bundle:(NSBundle *)bundle options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+- `+ (NSString *)renderObject:(id)object fromResource:(NSString *)name withExtension:(NSString *)ext bundle:(NSBundle *)bundle options:(GRMustacheTemplateOptions)options error:(NSError **)outError;`
+
+New GRMustacheTemplateLoader methods:
+
+- `+ (id)templateLoaderWithBaseURL:(NSURL *)url options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithBaseURL:(NSURL *)url extension:(NSString *)ext options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithBaseURL:(NSURL *)url extension:(NSString *)ext encoding:(NSStringEncoding)encoding options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithDirectory:(NSString *)path options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithDirectory:(NSString *)path extension:(NSString *)ext options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithDirectory:(NSString *)path extension:(NSString *)ext encoding:(NSStringEncoding)encoding options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithBundle:(NSBundle *)bundle options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithBundle:(NSBundle *)bundle extension:(NSString *)ext options:(GRMustacheTemplateOptions)options;`
+- `+ (id)templateLoaderWithBundle:(NSBundle *)bundle extension:(NSString *)ext encoding:(NSStringEncoding)encoding options:(GRMustacheTemplateOptions)options;`
+
 
 ## v1.7.4
 
@@ -46,13 +90,13 @@ The NSUndefinedKeyException silencing activated by the DEBUG macro applies to NS
 
 **Reduced memory footprint**
 
-New GRMustacheTemplateLoader class methods:
+New GRMustacheTemplateLoader methods:
 
 - `+ (id)templateLoaderWithDirectory:(NSString *)path;`
 - `+ (id)templateLoaderWithDirectory:(NSString *)path extension:(NSString *)ext;`
 - `+ (id)templateLoaderWithDirectory:(NSString *)path extension:(NSString *)ext encoding:(NSStringEncoding)encoding;`
 
-Deprecated GRMustacheTemplateLoader class methods (replace `BasePath` with `Directory`):
+Deprecated GRMustacheTemplateLoader methods (replace `BasePath` with `Directory`):
 
 - `+ (id)templateLoaderWithBasePath:(NSString *)path;`
 - `+ (id)templateLoaderWithBasePath:(NSString *)path extension:(NSString *)ext;`
@@ -101,7 +145,7 @@ New `GRMustacheTemplate` methods:
 - `+ (NSString *)renderObject:(id)object fromContentsOfFile:(NSString *)path error:(NSError **)outError;`
 - `+ (id)parseContentsOfFile:(NSString *)path error:(NSError **)outError;`
 
-New `GRMustacheTemplateLoader` class methods:
+New `GRMustacheTemplateLoader` methods:
 
 - `+ (id)templateLoaderWithBasePath:(NSString *)path;`
 - `+ (id)templateLoaderWithBasePath:(NSString *)path extension:(NSString *)ext;`

diff --git a/include/GRBoolean.h b/include/GRBoolean.h
@@ -21,6 +21,7 @@
 // THE SOFTWARE.
 
 #import <Foundation/Foundation.h>
+#import "GRMustacheAvailabilityMacros.h"
 
 /**
  The GRYes class provides with a singleton which you can use as a true value
@@ -40,13 +41,13 @@
  @returns the GRYes singleton.
  @since v1.0.0
  */
-+ (GRYes *)yes __attribute__((deprecated));
++ (GRYes *)yes AVAILABLE_GRMUSTACHE_VERSION_1_0_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_1_2;
 
 /**
  @returns YES
  @since v1.1.0
  */
-- (BOOL)boolValue;
+- (BOOL)boolValue AVAILABLE_GRMUSTACHE_VERSION_1_1_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_1_2;
 @end
 
 
@@ -69,11 +70,11 @@
  @returns the GRNo singleton.
  @since v1.0.0
  */
-+ (GRNo *)no __attribute__((deprecated));
++ (GRNo *)no AVAILABLE_GRMUSTACHE_VERSION_1_0_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_1_2;
 
 /**
  @returns NO
  @since v1.1.0
  */
-- (BOOL)boolValue;
+- (BOOL)boolValue AVAILABLE_GRMUSTACHE_VERSION_1_1_AND_LATER_BUT_DEPRECATED_IN_GRMUSTACHE_VERSION_1_2;
 @end
diff --git a/include/GRMustache.h b/include/GRMustache.h
@@ -21,6 +21,7 @@
 // THE SOFTWARE.
 
 #import <Foundation/Foundation.h>
+#import "GRMustacheAvailabilityMacros.h"
 
 enum {
     GRMustacheTemplateOptionNone = 0,
@@ -58,7 +59,7 @@ typedef struct {
  
  @since v1.0.0
  */
-+ (GRMustacheVersion)version;
++ (GRMustacheVersion)version AVAILABLE_GRMUSTACHE_VERSION_1_0_AND_LATER;
 
 //////////////////////////////////////////////////////////////////////////////////////////
 /// @name Handling of boolean properties
@@ -84,7 +85,7 @@ typedef struct {
  @see GRNo
  @since v1.0.0
  */
-+ (BOOL)strictBooleanMode;
++ (BOOL)strictBooleanMode AVAILABLE_GRMUSTACHE_VERSION_1_0_AND_LATER;
 
 /**
  Sets the strict boolean mode of GMustache.
@@ -95,13 +96,13 @@ typedef struct {
  @see GRMustache#strictBooleanMode
  @since v1.0.0
  */
-+ (void)setStrictBooleanMode:(BOOL)aBool;
++ (void)setStrictBooleanMode:(BOOL)aBool AVAILABLE_GRMUSTACHE_VERSION_1_0_AND_LATER;
 
-+ (void)preventNSUndefinedKeyExceptionAttack;
++ (void)preventNSUndefinedKeyExceptionAttack AVAILABLE_GRMUSTACHE_VERSION_1_7_AND_LATER;
 
-+ (GRMustacheTemplateOptions)defaultTemplateOptions;
++ (GRMustacheTemplateOptions)defaultTemplateOptions AVAILABLE_GRMUSTACHE_VERSION_1_8_AND_LATER;
 
-+ (void)setDefaultTemplateOptions:(GRMustacheTemplateOptions)templateOptions;
++ (void)setDefaultTemplateOptions:(GRMustacheTemplateOptions)templateOptions AVAILABLE_GRMUSTACHE_VERSION_1_8_AND_LATER;
 
 @end