Merge pull request #9 from bachonk/feature/optional_circular_clipping

Added circular param to category

Author: bachonk

UIImageView+Letters/UIImageView+Letters.h

@@ -42,6 +42,16 @@
  @param string The string used to generate the initials. This should be a user's full name if available
  @param color (optional) This optional paramter sets the background of the image. If not provided, a random color will be generated
  */
+
 - (void)setImageWithString:(NSString *)string color:(UIColor *)color;
 
+/**
+ Sets the image property of the view based on initial text, a specified background color, and a circular clipping
+ 
+ @param string The string used to generate the initials. This should be a user's full name if available
+ @param color (optional) This optional paramter sets the background of the image. If not provided, a random color will be generated
+ @param isCircular This boolean will determine if the image view will be clipped to a circular shape
+ */
+- (void)setImageWithString:(NSString *)string color:(UIColor *)color circular:(BOOL)isCircular;
+
 @end

UIImageView+Letters/UIImageView+Letters.m

@@ -24,13 +24,23 @@
 
 #import "UIImageView+Letters.h"
 
+@interface UIImageView (LettersPrivate)
+
+- (UIImage *)imageSnapshotFromText:(NSString *)text backgroundColor:(UIColor *)color circular:(BOOL)isCircular;
+
+@end
+
 @implementation UIImageView (Letters)
 
 - (void)setImageWithString:(NSString *)string {
-    [self setImageWithString:string color:nil];
+    [self setImageWithString:string color:nil circular:NO];
 }
 
 - (void)setImageWithString:(NSString *)string color:(UIColor *)color {
+    [self setImageWithString:string color:color circular:NO];
+}
+
+- (void)setImageWithString:(NSString *)string color:(UIColor *)color circular:(BOOL)isCircular {
     NSMutableString *displayString = [NSMutableString stringWithString:@""];
 
     NSMutableArray *words = [[string componentsSeparatedByCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] mutableCopy];
@@ -60,7 +70,7 @@ - (void)setImageWithString:(NSString *)string color:(UIColor *)color {
 
     UIColor *backgroundColor = color ? color : [self randomColor];
 
-    self.image = [self imageSnapshotFromText:[displayString uppercaseString] backgroundColor:backgroundColor];
+    self.image = [self imageSnapshotFromText:[displayString uppercaseString] backgroundColor:backgroundColor circular:isCircular];
 }
 
 #pragma mark - Helpers
@@ -89,7 +99,7 @@ - (UIColor *)randomColor {
     return [UIColor colorWithRed:red green:green blue:blue alpha:1.0f];
 }
 
-- (UIImage *)imageSnapshotFromText:(NSString *)text backgroundColor:(UIColor *)color {
+- (UIImage *)imageSnapshotFromText:(NSString *)text backgroundColor:(UIColor *)color circular:(BOOL)isCircular {
 
     CGFloat scale = [UIScreen mainScreen].scale;
 
@@ -107,6 +117,15 @@ - (UIImage *)imageSnapshotFromText:(NSString *)text backgroundColor:(UIColor *)c
 
     CGContextRef context = UIGraphicsGetCurrentContext();
 
+    if (isCircular) {
+        //
+        // Clip context to a circle
+        //
+        CGPathRef path = CGPathCreateWithEllipseInRect(self.bounds, NULL);
+        CGContextAddPath(context, path);
+        CGContextClip(context);
+    }
+    
     //
     // Fill background of context
     //