Skip to content

Commit 2ccb340

Browse files
anamnavianamnavi
authored
rename PSResourceInfo PrereleaseLabel property and variables to Prerelease (#591)
1 parent 1242151 commit 2ccb340

12 files changed

+35
-35
lines changed

‎help/Get-PSResource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ PSResourceInfo : {
135135
Name
136136
PackageManagementProvider
137137
PowerShellGetFormatVersion
138-
PrereleaseLabel
138+
Prerelease
139139
ProjectUri
140140
PublishedDate
141141
ReleaseNotes

‎src/PSGet.Format.ps1xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<TableColumnItems>
2020
<TableColumnItem><PropertyName>Name</PropertyName></TableColumnItem>
2121
<TableColumnItem><PropertyName>Version</PropertyName></TableColumnItem>
22-
<TableColumnItem><PropertyName>PrereleaseLabel</PropertyName></TableColumnItem>
22+
<TableColumnItem><PropertyName>Prerelease</PropertyName></TableColumnItem>
2323
<TableColumnItem><PropertyName>Repository</PropertyName></TableColumnItem>
2424
<TableColumnItem><PropertyName>Description</PropertyName></TableColumnItem>
2525
</TableColumnItems>
@@ -53,7 +53,7 @@
5353
<TableColumnItems>
5454
<TableColumnItem><PropertyName>Name</PropertyName></TableColumnItem>
5555
<TableColumnItem><ScriptBlock>$_.ParentResource.Version</ScriptBlock></TableColumnItem>
56-
<TableColumnItem><ScriptBlock>$_.ParentResource.PrereleaseLabel</ScriptBlock></TableColumnItem>
56+
<TableColumnItem><ScriptBlock>$_.ParentResource.Prerelease</ScriptBlock></TableColumnItem>
5757
<TableColumnItem><ScriptBlock>$_.ParentResource.Name</ScriptBlock></TableColumnItem>
5858
<TableColumnItem><ScriptBlock>$_.ParentResource.Repository</ScriptBlock></TableColumnItem>
5959
</TableColumnItems>

‎src/code/InstallHelper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ private List<PSResourceInfo> InstallPackage(
347347
string createFullVersion = pkg.Version.ToString();
348348
if (pkg.IsPrerelease)
349349
{
350-
createFullVersion = pkg.Version.ToString() + "-" + pkg.PrereleaseLabel;
350+
createFullVersion = pkg.Version.ToString() + "-" + pkg.Prerelease;
351351
}
352352

353353
if (!NuGetVersion.TryParse(createFullVersion, out NuGetVersion pkgVersion))
@@ -449,11 +449,11 @@ private List<PSResourceInfo> InstallPackage(
449449

450450
// pkgIdentity.Version.Version gets the version without metadata or release labels.
451451
string newVersion = pkgIdentity.Version.ToNormalizedString();
452-
string normalizedVersionNoPrereleaseLabel = newVersion;
452+
string normalizedVersionNoPrerelease = newVersion;
453453
if (pkgIdentity.Version.IsPrerelease)
454454
{
455455
// eg: 2.0.2
456-
normalizedVersionNoPrereleaseLabel = pkgIdentity.Version.ToNormalizedString().Substring(0, pkgIdentity.Version.ToNormalizedString().IndexOf('-'));
456+
normalizedVersionNoPrerelease = pkgIdentity.Version.ToNormalizedString().Substring(0, pkgIdentity.Version.ToNormalizedString().IndexOf('-'));
457457
}
458458

459459
string tempDirNameVersion = isLocalRepo ? tempInstallPath : Path.Combine(tempInstallPath, pkgIdentity.Id.ToLower(), newVersion);

‎src/code/InstallPSResource.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class InstallPSResource : PSCmdlet
9090
/// <summary>
9191
/// Prevents installing a package that contains cmdlets that already exist on the machine.
9292
/// </summary>
93-
[Parameter]
93+
[Parameter]
9494
public SwitchParameter NoClobber { get; set; }
9595

9696
/// <summary>
@@ -166,7 +166,7 @@ protected override void ProcessRecord()
166166
break;
167167

168168
case InputObjectParameterSet:
169-
string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.PrereleaseLabel);
169+
string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.Prerelease);
170170
if (!Utils.TryParseVersionOrVersionRange(normalizedVersionString, out _versionRange))
171171
{
172172
var exMessage = String.Format("Version '{0}' for resource '{1}' cannot be parsed.", normalizedVersionString, InputObject.Name);

‎src/code/PSResourceInfo.cs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ public sealed class PSResourceInfo
247247
public string Name { get; }
248248
public string PackageManagementProvider { get; }
249249
public string PowerShellGetFormatVersion { get; }
250-
public string PrereleaseLabel { get; }
250+
public string Prerelease { get; }
251251
public Uri ProjectUri { get; }
252252
public DateTime? PublishedDate { get; }
253253
public string ReleaseNotes { get; }
@@ -280,7 +280,7 @@ private PSResourceInfo(
280280
string name,
281281
string packageManagementProvider,
282282
string powershellGetFormatVersion,
283-
string prereleaseLabel,
283+
string prerelease,
284284
Uri projectUri,
285285
DateTime? publishedDate,
286286
string releaseNotes,
@@ -306,7 +306,7 @@ private PSResourceInfo(
306306
Name = name ?? string.Empty;
307307
PackageManagementProvider = packageManagementProvider ?? string.Empty;
308308
PowerShellGetFormatVersion = powershellGetFormatVersion ?? string.Empty;
309-
PrereleaseLabel = prereleaseLabel ?? string.Empty;
309+
Prerelease = prerelease ?? string.Empty;
310310
ProjectUri = projectUri;
311311
PublishedDate = publishedDate;
312312
ReleaseNotes = releaseNotes ?? string.Empty;
@@ -394,7 +394,7 @@ public static bool TryRead(
394394
filePath));
395395

396396
var additionalMetadata = GetProperty<Dictionary<string,string>>(nameof(PSResourceInfo.AdditionalMetadata), psObjectInfo);
397-
Version version = GetVersionInfo(psObjectInfo, additionalMetadata, out string prereleaseLabel);
397+
Version version = GetVersionInfo(psObjectInfo, additionalMetadata, out string prerelease);
398398

399399
psGetInfo = new PSResourceInfo(
400400
additionalMetadata: additionalMetadata,
@@ -412,7 +412,7 @@ public static bool TryRead(
412412
name: GetStringProperty(nameof(PSResourceInfo.Name), psObjectInfo),
413413
packageManagementProvider: GetStringProperty(nameof(PSResourceInfo.PackageManagementProvider), psObjectInfo),
414414
powershellGetFormatVersion: GetStringProperty(nameof(PSResourceInfo.PowerShellGetFormatVersion), psObjectInfo),
415-
prereleaseLabel: prereleaseLabel,
415+
prerelease: prerelease,
416416
projectUri: GetProperty<Uri>(nameof(PSResourceInfo.ProjectUri), psObjectInfo),
417417
publishedDate: GetProperty<DateTime>(nameof(PSResourceInfo.PublishedDate), psObjectInfo),
418418
releaseNotes: GetStringProperty(nameof(PSResourceInfo.ReleaseNotes), psObjectInfo),
@@ -449,10 +449,10 @@ private static string GetStringProperty(
449449
private static Version GetVersionInfo(
450450
PSObject psObjectInfo,
451451
Dictionary<string, string> additionalMetadata,
452-
out string prereleaseLabel)
452+
out string prerelease)
453453
{
454454
string versionString = GetProperty<string>(nameof(PSResourceInfo.Version), psObjectInfo);
455-
prereleaseLabel = String.Empty;
455+
prerelease = String.Empty;
456456

457457
if (!String.IsNullOrEmpty(versionString) ||
458458
additionalMetadata.TryGetValue("NormalizedVersion", out versionString))
@@ -472,15 +472,15 @@ private static Version GetVersionInfo(
472472
// versionStringParsed.Length > 1 (because string contained '-' so couldn't be 0)
473473
// versionString: "1.2.0-alpha1"
474474
pkgVersion = versionStringParsed[0];
475-
prereleaseLabel = versionStringParsed[1];
475+
prerelease = versionStringParsed[1];
476476
}
477477
}
478478

479479
// at this point, version is normalized (i.e either "1.2.0" (if part of prerelease) or "1.2.0.0" otherwise)
480480
// parse the pkgVersion parsed out above into a System.Version object
481481
if (!Version.TryParse(pkgVersion, out Version parsedVersion))
482482
{
483-
prereleaseLabel = String.Empty;
483+
prerelease = String.Empty;
484484
return null;
485485
}
486486
else
@@ -491,7 +491,7 @@ private static Version GetVersionInfo(
491491

492492
// version could not be parsed as string, it was written to XML file as a System.Version object
493493
// V3 code briefly did so, I believe so we provide support for it
494-
prereleaseLabel = String.Empty;
494+
prerelease = String.Empty;
495495
return GetProperty<Version>(nameof(PSResourceInfo.Version), psObjectInfo);
496496
}
497497

@@ -536,7 +536,7 @@ public static bool TryConvert(
536536
name: ParseMetadataName(metadataToParse),
537537
packageManagementProvider: null,
538538
powershellGetFormatVersion: null,
539-
prereleaseLabel: ParsePrerelease(metadataToParse),
539+
prerelease: ParsePrerelease(metadataToParse),
540540
projectUri: ParseMetadataProjectUri(metadataToParse),
541541
publishedDate: ParseMetadataPublishedDate(metadataToParse),
542542
releaseNotes: null,
@@ -887,7 +887,7 @@ private PSObject ConvertToCustomObject()
887887
{
888888
// 1.0.0-alpha1
889889
// 1.0.0.0
890-
string NormalizedVersion = IsPrerelease ? ConcatenateVersionWithPrerelease(Version.ToString(), PrereleaseLabel) : Version.ToString();
890+
string NormalizedVersion = IsPrerelease ? ConcatenateVersionWithPrerelease(Version.ToString(), Prerelease) : Version.ToString();
891891

892892
var additionalMetadata = new PSObject();
893893

‎src/code/SavePSResource.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,11 @@ public string Path
131131
[Parameter]
132132
public SwitchParameter SkipDependencyCheck { get; set; }
133133

134-
/// <summary>
135-
/// Suppresses progress information.
136-
/// </summary>
137-
[Parameter(ParameterSetName = NameParameterSet)]
138-
[Parameter(ParameterSetName = InputObjectParameterSet)]
134+
/// <summary>
135+
/// Suppresses progress information.
136+
/// </summary>
137+
[Parameter(ParameterSetName = NameParameterSet)]
138+
[Parameter(ParameterSetName = InputObjectParameterSet)]
139139
public SwitchParameter Quiet { get; set; }
140140

141141
#endregion
@@ -183,7 +183,7 @@ protected override void ProcessRecord()
183183
break;
184184

185185
case InputObjectParameterSet:
186-
string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.PrereleaseLabel);
186+
string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.Prerelease);
187187
if (!Utils.TryParseVersionOrVersionRange(normalizedVersionString, out _versionRange))
188188
{
189189
var exMessage = String.Format("Version '{0}' for resource '{1}' cannot be parsed.", normalizedVersionString, InputObject.Name);

‎src/code/UninstallPSResource.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ protected override void ProcessRecord()
113113
break;
114114

115115
case InputObjectParameterSet:
116-
string inputObjectPrereleaseLabel = InputObject.PrereleaseLabel;
117-
string inputObjectVersion = String.IsNullOrEmpty(inputObjectPrereleaseLabel) ? InputObject.Version.ToString() : Utils.GetNormalizedVersionString(versionString: InputObject.Version.ToString(), prerelease: inputObjectPrereleaseLabel);
116+
string inputObjectPrerelease = InputObject.Prerelease;
117+
string inputObjectVersion = String.IsNullOrEmpty(inputObjectPrerelease) ? InputObject.Version.ToString() : Utils.GetNormalizedVersionString(versionString: InputObject.Version.ToString(), prerelease: inputObjectPrerelease);
118118
if (!Utils.TryParseVersionOrVersionRange(
119119
version: inputObjectVersion,
120120
versionRange: out _versionRange))

‎src/code/Utils.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,10 @@ public static bool GetVersionForInstallPath(
213213
}
214214

215215
string version = psGetInfo.Version.ToString();
216-
string prereleaseLabel = psGetInfo.PrereleaseLabel;
216+
string prerelease = psGetInfo.Prerelease;
217217

218218
if (!NuGetVersion.TryParse(
219-
value: String.IsNullOrEmpty(prereleaseLabel) ? version : GetNormalizedVersionString(version, prereleaseLabel),
219+
value: String.IsNullOrEmpty(prerelease) ? version : GetNormalizedVersionString(version, prerelease),
220220
version: out pkgNuGetVersion))
221221
{
222222
cmdletPassedIn.WriteVerbose(String.Format("Leaf directory in path '{0}' cannot be parsed into a version.", installedPkgPath));

‎test/FindPSResource.Tests.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Describe 'Test Find-PSResource for Module' {
215215

216216
$resPrerelease = Find-PSResource -Name $testModuleName -Prerelease -Repository $TestGalleryName
217217
$resPrerelease.Version | Should -Be "5.2.5.0"
218-
$resPrerelease.PrereleaseLabel | Should -Be "alpha001"
218+
$resPrerelease.Prerelease | Should -Be "alpha001"
219219
}
220220

221221
It "find resources, including Prerelease version resources, when given Prerelease parameter" {

‎test/GetInstalledPSResource.Tests.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ $testCases =
117117
$res = Get-PSResource -Name $testModuleName -Version "5.2.5-alpha001"
118118
$res.Name | Should -Be $testModuleName
119119
$res.Version | Should -Be "5.2.5"
120-
$res.PrereleaseLabel | Should -Be "alpha001"
120+
$res.Prerelease | Should -Be "alpha001"
121121
}
122122

123123
It "Get prerelease version script when version with correct prerelease label is specified" {
@@ -127,6 +127,6 @@ $testCases =
127127
$res = Get-PSResource -Name $testScriptName -Version "3.0.0-alpha001"
128128
$res.Name | Should -Be $testScriptName
129129
$res.Version | Should -Be "3.0.0"
130-
$res.PrereleaseLabel | Should -Be "alpha001"
130+
$res.Prerelease | Should -Be "alpha001"
131131
}
132132
}

0 commit comments

Comments
 (0)