General
Running
Using
Reports
Metrics
- ABC
- AfferentCoupling
- ClassCount
- ClassLineCount
- CoberturaBranchCoverageMetric
- CoberturaLineCoverageMetric
- CrapMetric
- CyclomaticComplexity
- EfferentCoupling
- FieldCount
- MethodLineCount
- MethodCount
Calculates the Afferent Coupling for a package. This is a count of the number of other packages that depend on the classes within this package. It is an indicator of the package's responsibility ([1]). This is a package-level metric.
Implemented by the org.gmetrics.metric.coupling.AfferentCouplingMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the package level. and (potentially) included within the report(s). Valid values are: - "value" - the value for the current package - "total" - the total value for the current package and its descendant packages - "average" - the average value for the current package and its descendant packages - "referencedFromPackages" - the list of packages that reference classes within the current package | ["value","average"] |
| ignorePackageNames | The names of packages to ignore when calculating afferent coupling. This pattern string may contain wildcard characters ('*' or '?'); it may also contain more than one pattern, separated by commas. | null |
Metric for counting the number of lines for classes. Note that this metric measures the number of lines from the first line of the class to the last line of the class. The count includes all program statements, comment lines and whitespace.
Implemented by the org.gmetrics.metric.linecount.ClassLineCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Report timestamp: Jan 31, 2015 3:48:36 PM
| Package/Class/Method | Complexity (total) | Complexity (average) | Method Lines (total) | Method Lines (average) |
|---|---|---|---|---|
| [p] All packages | 737 | 1.7 | 2786 | 6.3 |
| [p] org | 737 | 1.7 | 2786 | 6.3 |
| [p] org/gmetrics | 737 | 1.7 | 2786 | 6.3 |
| [c] org.gmetrics.GMetricsRunner | 1 | 1.0 | 19 | 19.0 |
| [m] execute | 1 | 1 | 19 | 19 |
| [p] org/gmetrics/analyzer | 0 | 0.0 | 0 | 0.0 |
| [c] org.gmetrics.analyzer.AnalysisContext | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.analyzer.SourceAnalyzer | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/ant | 38 | 1.7 | 160 | 7.0 |
| [c] org.gmetrics.ant.AntFileSetSourceAnalyzer | 28 | 1.8 | 121 | 7.6 |
| [m] analyze | 1 | 1 | 8 | 8 |
| [m] getSourceDirectories | 1 | 1 | 7 | 7 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 4 | 4 |
| [m] calculatePackageLevelMetricResults | 1 | 1 | 5 | 5 |
| [m] processFileSet | 2 | 2 | 13 | 13 |
| [m] processFile | 4 | 4 | 20 | 20 |
| [m] applyMetricsToClass | 1 | 1 | 8 | 8 |
| [m] findResultsNodeForPath | 1 | 1 | 3 | 3 |
| [m] findPackageResultsNodeForPath | 2 | 2 | 7 | 7 |
| [m] findPackageResultsNodeForPath | 1 | 1 | 4 | 4 |
| [m] resultFromFirstMatchOrElseNull | 2 | 2 | 7 | 7 |
| [m] findOrAddResultsNodeForPath | 3 | 3 | 12 | 12 |
| [m] removeBaseDirectoryPrefix | 2 | 2 | 7 | 7 |
| [m] removeLeadingSlash | 3 | 3 | 3 | 3 |
| [m] afterAllSourceCodeProcessed | 2 | 2 | 7 | 7 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.ant.GMetricsTask | 9 | 1.5 | 36 | 6.0 |
| [m] execute | 2 | 2 | 15 | 15 |
| [m] addFileset | 1 | 1 | 4 | 4 |
| [m] addConfiguredReport | 2 | 2 | 10 | 10 |
| [m] createMetricSet | 2 | 2 | 3 | 3 |
| [m] createSourceAnalyzer | 1 | 1 | 3 | 3 |
| [m] createGMetricsRunner | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.ant.Report | 1 | 1.0 | 3 | 3.0 |
| [m] addConfiguredOption | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.ant.ReportOption | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/formatter | 4 | 1.3 | 19 | 6.3 |
| [c] org.gmetrics.formatter.Formatter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.formatter.FormatterFactory | 1 | 1.0 | 6 | 6.0 |
| [m] getFormatter | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.formatter.PercentageFormatter | 2 | 2.0 | 10 | 10.0 |
| [m] format | 2 | 2 | 10 | 10 |
| [c] org.gmetrics.formatter.ToStringFormatter | 1 | 1.0 | 3 | 3.0 |
| [m] format | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric | 305 | 1.6 | 1120 | 6.1 |
| [c] org.gmetrics.metric.AbstractAstVisitor | 6 | 1.5 | 16 | 4.0 |
| [m] isFirstVisit | 2 | 2 | 7 | 7 |
| [m] sourceLine | 1 | 1 | 3 | 3 |
| [m] getSourceUnit | 1 | 1 | 3 | 3 |
| [m] isSyntheticNonRunMethod | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.metric.AbstractMethodMetric | 12 | 2.4 | 55 | 11.0 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 2 | 2 | 7 | 7 |
| [m] calculateForClass | 3 | 3 | 16 | 16 |
| [m] addClosureFieldsToMetricResults | 3 | 3 | 14 | 14 |
| [m] addMethodsToMetricResults | 2 | 2 | 11 | 11 |
| [c] org.gmetrics.metric.AbstractMetric | 8 | 1.6 | 23 | 4.6 |
| [m] applyToPackage | 2 | 2 | 6 | 6 |
| [m] calculateForPackage | 1 | 1 | 4 | 4 |
| [m] applyToClass | 2 | 2 | 6 | 6 |
| [m] isNotAnInterface | 1 | 1 | 3 | 3 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.AstVisitor | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MethodMetric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.Metric | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metric.MetricLevel | 5 | 1.0 | 18 | 3.6 |
| [m] parse | 1 | 1 | 3 | 3 |
| [m] parseCommaSeparatedList | 1 | 1 | 6 | 6 |
| [m] getNames | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.PostProcessingMetric | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/metric/abc | 67 | 1.6 | 231 | 5.5 |
| [c] org.gmetrics.metric.abc.AbcAstVisitor | 33 | 1.7 | 104 | 5.5 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitPrefixExpression | 1 | 1 | 4 | 4 |
| [m] visitPostfixExpression | 1 | 1 | 4 | 4 |
| [m] visitMethodCallExpression | 1 | 1 | 4 | 4 |
| [m] visitPropertyExpression | 1 | 1 | 5 | 5 |
| [m] visitConstructorCallExpression | 1 | 1 | 4 | 4 |
| [m] visitIfElse | 2 | 2 | 6 | 6 |
| [m] visitSwitch | 2 | 2 | 7 | 7 |
| [m] visitTryCatchFinally | 1 | 1 | 5 | 5 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitBooleanExpression | 2 | 2 | 6 | 6 |
| [m] visitNotExpression | 2 | 2 | 6 | 6 |
| [m] handleExpressionContainingOperation | 5 | 5 | 12 | 12 |
| [m] countUnaryConditionals | 4 | 4 | 13 | 13 |
| [m] countUnaryConditionals | 1 | 1 | 4 | 4 |
| [m] isSingleVariable | 1 | 1 | 3 | 3 |
| [m] isFinalVariableDeclaration | 2 | 2 | 4 | 4 |
| [m] isNotEmptyStatement | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.abc.AbcMetric | 5 | 1.7 | 19 | 6.3 |
| [m] calculate | 2 | 2 | 9 | 9 |
| [m] calculate | 1 | 1 | 6 | 6 |
| [m] createAggregateMetricResult | 2 | 2 | 4 | 4 |
| [c] org.gmetrics.metric.abc.AbcVector | 4 | 1.0 | 19 | 4.8 |
| [m] getMagnitude | 1 | 1 | 5 | 5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] squared | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 8 | 8 |
| [p] org/gmetrics/metric/abc/result | 25 | 1.6 | 89 | 5.6 |
| [c] org.gmetrics.metric.abc.result.AbcMetricResult | 4 | 1.3 | 15 | 5.0 |
| [m] getAt | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [c] org.gmetrics.metric.abc.result.AggregateAbcMetricResult | 21 | 1.6 | 74 | 5.7 |
| [m] calculateFunctions | 5 | 5 | 17 | 17 |
| [m] getCount | 1 | 1 | 3 | 3 |
| [m] getTotalAbcVector | 1 | 1 | 3 | 3 |
| [m] getAbcVector | 1 | 1 | 3 | 3 |
| [m] getAverageAbcVector | 1 | 1 | 6 | 6 |
| [m] getAt | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addChildrenToAbcVector | 1 | 1 | 8 | 8 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [m] average | 3 | 3 | 8 | 8 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/metric/classcount | 3 | 1.5 | 10 | 5.0 |
| [c] org.gmetrics.metric.classcount.ClassCountMetric | 3 | 1.5 | 10 | 5.0 |
| [m] calculateForClass | 1 | 1 | 5 | 5 |
| [m] calculateForPackage | 2 | 2 | 5 | 5 |
| [p] org/gmetrics/metric/coupling | 61 | 1.4 | 242 | 5.6 |
| [c] org.gmetrics.metric.coupling.AbstractCouplingReferenceManager | 16 | 1.8 | 47 | 5.2 |
| [m] addReferencesFromPackage | 1 | 1 | 6 | 6 |
| [m] getPackageMetricResult | 1 | 1 | 4 | 4 |
| [m] isSourcePackageOrAncestor | 3 | 3 | 8 | 8 |
| [m] sortPackagesWithReferencesWithParentFirst | 1 | 1 | 3 | 3 |
| [m] updateStatisticsForAncestorPackage | 4 | 4 | 12 | 12 |
| [m] parentPackageName | 2 | 2 | 3 | 3 |
| [m] getReferencesFromPackage | 1 | 1 | 4 | 4 |
| [m] normalizePackageName | 2 | 2 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.metric.coupling.AbstractPackageCouplingMetric | 2 | 1.0 | 13 | 6.5 |
| [m] calculateForClass | 1 | 1 | 10 | 10 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.coupling.AfferentCouplingMetric | 4 | 1.3 | 16 | 5.3 |
| [m] calculateForPackage | 2 | 2 | 9 | 9 |
| [m] afterAllSourceCodeProcessed | 1 | 1 | 4 | 4 |
| [m] getMetricResult | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.coupling.AfferentCouplingReferenceManager | 6 | 1.2 | 33 | 6.6 |
| [m] updateStatisticsForAllPackages | 1 | 1 | 6 | 6 |
| [m] createEmptyMetricResult | 1 | 1 | 4 | 4 |
| [m] applyReverseReferencesForPackage | 2 | 2 | 13 | 13 |
| [m] updateStatisticsForAllAncestorPackages | 1 | 1 | 7 | 7 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.coupling.EfferentCouplingMetric | 4 | 1.3 | 16 | 5.3 |
| [m] calculateForPackage | 2 | 2 | 9 | 9 |
| [m] getMetricResult | 1 | 1 | 3 | 3 |
| [m] afterAllSourceCodeProcessed | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.metric.coupling.EfferentCouplingReferenceManager | 6 | 1.0 | 33 | 5.5 |
| [m] updateStatisticsForAllPackages | 1 | 1 | 6 | 6 |
| [m] createEmptyMetricResult | 1 | 1 | 4 | 4 |
| [m] applyReferencesForPackage | 1 | 1 | 10 | 10 |
| [m] updateStatisticsForAllAncestorPackages | 1 | 1 | 7 | 7 |
| [m] isSourcePackage | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metric.coupling.PackageReferenceAstVisitor | 23 | 1.5 | 84 | 5.6 |
| [m] visitClass | 1 | 1 | 10 | 10 |
| [m] visitField | 1 | 1 | 4 | 4 |
| [m] visitConstructorCallExpression | 1 | 1 | 5 | 5 |
| [m] visitVariableExpression | 1 | 1 | 5 | 5 |
| [m] visitConstructorOrMethod | 1 | 1 | 8 | 8 |
| [m] visitClosureExpression | 1 | 1 | 7 | 7 |
| [m] visitCastExpression | 1 | 1 | 5 | 5 |
| [m] visitClassExpression | 1 | 1 | 5 | 5 |
| [m] visitPropertyExpression | 2 | 2 | 7 | 7 |
| [m] visitImports | 2 | 2 | 9 | 9 |
| [m] checkType | 1 | 1 | 3 | 3 |
| [m] checkTypeName | 1 | 1 | 4 | 4 |
| [m] checkPackageName | 5 | 5 | 6 | 6 |
| [m] isValidPackageReference | 3 | 3 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/metric/coverage | 82 | 1.6 | 348 | 6.8 |
| [c] org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric | 27 | 1.9 | 120 | 8.6 |
| [m] applyToMethod | 2 | 2 | 7 | 7 |
| [m] applyToClosure | 1 | 1 | 4 | 4 |
| [m] calculateForClass | 4 | 4 | 21 | 21 |
| [m] calculateForPackage | 5 | 5 | 16 | 16 |
| [m] calculate | 1 | 1 | 5 | 5 |
| [m] getCoverageRatioForClass | 1 | 1 | 10 | 10 |
| [m] calculateCoverageForClassAndInnerClasses | 1 | 1 | 4 | 4 |
| [m] getOverallPackageMetricValue | 1 | 1 | 4 | 4 |
| [m] buildMethodResults | 3 | 3 | 16 | 16 |
| [m] calculateMethodResult | 2 | 2 | 9 | 9 |
| [m] logMissingMethodCoverageInformation | 2 | 2 | 6 | 6 |
| [m] findMethodElement | 1 | 1 | 6 | 6 |
| [m] containsClasses | 1 | 1 | 3 | 3 |
| [m] getCoberturaCoverageFile | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.coverage.CoberturaBranchCoverageMetric | 4 | 1.3 | 26 | 8.7 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] findLineElementsWithBranches | 1 | 1 | 3 | 3 |
| [m] getBranchCoverageRatio | 1 | 1 | 13 | 13 |
| [c] org.gmetrics.metric.coverage.CoberturaCoverageFile | 14 | 1.3 | 69 | 6.3 |
| [m] getOverallCoverageRate | 1 | 1 | 4 | 4 |
| [m] parseCoverageRate | 1 | 1 | 5 | 5 |
| [m] findPackageElement | 1 | 1 | 4 | 4 |
| [m] findClassElement | 1 | 1 | 4 | 4 |
| [m] findInnerClasses | 1 | 1 | 4 | 4 |
| [m] hasInnerClasses | 1 | 1 | 3 | 3 |
| [m] findMethodElement | 2 | 2 | 11 | 11 |
| [m] findAllMethodElements | 2 | 2 | 7 | 7 |
| [m] getCoberturaXml | 2 | 2 | 12 | 12 |
| [m] createNonValidatingXmlSlurper | 1 | 1 | 11 | 11 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.metric.coverage.CoberturaLineCoverageMetric | 3 | 1.5 | 15 | 7.5 |
| [m] getCoverageRatioForSingleClass | 2 | 2 | 10 | 10 |
| [m] getLinesCoverageRatio | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser | 20 | 2.0 | 75 | 7.5 |
| [m] matchesCoberturaMethod | 2 | 2 | 8 | 8 |
| [m] numberOfParameters | 1 | 1 | 3 | 3 |
| [m] parseSignatureParameterTypes | 3 | 3 | 16 | 16 |
| [m] extractParameters | 1 | 1 | 5 | 5 |
| [m] parseCoberturaSignatureParameterTypes | 2 | 2 | 7 | 7 |
| [m] parseParameterTypes | 2 | 2 | 12 | 12 |
| [m] processStandaloneCharacter | 4 | 4 | 11 | 11 |
| [m] processCharacterWithinFullyQualifiedTypeName | 2 | 2 | 8 | 8 |
| [m] classNameNoPackage | 2 | 2 | 4 | 4 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.metric.coverage.CoberturaSignatureParser$ParseContext | 8 | 1.3 | 23 | 3.8 |
| [m] startFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] withinFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] appendToFullyQualifiedTypeName | 1 | 1 | 3 | 3 |
| [m] terminateFullyQualifiedTypeName | 2 | 2 | 6 | 6 |
| [m] startNewArrayType | 1 | 1 | 3 | 3 |
| [m] processPrimitiveTypeCode | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.metric.coverage.Ratio | 6 | 1.2 | 20 | 4.0 |
| [m] plus | 1 | 1 | 4 | 4 |
| [m] toBigDecimal | 2 | 2 | 4 | 4 |
| [m] asType | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [p] org/gmetrics/metric/crap | 10 | 3.3 | 36 | 12.0 |
| [c] org.gmetrics.metric.crap.CrapMetric | 10 | 3.3 | 36 | 12.0 |
| [m] calculate | 1 | 1 | 4 | 4 |
| [m] calculate | 6 | 6 | 24 | 24 |
| [m] calculateCrapScore | 3 | 3 | 8 | 8 |
| [p] org/gmetrics/metric/cyclomatic | 20 | 1.5 | 63 | 4.8 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityAstVisitor | 16 | 1.5 | 51 | 4.6 |
| [m] visitMethod | 3 | 3 | 8 | 8 |
| [m] visitIfElse | 1 | 1 | 4 | 4 |
| [m] visitWhileLoop | 1 | 1 | 4 | 4 |
| [m] visitForLoop | 1 | 1 | 4 | 4 |
| [m] visitSwitch | 1 | 1 | 4 | 4 |
| [m] visitCatchStatement | 1 | 1 | 4 | 4 |
| [m] visitBinaryExpression | 1 | 1 | 4 | 4 |
| [m] visitTernaryExpression | 1 | 1 | 4 | 4 |
| [m] visitMethodCallExpression | 2 | 2 | 5 | 5 |
| [m] visitPropertyExpression | 2 | 2 | 4 | 4 |
| [m] handleExpressionContainingOperation | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric | 4 | 2.0 | 12 | 6.0 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [p] org/gmetrics/metric/fieldcount | 8 | 2.7 | 19 | 6.3 |
| [c] org.gmetrics.metric.fieldcount.FieldCountAstVisitor | 6 | 3.0 | 10 | 5.0 |
| [m] getNumberOfFields | 1 | 1 | 3 | 3 |
| [m] visitClass | 5 | 5 | 7 | 7 |
| [c] org.gmetrics.metric.fieldcount.FieldCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metric/linecount | 12 | 2.0 | 38 | 6.3 |
| [c] org.gmetrics.metric.linecount.ClassLineCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [c] org.gmetrics.metric.linecount.ClassLineCountAstVisitor | 2 | 2.0 | 6 | 6.0 |
| [m] visitClass | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountAstVisitor | 5 | 2.5 | 12 | 6.0 |
| [m] visitMethod | 3 | 3 | 6 | 6 |
| [m] visitClosureExpression | 2 | 2 | 6 | 6 |
| [c] org.gmetrics.metric.linecount.MethodLineCountMetric | 3 | 1.5 | 11 | 5.5 |
| [m] calculate | 2 | 2 | 6 | 6 |
| [m] calculate | 1 | 1 | 5 | 5 |
| [p] org/gmetrics/metric/methodcount | 11 | 3.7 | 21 | 7.0 |
| [c] org.gmetrics.metric.methodcount.MethodCountAstVisitor | 9 | 4.5 | 12 | 6.0 |
| [m] getNumberOfMethods | 1 | 1 | 3 | 3 |
| [m] visitClass | 8 | 8 | 9 | 9 |
| [c] org.gmetrics.metric.methodcount.MethodCountMetric | 2 | 2.0 | 9 | 9.0 |
| [m] calculateForClass | 2 | 2 | 9 | 9 |
| [p] org/gmetrics/metricregistry | 3 | 1.0 | 16 | 5.3 |
| [c] org.gmetrics.metricregistry.DefaultMetricRegistry | 3 | 1.0 | 16 | 5.3 |
| [m] getMetricClass | 1 | 1 | 4 | 4 |
| [m] getAllMetricNames | 1 | 1 | 4 | 4 |
| [m] buildMetricClassMap | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.metricregistry.MetricRegistry | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricregistry.MetricRegistryHolder | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/metricset | 30 | 1.2 | 143 | 5.7 |
| [c] org.gmetrics.metricset.CompositeMetricSet | 3 | 1.0 | 11 | 3.7 |
| [m] addMetric | 1 | 1 | 4 | 4 |
| [m] addMetricSet | 1 | 1 | 4 | 4 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.DefaultMetricSet | 1 | 1.0 | 3 | 3.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.GroovyDslMetricSet | 2 | 1.0 | 21 | 10.5 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 18 | 18 |
| [c] org.gmetrics.metricset.ListMetricSet | 2 | 1.0 | 10 | 5.0 |
| [m] getMetrics | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 7 | 7 |
| [c] org.gmetrics.metricset.MetricSet | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.metricset.MetricSetBuilder | 2 | 1.0 | 7 | 3.5 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.TopLevelDelegate | 16 | 1.3 | 70 | 5.8 |
| [m] metricset | 1 | 1 | 4 | 4 |
| [m] metricset | 1 | 1 | 10 | 10 |
| [m] metric | 1 | 1 | 5 | 5 |
| [m] metric | 1 | 1 | 6 | 6 |
| [m] metric | 1 | 1 | 10 | 10 |
| [m] propertyMissing | 2 | 2 | 5 | 5 |
| [m] methodMissing | 3 | 3 | 10 | 10 |
| [m] description | 1 | 1 | 4 | 4 |
| [m] getMetricSet | 1 | 1 | 3 | 3 |
| [m] assertClassImplementsMetricInterface | 1 | 1 | 4 | 4 |
| [m] addMetric | 2 | 2 | 6 | 6 |
| [m] isNotWithinAnotherMetricDefinition | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.metricset.MetricSetDelegate | 4 | 1.3 | 21 | 7.0 |
| [m] methodMissing | 2 | 2 | 15 | 15 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/report | 138 | 1.7 | 658 | 7.9 |
| [c] org.gmetrics.report.AbstractMetricCriteriaFilter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.AbstractReportWriter | 20 | 1.7 | 76 | 6.3 |
| [m] writeReport | 2 | 2 | 14 | 14 |
| [m] writeReportToStandardOut | 1 | 1 | 4 | 4 |
| [m] writeReportToFile | 2 | 2 | 8 | 8 |
| [m] initializeDefaultResourceBundle | 2 | 2 | 12 | 12 |
| [m] getResourceBundleString | 2 | 2 | 9 | 9 |
| [m] getResourceBundleStringOrNull | 2 | 2 | 9 | 9 |
| [m] initializeFormatters | 2 | 2 | 7 | 7 |
| [m] formatMetricResultValue | 2 | 2 | 4 | 4 |
| [m] getFormattedTimestamp | 1 | 1 | 4 | 4 |
| [m] isWriteToStandardOut | 2 | 2 | 3 | 3 |
| [m] initializeResourceBundle | 1 | 1 | 1 | 1 |
| [m] getTimestamp | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.report.BasicHtmlReportWriter | 32 | 1.9 | 177 | 10.4 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildMetricResultColumns | 2 | 2 | 11 | 11 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 1 | 1 | 11 | 11 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 2 | 2 | 17 | 17 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] setReportLevels | 1 | 1 | 3 | 3 |
| [m] includesReportLevel | 2 | 2 | 3 | 3 |
| [m] buildResultsTableRowRecursively | 10 | 10 | 33 | 33 |
| [m] buildResultsRowsForChildren | 2 | 2 | 9 | 9 |
| [m] prefixForResultsNodeLevel | 1 | 1 | 8 | 8 |
| [m] buildMetricDescriptions | 2 | 2 | 24 | 24 |
| [m] getDescriptionForMetricName | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [m] buildTitle | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.FunctionsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setFunctions | 1 | 1 | 3 | 3 |
| [m] includesFunction | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.LevelsCriteriaFilter | 2 | 1.0 | 6 | 3.0 |
| [m] setLevels | 1 | 1 | 3 | 3 |
| [m] includesLevel | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricCriteriaFilterHelper | 6 | 1.5 | 23 | 5.8 |
| [m] includesName | 3 | 3 | 7 | 7 |
| [m] parseCriteria | 1 | 1 | 7 | 7 |
| [m] parseCriteriaForSingleMetric | 1 | 1 | 6 | 6 |
| [m] parseCommaSeparatedList | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.MetricsCriteriaFilter | 3 | 1.5 | 6 | 3.0 |
| [m] setMetrics | 1 | 1 | 3 | 3 |
| [m] includesMetric | 2 | 2 | 3 | 3 |
| [c] org.gmetrics.report.ReportWriter | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.report.SeriesValue | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.report.SingleSeriesCriteriaFilter | 33 | 1.9 | 131 | 7.7 |
| [m] buildSeriesData | 1 | 1 | 20 | 20 |
| [m] findMatchingValuesForChildren | 1 | 1 | 6 | 6 |
| [m] getResultsNodeFullName | 3 | 3 | 14 | 14 |
| [m] findMatchingValues | 4 | 4 | 15 | 15 |
| [m] sortValuesIfApplicable | 3 | 3 | 9 | 9 |
| [m] limitToGreaterThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToLessThanIfApplicable | 2 | 2 | 7 | 7 |
| [m] limitToMaxResultsIfApplicable | 3 | 3 | 9 | 9 |
| [m] assertMetricExists | 1 | 1 | 4 | 4 |
| [m] assertLevelExists | 1 | 1 | 3 | 3 |
| [m] assertFunctionExists | 1 | 1 | 4 | 4 |
| [m] assertValidSortValue | 2 | 2 | 3 | 3 |
| [m] assertValidMaxResultsValue | 3 | 3 | 11 | 11 |
| [m] assertValidGreaterThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidLessThanValue | 1 | 1 | 3 | 3 |
| [m] assertValidNumberValue | 3 | 3 | 10 | 10 |
| [m] findMetric | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.report.SingleSeriesHtmlReportWriter | 11 | 1.1 | 96 | 9.6 |
| [m] writeReport | 1 | 1 | 18 | 18 |
| [m] buildHeaderSection | 1 | 1 | 8 | 8 |
| [m] buildCSS | 1 | 1 | 8 | 8 |
| [m] buildBodySection | 2 | 2 | 13 | 13 |
| [m] buildReportTimestamp | 1 | 1 | 6 | 6 |
| [m] buildResultsTable | 1 | 1 | 13 | 13 |
| [m] getSeriesValueNameHeading | 1 | 1 | 9 | 9 |
| [m] buildSeriesValueRow | 1 | 1 | 9 | 9 |
| [m] getMetricResultColumnHeading | 1 | 1 | 4 | 4 |
| [m] buildVersionFooter | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.report.XmlReportWriter | 27 | 1.8 | 130 | 8.7 |
| [m] writeReport | 1 | 1 | 17 | 17 |
| [m] buildReportElement | 1 | 1 | 5 | 5 |
| [m] buildProjectElement | 1 | 1 | 9 | 9 |
| [m] buildPackageElements | 1 | 1 | 3 | 3 |
| [m] buildElement | 4 | 4 | 7 | 7 |
| [m] buildPackageElement | 5 | 5 | 20 | 20 |
| [m] buildClassElement | 1 | 1 | 11 | 11 |
| [m] buildMethodElement | 1 | 1 | 10 | 10 |
| [m] buildMetricElements | 1 | 1 | 7 | 7 |
| [m] buildMetricElement | 6 | 6 | 14 | 14 |
| [m] isRoot | 1 | 1 | 3 | 3 |
| [m] buildMetricsElement | 1 | 1 | 14 | 14 |
| [m] getDescriptionForMetric | 1 | 1 | 4 | 4 |
| [m] isPackage | 1 | 1 | 3 | 3 |
| [m] cdata | 1 | 1 | 3 | 3 |
| [p] org/gmetrics/result | 49 | 1.5 | 160 | 4.8 |
| [c] org.gmetrics.result.ClassMetricResult | 2 | 1.0 | 7 | 3.5 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.result.FunctionNames | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MapMetricResult | 3 | 1.0 | 17 | 5.7 |
| [m] getAt | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [c] org.gmetrics.result.MethodKey | 6 | 1.2 | 23 | 4.6 |
| [m] equals | 2 | 2 | 4 | 4 |
| [m] hashCode | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [c] org.gmetrics.result.MetricResult | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.result.MetricResultBuilder | 28 | 2.2 | 61 | 4.7 |
| [m] createAggregateMetricResult | 1 | 1 | 13 | 13 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] calculateFunctions | 1 | 1 | 10 | 10 |
| [m] calculateCount | 1 | 1 | 3 | 3 |
| [m] total | 3 | 3 | 3 | 3 |
| [m] calculateTotal | 2 | 2 | 5 | 5 |
| [m] minimum | 3 | 3 | 3 | 3 |
| [m] calculateMinimum | 2 | 2 | 4 | 4 |
| [m] maximum | 3 | 3 | 3 | 3 |
| [m] calculateMaximum | 2 | 2 | 4 | 4 |
| [m] average | 3 | 3 | 3 | 3 |
| [m] shouldCalculateFunction | 3 | 3 | 3 | 3 |
| [m] isFunctionSpecifiedOrImplied | 3 | 3 | 4 | 4 |
| [c] org.gmetrics.result.MutableMapMetricResult | 4 | 1.0 | 19 | 4.8 |
| [m] getAt | 1 | 1 | 4 | 4 |
| [m] putAt | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 8 | 8 |
| [c] org.gmetrics.result.NumberMetricResult | 3 | 1.0 | 16 | 5.3 |
| [m] getAt | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 10 | 10 |
| [c] org.gmetrics.result.SingleNumberMetricResult | 3 | 1.0 | 17 | 5.7 |
| [m] getAt | 1 | 1 | 4 | 4 |
| [m] toString | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 9 | 9 |
| [p] org/gmetrics/resultsnode | 27 | 1.2 | 102 | 4.6 |
| [c] org.gmetrics.resultsnode.ClassResultsNode | 9 | 1.3 | 34 | 4.9 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addClassMetricResult | 2 | 2 | 10 | 10 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] addMethodMetricResult | 2 | 2 | 6 | 6 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.resultsnode.MethodResultsNode | 7 | 1.0 | 24 | 3.4 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addMetricResult | 1 | 1 | 4 | 4 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.resultsnode.PackageResultsNode | 11 | 1.4 | 44 | 5.5 |
| [m] getChildren | 1 | 1 | 3 | 3 |
| [m] containsClassResults | 1 | 1 | 3 | 3 |
| [m] getMetricResult | 1 | 1 | 4 | 4 |
| [m] addChildIfNotEmpty | 2 | 2 | 7 | 7 |
| [m] addChild | 1 | 1 | 5 | 5 |
| [m] applyMetric | 3 | 3 | 14 | 14 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.resultsnode.ResultsNode | N/A | N/A | N/A | N/A |
| [p] org/gmetrics/source | 37 | 2.1 | 111 | 6.2 |
| [c] org.gmetrics.source.AbstractSourceCode | 16 | 2.7 | 51 | 8.5 |
| [m] getLines | 2 | 2 | 6 | 6 |
| [m] line | 3 | 3 | 5 | 5 |
| [m] getAst | 3 | 3 | 16 | 16 |
| [m] getLineNumberForCharacterIndex | 5 | 5 | 16 | 16 |
| [m] isValid | 1 | 1 | 3 | 3 |
| [m] normalizePath | 2 | 2 | 5 | 5 |
| [c] org.gmetrics.source.SourceCode | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.source.SourceCodeCriteria | 8 | 8.0 | 17 | 17.0 |
| [m] matches | 8 | 8 | 17 | 17 |
| [c] org.gmetrics.source.SourceFile | 7 | 1.2 | 25 | 4.2 |
| [m] getName | 1 | 1 | 3 | 3 |
| [m] getPath | 1 | 1 | 3 | 3 |
| [m] getText | 2 | 2 | 6 | 6 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 5 | 5 |
| [m] <init> | 1 | 1 | 5 | 5 |
| [c] org.gmetrics.source.SourceString | 6 | 1.2 | 18 | 3.6 |
| [m] getText | 1 | 1 | 3 | 3 |
| [m] setPath | 2 | 2 | 3 | 3 |
| [m] toString | 1 | 1 | 3 | 3 |
| [m] createSourceUnit | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 6 | 6 |
| [p] org/gmetrics/util | 105 | 2.4 | 278 | 6.5 |
| [c] org.gmetrics.util.AstUtil | 40 | 2.7 | 94 | 6.3 |
| [m] isEmptyMethod | 1 | 1 | 3 | 3 |
| [m] isClosureField | 2 | 2 | 3 | 3 |
| [m] isBlock | 1 | 1 | 3 | 3 |
| [m] isEmptyBlock | 4 | 4 | 5 | 5 |
| [m] getMethodArguments | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 3 | 3 | 10 | 10 |
| [m] isMethodCall | 2 | 2 | 4 | 4 |
| [m] isMethodCall | 3 | 3 | 9 | 9 |
| [m] isMethodNamed | 1 | 1 | 4 | 4 |
| [m] getAnnotation | 2 | 2 | 6 | 6 |
| [m] getVariableExpressions | 9 | 9 | 16 | 16 |
| [m] isFinalVariable | 4 | 4 | 14 | 14 |
| [m] isFromGeneratedSourceCode | 3 | 3 | 3 | 3 |
| [m] respondsTo | 1 | 1 | 3 | 3 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.Calculator | 4 | 2.0 | 8 | 4.0 |
| [m] calculateAverage | 3 | 3 | 7 | 7 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.ClassNameUtil | 14 | 2.3 | 26 | 4.3 |
| [m] parentPackageName | 3 | 3 | 7 | 7 |
| [m] isPackageName | 2 | 2 | 4 | 4 |
| [m] isClassName | 2 | 2 | 4 | 4 |
| [m] getNameOnly | 4 | 4 | 7 | 7 |
| [m] isCapitalized | 2 | 2 | 3 | 3 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.GMetricsVersion | 1 | 1.0 | 3 | 3.0 |
| [m] getVersion | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.ImportUtil | 4 | 4.0 | 11 | 11.0 |
| [m] packageNameForImport | 4 | 4 | 11 | 11 |
| [c] org.gmetrics.util.PathUtil | 13 | 2.6 | 33 | 6.6 |
| [m] getName | 3 | 3 | 7 | 7 |
| [m] getParent | 3 | 3 | 9 | 9 |
| [m] normalize | 2 | 2 | 3 | 3 |
| [m] toPackageName | 4 | 4 | 13 | 13 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.PropertyUtil | 6 | 3.0 | 23 | 11.5 |
| [m] setPropertyFromString | 5 | 5 | 22 | 22 |
| [m] <init> | 1 | 1 | 1 | 1 |
| [c] org.gmetrics.util.WildcardPattern | 13 | 3.3 | 46 | 11.5 |
| [m] matches | 4 | 4 | 7 | 7 |
| [m] containsWildcards | 1 | 1 | 3 | 3 |
| [m] convertStringWithWildcardsToRegex | 5 | 5 | 24 | 24 |
| [m] <init> | 3 | 3 | 12 | 12 |
| [p] org/gmetrics/util/io | 10 | 1.4 | 34 | 4.9 |
| [c] org.gmetrics.util.io.ClassPathResource | 4 | 1.3 | 14 | 4.7 |
| [m] getInputStream | 1 | 1 | 3 | 3 |
| [m] getInputStream | 2 | 2 | 7 | 7 |
| [m] <init> | 1 | 1 | 4 | 4 |
| [c] org.gmetrics.util.io.DefaultResourceFactory | 4 | 2.0 | 12 | 6.0 |
| [m] getResource | 3 | 3 | 9 | 9 |
| [m] isUrl | 1 | 1 | 3 | 3 |
| [c] org.gmetrics.util.io.Resource | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.ResourceFactory | N/A | N/A | N/A | N/A |
| [c] org.gmetrics.util.io.UrlResource | 2 | 1.0 | 8 | 4.0 |
| [m] getInputStream | 1 | 1 | 4 | 4 |
| [m] <init> | 1 | 1 | 4 | 4 |
| # | Metric Name | Description |
|---|---|---|
| 1 | CyclomaticComplexity | Measures the (McCabe) Cyclomatic Complexity of source code. See the Wikipedia entry for Cyclomatic Complexity. |
| 2 | MethodLineCount | Counts the number of lines in each method. |
Measures the C.R.A.P. (Change Risk Anti-Patterns) score. It is designed to analyze and predict the amount of effort, pain, and time required to maintain an existing body of code.
A method with a CRAP score over 30 is considered CRAPpy (i.e., unacceptable, offensive, etc.). [2]
Implemented by the org.gmetrics.metric.crap.CrapMetric class.
Given a Groovy method m, C.R.A.P. for m is calculated as follows:
C.R.A.P.(m) = comp(m)^2 * (1 – cov(m)/100)^3 + comp(m)
Where comp(m) is the cyclomatic complexity of method m, and cov(m) is the test code coverage provided by automated tests.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coverageMetric | The GMetrics Metric instance to provide code coverage data. GMetrics includes a Cobertura-based coverage metric. See CoberturaLineCoverageMetric This property is REQUIRED. | N/A |
| complexityMetric | The GMetrics Metric instance to provide cyclomatic complexity data. GMetrics includes a CyclomaticComplexityMetric, which is used as the default provider. | An instance of CyclomaticComplexityMetric |
Here is a sample MetricSet definition that includes a CrapMetric.
final COBERTURA_FILE = 'coverage/GMetrics/coverage.xml'
metricset {
def coberturaMetric = CoberturaLineCoverage {
coberturaFile = COBERTURA_FILE
functions = ['total']
}
CRAP {
functions = ['total']
coverageMetric = coberturaMetric
}
}
Note setting the coverageMetric field is required.
The CRAP metric is a special composite metric -- it uses other metrics to calculate complexity and code coverage. In the example above, the CoberturaLineCoverage metric is also included within the MetricSet being defined. Alternatively, if you define the CoberturaLineCoverage metric within the CRAP metric definition, then the CoberturaLineCoverage metric is not included within the MetricSet, as in the example below.
final COBERTURA_FILE = 'coverage/GMetrics/coverage.xml'
metricset {
CRAP {
// CoberturaLineCoverage is not included in the MetricSet
coverageMetric = CoberturaLineCoverage {
coberturaFile = COBERTURA_FILE
}
}
}
There is one annoying known limitation with that behavior. If you use the Map syntax, rather than the Closure syntax, to define the outer metric, then inner metric is also included within the MetricSet, as in the example below.
metricset {
// Both CRAP and CoberturaLineCoverage metrics are included in the MetricSet
CRAP(coverageMetric:CoberturaLineCoverage(coberturaFile:'coverage/GMetrics/coverage.xml'))
}
Metric for counting the number of classes in each package. This metric counts the number of classes, interfaces and enums within a package.
Implemented by the org.gmetrics.metric.classcount.ClassCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Calculates the ABC Metric for a class or method. ABC is a metric of size/complexity that counts the number of Assignments (A), Branches (B) and Conditions (C) and assigns a single numerical score calculated as:
|ABC| = sqrt((A*A)+(B*B)+(C*C))
Implemented by the org.gmetrics.metric.abc.AbcMetric class.
The ABC Metric calculation rules for Groovy:
A frequently-referenced blog post by Jake Scruggs ([4]) offers the following guidelines for interpreting an ABC score. Note that these values refer to the score (magnitude) calculated for a single method:
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
If no MetricSet is configured for the GMetrics Ant Task then it uses the set of Metrics defined by the org.gmetrics.metricset.DefaultMetricSet class. That includes the following Metrics:
Metric for counting the number of fields within each class. Note that static final fields (i.e., constants) are included as well.
Implemented by the org.gmetrics.metric.fieldcount.FieldCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
Metric that measures the code coverage of branches (conditionals) based on a Cobertura coverage XML file.
Implemented by the org.gmetrics.metric.coverage.CoberturaBranchCoverageMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coberturaFile | The path to the Cobertura XML file. By default, the path is relative to the classpath. But the path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". This property is REQUIRED. | N/A |
This metric does not calculate coverage for Closure Fields (fields initialized to a Closure Expression), unlike some other method-level metrics.
| Method | Method Lines (total) |
|---|---|
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTableRowRecursively | 33 |
| org.gmetrics.metric.crap.CrapMetric#calculate | 24 |
| org.gmetrics.report.BasicHtmlReportWriter#buildMetricDescriptions | 24 |
| org.gmetrics.util.WildcardPattern#convertStringWithWildcardsToRegex | 24 |
| org.gmetrics.util.PropertyUtil#setPropertyFromString | 22 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForClass | 21 |
| org.gmetrics.ant.AntFileSetSourceAnalyzer#processFile | 20 |
| org.gmetrics.report.SingleSeriesCriteriaFilter#buildSeriesData | 20 |
| org.gmetrics.report.XmlReportWriter#buildPackageElement | 20 |
| org.gmetrics.GMetricsRunner#execute | 19 |
| org.gmetrics.metricset.GroovyDslMetricSet#<init> | 18 |
| org.gmetrics.report.SingleSeriesHtmlReportWriter#writeReport | 18 |
| org.gmetrics.metric.abc.result.AggregateAbcMetricResult#calculateFunctions | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#writeReport | 17 |
| org.gmetrics.report.BasicHtmlReportWriter#buildResultsTable | 17 |
| org.gmetrics.report.XmlReportWriter#writeReport | 17 |
| org.gmetrics.source.SourceCodeCriteria#matches | 17 |
| org.gmetrics.metric.AbstractMethodMetric#calculateForClass | 16 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#calculateForPackage | 16 |
| org.gmetrics.metric.coverage.AbstractCoberturaCoverageMetric#buildMethodResults | 16 |
The org.gmetrics.report.SingleSeriesHtmlReportWriter class produces an HTML report of metric results based on a single metric, single level and single function to provide a single series of data.
The metric, level and function properties are required (must be non-null and non-empty). These three properties uniquely identify a single series of metric values.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.SingleSeriesHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| metric | The name (case-sensitive) of a single Metric included in the analysis results (e.g. "CyclomaticComplexity"). | Yes |
| level | The single level at which results are included in the report. Valid level values are "package", "class" and "method". | Yes |
| function | The function for which results are included in the report. Valid function values are metric-specific, but are typically "total", "average", "minimum" or "maximum". | Yes |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
| sort | Controls whether the report results are sorted numerically. A value of null or empty means no sorting is performed; otherwise, the value must be either "ascending" or "descending". | No |
| maxResults | Specifies the limit on the number of results included in the report. A value of null, zero or empty means no limit is applied; otherwise the value must be a positive integer. | No |
| greaterThan | Specifies a lower-bound threshold -- only results with a larger value are included within the report. A value of null or empty means no lower-bound threshold is applied. | No |
| lessThan | Specifies an upper-bound threshold -- only results with a smaller value are included within the report. A value of null or empty means no upper-bound threshold is applied. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.SingleSeriesHtmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.SingleSeriesHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
<option name="metric" value="CyclomaticComplexity" />
<option name="level" value="class" />
<option name="function" value="average" />
<option name="maxResults" value="50" />
<option name="greaterThan" value="100.0" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
The org.gmetrics.report.XmlReportWriter class produces an XML report of GMetrics results.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.BasicHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| functions | The (comma-separated) list of functions for which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all functions provided by a metric are included within the report. Any metrics not explicitly configured include all applicable functions as well. ---- Valid function values are metric-specific, but typically include "total", "average", "minimum" and "maximum". ---- For example, a value of "MethodLineCount=minimum,average" for functions includes only the minimum and average function results for the MethodLineCount metric. Likewise, a value of "ABC=average; CyclomaticComplexity=total,maximum" includes the average function results for the ABC metric and the total and maximum function results for the CyclomaticComplexity metric. Note that all functions provided by any other metrics (not configured) are included. | No |
| levels | The (comma-separated) list of levels at which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all levels are included for all metrics within the report. Any metrics not explicitly configured include all applicable levels as well. ---- Valid level values are "package", "class" and "method". ---- For example, a value of "MethodLineCount=class,method" for levels includes only the class and method level results for the MethodLineCount metric. Likewise, a value of "ABC=method; CyclomaticComplexity=package,class" includes the method level results for the ABC metric and the package and class level results for the CyclomaticComplexity metric. Note that all levels are included for any other metrics not explicitly configured. | No |
| metrics | The (comma-separated) list of names of the metrics included in the report. By default, all metrics within the results are included in the report. ---- For example, a metrics value of "ABC, MethodLineCount" includes only the ABC and MethodLineCount metrics within the report. | No |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.XmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.XmlReportWriter">
<option name="outputFile" value="SampleGMetricsXmlReport.html" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
And here is an example illustrating explicit configuration of the metrics, levels and functions to be included within the report:
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.XmlReportWriter">
<option name="outputFile" value="SampleGMetricsXmlReport.html" />
<option name="metrics" value="CyclomaticComplexity, ABC" />
<option name="levels" value="CyclomaticComplexity=class,method; ABC=method" />
<option name="functions" value="ABC=average; CyclomaticComplexity=total,maximum" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
See a Sample Report from the org.gmetrics.report.BasicHtmlReportWriter ReportWriter.
See a Sample Report from the org.gmetrics.report.SingleSeriesHtmlReportWriter ReportWriter.
See a See a Sample Report from the org.gmetrics.report.XmlReportWriter ReportWriter.
MrHaki has written a detailed blog post describing How to Create a GMetrics Report with XSLT
Metric that measures the code coverage of source lines based on a Cobertura coverage XML file.
Implemented by the org.gmetrics.metric.coverage.CoberturaLineCoverageMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| coberturaFile | The path to the Cobertura XML file. By default, the path is relative to the classpath. But the path may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute path on the filesystem), or "http:". This property is REQUIRED. | N/A |
This metric does not calculate coverage for Closure Fields (fields initialized to a Closure Expression), unlike some other method-level metrics.
The org.gmetrics.report.BasicHtmlReportWriter class produces an HTML report of metric results in a single HTML table, with one row for each package, class or method (or closure field) and one column for each metric value (function) being calculated.
See a Sample Report.
The option element is a child of the report element and defines a report-specific option for a report.
org.gmetrics.report.BasicHtmlReportWriter supports the following options:
| Attribute | Description | Required |
| functions | The (comma-separated) list of functions for which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all functions provided by a metric are included within the report. Any metrics not explicitly configured include all applicable functions as well. ---- Valid function values are metric-specific, but typically include "total", "average", "minimum" and "maximum". ---- For example, a value of "MethodLineCount=minimum,average" for functions includes only the minimum and average function results for the MethodLineCount metric. Likewise, a value of "ABC=average; CyclomaticComplexity=total,maximum" includes the average function results for the ABC metric and the total and maximum function results for the CyclomaticComplexity metric. Note that all functions provided by any other metrics (not configured) are included. | No |
| levels | The (comma-separated) list of levels at which results are included in the report for a particular metric. Multiple metrics are configured by separating them with semicolons (;). By default, all levels are included for all metrics within the report. Any metrics not explicitly configured include all applicable levels as well. ---- Valid level values are "package", "class" and "method". ---- For example, a value of "MethodLineCount=class,method" for levels includes only the class and method level results for the MethodLineCount metric. Likewise, a value of "ABC=method; CyclomaticComplexity=package,class" includes the method level results for the ABC metric and the package and class level results for the CyclomaticComplexity metric. Note that all levels are included for any other metrics not explicitly configured. | No |
| reportLevels | The (comma-separated) list of levels included in the report for all metrics. By default, all levels are included in the report. ---- Valid level values are "package", "class" and "method". ---- For example, a value of "package,method" for reportLevels includes only rows for the package and method. | No |
| metrics | The (comma-separated) list of names of the metrics included in the report. By default, all metrics within the results are included in the report. ---- For example, a metrics value of "ABC, MethodLineCount" includes only the ABC and MethodLineCount metrics within the report. | No |
| outputFile | The path and filename for the output report file. | No |
| title | The title for the output report. | No |
| writeToStandardOut | Set to "true" or true to write out the report to stdout (System.out) instead of writing to a file. | No |
Here is an example Ant XML build file illustrating configuration of org.gmetrics.report.BasicHtmlReportWriter.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
And here is an example illustrating explicit configuration of the metrics, levels and functions to be included within the report:
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
<option name="metrics" value="CyclomaticComplexity, ABC" />
<option name="levels" value="CyclomaticComplexity=class,method; ABC=method" />
<option name="functions" value="ABC=average; CyclomaticComplexity=total,maximum" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
Calculates the Cyclomatic Complexity Metric for a class or method. Cyclomatic Complexity is a metric of complexity that counts the number of independent paths through the source code, and assigns a single numerical score for each method. The Cyclomatic Complexity score can also serve as an upper bound for the number of test cases that are necessary to achieve a complete branch coverage for a particular method ([1]).
Implemented by the org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric class.
The Cyclomatic Complexity Metric calculates a value for each method. Furthermore, if a class field is initialized to a Closure (ClosureExpression), then that Closure is analyzed just like a method.
The value of 10 is often considered as the threshold between acceptable (low risk) code and too complex (higher risk). See [1] and [2], for instance. As McCabe ([1]) says, "The particular upper bound that has been used for cyclomatic complexity is 10 which seems like a reasonable, but not magical, upper limit."
Other sources cite 15 as a useful threshold, and/or draw further delineations between low/medium/high/unacceptable complexity values. NDepend ([4]), for instance, recommends that methods with a score of "15 are hard to understand and maintain. Methods where CC is higher than 30 are extremely complex and should be split." On the other hand, [5] categorizes cyclomatic complexity scores into the following levels:
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
The GMetrics project provides calculation and reporting of size and complexity metrics for Groovy source code. GMetrics scans Groovy source code, applying a set of metrics, and generates an HTML or XML report of the results.
You can run GMetrics using the supplied Ant Task.
Total and average values for the following metrics are provided:
See the site navigation menu for a list of the metrics and reports provided out of the box by GMetrics.
Take a look at a Sample GMetrics Report.
The GMetrics project requires:
For projects built using Maven, GMetrics is now available from the Maven Central Repository.
Calculates the Efferent Coupling for a package. This is a count of the number of other packages that the classes in a package depend upon, and is an indicator of the package's independence ([1]). This is a package-level metric.
Implemented by the org.gmetrics.metric.coupling.EfferentCouplingMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the package level. and (potentially) included within the report(s). Valid values are: - "value" - the value for the current package - "total" - the total value for the current package and its descendant packages - "average" - the average value for the current package and its descendant packages - "referencedPackages" - the list of referenced packages | ["value","average"] |
| ignorePackageNames | The names of packages to ignore when calculating efferent coupling. This pattern string may contain wildcard characters ('*' or '?'); it may also contain more than one pattern, separated by commas. | null |
Metric for counting the number of lines for methods and closure fields. Note that this metric measures the number of lines from the first line of the method to the last line of the metric. The count includes all program statements, comment lines and whitespace.
Implemented by the org.gmetrics.metric.linecount.MethodLineCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
| includeClosureFields | This boolean property controls whether metric values are calculated for Closure Fields and treated as methods. A Closure Field is a field that is initialized to a Closure Expression, e.g., def myField = { println 12 }. | true |
| Attribute | Description | Required |
| metricSetFile | The paths to a Groovy MetricSet DSL file. By default, the path specified is relative to the classpath, but it may be optionally prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute filesystem path), or "http:". If not specified, it uses the set of Metrics defined by the Default MetricSet. | NO |
The <report> nested element defines the type and options for a report. It includes a type attribute and contains optional nested <option> elements.
NOTE: Currently, org.gmetrics.report.BasicHtmlReportWriter is the only report provided with GMetrics.
| Attribute | Description | Required |
| type | The fully-qualified class name for the report class. This class must implement the org.gmetrics.report.ReportWriter interface. | Yes |
The <option> element is a child of the <report> element and defines a report-specific option for a report. See the Example below.
At least one fileset nested element is required, and is used to specify the source files that GMetrics should analyze. This is the standard Ant FileSet, and is quite powerful and flexible. See the Apache Ant Manual for more information on FileSets.
Here is an example Ant XML build file.
<taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics metricSetFile="config/metricset.groovy">
<report type="org.gmetrics.report.BasicHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
Things to note:
Metric for counting the number methods and closure fields within each class. Note that this metric counts methods and constructors.
Implemented by the org.gmetrics.metric.methodcount.MethodCountMetric class.
The following properties can be configured for this metric within a MetricSet. See Creating a MetricSet for information on the syntax of setting a metric property.
| Property | Description | Default Value |
| enabled | This boolean property controls whether the metric is enabled. If set to false, then the metric is not included as part of the results or the output reports. | true |
| functions | This List<String> property contains the names of the functions to be calculated at the method, class and package levels and (potentially) included within the report(s). Valid values are: - "total" - "average" - "minimum" - "maximum" | ["total","average"] |
GMetrics provides a Groovy DSL (domain-specific language) for defining MetricSets.
The preferred syntax for defining a MetricSet is to specify the list of Metrics using the Metric names. Here is simple example:
metricset {
description 'A simple MetricSet'
ClassCount // specify metric name only (note no "Metric" suffix on metric name)
FieldCount { // configure the Metric using a Closure
functions = ['total']
}
MethodCount([functions:['total']) // configure the Metric using a Map of properties
}
Things to note:
Here is an example of a more comprehensive Groovy MetricSet file, illustrating specifying Metrics by Metric class or Metric name, and also nested MetricSet files:
import org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric
metricset {
description 'An example MetricSet'
metricset("MyMetricSet.groovy")
metric(org.gmetrics.metric.abc.AbcMetric) {
functions = ['average', 'maximum']
}
metric(CyclomaticComplexityMetric) // specify metric class (see import)
ClassCount // specify metric name only (note no "Metric" suffix on metric name)
FieldCount { // specify metric name only
functions = ['total']
}
metricset("somepath/MyOtherMetricSet.groovy") {
ClassLineCount {
enabled = false
}
MethodLineCount name:'CustomMethodLineCount'
}
}
Things to note:
About the "inner" metricset statements:
About the metric statements:
InputStream getInputStream(String path) convenience method.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
* @version $Revision: 24 $ - $Date: 2009-12-10 21:17:05 -0500 (Thu, 10 Dec 2009) $
*/
class ClassPathResource implements Resource {
final String path
/**
* Convenience method to open an InputStream on the specified resource path relative the classpath
* @path - the path to the resource (file). The path is relative to the classpath,
* by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such
* as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The
* path must not be empty or null.
* @throws IOException - if an error occurs opening the InputStream
*/
static InputStream getInputStream(String path) throws IOException {
return new ClassPathResource(path).getInputStream()
}
/**
* Construct a new ClassPathResource
* @path - the path to the resource (file). The path is relative to the classpath,
* by default, but may be optionally prefixed by any of the valid java.net.URL prefixes, such
* as "file:" (to load from a relative or absolute path on the filesystem), or "http:". The
* path must not be empty or null.
*/
ClassPathResource(String path) {
assert path
this.path = path
}
/**
* Open an InputStream on the classpath resource path
* @throws IOException - if an error occurs opening the InputStream
*/
InputStream getInputStream() throws IOException {
def inputStream = getClass().classLoader.getResourceAsStream(path)
if (!inputStream) {
throw new FileNotFoundException("File [$path] does not exist or is not accessible")
}
return inputStream
}
} GMetrics-0.7/src/main/groovy/org/gmetrics/util/io/DefaultResourceFactory.groovy 0000644 0001750 0001750 00000003300 12107724363 027351 0 ustar ebourg ebourg /*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.util.io
/**
* Default implementation of ResourceFactory.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
* @version $Revision: 24 $ - $Date: 2009-12-10 21:17:05 -0500 (Thu, 10 Dec 2009) $
*/
class DefaultResourceFactory implements ResourceFactory {
/**
* Return a Resource instance suitable for the specified path.
* @param path - the path to the resource. Must not be null or empty. This may be
* optionally prefixed by "classpath:" or any of the valid java.net.URL prefixes
* (e.g., "file:", "http:")
* @throws IOException - if an error occurs opening the InputStream
*/
Resource getResource(String path) throws IOException {
assert path
if (path.startsWith('classpath:')) {
return new ClassPathResource(path - 'classpath:')
}
return isUrl(path) ?
new UrlResource(path) : new ClassPathResource(path)
}
private isUrl(String path) {
return path =~ /.*\:.*/
}
} GMetrics-0.7/src/main/groovy/org/gmetrics/util/io/ResourceFactory.groovy 0000644 0001750 0001750 00000002377 12107724363 026061 0 ustar ebourg ebourg /*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.util.io
/**
* Defines the interface for factory objects that create/return Resource instances.
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
* @version $Revision: 24 $ - $Date: 2009-12-10 21:17:05 -0500 (Thu, 10 Dec 2009) $
*/
interface ResourceFactory {
/**
* Return a Resource instance suitable for the specified path.
* @param path - the path to the resource. This may be optionally prefixed by
* @throws IOException - if an error occurs opening the InputStream
*/
Resource getResource(String path) throws IOException
} GMetrics-0.7/src/main/groovy/org/gmetrics/util/WildcardPattern.groovy 0000644 0001750 0001750 00000012163 12107724363 025414 0 ustar ebourg ebourg /*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.util
/**
* Represents a string pattern that may optionally include wildcards ('*', '**' or '?'), and
* provides an API to determine whether that pattern matches a specified input string.
*
* The wildcard character '*' within the pattern matches a sequence of zero or more characters within a
* single file or directory name in the input string. It does not match a sequence of two or more
* dir/file names. For instance, 'a*b' matches 'a12345b' and 'ab', but does NOT match 'a/b' or 'a123/b'.
*
* The '**' wildcard matches any sequence of zero or more characters in the input string, including
* directory names and separators . It matches any part of the directory tree. For instance, 'a**b'
* matches 'a12345b', 'ab', 'a/b' and 'a1/a2/a3b'.
*
* The wildcard character '?' within the pattern matches exactly one character in the input string,
* excluding the normalized file separator character ('/').
*
* This is an internal class and its API is subject to change.
*
* @author Chris Mair
* @version $Revision: 98 $ - $Date: 2010-03-09 21:45:10 -0500 (Tue, 09 Mar 2010) $
*/
class WildcardPattern {
private List regexes = []
private List strings = []
private defaultMatches
/**
* Construct a new WildcardPattern instance on a single pattern or a comma-separated list of patterns.
* @param patternString - the pattern string, optionally including wildcard characters ('*' or '?');
* may optionally contain more than one pattern, separated by commas; may be null or empty to always match
* @param defaultMatches - a boolean indicating whether matches() should
* return true if the pattern string is either empty or null. This parameter is
* optional and defaults to true.
*/
WildcardPattern(String patternString, boolean defaultMatches=true) {
this.defaultMatches = defaultMatches
def patterns = patternString ? patternString.tokenize(',') : []
patterns.each { pattern ->
if (containsWildcards(pattern)) {
regexes << convertStringWithWildcardsToRegex(pattern)
}
else {
strings << pattern
}
}
}
/**
* Return true if the specified String matches the pattern or if the original
* patternString (specified in the constructor) was null or empty and the
* value for defaultMatches (also specified in the constructor) was true.
* @param string - the String to check
* @return true if the String matches the pattern
*/
boolean matches(String string) {
if (regexes.empty && strings.empty) {
return defaultMatches
}
return regexes.find { regex -> string ==~ regex } ||
strings.contains(string)
}
/**
* Return true if the specified String contains one or more wildcard characters ('?' or '*')
* @param string - the String to check
* @return true if the String contains wildcards
*/
private static boolean containsWildcards(String string) {
return string =~ /\*|\?/
}
/**
* Convert the specified String, optionally containing wildcards (? or *), to a regular expression String
*
* @param stringWithWildcards - the String to convert, optionally containing wildcards (? or *)
* @return an equivalent regex String
*
* @throws AssertionError - if the stringWithWildcards is null
*/
private static String convertStringWithWildcardsToRegex(String stringWithWildcards) {
assert stringWithWildcards != null
def result = new StringBuffer()
def prevCharWasStar = false
stringWithWildcards.each {ch ->
switch (ch) {
case '*':
// Single '*' matches single dir/file; Double '*' matches sequence of zero or more dirs/files
result << (prevCharWasStar ? /.*/ : /[^\/]*/)
prevCharWasStar = !prevCharWasStar
break;
case '?':
// Any character except the normalized file separator ('/')
result << /[^\/]/
break;
case ['$', '|', '[', ']', '(', ')', '.', ':', '{', '}', '\\', '^', '+']:
result << '\\' + ch
break;
default: result << ch
}
}
return result
}
} GMetrics-0.7/src/main/groovy/org/gmetrics/util/Calculator.groovy 0000644 0001750 0001750 00000002230 12107724363 024410 0 ustar ebourg ebourg /*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.util
/**
* Contains static utility methods related to mathematical calculations
*
* @author Chris Mair
*/
class Calculator {
static BigDecimal calculateAverage(BigDecimal sum, int count, int scale) {
if(sum && count) {
def result = sum / count
return result.setScale(scale, BigDecimal.ROUND_HALF_UP)
}
return 0.0.setScale(scale, BigDecimal.ROUND_HALF_UP)
}
// Private constructor. All methods are static.
private Calculator() { }
}
GMetrics-0.7/src/main/groovy/org/gmetrics/result/ 0000755 0001750 0001750 00000000000 12623566446 021425 5 ustar ebourg ebourg GMetrics-0.7/src/main/groovy/org/gmetrics/result/MutableMapMetricResult.groovy 0000644 0001750 0001750 00000003476 12463030155 027261 0 ustar ebourg ebourg /*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.result
import org.gmetrics.metric.Metric
import org.gmetrics.metric.MetricLevel
/**
* A MetricResult for arbitrary values, backed by a mutable Map.
*
* @author Chris Mair
*/
class MutableMapMetricResult implements MetricResult {
final Metric metric
final MetricLevel metricLevel
final Integer lineNumber = null
final map
int count = 0
/**
* Construct a new instance
* @param metric - the Metric to which this result applies
* @param metricLevel - the metric level for this result
* @param map - the Map of metric result values
*/
MutableMapMetricResult(Metric metric, MetricLevel metricLevel, MapwriteReport(Writer, ResultsNode, AnalysisContext) method
* and define a defaultOutputFile property.
*
* @author Chris Mair
*/
abstract class AbstractReportWriter implements ReportWriter {
protected static final BASE_MESSAGES_BUNDLE = "gmetrics-base-messages"
protected static final CUSTOM_MESSAGES_BUNDLE = "gmetrics-messages"
protected static final GMETRICS_URL = "http://www.gmetrics.org"
String outputFile
Object writeToStandardOut
@SuppressWarnings(['LoggerWithWrongModifiers', 'FieldName'])
protected final LOG = Logger.getLogger(getClass())
protected customMessagesBundleName = CUSTOM_MESSAGES_BUNDLE
protected resourceBundle
protected Mapmetric, level and function properties are required (must
* be non-null and non-empty). These three properties uniquely identify a single series of metric values.
*
* The metric property must specify the name (case-sensitive) of a single Metric (for example
* "CyclomaticComplexity") included in the analysis results.
*
* The level property must be set to one of: "package", "class" or "method".
*
* The function property must be set to the name of a function supported by the
* metric, typically one of: "total", "average", "minimum" or "maximum".
*
* The sort property is optional, and if not null or empty, must either have
* the value of "ascending" or "descending", and causes the results to be sorted numerically in either ascending
* or descending order.
*
* The maxResults property is optional. A value of null, empty or 0
* means no limit. Otherwise, the value must be positive, and limits the number of results returned.
*
* The greaterThan property is optional. The value specifies a threshold -- only results
* with a larger value are returned. A value of null or empty means no threshold.
*
* The lessThan property is optional. The value specifies a threshold -- only results
* with a smaller value are returned. A value of null or empty means no threshold.
*
* @author Chris Mair
*/
@Mixin(SingleSeriesCriteriaFilter)
class SingleSeriesHtmlReportWriter extends AbstractReportWriter {
public static final DEFAULT_OUTPUT_FILE = 'GMetricsSingleSeriesReport.html'
protected static final DEFAULT_CSS_FILE = 'gmetrics-single-series-html-report.css'
protected static final DEFAULT_TITLE = "GMetrics Report"
static defaultOutputFile = DEFAULT_OUTPUT_FILE
String title = DEFAULT_TITLE
String subtitle
@Override
protected void writeReport(Writer writer, ResultsNode resultsNode, AnalysisContext analysisContext) {
assert resultsNode
assert writer
def seriesData = buildSeriesData(resultsNode, analysisContext.metricSet)
def builder = new StreamingMarkupBuilder()
def html = builder.bind {
html {
out << buildHeaderSection()
out << buildBodySection(seriesData)
}
}
writer << html
LOG.info("Report created")
}
private buildHeaderSection() {
return {
head {
title(title)
out << buildCSS()
}
}
}
private buildCSS() {
return {
def cssInputStream = ClassPathResource.getInputStream(DEFAULT_CSS_FILE)
assert cssInputStream, "CSS File [$DEFAULT_CSS_FILE] not found"
def css = cssInputStream.text
unescaped << css
}
}
private buildBodySection(Listmetric, level and function properties are required (must
* be non-null and non-empty). These three properties uniquely identify a single series of metric values.
*
* The metric property must specify the name (case-sensitive) of a single Metric (for example
* "CyclomaticComplexity") included in the analysis results.
*
* The level property must be set to one of: "package", "class" or "method".
*
* The function property must be set to the name of a function supported by the
* metric, typically one of: "total", "average", "minimum" or "maximum".
*
* The sort property is optional, and if not null or empty, must either have
* the value of "ascending" or "descending", and causes the results to be sorted numerically in either ascending
* or descending order.
*
* The maxResults property is optional. A value of null, empty or 0
* means no limit. Otherwise, the value must be positive, and limits the number of results returned.
*
* The greaterThan property is optional. The value specifies a threshold -- only results
* with a larger value are returned. A value of null or empty means no threshold.
*
* The lessThan property is optional. The value specifies a threshold -- only results
* with a smaller value are returned. A value of null or empty means no threshold.
*
* @author Chris Mair
*/
class SingleSeriesCriteriaFilter {
private static final VALID_SORT_VALUES = ['ascending', 'descending']
String metric
String level
String function
String sort
String maxResults
String greaterThan
String lessThan
Listmetricset
* method, passing in a Closure defining the contents of the MetricSet.
* The Closure can contain any combination of the following (as well as
* arbitrary Groovy code):
* metricset - to load a MetricSet file. The path specifies a Groovy file.metric - to load a single Metric; specify the Metric classdescription - description of the MetricSet (optional)MetricSet implementation that parses a Groovy DSL of Metric definitions.
* The filename passed into the constructor is interpreted relative to the classpath.
* Note that this class attempts to read the file and parse the Groovy from within the constructor.
*
* @author Chris Mair
* @version $Revision: 298 $ - $Date: 2015-01-30 16:56:55 -0500 (Fri, 30 Jan 2015) $
*/
class GroovyDslMetricSet implements MetricSet {
private static final LOG = Logger.getLogger(GroovyDslMetricSet)
private ResourceFactory resourceFactory = new DefaultResourceFactory()
private metrics
/**
* Construct a new instance on the specified Groovy DSL MetricSet file path
* @param path - the path to the Groovy DSL MetricSet definition file, relative to the classpath; must not be empty or null
*/
GroovyDslMetricSet(String path) {
assert path
LOG.info("Loading metrics from [$path]")
def inputStream = resourceFactory.getResource(path).inputStream
def metricSetBuilder = new MetricSetBuilder()
def callMetricSet = { closure ->
closure.resolveStrategy = Closure.DELEGATE_ONLY // fail if access non-existent properties
metricSetBuilder.metricset(closure)
}
Binding binding = new Binding(metricset:callMetricSet)
GroovyShell shell = new GroovyShell(binding);
shell.evaluate(inputStream.text);
metrics = metricSetBuilder.metricSet.metrics
}
/**
* @return a List of Metric objects
*/
List getMetrics() {
return metrics
}
}
GMetrics-0.7/src/main/groovy/org/gmetrics/metricset/ListMetricSet.groovy 0000644 0001750 0001750 00000003025 12107724353 026076 0 ustar ebourg ebourg /*
* Copyright 2008 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.metricset
import org.gmetrics.metric.Metric
/**
* A MetricSet implementation that returns a static List of Metrics passed into its constructor.
*
* @author Chris Mair
* @version $Revision: 107 $ - $Date: 2010-06-05 07:23:27 -0400 (Sat, 05 Jun 2010) $
*/
class ListMetricSet implements MetricSet {
private metrics
/**
* Construct a new instance from the specified List of metrics.
* @param metrics - the List of List of Metric objects; must not be null, but may be empty.
*/
ListMetricSet(List metrics) {
assert metrics != null
assert metrics.every { it instanceof Metric }
def copy = []
copy.addAll(metrics)
this.metrics = Collections.unmodifiableList(copy)
}
/**
* @return a List of Metric objects
*/
List getMetrics() {
metrics
}
} GMetrics-0.7/src/main/groovy/org/gmetrics/metricset/CompositeMetricSet.groovy 0000644 0001750 0001750 00000003221 12107724353 027123 0 ustar ebourg ebourg /*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.metricset
import org.gmetrics.metric.Metric
/**
* A MetricSet implementation that aggregates a set of MetricSets and Metrics.
*
* @author Chris Mair
* @version $Revision: 85 $ - $Date: 2010-02-26 21:51:52 -0500 (Fri, 26 Feb 2010) $
*/
class CompositeMetricSet implements MetricSet {
private metrics = []
/**
* Add a single Metric to this MetricSet
* @param metric - the Metric to add
*/
void addMetric(Metric metric) {
assert metric != null
metrics << metric
}
/**
* Add all of the Metrics within the specified MetricSet to this MetricSet
* @param metricSet - the MetricSet whose Metrics are to be included
*/
void addMetricSet(MetricSet metricSet) {
assert metricSet != null
metrics.addAll(metricSet.getMetrics())
}
/**
* @return a List of Metric objects. The returned List is immutable.
*/
List getMetrics() {
return metrics.asImmutable()
}
}
GMetrics-0.7/src/main/groovy/org/gmetrics/metricset/DefaultMetricSet.groovy 0000644 0001750 0001750 00000002461 12107724353 026552 0 ustar ebourg ebourg /*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.metricset
import org.gmetrics.metric.linecount.MethodLineCountMetric
import org.gmetrics.metric.linecount.ClassLineCountMetric
import org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric
/**
* A MetricSet implementation that returns the default static List of Metrics.
*
* @author Chris Mair
* @version $Revision: 79 $ - $Date: 2010-02-20 21:51:05 -0500 (Sat, 20 Feb 2010) $
*/
class DefaultMetricSet implements MetricSet {
private metricSet = new ListMetricSet([new CyclomaticComplexityMetric(), new ClassLineCountMetric(), new MethodLineCountMetric()])
List getMetrics() {
return metricSet.getMetrics()
}
} GMetrics-0.7/src/main/groovy/org/gmetrics/metricset/MetricSet.groovy 0000644 0001750 0001750 00000001573 12107724353 025250 0 ustar ebourg ebourg /*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics.metricset
/**
* Represents a set of (configured) Metric objects
*
* @author Chris Mair
* @version $Revision: 24 $ - $Date: 2009-12-10 21:17:05 -0500 (Thu, 10 Dec 2009) $
*/
interface MetricSet {
List getMetrics()
} GMetrics-0.7/src/main/groovy/org/gmetrics/GMetricsRunner.groovy 0000644 0001750 0001750 00000004605 12107724361 024257 0 ustar ebourg ebourg /*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gmetrics
import org.gmetrics.resultsnode.ResultsNode
import org.gmetrics.analyzer.SourceAnalyzer
import org.apache.log4j.Logger
import org.gmetrics.metricset.MetricSet
import org.gmetrics.analyzer.AnalysisContext
/**
* Helper class to run GMetrics.
*
* The following properties must be configured before invoking the execute() method:
* sourceAnalyzer - An instance of a org.gmetrics.analyzer.SourceAnalyzer implementation.reportWriters - The list of ReportWriter instances. A report is generated
* for each element in this list. This list can be empty, but cannot be null.* 1. Each method starts with a complexity count of one. * 2. Add one to the complexity count for each occurrence of: * if while for case catch && || ?: (ternary-operator) ?: (elvis-operator) ?. (null-check) ** * Additional notes: *
calculateForClass(ClassNode, SourceCode) method.
*
* @author Chris Mair
*/
abstract class AbstractMetric implements Metric {
boolean enabled = true
List* 1. Add one to the assignment count for each occurrence of an assignment operator, excluding * constant declarations: = *= /= %= += <<= >>= &= |= ^= >>>= * 2. Add one to the assignment count for each occurrence of an increment or decrement operator * (prefix or postfix): ++ -- * 3. Add one to the branch count for each function call or class method call. * 4. Add one to the branch count for each occurrence of the new operator. * 5. Add one to the condition count for each use of a conditional operator: * == != <= >= < > <=> =~ ==~ * 6. Add one to the condition count for each use of the following keywords: * else case default try catch ? * 7. Add one to the condition count for each unary conditional expression. These are cases where * a single variable/field/value is treated as a boolean value. Examples include* * Additional notes: *if (x)* andreturn !ready. *
metricSetFile property specifies the path to a Groovy MetricSet
* definition file. By default, the path specified is relative to the classpath, but it may be optionally
* prefixed by any of the valid java.net.URL prefixes, such as "file:" (to load from a relative or absolute
* path on the filesystem), or "http:". The metricSetFile property is optional. If not
* specified, it uses the set of Metrics defined by DefaultMetricSet.
*
* At least one nested fileset element is required, and is used to specify the source files
* to be analyzed. This is the standard Ant FileSet, and is quite powerful and flexible.
* See the Apache Ant Manual for more information on FileSets.
*
* The report nested element defines the type and report-specific options for the
* output report. The type attribute (which
* specifies the fully-qualified class name of the ReportWriter class) and
* can contain nested option elements. Each option, in turn, must
* include a name and value attribue. Currently, the
* BasicHtmlReportWriter class (org.gmetrics.report.BasicHtmlReportWriter) is the
* only report type provided.
*
* @see "http://ant.apache.org/manual/index.html"
*
* @author Chris Mair
* @version $Revision: 95 $ - $Date: 2010-03-08 22:00:10 -0500 (Mon, 08 Mar 2010) $
*/
class GMetricsTask extends Task {
private static final LOG = Logger.getLogger(GMetricsTask)
String metricSetFile
protected List reportWriters = []
protected List fileSets = []
// Abstract creation of the GMetricsNarcRunner instance to allow substitution of test spy for unit tests
protected createGMetricsRunner = { return new GMetricsRunner() }
/**
* Execute this Ant Task
*/
void execute() throws BuildException {
assert fileSets
try {
def sourceAnalyzer = createSourceAnalyzer()
def gMetricsRunner = createGMetricsRunner()
gMetricsRunner.metricSet = createMetricSet()
gMetricsRunner.reportWriters = reportWriters
gMetricsRunner.sourceAnalyzer = sourceAnalyzer
gMetricsRunner.execute()
}
catch(Throwable t) {
LOG.error("GMetricsTask error", t)
throw t
}
}
/**
* Ant-defined method (by convention), called with each instance of a nested