Expose a data-source-oriented API for PhotosViewController

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 Changes for users of the library currently on `develop`:
 
-_This space intentionally left blank._
+- Expose a data-source-oriented API for PhotosViewController ([#226](https://github.com/NYTimes/NYTPhotoViewer/pull/226))
 
 ## [1.2.0](https://github.com/NYTimes/NYTPhotoViewer/releases/tag/1.2.0)
 

Example/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -1,5 +1,15 @@
 {
   "images" : [
+    {
+      "idiom" : "iphone",
+      "size" : "20x20",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "iphone",
+      "size" : "20x20",
+      "scale" : "3x"
+    },
     {
       "idiom" : "iphone",
       "size" : "29x29",

Example/Assets.xcassets/Chess.imageset/Contents.json

@@ -0,0 +1,23 @@
+{
+  "images" : [
+    {
+      "idiom" : "universal",
+      "filename" : "dzombak-chess.jpg",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "filename" : "dzombak-chess-1.jpg",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "filename" : "dzombak-chess-2.jpg",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}

LICENSE.md

@@ -1,11 +1,11 @@
-Copyright (c) 2015-2016 The New York Times Company
- 
+Copyright (c) 2015-2017 The New York Times Company
+
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this library except in compliance with the License.
 You may obtain a copy of the License at
- 
+
     http://www.apache.org/licenses/LICENSE-2.0
- 
+
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

NYTPhotoViewer.xcodeproj/xcshareddata/xcschemes/NYTPhotoViewer.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0720"
+   LastUpgradeVersion = "0820"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

NYTPhotoViewer.xcodeproj/xcshareddata/xcschemes/NYTPhotoViewerCore.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0720"
+   LastUpgradeVersion = "0820"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

NYTPhotoViewer/NYTPhotoCaptionView.h

@@ -13,6 +13,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  *  A view used to display the caption for a photo.
+ *
+ *  This is used by default when no custom caption view is provided.
  */
 @interface NYTPhotoCaptionView : UIView <NYTPhotoCaptionViewLayoutWidthHinting>
 

NYTPhotoViewer/NYTPhotoViewer.h

@@ -17,7 +17,7 @@ FOUNDATION_EXPORT const unsigned char NYTPhotoViewerVersionString[];
 // In this header, you should import all the public headers of your framework using statements like #import <NYTPhotoViewer/PublicHeader.h>
 #import <NYTPhotoViewer/NYTPhotoCaptionView.h>
 #import <NYTPhotoViewer/NYTPhotoDismissalInteractionController.h>
-#import <NYTPhotoViewer/NYTPhotosDataSource.h>
+#import <NYTPhotoViewer/NYTPhotoViewerArrayDataSource.h>
 #import <NYTPhotoViewer/NYTPhotosOverlayView.h>
 #import <NYTPhotoViewer/NYTPhotosViewController.h>
 #import <NYTPhotoViewer/NYTPhotoTransitionAnimator.h>
@@ -29,6 +29,7 @@ FOUNDATION_EXPORT const unsigned char NYTPhotoViewerVersionString[];
 #import <NYTPhotoViewer/NYTPhoto.h>
 #import <NYTPhotoViewer/NYTPhotoCaptionViewLayoutWidthHinting.h>
 #import <NYTPhotoViewer/NYTPhotoContainer.h>
-#import <NYTPhotoViewer/NYTPhotosViewControllerDataSource.h>
+#import <NYTPhotoViewer/NYTPhotoViewerDataSource.h>
 
+// Support
 #import <NYTPhotoViewer/NSBundle+NYTPhotoViewer.h>

NYTPhotoViewer/NYTPhotoViewerArrayDataSource.h

@@ -0,0 +1,37 @@
+//
+//  NYTPhotoViewerArrayDataSource.h
+//  NYTPhotoViewer
+//
+//  Created by Brian Capps on 2/11/15.
+//  Copyright (c) 2017 The New York Times Company. All rights reserved.
+//
+
+@import Foundation;
+
+#import "NYTPhotoViewerDataSource.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  A simple concrete implementation of `NYTPhotoViewerDataSource`, for use with an array of images.
+ */
+@interface NYTPhotoViewerArrayDataSource : NSObject <NYTPhotoViewerDataSource, NSFastEnumeration>
+
+@property (nonatomic, readonly) NSArray<id<NYTPhoto>> *photos;
+
+/**
+ *  The designated initializer that takes and stores an array of photos.
+ *
+ *  @param photos An array of objects conforming to the `NYTPhoto` protocol.
+ *
+ *  @return A fully initialized data source.
+ */
+- (instancetype)initWithPhotos:(nullable NSArray<id<NYTPhoto>> *)photos NS_DESIGNATED_INITIALIZER;
+
++ (instancetype)dataSourceWithPhotos:(nullable NSArray<id<NYTPhoto>> *)photos;
+
+- (id<NYTPhoto>)objectAtIndexedSubscript:(NSUInteger)idx;
+
+@end
+
+NS_ASSUME_NONNULL_END

NYTPhotoViewer/NYTPhotoViewerArrayDataSource.m

@@ -0,0 +1,69 @@
+//
+//  NYTPhotoViewerArrayDataSource.m
+//  NYTPhotoViewer
+//
+//  Created by Brian Capps on 2/11/15.
+//  Copyright (c) 2017 The New York Times Company. All rights reserved.
+//
+
+#import "NYTPhotoViewerArrayDataSource.h"
+
+@implementation NYTPhotoViewerArrayDataSource
+
+#pragma mark - NSObject
+
+- (instancetype)init {
+    return [self initWithPhotos:nil];
+}
+
+#pragma mark - NYTPhotosDataSource
+
+- (instancetype)initWithPhotos:(nullable NSArray<id<NYTPhoto>> *)photos {
+    self = [super init];
+
+    if (self) {
+        if (photos == nil) {
+            _photos = @[];
+        } else {
+            _photos = [photos copy];
+        }
+    }
+
+    return self;
+}
+
++ (instancetype)dataSourceWithPhotos:(nullable NSArray<id<NYTPhoto>> *)photos {
+    return [[self alloc] initWithPhotos:photos];
+}
+
+#pragma mark - NSFastEnumeration
+
+- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(__unsafe_unretained id [])buffer count:(NSUInteger)length {
+    return [self.photos countByEnumeratingWithState:state objects:buffer count:length];
+}
+
+#pragma mark - NYTPhotosViewControllerDataSource
+
+- (NSNumber *)numberOfPhotos {
+    return @(self.photos.count);
+}
+
+- (nullable id <NYTPhoto>)photoAtIndex:(NSInteger)photoIndex {
+    if (photoIndex < self.photos.count) {
+        return self.photos[photoIndex];
+    }
+
+    return nil;
+}
+
+- (NSInteger)indexOfPhoto:(id <NYTPhoto>)photo {
+    return [self.photos indexOfObject:photo];
+}
+
+#pragma mark - Subscripting
+
+- (id<NYTPhoto>)objectAtIndexedSubscript:(NSUInteger)idx {
+    return self.photos[idx];
+}
+
+@end

NYTPhotoViewer/NYTPhotoViewerCore.h

@@ -1,5 +1,5 @@
 //
-//  NYTPhotoViewer.h
+//  NYTPhotoViewerCore.h
 //  NYTPhotoViewer
 //
 //  Created by David Beck on 3/2/16.
@@ -17,7 +17,7 @@ FOUNDATION_EXPORT const unsigned char NYTPhotoViewerCoreVersionString[];
 // In this header, you should import all the public headers of your framework using statements like #import <NYTPhotoViewer/PublicHeader.h>
 #import <NYTPhotoViewer/NYTPhotoCaptionView.h>
 #import <NYTPhotoViewer/NYTPhotoDismissalInteractionController.h>
-#import <NYTPhotoViewer/NYTPhotosDataSource.h>
+#import <NYTPhotoViewer/NYTPhotoViewerArrayDataSource.h>
 #import <NYTPhotoViewer/NYTPhotosOverlayView.h>
 #import <NYTPhotoViewer/NYTPhotosViewController.h>
 #import <NYTPhotoViewer/NYTPhotoTransitionAnimator.h>
@@ -29,6 +29,7 @@ FOUNDATION_EXPORT const unsigned char NYTPhotoViewerCoreVersionString[];
 #import <NYTPhotoViewer/NYTPhoto.h>
 #import <NYTPhotoViewer/NYTPhotoCaptionViewLayoutWidthHinting.h>
 #import <NYTPhotoViewer/NYTPhotoContainer.h>
-#import <NYTPhotoViewer/NYTPhotosViewControllerDataSource.h>
+#import <NYTPhotoViewer/NYTPhotoViewerDataSource.h>
 
+// Support
 #import <NYTPhotoViewer/NSBundle+NYTPhotoViewer.h>

NYTPhotoViewer/NYTPhotoViewerSinglePhotoDataSource.h

@@ -0,0 +1,40 @@
+//
+//  NYTPhotoViewerSinglePhotoDataSource.h
+//  NYTPhotoViewer
+//
+//  Created by Chris Dzombak on 1/27/17.
+//  Copyright © 2017 The New York Times Company. All rights reserved.
+//
+
+@import Foundation;
+
+#import "NYTPhotoViewerDataSource.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  A simple concrete implementation of `NYTPhotoViewerDataSource`, for use with a single image.
+ */
+@interface NYTPhotoViewerSinglePhotoDataSource : NSObject <NYTPhotoViewerDataSource>
+
+@property (nonatomic, readonly) id<NYTPhoto> photo;
+
+/**
+ *  The designated initializer that takes and stores a single photo.
+ *
+ *  @param photos An object conforming to the `NYTPhoto` protocol.
+ *
+ *  @return A fully initialized data source.
+ */
+- (instancetype)initWithPhoto:(id<NYTPhoto>)photo NS_DESIGNATED_INITIALIZER;
+
++ (instancetype)dataSourceWithPhoto:(id<NYTPhoto>)photo;
+
+/**
+ *  Initializing without a photo is invalid.
+ */
+- (instancetype)init NS_UNAVAILABLE;
+
+@end
+
+NS_ASSUME_NONNULL_END

NYTPhotoViewer/NYTPhotoViewerSinglePhotoDataSource.m

@@ -0,0 +1,38 @@
+//
+//  NYTPhotoViewerSinglePhotoDataSource.m
+//  NYTPhotoViewer
+//
+//  Created by Chris Dzombak on 1/27/17.
+//  Copyright © 2017 The New York Times Company. All rights reserved.
+//
+
+#import "NYTPhotoViewerSinglePhotoDataSource.h"
+
+@implementation NYTPhotoViewerSinglePhotoDataSource
+
+- (instancetype)initWithPhoto:(id<NYTPhoto>)photo {
+    if ((self = [super init])) {
+        _photo = photo;
+    }
+    return self;
+}
+
++ (instancetype)dataSourceWithPhoto:(id<NYTPhoto>)photo {
+    return [[self alloc] initWithPhoto:photo];
+}
+
+#pragma mark NYTPhotoViewerDataSource
+
+- (NSNumber *)numberOfPhotos {
+    return @(1);
+}
+
+- (id<NYTPhoto>)photoAtIndex:(NSInteger)photoIndex {
+    return self.photo;
+}
+
+- (NSInteger)indexOfPhoto:(id<NYTPhoto>)photo {
+    return 0;
+}
+
+@end