Description
The GMetrics Plugin provides provides calculation and reporting of size and complexity metrics for Groovy source cod. It uses the GMetrics library. It is actually a port of the Grails GMetrics plugin created by Scott Ryan.
Installation
The current version of griffon-gmetrics-plugin is 0.3
To install just issue the following command
Usage
The plugin provides a script 'gmetrics' that will analyze your code and write its results to an HTML file. Run
to perform the analysis.
Customization
The plugin requires no customization to run. By default it will analyze all Groovy files in
- src/main
- griffon-app/controllers
- griffon-app/models
- griffon-app/views
- griffon-app/services
and use a default title and report name. You can restrict which folders are included or add extra ones. The following table lists settings that will be read from griffon-app/conf/Config.groovy and used if available:
Property |
Default Value |
Meaning |
|---|---|---|
gmetrics.reportName |
'GMetricsAntReport.html' |
the name of the analysis report file |
gmetrics.reportLocation |
$projectTargetDir |
the location of the analysis report file |
gmetrics.reportType |
'html' |
the report type; the only valid value is 'html' |
gmetrics.reportTitle |
none |
the report title |
gmetrics.processSrcGroovy |
true |
whether to analyze source in src/main/*.groovy |
gmetrics.processControllers |
true |
whether to analyze source in griffon-app/controllers |
gmetrics.processModels |
true |
whether to analyze source in griffon-app/models |
gmetrics.processViews |
true |
whether to analyze source in griffon-app/views |
gmetrics.processServices |
true |
whether to analyze source in griffon-app/services |
gmetrics.processTestUnit |
true |
whether to analyze source in test/unit |
gmetrics.processTestIntegration |
true |
whether to analyze source in test/integration |
gmetrics.extraIncludeDirs |
none |
extra source directories to include; for example to include Wizard files, specify to add the pattern 'griffon-app/wizards/*/.groovy' to the analysis fileset |
History
Version |
Date |
Notes |
|---|---|---|
0.3 |
10-28-10 |
Release sync with Griffon 0.9.1; Upgrade to GMetrics 0.3 |
0.2 |
07-22-10 |
Release sync with Griffon 0.9 |
0.1 |
05-30-10 |
First release |