(GH-256) sort packages by name

This change adds a new command line option "order-by", allowing the
user to specify a few sorting strategies. By default the results will
be sorted by name.

Author: bartvanandel

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1

@@ -43,8 +43,8 @@ $proUninstallOptions = " --from-programs-and-features"
 $proPinOptions = " --note=''"
 
 $commandOptions = @{
-  list = "--lo --id-only --pre --exact --by-id-only --id-starts-with --detailed --approved-only --not-broken --source='' --user= --password= --local-only --prerelease --include-programs --page= --page-size= --order-by-popularity --download-cache-only" + $proListOptions + $allcommands
-  search = "--pre --exact --by-id-only --id-starts-with --detailed --approved-only --not-broken --source='' --user= --password= --local-only --prerelease --include-programs --page= --page-size= --order-by-popularity --download-cache-only" + $allcommands
+  list = "--lo --id-only --pre --exact --by-id-only --id-starts-with --detailed --approved-only --not-broken --source='' --user= --password= --local-only --prerelease --include-programs --page= --page-size= --order-by --order-by-popularity --download-cache-only" + $proListOptions + $allcommands
+  search = "--pre --exact --by-id-only --id-starts-with --detailed --approved-only --not-broken --source='' --user= --password= --local-only --prerelease --include-programs --page= --page-size= --order-by --order-by-popularity --download-cache-only" + $allcommands
   info = "--pre --lo --source='' --user= --password= --local-only --prerelease" + $allcommands
   install = "-y -whatif -? --pre --version= --params='' --install-arguments='' --override-arguments --ignore-dependencies --source='' --source='windowsfeatures' --source='webpi' --user= --password= --prerelease --forcex86 --not-silent --package-parameters='' --allow-downgrade --force-dependencies --require-checksums --use-package-exit-codes --ignore-package-exit-codes --skip-automation-scripts --allow-multiple-versions --ignore-checksums --allow-empty-checksums --allow-empty-checksums-secure --download-checksum='' --download-checksum-type='' --download-checksum-x64='' --download-checksum-type-x64='' --stop-on-first-package-failure" + $proInstallUpgradeOptions + $allcommands
   pin = "--name= --version= -?" + $proPinOptions + $allcommands

src/chocolatey/chocolatey.csproj

@@ -116,6 +116,7 @@
     <Compile Include="infrastructure.app\domain\installers\SquirrelInstaller.cs" />
     <Compile Include="infrastructure.app\domain\installers\WindowsUpdateInstaller.cs" />
     <Compile Include="infrastructure.app\domain\installers\WiseInstaller.cs" />
+    <Compile Include="infrastructure.app\domain\PackageOrder.cs" />
     <Compile Include="infrastructure.app\domain\RegistryHiveType.cs" />
     <Compile Include="infrastructure.app\domain\RegistryValueExtensions.cs" />
     <Compile Include="infrastructure.app\domain\RegistryValueKindType.cs" />

src/chocolatey/infrastructure.app/commands/ChocolateyListCommand.cs

@@ -16,11 +16,13 @@
 
 namespace chocolatey.infrastructure.app.commands
 {
+    using System;
     using System.Collections.Generic;
     using System.Linq;
     using attributes;
     using commandline;
     using configuration;
+    using domain;
     using infrastructure.commands;
     using logging;
     using results;
@@ -102,9 +104,28 @@ public virtual void configure_argument_parser(OptionSet optionSet, ChocolateyCon
                  .Add("id-starts-with",
                      "IdStartsWith - Only return packages where the id starts with the search filter. Available in 0.9.10+.",
                      option => configuration.ListCommand.IdStartsWith = option != null)
+                 .Add("o=|order=|order-by=",
+                     "OrderBy - Sort by package results by name (default), title, popularity, lastpublished, unsorted. Available in 0.10.12+.",
+                     option =>
+                     {
+                         PackageOrder packageOrder;
+                         if (Enum.TryParse(option, true, out packageOrder)) {
+                             configuration.ListCommand.OrderBy = packageOrder;
+                         }
+                         else
+                         {
+                             this.Log().Warn("Unknown package order {0}, ignoring".format_with(option));
+                         }
+                     })
                  .Add("order-by-popularity",
                      "OrderByPopularity - Sort by package results by popularity. Available in 0.9.10+.",
-                     option => configuration.ListCommand.OrderByPopularity = option != null)    
+                     option =>
+                     {
+                         if (option != null)
+                         {
+                             configuration.ListCommand.OrderBy = PackageOrder.popularity;
+                         }
+                     })
                  .Add("approved-only",
                      "ApprovedOnly - Only return approved packages - this option will filter out results not from the community repository. Available in 0.9.10+.",
                      option => configuration.ListCommand.ApprovedOnly = option != null)   

src/chocolatey/infrastructure.app/configuration/ChocolateyConfiguration.cs

@@ -403,6 +403,7 @@ public sealed class ListCommandConfiguration
         public ListCommandConfiguration()
         {
             PageSize = 25;
+            OrderBy = PackageOrder.name;
         }
 
         // list
@@ -415,7 +416,7 @@ public ListCommandConfiguration()
         public bool ByIdOnly { get; set; }
         public bool ByTagOnly { get; set; }
         public bool IdStartsWith { get; set; }
-        public bool OrderByPopularity { get; set; }
+        public PackageOrder OrderBy { get; set; }
         public bool ApprovedOnly { get; set; }
         public bool DownloadCacheAvailable { get; set; }
         public bool NotBroken { get; set; }

src/chocolatey/infrastructure.app/domain/PackageOrder.cs

@@ -0,0 +1,46 @@
+// Copyright © 2017 - 2018 Chocolatey Software, Inc
+// Copyright © 2011 - 2017 RealDimensions Software, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace chocolatey.infrastructure.app.domain
+{
+    public enum PackageOrder
+    {
+        /// <summary>
+        /// Sort by package name, ascending
+        /// </summary>
+        name,
+
+        /// <summary>
+        /// Sort by package title, ascending
+        /// </summary>
+        title,
+
+        /// <summary>
+        /// Sort by popularity, most popular first
+        /// </summary>
+        popularity,
+
+        /// <summary>
+        /// Sort by last published dates, new to old
+        /// </summary>
+        lastpublished,
+
+        /// <summary>
+        /// Leave unsorted, i.e. show in the order in which they were retrieved.
+        /// </summary>
+        unsorted
+    }
+}

src/chocolatey/infrastructure.app/nuget/NugetList.cs

@@ -22,6 +22,7 @@ namespace chocolatey.infrastructure.app.nuget
 
     using NuGet;
     using configuration;
+    using chocolatey.infrastructure.app.domain;
 
     // ReSharper disable InconsistentNaming
 
@@ -137,9 +138,25 @@ private static IQueryable<IPackage> execute_package_search(ChocolateyConfigurati
                         .AsQueryable();
             }
 
-            results = configuration.ListCommand.OrderByPopularity ? 
-                 results.OrderByDescending(p => p.DownloadCount).ThenBy(p => p.Id)
-                 : results;
+
+            switch (configuration.ListCommand.OrderBy)
+            {
+                case PackageOrder.name:
+                    results = results.OrderBy(p => p.Id);
+                    break;
+
+                case PackageOrder.title:
+                    results = results.OrderBy(p => p.Title).ThenBy(p => p.Id);
+                    break;
+
+                case PackageOrder.popularity:
+                    results = results.OrderByDescending(p => p.DownloadCount).ThenBy(p => p.Id);
+                    break;
+
+                case PackageOrder.lastpublished:
+                    results = results.OrderByDescending(p => p.Published).ThenBy(p => p.Id);
+                    break;
+            }
 
             return results;
         }