X-Git-Url: http://nitlanguage.org diff --git a/src/metrics/inheritance_metrics.nit b/src/metrics/inheritance_metrics.nit index a9f3247..d475562 100644 --- a/src/metrics/inheritance_metrics.nit +++ b/src/metrics/inheritance_metrics.nit @@ -17,32 +17,44 @@ # 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) + 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 print toolcontext.format_h1("\n# Inheritance metrics") - var hmetrics = new InheritanceMetricSet - hmetrics.register(new MDUI, new MDUIC, new MDUII, new MIF, new MIFC, new MIFI) - - var cmetrics = new MClassMetricSet - cmetrics.register(new CNOA, new CNOP, new CNOC, new CNODC) - cmetrics.register(new CNOA, new CNOP, new CNOC, new CNODI) - cmetrics.register(new CDIT, new CDITI) + 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)) + + 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)) var model = toolcontext.modelbuilder.model var mmodules = new HashSet[MModule] @@ -62,69 +74,27 @@ private class InheritanceMetricsPhase if mod_mclasses.is_empty then continue mmodules.add_all(mgroup.mmodules) mclasses.add_all(mod_mclasses) - cmetrics.collect(new HashSet[MClass].from(mod_mclasses), mainmodule) - for name, metric in cmetrics.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 - hmetrics.collect(new HashSet[MModule].from(mgroup.mmodules), mainmodule) - for name, metric in hmetrics.metrics do - if metric isa FloatMetric 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 + cmetrics.clear + cmetrics.collect(new HashSet[MClass].from(mod_mclasses)) + cmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then cmetrics.to_csv.save("{out}/{mgroup}_classes.csv") + hmetrics.clear + hmetrics.collect(new HashSet[MModule].from(mgroup.mmodules)) + hmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then hmetrics.to_csv.save("{out}/{mgroup}_inheritance.csv") end end if not mclasses.is_empty then # Global metrics print toolcontext.format_h2("\n ## global metrics") - cmetrics.collect(mclasses, mainmodule) - for name, metric in cmetrics.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 - hmetrics.collect(mmodules, mainmodule) - for name, metric in hmetrics.metrics do - if metric isa FloatMetric 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 - -# Metric Set used to collect data about inheritance in each module -class InheritanceMetricSet - super MetricSet - redef type METRIC: MModuleMetric - fun collect(mmodules: Set[MModule], mainmodule: MModule) do - clear - for metric in metrics.values do - for mmodule in mmodules do - metric.collect(mmodule, mainmodule) - end + cmetrics.clear + cmetrics.collect(mclasses) + cmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then cmetrics.to_csv.save("{out}/summary_classes.csv") + hmetrics.clear + hmetrics.collect(mmodules) + hmetrics.to_console(1, not toolcontext.opt_nocolors.value) + if csv then hmetrics.to_csv.save("{out}/summary_inheritance.csv") end end end @@ -138,15 +108,20 @@ class MDUI redef fun name do return "mdui" redef fun desc do return "proportion of mclass defined using inheritance (has other parent than Object)" - redef fun collect(mmodule, mainmodule) do - var count = 0 - for mclass in mmodule.intro_mclasses do - if mclass.in_hierarchy(mainmodule).greaters.length > 2 then count += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / mmodule.intro_mclasses.length.to_f + 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 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / mmodule.intro_mclasses.length.to_f + end end end end @@ -160,19 +135,24 @@ class MDUIC redef fun name do return "mduic" redef fun desc do return "proportion of class_kind defined using inheritance" - redef fun collect(mmodule, mainmodule) 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 + 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 + end + nb += 1 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / nb.to_f end - nb += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / nb.to_f end end end @@ -186,19 +166,24 @@ class MDUII redef fun name do return "mduii" redef fun desc do return "proportion of interface_kind defined using inheritance" - redef fun collect(mmodule, mainmodule) 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 + 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 + end + nb += 1 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / nb.to_f end - nb += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / nb.to_f end end end @@ -212,15 +197,20 @@ class MIF redef fun name do return "mif" redef fun desc do return "proportion of mclass inherited from" - redef fun collect(mmodule, mainmodule) do - var count = 0 - for mclass in mmodule.intro_mclasses do - if mclass.in_hierarchy(mainmodule).direct_smallers.length > 0 then count += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / mmodule.intro_mclasses.length.to_f + 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 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / mmodule.intro_mclasses.length.to_f + end end end end @@ -234,19 +224,24 @@ class MIFC redef fun name do return "mifc" redef fun desc do return "proportion of class_kind inherited from" - redef fun collect(mmodule, mainmodule) 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 + 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 + end + nb += 1 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / nb.to_f end - nb += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / nb.to_f end end end @@ -260,19 +255,24 @@ class MIFI redef fun name do return "mifi" redef fun desc do return "proportion of interface_kind inherited from" - redef fun collect(mmodule, mainmodule) 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 + 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 + end + nb += 1 + end + if mmodule.intro_mclasses.is_empty then + values[mmodule] = 0.0 + else + values[mmodule] = count.to_f / nb.to_f end - nb += 1 - end - if mmodule.intro_mclasses.is_empty then - values[mmodule] = 0.0 - else - values[mmodule] = count.to_f / nb.to_f end end end @@ -286,15 +286,20 @@ class CNOAC redef fun name do return "cnoac" redef fun desc do return "number of class_kind ancestor" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(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 + 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 + if parent == mclass then continue + if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -307,15 +312,20 @@ class CNOPC redef fun name do return "cnopc" redef fun desc do return "number of class_kind parent" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(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 + 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 + if parent == mclass then continue + if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -328,15 +338,20 @@ class CNOCC redef fun name do return "cnocc" redef fun desc do return "number of class_kind children" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(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 + 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 + if parent == mclass then continue + if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -349,15 +364,20 @@ class CNODC redef fun name do return "cnodc" redef fun desc do return "number of class_kind descendants" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(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 + 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 + if parent == mclass then continue + if parent.kind == abstract_kind or parent.kind == concrete_kind or parent.kind == extern_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -370,15 +390,20 @@ class CNOAI redef fun name do return "cnoai" redef fun desc do return "number of interface_kind ancestor" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(mainmodule).greaters do - if parent == mclass then continue - if parent.kind == interface_kind then - count += 1 + 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 + if parent == mclass then continue + if parent.kind == interface_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -391,15 +416,20 @@ class CNOPI redef fun name do return "cnopi" redef fun desc do return "number of interface_kind parent" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_greaters do - if parent == mclass then continue - if parent.kind == interface_kind then - count += 1 + 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 + if parent == mclass then continue + if parent.kind == interface_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -412,15 +442,20 @@ class CNOCI redef fun name do return "cnoci" redef fun desc do return "number of interface_kind children" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(mainmodule).direct_smallers do - if parent == mclass then continue - if parent.kind == interface_kind then - count += 1 + 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 + if parent == mclass then continue + if parent.kind == interface_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -433,15 +468,20 @@ class CNODI redef fun name do return "cnodi" redef fun desc do return "number of interface_kind descendants" - redef fun collect(mclass, mainmodule) do - var count = 0 - for parent in mclass.in_hierarchy(mainmodule).smallers do - if parent == mclass then continue - if parent.kind == interface_kind then - count += 1 + 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 + if parent == mclass then continue + if parent.kind == interface_kind then + count += 1 + end end + values[mclass] = count end - values[mclass] = count end end @@ -454,8 +494,13 @@ class CDITC redef fun name do return "cditc" redef fun desc do return "depth in class tree following only class, abstract, extern kind" - redef fun collect(mclass, mainmodule) do - values[mclass] = mclass.ditc(mainmodule) + 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) + end end end @@ -468,8 +513,13 @@ class CDITI redef fun name do return "cditi" redef fun desc do return "depth in class tree following only interface_kind" - redef fun collect(mclass, mainmodule) do - values[mclass] = mclass.diti(mainmodule) + 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) + end end end