Updating the API to a Swift3 style API

[plivesey]

No description provided.

[plivesey]

API changes:

// protocol Model and protocol SimpleModel

func isEqualToModel(_ model: Model) -> Bool {}
func isEqual(to model: Model) -> Bool {}

func mergeModel(_ model: Model) -> Model
func merge(_ model: Model) -> Model

// DataProvider, CollectionDataProvider, BatchDataProviderListener

open var paused: Bool
open var isPaused: Bool

// DataProvider, CollectionDataProvider

open func fetchDataFromCache(cacheKey cacheKey: String?, ...)
open func fetchDataFromCache(withCacheKey cacheKey: String?, ...)

// CollectionDataProvider

open func removeAtIndex(_ index: Int, shouldCache: Bool = true, context: Any? = nil)
open func remove(at index: Int, shouldCache: Bool = true, context: Any? = nil)

Please also pay attention to all the APIs that I did not change.

[codecov-io]

Current coverage is 90.01% (diff: 94.81%)

Merging #39 into master will decrease coverage by 0.06%

@@             master        #39   diff @@
==========================================
  Files            43         43          
  Lines          4538       4538          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
- Hits           4088       4085     -3   
- Misses          450        453     +3   
  Partials          0          0          

Powered by Codecov. Last update 95376f2...2704840

[nicksnyder]

An alternative to consider:
fetchCachedData(withKey cacheKey: String?, ...)

[plivesey]

Hmmmm...originally liked, but maybe not...I think I prefer cache key because it's consistent naming across different places?

[nicksnyder]

Wondering if this should have a noun

removeItem(at index: Int, ...)
removeData(at index: Int, ...)

[plivesey]

I don't think so based off Apple's APIs. Apple specifically suggests against this in API guidelines https://swift.org/documentation/api-design-guidelines/ (Omit needless words)

from ^
bad public mutating func removeElement(_ member: Element) -> Element?
good public mutating func remove(_ member: Element) -> Element?