src/metrics/refinement_metrics.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2012 Jean Privat <jean@pryen.org>
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 # Collect metrics about refinement usage
  18 module refinement_metrics
  19
  20 import model
  21 import metrics_base
  22
  23 redef class ToolContext
  24         var refinement_metrics_phase: Phase = new RefinementMetricsPhase(self, null)
  25 end
  26
  27 private class RefinementMetricsPhase
  28         super Phase
  29         redef fun process_mainmodule(mainmodule, given_mmodules)
  30         do
  31                 if not toolcontext.opt_refinement.value and not toolcontext.opt_all.value then return
  32                 compute_refinement_metrics(toolcontext.modelbuilder.model)
  33         end
  34 end
  35
  36 # Print refinement usage metrics
  37 fun compute_refinement_metrics(model: Model)
  38 do
  39         print "--- Metrics of refinement usage ---"
  40         var nbmod = model.mmodules.length
  41         print "Number of modules: {nbmod}"
  42
  43         print ""
  44
  45         var nbcla = model.mclasses.length
  46         var nbcladef = model.mclassdef_hierarchy.length
  47         print "Number of classes: {nbcla}"
  48
  49         # determine the distribution of:
  50         #  * class kinds (interface, abstract class, etc.)
  51         #  * refinex classes (vs. unrefined ones)
  52         var kinds = new Counter[MClassKind]
  53         var refined = 0
  54         for c in model.mclasses do
  55                 kinds.inc(c.kind)
  56                 if c.mclassdefs.length > 1 then
  57                         refined += 1
  58                 end
  59         end
  60         for k in kinds.sort do
  61                 var v = kinds[k]
  62                 print "  Number of {k} kind: {v} ({div(v*100,nbcla)}%)"
  63         end
  64
  65
  66         print ""
  67
  68         print "Number of class definitions: {nbcladef}"
  69         print "Number of refined classes: {refined} ({div(refined*100,nbcla)}%)"
  70         print "Average number of class refinments by classes: {div(nbcladef-nbcla,nbcla)}"
  71         print "Average number of class refinments by refined classes: {div(nbcladef-nbcla,refined)}"
  72
  73         print ""
  74
  75         var nbprop = model.mproperties.length
  76         var nbpropdef = 0
  77         var redefined = 0
  78         print "Number of properties: {model.mproperties.length}"
  79         var pkinds = new Counter[String]
  80         for p in model.mproperties do
  81                 nbpropdef += p.mpropdefs.length
  82                 if p.mpropdefs.length > 1 then
  83                         redefined += 1
  84                 end
  85                 pkinds.inc(p.class_name)
  86         end
  87         for k in pkinds.sort do
  88                 var v = pkinds[k]
  89                 print "  Number of {k}: {v} ({div(v*100,nbprop)}%)"
  90         end
  91
  92         print ""
  93
  94         print "Number of property definitions: {nbpropdef}"
  95         print "Number of redefined properties: {redefined} ({div(redefined*100,nbprop)}%)"
  96         print "Average number of property redefinitions by property: {div(nbpropdef-nbprop,nbprop)}"
  97         print "Average number of property redefinitions by redefined property: {div(nbpropdef-nbprop,redefined)}"
  98 end