Merge pull request #4 from firebase/mm-add-examples

0.2.3 Release Candidate

Author: asciimike

FirebaseUI.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
   s.name         = "FirebaseUI"
-  s.version      = "0.2.1"
+  s.version      = "0.2.3"
   s.summary      = "UI binding libraries for Firebase."
   s.homepage     = "https://github.com/firebase/FirebaseUI-iOS"
   s.license      = { :type => 'MIT', :file => 'LICENSE' }
   s.author       = { "Firebase" => "[email protected]" }
   s.social_media_url = "https://twitter.com/firebase"
-  s.source       = { :git => "https://github.com/firebase/FirebaseUI-iOS.git", :tag => 'v0.2.1' }
+  s.source       = { :git => "https://github.com/firebase/FirebaseUI-iOS.git", :tag => 'v0.2.3' }
   s.source_files = "FirebaseUI/**/*.{h,m}"
   s.dependency  "Firebase", "~> 2.2"
   s.platform = :ios

FirebaseUI.xcodeproj/project.pbxproj

@@ -119,10 +119,10 @@
 		D8B6ACEA1B5839F7005CDDB2 /* Implementation */ = {
 			isa = PBXGroup;
 			children = (
-				D8DF55611B742DB40030E996 /* FirebaseCollectionViewDataSource.m */,
 				D8B6ACEF1B583C41005CDDB2 /* FirebaseArray.m */,
 				D8B6ACF21B583C41005CDDB2 /* FirebaseDataSource.m */,
 				D8B6ACF11B583C41005CDDB2 /* FirebaseTableViewDataSource.m */,
+				D8DF55611B742DB40030E996 /* FirebaseCollectionViewDataSource.m */,
 			);
 			name = Implementation;
 			sourceTree = "<group>";

FirebaseUI/API/FirebaseCollectionViewDataSource.h

@@ -43,6 +43,11 @@
  */
 @property (strong, nonatomic, __NON_NULL) Class modelClass;
 
+/**
+ * The cell class to coerce UICollectionViewCells to (if desired). For instance, if the cellClass is set to [CustomCollectionViewCell class] in Obj-C or CustomCollectionViewCell in Swift, then objects of type CustomCollectionViewCell will be returned instead of type UICollectionViewCell.
+ */
+@property (strong, nonatomic, __NON_NULL) Class cellClass;
+
 /**
  * The reuse identifier for cells in the UICollectionView.
  */
@@ -53,10 +58,15 @@
  */
 @property (strong, nonatomic, __NON_NULL) UICollectionView *collectionView;
 
+/**
+ * Property to keep track of prototype cell use, to not register a class for the UICollectionView or do similar book keeping.
+ */
+@property BOOL hasPrototypeCell;
+
 /**
  * The callback to populate a subclass of UICollectionViewCell with an object provided by the datasource.
  */
-@property (strong, nonatomic, __NON_NULL) void(^populateCell)(UICollectionViewCell * __NON_NULL_PTR cell, NSObject * __NON_NULL_PTR object);
+@property (strong, nonatomic, __NON_NULL) void(^populateCell)(__kindof UICollectionViewCell * __NON_NULL_PTR cell, __kindof NSObject * __NON_NULL_PTR object);
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with FDataSnapshots.
@@ -65,7 +75,16 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+
+/**
+ * Initialize an instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with FDataSnapshots. Note that this method is used when using prototype cells, where the cells don't need to be registered in the class.
+ * @param ref A Firebase reference to bind the datasource to
+ * @param identifier A string to use as a CellReuseIdentifier
+ * @param collectionView An instance of a UICollectionView to bind to
+ * @return An instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with FDataSnapshots
+ */
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref prototypeReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates a custom subclass of UICollectionViewCell with FDataSnapshots.
@@ -75,7 +94,7 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates a custom subclass of UICollectionViewCell with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellClass:(__NULLABLE Class)cell reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellClass:(__NULLABLE Class)cell cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates a custom xib with FDataSnapshots.
@@ -85,7 +104,7 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates a custom xib with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref nibNamed:(__NON_NULL NSString *)nibName reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref nibNamed:(__NON_NULL NSString *)nibName cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with a custom model class.
@@ -95,7 +114,17 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+
+/**
+ * Initialize an instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with a custom model class. Note that this method is used when using prototype cells, where the cells don't need to be registered in the class.
+ * @param ref A Firebase reference to bind the datasource to
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
+ * @param identifier A string to use as a CellReuseIdentifier
+ * @param collectionView An instance of a UICollectionView to bind to
+ * @return An instance of FirebaseCollectionViewDataSource that populates UICollectionViewCells with a custom model class
+ */
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model prototypeReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates a custom subclass of UICollectionViewCell with a custom model class.
@@ -106,7 +135,7 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates a custom subclass of UICollectionViewCell with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellClass:(__NULLABLE Class)cell reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellClass:(__NULLABLE Class)cell cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * Initialize an instance of FirebaseCollectionViewDataSource that populates a custom xib with a custom model class.
@@ -117,12 +146,12 @@
  * @param collectionView An instance of a UICollectionView to bind to
  * @return An instance of FirebaseCollectionViewDataSource that populates a custom xib with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model nibNamed:(__NON_NULL NSString *)nibName reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model nibNamed:(__NON_NULL NSString *)nibName cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UICollectionView *)collectionView;
 
 /**
  * This method populates the fields of a UICollectionViewCell or subclass given an FDataSnapshot (or custom model object).
  * @param callback A block which returns an initialized UICollectionViewCell (or subclass) and the corresponding object to populate the cell with.
  */
-- (void)populateCellWithBlock:(__NON_NULL void(^)(UICollectionViewCell * __NON_NULL_PTR cell, NSObject * __NON_NULL_PTR object))callback;
+- (void)populateCellWithBlock:(__NON_NULL void(^)(__kindof UICollectionViewCell * __NON_NULL_PTR cell, __kindof NSObject * __NON_NULL_PTR object))callback;
 
 @end

FirebaseUI/API/FirebaseTableViewDataSource.h

@@ -53,10 +53,15 @@
  */
 @property (strong, nonatomic, __NON_NULL) UITableView *tableView;
 
+/**
+ * Property to keep track of prototype cell use, to not register a class for the UICollectionView or do similar book keeping.
+ */
+@property BOOL hasPrototypeCell;
+
 /**
  * The callback to populate a subclass of UITableViewCell with an object provided by the datasource.
  */
-@property (strong, nonatomic, __NON_NULL) void(^populateCell)(UITableViewCell * __NON_NULL_PTR cell, NSObject * __NON_NULL_PTR object);
+@property (strong, nonatomic, __NON_NULL) void(^populateCell)(__kindof UITableViewCell * __NON_NULL_PTR cell, __kindof NSObject * __NON_NULL_PTR object);
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with FDataSnapshots.
@@ -65,7 +70,16 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+
+/**
+ * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with FDataSnapshots. Note that this method is used when using prototype cells, where the cells don't need to be registered in the class.
+ * @param ref A Firebase reference to bind the datasource to
+ * @param identifier A string to use as a CellReuseIdentifier
+ * @param tableView An instance of a UITableView to bind to
+ * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with FDataSnapshots
+ */
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref prototypeReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates a custom subclass of UITableViewCell with FDataSnapshots.
@@ -75,7 +89,7 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates a custom subclass of UITableViewCell with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellClass:(__NULLABLE Class)cell reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref cellClass:(__NULLABLE Class)cell cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates a custom xib with FDataSnapshots.
@@ -85,7 +99,7 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates a custom xib with FDataSnapshots
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref nibNamed:(__NON_NULL NSString *)nibName reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref nibNamed:(__NON_NULL NSString *)nibName cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom model class.
@@ -95,7 +109,17 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+
+/**
+ * Initialize an instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom model class. Note that this method is used when using prototype cells, where the cells don't need to be registered in the class.
+ * @param ref A Firebase reference to bind the datasource to
+ * @param model A custom class that FDataSnapshots are coerced to, defaults to FDataSnapshot if nil
+ * @param identifier A string to use as a CellReuseIdentifier
+ * @param tableView An instance of a UITableView to bind to
+ * @return An instance of FirebaseTableViewDataSource that populates UITableViewCells with a custom model class
+ */
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model prototypeReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates a custom subclass of UITableViewCell with a custom model class.
@@ -106,7 +130,7 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates a custom subclass of UITableViewCell with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellClass:(__NULLABLE Class)cell reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model cellClass:(__NULLABLE Class)cell cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * Initialize an instance of FirebaseTableViewDataSource that populates a custom xib with a custom model class.
@@ -117,13 +141,13 @@
  * @param tableView An instance of a UITableView to bind to
  * @return An instance of FirebaseTableViewDataSource that populates a custom xib with a custom model class
  */
-- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model nibNamed:(__NON_NULL NSString *)nibName reuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
+- (__NON_NULL instancetype)initWithRef:(__NON_NULL Firebase *)ref modelClass:(__NULLABLE Class)model nibNamed:(__NON_NULL NSString *)nibName cellReuseIdentifier:(__NON_NULL NSString *)identifier view:(__NON_NULL UITableView *)tableView;
 
 /**
  * This method populates the fields of a UITableViewCell or subclass given a model object (or FDataSnapshot).
  * @param callback A block which returns an initialized UITableViewCell (or subclass) and the corresponding object to populate the cell with.
  */
-- (void)populateCellWithBlock:(__NON_NULL void(^)(UITableViewCell * __NON_NULL_PTR cell, NSObject * __NON_NULL_PTR object))callback;
+- (void)populateCellWithBlock:(nonnull void (^)(__kindof UITableViewCell * __NON_NULL_PTR cell, __kindof NSObject * __NON_NULL_PTR object))callback;
 
 @end