# Collect common metrics about mclasses
module mclasses_metrics
-import model
import metrics_base
-import phase
-import frontend
redef class ToolContext
- var mclasses_metrics_phase = new MClassesMetricsPhase(self, null)
+ var mclasses_metrics_phase: Phase = new MClassesMetricsPhase(self, null)
end
# Extract metrics about mclasses from model.
private class MClassesMetricsPhase
super Phase
- redef fun process_mainmodule(mainmodule)
+ redef fun process_mainmodule(mainmodule, given_mmodules)
do
if not toolcontext.opt_mclasses.value and not toolcontext.opt_all.value then return
+ var csv = toolcontext.opt_csv.value
+ var out = "{toolcontext.opt_dir.value or else "metrics"}/mclasses"
+ out.mkdir
+
print toolcontext.format_h1("\n# MClasses metrics")
- var metrics = new MClassMetricSet
+ var metrics = new MetricSet
var min_vis = private_visibility
metrics.register(new CNOA(mainmodule))
metrics.register(new CNOP(mainmodule))
metrics.register(new CNOC(mainmodule))
metrics.register(new CNOD(mainmodule))
metrics.register(new CDIT(mainmodule))
+ metrics.register(new CNBP(mainmodule, min_vis))
+ metrics.register(new CNBA(mainmodule, min_vis))
metrics.register(new CNBIP(mainmodule, min_vis))
metrics.register(new CNBRP(mainmodule, min_vis))
metrics.register(new CNBHP(mainmodule, min_vis))
#TODO metrics.register(new CNBI) # nb init
- #TODO metrics.register(new CNBA) # nb attrs
#TODO metrics.register(new CNBM) # nb methods
#TODO metrics.register(new CNBV) # nb vtypes
for mgroup in mproject.mgroups do
if mgroup.mmodules.is_empty then continue
+ metrics.clear
# Scalar metrics
print toolcontext.format_h3(" `- group {mgroup.full_name}")
-
var mod_mclasses = new HashSet[MClass]
for mmodule in mgroup.mmodules do mod_mclasses.add_all(mmodule.intro_mclasses)
if mod_mclasses.is_empty then continue
mclasses.add_all(mod_mclasses)
- metrics.collect(new HashSet[MClass].from(mod_mclasses), mainmodule)
- for name, metric in metrics.metrics do
- if metric isa IntMetric then
- print toolcontext.format_h4("\t{name}: {metric.desc}")
- print toolcontext.format_p("\t avg: {metric.avg}")
- var max = metric.max
- print toolcontext.format_p("\t max: {max.first} ({max.second})")
- var min = metric.min
- print toolcontext.format_p("\t min: {min.first} ({min.second})")
- end
- end
+ metrics.collect(new HashSet[MClass].from(mod_mclasses))
+ metrics.to_console(1, not toolcontext.opt_nocolors.value)
+ if csv then metrics.to_csv.save("{out}/{mgroup}.csv")
end
end
if not mclasses.is_empty then
+ metrics.clear
# Global metrics
print toolcontext.format_h2("\n ## global metrics")
-
- metrics.collect(mclasses, mainmodule)
- for name, metric in metrics.metrics do
- if metric isa IntMetric then
- print toolcontext.format_h4("\t{name}: {metric.desc}")
- print toolcontext.format_p("\t avg: {metric.avg}")
- var max = metric.max
- print toolcontext.format_p("\t max: {max.first} ({max.second})")
- var min = metric.min
- print toolcontext.format_p("\t min: {min.first} ({min.second})")
- end
- end
- end
- end
-end
-
-# An MetricSet for MClasses metrics
-class MClassMetricSet
- super MetricSet
- redef type METRIC: MClassMetric
-
- # Collect all the metrics on the set of MClasses
- fun collect(mclasses: Set[MClass], mainmodule: MModule) do
- clear
- for metric in metrics.values do
- metric.collect(mclasses)
+ metrics.collect(mclasses)
+ metrics.to_console(1, not toolcontext.opt_nocolors.value)
+ if csv then metrics.to_csv.save("{out}/summary.csv")
end
end
end
end
end
+# Class Metric: Number of MProperties
+class CNBP
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnbp"
+ redef fun desc do return "number of accessible properties (inherited + local)"
+
+ var mainmodule: MModule
+ var min_visibility: MVisibility
+
+ init(mainmodule: MModule, min_visibility: MVisibility) do
+ self.mainmodule = mainmodule
+ self.min_visibility = min_visibility
+ end
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.all_mproperties(mainmodule, min_visibility).length
+ end
+ end
+end
+
+# Class Metric: Number of MAttributes
+class CNBA
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnba"
+ redef fun desc do return "number of accessible attributes (inherited + local)"
+
+ var mainmodule: MModule
+ var min_visibility: MVisibility
+
+ init(mainmodule: MModule, min_visibility: MVisibility) do
+ self.mainmodule = mainmodule
+ self.min_visibility = min_visibility
+ end
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.all_mattributes(mainmodule, min_visibility).length
+ end
+ end
+end
+
# Class Metric: Number of Introduced MProperties
class CNBIP
super MClassMetric
end
end
+# Class Metric: Number of Local MProperties (Intro + Redef)
+class CNBLP
+ super MClassMetric
+ super IntMetric
+ redef fun name do return "cnblp"
+ redef fun desc do return "number of local properties (intro + redef)"
+
+ var mainmodule: MModule
+ var min_visibility: MVisibility
+
+ init(mainmodule: MModule, min_visibility: MVisibility) do
+ self.mainmodule = mainmodule
+ self.min_visibility = min_visibility
+ end
+
+ redef fun collect(mclasses) do
+ for mclass in mclasses do
+ values[mclass] = mclass.local_mproperties(min_visibility).length
+ end
+ end
+end