Added FilecachedInputOutputStream #197
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,20 +57,3 @@ extension Record { | |
| self.request = request | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,81 @@ | ||||||||
| // | ||||||||
| // Copyright (c) 2018 cauli.works | ||||||||
| // | ||||||||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||||||||
| // of this software and associated documentation files (the "Software"), to deal | ||||||||
| // in the Software without restriction, including without limitation the rights | ||||||||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||||||||
| // copies of the Software, and to permit persons to whom the Software is | ||||||||
| // furnished to do so, subject to the following conditions: | ||||||||
| // | ||||||||
| // The above copyright notice and this permission notice shall be included in | ||||||||
| // all copies or substantial portions of the Software. | ||||||||
| // | ||||||||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||||||||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||||||||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||||||||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||||||||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||||||||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||||||||
| // THE SOFTWARE. | ||||||||
| // | ||||||||
|
|
||||||||
| import Foundation | ||||||||
|
|
||||||||
| /// The FilecachedInputOutputStream is an InputStream that can be written to. | ||||||||
| /// Every byte written to the stream is first written to a temp file before | ||||||||
| /// it can be read from. | ||||||||
| internal class FilecachedInputOutputStream: InputStream { | ||||||||
|
|
||||||||
| let writableOutputStream: OutputStream? | ||||||||
|
|
||||||||
| private let cacheFile: URL | ||||||||
| private let readableInputStream: InputStream | ||||||||
|
|
||||||||
| deinit { | ||||||||
| DispatchQueue.global(qos: .background).async { [cacheFile] in | ||||||||
| do { | ||||||||
| try FileManager.default.removeItem(at: cacheFile) | ||||||||
| } catch (let error as NSError) | ||||||||
| where error.domain == NSCocoaErrorDomain && error.code == NSFileNoSuchFileError { | ||||||||
| // All good. File doesn't exist. | ||||||||
| } catch { | ||||||||
| print("Failed to delete temporary file with path: \(cacheFile)") | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| init(fileCache: URL) { | ||||||||
| writableOutputStream = OutputStream(url: fileCache, append: true) | ||||||||
| writableOutputStream?.open() | ||||||||
| readableInputStream = InputStream(url: fileCache)! | ||||||||
| cacheFile = fileCache | ||||||||
| super.init(url: fileCache)! | ||||||||
|
There was a problem hiding this comment.
There was a problem hiding this comment. Same here 😊
Suggested change
|
||||||||
| } | ||||||||
|
|
||||||||
| convenience init() { | ||||||||
| let tempfolder = URL(fileURLWithPath: NSTemporaryDirectory()) | ||||||||
| let tempfile = tempfolder.appendingPathComponent(UUID().uuidString) | ||||||||
| self.init(fileCache: tempfile) | ||||||||
| } | ||||||||
|
|
||||||||
| override var hasBytesAvailable: Bool { | ||||||||
| return writableOutputStream?.streamStatus != .closed || readableInputStream.hasBytesAvailable | ||||||||
| } | ||||||||
|
|
||||||||
| override func open() { | ||||||||
| readableInputStream.open() | ||||||||
| } | ||||||||
|
|
||||||||
| override func close() { | ||||||||
| readableInputStream.close() | ||||||||
| } | ||||||||
|
|
||||||||
| override func read(_ buffer: UnsafeMutablePointer<UInt8>, maxLength len: Int) -> Int { | ||||||||
| return readableInputStream.read(buffer, maxLength: len) | ||||||||
| } | ||||||||
|
|
||||||||
| override func getBuffer(_ buffer: UnsafeMutablePointer<UnsafeMutablePointer<UInt8>?>, length len: UnsafeMutablePointer<Int>) -> Bool { | ||||||||
| return readableInputStream.getBuffer(buffer, length: len) | ||||||||
| } | ||||||||
| } | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // | ||
| // Copyright (c) 2018 cauli.works | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
| // | ||
|
|
||
| @testable import Cauliframework | ||
| import Foundation | ||
| import Quick | ||
| import Nimble | ||
|
|
||
| class FilecachedInputOutputStreamSpec: QuickSpec { | ||
| override func spec() { | ||
| describe("hasBytesAvailable") { | ||
| it("should be true if the outputstream isn't closed even if no data was written before") { | ||
| let stream = FilecachedInputOutputStream() | ||
| expect(stream.hasBytesAvailable) == true | ||
| } | ||
| it("should be false if the outputstream is closed") { | ||
| let stream = FilecachedInputOutputStream() | ||
| stream.writableOutputStream?.close() | ||
| expect(stream.hasBytesAvailable) == false | ||
| } | ||
| it("should be false if the outputstream is closed, even if unread data was written to") { | ||
| let stream = FilecachedInputOutputStream() | ||
| let data = "spec_data".data(using: .utf8)! | ||
| _ = data.withUnsafeBytes { stream.writableOutputStream?.write($0, maxLength: data.count) } | ||
| stream.writableOutputStream?.close() | ||
| expect(stream.hasBytesAvailable) == false | ||
| } | ||
| } | ||
| describe("read") { | ||
| it("shouldn't read any data if nothing was written to it") { | ||
| let stream = FilecachedInputOutputStream() | ||
| stream.open() | ||
| let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: 1024) | ||
| let readBytes = stream.read(buffer, maxLength: 1024) | ||
| expect(readBytes) == 0 | ||
| } | ||
| it("shouldn't read the same data that was written to the output stream") { | ||
| let stream = FilecachedInputOutputStream() | ||
| let writtenData = "spec_data".data(using: .utf8)! | ||
| _ = writtenData.withUnsafeBytes { stream.writableOutputStream?.write($0, maxLength: writtenData.count) } | ||
| stream.open() | ||
| let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: 1024) | ||
| let readBytes = stream.read(buffer, maxLength: 1024) | ||
| let readData = Data(bytes: buffer, count: readBytes) | ||
| expect(readBytes) == writtenData.count | ||
| expect(readData) == writtenData | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func tempfile() -> URL { | ||
| let tempfolder = URL(fileURLWithPath: NSTemporaryDirectory()) | ||
| return tempfolder.appendingPathComponent(UUID().uuidString) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about adding a
swiftlint:next:disable force_unwrapping?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah! What do you think about this?