1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
//
// Gendarme.Rules.Maintainability.AvoidDeepInheritanceTreeRule
//
// Authors:
// Sebastien Pouliot <sebastien@ximian.com>
//
// Copyright (C) 2008 Novell, Inc (http://www.novell.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 Mono.Cecil;
using Gendarme.Framework;
using Gendarme.Framework.Rocks;
namespace Gendarme.Rules.Maintainability {
// TODO: Afaict it is not possible to configure the MaximumDepth or CountExternalDepth
// properties.
/// <summary>
/// This rule will fire if a type has (by default) more than four base classes defined
/// within the assembly set being analyzed. Optionally it will also count base
/// classes defined outside the assembly set.
/// </summary>
/// <remarks>This rule is available since Gendarme 2.0</remarks>
[Problem ("This type has more than four base classes.")]
[Solution ("Refactor your class hierarchy to reduce its depth. Consider using extension methods to extend existing types.")]
[FxCopCompatibility ("Microsoft.Maintainability", "CA1501:AvoidExcessiveInheritance")]
public class AvoidDeepInheritanceTreeRule : Rule, ITypeRule {
public int MaximumDepth {
get { return maximumDepth; }
set { maximumDepth = value; }
}
private int maximumDepth = 4;
public bool CountExternalDepth {
get { return countExternalDepth; }
set { countExternalDepth = value; }
}
private bool countExternalDepth = false;
private Severity GetSeverity (int depth)
{
if (depth < 2 * MaximumDepth)
return Severity.Medium;
return (depth < 4 * MaximumDepth) ? Severity.High : Severity.Critical;
}
public RuleResult CheckType (TypeDefinition type)
{
if (type.IsInterface || type.IsValueType || type.IsDelegate ())
return RuleResult.DoesNotApply;
int depth = 0;
while (type.BaseType != null) {
type = type.BaseType.Resolve ();
if (type == null)
break;
if (countExternalDepth || Runner.Assemblies.Contains (type.Module.Assembly))
depth++;
}
if (depth <= MaximumDepth)
return RuleResult.Success;
// Confidence is total unless we count outside the current assembly,
// where it's possible we can't resolve up to System.Object
Confidence confidence = countExternalDepth ? Confidence.High : Confidence.Total;
// Severity is based on the depth
Runner.Report (type, GetSeverity (depth), confidence, String.Format ("Inheritance tree depth : {0}.", depth));
return RuleResult.Failure;
}
}
}
|
