Merge branch 'dev' of github.com:crelies/RemoteImage into dev

celies-e · celies-e · commit 2f132686f173 · 2020-03-27T15:54:35.000+01:00
# Conflicts:
#	Sources/RemoteImage/public/Views/RemoteImage.swift
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,8 @@
+language: swift
+osx_image: xcode11.3
+script:
+  - swift package generate-xcodeproj
+  - xcodebuild clean test -destination 'name=iPhone 8' -scheme RemoteImage-Package -enableCodeCoverage YES -derivedDataPath .build/derivedData -quiet
+after_success:
+  # upload test coverage data
+  - bash <(curl -s https://codecov.io/bash) -J '^RemoteImage$' -D .build/derivedData
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -15,12 +15,15 @@ let package = Package(
             name: "RemoteImage",
             targets: ["RemoteImage"]),
     ],
+    dependencies: [
+        .package(url: "https://github.com/nalexn/ViewInspector.git", from: "0.3.8")
+    ],
     targets: [
         .target(
             name: "RemoteImage",
             dependencies: []),
         .testTarget(
             name: "RemoteImageTests",
-            dependencies: ["RemoteImage"]),
+            dependencies: ["RemoteImage", "ViewInspector"]),
     ]
 )
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 # RemoteImage
 
-[![Swift 5.1](https://img.shields.io/badge/swift5.1-compatible-green.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
-[![Platform](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com)
+[![Swift 5.1](https://img.shields.io/badge/swift-5.1-green.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
+[![Platforms](https://img.shields.io/badge/platforms-iOS%20%7C%20macOS%20%7C%20tvOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com)
 [![Current Version](https://img.shields.io/github/v/tag/crelies/RemoteImage?longCache=true&style=flat-square)](https://github.com/crelies/RemoteImage)
+[![Build status](https://travis-ci.com/crelies/RemoteImage.svg?token=THnaziKxRFFz1nKcsPgz&branch=dev)](https://travis-ci.com/crelies/RemoteImage)
+[![Code coverage](https://codecov.io/gh/crelies/RemoteImage/branch/dev/graph/badge.svg?token=DhJyoUKNPM)](https://codecov.io/gh/crelies/RemoteImage)
 [![License](https://img.shields.io/badge/license-MIT-lightgrey.svg?longCache=true&style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)
 
 This Swift package provides a wrapper view around the existing **SwiftUI** `Image view` which adds support for showing and caching remote images.
diff --git a/Sources/RemoteImage/private/Models/RemoteImageState.swift b/Sources/RemoteImage/private/Models/RemoteImageState.swift
@@ -6,10 +6,28 @@
 //  Copyright © 2019 Christian Elies. All rights reserved.
 //
 
-import Foundation
+#if canImport(UIKit)
+import UIKit
 
 enum RemoteImageState: Hashable {
     case error(_ error: NSError)
-    case image(_ image: PlatformSpecificImageType)
+    case image(_ image: UIImage)
     case loading
 }
+
+extension RemoteImageState {
+    var error: NSError? {
+        guard case let RemoteImageState.error(error) = self else {
+            return nil
+        }
+        return error
+    }
+
+    var image: UIImage? {
+        guard case let RemoteImageState.image(uiImage) = self else {
+            return nil
+        }
+        return uiImage
+    }
+}
+#endif
diff --git a/Sources/RemoteImage/private/Protocols/RemoteImageServiceProtocol.swift b/Sources/RemoteImage/private/Protocols/RemoteImageServiceProtocol.swift
@@ -5,6 +5,7 @@
 //  Created by Christian Elies on 15.12.19.
 //
 
+#if canImport(UIKit)
 import Combine
 
 protocol RemoteImageServiceProtocol where Self: ObservableObject {
@@ -14,3 +15,4 @@ protocol RemoteImageServiceProtocol where Self: ObservableObject {
     var state: RemoteImageState { get set }
     func fetchImage(ofType type: RemoteImageType)
 }
+#endif
diff --git a/Sources/RemoteImage/private/Services/DefaultRemoteImageCache.swift b/Sources/RemoteImage/private/Services/DefaultRemoteImageCache.swift
@@ -5,18 +5,20 @@
 //  Created by Christian Elies on 14.12.19.
 //
 
-import Foundation
+#if canImport(UIKit)
+import UIKit
 
 struct DefaultRemoteImageCache {
-    let cache = NSCache<AnyObject, PlatformSpecificImageType>()
+    let cache = NSCache<AnyObject, UIImage>()
 }
 
 extension DefaultRemoteImageCache: RemoteImageCache {
-    func object(forKey key: AnyObject) -> PlatformSpecificImageType? { cache.object(forKey: key) }
+    func object(forKey key: AnyObject) -> UIImage? { cache.object(forKey: key) }
 
-    func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject) { cache.setObject(object, forKey: key) }
+    func setObject(_ object: UIImage, forKey key: AnyObject) { cache.setObject(object, forKey: key) }
 
     func removeObject(forKey key: AnyObject) { cache.removeObject(forKey: key) }
 
     func removeAllObjects() { cache.removeAllObjects() }
 }
+#endif
diff --git a/Sources/RemoteImage/public/Models/PlatformSpecificImageType.swift b/Sources/RemoteImage/public/Models/PlatformSpecificImageType.swift
diff --git a/Sources/RemoteImage/public/Protocols/RemoteImageCache.swift b/Sources/RemoteImage/public/Protocols/RemoteImageCache.swift
@@ -5,11 +5,13 @@
 //  Created by Christian Elies on 14.12.19.
 //
 
-import Foundation
+#if canImport(UIKit)
+import UIKit
 
 public protocol RemoteImageCache {
-    func object(forKey key: AnyObject) -> PlatformSpecificImageType?
-    func setObject(_ object: PlatformSpecificImageType, forKey key: AnyObject)
+    func object(forKey key: AnyObject) -> UIImage?
+    func setObject(_ object: UIImage, forKey key: AnyObject)
     func removeObject(forKey key: AnyObject)
     func removeAllObjects()
 }
+#endif
diff --git a/Sources/RemoteImage/public/Services/RemoteImageService.swift b/Sources/RemoteImage/public/Services/RemoteImageService.swift
@@ -6,8 +6,9 @@
 //  Copyright © 2019 Christian Elies. All rights reserved.
 //
 
+#if canImport(UIKit)
 import Combine
-import Foundation
+import UIKit
 
 public typealias RemoteImageCacheKeyProvider = (RemoteImageType) -> AnyObject
 
@@ -52,7 +53,7 @@ extension RemoteImageService {
         let urlRequest = URLRequest(url: url)
 
         cancellable = dependencies.remoteImageURLDataPublisher.dataPublisher(for: urlRequest)
-            .map { PlatformSpecificImageType(data: $0.data) }
+            .map { UIImage(data: $0.data) }
             .receive(on: RunLoop.main)
             .sink(receiveCompletion: { completion in
                 switch completion {
@@ -80,7 +81,7 @@ extension RemoteImageService {
         dependencies.photoKitService.getPhotoData(localIdentifier: localIdentifier) { result in
             switch result {
             case .success(let data):
-                if let image = PlatformSpecificImageType(data: data) {
+                if let image = UIImage(data: data) {
                     Self.cache.setObject(image, forKey: cacheKey)
                     self.state = .image(image)
                 } else {
@@ -92,3 +93,4 @@ extension RemoteImageService {
         }
     }
 }
+#endif
diff --git a/Sources/RemoteImage/public/Services/RemoteImageServiceFactory.swift b/Sources/RemoteImage/public/Services/RemoteImageServiceFactory.swift
@@ -5,6 +5,7 @@
 //  Created by Christian Elies on 29.10.19.
 //
 
+#if canImport(UIKit)
 import Foundation
 
 public final class RemoteImageServiceFactory {
@@ -13,3 +14,4 @@ public final class RemoteImageServiceFactory {
         return RemoteImageService(dependencies: dependencies)
     }
 }
+#endif
diff --git a/Sources/RemoteImage/public/Views/RemoteImage.swift b/Sources/RemoteImage/public/Views/RemoteImage.swift
@@ -6,6 +6,7 @@
 //  Copyright © 2019 Christian Elies. All rights reserved.
 //
 
+#if canImport(SwiftUI) && canImport(UIKit)
 import Combine
 import SwiftUI
 
@@ -17,30 +18,18 @@ public struct RemoteImage<ErrorView: View, ImageView: View, LoadingView: View>:
 
     @ObservedObject private var service = RemoteImageServiceFactory.makeRemoteImageService()
 
-    public var body: AnyView {
-        switch service.state {
-            case .error(let error):
-                return AnyView(
-                    errorView(error)
-                )
-            case .image(let image):
-                #if canImport(UIKit)
-                    return AnyView(
-                        self.imageView(Image(uiImage: image))
-                    )
-                #elseif os(macOS)
-                    return AnyView(
-                        self.imageView(Image(nsImage: image))
-                    )
-                #else
-                    return AnyView(
-                        Text("Cannot render image: unsupported platform")
-                    )
-                #endif
-            case .loading:
-                return AnyView(
-                    loadingView()
-                )
+    public var body: some View {
+        Group {
+            if service.state == .loading {
+                loadingView()
+                    .onAppear {
+                        self.service.fetchImage(ofType: self.type)
+                    }
+            } else {
+                service.state.error.map { errorView($0) }
+
+                service.state.image.map { self.imageView(Image(uiImage: $0)) }
+            }
         }
     }
 
@@ -68,3 +57,5 @@ struct RemoteImage_Previews: PreviewProvider {
     }
 }
 #endif
+
+#endif
diff --git a/Tests/RemoteImageTests/Extensions/RemoteImage+Inspectable.swift b/Tests/RemoteImageTests/Extensions/RemoteImage+Inspectable.swift
@@ -0,0 +1,11 @@
+//
+//  RemoteImage+Inspectable.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 22.02.20.
+//
+
+@testable import RemoteImage
+import ViewInspector
+
+extension RemoteImage: Inspectable {}
diff --git a/Tests/RemoteImageTests/Extensions/URLSession+RemoteImageURLDataPublisherTests.swift b/Tests/RemoteImageTests/Extensions/URLSession+RemoteImageURLDataPublisherTests.swift
@@ -21,4 +21,8 @@ final class URLSession_RemoteImageURLDataPublisherTests: XCTestCase {
         let dataPublisher = urlSession.dataPublisher(for: urlRequest)
         XCTAssertEqual(dataPublisher.description, dataTaskPublisher.description)
     }
+
+    static var allTests = [
+        ("testDataPublisher", testDataPublisher)
+    ]
 }
diff --git a/Tests/RemoteImageTests/Models/PhotoKitServiceErrorTests.swift b/Tests/RemoteImageTests/Models/PhotoKitServiceErrorTests.swift
@@ -61,4 +61,16 @@ final class PhotoKitServiceErrorTests: XCTestCase {
     func testErrorDomain() {
         XCTAssertEqual(PhotoKitServiceError.errorDomain, String(describing: PhotoKitService.self))
     }
+
+    static var allTests = [
+        ("testMissingDataErrorDescription", testMissingDataErrorDescription),
+        ("testMissingDataFailureReason", testMissingDataFailureReason),
+        ("testMissingDataRecoverySuggestion", testMissingDataRecoverySuggestion),
+        ("testMissingDataErrorCode", testMissingDataErrorCode),
+        ("testPhAssetNotFoundErrorDescription", testPhAssetNotFoundErrorDescription),
+        ("testPhAssetNotFoundFailureReason", testPhAssetNotFoundFailureReason),
+        ("testPhAssetNotFoundRecoverySuggestion", testPhAssetNotFoundRecoverySuggestion),
+        ("testPhAssetNotFoundErrorCode", testPhAssetNotFoundErrorCode),
+        ("testErrorDomain", testErrorDomain)
+    ]
 }
diff --git a/Tests/RemoteImageTests/Models/RemoteImageServiceErrorTests.swift b/Tests/RemoteImageTests/Models/RemoteImageServiceErrorTests.swift
@@ -14,4 +14,8 @@ final class RemoteImageServiceErrorTests: XCTestCase {
         let expectedDescription = "Could not create image from received data"
         XCTAssertEqual(description, expectedDescription)
     }
+
+    static var allTests = [
+        ("testCouldNotCreateImageDescription", testCouldNotCreateImageDescription)
+    ]
 }
diff --git a/Tests/RemoteImageTests/Models/RemoteImageStateTests.swift b/Tests/RemoteImageTests/Models/RemoteImageStateTests.swift
@@ -0,0 +1,43 @@
+//
+//  RemoteImageStateTests.swift
+//  RemoteImageTests
+//
+//  Created by Christian Elies on 23.02.20.
+//
+
+#if canImport(UIKit)
+@testable import RemoteImage
+import UIKit
+import XCTest
+
+final class RemoteImageStateTests: XCTestCase {
+    func testErrorValue() {
+        let error = NSError(domain: "MockDomain", code: 1, userInfo: nil)
+        let state: RemoteImageState = .error(error)
+        XCTAssertEqual(state.error, error)
+    }
+
+    func testNoErrorValue() {
+        let state: RemoteImageState = .loading
+        XCTAssertNil(state.error)
+    }
+
+    func testImageValue() {
+        let image = UIImage()
+        let state: RemoteImageState = .image(image)
+        XCTAssertEqual(state.image, image)
+    }
+
+    func testNoImageValue() {
+        let state: RemoteImageState = .loading
+        XCTAssertNil(state.image)
+    }
+
+    static var allTests = [
+        ("testErrorValue", testErrorValue),
+        ("testNoErrorValue", testNoErrorValue),
+        ("testImageValue", testImageValue),
+        ("testNoImageValue", testNoImageValue)
+    ]
+}
+#endif
diff --git a/Tests/RemoteImageTests/Services/DefaultRemoteImageCacheTests.swift b/Tests/RemoteImageTests/Services/DefaultRemoteImageCacheTests.swift
@@ -5,7 +5,9 @@
 //  Created by Christian Elies on 14.12.19.
 //
 
+#if canImport(UIKit)
 @testable import RemoteImage
+import UIKit
 import XCTest
 
 final class DefaultRemoteImageCacheTests: XCTestCase {
@@ -17,14 +19,14 @@ final class DefaultRemoteImageCacheTests: XCTestCase {
 
     func testSetImage() {
         let key = "Test" as NSString
-        let image = PlatformSpecificImageType()
+        let image = UIImage()
         remoteImageCache.setObject(image, forKey: key)
         XCTAssertEqual(remoteImageCache.object(forKey: key), image)
     }
 
     func testRemoveImage() {
         let key = "Test" as NSString
-        let image = PlatformSpecificImageType()
+        let image = UIImage()
         remoteImageCache.setObject(image, forKey: key)
         XCTAssertEqual(remoteImageCache.object(forKey: key), image)
         remoteImageCache.removeObject(forKey: key)
@@ -36,3 +38,4 @@ final class DefaultRemoteImageCacheTests: XCTestCase {
         ("testRemoveImage", testRemoveImage)
     ]
 }
+#endif
diff --git a/Tests/RemoteImageTests/Services/PhotoKitServiceTests.swift b/Tests/RemoteImageTests/Services/PhotoKitServiceTests.swift
@@ -87,4 +87,10 @@ final class PhotoKitServiceTests: XCTestCase {
             XCTFail("Invalid photo data result")
         }
     }
+
+    static var allTests = [
+        ("testPhotoDataNotFound", testPhotoDataNotFound),
+        ("testPhotoDataFailure", testPhotoDataFailure),
+        ("testPhotoDataSuccess", testPhotoDataSuccess)
+    ]
 }
diff --git a/Tests/RemoteImageTests/Services/RemoteImageServiceDependenciesTests.swift b/Tests/RemoteImageTests/Services/RemoteImageServiceDependenciesTests.swift
diff --git a/Tests/RemoteImageTests/Services/RemoteImageServiceFactoryTests.swift b/Tests/RemoteImageTests/Services/RemoteImageServiceFactoryTests.swift
diff --git a/Tests/RemoteImageTests/Services/RemoteImageServiceTests.swift b/Tests/RemoteImageTests/Services/RemoteImageServiceTests.swift
diff --git a/Tests/RemoteImageTests/Views/RemoteImageTests.swift b/Tests/RemoteImageTests/Views/RemoteImageTests.swift
diff --git a/Tests/RemoteImageTests/XCTestManifests.swift b/Tests/RemoteImageTests/XCTestManifests.swift
