Added version for REQUIREDSCRIPTS (#162)

* Added versioning for REQUIREDSCRIPTS
Enabled following scenarios for REQUIREDSCRIPTS
[1.0] - RequiredVersion
[1.0,2.0] - Min and Max Version
(,1.0] - Max Version
1.0 - Min Version

Author: wooseung-sim

PowerShellGet/PSGet.Resource.psd1

@@ -246,6 +246,10 @@ ConvertFrom-StringData @'
         InvalidValueBoolean=The specified value '{0}' for the parameter '{1}' is invalid. It should be $true or $false.
         UserDeclinedLicenseAcceptance=User declined license acceptance.
         AcceptLicense=License Acceptance
+        RequiredScriptVersion=REQUIREDSCRIPTS: Required version of script '{0}' is '{1}'.
+        RequiredScriptVersoinFormat=<ScriptName>, <ScriptName>:<MinimumVersion>, <ScriptName>:[<RequiredVersion>], <ScriptName>:[<MinimumVersion>,<MaximumVersion>], <ScriptName>:[,<MaximumVersion>]
+        FailedToParseRequiredScripts=Cannot parse REQUIREDSCRIPTS '{0}'. Acceptable formats are: '{1}'.
+        FailedToParseRequiredScriptsVersion=Version format error: {0}, '{1}'. Acceptable formats are: '{2}'. 
 ###PSLOC
 '@
 

PowerShellGet/PSModule.psm1

@@ -7821,29 +7821,60 @@ function ValidateAndGet-ScriptDependencies
                                         WarningAction = 'SilentlyContinue'
                                         Debug = $DebugPreference
                                     }
+            $ReqScriptInfo = @{}
+
             if ($PSBoundParameters.ContainsKey('Credential'))
             {
                 $FindScriptArguments.Add('Credential',$Credential)
             }
+            
+            if (-not ($requiredScript -match '^(?<ScriptName>[^:]+)(:(?<Version>[^:\s]+))?$'))
+            {
+                $message = $LocalizedData.FailedToParseRequiredScripts -f ($requiredScript)
+
+                ThrowError `
+                    -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "FailedToParseRequiredScripts" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+            }
 
-            if($DependentScriptInfo.ExternalScriptDependencies -contains $requiredScript)
+            $scriptName = $Matches['ScriptName']
+            if ($DependentScriptInfo.ExternalScriptDependencies -contains $scriptName)
             {
-                Write-Verbose -Message ($LocalizedData.SkippedScriptDependency -f $requiredScript)
+                Write-Verbose -Message ($LocalizedData.SkippedScriptDependency -f $scriptName)
 
                 continue
             }
 
-            $FindScriptArguments['Name'] = $requiredScript
-            $ReqScriptInfo = @{}
-            $ReqScriptInfo['Name'] = $requiredScript
+            if ($Matches.Keys -Contains 'Version')
+            {
+                $ReqScriptInfo = ValidateAndGet-NuspecVersionString -Version $Matches['Version']
+                
+                if($ReqScriptInfo.Keys -Contains 'RequiredVersion')
+                {
+                    $FindScriptArguments['RequiredVersion'] = $ReqScriptInfo['RequiredVersion']
+                }
+                elseif($ReqScriptInfo.Keys -Contains 'MinimumVersion')
+                {
+                    $FindScriptArguments['MinimumVersion'] = $ReqScriptInfo['MinimumVersion']
+                }
+                if($ReqScriptInfo.Keys -Contains 'MaximumVersion')
+                {
+                    $FindScriptArguments['MaximumVersion'] = $ReqScriptInfo['MaximumVersion']
+                }
+            }
 
+            $ReqScriptInfo['Name'] = $scriptName
+            $FindScriptArguments['Name'] = $scriptName
             $psgetItemInfo = Find-Script @FindScriptArguments  | 
-                                        Microsoft.PowerShell.Core\Where-Object {$_.Name -eq $requiredScript} | 
+                                        Microsoft.PowerShell.Core\Where-Object {$_.Name -eq $scriptName} | 
                                             Microsoft.PowerShell.Utility\Select-Object -Last 1 -ErrorAction Ignore
 
             if(-not $psgetItemInfo)
             {
-                $message = $LocalizedData.UnableToResolveScriptDependency -f ('script', $requiredScript, $DependentScriptInfo.Name, $Repository, 'ExternalScriptDependencies')
+                $message = $LocalizedData.UnableToResolveScriptDependency -f ('script', $scriptName, $DependentScriptInfo.Name, $Repository, 'ExternalScriptDependencies')
                 ThrowError -ExceptionName "System.InvalidOperationException" `
                             -ExceptionMessage $message `
                             -ErrorId "UnableToResolveScriptDependency" `
@@ -7858,6 +7889,146 @@ function ValidateAndGet-ScriptDependencies
     return $DependenciesDetails
 }
 
+function ValidateAndGet-NuspecVersionString
+{
+    param(
+        [Parameter(Mandatory=$true)]
+        [string]
+        $Version
+    )
+
+    $versionPattern = '^((?<MinRule>[\[\(])?((?<MinVersion>[^:\(\[\)\]\,]+))?((?<Comma>[\,])?(?<MaxVersion>[^:\(\[\)\]\,]+)?)?(?<MaxRule>[\]\)])?)$'
+    $VersionInfo = @{}
+
+    if ( -not ($Version -match $versionPattern))
+    {
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Invalid Version format', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if ($Matches.Keys -Contains 'MinRule' -xor $Matches.Keys -Contains 'MaxRule')
+    {
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Minimum and Maximum inclusive/exclusive condition mismatch', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if (-not ($Matches.Keys -Contains 'MinVersion' -or $Matches.Keys -Contains 'MaxVersion'))
+    {
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('No version.', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if ((-not ($Matches.Keys -Contains 'MinRule' -and $Matches.Keys -Contains 'MaxRule')) -and $Matches.Keys -Contains 'Comma')
+    {
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Invalid version format', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if ($Matches.Keys -Contains 'MaxRule' -and -not ($Matches['MaxRule'] -eq ']') )
+    {
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Maximum version condition should be inclusive', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if ($Matches.Keys -Contains 'MinVersion' -and $Matches.Keys -Contains 'MaxVersion')
+    {
+        if ($Matches.Keys -Contains 'MinRule' -and $Matches.Keys -Contains 'MaxRule')
+        {
+            if ($Matches['MinRule'] -eq '[')
+            {
+                $VersionInfo['MinimumVersion'] = $Matches['MinVersion']
+                $VersionInfo['MaximumVersion'] = $Matches['MaxVersion']
+            }
+            else
+            {
+                $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Minimum version condition should be inclusive', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+                Write-Verbose $message
+                ThrowError -ExceptionName "System.ArgumentException" `
+                            -ExceptionMessage $message `
+                            -ErrorId "UnableToResolveScriptDependency" `
+                            -CallerPSCmdlet $CallerPSCmdlet `
+                            -ErrorCategory InvalidOperation
+            }
+        }
+        else
+        {
+            $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ('Minimum and Maximum inclusive/exclusive condition mismatch', $Version, $LocalizedData.RequiredScriptVersoinFormat)
+            Write-Verbose $message
+            ThrowError -ExceptionName "System.ArgumentException" `
+                        -ExceptionMessage $message `
+                        -ErrorId "UnableToResolveScriptDependency" `
+                        -CallerPSCmdlet $CallerPSCmdlet `
+                        -ErrorCategory InvalidOperation
+        }
+
+        return $VersionInfo
+    }
+
+    if ($Matches.Keys -Contains 'MinVersion')
+    {
+        if ($Matches.Keys -Contains 'MinRule' -and $Matches.Keys -Contains 'MaxRule')
+        {
+            if (($Matches['MinRule'] -eq '[') -and ($Matches['MaxRule'] -eq ']'))
+            {
+                $VersionInfo['RequiredVersion'] = $Matches['MinVersion']
+                return $VersionInfo
+            }
+        }
+        else
+        {
+            $VersionInfo['MinimumVersion'] = $Matches['MinVersion']
+            return $VersionInfo
+        }
+
+        $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ("Minimum and Maximum version rules should be inclusive for 'RequiredVersion'", $Version, $LocalizedData.RequiredScriptVersoinFormat)
+        Write-Verbose $message
+        ThrowError -ExceptionName "System.ArgumentException" `
+                    -ExceptionMessage $message `
+                    -ErrorId "UnableToResolveScriptDependency" `
+                    -CallerPSCmdlet $CallerPSCmdlet `
+                    -ErrorCategory InvalidOperation
+    }
+
+    if ($Matches.Keys -Contains 'MaxVersion')
+    {
+        $VersionInfo['MaximumVersion'] = $Matches['MaxVersion']
+        return $VersionInfo
+    }
+
+    $message = $LocalizedData.FailedToParseRequiredScriptsVersion -f ("Failed to parse version string", $Version, $LocalizedData.RequiredScriptVersoinFormat)
+    Write-Verbose $message
+    ThrowError -ExceptionName "System.ArgumentException" `
+                -ExceptionMessage $message `
+                -ErrorId "UnableToResolveScriptDependency" `
+                -CallerPSCmdlet $CallerPSCmdlet `
+                -ErrorCategory InvalidOperation
+}
+
 function ValidateAndGet-RequiredModuleDetails
 {
     param(
@@ -8836,7 +9007,7 @@ function ValidateAndAdd-PSScriptInfoEntry
 
         $script:RequiredScripts { 
                                     $KeyName = $script:RequiredScripts
-                                    $Value = $Value -split '[,\s+]' | Microsoft.PowerShell.Core\Where-Object {$_}
+                                    $Value = $Value -split ',(?=[^\[^\(]\w(?!\w+[\)\]]))|\s' | Microsoft.PowerShell.Core\Where-Object {$_}
                                 }
 
         $script:ExternalScriptDependencies { 

Tests/Asserts.psm1

@@ -184,6 +184,14 @@ function AssertNull
     Assert ($args[0] -eq $()) $args[1]
 }
 
+# Usage: AssertNullOrEmpty <object> <message>
+#
+function AssertNullOrEmpty
+{
+    Assert ($args.Length -eq 2) "AssertNullOrEmpty takes two parameters."
+    Assert ($args[0] -eq $() -or $args[0] -eq '') $args[1]
+}
+
 # This function waits for either a specified amount of time or for a script block to evaluate to true and throws an exception if the timeout period elapses.  Example:
 #
 #   WaitFor {get-process calc} 10000 250 "Calc.exe wasn't started within 10 seconds."