Merge branch 'release/0.9.4'

Author: Arvtesh

CHANGELOG.md

@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/); this project adheres to [Semantic Versioning](http://semver.org/).
 
+-----------------------
+## [0.9.4] - 2018.07.10
+
+### Added
+- Added assembly definition file for Unity 2017.3+.
+- Added `AsyncResult.FaultedOperation` helper.
+- Added `AsyncUtility.IsMainThread` method.
+- Added `AsyncUtility.GetAssetBundle`, `AsyncUtility.GetTexture`, `AsyncUtility.AudioClip` and `AsyncUtility.GetMovieTexture` helper methods.
+- Added `AssetBundleCreateRequest` wrapper operation.
+- Added `ThrowIfNonSuccess` extension for `IAsyncOperation`.
+- Added `ToEnum` extension for `IAsyncResult` that converts an asynchronous operation (`Task`, `AsyncResult` etc) to enumerator.
+- Added `IAsyncSchedulable` interface - an abstraction of a schedulable entity.
+- Added `AsyncLazy` helper for initialization operations.
+
+### Fixed
+- Fixed compile warnings for some older Unity versions.
+- Fixed error handling for Unity operation wrappers.
+
+### Removed
+- Removed `AggregateException` class for net35.
+
 -----------------------
 ## [0.9.3] - 2018.06.09
 

README.md

@@ -7,6 +7,8 @@ NuGet | [![NuGet](https://img.shields.io/nuget/v/UnityFx.Async.svg)](https://www
 Github | [![GitHub release](https://img.shields.io/github/release/Arvtesh/UnityFx.Async.svg?logo=github)](https://github.com/Arvtesh/UnityFx.Async/releases)
 Unity Asset Store | [![Asynchronous operations for Unity](https://img.shields.io/badge/tools-v0.9.3-green.svg)](https://assetstore.unity.com/packages/tools/asynchronous-operations-for-unity-96696)
 
+**If you enjoy using the library - please, [rate and review](https://assetstore.unity.com/packages/tools/asynchronous-operations-for-unity-96696) it on the Asset Store!**
+
 ## Synopsis
 
 *UnityFx.Async* introduces effective and portable asynchronous operations that can be used very much like [Tasks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task) in .NET or [Promises](https://developers.google.com/web/fundamentals/primers/promises) in JS. [AsyncResult](https://arvtesh.github.io/UnityFx.Async/api/netstandard2.0/UnityFx.Async.AsyncResult.html) class is an implementation of a generic asynchronous operation (aka `promise` or `future`). In many aspects it mimics [Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task) (for example, it can be used with `async`/`await` operators, supports continuations and synchronization context capturing) while maintaining Unity/net35 compatibility. It is a great foundation toolset for any Unity project.
@@ -331,12 +333,12 @@ DownloadTextAsync("http://www.google.com")
     .Then(text => ExtractFirstParagraph(text))
     .WithCancellation(cancellationToken);
 ```
-If the [token](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken) passed to `WithCancellation()` is cancelled the target operation is cancelled as well (and that means cancelling all chained operations) as soon as possible. Cancellation might not be instant (depends on specific operation implementation). Also, please note that not all operations might support cancellation; in this case `Cancel()` will throw `NotSupportedException`.
+If the [token](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken) passed to `WithCancellation()` is cancelled, the target operation is cancelled as well (and that means cancelling all chained operations) as soon as possible. Cancellation might not be instant (depends on specific operation implementation). Also, please note that not all operations might support cancellation; in this case `Cancel()` will throw `NotSupportedException`.
 
 ### Progress reporting
 Library operations support progress reporting via exposing `IAsyncOperation.Progress` property and progress reporting events:
 ```csharp
-var progress = op.Progess;  // gets an operation progress as a float value in range [0, 1]
+var progress = op.Progress;  // gets an operation progress as a float value in range [0, 1]
 
 // subscribe to progress changed event
 op.ProgressChanged += (sender, args) =>
@@ -375,7 +377,7 @@ There are also non-delegate completion callbacks (`IAsyncContinuation`):
 ```csharp
 class MyContinuation : IAsyncContinuation
 {
-    public void Invoke(IAsyncOperation op, bool inline) => Debug.Log("Done");
+    public void Invoke(IAsyncOperation op) => Debug.Log("Done");
 }
 
 // ...
@@ -483,7 +485,7 @@ Please note that the library is NOT a replacement for [Tasks](https://docs.micro
 - An extendable [IAsyncResult](https://docs.microsoft.com/en-us/dotnet/api/system.iasyncresult) implementation is needed.
 
 ## Motivation
-The project was initially created to help author with his [Unity3d](https://unity3d.com) projects. Unity's [AsyncOperation](https://docs.unity3d.com/ScriptReference/AsyncOperation.html) and the like can only be used in coroutines, cannot be extended and mostly do not return result or error information, .NET 3.5 does not provide much help either and even with .NET 4.6 support compatibility requirements often do not allow using [Tasks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task). When I caught myself writing the same asynchronous operation wrappers in each project I decided to share my experience for the best of human kind.
+The project was initially created to help author with his [Unity3d](https://unity3d.com) projects. Unity's [AsyncOperation](https://docs.unity3d.com/ScriptReference/AsyncOperation.html) and similar can only be used in coroutines, cannot be extended and mostly do not return result or error information, .NET 3.5 does not provide much help either and even with .NET 4.6 support compatibility requirements often do not allow using [Tasks](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task). When I caught myself writing the same asynchronous operation wrappers in each project I decided to share my experience to the best of human kind.
 
 ## Documentation
 Please see the links below for extended information on the product:

src/Build.ps1

@@ -69,6 +69,7 @@ function _PublishAssetStorePackage
 	param([string]$targetFramework)
 
 	$changelogPath = (Join-Path $scriptPath "..\CHANGELOG.md")
+	$readmePath = (Join-Path $scriptPath "UnityFx.Async\README.txt")
 	$filesToPublish = (Join-Path $scriptPath "UnityFx.Async.AssetStore\Assets\*")
 	$binToPublish =(Join-Path $binPath (Join-Path $targetFramework "\*")) 
 	$publishPath = (Join-Path $assetStorePath (Join-Path $targetFramework "Assets"))
@@ -79,9 +80,9 @@ function _PublishAssetStorePackage
 	Copy-Item -Path $filesToPublish -Destination $publishPath -Force -Recurse
 	Copy-Item -Path $binToPublish -Destination $publishBinPath -Force -Recurse
 	Copy-Item -Path $changelogPath -Destination $publishPath2 -Force
+	Copy-Item -Path $readmePath -Destination $publishPath2 -Force
 }
 
-
 _PublishAssetStorePackage "net35"
 _PublishAssetStorePackage "net46"
 _PublishAssetStorePackage "netstandard2.0"

src/UnityFx.Async.AssetStore/Assets/UnityFx.Async/Module.asmdef

@@ -0,0 +1,8 @@
+{
+    "name": "UnityFx.Async.Unity",
+    "references": [],
+    "optionalUnityReferences": [],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false
+}

src/UnityFx.Async.AssetStore/Assets/UnityFx.Async/README.txt

@@ -0,0 +1,50 @@
+// Copyright (c) Alexander Bogarsukov.
+// Licensed under the MIT license. See the LICENSE.md file in the project root for more information.
+
+using System;
+using UnityEngine;
+
+namespace UnityFx.Async
+{
+	/// <summary>
+	/// A wrapper for <see cref="AssetBundleCreateRequest"/>.
+	/// </summary>
+	public class AssetBundleCreateRequestResult : AsyncOperationResult<AssetBundle>
+	{
+		#region data
+		#endregion
+
+		#region interface
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="AssetBundleCreateRequestResult"/> class.
+		/// </summary>
+		/// <param name="op">Source web request.</param>
+		public AssetBundleCreateRequestResult(AssetBundleCreateRequest op)
+			: base(op)
+		{
+		}
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="AssetBundleCreateRequestResult"/> class.
+		/// </summary>
+		/// <param name="op">Source web request.</param>
+		/// <param name="userState">User-defined data.</param>
+		public AssetBundleCreateRequestResult(AssetBundleCreateRequest op, object userState)
+			: base(op, userState)
+		{
+		}
+
+		#endregion
+
+		#region AsyncResult
+
+		/// <inheritdoc/>
+		protected override AssetBundle GetResult(AsyncOperation op)
+		{
+			return (op as AssetBundleCreateRequest).assetBundle;
+		}
+
+		#endregion
+	}
+}

src/UnityFx.Async.AssetStore/Assets/UnityFx.Async/Scripts/AssetBundleCreateRequestResult.cs

@@ -10,63 +10,40 @@ namespace UnityFx.Async
 	/// A wrapper for <see cref="AssetBundleRequest"/> with result value.
 	/// </summary>
 	/// <typeparam name="T">Result type.</typeparam>
-	public sealed class AssetBundleRequestResult<T> : AsyncResult<T> where T : UnityEngine.Object
+	public sealed class AssetBundleRequestResult<T> : AsyncOperationResult<T> where T : UnityEngine.Object
 	{
 		#region data
-
-		private readonly AssetBundleRequest _op;
-
 		#endregion
 
 		#region interface
 
 		/// <summary>
-		/// Gets the underlying <see cref="AssetBundleRequest"/> instance.
+		/// Initializes a new instance of the <see cref="AssetBundleRequestResult{T}"/> class.
 		/// </summary>
-		public AssetBundleRequest Request
+		/// <param name="op">Source operation.</param>
+		public AssetBundleRequestResult(AssetBundleRequest op)
+			: base(op)
 		{
-			get
-			{
-				return _op;
-			}
 		}
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="AssetBundleRequestResult{T}"/> class.
 		/// </summary>
-		/// <param name="op">Source web request.</param>
-		public AssetBundleRequestResult(AssetBundleRequest op)
-			: base(AsyncOperationStatus.Running)
+		/// <param name="op">Source operation.</param>
+		/// <param name="userState">User-defined data.</param>
+		public AssetBundleRequestResult(AssetBundleRequest op, object userState)
+			: base(op, userState)
 		{
-			_op = op;
-
-			if (op.isDone)
-			{
-				TrySetResult(op.asset as T, true);
-			}
-			else
-			{
-#if UNITY_2017_2_OR_NEWER || UNITY_2018
-
-				// Starting with Unity 2017.2 there is AsyncOperation.completed event
-				op.completed += o => TrySetResult(o.asset as T);
-
-#else
-
-				AsyncUtility.AddCompletionCallback(op, () => TrySetResult(_op.asset as T));
-
-#endif
-			}
 		}
 
 		#endregion
 
-		#region AsyncResult
+		#region AsyncOperationResult
 
 		/// <inheritdoc/>
-		protected override float GetProgress()
+		protected override T GetResult(AsyncOperation op)
 		{
-			return _op.progress;
+			return (op as AssetBundleRequest).asset as T;
 		}
 
 		#endregion

src/UnityFx.Async.AssetStore/Assets/UnityFx.Async/Scripts/AssetBundleRequestResult{T}.cs

@@ -35,11 +35,29 @@ public AsyncOperation Operation
 		/// </summary>
 		/// <param name="op">Source web request.</param>
 		public AsyncOperationResult(AsyncOperation op)
-			: base(AsyncOperationStatus.Running)
 		{
 			_op = op;
+		}
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="AsyncOperationResult"/> class.
+		/// </summary>
+		/// <param name="op">Source web request.</param>
+		/// <param name="userState">User-defined data.</param>
+		public AsyncOperationResult(AsyncOperation op, object userState)
+			: base(null, userState)
+		{
+			_op = op;
+		}
 
-			if (op.isDone)
+		#endregion
+
+		#region AsyncResult
+
+		/// <inheritdoc/>
+		protected override void OnStarted()
+		{
+			if (_op.isDone)
 			{
 				TrySetCompleted(true);
 			}
@@ -48,20 +66,16 @@ public AsyncOperationResult(AsyncOperation op)
 #if UNITY_2017_2_OR_NEWER || UNITY_2018
 
 				// Starting with Unity 2017.2 there is AsyncOperation.completed event
-				op.completed += o => TrySetCompleted();
+				_op.completed += o => TrySetCompleted();
 
 #else
 
-				AsyncUtility.AddCompletionCallback(op, () => TrySetCompleted());
+				AsyncUtility.AddCompletionCallback(_op, () => TrySetCompleted());
 
 #endif
 			}
 		}
 
-		#endregion
-
-		#region AsyncResult
-
 		/// <inheritdoc/>
 		protected override float GetProgress()
 		{