Browse Source

Added introduce constant action.

newNRvisualizers
Mike Krüger 14 years ago
parent
commit
ceef571315
  1. 1
      ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj
  2. 90
      ICSharpCode.NRefactory.CSharp/Refactoring/CodeActions/IntroduceConstantAction.cs
  3. 22
      ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/InconsistentNamingIssue/NamingConventionService.cs
  4. 94
      ICSharpCode.NRefactory.Tests/CSharp/CodeActions/IntroduceConstantTests.cs
  5. 1
      ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

1
ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj

@ -358,6 +358,7 @@ @@ -358,6 +358,7 @@
<Compile Include="Refactoring\CodeActions\CreateClassDeclarationAction.cs" />
<Compile Include="Refactoring\CodeActions\CreateDelegateAction.cs" />
<Compile Include="Formatter\TextEditorOptions.cs" />
<Compile Include="Refactoring\CodeActions\IntroduceConstantAction.cs" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\ICSharpCode.NRefactory\ICSharpCode.NRefactory.csproj">

90
ICSharpCode.NRefactory.CSharp/Refactoring/CodeActions/IntroduceConstantAction.cs

@ -0,0 +1,90 @@ @@ -0,0 +1,90 @@
//
// IntroduceConstantAction.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2012 Xamarin <http://xamarin.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using System.Collections.Generic;
namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
[ContextAction("Introduce constant", Description = "Creates a constant for a non constant primitive expression.")]
public class IntroduceConstantAction : ICodeActionProvider
{
public IEnumerable<CodeAction> GetActions(RefactoringContext context)
{
var pexpr = context.GetNode<PrimitiveExpression>();
if (pexpr == null)
yield break;
var statement = context.GetNode<Statement>();
if (statement == null) {
yield break;
}
var resolveResult = context.Resolve(pexpr);
yield return new CodeAction(context.TranslateString("Create local constant"), script => {
string name = CreateMethodDeclarationAction.CreateBaseName(pexpr, resolveResult.Type);
var service = (NamingConventionService)context.GetService(typeof(NamingConventionService));
if (service != null)
name = service.CheckName(context, name, AffectedEntity.LocalConstant);
var initializer = new VariableInitializer(name, pexpr.Clone());
var decl = new VariableDeclarationStatement() {
Type = context.CreateShortType(resolveResult.Type),
Modifiers = Modifiers.Const,
Variables = { initializer }
};
script.InsertBefore(statement, decl);
var variableUsage = new IdentifierExpression(name);
script.Replace(pexpr, variableUsage);
script.Link(initializer.NameToken, variableUsage);
});
yield return new CodeAction(context.TranslateString("Create constant field"), script => {
string name = CreateMethodDeclarationAction.CreateBaseName(pexpr, resolveResult.Type);
var service = (NamingConventionService)context.GetService(typeof(NamingConventionService));
if (service != null)
name = service.CheckName(context, name, AffectedEntity.ConstantField);
var initializer = new VariableInitializer(name, pexpr.Clone());
var decl = new FieldDeclaration() {
ReturnType = context.CreateShortType(resolveResult.Type),
Modifiers = Modifiers.Const,
Variables = { initializer }
};
script.InsertWithCursor(context.TranslateString("Create constant"), decl, Script.InsertPosition.Before);
var variableUsage = new IdentifierExpression(name);
script.Replace(pexpr, variableUsage);
script.Link(initializer.NameToken, variableUsage);
});
}
}
}

22
ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/InconsistentNamingIssue/NamingConventionService.cs

@ -35,6 +35,28 @@ namespace ICSharpCode.NRefactory.CSharp.Refactoring @@ -35,6 +35,28 @@ namespace ICSharpCode.NRefactory.CSharp.Refactoring
get;
}
public string CheckName(RefactoringContext ctx, string name, AffectedEntity entity, Modifiers accessibilty = Modifiers.Private, bool isStatic = false)
{
foreach (var rule in Rules) {
if (!rule.AffectedEntity.HasFlag(entity)) {
continue;
}
if (!rule.VisibilityMask.HasFlag(accessibilty)) {
continue;
}
if (isStatic && !rule.IncludeStaticEntities || !isStatic && !rule.IncludeInstanceMembers) {
continue;
}
if (!rule.IsValid(name)) {
IList<string> suggestedNames;
var msg = rule.GetErrorMessage(ctx, name, out suggestedNames);
if (suggestedNames.Any ())
return suggestedNames [0];
}
}
return name;
}
public bool IsValidName(string name, AffectedEntity entity, Modifiers accessibilty = Modifiers.Private, bool isStatic = false)
{
foreach (var rule in Rules) {

94
ICSharpCode.NRefactory.Tests/CSharp/CodeActions/IntroduceConstantTests.cs

@ -0,0 +1,94 @@ @@ -0,0 +1,94 @@
//
// IntroduceConstantTests.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2012 Xamarin <http://xamarin.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using NUnit.Framework;
using ICSharpCode.NRefactory.CSharp.Refactoring;
namespace ICSharpCode.NRefactory.CSharp.CodeActions
{
[TestFixture]
public class IntroduceConstantTests : ContextActionTestBase
{
[Test()]
public void TestLocalConstant ()
{
Test<IntroduceConstantAction> (@"class TestClass
{
public void Hello ()
{
System.Console.WriteLine ($""Hello World"");
}
}", @"class TestClass
{
public void Hello ()
{
const string helloWorld = ""Hello World"";
System.Console.WriteLine (helloWorld);
}
}");
}
[Test()]
public void TestLocalConstantHexNumber ()
{
Test<IntroduceConstantAction> (@"class TestClass
{
public void Hello ()
{
System.Console.WriteLine ($0xAFFE);
}
}", @"class TestClass
{
public void Hello ()
{
const int i = 0xAFFE;
System.Console.WriteLine (i);
}
}");
}
[Test()]
public void TestFieldConstant ()
{
Test<IntroduceConstantAction> (@"class TestClass
{
public void Hello ()
{
System.Console.WriteLine ($""Hello World"");
}
}", @"class TestClass
{
const string HelloWorld = ""Hello World"";
public void Hello ()
{
System.Console.WriteLine (HelloWorld);
}
}", 1);
}
}
}

1
ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

@ -259,6 +259,7 @@ @@ -259,6 +259,7 @@
<Compile Include="CSharp\CodeActions\CreateClassDeclarationTests.cs" />
<Compile Include="CSharp\CodeActions\CreateConstructorDeclarationTests.cs" />
<Compile Include="CSharp\CodeActions\CreateDelegateTests.cs" />
<Compile Include="CSharp\CodeActions\IntroduceConstantTests.cs" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\Mono.Cecil\Mono.Cecil.csproj">

Loading…
Cancel
Save