Merge pull request #107 from Raizlabs/bugfix/zeveisenberg/31-nullabil…

…ity-and-generics

Nullability and Generics

Example/BonMot/NSDictionary+BONEquality.h

@@ -8,13 +8,15 @@
 
 @import Foundation;
 
+#import "BONCompatibility.h"
+
 @import CoreGraphics.CGBase;
 
 OBJC_EXTERN const CGFloat kBONCGFloatEpsilon;
 OBJC_EXTERN BOOL BONCGFloatsCloseEnough(CGFloat float1, CGFloat float2);
 
-@interface NSDictionary (BONEquality)
+@interface BONGenericDict (BONEquality)
 
-- (BOOL)bon_isCloseEnoughEqualToDictionary:(NSDictionary *)dictionary;
+- (BOOL)bon_isCloseEnoughEqualToDictionary:(BONNullable BONGenericDict *)dictionary;
 
 @end

Example/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - BonMot (2.1.1)
+  - BonMot (2.3)
 
 DEPENDENCIES:
   - BonMot (from `../`)
@@ -9,6 +9,6 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  BonMot: 52c1f4026036a8a03081a12402fc3e796f56e28e
+  BonMot: 6fbd53628aca43c70db2a0e778fa847384a7d858
 
 COCOAPODS: 0.39.0

Example/Tests/BONBaseTestCase.h

@@ -9,6 +9,7 @@
 @import XCTest;
 #import "NSDictionary+BONEquality.h"
 #import "DummyAssetClass.h"
+#import "BONCompatibility.h"
 
 OBJC_EXTERN NSValue *BONValueFromRange(NSUInteger location, NSUInteger length);
 
@@ -41,13 +42,13 @@ OBJC_EXTERN NSValue *BONValueFromRange(NSUInteger location, NSUInteger length);
  *  @param attributedString  The attributed string to validate.
  *  @param controlAttributes A dictionary whose keys are @c NSValue objects containing @c NSRange structs, and whose values are attributes dictionaries.
  */
-#define BONAssertAttributedStringHasAttributes(attributedString, controlAttributes)                                                                                     \
-    NSMutableDictionary *mutableControlAttributes = controlAttributes.mutableCopy;                                                                                      \
-    [attributedString enumerateAttributesInRange:NSMakeRange(0, attributedString.length) options:0 usingBlock:^(NSDictionary * attrs, NSRange range, BOOL * stop) { \
-        NSValue *testRangeValue = [NSValue valueWithRange:range];                                                                                                   \
-        NSDictionary *controlAttrs = controlAttributes[testRangeValue];                                                                                             \
-        XCTAssertNotNil(controlAttrs, @"Attributed String had attributes that were not accounted for at %@: %@", NSStringFromRange(range), attrs);                  \
-        BONAssertEqualDictionaries(attrs, controlAttrs);                                                                                                            \
+#define BONAssertAttributedStringHasAttributes(attributedString, controlAttributes)                                                                                                              \
+    NSMutableDictionary *mutableControlAttributes = controlAttributes.mutableCopy;                                                                                                               \
+    [attributedString enumerateAttributesInRange:NSMakeRange(0, attributedString.length) options:0 usingBlock:^(BONStringDict * BONCNonnull attrs, NSRange range, BOOL * BONCNonnull stop) { \
+        NSValue *testRangeValue = [NSValue valueWithRange:range];                                                                                                                                    \
+        NSDictionary *controlAttrs = controlAttributes[testRangeValue];                                                                                                                              \
+        XCTAssertNotNil(controlAttrs, @"Attributed String had attributes that were not accounted for at %@: %@", NSStringFromRange(range), attrs);                                                   \
+        BONAssertEqualDictionaries(attrs, controlAttrs);                                                                                                                                             \
         [mutableControlAttributes removeObjectForKey:testRangeValue]; }]; \
     XCTAssertEqual(mutableControlAttributes.count, 0, @"Some attributes not found in string: %@", mutableControlAttributes);
 

Example/Tests/BONTextAlignmentTestCase.m

@@ -120,8 +120,9 @@ - (void)testParagraphStyle
 // Test behavior when using both `headIndent` and `indentSpacer`
 - (void)testHeadIndentWithIndentSpacer
 {
+    UIImage *robotImage = [UIImage imageNamed:@"robot" inBundle:[NSBundle bundleForClass:self.class] compatibleWithTraitCollection:nil];
     BONChain *chain = BONChain.new
-                          .image([UIImage imageNamed:@"robot" inBundle:[NSBundle bundleForClass:self.class] compatibleWithTraitCollection:nil])
+                          .image(robotImage)
                           .headIndent(1.23)
                           .indentSpacer(4.0);
     [chain appendLink:chain.string(@"test")];
@@ -133,7 +134,7 @@ - (void)testHeadIndentWithIndentSpacer
     // The `indentSpacer` doesn't overwrite the `headIndent` value
     XCTAssertEqualWithAccuracy(testParagraphStyle.headIndent, 1.23, kBONCGFloatEpsilon);
 
-    [testAttributedString enumerateAttributesInRange:NSMakeRange(0, testAttributedString.length) options:0 usingBlock:^(NSDictionary<NSString *, id> *_Nonnull attrs, NSRange range, BOOL *_Nonnull stop) {
+    [testAttributedString enumerateAttributesInRange:NSMakeRange(0, testAttributedString.length) options:0 usingBlock:^(BONStringDict *BONCNonnull attrs, NSRange range, BOOL *BONCNonnull stop) {
         NSParagraphStyle *paragraphStyle = attrs[NSParagraphStyleAttributeName];
         if (paragraphStyle != nil) {
             NSString *substring = [testAttributedString.string substringWithRange:range];

Pod/BonMot.h

@@ -1,6 +1,6 @@
 //
 //  BonMot.h
-//  Pods
+//  BonMot
 //
 //  Created by Zev Eisenberg on 7/13/15.
 //

Pod/Classes/BONChain.h

@@ -1,6 +1,6 @@
 //
 //  BONChain.h
-//  Pods
+//  BonMot
 //
 //  Created by Zev Eisenberg on 4/24/15.
 //
@@ -9,41 +9,44 @@
 @import Foundation;
 
 #import "BONText.h"
+#import "BONCompatibility.h"
+
+BON_ASSUME_NONNULL_BEGIN
 
 @class BONChain;
 
-typedef BONChain * (^BONChainFontNameAndSize)(NSString *fontName, CGFloat fontSize);
-typedef BONChain * (^BONChainFont)(UIFont *font);
-typedef BONChain * (^BONChainColor)(UIColor *color);
-typedef BONChain * (^BONChainAdobeTracking)(NSInteger adobeTracking);
-typedef BONChain * (^BONChainPointTracking)(CGFloat pointTracking);
-typedef BONChain * (^BONChainFirstLineHeadIndent)(CGFloat firstLineHeadIndent);
-typedef BONChain * (^BONChainHeadIndent)(CGFloat headIndent);
-typedef BONChain * (^BONChainTailIndent)(CGFloat tailIndent);
-typedef BONChain * (^BONChainLineHeight)(CGFloat lineHeightMultiple);
-typedef BONChain * (^BONChainMaximumLineHeight)(CGFloat maximumLineHeight);
-typedef BONChain * (^BONChainMinimumLineHeight)(CGFloat minimumLineHeight);
-typedef BONChain * (^BONChainLineSpacing)(CGFloat lineSpacing);
-typedef BONChain * (^BONChainParagraphSpacingAfter)(CGFloat paragraphSpacing);
-typedef BONChain * (^BONChainParagraphSpacingBefore)(CGFloat paragraphSpacingBefore);
-typedef BONChain * (^BONChainBaselineOffset)(CGFloat baselineOffset);
-typedef BONChain * (^BONChainAlignment)(NSTextAlignment alignment);
-typedef BONChain * (^BONChainFigureCase)(BONFigureCase figureCase);
-typedef BONChain * (^BONChainFigureSpacing)(BONFigureSpacing figureSpacing);
-typedef BONChain * (^BONChainIndentSpacer)(CGFloat indentSpacer);
-typedef BONChain * (^BONChainString)(NSString *string);
-typedef BONChain * (^BONChainImage)(UIImage *image);
-
-typedef BONChain * (^BONChainUnderlineStyle)(NSUnderlineStyle style);
-typedef BONChain * (^BONChainUnderlineColor)(UIColor *color);
-
-typedef BONChain * (^BONChainStrikethroughStyle)(NSUnderlineStyle style);
-typedef BONChain * (^BONChainStrikethroughColor)(UIColor *color);
+typedef BONChain *BONCNonnull (^BONChainFontNameAndSize)(NSString *BONCNonnull fontName, CGFloat fontSize);
+typedef BONChain *BONCNonnull (^BONChainFont)(UIFont *BONCNullable font);
+typedef BONChain *BONCNonnull (^BONChainColor)(UIColor *BONCNullable color);
+typedef BONChain *BONCNonnull (^BONChainAdobeTracking)(NSInteger adobeTracking);
+typedef BONChain *BONCNonnull (^BONChainPointTracking)(CGFloat pointTracking);
+typedef BONChain *BONCNonnull (^BONChainFirstLineHeadIndent)(CGFloat firstLineHeadIndent);
+typedef BONChain *BONCNonnull (^BONChainHeadIndent)(CGFloat headIndent);
+typedef BONChain *BONCNonnull (^BONChainTailIndent)(CGFloat tailIndent);
+typedef BONChain *BONCNonnull (^BONChainLineHeight)(CGFloat lineHeightMultiple);
+typedef BONChain *BONCNonnull (^BONChainMaximumLineHeight)(CGFloat maximumLineHeight);
+typedef BONChain *BONCNonnull (^BONChainMinimumLineHeight)(CGFloat minimumLineHeight);
+typedef BONChain *BONCNonnull (^BONChainLineSpacing)(CGFloat lineSpacing);
+typedef BONChain *BONCNonnull (^BONChainParagraphSpacingAfter)(CGFloat paragraphSpacing);
+typedef BONChain *BONCNonnull (^BONChainParagraphSpacingBefore)(CGFloat paragraphSpacingBefore);
+typedef BONChain *BONCNonnull (^BONChainBaselineOffset)(CGFloat baselineOffset);
+typedef BONChain *BONCNonnull (^BONChainAlignment)(NSTextAlignment alignment);
+typedef BONChain *BONCNonnull (^BONChainFigureCase)(BONFigureCase figureCase);
+typedef BONChain *BONCNonnull (^BONChainFigureSpacing)(BONFigureSpacing figureSpacing);
+typedef BONChain *BONCNonnull (^BONChainIndentSpacer)(CGFloat indentSpacer);
+typedef BONChain *BONCNonnull (^BONChainString)(NSString *BONCNullable string);
+typedef BONChain *BONCNonnull (^BONChainImage)(UIImage *BONCNullable image);
+
+typedef BONChain *BONCNonnull (^BONChainUnderlineStyle)(NSUnderlineStyle style);
+typedef BONChain *BONCNonnull (^BONChainUnderlineColor)(UIColor *BONCNullable color);
+
+typedef BONChain *BONCNonnull (^BONChainStrikethroughStyle)(NSUnderlineStyle style);
+typedef BONChain *BONCNonnull (^BONChainStrikethroughColor)(UIColor *BONCNullable color);
 
 @interface BONChain : NSObject <NSCopying, BONChainable>
 
 @property (copy, nonatomic, readonly) NSAttributedString *attributedString;
-@property (copy, nonatomic, readonly) NSDictionary *attributes;
+@property (copy, nonatomic, readonly) BONStringDict *attributes;
 
 // fontNameAndSize and font are mutually exclusive: setting one will unset the other
 @property (copy, nonatomic, readonly) BONChainFontNameAndSize fontNameAndSize;
@@ -91,6 +94,8 @@ typedef BONChain * (^BONChainStrikethroughColor)(UIColor *color);
 
 // concatenation
 - (void)appendLink:(id<BONChainable>)link;
-- (void)appendLink:(id<BONChainable>)link separator:(NSString *)separator;
+- (void)appendLink:(id<BONChainable>)link separator:(BONNullable NSString *)separator;
 
 @end
+
+BON_ASSUME_NONNULL_END

Pod/Classes/BONChain.m

@@ -1,6 +1,6 @@
 //
 //  BONChain.m
-//  Pods
+//  BonMot
 //
 //  Created by Zev Eisenberg on 4/24/15.
 //

Pod/Classes/BONChainable.h

@@ -1,15 +1,19 @@
 //
 //  BONChainable.h
-//  Pods
+//  BonMot
 //
 //  Created by Zev Eisenberg on 10/9/15.
 //
 //
 
 @import Foundation;
 
+#import "BONCompatibility.h"
+
 @class BONText;
 
+BON_ASSUME_NONNULL_BEGIN
+
 /**
  *  Objects conforming to this protocol can be used in BonMot chaining operations.
  */
@@ -18,3 +22,5 @@
 @property (strong, nonatomic, readonly) BONText *text;
 
 @end
+
+BON_ASSUME_NONNULL_END

Pod/Classes/BONCompatibility.h

@@ -0,0 +1,46 @@
+//
+//  BONCompatibility.h
+//  BonMot
+//
+//  Created by Zev Eisenberg on 3/4/15.
+//
+
+//
+// Nullability annotation compatibility.
+//
+
+// clang-format off
+#if __has_feature(nullability)
+#   define BONNonnull            nonnull
+#   define BONNullable           nullable
+#   define BONCNonnull           __nonnull
+#   define BONCNullable          __nullable
+#   define BON_ASSUME_NONNULL_BEGIN NS_ASSUME_NONNULL_BEGIN
+#   define BON_ASSUME_NONNULL_END   NS_ASSUME_NONNULL_END
+#else
+#   define BONNonnull
+#   define BONNullable
+#   define BONCNonnull
+#   define BONCNullable
+#   define BON_ASSUME_NONNULL_BEGIN
+#   define BON_ASSUME_NONNULL_END
+#endif
+
+//
+// Lightweight generics compatibility.
+//
+
+#if __has_feature(objc_generics)
+#   define BONGeneric(class, ...) class<__VA_ARGS__>
+#   define BONGenericType(type) type
+#else
+#   define BONGeneric(class, ...) class
+#   define BONGenericType(type) id
+#endif
+
+
+#define BONStringDict BONGeneric(NSDictionary, NSString *, id)
+#define BONStringMutableDict BONGeneric(NSMutableDictionary, NSString *, id)
+#define BONGenericDict BONGeneric(NSDictionary, KeyType, ObjectType)
+
+// clang-format on