Skip to content

Allow 'name' as an alias key for 'label' in ConvertTo-Html, allow the 'width' entry to be an integer #8426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityapatwardhan merged 13 commits into from
Jan 18, 2019
Merged

Allow 'name' as an alias key for 'label' in ConvertTo-Html, allow the 'width' entry to be an integer #8426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f0e5ada
Fixes #6994
mklement0 Dec 8, 2018
12c24f3
Reverted accidental change to launch.json
mklement0 Dec 8, 2018
70a830c
CodeFactor style changes
mklement0 Dec 8, 2018
a9b5a9a
Typo
mklement0 Dec 8, 2018
8e5cb3a
switched to using LabelEntryDefinion() instance
mklement0 Dec 8, 2018
144bd99
addresses Codacy/PR Quality Review issue
mklement0 Jan 17, 2019
db864f1
addresses CodeFactor issues
mklement0 Jan 17, 2019
3e1b38a
resolves merge conflict
mklement0 Jan 17, 2019
b993fad
resolves merge conflict
mklement0 Jan 17, 2019
529fb98
???
mklement0 Jan 17, 2019
d3a6975
resolves merge conflict
mklement0 Jan 17, 2019
70614e2
resolves merge conflict
mklement0 Jan 17, 2019
10c064c
resolves merge conflict
mklement0 Jan 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/convert-HTML.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,9 +326,11 @@ internal class ConvertHTMLExpressionParameterDefinition : CommandParameterDefini
protected override void SetEntries()
{
this.hashEntries.Add(new ExpressionEntryDefinition());
this.hashEntries.Add(new HashtableEntryDefinition(ConvertHTMLParameterDefinitionKeys.LabelEntryKey, new Type[] { typeof(string) }));
this.hashEntries.Add(new HashtableEntryDefinition(ConvertHTMLParameterDefinitionKeys.AlignmentEntryKey, new Type[] { typeof(string) }));
this.hashEntries.Add(new HashtableEntryDefinition(ConvertHTMLParameterDefinitionKeys.WidthEntryKey, new Type[] { typeof(string) }));
this.hashEntries.Add(new LabelEntryDefinition());
this.hashEntries.Add(new HashtableEntryDefinition(ConvertHTMLParameterDefinitionKeys.AlignmentEntryKey, new[] { typeof(string) }));

// Note: We accept "width" as either string or int.
this.hashEntries.Add(new HashtableEntryDefinition(ConvertHTMLParameterDefinitionKeys.WidthEntryKey, new[] { typeof(string), typeof(int) }));
}
}

Expand Down Expand Up @@ -362,7 +364,11 @@ private void InitializeResolvedNameMshParameters()
{
string label = p.GetEntry(ConvertHTMLParameterDefinitionKeys.LabelEntryKey) as string;
string alignment = p.GetEntry(ConvertHTMLParameterDefinitionKeys.AlignmentEntryKey) as string;
string width = p.GetEntry(ConvertHTMLParameterDefinitionKeys.WidthEntryKey) as string;

// Accept the width both as a string and as an int.
string width;
int? widthNum = p.GetEntry(ConvertHTMLParameterDefinitionKeys.WidthEntryKey) as int?;
Copy link
Collaborator

@iSazonov iSazonov Dec 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not:

Suggested change
int? widthNum = p.GetEntry(ConvertHTMLParameterDefinitionKeys.WidthEntryKey) as int?;
var widthEntryKey = p.GetEntry(ConvertHTMLParameterDefinitionKeys.WidthEntryKey);
if (widthEntryKey is int widthNum)
{
width = widthNum.Value.ToString();
}
else
{
width = widthEntryKey as string;
}

width = widthNum != null ? widthNum.Value.ToString() : p.GetEntry(ConvertHTMLParameterDefinitionKeys.WidthEntryKey) as string;
PSPropertyExpression ex = p.GetEntry(FormatParameterDefinitionKeys.ExpressionEntryKey) as PSPropertyExpression;
List<PSPropertyExpression> resolvedNames = ex.ResolveNames(_inputObject);
foreach (PSPropertyExpression resolvedName in resolvedNames)
Expand Down
22 changes: 18 additions & 4 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/ConvertTo-Html.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,15 +169,29 @@ After the object
$returnString | Should -Be '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
}

It "Test ConvertTo-HTML supports scriptblock-based calculated properties: by hashtable"{
$returnString = ($customObject | ConvertTo-HTML @{ l='NewAge'; e={ $_.Age + 1 } }) -join $newLine
It "Test ConvertTo-HTML supports scriptblock-based calculated properties: by hashtable" {
$returnString = ($customObject | ConvertTo-HTML @{ l = 'NewAge'; e = { $_.Age + 1 } }) -join $newLine
$returnString | Should -Match '\b43\b'
}

It "Test ConvertTo-HTML supports scriptblock-based calculated properties: directly"{
It "Test ConvertTo-HTML supports scriptblock-based calculated properties: directly" {
$returnString = ($customObject | ConvertTo-HTML { $_.Age + 1 }) -join $newLine
$returnString | Should -Match '\b43\b'
}

}
It "Test ConvertTo-HTML calculated property supports 'name' key as alias of 'label'" {
$returnString = ($customObject | ConvertTo-Html @{ name = 'AgeRenamed'; e = 'Age'}) -join $newLine
$returnString | Should -Match 'AgeRenamed'
}

It "Test ConvertTo-HTML calculated property supports integer 'width' entry" {
Copy link
Collaborator

@iSazonov iSazonov Dec 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only integer?

Copy link
Contributor Author

@mklement0 mklement0 Dec 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iSazonov: Good question: int is the type of the Alignment entry for Format-Table, and I simply amended that class to also be able to use it with ConvertTo-Html, with a string-typed width entry.

Since we're talking about UIs and column widths, my guess is that [int] is enough, but I'm not wedded to that, and if someone knows that a wider type is called for, I'm all ears.

$returnString = ($customObject | ConvertTo-Html @{ e = 'Age'; width = 10 }) -join $newLine
$returnString | Should -Match '\swidth\s*=\s*(["''])10\1'
}

It "Test ConvertTo-HTML calculated property supports string 'width' entry" {
$returnString = ($customObject | ConvertTo-Html @{ e = 'Age'; width = '10' }) -join $newLine
$returnString | Should -Match '\swidth\s*=\s*(["''])10\1'
}

}