documentation

Author: aaronbrethorst

ABReleaseNotesViewController/ABReleaseNotesDownloader.h

@@ -26,7 +26,30 @@
 
 #import <Foundation/Foundation.h>
 
+/**
+ Retrieves release notes and the current version number from the App Store for the app whose
+ app identifier is passed in on initialization.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+
 @interface ABReleaseNotesDownloader : NSObject
+
+/**
+ Returns a newly initialized downloader with the specified app identifier.
+ 
+ @param appIdentifier The unique ID of your app in the App Store.
+ 
+ @return A newly initialized `ABReleaseNotesDownloader` object.
+ */
 - (instancetype)initWithAppIdentifier:(NSString *)appIdentifier;
+
+/**
+ Responsible for checking the App Store for updates to the app identifier specified in initialization.
+ 
+ @param checker The block to execute after the update check finishes. This block has no return value, but has three parameters: a BOOL flag indicating whether the app has been updated, release notes, and a new version number. and takes no parameters.
+ */
 - (void)checkForUpdates:(void (^)(BOOL updated, NSString *releaseNotes, NSString *versionNumber))checker;
 @end
+
+NS_ASSUME_NONNULL_END

ABReleaseNotesViewController/ABReleaseNotesPresentationController.h

@@ -26,6 +26,12 @@
 
 #import <UIKit/UIKit.h>
 
+/**
+ A presentation controller used by `ABReleaseNotesViewController` to control the display of the 
+ release notes controller on screen. Designed to be used as-is, and you shouldn't have to interact
+ directly with this class.
+ */
+
 @interface ABReleaseNotesPresentationController : UIPresentationController
 
 @end

ABReleaseNotesViewController/ABReleaseNotesViewController.h

@@ -25,10 +25,74 @@
 
 #import <UIKit/UIKit.h>
 
+/**
+ 
+ Overview
+ ====
+ 
+ `ABReleaseNotesViewController` is a view controller, and should be the only part of this
+ system with which you'll need to interact directly.
+ 
+ You should generally instantiate `ABReleaseNotesViewController` with the factory class method
+ provided here, instead of calling one of the `-init` methods. However, you can call one of the 
+ `-init:` methods if you really want to, but take care to ensure that the properties set by the
+ factory method are also set wherever you initialize your new view controller.
+ 
+ Notes:
+ ====
+ 
+ * There is no guarantee that your block in `-checkForUpdates:` will ever be called. Do not assume it will be.
+ 
+ Typical Usage
+ ====
+ 
+ Create your release notes object in your init method, or in `-viewDidLoad`:
+ 
+     - (void)viewDidLoad {
+         [super viewDidLoad];
+         self.releaseNotes = [ABReleaseNotesViewController releaseNotesControllerWithAppIdentifier:@"329380089" title:NSLocalizedString(@"Release Notes", @"")];
+     }
+ 
+ After your view appears, begin checking for updates. If an update is available, you may present the view controller immediately, as depicted below:
+ 
+    [self.releaseNotes checkForUpdates:^(BOOL updated) {
+        if (updated) {
+            [self presentViewController:self.releaseNotes animated:YES completion:nil];
+        }
+    }];
+ 
+ Additionally, you could present an alert or some sort of non-modal user interface to the user informing them that they can read release notes if desired.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+
 @interface ABReleaseNotesViewController : UIViewController
+
+/**
+ The style of the blur effect to apply to your view's background.
+ */
 @property(nonatomic,assign) UIBlurEffectStyle blurEffectStyle;
+
+/**
+ The title of the close button at the bottom of the view. By default, this is "Dismiss".
+ */
 @property(nonatomic,copy) NSString *closeButtonTitle;
-@property(nonatomic,copy) UIColor *lineViewColor;
-+ (id)releaseNotesControllerWithAppIdentifier:(NSString *)appIdentifier title:(NSString*)title;
+
+/**
+ Creates and returns a new view controller.
+ 
+ @param appIdentifier The App Store identifier for your app.
+ 
+ @return A newly initialized ABReleaseNotesViewController
+ */
+- (instancetype)initWithAppIdentifier:(NSString*)appIdentifier;
+
+/**
+ Checks the App Store to see if the current version of the app is an updated version.
+ 
+ @param block The completion block called if an update has occurred.
+ */
 - (void)checkForUpdates:(void(^)(BOOL updated))block;
 @end
+
+NS_ASSUME_NONNULL_END

ABReleaseNotesViewController/ABReleaseNotesViewController.m

@@ -37,45 +37,58 @@ @interface ABReleaseNotesViewController ()<UIViewControllerTransitioningDelegate
 @property(nonatomic,strong) UIVisualEffectView *vibrancyView;
 @property(nonatomic,strong) UILabel *titleLabel;
 @property(nonatomic,strong) UITextView *bodyText;
+@property(nonatomic,copy) UIColor *lineViewColor;
 @end
 
 @implementation ABReleaseNotesViewController
 
-#pragma mark - Initialization
-
-- (instancetype)init {
+- (instancetype)initWithAppIdentifier:(NSString*)appIdentifier {
     self = [super init];
-
+    
     if (self) {
-        _blurEffectStyle = UIBlurEffectStyleLight;
-
-        _closeButtonTitle = NSLocalizedString(@"Dismiss", @"");
-
-        _lineViewColor = [UIColor colorWithWhite:0.f alpha:0.25f];
+        self.title = NSLocalizedString(@"Release Notes", @"");
 
-        _bodyText = ({
-            UITextView *textView = [[UITextView alloc] init];
-            textView.translatesAutoresizingMaskIntoConstraints = NO;
-            textView.font = [UIFont preferredFontForTextStyle:UIFontTextStyleBody];
-            textView.backgroundColor = [UIColor clearColor];
-            textView.editable = NO;
-            textView.selectable = NO;
-            textView;
-        });
+        _appIdentifier = [appIdentifier copy];
+        [self commonInit];
     }
     return self;
 }
 
-+ (id)releaseNotesControllerWithAppIdentifier:(NSString *)appIdentifier title:(NSString *)title {
+- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
+    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
+    if (self) {
+        [self commonInit];
+    }
+    return self;
+}
 
-    ABReleaseNotesViewController *controller = [[ABReleaseNotesViewController alloc] init];
-    controller.title = title;
-    controller.appIdentifier = appIdentifier;
-    controller.blurEffectStyle = UIBlurEffectStyleLight;
-    controller.modalPresentationStyle = UIModalPresentationCustom;
-    controller.transitioningDelegate = controller;
+- (instancetype)initWithCoder:(NSCoder *)aDecoder {
+    self = [super initWithCoder:aDecoder];
+    
+    if (self) {
+        [self commonInit];
+    }
+    return self;
+}
 
-    return controller;
+- (void)commonInit {
+    _blurEffectStyle = UIBlurEffectStyleLight;
+    self.modalPresentationStyle = UIModalPresentationCustom;
+    self.transitioningDelegate = self;
+    
+    _closeButtonTitle = NSLocalizedString(@"Dismiss", @"");
+    
+    _lineViewColor = [UIColor colorWithWhite:0.f alpha:0.25f];
+    
+    _bodyText = ({
+        UITextView *textView = [[UITextView alloc] init];
+        textView.translatesAutoresizingMaskIntoConstraints = NO;
+        textView.font = [UIFont preferredFontForTextStyle:UIFontTextStyleBody];
+        textView.backgroundColor = [UIColor clearColor];
+        textView.editable = NO;
+        textView.selectable = NO;
+        textView;
+    });
 }
 
 #pragma mark - UIViewController
@@ -149,6 +162,13 @@ - (void)close {
 #pragma mark - Public Methods
 
 - (void)checkForUpdates:(void(^)(BOOL updated))block {
+    
+    BOOL hasIdentifier = self.appIdentifier.length > 0;
+    NSParameterAssert(hasIdentifier);
+    if (!hasIdentifier) {
+        return;
+    }
+    
     NSString *defaultsAppVersion = [[NSUserDefaults standardUserDefaults] objectForKey:ABReleaseNotesVersionUserDefaultsKey];
     if (!defaultsAppVersion) {
         // it's nil, so write out a value first launch and bail.

Demo/ViewController.m

@@ -26,7 +26,7 @@ - (void)viewDidLoad {
     [self.view addSubview:self.webView];
     [self.webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.apple.com"]]];
 
-    self.releaseNotes = [ABReleaseNotesViewController releaseNotesControllerWithAppIdentifier:@"329380089" title:NSLocalizedString(@"Release Notes", @"")];
+    self.releaseNotes = [[ABReleaseNotesViewController alloc] initWithAppIdentifier:@"329380089"];
 }
 
 - (void)viewDidAppear:(BOOL)animated {