Skip to content

Fixes to AvoidNullOrEmptyHelpMessageAttribute. #454

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
merged 1 commit into from
Feb 24, 2016
Merged

Fixes to AvoidNullOrEmptyHelpMessageAttribute. #454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 40 additions & 15 deletions Rules/AvoidNullOrEmptyHelpMessageAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,51 +38,52 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)

foreach (FunctionDefinitionAst funcAst in functionAsts)
{
if (funcAst.Body == null || funcAst.Body.ParamBlock == null
|| funcAst.Body.ParamBlock.Attributes == null || funcAst.Body.ParamBlock.Parameters == null)
if (funcAst.Body == null || funcAst.Body.ParamBlock == null || funcAst.Body.ParamBlock.Parameters == null)
{
continue;
}

foreach (var paramAst in funcAst.Body.ParamBlock.Parameters)
{
foreach (var paramAstAttribute in paramAst.Attributes)
foreach (ParameterAst paramAst in funcAst.Body.ParamBlock.Parameters)
{
if (paramAst == null)
{
if (!(paramAstAttribute is AttributeAst))
continue;
}

foreach (AttributeBaseAst attributeAst in paramAst.Attributes)
{
var paramAttributeAst = attributeAst as AttributeAst;
if (paramAttributeAst == null)
{
continue;
}

var namedArguments = (paramAstAttribute as AttributeAst).NamedArguments;

var namedArguments = paramAttributeAst.NamedArguments;
if (namedArguments == null)
{
continue;
}

foreach (NamedAttributeArgumentAst namedArgument in namedArguments)
{
if (!(namedArgument.ArgumentName.Equals("HelpMessage", StringComparison.OrdinalIgnoreCase)))
if (namedArgument == null || !(namedArgument.ArgumentName.Equals("HelpMessage", StringComparison.OrdinalIgnoreCase)))
{
continue;
}

string errCondition;
if (namedArgument.ExpressionOmitted
|| namedArgument.Argument.Extent.Text.Equals("\"\"")
|| namedArgument.Argument.Extent.Text.Equals("\'\'"))
if (namedArgument.ExpressionOmitted || HasEmptyStringInExpression(namedArgument.Argument))
{
errCondition = "empty";
}
else if (namedArgument.Argument.Extent.Text.Equals("$null", StringComparison.OrdinalIgnoreCase))
else if (HasNullInExpression(namedArgument.Argument))
{
errCondition = "null";
}
else
{
errCondition = null;
}

if (!String.IsNullOrEmpty(errCondition))
{
string message = string.Format(CultureInfo.CurrentCulture,
Expand All @@ -102,6 +103,30 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
}
}

/// <summary>
/// Checks if the given ast is an empty string.
/// </summary>
/// <param name="ast"></param>
/// <returns></returns>
private bool HasEmptyStringInExpression(ExpressionAst ast)
{
var constStrAst = ast as StringConstantExpressionAst;
return constStrAst != null && constStrAst.Value.Equals(String.Empty);
}

/// <summary>
/// Checks if the ast contains null expression.
/// </summary>
/// <param name="ast"></param>
/// <returns></returns>
private bool HasNullInExpression(Ast ast)
{
var varExprAst = ast as VariableExpressionAst;
return varExprAst != null
&& varExprAst.VariablePath.IsUnqualified
&& varExprAst.VariablePath.UserPath.Equals("null", StringComparison.OrdinalIgnoreCase);
}

/// <summary>
/// GetName: Retrieves the name of this rule.
/// </summary>
Expand Down