Skip to content

Commit

Permalink
Merge branch 'hotfix/1.0.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
abogarsukov committed Apr 9, 2019
2 parents 65c4f20 + 5897c86 commit b5c2507
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 9 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ 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/).

-----------------------
## [1.0.1] - 2019.04.09

NOTE: NuGet-only release to instead of not published v1.0.0.

### Changed
- Deprecated all `Task`-related extension methods. They are considered out of the library scope.

-----------------------
## [1.0.0] - 2019.02.23

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,10 +492,9 @@ As stated abovethe library include 2 main parts:
* Core tools (defined in `UnityFx.Async.dll` assembly, do not depend on Unity3d);
* Unity3d-specific tools (defined as a collection of C# scripts if installed as an Asset Store package, require Unity3d to compile/execute).

Everything described before (unless specified otherwise) does not require Unity and can be used in any application. The Unity-specific stuff is located in 3 classes:
Everything described before (unless specified otherwise) does not require Unity and can be used in any application. Essential Unity-specific stuff is located in classes:
* `AsyncUtility`. Defines helper methods for accessing main thread in Unity, running coroutines without actually using a `MonoBehaviour` and waiting for native Unity asynchronous operations outside of coroutines.
* `AsyncWww`. Defines web request related helpers.
* `UnityExtensions`. Defines extensions for native Unity classes (like `AsyncOperation` and `UnityWebRequest`).

For example, one can throw a few lines of code to be executed on a main thread using:
```csharp
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ public static IAsyncOperation<T> ToAsync<T>(this AssetBundleRequest op) where T
/// Creates an <see cref="Task"/> wrapper for the Unity <see cref="AsyncOperation"/>.
/// </summary>
/// <param name="op">The source operation.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task ToTask(this AsyncOperation op)
{
if (op.isDone)
Expand All @@ -78,6 +79,7 @@ public static Task ToTask(this AsyncOperation op)
/// Creates an <see cref="Task{TResult}"/> wrapper for the Unity <see cref="ResourceRequest"/>.
/// </summary>
/// <param name="op">The source operation.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task<T> ToTask<T>(this ResourceRequest op) where T : UnityEngine.Object
{
var result = new TaskCompletionSource<T>(op);
Expand All @@ -89,6 +91,7 @@ public static Task<T> ToTask<T>(this ResourceRequest op) where T : UnityEngine.O
/// Creates an <see cref="Task{TResult}"/> wrapper for the Unity <see cref="AssetBundleRequest"/>.
/// </summary>
/// <param name="op">The source operation.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task<T> ToTask<T>(this AssetBundleRequest op) where T : UnityEngine.Object
{
var result = new TaskCompletionSource<T>(op);
Expand All @@ -100,6 +103,7 @@ public static Task<T> ToTask<T>(this AssetBundleRequest op) where T : UnityEngin
/// Returns the operation awaiter. This method is intended for compiler use only.
/// </summary>
/// <param name="op">The operation to await.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static CompilerServices.AsyncOperationAwaiter GetAwaiter(this AsyncOperation op)
{
return new CompilerServices.AsyncOperationAwaiter(op);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public static IAsyncOperation<T> ToAsync<T>(this UnityWebRequest request) where
/// Creates an <see cref="Task"/> wrapper for the specified <see cref="UnityWebRequest"/>.
/// </summary>
/// <param name="request">The source web request.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task ToTask(this UnityWebRequest request)
{
var result = new TaskCompletionSource<object>(request);
Expand All @@ -56,6 +57,7 @@ public static Task ToTask(this UnityWebRequest request)
/// Creates an <see cref="Task{TResult}"/> wrapper for the specified <see cref="UnityWebRequest"/>.
/// </summary>
/// <param name="request">The source web request.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task<T> ToTask<T>(this UnityWebRequest request) where T : class
{
var result = new TaskCompletionSource<T>(request);
Expand All @@ -67,6 +69,7 @@ public static Task<T> ToTask<T>(this UnityWebRequest request) where T : class
/// Returns the operation awaiter. This method is intended for compiler use only.
/// </summary>
/// <param name="op">The operation to await.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static CompilerServices.UnityWebRequestAwaiter GetAwaiter(this UnityWebRequest op)
{
return new CompilerServices.UnityWebRequestAwaiter(op);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public static IAsyncOperation<T> ToAsync<T>(this WWW request) where T : class
/// Creates an <see cref="Task"/> wrapper for the specified <see cref="WWW"/>.
/// </summary>
/// <param name="request">The source web request.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task ToTask(this WWW request)
{
var result = new TaskCompletionSource<object>(request);
Expand All @@ -57,6 +58,7 @@ public static Task ToTask(this WWW request)
/// Creates an <see cref="Task{TResult}"/> wrapper for the specified <see cref="WWW"/>.
/// </summary>
/// <param name="request">The source web request.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static Task<T> ToTask<T>(this WWW request) where T : class
{
var result = new TaskCompletionSource<T>(request);
Expand All @@ -68,6 +70,7 @@ public static Task<T> ToTask<T>(this WWW request) where T : class
/// Returns the operation awaiter. This method is intended for compiler use only.
/// </summary>
/// <param name="op">The operation to await.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static CompilerServices.WwwAwaiter GetAwaiter(this WWW op)
{
return new CompilerServices.WwwAwaiter(op);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ public static class YieldInstructionExtensions
/// Returns the operation awaiter. This method is intended for compiler use only.
/// </summary>
/// <param name="op">The operation to await.</param>
[Obsolete("Task-related helpers are out of the library scope. Please use UnityFx.Tasks instead.")]
public static CompilerServices.YieldInstructionAwaiter GetAwaiter(this YieldInstruction op)
{
return new CompilerServices.YieldInstructionAwaiter(op);
Expand Down
12 changes: 6 additions & 6 deletions src/UnityFx.Async.AssetStore/UnityFx.Async.AssetStore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

<PropertyGroup>
<TargetFrameworks>net35;net46</TargetFrameworks>
<Description>Asset Store code for UnityFx.Async.</Description>
<Description>Asset Store scripts for UnityFx.Async.</Description>
<Company />
<Authors>Alexander Bogarsukov</Authors>
<Copyright>Alexander Bogarsukov</Copyright>
<RepositoryUrl>https://github.com/Arvtesh/UnityFx.Async</RepositoryUrl>
<RepositoryType>Git</RepositoryType>
<Version>0.7.0</Version>
<AssemblyVersion>0.7.0.0</AssemblyVersion>
<FileVersion>0.7.0.0</FileVersion>
<InformationalVersion>0.7.0.0</InformationalVersion>
<Version>1.0.0</Version>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<FileVersion>1.0.0.0</FileVersion>
<InformationalVersion>1.0.0.0</InformationalVersion>
<NeutralLanguage>en-US</NeutralLanguage>
<RootNamespace>UnityFx.Async</RootNamespace>
<IsPackable>false</IsPackable>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<CodeAnalysisRuleSet>../CodingConventions/Cs/CsharpRules.ruleset</CodeAnalysisRuleSet>
<LangVersion>4</LangVersion>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
</PropertyGroup>

<PropertyGroup Condition="'$(TargetFramework)' == 'net46'">
Expand Down
2 changes: 1 addition & 1 deletion src/UnityFx.Async/UnityFx.Async.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
<RepositoryType>Git</RepositoryType>
<PackageVersion>1.0.0</PackageVersion>
<PackageProjectUrl>https://github.com/Arvtesh/UnityFx.Async</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/Arvtesh/UnityFx.Async/blob/master/LICENSE.md</PackageLicenseUrl>
<PackageTags>UnityFx;Async;Promise;AsyncOperation;Coroutine;Task;Unity3d</PackageTags>
<PackageIconUrl></PackageIconUrl>
<Version>1.0.0</Version>
Expand All @@ -23,6 +22,7 @@
<CodeAnalysisRuleSet>../CodingConventions/Cs/CsharpRules.ruleset</CodeAnalysisRuleSet>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>UnityFx.Async.snk</AssemblyOriginatorKeyFile>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
</PropertyGroup>

<ItemGroup>
Expand Down

0 comments on commit b5c2507

Please sign in to comment.