Merge pull request #98 from JohnSundell/actions-api-powerup

Power up actions API to support content operations & async, chainable actions

Author: JohnSundell

HubFramework.xcodeproj/project.pbxproj

@@ -197,6 +197,7 @@
 		8A4C28151DB5120400152429 /* HUBComponentGestureRecognizer.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = HUBComponentGestureRecognizer.h; sourceTree = "<group>"; };
 		8A4C28161DB5120400152429 /* HUBComponentGestureRecognizer.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBComponentGestureRecognizer.m; sourceTree = "<group>"; };
 		8A4C28191DB6464B00152429 /* HUBComponentWithSelectionState.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = HUBComponentWithSelectionState.h; sourceTree = "<group>"; };
+		8A4EB8B01DBA47E90004588C /* HUBAsyncAction.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = HUBAsyncAction.h; sourceTree = "<group>"; };
 		8A58E0E21C5A77C700F41A5C /* HUBJSONPathTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBJSONPathTests.m; sourceTree = "<group>"; };
 		8A58E1461C5B79A900F41A5C /* HUBMutableJSONPathTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBMutableJSONPathTests.m; sourceTree = "<group>"; };
 		8A58E1481C5FA62E00F41A5C /* HUBComponentImageDataBuilderTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBComponentImageDataBuilderTests.m; sourceTree = "<group>"; };
@@ -340,6 +341,8 @@
 		8AD151801D9966080008E182 /* HUBURLSessionMock.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBURLSessionMock.m; sourceTree = "<group>"; };
 		8AD151821D9968390008E182 /* HUBURLSessionDataTaskMock.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = HUBURLSessionDataTaskMock.h; sourceTree = "<group>"; };
 		8AD151831D9968390008E182 /* HUBURLSessionDataTaskMock.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBURLSessionDataTaskMock.m; sourceTree = "<group>"; };
+		8AD585B51DB4D38700DB7606 /* HUBActionPerformer.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = HUBActionPerformer.h; sourceTree = "<group>"; };
+		8AD585B91DB4F49600DB7606 /* HUBContentOperationActionPerformer.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = HUBContentOperationActionPerformer.h; sourceTree = "<group>"; };
 		8AD732011D9AD30100E4B427 /* HUBDefaultConnectivityStateResolver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = HUBDefaultConnectivityStateResolver.h; sourceTree = "<group>"; };
 		8AD732021D9AD30100E4B427 /* HUBDefaultConnectivityStateResolver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HUBDefaultConnectivityStateResolver.m; sourceTree = "<group>"; };
 		8AD7335F1D9BE6F800E4B427 /* SystemConfiguration.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SystemConfiguration.framework; path = System/Library/Frameworks/SystemConfiguration.framework; sourceTree = SDKROOT; };
@@ -524,8 +527,10 @@
 			isa = PBXGroup;
 			children = (
 				8A2A72EE1D4B749600141619 /* HUBAction.h */,
+				8A4EB8B01DBA47E90004588C /* HUBAsyncAction.h */,
 				8A0C356C1D7DB656007C32D9 /* HUBActionFactory.h */,
 				8A2A72ED1D4B744A00141619 /* HUBActionRegistry.h */,
+				8AD585B51DB4D38700DB7606 /* HUBActionPerformer.h */,
 				8A6529F51D82D1C7007B1A15 /* HUBActionHandler.h */,
 				F663FE7C1D10BECE003E19B6 /* HUBActionContext.h */,
 				8A6529F61D82D7BE007B1A15 /* HUBActionTrigger.h */,
@@ -740,6 +745,7 @@
 				8A40B12D1CAAA71500EBDDE2 /* HUBContentOperation.h */,
 				8AF82D831D12EEFA00D1B933 /* HUBContentOperationWithInitialContent.h */,
 				8A6525371D815F4C007B1A15 /* HUBContentOperationActionObserver.h */,
+				8AD585B91DB4F49600DB7606 /* HUBContentOperationActionPerformer.h */,
 				8A5D7A471CB7D2DB00B987BA /* HUBContentReloadPolicy.h */,
 				52977AC61DA7D0890064629E /* HUBBlockContentOperationFactory.h */,
 			);

demo/HubFrameworkDemo.xcodeproj/project.pbxproj

@@ -10,6 +10,9 @@
 		8A27299A1D9546BB00EF43FC /* RootContentOperationFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A2729991D9546BB00EF43FC /* RootContentOperationFactory.swift */; };
 		8A27299E1D9546ED00EF43FC /* RootContentOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A27299D1D9546ED00EF43FC /* RootContentOperation.swift */; };
 		8A2729A21D95486A00EF43FC /* URL+ViewURIs.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A2729A11D95486A00EF43FC /* URL+ViewURIs.swift */; };
+		8A374CFF1DBE659E0013E592 /* TodoListActionFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A374CFC1DBE659E0013E592 /* TodoListActionFactory.swift */; };
+		8A374D001DBE659E0013E592 /* TodoListAddAction.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A374CFD1DBE659E0013E592 /* TodoListAddAction.swift */; };
+		8A374D011DBE659E0013E592 /* TodoListContentOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A374CFE1DBE659E0013E592 /* TodoListContentOperation.swift */; };
 		8A42E0AB1D8C376B004FAC33 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A42E0A91D8C376B004FAC33 /* AppDelegate.swift */; };
 		8A42E0B21D8C3779004FAC33 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 8A42E0AE1D8C3779004FAC33 /* Assets.xcassets */; };
 		8A42E0B31D8C3779004FAC33 /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 8A42E0AF1D8C3779004FAC33 /* LaunchScreen.storyboard */; };
@@ -65,6 +68,9 @@
 		8A2729991D9546BB00EF43FC /* RootContentOperationFactory.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RootContentOperationFactory.swift; sourceTree = "<group>"; };
 		8A27299D1D9546ED00EF43FC /* RootContentOperation.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RootContentOperation.swift; sourceTree = "<group>"; };
 		8A2729A11D95486A00EF43FC /* URL+ViewURIs.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "URL+ViewURIs.swift"; sourceTree = "<group>"; };
+		8A374CFC1DBE659E0013E592 /* TodoListActionFactory.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TodoListActionFactory.swift; sourceTree = "<group>"; };
+		8A374CFD1DBE659E0013E592 /* TodoListAddAction.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TodoListAddAction.swift; sourceTree = "<group>"; };
+		8A374CFE1DBE659E0013E592 /* TodoListContentOperation.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TodoListContentOperation.swift; sourceTree = "<group>"; };
 		8A42E0921D8C36A3004FAC33 /* HubFrameworkDemo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = HubFrameworkDemo.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		8A42E0A91D8C376B004FAC33 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
 		8A42E0AE1D8C3779004FAC33 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
@@ -107,6 +113,16 @@
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		8A374CFA1DBE65920013E592 /* Todo list */ = {
+			isa = PBXGroup;
+			children = (
+				8A374CFC1DBE659E0013E592 /* TodoListActionFactory.swift */,
+				8A374CFD1DBE659E0013E592 /* TodoListAddAction.swift */,
+				8A374CFE1DBE659E0013E592 /* TodoListContentOperation.swift */,
+			);
+			name = "Todo list";
+			sourceTree = "<group>";
+		};
 		8A42E0891D8C36A3004FAC33 = {
 			isa = PBXGroup;
 			children = (
@@ -198,6 +214,7 @@
 				8AD5EDB11D9A7CE4004B2CEA /* GitHub Search */,
 				8AD72F4F1D9ABCDD00E4B427 /* Pretty pictures */,
 				8ABCCEA71D9D1AAB005113B5 /* Really long list */,
+				8A374CFA1DBE65920013E592 /* Todo list */,
 			);
 			name = Features;
 			sourceTree = "<group>";
@@ -352,6 +369,7 @@
 				8AD72F571D9AC22600E4B427 /* ImageComponent.swift in Sources */,
 				8A2729A21D95486A00EF43FC /* URL+ViewURIs.swift in Sources */,
 				8A42E1F91D8C476C004FAC33 /* ComponentFallbackHandler.swift in Sources */,
+				8A374D001DBE659E0013E592 /* TodoListAddAction.swift in Sources */,
 				8ABCCEAC1D9D1AE4005113B5 /* ReallyLongListContentOperationFactory.swift in Sources */,
 				8AD5EDCE1D9AA294004B2CEA /* LabelComponent.swift in Sources */,
 				8AD5EDCA1D9A9DBC004B2CEA /* GitHubSearchActivityIndicatorContentOperation.swift in Sources */,
@@ -360,12 +378,14 @@
 				8A42E0AB1D8C376B004FAC33 /* AppDelegate.swift in Sources */,
 				8AD5EDC41D9A92EC004B2CEA /* GitHubSearchCustomDataKeys.swift in Sources */,
 				8A27299E1D9546ED00EF43FC /* RootContentOperation.swift in Sources */,
+				8A374CFF1DBE659E0013E592 /* TodoListActionFactory.swift in Sources */,
 				8ABCCEAA1D9D1AC3005113B5 /* ReallyLongListContentOperation.swift in Sources */,
 				8AD5EDB91D9A7DEC004B2CEA /* DefaultComponentFactory.swift in Sources */,
 				8AD5EDC61D9A9674004B2CEA /* HUBJSONSchemaRegistry+CustomSchemas.swift in Sources */,
 				8AD5EDC81D9A9C3C004B2CEA /* ActivityIndicatorComponent.swift in Sources */,
 				8AD72F551D9AC18100E4B427 /* PrettyPicturesContentOperationFactory.swift in Sources */,
 				8AD5EDC21D9A90F7004B2CEA /* GitHubSearchResultsContentOperation.swift in Sources */,
+				8A374D011DBE659E0013E592 /* TodoListContentOperation.swift in Sources */,
 				8AD14FED1D9958A90008E182 /* UIImageView+Animation.swift in Sources */,
 				8A42E1F71D8C468C004FAC33 /* ComponentLayoutManager.swift in Sources */,
 				8AD72F531D9ABDB100E4B427 /* PrettyPicturesContentOperation.swift in Sources */,

demo/sources/AppDelegate.swift

@@ -43,6 +43,7 @@ import HubFramework
         registerGitHubSearchFeature()
         registerPrettyPicturesFeature()
         registerReallyLongListFeature()
+        registerTodoListFeature()
 
         return true
     }
@@ -122,6 +123,25 @@ import HubFramework
         )
     }
 
+    private func registerTodoListFeature() {
+        let contentOperationFactory = HUBBlockContentOperationFactory() { _ in
+            return [TodoListContentOperation()]
+        }
+        
+        hubManager.featureRegistry.registerFeature(
+            withIdentifier: "todoList",
+            viewURIPredicate: HUBViewURIPredicate(viewURI: .todoListViewURI),
+            title: "Todo List",
+            contentOperationFactories: [contentOperationFactory],
+            contentReloadPolicy: nil,
+            customJSONSchemaIdentifier: nil,
+            actionHandler: nil,
+            viewControllerScrollHandler: nil
+        )
+        
+        hubManager.actionRegistry.register(TodoListActionFactory(), forNamespace: TodoListActionFactory.namespace)
+    }
+    
     // MARK: - Opening view URIs
 
     @discardableResult private func open(viewURI: URL, animated: Bool) -> Bool {

demo/sources/RootContentOperation.swift

@@ -48,6 +48,11 @@ class RootContentOperation: NSObject, HUBContentOperation {
         reallyLongListRowBuilder.subtitle = "A feature that renders 10,000 rows"
         reallyLongListRowBuilder.targetBuilder.uri = .reallyLongListViewURI
 
+        let todoListRowBuilder = viewModelBuilder.builderForBodyComponentModel(withIdentifier: "todoList")
+        todoListRowBuilder.title = "Todo list"
+        todoListRowBuilder.subtitle = "A feature for adding todo items to a list"
+        todoListRowBuilder.targetBuilder.uri = .todoListViewURI
+        
         delegate?.contentOperationDidFinish(self)
     }
 }

demo/sources/SearchBarComponent.swift

@@ -42,7 +42,7 @@ class SearchBarComponent: NSObject, HUBComponentActionPerformer, UISearchBarDele
     static let debounceInterval = 0.3
 
     var view: UIView?
-    var actionDelegate: HUBComponentActionDelegate?
+    weak var actionPerformer: HUBActionPerformer?
 
     var debounceTimer: Timer?
 
@@ -95,7 +95,7 @@ class SearchBarComponent: NSObject, HUBComponentActionPerformer, UISearchBarDele
         debounceTimer?.invalidate()
         self.debounceTimer = Timer.scheduledTimer(withTimeInterval: SearchBarComponent.debounceInterval, repeats: false) { (_) in
             let customData = [SearchBarComponentCustomDataKeys.text: searchText]
-            self.actionDelegate?.component(self, performActionWith: actionIdentifier, customData: customData)
+            self.actionPerformer?.performAction(withIdentifier: actionIdentifier, customData: customData)
         }
     }
 

demo/sources/TodoListActionFactory.swift

@@ -0,0 +1,45 @@
+/*
+ *  Copyright (c) 2016 Spotify AB.
+ *
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file 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.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+import Foundation
+import HubFramework
+
+/// Action names used by `TodoListActionFactory`
+struct TodoListActionNames {
+    /// The name of an action to display an alert to add a todo item
+    static var add: String { return "add" }
+    /// The name of an action that gets performed once a todo item has been added
+    static var addCompleted: String { return "add-completed" }
+}
+
+/// Action factory used by the "Todo list" feature
+class TodoListActionFactory: NSObject, HUBActionFactory {
+    /// The namespace that this action factory is registered for with `HUBActionRegistry`
+    static var namespace: String { return "namespace" }
+    
+    func createAction(forName name: String) -> HUBAction? {
+        if (name == TodoListActionNames.add) {
+            return TodoListAddAction()
+        }
+        
+        return nil
+    }
+}

demo/sources/TodoListAddAction.swift

@@ -0,0 +1,58 @@
+/*
+ *  Copyright (c) 2016 Spotify AB.
+ *
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file 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.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+import Foundation
+import HubFramework
+
+/// Action custom data keys used by `TodoListAddAction`
+struct TodoListAddActionCustomDataKeys {
+    /// The title of the item to add to a todo list
+    static var itemTitle: String { return "item" }
+}
+
+/// Action that presents an alert to add a todo list item
+class TodoListAddAction: NSObject, HUBAsyncAction {
+    weak var delegate: HUBAsyncActionDelegate?
+    
+    func perform(with context: HUBActionContext) -> Bool {
+        let alertController = UIAlertController(title: "Add an item", message: nil, preferredStyle: .alert)
+        alertController.addTextField(configurationHandler: nil)
+        
+        let cancelAction = UIAlertAction(title: "Cancel", style: .cancel) { _ in
+            alertController.dismiss(animated: true, completion: nil)
+            self.delegate?.actionDidFinish(self, chainToActionWithIdentifier: nil, customData: nil)
+        }
+        
+        let doneAction = UIAlertAction(title: "Add", style: .default) { _ in
+            let nextActionIdentifier = HUBIdentifier(namespace: TodoListActionFactory.namespace, name: TodoListActionNames.addCompleted)
+            let nextActionCustomData = [TodoListAddActionCustomDataKeys.itemTitle: alertController.textFields!.first!.text]
+            self.delegate?.actionDidFinish(self, chainToActionWithIdentifier: nextActionIdentifier, customData: nextActionCustomData)
+        }
+        
+        alertController.addAction(cancelAction)
+        alertController.addAction(doneAction)
+        
+        context.viewController.present(alertController, animated: true, completion: nil)
+        
+        return true
+    }
+}
+

demo/sources/TodoListContentOperation.swift

@@ -0,0 +1,60 @@
+/*
+ *  Copyright (c) 2016 Spotify AB.
+ *
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file 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.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+import Foundation
+import HubFramework
+
+/// Content operation used by the "Todo list" feature
+class TodoListContentOperation: NSObject, HUBContentOperationActionPerformer, HUBContentOperationActionObserver {
+    weak var delegate: HUBContentOperationDelegate?
+    weak var actionPerformer: HUBActionPerformer?
+    
+    private var items = [String]()
+
+    func perform(forViewURI viewURI: URL, featureInfo: HUBFeatureInfo, connectivityState: HUBConnectivityState, viewModelBuilder: HUBViewModelBuilder, previousError: Error?) {
+        viewModelBuilder.navigationItem.rightBarButtonItem = UIBarButtonItem(barButtonSystemItem: .add, target: self, action: #selector(handleAddButton))
+        
+        items.enumerated().forEach { index, item in
+            let itemRowBuilder = viewModelBuilder.builderForBodyComponentModel(withIdentifier: "item-\(index)")
+            itemRowBuilder.title = item
+        }
+        
+        delegate?.contentOperationDidFinish(self)
+    }
+    
+    func actionPerformed(with context: HUBActionContext, viewURI: URL, featureInfo: HUBFeatureInfo, connectivityState: HUBConnectivityState) {
+        guard context.customActionIdentifier == HUBIdentifier(namespace: TodoListActionFactory.namespace, name: TodoListActionNames.addCompleted) else {
+            return
+        }
+        
+        guard let itemTitle = context.customData?[TodoListAddActionCustomDataKeys.itemTitle] as? String else {
+            return
+        }
+        
+        items.append(itemTitle)
+        delegate?.contentOperationRequiresRescheduling(self)
+    }
+    
+    @objc private func handleAddButton() {
+        let actionIdentifier = HUBIdentifier(namespace: TodoListActionFactory.namespace, name: TodoListActionNames.add)
+        actionPerformer?.performAction(withIdentifier: actionIdentifier, customData: nil)
+    }
+}

demo/sources/URL+ViewURIs.swift

@@ -41,6 +41,11 @@ extension URL {
     static var reallyLongListViewURI: URL {
         return URL(viewURI: "reallylonglist")
     }
+    
+    /// The view URI used for the "Todo list" feature
+    static var todoListViewURI: URL {
+        return URL(viewURI: "todoList")
+    }
 }
 
 private extension URL {

include/HubFramework/HUBAction.h

@@ -19,7 +19,6 @@
  *  under the License.
  */
 
-
 #import <Foundation/Foundation.h>
 
 @protocol HUBActionContext;