initial readme

Author: icanzilb

README.md

@@ -1,3 +1,57 @@
 # CombineDataSources
 
-A description of this package.
+<p align="center">
+<a href="https://github.com/apple/swift-package-manager" target="_blank"><img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg" alt="CombineDataSources supports Swift Package Manager (SPM)"></a> 
+<img src="https://img.shields.io/badge/platforms-iOS%2013.0-333333.svg" />
+</p>
+
+**CombineDataSources** provides custom Combine subscribers that act as table and collection view controllers and bind a stream of element collections to table or collection sections with cells.  
+
+**Note**: The package is currently work in progress.
+
+## Usage
+
+The repo contains a demo app in the *Example* sub-folder that demonstrates visually different ways to use CombineDataSources.
+
+#### Bind a plain list of elements
+
+```swift
+var data = PassthroughSubject<[Person], Never>()
+
+data
+  .receive(subscriber: tableView.rowsSubscriber(cellIdentifier: "Cell", cellType: PersonCell.self, cellConfig: { cell, indexPath, model in
+    cell.nameLabel.text = model.name
+  }))
+```
+
+![Plain list updates with CombineDataSources](https://github.com/combineopensource/CombineDataSources/raw/master/Assets/plain-list.gif)
+
+#### Bind a list of Section models
+
+```swift
+var data = PassthroughSubject<[Section<Person>], Never>()
+
+data
+  .receive(subscriber: tableView.sectionsSubscriber(cellIdentifier: "Cell", cellType: PersonCell.self, cellConfig: { cell, indexPath, model in
+    cell.nameLabel.text = model.name
+  }))
+```
+
+![Sectioned list updates with CombineDataSources](https://github.com/combineopensource/CombineDataSources/raw/master/Assets/sections-list.gif)
+
+#### Customize the table controller
+
+```swift
+var data = PassthroughSubject<[[Person]], Never>()
+
+let controller = TableViewItemsController<[[Person]]>(cellIdentifier: "Cell", cellType: PersonCell.self) { cell, indexPath, person in
+  cell.nameLabel.text = person.name
+}
+controller.animated = false
+
+// More custom controller configuration ...
+
+data
+  .receive(subscriber: tableView.sectionsSubscriber(controller))
+```
+

Sources/CombineDataSources/TableViewItemsController.swift

@@ -54,6 +54,10 @@ public class TableViewItemsController<CollectionType>: NSObject, UITableViewData
     self.cellFactory = cellFactory
   }
 
+  deinit {
+    print("Controller is released")
+  }
+  
   // MARK: - Update collection
   private let fromRow = {(section: Int) in return {(row: Int) in return IndexPath(row: row, section: section)}}
 

Tests/CombineDataSourcesTests/MemoryManagementTests.swift

@@ -0,0 +1,26 @@
+import XCTest
+import UIKit
+@testable import CombineDataSources
+
+final class MemoryManagementTests: XCTestCase {
+  func testControllerOwnsTableViewAndDataSource() {
+    let ctr: TableViewItemsController<[[Model]]>? = TableViewItemsController<[[Model]]>(cellIdentifier: "Cell", cellType: UITableViewCell.self) { (cell, indexPath, model) in
+      //
+    }
+
+    // Configure the controller
+    var tableView: UITableView? = UITableView()
+    tableView!.register(UITableViewCell.self, forCellReuseIdentifier: "Cell")
+    var dataSource: TestDataSource? = TestDataSource()
+    
+    ctr!.tableView = tableView
+    ctr!.dataSource = dataSource
+    ctr!.updateCollection([dataSet1, dataSet1])
+    
+    tableView = nil
+    XCTAssertNotNil(ctr!.tableView)
+    
+    dataSource = nil
+    XCTAssertNotNil(ctr!.dataSource)
+  }
+}

Tests/CombineDataSourcesTests/TableViewItemsControllerTests.swift

@@ -2,17 +2,6 @@ import XCTest
 import UIKit
 @testable import CombineDataSources
 
-struct Model: Equatable {
-  var text: String
-}
-
-let dataSet1 = [
-  Model(text: "test1"), Model(text: "test2"), Model(text: "test3")
-]
-let dataSet2 = [
-  Section(header: "section header", items: [Model(text: "test model")], footer: "section footer")
-]
-
 final class TableViewItemsControllerTests: XCTestCase {
 
   func testDataSource() {
@@ -53,25 +42,7 @@ final class TableViewItemsControllerTests: XCTestCase {
     let tableView = UITableView()
     ctr.tableView = tableView
     ctr.updateCollection([dataSet1])
-    
-    // Provide fallback data source
-    class TestDataSource: NSObject, UITableViewDataSource {
-      func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
-        fatalError()
-      }
-      
-      func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
-        fatalError()
-      }
-      
-      func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
-        return "test header"
-      }
-      func tableView(_ tableView: UITableView, titleForFooterInSection section: Int) -> String? {
-        return "test footer"
-      }
-    }
-    
+        
     let fallbackDataSource = TestDataSource()
     ctr.dataSource = fallbackDataSource
 

Tests/CombineDataSourcesTests/TestFixtures.swift

@@ -0,0 +1,40 @@
+//
+//  File.swift
+//  
+//
+//  Created by Marin Todorov on 8/14/19.
+//
+
+import XCTest
+import CombineDataSources
+import UIKit
+
+struct Model: Equatable {
+  var text: String
+}
+
+let dataSet1 = [
+  Model(text: "test1"), Model(text: "test2"), Model(text: "test3")
+]
+let dataSet2 = [
+  Section(header: "section header", items: [Model(text: "test model")], footer: "section footer")
+]
+
+// Provide fallback data source
+class TestDataSource: NSObject, UITableViewDataSource {
+  func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
+    fatalError()
+  }
+  
+  func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
+    fatalError()
+  }
+  
+  func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
+    return "test header"
+  }
+  func tableView(_ tableView: UITableView, titleForFooterInSection section: Int) -> String? {
+    return "test footer"
+  }
+}
+