Added some more methods to the queue.

Author: alda-optimizely

OptimizelySDKCore/OptimizelySDKCore/OPTLYQueue.h

@@ -53,12 +53,27 @@ extern const NSInteger OPTLYQueueDefaultMaxSize;
 - (id)dequeue;
 
 /**
- * Returns a reference to the oldest item in the queue (the queue is not mutated).
+ * Returns and removes the oldest N item in the queue (the queue is mutated).
  *
- * @return A reference to the oldest item in the queue.
+ * @param numberOfItems The number of itmes to remove.
+ * @return The oldest N items from the queue.
+ */
+- (NSArray *)dequeueNItems:(NSInteger)numberOfItems;
+
+/**
+ * Returns a copy of the oldest item in the queue (the queue is not mutated).
+ *
+ * @return A copy of the oldest item in the queue.
  */
 - (id)front;
 
+/**
+ * Returns a copy of the oldest N items in the queue (the queue is not mutated).
+ *
+ * @return An array with a copy of the oldest N items in the queue.
+ */
+- (NSArray *)firstNItems:(NSInteger)numberOfItems;
+
 /**
  * Gets the size of the queue.
  *

OptimizelySDKCore/OptimizelySDKCore/OPTLYQueue.m

@@ -58,6 +58,16 @@ - (id)front {
     return item;
 }
 
+- (NSArray *)firstNItems:(NSInteger)numberOfItems {
+    NSArray *items;
+    if (!self.isEmpty) {
+        NSInteger endOfRange = numberOfItems > [self size] ? [self size] : numberOfItems;
+        NSRange range = NSMakeRange(0, endOfRange);
+        items = [self.mutableQueue subarrayWithRange:range];
+    }
+    return items;
+}
+
 - (id)dequeue {
     id item = nil;
     if (!self.isEmpty) {
@@ -67,6 +77,17 @@ - (id)dequeue {
     return item;
 }
 
+- (NSArray *)dequeueNItems:(NSInteger)numberOfItems {
+    NSArray *items;
+    if (!self.isEmpty) {
+        NSInteger endOfRange = numberOfItems > [self size] ? [self size] : numberOfItems;
+        NSRange range = NSMakeRange(0, endOfRange);
+        items = [self.mutableQueue subarrayWithRange:range];
+        [self.mutableQueue removeObjectsInRange:range];
+    }
+    return items;
+}
+
 - (NSInteger)size {
     return [self.queue count];
 }

OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYQueueTest.m

@@ -45,23 +45,13 @@ - (void)setUp {
 
 - (void)tearDown {
     self.queue = nil;
-    self.testData1 = nil;
-    self.testData2 = nil;
-    self.testData3 = nil;
-    self.testData4 = nil;
     [super tearDown];
 }
 
-- (void)testQueueInit
-{
-    OPTLYQueue *queue = [OPTLYQueue new];
-    XCTAssert(queue.maxQueueSize == OPTLYQueueDefaultMaxSize, @"Invalid max queue size for default queue initialization.");
-}
-
 - (void)testQueueInitWithQueueSize {
     XCTAssertNotNil(self.queue);
     NSInteger queueCapacity = [self.queue maxQueueSize];
-    XCTAssert(queueCapacity == kMaxQueueSize, @"Incorrect max queue size");
+    XCTAssert(queueCapacity == kMaxQueueSize, @"incorrect max queue size");
 }
 
 // queue insertion should cap off at max size
@@ -72,7 +62,7 @@ - (void)testEnqueueAndSize
 }
 
 // dequeue'd value should be the oldest
-// queue size should decrease
+// queue size shoudl decrease
 - (void)testDequeue
 {
     NSString *dequeuedData = [self.queue dequeue];
@@ -81,13 +71,37 @@ - (void)testDequeue
     XCTAssert(size == kMaxQueueSize-1, @"Invalid queue size after dequeue.");
 }
 
+- (void)testDequeueNItems
+{
+    NSInteger numberOfItems = 3;
+    NSArray *firstNItems = [self.queue dequeueNItems:numberOfItems];
+    XCTAssert([firstNItems count] == numberOfItems, @"Invalid number of items retrieved.");
+    XCTAssert([firstNItems[0] isEqualToString:self.testData1], @"Invalid data dequeued.");
+    XCTAssert([firstNItems[1] isEqualToString:self.testData2], @"Invalid data dequeued.");
+    XCTAssert([firstNItems[2] isEqualToString:self.testData3], @"Invalid data dequeued.");
+    NSInteger size = [self.queue size];
+    XCTAssert(size == 0, @"Invalid queue size.");
+}
+
 // the front value should be the oldest
 - (void)testFront
 {
     NSString *front = [self.queue front];
     XCTAssert([front isEqualToString:self.testData1], @"Invalid data dequeued.");
     NSInteger size = [self.queue size];
-    XCTAssert(size == kMaxQueueSize, @"Invalid queue size after dequeue.");
+    XCTAssert(size == kMaxQueueSize, @"Invalid queue size.");
+}
+
+- (void)testFirstNItems
+{
+    NSInteger numberOfItems = 3;
+    NSArray *firstNItems = [self.queue firstNItems:numberOfItems];
+    XCTAssert([firstNItems count] == numberOfItems, @"Invalid number of items retrieved.");
+    XCTAssert([firstNItems[0] isEqualToString:self.testData1], @"Invalid data dequeued.");
+    XCTAssert([firstNItems[1] isEqualToString:self.testData2], @"Invalid data dequeued.");
+    XCTAssert([firstNItems[2] isEqualToString:self.testData3], @"Invalid data dequeued.");
+    NSInteger size = [self.queue size];
+    XCTAssert(size == kMaxQueueSize, @"Invalid queue size.");
 }
 
 - (void)testIsFull