Merge pull request #28 from windows-toolkit/feature/preview3-update

Preview4 update

Author: michael-hawker

azure-pipelines.yml

@@ -18,7 +18,10 @@ steps:
 
 - task: NuGetCommand@2
   inputs:
-    restoreSolution: '$(solution)'
+    command: 'restore'
+    restoreSolution: '**/*.sln'
+    feedsToUse: 'config'
+    nugetConfigPath: ./samples/nuget.config
 
 - task: VSBuild@1
   inputs:

docs/mvvm/ObservableObject.md

@@ -53,7 +53,7 @@ public class ObservableUser : ObservableObject
     public string Name
     {
         get => user.Name;
-        set => Set(user.Name, value, user, (u, n) => u.Name = n);
+        set => SetProperty(user.Name, value, user, (u, n) => u.Name = n);
     }
 }
 ```

samples/MvvmSampleUwp/MvvmSampleUwp/App.xaml.cs

@@ -39,12 +39,12 @@ protected override void OnLaunched(LaunchActivatedEventArgs e)
                 TitleBarHelper.ExpandViewIntoTitleBar();
 
                 // Register services
-                Ioc.Default.ConfigureServices(services =>
-                {
-                    services.AddSingleton<IFilesService, FilesService>();
-                    services.AddSingleton<ISettingsService, SettingsService>();
-                    services.AddSingleton(RestService.For<IRedditService>("https://www.reddit.com/"));
-                });
+                Ioc.Default.ConfigureServices(
+                    new ServiceCollection()
+                    .AddSingleton<IFilesService, FilesService>()
+                    .AddSingleton<ISettingsService, SettingsService>()
+                    .AddSingleton(RestService.For<IRedditService>("https://www.reddit.com/"))
+                    .BuildServiceProvider());
             }
 
             // Enable the prelaunch if needed, and activate the window

samples/MvvmSampleUwp/MvvmSampleUwp/Assets/docs/AsyncRelayCommand.md

@@ -9,13 +9,14 @@ dev_langs:
 
 # AsyncRelayCommand and AsyncRelayCommand<T>
 
-The [AsyncRelayCommand](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.mvvm.input.AsyncRelayCommand) and [AsyncRelayCommand<T>](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.mvvm.input.AsyncRelayCommand-1) are `ICommand` implementations that extend the functionalities offered by `RelayCommand`, with support for asynchronous operations.
+The [`AsyncRelayCommand`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.mvvm.input.AsyncRelayCommand) and [`AsyncRelayCommand<T>`](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.mvvm.input.AsyncRelayCommand-1) are `ICommand` implementations that extend the functionalities offered by `RelayCommand`, with support for asynchronous operations.
 
 ## How they work
 
 `AsyncRelayCommand` and `AsyncRelayCommand<T>` have the following main features:
 
-- They extend the functionalities of the non-asynchronous commands included in the library, with support for `Task`-returning delegates.
+- They extend the functionalities of the synchronous commands included in the library, with support for `Task`-returning delegates.
+- They can wrap asynchronous functions with an additional `CancellationToken` parameter to support cancelation, and they expose a `CanBeCanceled` and `IsCancellationRequested` properties, as well as a `Cancel` method.
 - They expose an `ExecutionTask` property that can be used to monitor the progress of a pending operation, and an `IsRunning` that can be used to check when an operation completes. This is particularly useful to bind a command to UI elements such as loading indicators.
 - They implement the `IAsyncRelayCommand` and `IAsyncRelayCommand<T>` interfaces, which means that viewmodel can easily expose commands using these to reduce the tight coupling between types. For instance, this makes it easier to replace a command with a custom implementation exposing the same public API surface, if needed.
 

samples/MvvmSampleUwp/MvvmSampleUwp/Assets/docs/Introduction.md

@@ -33,6 +33,8 @@ using Microsoft.Toolkit.Mvvm;
 Imports Microsoft.Toolkit.Mvvm
 ```
 
+3. Code samples are available in the other docs pages for the MVVM package, and in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/master/UnitTests/UnitTests.Shared/Mvvm) for the project.
+
 ## When should I use this package?
 
 Use this package for access to a collection of standard, self-contained, lightweight types that provide a starting implementation for building modern apps using the MVVM pattern. These types alone are usually enough for many users to build apps without needing additional external references.
@@ -65,5 +67,3 @@ The included types are:
   - `ValueChangedMessage<T>`
 
 This package aims to offer as much flexibility as possible, so developers are free to choose which components to use.  All types are loosely-coupled, so that it's only necessary to include what you use. There is no requirement to go "all-in" with a specific series of all-encompassing APIs, nor is there a set of mandatory patterns that need to be followed when building apps using these helpers. Combine these building blocks in a way that best fits your needs.
-
-Code samples are available in the other docs pages for the MVVM package, and in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/master/UnitTests/UnitTests.Shared/Mvvm) for the project.

samples/MvvmSampleUwp/MvvmSampleUwp/Assets/docs/Ioc.md

@@ -1,47 +1,82 @@
 ---
 title: Ioc
 author: Sergio0694
-description: A type that facilitates the use of the IServiceProvider type
+description: An introduction to the use of the IServiceProvider type through the Microsoft.Extensions.DependencyInjection APIs
 keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, mvvm, service, dependency injection, net core, net standard
 dev_langs:
   - csharp
 ---
 
 # Ioc ([Inversion of control](https://en.wikipedia.org/wiki/Inversion_of_control))
 
-The [Ioc](https://docs.microsoft.com/dotnet/api/microsoft.toolkit.mvvm.DependencyInjection.Ioc) class is a type that facilitates the use of the `IServiceProvider` type. It's powered by the `Microsoft.Extensions.DependencyInjection` package, which provides a fully featured and powerful DI set of APIs, and acts as an easy to setup and use `IServiceProvider`.
+Inversion of Control is a common pattern that can be used to increase modularity in the codebase of an application when using the MVVM pattern. A frequently used way to enable this is to use _dependency injection_ (DI), which consists of creating a number of services that are injected into backend classes (i.e. passed as parameters to the viewmodel constructors). Doing this allows code using these services not to rely on the implementation details of these services, and it also makes it easy to swap the concrete implementations of these services. This pattern also makes it easy to make platform-specific features available to backend code, by abstracting them through a service which is then injected where needed. Since services are then isolated from where they are used, they become more testable as well.
+
+The MVVM Toolkit doesn't provide built-in APIs to facilitate the usage of this pattern, as dedicated libraries specifically exist for this, such as the `Microsoft.Extensions.DependencyInjection` package. It provides a fully featured and powerful set of dependency injection APIs already and can be easily setup to use the [`IServiceProvider`](https://docs.microsoft.com/dotnet/api/system.iserviceprovider) interface. The following guide will refer to this library and provide a series of examples of how to integrate it into applications using the MVVM pattern with the MVVM Toolkit.
 
 ## Configure and resolve services
 
-The main entry point is the `ConfigureServices` method, which can be used like so:
+The first step is to declare an `IServiceProvider` instance, and to initialize all the necessary services, usually at startup. For instance, on UWP (but a similar setup can be used on other frameworks too):
 
 ```csharp
-// Register the services at startup
-Ioc.Default.ConfigureServices(services =>
+public sealed partial class App : Application
 {
-    services.AddSingleton<IFilesService, FilesService>();
-    services.AddSingleton<ISettingsService, SettingsService>();
-    // Other services here...
-});
+    public App()
+    {
+        Services = ConfigureServices();
+
+        this.InitializeComponent();
+    }
+
+    /// <summary>
+    /// Gets the current <see cref="App"/> instance in use
+    /// </summary>
+    public new static App Current => (App)Application.Current;
+
+    /// <summary>
+    /// Gets the <see cref="IServiceProvider"/> instance to resolve application services.
+    /// </summary>
+    public IServiceProvider Services { get; }
+
+    /// <summary>
+    /// Configures the services for the application.
+    /// </summary>
+    private static IServiceProvider ConfigureServices()
+    {
+        var services = new ServiceCollection();
+
+        services.AddSingleton<IFilesService, FilesService>();
+        services.AddSingleton<ISettingsService, SettingsService>();
+        services.AddSingleton<IClipboardService, ClipboardService>();
+        services.AddSingleton<IShareService, ShareService>();
+        services.AddSingleton<IEmailService, EmailService>();
 
-// Retrieve a service instance when needed
-IFilesService fileService = Ioc.Default.GetService<IFilesService>();
+        return services.BuildServiceProvider();
+    }
+}
 ```
 
-The `Ioc.Default` property offers a thread-safe `IServiceProvider` instance that can be used anywhere in the application to resolve services. The `ConfigureService` method handles the initialization of that service. It is also possible to create different `Ioc` instances and to initialize each with different services.
+Here the `Services` property is initialized at startup, and all the application services and viewmodels are registered. There is also a new `Current` property that can be used to easily access the `Services` property from other views in the application. For instance:
+
+```csharp
+IFilesService filesService = App.Current.Services.GetService<IFilesService>();
+
+// Use the files service here...
+```
+
+The key aspect here is that each service may very well be using platform-specific APIs, but since those are all abstracted away through the interface our code is using, we don't need to worry about them whenever we're just resolving an instance and using it to perform operations.
 
 ## Constructor injection
 
 One powerful feature that is available is "constructor injection", which means that the DI service provider is able to automatically resolve indirect dependencies between registered services when creating instances of the type being requested. Consider the following service:
 
 ```csharp
-public class ConsoleLogger : ILogger
+public class FileLogger : IFileLogger
 {
-    private readonly IFileService FileService;
+    private readonly IFilesService FileService;
     private readonly IConsoleService ConsoleService;
 
-    public ConsoleLogger(
-        IFileService fileService,
+    public FileLogger(
+        IFilesService fileService,
         IConsoleService consoleService)
     {
         FileService = fileService;
@@ -52,22 +87,61 @@ public class ConsoleLogger : ILogger
 }
 ```
 
-Here we have a `ConsoleLogger` implementing the `ILogger` interface, and requiring `IFileService` and `IConsoleService` instances. Constructor injection means the DI service provider will "automagically" gather all the necessary services, like so:
+Here we have a `FileLogger` type implementing the `IFileLogger` interface, and requiring `IFilesService` and `IConsoleService` instances. Constructor injection means the DI service provider will automatically gather all the necessary services, like so:
 
 ```csharp
-// Register the services at startup
-Ioc.Default.ConfigureServices(services =>
+/// <summary>
+/// Configures the services for the application.
+/// </summary>
+private static IServiceProvider ConfigureServices()
 {
-    services.AddSingleton<IFileService, FileService>();
+    var services = new ServiceCollection();
+
+    services.AddSingleton<IFilesService, FilesService>();
     services.AddSingleton<IConsoleService, ConsoleService>();
-    services.AddSingleton<ILogger, ConsoleLogger>();
-});
+    services.AddSingleton<IFileLogger, FileLogger>();
+
+    return services.BuildServiceProvider();
+}
 
 // Retrieve a logger service with constructor injection
-ILogger consoleLogger = Ioc.Default.GetService<ILogger>();
+IFileLogger fileLogger = App.Current.Services.GetService<IFileLogger>();
+```
+
+The DI service provider will automatically check whether all the necessary services are registered, then it will retrieve them and invoke the constructor for the registered `IFileLogger` concrete type, to get the instance to return.
+
+## What about viewmodels?
+
+A service provider has "service" in its name, but it can actually be used to resolve instances of any class, including viewmodels! The same concepts explained above still apply, including constructor injection. Imagine we had a `ContactsViewModel` type, using an `IContactsService` and an `IPhoneService` instance through its constructor. We could have a `ConfigureServices` method like this:
+
+```csharp
+/// <summary>
+/// Configures the services for the application.
+/// </summary>
+private static IServiceProvider ConfigureServices()
+{
+    var services = new ServiceCollection();
+
+    // Services
+    services.AddSingleton<IContactsService, ContactsService>();
+    services.AddSingleton<IPhoneService, PhoneService>();
+
+    // Viewmodels
+    services.AddTransient<ContactsViewModel>();
+
+    return services.BuildServiceProvider();
+}
 ```
 
-The DI service provider will automatically check whether all the necessary services are registered, then it will retrieve them and invoke the constructor for the registered `ILogger` concrete type, to get the instance to return - all done automatically!
+And then in our `ContactsView`, we would assign the data context as follows:
+
+```csharp
+public ContactsView()
+{
+    this.InitializeComponent();
+    this.DataContext = App.Current.Services.GetService<ContactsViewModel>();
+}
+```
 
 ## More docs