Show description for cron expressions

THIRD-PARTY-NOTICES.md

@@ -19,6 +19,7 @@ This project incorporates components from the projects listed below. The origina
 15. [Cronos](#cronos) (<https://github.com/HangfireIO/Cronos>)
 16. [BouncyCastle](#bouncy-castle) (<https://www.bouncycastle.org/>)
 17. [SVG Repo](#svg-repo) (<https://www.svgrepo.com/>)
+18. [Cron Expression Descriptor](#cron-expression-descriptor) (<https://github.com/bradymholt/cron-expression-descriptor/>)
 
 Newtonsoft.Json
 =========================================
@@ -564,3 +565,23 @@ 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.
+
+Cron Expression Descriptor
+=========================================
+
+Copyright (c) 2017 Brady Holt
+
+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.

src/Directory.Build.props

@@ -17,6 +17,7 @@
     </PropertyGroup>
 
     <PropertyGroup>
+        <Nuget_CronExpressionDescriptor>2.20.0</Nuget_CronExpressionDescriptor>
         <Nuget_Cronos>0.7.1</Nuget_Cronos>
         <NuGet_DotNet>6.0.0</NuGet_DotNet>
         <Nuget_GitInfo>2.2.0</Nuget_GitInfo>

src/dev/impl/DevToys/DevToys.csproj

@@ -776,6 +776,7 @@
     </Page>
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="CronExpressionDescriptor" Version="$(Nuget_CronExpressionDescriptor)" />
     <PackageReference Include="Cronos" Version="$(Nuget_Cronos)" />
     <PackageReference Include="GitInfo" Version="$(Nuget_GitInfo)" />
     <PackageReference Include="Markdig" Version="$(Nuget_Markdig)" />

src/dev/impl/DevToys/LanguageManager.cs

@@ -1006,6 +1006,16 @@ public class CRONParserStrings : ObservableObject
         /// Gets the resource SecondsIncludedMode.
         /// </summary>
         public string SecondsIncludedMode => _resources.GetString("SecondsIncludedMode");
+
+        /// <summary>
+        /// Gets the resource DescriptionTitle.
+        /// </summary>
+        public string DescriptionTitle => _resources.GetString("DescriptionTitle");
+
+        /// <summary>
+        /// Gets the resource DescriptionErrorMessage.
+        /// </summary>
+        public string DescriptionErrorMessage => _resources.GetString("DescriptionErrorMessage");
     }
 
     public class GuidGeneratorStrings : ObservableObject

src/dev/impl/DevToys/Strings/en-US/CRONParser.resw

@@ -171,4 +171,10 @@
   <data name="SecondsIncludedMode" xml:space="preserve">
     <value>Seconds included (6 - segment Cron)</value>
   </data>
+  <data name="DescriptionTitle" xml:space="preserve">
+    <value>Description</value>
+  </data>
+  <data name="DescriptionErrorMessage" xml:space="preserve">
+    <value>Unable to generate description</value>
+  </data>
 </root>

src/dev/impl/DevToys/ViewModels/Tools/Converters/CronParser/CronParserToolViewModel.cs

@@ -12,6 +12,8 @@
 using Microsoft.Toolkit.Mvvm.ComponentModel;
 using Microsoft.Toolkit.Mvvm.Input;
 using Windows.ApplicationModel.DataTransfer;
+using CronExpressionDescriptor;
+using DevToys.Core;
 
 namespace DevToys.ViewModels.Tools.CronParser
 {
@@ -25,6 +27,7 @@ public sealed class CronParserToolViewModel : ObservableRecipient, IToolViewMode
         private string _cronExpression;
         private bool _setPropertyInProgress;
         private string? _outputValue;
+        private string? _cronDescription;
 
         private const string DefaultCronWithSeconds = "* * * * * *";
         private const string DefaultCronWithoutSeconds = "* * * * *";
@@ -165,6 +168,14 @@ internal string? OutputValue
             private set => SetProperty(ref _outputValue, value);
         }
 
+        /// <summary>
+        /// A human-readable description of the cron expression
+        /// </summary>
+        internal string? CronDescription
+        {
+            get => _cronDescription;
+            set => SetProperty(ref _cronDescription, value);
+        }
 
         [ImportingConstructor]
         public CronParserToolViewModel(ISettingsProvider settingsProvider)
@@ -218,6 +229,17 @@ private void ParseCronExpression()
                     return;
                 }
 
+                // Attempt to generate a description
+                try
+                {
+                    CronDescription = ExpressionDescriptor.GetDescription(UserCronExpression);
+                }
+                catch (Exception ex)
+                {
+                    CronDescription = Strings.DescriptionErrorMessage;
+                    Logger.LogFault($"Error generating description from cron expression: '{UserCronExpression}'", ex);
+                }
+
                 output.Add(nextOccurence.Value.ToString(OutputDateTimeFormat));
 
                 for (int i = 0; i <= int.Parse(OutputLimitMode); i++)

src/dev/impl/DevToys/Views/Tools/Converters/CronParser/CronParserToolPage.xaml

@@ -34,6 +34,7 @@
         </Grid.ChildrenTransitions>
 
         <Grid.RowDefinitions>
+            <RowDefinition Height="Auto"/>
             <RowDefinition Height="Auto"/>
             <RowDefinition Height="Auto"/>
             <RowDefinition Height="*"/>
@@ -102,7 +103,15 @@
              Tag="UserCronExpression"/>
 
         <controls:CustomTextBox
-             Grid.Row="2"
+            Grid.Row="2"
+            IsReadOnly="True"
+            AcceptsReturn="True"
+            IsRichTextEdit="False"
+            Header="{x:Bind ViewModel.Strings.DescriptionTitle}"
+            Text="{x:Bind ViewModel.CronDescription, Mode=OneWay}"/>
+
+        <controls:CustomTextBox
+             Grid.Row="3"
              MinHeight="250"
              IsReadOnly="True"            
              AcceptsReturn="True"