Merge pull request #10 from meokullu/new_version_0008

v1.2.0

Author: meokullu

.gitignore

@@ -360,4 +360,5 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+/NuGetVersionChecker/src/CompareVersion.cs

CHANGELOG.md

@@ -16,6 +16,16 @@
 #### Security
 -->
 
+### [1.2.0] (2024-07-07)
+#### Added
+* `PackageEqualityComparer` class is added into `Package`. It has `Equal(Package x, Package y)` and `GetHashCode(Package obj)` interface methods of `IEqualityComparer<Package>`.
+* `CheckVersionAsync(List<string> pathList, bool includePrerelease)` method is added. This method uses distinction before call `GetPackagesFromNuGet(List<string> packageNameList)` to get packages to compare their versions.
+
+#### Changed
+* `GetPackageFromNuGetAsync(string packageName)` method now has optional parameter of `includePrerelease` which is set to false to indicate if prerelease is included for search.
+* `GetPackagesFromNuGetAsync(List<string> packageNameList)` method now has optional parameter of `includePrerelease` which is set to false to indicate if prerelease is included for search.
+* `CheckVersionAsync(string path)` method now has optional parameter of `includePrerelease` which is set to false to indicate if prerelease is included for search.
+
 ### [1.1.0] (2024-06-24)
 #### Added
 * Override method of ToString() for `Package`. It displays package name and version.

NuGetVersionChecker/NuGetVersionChecker.csproj

@@ -11,24 +11,22 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>version; version-checker; version-compare; NuGet; Nuget-Package; version-check; Dependency</PackageTags>
     <PackageReleaseNotes>
-      v1.1.0
-      * GetPackageFromNuGetAsync() and GetPackagesFromNuGetAsync() now uses package.Identity.Id to fill Package data instead of using requested Package name.
-      * Package now has override ToString() method.
-      * GetPackages(string path) now check if path is null or empty.
-      * VersionCheckAsync(string path) now checks if path is null or empty.
-      
+      v1.2.0
+      PackageEqualityComparer added which is derived from IEqualityComparer.
+      CheckVersionAsync() method is added to compare versions as a list of Package.
+      GetPackageFromNuGetAsync() and GetPackagesFromNuGetAsync() method have now includePrerelease option parameter which is set false default to determine if prerelease packages are included during search from NuGet API.      
       See changelog (https://github.com/meokullu/NuGetVersionChecker/blob/master/CHANGELOG.md)
     </PackageReleaseNotes>
-    <AssemblyVersion>1.1.0</AssemblyVersion>
-    <FileVersion>1.1.0</FileVersion>
+    <AssemblyVersion>1.2.0</AssemblyVersion>
+    <FileVersion>1.2.0</FileVersion>
     <Title>Nuget Version Checker</Title>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageProjectUrl>https://meokullu.github.io/NuGetVersionChecker/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/meokullu/NuGetVersionChecker</RepositoryUrl>
     <ApplicationIcon>Resources\icon256.ico</ApplicationIcon>
     <Copyright>Enes Okullu</Copyright>
     <PackageIcon>icon128.png</PackageIcon>
-    <Version>1.1.0</Version>
+    <Version>1.2.0</Version>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
   </PropertyGroup>
 
@@ -41,6 +39,10 @@
     <WarningLevel>9999</WarningLevel>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Compile Remove="src\CompareVersion.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <Content Include="Resources\icon256.ico" />
   </ItemGroup>

NuGetVersionChecker/NugetVersionChecker - Backup.csproj

@@ -26,11 +26,12 @@ public partial class NuGetVersionChecker
         /// Returns a package by making search on NuGet.
         /// </summary>
         /// <param name="packageName">Name of package.</param>
+        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
         /// <returns>Returns a package.</returns>
-        public static async Task<Package> GetPackageFromNuGetAsync(string packageName)
+        public static async Task<Package> GetPackageFromNuGetAsync(string packageName, bool includePrerelease = true)
         {
             PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
-            SearchFilter searchFilter = new SearchFilter(includePrerelease: true);
+            SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
 
             // Making a search with taking one package.
             IEnumerable<IPackageSearchMetadata> searchResults = await resource.SearchAsync(
@@ -70,11 +71,12 @@ public static async Task<Package> GetPackageFromNuGetAsync(string packageName)
         /// Returns list of packages by making search on NuGet.
         /// </summary>
         /// <param name="packageNameList">List of package names.</param>
+        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
         /// <returns>List of packages.</returns>
-        public static async Task<List<Package>> GetPackagesFromNuGetAsync(List<string> packageNameList)
+        public static async Task<List<Package>> GetPackagesFromNuGetAsync(List<string> packageNameList, bool includePrerelease = true)
         {
             PackageSearchResource resource = await s_repository.GetResourceAsync<PackageSearchResource>();
-            SearchFilter searchFilter = new SearchFilter(includePrerelease: true);
+            SearchFilter searchFilter = new SearchFilter(includePrerelease: includePrerelease);
 
             // Return value.
             List<Package> packageList = new List<Package>();

NuGetVersionChecker/src/GetPackageFromNuGet.cs

@@ -1,5 +1,6 @@
 using NuGet.Versioning;
 using System;
+using System.Collections.Generic;
 
 namespace NuGetVersionChecker
 {
@@ -68,6 +69,49 @@ public override string ToString()
             {
                 return $"{Name} {Version}";
             }
+
+            /// <summary>
+            /// Package equality comparer derived from IEqualityComparer interface.
+            /// </summary>
+            public class PackageEqualityComparer : IEqualityComparer<Package>
+            {
+                /// <summary>
+                /// Compares two Package based on their name and version.
+                /// </summary>
+                /// <param name="x">First package to compare.</param>
+                /// <param name="y">Second package to compare.</param>
+                /// <returns>Returns true if packages are same, returns false if packages are different or one of the given package is null.</returns>
+                public bool Equals(Package x, Package y)
+                {
+                    // Checking if either of package is null.
+                    if (x == null || y == null)
+                    {
+                        // Returning false to indicate at least one of packages is null.
+                        return false; 
+                    }
+                    // Checking if two given package's property values are same.
+                    else if (x.Name == y.Name && x.Version == y.Version)
+                    {
+                        return true;
+                    }
+                    else
+                    {
+                        // Returning false to indicate packages are different.
+                        return false;
+                    }
+                }
+
+                /// <summary>
+                /// Returning hashcode with creating tuple of Package's name and version.
+                /// </summary>
+                /// <param name="obj">A package.</param>
+                /// <returns>int value of hashcode.</returns>
+                public int GetHashCode(Package obj)
+                {
+                    // Returning hash code.
+                    return Tuple.Create(obj.Name, obj.Version).GetHashCode();
+                }
+            }
         }
     }    
 }

NuGetVersionChecker/src/Package.cs

@@ -1,6 +1,8 @@
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Threading.Tasks;
+using static NuGetVersionChecker.NuGetVersionChecker.Package;
 
 namespace NuGetVersionChecker
 {
@@ -10,8 +12,9 @@ public partial class NuGetVersionChecker
         /// Returns list of packages with their names, versions and availability to update.
         /// </summary>
         /// <param name="path">Path of .csproj file.</param>
+        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
         /// <returns>List of Packages.</returns>
-        public static async Task<List<Package>> CheckVersionAsync(string path)
+        public static async Task<List<Package>> CheckVersionAsync(string path, bool includePrerelease = false)
         {
             // Returning data which consisting packages.
             List<Package> packages = new List<Package>();
@@ -26,7 +29,9 @@ public static async Task<List<Package>> CheckVersionAsync(string path)
             List<Package> usedPackages = GetPackages(path);
 
             // Get used packages info from NuGet.
-            List<Package> nugetPackages = await GetPackagesFromNuGetAsync(usedPackages.Select(p => p.Name).ToList());
+            List<Package> nugetPackages = await GetPackagesFromNuGetAsync(
+                packageNameList: usedPackages.Select(p => p.Name).ToList(),
+                includePrerelease: includePrerelease);
 
             // Loop for packages
             foreach (Package package in usedPackages)
@@ -47,5 +52,61 @@ public static async Task<List<Package>> CheckVersionAsync(string path)
             // Returning list of packages.
             return packages;
         }
+
+        /// <summary>
+        /// Returns list of packages with their names, versions and availability to update.
+        /// </summary>
+        /// <param name="pathList">List of package names.</param>
+        /// <param name="includePrerelease">Include Prerelease version to compare versions.</param>
+        /// <returns>List of Packages.</returns>
+        public static async Task<List<Package>> CheckVersionAsync(List<string> pathList, bool includePrerelease = false)
+        {
+            // Returning data which consisting packages.
+            List<Package> packages = new List<Package>();
+
+            if (pathList.Any(p => p == null))
+            {
+                return packages;
+            }
+
+            // Get currently used packages.
+            List<Package> usedPackages = new List<Package>();
+
+            // Loop for pathlist to fill used packages list.
+            foreach (string path in pathList)
+            {
+                usedPackages.AddRange(GetPackages(path));
+            }
+
+            // Instance of comparer.
+            PackageEqualityComparer pec = new PackageEqualityComparer();
+
+            // Distinction of packages.
+            IEnumerable<Package> disctinctUsedPackage = usedPackages.Distinct(comparer: pec);
+
+            // Get used packages info from NuGet.
+            List<Package> nugetPackages = await GetPackagesFromNuGetAsync(
+                packageNameList: disctinctUsedPackage.Select(p => p.Name).ToList(),
+                includePrerelease: includePrerelease);
+
+            // Loop for packages
+            foreach (Package package in usedPackages)
+            {
+                // Check if newer version is available on NuGet.
+                if (disctinctUsedPackage.Where(p => p.Name == package.Name).Select(q => q.Version).FirstOrDefault() > package.Version)
+                {
+                    // Package is available to update.
+                    packages.Add(new Package(package.Name, package.Version, updateAvailable: true));
+                }
+                else
+                {
+                    // Package is up to date.
+                    packages.Add(new Package(package.Name, package.Version, updateAvailable: false));
+                }
+            }
+
+            // Returning list of packages.
+            return disctinctUsedPackage.ToList();
+        }
     }
 }

NuGetVersionChecker/src/VersionChecker.cs

@@ -13,7 +13,7 @@ Since there is no tracking mechanism that notifies users of package without manu
 
 ```
 // Path for .csporj file. Return list of `Package` that contains package names, versions and availability to update.
-CheckVersionAsync(string path);
+CheckVersionAsync(string path, bool includePrelease = false);
 ```
 
 ```
@@ -23,12 +23,12 @@ GetPackages(string path);
 
 ```
 // packageName of the NuGet package. Returns `Package` that contains package name and its version.
-GetPackageFromNuGetAsync(string packageName);
+GetPackageFromNuGetAsync(string packageName, bool includePrerelease = false);
 ```
 
 ```
 // packageNameList of the list of NuGet package names. Returns List of `Package` that contains packages name and their versions.
-GetPackagesFromNuGetAsync(List<string> packageNameList);
+GetPackagesFromNuGetAsync(List<string> packageNameList, bool includePrerelease = false);
 ```
 
 #### Console Application