Merge pull request #34 from square/rhg/ark-log-message-create-with-date

Allow an ARKLogMessage to be created with an arbitrary creationDate. …

Author: rhgills

Aardvark.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = 'Aardvark'
-  s.version  = '1.4.0'
+  s.version  = '1.5.0'
   s.license  = 'Apache License, Version 2.0'
   s.summary  = 'Aardvark is a library that makes it dead simple to create actionable bug reports.'
   s.homepage = 'https://github.com/square/Aardvark'

AardvarkTests/ARKLogTableViewControllerTests.m

@@ -46,49 +46,18 @@ - (instancetype)initWithDate:(NSDate *)date;
 
 @implementation ARKFakeLogMessage
 
-@synthesize creationDate = _creationDate;
-
 #pragma mark - Initialization
 
 - (instancetype)initWithDate:(NSDate *)date;
 {
-    self = [self init];
+    self = [super initWithText:@"Fake Log" image:nil type:ARKLogTypeDefault userInfo:nil creationDate:date];
     if (!self) {
         return nil;
     }
 
-    _creationDate = date;
-    
     return self;
 }
 
-#pragma mark - NSObject
-
-- (NSString *)description;
-{
-    NSString *dateString = [NSDateFormatter localizedStringFromDate:self.creationDate dateStyle:NSDateFormatterShortStyle timeStyle:NSDateFormatterMediumStyle];
-    return [NSString stringWithFormat:@"[%@] Fake Log", dateString];
-}
-
-#pragma mark - NSCoding
-
-- (instancetype)initWithCoder:(NSCoder *)aDecoder;
-{
-    self = [self init];
-    if (!self) {
-        return nil;
-    }
-    
-    _creationDate = [[aDecoder decodeObjectOfClass:[NSDate class] forKey:ARKSelfKeyPath(creationDate)] copy];
-    
-    return self;
-}
-
-- (void)encodeWithCoder:(NSCoder *)aCoder;
-{
-    [aCoder encodeObject:self.creationDate forKey:ARKSelfKeyPath(creationDate)];
-}
-
 @end
 
 

Log Viewing/ARKLogTableViewController.m

@@ -481,10 +481,6 @@ - (void)_scrollTableViewToBottomAnimated:(BOOL)animated;
 
 @implementation ARKTimestampLogMessage
 
-@synthesize text = _text;
-@synthesize type = _type;
-@synthesize creationDate = _creationDate;
-
 #pragma mark - Class Methods
 
 + (NSDateFormatter *)sharedDateFormatter;
@@ -505,26 +501,13 @@ + (NSDateFormatter *)sharedDateFormatter;
 
 - (instancetype)initWithDate:(NSDate *)date;
 {
-    self = [self init];
-    if (!self) {
-        return nil;
-    }
-    
-    _type = ARKLogTypeSeparator;
-    _creationDate = date;
-    
-    return self;
+    NSString *text = [[[self class] sharedDateFormatter] stringFromDate:date];
+    return [super initWithText:text image:nil type:ARKLogTypeSeparator userInfo:nil creationDate:date];
 }
 
-#pragma mark - Properties
-
-- (NSString *)text;
+- (instancetype)initWithText:(NSString *)text image:(UIImage *)image type:(ARKLogType)type userInfo:(NSDictionary *)userInfo creationDate:(nonnull NSDate *)date;
 {
-    if (!_text) {
-        _text = [[[self class] sharedDateFormatter] stringFromDate:self.creationDate];
-    }
-    
-    return _text;
+    return [self initWithDate:date];
 }
 
 @end

Log Viewing/ARKLogTableViewController_Testing.h

@@ -32,6 +32,12 @@
 
 @interface ARKTimestampLogMessage : ARKLogMessage
 
-- (instancetype)initWithDate:(NSDate *)date;
+- (instancetype)initWithDate:(NSDate *)date NS_DESIGNATED_INITIALIZER;
+
++ (instancetype)new NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithText:(NSString *)text image:(UIImage *)image type:(ARKLogType)type userInfo:(NSDictionary *)userInfo NS_UNAVAILABLE;
+- (instancetype)initWithText:(NSString *)text image:(UIImage *)image type:(ARKLogType)type userInfo:(NSDictionary *)userInfo creationDate:(NSDate *)date NS_UNAVAILABLE;
+
 
 @end

Logging/ARKLogMessage.h

@@ -27,15 +27,22 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface ARKLogMessage : NSObject <NSCopying, NSSecureCoding>
 
++ (instancetype)new NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
+
+/// Creates an ARKLogMessage with the provided parameters, created at the current date.
+/// @see initWithText:image:type:userInfo:creationDate:
 - (instancetype)initWithText:(NSString *)text image:(nullable UIImage *)image type:(ARKLogType)type userInfo:(nullable NSDictionary *)userInfo;
 
+- (instancetype)initWithText:(NSString *)text image:(nullable UIImage *)image type:(ARKLogType)type userInfo:(nullable NSDictionary *)userInfo creationDate:(NSDate *)date NS_DESIGNATED_INITIALIZER;
+
 @property (nonatomic, copy, readonly) NSDate *creationDate;
 @property (nonatomic, copy, readonly) NSString *text;
-@property (nonatomic, readonly) UIImage *image;
+@property (nonatomic, readonly, nullable) UIImage *image;
 @property (nonatomic, readonly) ARKLogType type;
 
-/// Arbitrary information used by ARKLogBlocks. This data is not persisted
-@property (nonatomic, copy, readonly) NSDictionary *userInfo;
+/// Arbitrary information used by ARKLogBlocks. This data is not persisted.
+@property (nonatomic, copy, readonly, nullable) NSDictionary *userInfo;
 
 @end
 

Logging/ARKLogMessage.m

@@ -36,35 +36,35 @@ + (BOOL)supportsSecureCoding;
 
 - (instancetype)initWithText:(NSString *)text image:(UIImage *)image type:(ARKLogType)type userInfo:(NSDictionary *)userInfo;
 {
-    self = [self init];
+    return [self initWithText:text image:image type:type userInfo:userInfo creationDate:[NSDate date]];
+}
+
+- (instancetype)initWithText:(NSString *)text image:(UIImage *)image type:(ARKLogType)type userInfo:(NSDictionary *)userInfo creationDate:(nonnull NSDate *)date;
+{
+    self = [super init];
     if (!self) {
         return nil;
     }
-    
+
     _text = [text copy];
     _image = image;
     _type = type;
     _userInfo = [userInfo copy];
-    _creationDate = [NSDate date];
-    
+    _creationDate = date;
+
     return self;
 }
 
 #pragma mark - NSCoding
 
 - (instancetype)initWithCoder:(NSCoder *)aDecoder;
 {
-    self = [self init];
-    if (!self) {
-        return nil;
-    }
-    
-    _text = [aDecoder decodeObjectOfClass:[NSString class] forKey:ARKSelfKeyPath(text)];
-    _image = [aDecoder decodeObjectOfClass:[UIImage class] forKey:ARKSelfKeyPath(image)];
-    _type = (ARKLogType)[[aDecoder decodeObjectOfClass:[NSNumber class] forKey:ARKSelfKeyPath(type)] unsignedIntegerValue];
-    _creationDate = [[aDecoder decodeObjectOfClass:[NSDate class] forKey:ARKSelfKeyPath(creationDate)] copy];
+    NSString *text = [aDecoder decodeObjectOfClass:[NSString class] forKey:ARKSelfKeyPath(text)];
+    UIImage *image = [aDecoder decodeObjectOfClass:[UIImage class] forKey:ARKSelfKeyPath(image)];
+    ARKLogType type = (ARKLogType)[[aDecoder decodeObjectOfClass:[NSNumber class] forKey:ARKSelfKeyPath(type)] unsignedIntegerValue];
+    NSDate *creationDate = [[aDecoder decodeObjectOfClass:[NSDate class] forKey:ARKSelfKeyPath(creationDate)] copy];
 
-    return self;
+    return [self initWithText:text image:image type:type userInfo:nil creationDate:creationDate];
 }
 
 - (void)encodeWithCoder:(NSCoder *)aCoder;