Added comments and cleaned up

ClassyKit · Mar 9, 2016 · e0b7627 · e0b7627
1 parent a12b9ad
commit e0b7627
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 10 deletions.
diff --git a/Classy/Parser/CASStyler.h b/Classy/Parser/CASStyler.h
@@ -10,10 +10,23 @@
 #import "CASObjectClassDescriptor.h"
 #import "CASStyleableItem.h"
 
-@protocol CASStylerCacheDelegate <NSObject>
+@class CASStyleNode;
+
+/**
+ * Protocol caching the @c CASStyleNode's. Adds the possibility to cache the in-memory representation of Classy's CAS 
+ * file, since parsing the file is slower than loading cached version.
+ */
+@protocol CASCacheProtocol <NSObject>
 @optional
-- (NSArray *)cachedStyleNodesFromPath:(NSString *)path withVariables:(NSDictionary *)variables;
-- (void)cacheStyleNodes:(NSArray *)styleNodes fromPath:(NSString *)path variables:(NSDictionary *)variables;
+/**
+ *  Loads cached version of stylesheet located at @c path with @c variables
+ */
+- (NSArray <CASStyleNode *> *)cachedStyleNodesFromCASPath:(NSString *)path withVariables:(NSDictionary *)variables;
+
+/**
+ * Stores the stylesheet in-memory representation loaded from @c path with @c variables
+ */
+- (void)cacheStyleNodes:(NSArray <CASStyleNode *> *)styleNodes fromPath:(NSString *)path variables:(NSDictionary *)variables;
 @end
 
 
@@ -26,7 +39,7 @@
  */
 + (instancetype)defaultStyler;
 
-@property (nonatomic, weak) id<CASStylerCacheDelegate> cacheDelegate;
+@property (nonatomic, weak) id<CASCacheProtocol> cache;
 
 @property (nonatomic, copy) NSDictionary *variables;
 

diff --git a/Classy/Parser/CASStyler.m b/Classy/Parser/CASStyler.m
@@ -160,8 +160,8 @@ - (void)setFilePath:(NSString *)filePath error:(NSError **)error {
     NSArray *styleNodes = nil;
     NSSet *importedFileNames = nil;
 
-    if ([self.cacheDelegate respondsToSelector:@selector(cachedStyleNodesFromPath:withVariables:)]) {
-        styleNodes = [self.cacheDelegate cachedStyleNodesFromPath:filePath withVariables:self.variables];
+    if ([self.cache respondsToSelector:@selector(cachedStyleNodesFromCASPath:withVariables:)]) {
+        styleNodes = [self.cache cachedStyleNodesFromCASPath:filePath withVariables:self.variables];
     }
 
     if (styleNodes != nil) {
@@ -186,12 +186,10 @@ - (void)setFilePath:(NSString *)filePath error:(NSError **)error {
             }
             return NSOrderedSame;
         }];
-
 
-        if ([self.cacheDelegate respondsToSelector:@selector(cacheStyleNodes:fromPath:variables:)]) {
-            [self.cacheDelegate cacheStyleNodes:styleNodes fromPath:filePath variables:self.variables];
+        if ([self.cache respondsToSelector:@selector(cacheStyleNodes:fromPath:variables:)]) {
+            [self.cache cacheStyleNodes:styleNodes fromPath:filePath variables:self.variables];
         }
-        styleNodes = [self.cacheDelegate cachedStyleNodesFromPath:filePath withVariables:self.variables];
     }
 
     if (self.watchFilePath) {