X-Git-Url: http://nitlanguage.org diff --git a/src/metrics/inheritance_metrics.nit b/src/metrics/inheritance_metrics.nit index 8c799ac..29a15ce 100644 --- a/src/metrics/inheritance_metrics.nit +++ b/src/metrics/inheritance_metrics.nit @@ -17,52 +17,57 @@ # Collect metrics about inheritance usage module inheritance_metrics -import model +import metrics_base import mmodules_metrics import mclasses_metrics -import phase -import frontend redef class ToolContext - var inheritance_metrics_phase = new InheritanceMetricsPhase(self, null) + + # Inheritance related metrics phase + var inheritance_metrics_phase: Phase = new InheritanceMetricsPhase(self, null) end # Extract metrics about inheritance from model. private class InheritanceMetricsPhase super Phase - redef fun process_mainmodule(mainmodule) + redef fun process_mainmodule(mainmodule, given_mmodules) do if not toolcontext.opt_inheritance.value and not toolcontext.opt_all.value then return + var csv = toolcontext.opt_csv.value + var out = "{toolcontext.opt_dir.value or else "metrics"}/inheritance" + out.mkdir + + var model = toolcontext.modelbuilder.model + var model_view = new ModelView(model, mainmodule) print toolcontext.format_h1("\n# Inheritance metrics") var hmetrics = new MetricSet - hmetrics.register(new MDUI(mainmodule)) - hmetrics.register(new MDUIC(mainmodule)) - hmetrics.register(new MDUII(mainmodule)) - hmetrics.register(new MIF(mainmodule)) - hmetrics.register(new MIFC(mainmodule)) - hmetrics.register(new MIFI(mainmodule)) + hmetrics.register(new MDUI(model_view)) + hmetrics.register(new MDUIC(model_view)) + hmetrics.register(new MDUII(model_view)) + hmetrics.register(new MIF(model_view)) + hmetrics.register(new MIFC(model_view)) + hmetrics.register(new MIFI(model_view)) var cmetrics = new MetricSet - cmetrics.register(new CNOAC(mainmodule)) - cmetrics.register(new CNOPC(mainmodule)) - cmetrics.register(new CNOCC(mainmodule)) - cmetrics.register(new CNODC(mainmodule)) - cmetrics.register(new CNOPI(mainmodule)) - cmetrics.register(new CNOCI(mainmodule)) - cmetrics.register(new CNODI(mainmodule)) - cmetrics.register(new CDITC(mainmodule)) - cmetrics.register(new CDITI(mainmodule)) + cmetrics.register(new CNOAC(model_view)) + cmetrics.register(new CNOPC(model_view)) + cmetrics.register(new CNOCC(model_view)) + cmetrics.register(new CNODC(model_view)) + cmetrics.register(new CNOPI(model_view)) + cmetrics.register(new CNOCI(model_view)) + cmetrics.register(new CNODI(model_view)) + cmetrics.register(new CDITC(model_view)) + cmetrics.register(new CDITI(model_view)) - var model = toolcontext.modelbuilder.model var mmodules = new HashSet[MModule] var mclasses = new HashSet[MClass] - for mproject in model.mprojects do + for mpackage in model.mpackages do - print toolcontext.format_h2("\n ## project {mproject}") + print toolcontext.format_h2("\n ## package {mpackage}") - for mgroup in mproject.mgroups do + for mgroup in mpackage.mgroups do if mgroup.mmodules.is_empty then continue # Scalar metrics @@ -73,28 +78,14 @@ private class InheritanceMetricsPhase if mod_mclasses.is_empty then continue mmodules.add_all(mgroup.mmodules) mclasses.add_all(mod_mclasses) + cmetrics.clear cmetrics.collect(new HashSet[MClass].from(mod_mclasses)) - for metric in cmetrics.metrics do - if metric isa IntMetric then - print toolcontext.format_h4("\t{metric.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 + cmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then cmetrics.to_csv.write_to_file("{out}/{mgroup}_classes.csv") + hmetrics.clear hmetrics.collect(new HashSet[MModule].from(mgroup.mmodules)) - for metric in hmetrics.metrics do - if metric isa FloatMetric then - print toolcontext.format_h4("\t{metric.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 + hmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then hmetrics.to_csv.write_to_file("{out}/{mgroup}_inheritance.csv") end end if not mclasses.is_empty then @@ -102,28 +93,12 @@ private class InheritanceMetricsPhase print toolcontext.format_h2("\n ## global metrics") cmetrics.clear cmetrics.collect(mclasses) - for metric in cmetrics.metrics do - if metric isa IntMetric then - print toolcontext.format_h4("\t{metric.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 + cmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then cmetrics.to_csv.write_to_file("{out}/summary_classes.csv") hmetrics.clear hmetrics.collect(mmodules) - for metric in hmetrics.metrics do - if metric isa FloatMetric then - print toolcontext.format_h4("\t{metric.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 + hmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then hmetrics.to_csv.write_to_file("{out}/summary_inheritance.csv") end end end @@ -137,14 +112,11 @@ class MDUI redef fun name do return "mdui" redef fun desc do return "proportion of mclass defined using inheritance (has other parent than Object)" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 for mclass in mmodule.intro_mclasses do - if mclass.in_hierarchy(mainmodule).greaters.length > 2 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).greaters.length > 2 then count += 1 end if mmodule.intro_mclasses.is_empty then values[mmodule] = 0.0 @@ -164,16 +136,13 @@ class MDUIC redef fun name do return "mduic" redef fun desc do return "proportion of class_kind defined using inheritance" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 var nb = 0 for mclass in mmodule.intro_mclasses do if mclass.kind == abstract_kind or mclass.kind == concrete_kind or mclass.kind == extern_kind then - if mclass.in_hierarchy(mainmodule).greaters.length > 2 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).greaters.length > 2 then count += 1 end nb += 1 end @@ -195,16 +164,13 @@ class MDUII redef fun name do return "mduii" redef fun desc do return "proportion of interface_kind defined using inheritance" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 var nb = 0 for mclass in mmodule.intro_mclasses do if mclass.kind == interface_kind then - if mclass.in_hierarchy(mainmodule).greaters.length > 2 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).greaters.length > 2 then count += 1 end nb += 1 end @@ -226,14 +192,11 @@ class MIF redef fun name do return "mif" redef fun desc do return "proportion of mclass inherited from" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 for mclass in mmodule.intro_mclasses do - if mclass.in_hierarchy(mainmodule).direct_smallers.length > 0 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).direct_smallers.length > 0 then count += 1 end if mmodule.intro_mclasses.is_empty then values[mmodule] = 0.0 @@ -253,16 +216,13 @@ class MIFC redef fun name do return "mifc" redef fun desc do return "proportion of class_kind inherited from" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 var nb = 0 for mclass in mmodule.intro_mclasses do if mclass.kind == abstract_kind or mclass.kind == concrete_kind or mclass.kind == extern_kind then - if mclass.in_hierarchy(mainmodule).direct_smallers.length > 0 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).direct_smallers.length > 0 then count += 1 end nb += 1 end @@ -284,16 +244,13 @@ class MIFI redef fun name do return "mifi" redef fun desc do return "proportion of interface_kind inherited from" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mmodules) do for mmodule in mmodules do var count = 0 var nb = 0 for mclass in mmodule.intro_mclasses do if mclass.kind == interface_kind then - if mclass.in_hierarchy(mainmodule).direct_smallers.length > 0 then count += 1 + if mclass.in_hierarchy(model_view.mainmodule).direct_smallers.length > 0 then count += 1 end nb += 1 end @@ -315,13 +272,10 @@ class CNOAC redef fun name do return "cnoac" redef fun desc do return "number of class_kind ancestor" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).greaters do + for parent in mclass.in_hierarchy(model_view.mainmodule).greaters do if parent == mclass then continue if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then count += 1 @@ -341,13 +295,10 @@ class CNOPC redef fun name do return "cnopc" redef fun desc do return "number of class_kind parent" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_greaters do + for parent in mclass.in_hierarchy(model_view.mainmodule).direct_greaters do if parent == mclass then continue if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then count += 1 @@ -367,13 +318,10 @@ class CNOCC redef fun name do return "cnocc" redef fun desc do return "number of class_kind children" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_smallers do + for parent in mclass.in_hierarchy(model_view.mainmodule).direct_smallers do if parent == mclass then continue if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then count += 1 @@ -393,13 +341,10 @@ class CNODC redef fun name do return "cnodc" redef fun desc do return "number of class_kind descendants" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).smallers do + for parent in mclass.in_hierarchy(model_view.mainmodule).smallers do if parent == mclass then continue if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then count += 1 @@ -410,6 +355,29 @@ class CNODC end end +# MClass metric: Number of Abstract Class Ancestors +# +# Count only absrtract classes +class CNOAA + super MClassMetric + super IntMetric + redef fun name do return "cnoaa" + redef fun desc do return "number of abstract class ancestors" + + redef fun collect(mclasses) do + for mclass in mclasses do + var count = 0 + for parent in mclass.in_hierarchy(model_view.mainmodule).greaters do + if parent == mclass then continue + if parent.kind == abstract_kind then + count += 1 + end + end + values[mclass] = count + end + end +end + # MClass metric: Number of Interface Ancestors # # Count only interfaces @@ -419,13 +387,10 @@ class CNOAI redef fun name do return "cnoai" redef fun desc do return "number of interface_kind ancestor" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).greaters do + for parent in mclass.in_hierarchy(model_view.mainmodule).greaters do if parent == mclass then continue if parent.kind == interface_kind then count += 1 @@ -445,13 +410,10 @@ class CNOPI redef fun name do return "cnopi" redef fun desc do return "number of interface_kind parent" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_greaters do + for parent in mclass.in_hierarchy(model_view.mainmodule).direct_greaters do if parent == mclass then continue if parent.kind == interface_kind then count += 1 @@ -471,13 +433,10 @@ class CNOCI redef fun name do return "cnoci" redef fun desc do return "number of interface_kind children" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_smallers do + for parent in mclass.in_hierarchy(model_view.mainmodule).direct_smallers do if parent == mclass then continue if parent.kind == interface_kind then count += 1 @@ -497,13 +456,10 @@ class CNODI redef fun name do return "cnodi" redef fun desc do return "number of interface_kind descendants" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do var count = 0 - for parent in mclass.in_hierarchy(mainmodule).smallers do + for parent in mclass.in_hierarchy(model_view.mainmodule).smallers do if parent == mclass then continue if parent.kind == interface_kind then count += 1 @@ -523,12 +479,9 @@ class CDITC redef fun name do return "cditc" redef fun desc do return "depth in class tree following only class, abstract, extern kind" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do - values[mclass] = mclass.ditc(mainmodule) + values[mclass] = mclass.ditc(model_view.mainmodule) end end end @@ -542,12 +495,9 @@ class CDITI redef fun name do return "cditi" redef fun desc do return "depth in class tree following only interface_kind" - var mainmodule: MModule - init(mainmodule: MModule) do self.mainmodule = mainmodule - redef fun collect(mclasses) do for mclass in mclasses do - values[mclass] = mclass.diti(mainmodule) + values[mclass] = mclass.diti(model_view.mainmodule) end end end @@ -555,7 +505,7 @@ end # model redef redef class MClass - + # Class Depth in Inheritance Tree # # Following the longest path composed only of extends edges from self to Object @@ -594,4 +544,3 @@ redef class MClass return min end end -