Replaces ISuggestSource with IAsyncSuggest and modifies ISuggestResult.

Removes ISuggest file and uses IAsyncSuggest and ISuggestResult in SuggestBoxLib project in places of its interfaces.

Moves logic for validation and assigning suggestions to the SuggestBox's ItemsSource out of viewmodel and into SuggestBox.
This includes
-removing CollectionEmptyValidationRule and QueryResults from AppViewModel in CachedPathSuggestBox.Demo
-moving FastObservableCollection and NameOfExtension into SuggestBoxLib.

Author: Declan Taylor

source/Demos/CachedPathSuggest/Infrastructure/DirectoryHelper.cs

@@ -5,7 +5,7 @@
 
 namespace CachedPathSuggest.Infrastructure
 {
-    internal static class DirectoryHelper
+    public static class DirectoryHelper
     {
         public static IEnumerable<(string path, string? label)>? EnumerateSubDirectories(string input)
         {
@@ -36,7 +36,7 @@ internal static class DirectoryHelper
                 catch
                 {
                     // Catch invalid path exceptions here ...
-                    return EnumerateLogicalDrives();
+                    return Array.Empty<(string, string?)>();
                 }
             }
 

source/Demos/CachedPathSuggest/Service/ISuggest.cs

@@ -2,11 +2,8 @@
     x:Class="CachedPathSuggestBox.Demo.App"
     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-    xmlns:b="http://schemas.microsoft.com/xaml/behaviors"
     xmlns:suggestBoxLib="clr-namespace:SuggestBoxLib;assembly=SuggestBoxLib"
     xmlns:vm="clr-namespace:CachedPathSuggest.ViewModels;assembly=CachedPathSuggest" 
-    xmlns:validationRules="clr-namespace:CachedPathSuggestBox.Demo.ValidationRules"
-    xmlns:infrastructure="clr-namespace:CachedPathSuggestBox.Demo.Infrastructure"
     StartupUri="MainWindow.xaml">
     <Application.Resources>
 
@@ -80,36 +77,6 @@
                 <Setter Property="Hint" Value="Enter a file-system-path or the Space key" />
             </Style>
 
-            <suggestBoxLib:SuggestBox x:Key="DiskPathSuggestBox"
-                                      Style="{StaticResource SuggestBoxStyle}"
-                                      ItemsSource="{Binding QueryResults, Mode=OneTime}"
-                                      ItemContainerStyle="{StaticResource ItemContainerStyle}">
-                <suggestBoxLib:SuggestBox.SelectedValuePath>
-                    <infrastructure:NameOf Type='{x:Type vm:BaseItem}' Member='Value' />
-                </suggestBoxLib:SuggestBox.SelectedValuePath>
-                <b:Interaction.Triggers>
-                    <b:EventTrigger EventName="QueryChanged">
-                        <b:InvokeCommandAction Command="{Binding TextChangedCommand}" PassEventArgsToCommand="True" />
-                    </b:EventTrigger>
-                </b:Interaction.Triggers>
-                <TextBox.Resources>
-                    <validationRules:BindingProxy x:Key="TargetProxy" Data="{Binding Path=QueryResults.Count}" />
-                    <validationRules:BindingProxy x:Key="SourceProxy"
-                                                  Data="{Binding Path=Text, ElementName=DiskPathSuggestBox, Mode=TwoWay}" />
-                </TextBox.Resources>
-                <TextBox.Text>
-                    <Binding Path="Text" UpdateSourceTrigger="PropertyChanged">
-                        <Binding.ValidationRules>
-                            <validationRules:IsEmptyValidationRule>
-                                <validationRules:ComparisonValue
-                                    Value="{Binding Data, Source={StaticResource TargetProxy}}"
-                                    BindingToTrigger="{Binding Data, Source={StaticResource SourceProxy}}" />
-                            </validationRules:IsEmptyValidationRule>
-                        </Binding.ValidationRules>
-                    </Binding>
-                </TextBox.Text>
-            </suggestBoxLib:SuggestBox>
-
         </ResourceDictionary>
     </Application.Resources>
 

source/Demos/CachedPathSuggestBox.Demo/App.xaml

@@ -5,6 +5,10 @@
     xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
     xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
     xmlns:viewModel="clr-namespace:CachedPathSuggestBox.Demo.ViewModel"
+    xmlns:suggestBoxLib="clr-namespace:SuggestBoxLib;assembly=SuggestBoxLib"
+    xmlns:infrastructure="clr-namespace:CachedPathSuggestBox.Demo.Infrastructure;assembly=SuggestBoxLib"
+    xmlns:vm="clr-namespace:CachedPathSuggest.ViewModels;assembly=CachedPathSuggest"
+    xmlns:b="http://schemas.microsoft.com/xaml/behaviors"
     Title="MainWindow"
     Width="800"
     Height="250"
@@ -18,7 +22,20 @@
                     <ColumnDefinition Width="Auto" />
                 </Grid.ColumnDefinitions>
 
-                <ContentControl Content="{StaticResource DiskPathSuggestBox}" />
+                <suggestBoxLib:SuggestBox
+                                          Style="{StaticResource SuggestBoxStyle}"
+                                          SuggestSource="{Binding AsyncSuggest, Mode=OneTime}"
+                                          ItemContainerStyle="{StaticResource ItemContainerStyle}"
+                                          Text="{Binding Path=Text, UpdateSourceTrigger=PropertyChanged}">
+                    <suggestBoxLib:SuggestBox.SelectedValuePath>
+                        <infrastructure:NameOf Type='{x:Type vm:BaseItem}' Member='Value' />
+                    </suggestBoxLib:SuggestBox.SelectedValuePath>
+                    <b:Interaction.Triggers>
+                        <b:EventTrigger EventName="QueryChanged">
+                            <b:InvokeCommandAction Command="{Binding TextChangedCommand}" PassEventArgsToCommand="True" />
+                        </b:EventTrigger>
+                    </b:Interaction.Triggers>
+                </suggestBoxLib:SuggestBox>
 
                 <WrapPanel Grid.Column="1" Margin="5">
                     <FrameworkElement.Resources>

source/Demos/CachedPathSuggestBox.Demo/MainWindow.xaml

@@ -1,22 +1,23 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
 using CachedPathSuggest.Infrastructure;
 using CachedPathSuggest.ViewModels;
+using SuggestBoxLib.Interfaces;
+using SuggestBoxLib.Model;
 
-namespace CachedPathSuggest.Service
+namespace CachedPathSuggestBox.Demo.Service
 {
     /// <summary>
     ///     Wraps a LiteDB to generate previously bookmarked suggestions through similarity for a given string.
     /// </summary>
-    public class CachedPathInformationAsyncSuggest : IAsyncSuggest
+    public class CachedAsyncSuggest : IAsyncSuggest
     {
         private static readonly int NumberOfResultsToReturn = 5;
         private readonly LiteRepository repository;
 
-        public CachedPathInformationAsyncSuggest(LiteRepository repository)
+        public CachedAsyncSuggest(LiteRepository repository)
         {
             this.repository = repository;
         }
@@ -35,9 +36,9 @@ public CachedPathInformationAsyncSuggest(LiteRepository repository)
         ///     f:\\do_letters
         ///     g:\\document\lists.ico
         /// </example>
-        public async Task<IReadOnlyCollection<BaseItem>?> SuggestAsync(string queryThis)
+        public async Task<ISuggestResult> SuggestAsync(string queryThis)
         {
-            return await Task.Run(() => GetPathInformations(queryThis, repository));
+            return new SuggestResult(await Task.Run(() => GetPathInformations(queryThis, repository)));
 
             static CachedPathInformation[] GetPathInformations(string key, LiteRepository repository)
             {

source/Demos/CachedPathSuggest/Service/CachedPathInformationSuggest.cs renamed to source/Demos/CachedPathSuggestBox.Demo/Service/CachedAsyncSuggest.cs

@@ -4,18 +4,18 @@
 using System.Threading.Tasks;
 using CachedPathSuggest.Infrastructure;
 using CachedPathSuggest.ViewModels;
+using SuggestBoxLib.Interfaces;
+using SuggestBoxLib.Model;
 
-namespace CachedPathSuggest.Service
+namespace CachedPathSuggestBox.Demo.Service
 {
     /// <summary>
     ///     Wraps a LiteDB and a FileSystem data provider to generate similarity based suggestions
     ///     for a given string.
     /// </summary>
     public class CombinedAsyncSuggest : IAsyncSuggest
     {
-        private readonly CachedPathInformationAsyncSuggest
-            cachedPathInformationAsyncSuggest = new(new LiteRepository());
-
+        private readonly CachedAsyncSuggest cachedAsyncSuggest = new(new LiteRepository());
         private readonly DirectoryAsyncSuggest directoryAsyncSuggest = new();
 
         /// <summary>
@@ -29,20 +29,22 @@ private readonly CachedPathInformationAsyncSuggest
         ///     in a single list. The list contains a separator item (if both types of items are returned).
         ///     The separator item can be used for visual enhancement when displaying the list.
         /// </returns>
-        public async Task<IReadOnlyCollection<BaseItem>?> SuggestAsync(string queryThis)
+        public async Task<ISuggestResult> SuggestAsync(string queryThis)
         {
-            var cachedSuggestions = await cachedPathInformationAsyncSuggest.SuggestAsync(queryThis);
+            var cachedSuggestions = await cachedAsyncSuggest.SuggestAsync(queryThis);
             var directorySuggestions = await directoryAsyncSuggest.SuggestAsync(queryThis);
-            return (cachedSuggestions, directorySuggestions) switch
+            var suggestions = (cachedSuggestions, directorySuggestions) switch
             {
                 (null, null) => null,
-                ({Count: 0}, {Count: 0}) => null,
-                ({Count: 0}, {Count: > 0}) => directorySuggestions,
-                ({Count: > 0}, {Count: 0}) => cachedSuggestions,
-                ({Count: > 0} c, {Count: > 0} d) => c
-                    .Concat(new[] {new ItemSeparator()}).Concat(d).ToArray(),
+                ({ Suggestions: { Count: 0 } }, { Suggestions: { Count: 0 } }) => null,
+                ({ Suggestions: { Count: 0 } }, { Suggestions: { Count: > 0 } }) => directorySuggestions.Suggestions,
+                ({ Suggestions: { Count: > 0 } }, { Suggestions: { Count: 0 } }) => cachedSuggestions.Suggestions,
+                ({ Suggestions: { Count: > 0 } c }, { Suggestions: { Count: > 0 } d }) => c
+
+                    .Concat(new[] { new ItemSeparator() }).Concat(d).ToArray(),
                 _ => throw new ArgumentOutOfRangeException()
             };
+            return new SuggestResult(suggestions, suggestions?.Count > 0);
         }
 
         /// <summary>
@@ -51,7 +53,7 @@ private readonly CachedPathInformationAsyncSuggest
         /// <param name="text"></param>
         public void AddCachedSuggestion(string text)
         {
-            cachedPathInformationAsyncSuggest.Insert(text);
+            cachedAsyncSuggest.Insert(text);
         }
 
         /// <summary>
@@ -60,7 +62,7 @@ public void AddCachedSuggestion(string text)
         /// <param name="text"></param>
         public void RemoveCachedSuggestion(string text)
         {
-            cachedPathInformationAsyncSuggest.Delete(text);
+            cachedAsyncSuggest.Delete(text);
         }
 
         /// <summary>
@@ -69,7 +71,7 @@ public void RemoveCachedSuggestion(string text)
         /// <param name="text"></param>
         public bool ContainsSuggestion(string text)
         {
-            return cachedPathInformationAsyncSuggest.Match(text);
+            return cachedAsyncSuggest.Match(text);
         }
     }
 }

source/Demos/CachedPathSuggest/Service/CombinedSuggest.cs renamed to source/Demos/CachedPathSuggestBox.Demo/Service/CombinedAsyncSuggest.cs

@@ -5,8 +5,10 @@
 using System.Threading.Tasks;
 using CachedPathSuggest.Infrastructure;
 using CachedPathSuggest.ViewModels;
+using SuggestBoxLib.Interfaces;
+using SuggestBoxLib.Model;
 
-namespace CachedPathSuggest.Service
+namespace CachedPathSuggestBox.Demo.Service
 {
     /// <summary>
     ///     Wraps a LiteDB and a FileSystem data provider to generate similarity based suggestions
@@ -28,19 +30,19 @@ public DirectoryAsyncSuggest()
         /// <summary>
         ///     Class constructor
         /// </summary>
-        public async Task<IReadOnlyCollection<BaseItem>?> SuggestAsync(string queryThis)
+        public async Task<ISuggestResult> SuggestAsync(string queryThis)
         {
             tokenSource.Cancel();
 
             tokenSource = new CancellationTokenSource();
-            var ty = Task.Run(() =>
+            var ty =await Task.Run(() =>
                 (string.IsNullOrWhiteSpace(queryThis)
                     ? DirectoryHelper.EnumerateLogicalDrives().ToArray()
                     : DirectoryHelper.EnumerateSubDirectories(queryThis)?.ToArray() ??
                       Array.Empty<(string name, string? vi)>())
                 .Select(r => new PathInformation(r.path, r.label)).ToArray(), tokenSource.Token);
 
-            return await ty;
+            return new SuggestResult(ty);
         }
     }
 }