Merge branch 'master' of https://github.com/wtmoose/TLIndexPathTools

Author: wtmoose

README.md

@@ -11,7 +11,7 @@ TLIndexPathTools is a small set of classes that can greatly simplify your table
 
 TLIndexPathTools is as lightweight as you want it to be. Start small by using `TLIndexPathDataModel` as your data model (instead of an array) and gain the ability to easily organize data into sections and simplify your view controller with APIs like `[dataModel numberOfRowsInSection:]`, `[dataModel itemAtIndexPath:]`, and `[dataModel indexPathForItem:]`. Or keep reading to learn about automatic batch updates, easier Core Data integration and more.
 
-##Installation
+## Installation
 
 Add "TLIndexPathTools" to your podfile or, if you're not using CocoaPods:
 
@@ -21,7 +21,7 @@ Add "TLIndexPathTools" to your podfile or, if you're not using CocoaPods:
 
 <!--CoreData is required for Core Data integration and because `TLIndexPathSectionInfo` implements the `NSFetchedResultsSectionInfo` protocol. QuartzCore is required because the Grid extension uses it.-->
 
-##Overview
+## Overview
 
 `NSArray` is the standard construct for simple table and collection view data models. However, if multiple sections are involved, the typical setup is an `NSArray` containing section names and an `NSDictionary` of `NSArrays` containing data items, keyed by section name. Since table and collection views work with `NSIndexPaths`, the following pattern is used repeatedly in data source and delegate methods:
 
@@ -43,7 +43,7 @@ Most of the functionality in TLIndexPathTools can be accomplished with just `TLI
 
 This version of TLIndexPathTools is designed to handle up to a few thousand items. Larger data sets may have performance issues.
 
-###TLIndexPathDataModel
+### TLIndexPathDataModel
 
 `TLIndexPathDataModel` is an immutable object you use in your view controller to hold your data items instead of an array (or dictionary of arrays, for multiple sections). There are four initializers, a basic one and three for handling multiple sections:
 
@@ -91,7 +91,7 @@ dataModel.sections;
 
 As an immutable object, all of the properties and methods in `TLIndexPathDataModel` are read-only. So using the data model is very straightforward once you've selected the appropriate initializer.
 
-###TLIndexPathUpdates
+### TLIndexPathUpdates
 
 `TLIndexPathUpdates` is a companion class to `TLIndexPathDataModel` for batch updates. You provide two versions of your data model to the initializer and the inserts, deletes, and moves are calculated. Then call either `performBatchUpdatesOnTableView:` or `performBatchUpdatesOnCollectionView:` to perform the updates.
 
@@ -113,7 +113,7 @@ TLIndexPathUpdates *updates = [[TLIndexPathUpdates alloc] initWithOldDataModel:o
 
 Thats all it takes!
 
-###TLIndexPathController
+### TLIndexPathController
 
 `TLIndexPathController` is TLIndexPathTools' version of `NSFetchedResultsController`. It should not come as a surprise, then, that you must use this class if you want to integrate with Core Data.
 
@@ -199,7 +199,7 @@ The `willUpdateDataModel` delegate method is a really cool feature of `TLIndexPa
 }
 ```
 
-###TLTableViewController & TLCollectionViewController
+### TLTableViewController & TLCollectionViewController
 
 `TLTableViewController` and `TLCollectionViewController` are table and collection view base classes that use `TLIndexPathController` and implement the essential data source and delegate methods to get you up and running quickly. Both classes look much like the code outlined above for integrating with `TLIndexPathController`.
 
@@ -209,12 +209,15 @@ Both classes support view controller-backed cells. Enabling this feature is as e
 
 Most of the sample projects are based on `TLTableViewController` or `TLCollectionViewController`, so a brief perusal will give you a good idea what can be accomplished with a few lines of code.
 
-##Documentation
+## Documentation
 
 The Xcode docset can be generated by running the Docset project. The build configuration assumes [Appledoc][6] is installed at /usr/local/bin/appledoc. This can be changed at TLIndexPathTools project | Docset target | Build Phases tab | Run Script.
 
 The API documentation is also [available online][7].
 
+## About SwiftKick Mobile
+We build high quality apps! [Get in touch](http://www.swiftkickmobile.com) if you need help with a project.
+
 [1]:https://github.com/wtmoose/TLIndexPathTools/blob/master/Examples/Settings/Settings/SettingsTableViewController.m
 [2]:https://github.com/wtmoose/TLIndexPathTools/blob/master/Examples/Collapse/Collapse/CollapseTableViewController.m
 [3]:https://github.com/wtmoose/TLIndexPathTools/blob/master/Examples/Outline/Outline/OutlineTableViewController.m

TLIndexPathTools.xcodeproj/project.pbxproj

@@ -532,6 +532,7 @@
 					"$(inherited)",
 				);
 				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
+				GCC_WARN_ABOUT_MISSING_NEWLINE = YES;
 				GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
 				GCC_WARN_UNDECLARED_SELECTOR = YES;
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
@@ -571,6 +572,7 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
+				GCC_WARN_ABOUT_MISSING_NEWLINE = YES;
 				GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
 				GCC_WARN_UNDECLARED_SELECTOR = YES;
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;

TLIndexPathTools/Controllers/TLIndexPathController.h

@@ -60,7 +60,8 @@ extern NSString * kTLIndexPathUpdatesKey;
  it can be replaced with a model containing a "no results" item.
  
  @param controller  the index path controller that sent the message.
- @param updates  the updates object that can be used to perform batch updates on a table or collection view.
+ @param oldDataModel the old data model used before the update.
+ @param updatedDataModel the new data model returned after the update.
  @returns an alternative data model to use instead of `updatedDataModel` or `nil` to use `updatedDataModel`
  
  */
@@ -167,7 +168,7 @@ extern NSString * kTLIndexPathUpdatesKey;
 /**
  Returns an index path controller initialized with the given items.
  
- @param items  the aray of items
+ @param items  the array of items
  @return the index path controller with a default data model representation of the given items
  
  A default data model is initialized with items where the properties `identifierKeyPath`,
@@ -187,15 +188,15 @@ extern NSString * kTLIndexPathUpdatesKey;
  Returns an index path controller initialized with the given fetch request and
  configuration parameters.
  
- @param fetchRequest
- @param context
- @param sectionNameKeyPath
- @param identifierKeyPath
- @param cacheName
+ @param fetchRequest the fetch request used to do the fetching
+ @param context the managed object context used to fetch objects
+ @param sectionNameKeyPath the key path on the fetched objects used to determine the section they belong to
+ @param identifierKeyPath how the identifier should be generated
+ @param cacheName the name of the file used to cache section information
  @return the index path controller with a default data model representation of the given fetch request
  
  */
-- (instancetype)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString * __nullable)sectionNameKeyPath identifierKeyPath:(NSString * __nullable)identifierKeyPath cacheName:(NSString * __nullable)name;
+- (instancetype)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString * __nullable)sectionNameKeyPath identifierKeyPath:(NSString * __nullable)identifierKeyPath cacheName:(NSString * __nullable)cacheName;
 
 #pragma mark - Configuration information
 /** @name Configuration information */
@@ -283,7 +284,7 @@ extern NSString * kTLIndexPathUpdatesKey;
  fetch request (and perform fetch), in-memory sort descriptors, and in-memory
  predicate as a single update.
  
- @param udpates  a block that makes changes to the controller
+ @param updates  a block that makes changes to the controller
  @param completion  a block to be executed after the batch updates are performed.
         Note that controller:didUpdateDataModel: is called before this block.
  

TLIndexPathTools/Controllers/TLIndexPathController.m

@@ -62,13 +62,13 @@ - (instancetype)initWithDataModel:(TLIndexPathDataModel *)dataModel
     return self;
 }
 
-- (id)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString *)sectionNameKeyPath identifierKeyPath:(NSString *)identifierKeyPath cacheName:(NSString *)name
+- (id)initWithFetchRequest:(NSFetchRequest *)fetchRequest managedObjectContext:(NSManagedObjectContext *)context sectionNameKeyPath:(NSString *)sectionNameKeyPath identifierKeyPath:(NSString *)identifierKeyPath cacheName:(NSString *)cacheName
 {
     TLIndexPathDataModel *dataModel = [[TLIndexPathDataModel alloc] initWithItems:@[] sectionNameKeyPath:sectionNameKeyPath identifierKeyPath:identifierKeyPath];
     if (self = [self initWithDataModel:dataModel]) {
         //initialize the backing controller with nil sectionNameKeyPath because we don't require
         //items to be sorted by section, but NSFetchedResultsController does.
-        _backingController = [[NSFetchedResultsController alloc] initWithFetchRequest:fetchRequest managedObjectContext:context sectionNameKeyPath:sectionNameKeyPath cacheName:name];
+        _backingController = [[NSFetchedResultsController alloc] initWithFetchRequest:fetchRequest managedObjectContext:context sectionNameKeyPath:sectionNameKeyPath cacheName:cacheName];
         _backingController.delegate = self;
     }
     return self;

TLIndexPathTools/Data Model/TLIndexPathItem.h

@@ -68,4 +68,4 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-NS_ASSUME_NONNULL_END
+NS_ASSUME_NONNULL_END

TLIndexPathTools/Data Model/TLIndexPathItem.m

@@ -49,7 +49,7 @@ + (NSArray *)identifiersForIndexPathItems:(NSArray *)indexPathItems
 
 - (NSUInteger)hash
 {
-    NSInteger hash = 0;
+    NSUInteger hash = 0;
     hash += 31 * hash + [self.identifier hash];
     hash += 31 * hash + [self.sectionName hash];
     hash += 31 * hash + [self.cellIdentifier hash];

TLIndexPathTools/Data Model/TLIndexPathSectionInfo.h

@@ -42,4 +42,4 @@ NS_ASSUME_NONNULL_BEGIN
 - (instancetype)initWithItems:(NSArray *)items name:(NSString * __nullable)name indexTitle:(NSString * __nullable)indexTitle;
 @end
 
-NS_ASSUME_NONNULL_END
+NS_ASSUME_NONNULL_END

TLIndexPathTools/Extensions/No Results/TLNoResultsTableDataModel.h

@@ -33,5 +33,5 @@
 @property (strong, nonatomic, readonly) NSString *blankCellIdentifier;
 @property (strong, nonatomic, readonly) NSString *noResultsCellIdentifier;
 @property (strong, nonatomic, readonly) NSString *noResultsText;
-- initWithRows:(NSInteger)rows blankCellId:(NSString *)blankCellId noResultsCellId:(NSString *)noResultsCellId noResultsText:(NSString *)noResultsText;
+- (instancetype)initWithRows:(NSInteger)rows blankCellId:(NSString *)blankCellId noResultsCellId:(NSString *)noResultsCellId noResultsText:(NSString *)noResultsText;
 @end

TLIndexPathTools/Extensions/No Results/TLNoResultsTableDataModel.m

@@ -26,7 +26,7 @@
 
 @implementation TLNoResultsTableDataModel
 
-- (id)initWithRows:(NSInteger)rows blankCellId:(NSString *)blankCellId noResultsCellId:(NSString *)noResultsCellId noResultsText:(NSString *)noResultsText
+- (instancetype)initWithRows:(NSInteger)rows blankCellId:(NSString *)blankCellId noResultsCellId:(NSString *)noResultsCellId noResultsText:(NSString *)noResultsText
 {
     rows = MAX(rows, 1);
     NSMutableArray *items = [[NSMutableArray alloc] initWithCapacity:rows];