src: Updated uses of CSV library
[nit.git] / src / metrics / mendel_metrics.nit
index 3988824..1c4b6f8 100644 (file)
@@ -45,9 +45,13 @@ module mendel_metrics
 
 import metrics_base
 import mclasses_metrics
+import mmodules_metrics
 import modelize
 
 redef class ToolContext
+       # Compute MENDEL metrics.
+       #
+       # See `mendel_metrics` module documentation.
        var mendel_metrics_phase: Phase = new MendelMetricsPhase(self, null)
 end
 
@@ -62,24 +66,23 @@ private class MendelMetricsPhase
 
                print toolcontext.format_h1("\n# Mendel metrics")
 
-               var vis = protected_visibility
                var model = toolcontext.modelbuilder.model
+               var model_view = model.protected_view
 
                var mclasses = new HashSet[MClass]
-               for mclass in model.mclasses do
-                       if mclass.visibility < vis then continue
+               for mclass in model_view.mclasses do
                        if mclass.is_interface then continue
                        mclasses.add(mclass)
                end
 
-               var cnblp = new CNBLP(mainmodule, vis)
+               var cnblp = new CNBLP(mainmodule, model_view)
                var cnvi = new CNVI(mainmodule)
                var cnvs = new CNVS(mainmodule)
 
                var metrics = new MetricSet
                metrics.register(cnblp, cnvi, cnvs)
                metrics.collect(mclasses)
-               if csv then metrics.to_csv.save("{out}/mendel.csv")
+               if csv then metrics.to_csv.write_to_file("{out}/mendel.csv")
 
                var threshold = cnblp.threshold
                print toolcontext.format_h4("\tlarge mclasses (threshold: {threshold})")
@@ -107,21 +110,21 @@ private class MendelMetricsPhase
 
                if csv then
                        var csvh = new CsvDocument
-                       csvh.format = new CsvFormat('"', ';', "\n")
+                       csvh.separator = ';'
                        csvh.header = ["povr", "ovr", "pext", "ext", "pspe", "spe", "prep", "rep", "eq"]
                        for mclass in mclasses do
-                               var povr = mclass.is_pure_overrider(vis).object_id
-                               var ovr = mclass.is_overrider(vis).object_id
-                               var pext = mclass.is_pure_extender(vis).object_id
-                               var ext = mclass.is_extender(vis).object_id
-                               var pspe = mclass.is_pure_specializer(vis).object_id
-                               var spe = mclass.is_pure_specializer(vis).object_id
-                               var prep = mclass.is_pure_replacer(vis).object_id
-                               var rep = mclass.is_replacer(vis).object_id
-                               var eq = mclass.is_equal(vis).object_id
+                               var povr = mclass.is_pure_overrider(model_view).object_id
+                               var ovr = mclass.is_overrider(model_view).object_id
+                               var pext = mclass.is_pure_extender(model_view).object_id
+                               var ext = mclass.is_extender(model_view).object_id
+                               var pspe = mclass.is_pure_specializer(model_view).object_id
+                               var spe = mclass.is_pure_specializer(model_view).object_id
+                               var prep = mclass.is_pure_replacer(model_view).object_id
+                               var rep = mclass.is_replacer(model_view).object_id
+                               var eq = mclass.is_equal(model_view).object_id
                                csvh.add_record(povr, ovr, pext, ext, pspe, spe, prep, rep, eq)
                        end
-                       csvh.save("{out}/inheritance_behaviour.csv")
+                       csvh.write_to_file("{out}/inheritance_behaviour.csv")
                end
        end
 end
@@ -134,18 +137,37 @@ class CBMS
        redef fun name do return "cbms"
        redef fun desc do return "branch mean size, mean number of introduction available among ancestors"
 
+       # Mainmodule used to compute class hierarchy.
        var mainmodule: MModule
-       init(mainmodule: MModule) do self.mainmodule = mainmodule
+       private var protected_view: ModelView = mainmodule.model.protected_view is lateinit
 
        redef fun collect(mclasses) do
                for mclass in mclasses do
-                       var totc = mclass.all_mproperties(mainmodule, protected_visibility).length
+                       var totc = mclass.collect_accessible_mproperties(protected_view).length
                        var ditc = mclass.in_hierarchy(mainmodule).depth
                        values[mclass] = totc.to_f / (ditc + 1).to_f
                end
        end
 end
 
+# Module Branch Mean Size
+# mbms(module) = |mclassdefs(module)| / (DIT(module) + 1)
+class MBMS
+       super MModuleMetric
+       super FloatMetric
+       redef fun name do return "mbms"
+       redef fun desc do return "branch mean size, mean number of class definition available among ancestors"
+
+       redef fun collect(mmodules) do
+               for mmodule in mmodules do
+                       var totc = mmodule.collect_intro_mclassdefs(mmodule.protected_view).length
+                       totc += mmodule.collect_redef_mclassdefs(mmodule.protected_view).length
+                       var ditc = mmodule.in_importation.depth
+                       values[mmodule] = totc.to_f / (ditc + 1).to_f
+               end
+       end
+end
+
 # Class Novelty Index
 # cnvi = |LocS(class)| / cbms(parents(class))
 class CNVI
@@ -154,8 +176,9 @@ class CNVI
        redef fun name do return "cnvi"
        redef fun desc do return "class novelty index, contribution of the class to its branch in term of introductions"
 
+       # Mainmodule used to compute class hierarchy.
        var mainmodule: MModule
-       init(mainmodule: MModule) do self.mainmodule = mainmodule
+       private var protected_view: ModelView = mainmodule.model.protected_view is lateinit
 
        redef fun collect(mclasses) do
                var cbms = new CBMS(mainmodule)
@@ -166,7 +189,7 @@ class CNVI
                                cbms.clear
                                cbms.collect(new HashSet[MClass].from(parents))
                                # compute class novelty index
-                               var locc = mclass.local_mproperties(protected_visibility).length
+                               var locc = mclass.collect_accessible_mproperties(protected_view).length
                                values[mclass] = locc.to_f / cbms.avg
                        else
                                values[mclass] = 0.0
@@ -175,6 +198,33 @@ class CNVI
        end
 end
 
+# Module Novelty Index
+# mnvi = |LocS(module)| / mbms(parents(module))
+class MNVI
+       super MModuleMetric
+       super FloatMetric
+       redef fun name do return "mnvi"
+       redef fun desc do return "module novelty index, contribution of the module to its branch in term of introductions"
+
+       redef fun collect(mmodules) do
+               var mbms = new MBMS
+               for mmodule in mmodules do
+                       # compute branch mean size
+                       var parents = mmodule.in_importation.direct_greaters
+                       if parents.length > 0 then
+                               mbms.clear
+                               mbms.collect(new HashSet[MModule].from(parents))
+                               # compute module novelty index
+                               var locc = mmodule.collect_intro_mclassdefs(mmodule.protected_view).length
+                               locc += mmodule.collect_redef_mclassdefs(mmodule.protected_view).length
+                               values[mmodule] = locc.to_f / mbms.avg
+                       else
+                               values[mmodule] = 0.0
+                       end
+               end
+       end
+end
+
 # Class Novelty Score
 # cnvs = |LocS(class)| x nvi
 class CNVS
@@ -183,26 +233,46 @@ class CNVS
        redef fun name do return "cnvs"
        redef fun desc do return "class novelty score, importance of the contribution of the class to its branch"
 
+       # Mainmodule used to compute class hierarchy.
        var mainmodule: MModule
-       init(mainmodule: MModule) do self.mainmodule = mainmodule
+       private var protected_view: ModelView = mainmodule.model.protected_view is lateinit
 
        redef fun collect(mclasses) do
                var cnvi = new CNVI(mainmodule)
                cnvi.collect(mclasses)
                for mclass in mclasses do
-                       var locc = mclass.local_mproperties(protected_visibility).length
+                       var locc = mclass.collect_local_mproperties(protected_view).length
                        values[mclass] = cnvi.values[mclass] * locc.to_f
                end
        end
 end
 
+# Module Novelty Score
+# mnvs = |LocS(module)| x nvi
+class MNVS
+       super MModuleMetric
+       super FloatMetric
+       redef fun name do return "mnvs"
+       redef fun desc do return "module novelty score, importance of the contribution of the module to its branch"
+
+       redef fun collect(mmodules) do
+               var mnvi = new MNVI
+               mnvi.collect(mmodules)
+               for mmodule in mmodules do
+                       var locc = mmodule.collect_intro_mclassdefs(mmodule.protected_view).length
+                       locc += mmodule.collect_redef_mclassdefs(mmodule.protected_view).length
+                       values[mmodule] = mnvi.values[mmodule] * locc.to_f
+               end
+       end
+end
+
 redef class MClass
        # the set of redefition that call to super
-       fun extended_mproperties(min_visibility: MVisibility): Set[MProperty] do
+       fun extended_mproperties(view: ModelView): Set[MProperty] do
                var set = new HashSet[MProperty]
                for mclassdef in mclassdefs do
                        for mpropdef in mclassdef.mpropdefs do
-                               if mpropdef.mproperty.visibility < min_visibility then continue
+                               if not view.accept_mentity(mpropdef) then continue
                                if not mpropdef.has_supercall then continue
                                if mpropdef.mproperty.intro_mclassdef.mclass != self then set.add(mpropdef.mproperty)
                        end
@@ -211,11 +281,11 @@ redef class MClass
        end
 
        # the set of redefition that do not call to super
-       fun overriden_mproperties(min_visibility: MVisibility): Set[MProperty] do
+       fun overriden_mproperties(view: ModelView): Set[MProperty] do
                var set = new HashSet[MProperty]
                for mclassdef in mclassdefs do
                        for mpropdef in mclassdef.mpropdefs do
-                               if mpropdef.mproperty.visibility < min_visibility then continue
+                               if not view.accept_mentity(mpropdef) then continue
                                if mpropdef.has_supercall then continue
                                if mpropdef.mproperty.intro_mclassdef.mclass != self then set.add(mpropdef.mproperty)
                        end
@@ -224,80 +294,79 @@ redef class MClass
        end
 
        # pure overriders contain only redefinitions
-       private fun is_pure_overrider(min_visibility: MVisibility): Bool do
-               var news = intro_mproperties(min_visibility).length
-               var locs = local_mproperties(min_visibility).length
+       private fun is_pure_overrider(view: ModelView): Bool do
+               var news = collect_intro_mproperties(view).length
+               var locs = collect_local_mproperties(view).length
                if news == 0 and locs > 0 then return true
                return false
        end
 
        # overriders contain more definitions than introductions
-       private fun is_overrider(min_visibility: MVisibility): Bool do
-               var rdfs = redef_mproperties(min_visibility).length
-               var news = intro_mproperties(min_visibility).length
-               var locs = local_mproperties(min_visibility).length
+       private fun is_overrider(view: ModelView): Bool do
+               var rdfs = collect_redef_mproperties(view).length
+               var news = collect_intro_mproperties(view).length
+               var locs = collect_local_mproperties(view).length
                if rdfs >= news and locs > 0 then return true
                return false
        end
 
        # pure extenders contain only introductions
-       private fun is_pure_extender(min_visibility: MVisibility): Bool do
-               var rdfs = redef_mproperties(min_visibility).length
-               var locs = local_mproperties(min_visibility).length
+       private fun is_pure_extender(view: ModelView): Bool do
+               var rdfs = collect_redef_mproperties(view).length
+               var locs = collect_local_mproperties(view).length
                if rdfs == 0 and locs > 0 then return true
                return false
        end
 
        # extenders contain more introduction than redefinitions
-       private fun is_extender(min_visibility: MVisibility): Bool do
-               var rdfs = redef_mproperties(min_visibility).length
-               var news = intro_mproperties(min_visibility).length
-               var locs = local_mproperties(min_visibility).length
+       private fun is_extender(view: ModelView): Bool do
+               var rdfs = collect_redef_mproperties(view).length
+               var news = collect_intro_mproperties(view).length
+               var locs = collect_local_mproperties(view).length
                if news > rdfs and locs > 0 then return true
                return false
        end
 
        # pure specializers always call to super in its redefinitions
-       private fun is_pure_specializer(min_visibility: MVisibility): Bool do
-               var ovrs = overriden_mproperties(min_visibility).length
-               var rdfs = redef_mproperties(min_visibility).length
+       private fun is_pure_specializer(view: ModelView): Bool do
+               var ovrs = overriden_mproperties(view).length
+               var rdfs = collect_redef_mproperties(view).length
                if ovrs == 0 and rdfs > 0 then return true
                return false
        end
 
        # specializers have more redefinitions that call super than not calling it
-       private fun is_specializer(min_visibility: MVisibility): Bool do
-               var spcs = extended_mproperties(min_visibility).length
-               var ovrs = overriden_mproperties(min_visibility).length
-               var rdfs = redef_mproperties(min_visibility).length
+       private fun is_specializer(view: ModelView): Bool do
+               var spcs = extended_mproperties(view).length
+               var ovrs = overriden_mproperties(view).length
+               var rdfs = collect_redef_mproperties(view).length
                if spcs > ovrs and rdfs > 0 then return true
                return false
        end
 
        # pure replacers never call to super in its redefinitions
-       private fun is_pure_replacer(min_visibility: MVisibility): Bool do
-               var spcs = extended_mproperties(min_visibility).length
-               var rdfs = redef_mproperties(min_visibility).length
+       private fun is_pure_replacer(view: ModelView): Bool do
+               var spcs = extended_mproperties(view).length
+               var rdfs = collect_redef_mproperties(view).length
                if spcs == 0 and rdfs > 0 then return true
                return false
        end
 
        # replacers have less redefinitions that call super than not calling it
-       private fun is_replacer(min_visibility: MVisibility): Bool do
-               var spcs = extended_mproperties(min_visibility).length
-               var ovrs = overriden_mproperties(min_visibility).length
-               var rdfs = redef_mproperties(min_visibility).length
+       private fun is_replacer(view: ModelView): Bool do
+               var spcs = extended_mproperties(view).length
+               var ovrs = overriden_mproperties(view).length
+               var rdfs = collect_redef_mproperties(view).length
                if ovrs > spcs and rdfs > 0 then return true
                return false
        end
 
        # equals contain as redifinition than introduction
-       private fun is_equal(min_visibility: MVisibility): Bool do
-               var spcs = extended_mproperties(min_visibility).length
-               var ovrs = overriden_mproperties(min_visibility).length
-               var rdfs = redef_mproperties(min_visibility).length
+       private fun is_equal(view: ModelView): Bool do
+               var spcs = extended_mproperties(view).length
+               var ovrs = overriden_mproperties(view).length
+               var rdfs = collect_redef_mproperties(view).length
                if spcs == ovrs and rdfs > 0 then return true
                return false
        end
 end
-