Suporting json config file and better ResultReport

Author: AlbertoMonteiro

.gitignore

@@ -4,26 +4,32 @@
 # User-specific files
 *.suo
 *.user
+*.userosscache
 *.sln.docstates
 
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
 [Rr]elease/
+[Rr]eleases/
 x64/
+x86/
 build/
 bld/
 [Bb]in/
 [Oo]bj/
 
-# Roslyn cache directories
-*.ide/
+# Visual Studio 2015 cache/options directory
+.vs/
 
 # MSTest test Results
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
 
-#NUNIT
+# NUNIT
 *.VisualState.xml
 TestResult.xml
 
@@ -32,6 +38,10 @@ TestResult.xml
 [Rr]eleasePS/
 dlldata.c
 
+# DNX
+project.lock.json
+artifacts/
+
 *_i.c
 *_p.c
 *_i.h
@@ -84,7 +94,7 @@ _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
 
-# JustCode is a .NET coding addin-in
+# JustCode is a .NET coding add-in
 .JustCode
 
 # TeamCity is a build add-in
@@ -128,17 +138,16 @@ publish/
 ## passwords
 #*.pubxml
 
-# NuGet Packages Directory
-packages/*
-## TODO: If the tool you use requires repositories.config
-## uncomment the next line
-#!packages/repositories.config
+*.publishproj
 
-# Enable "build/" folder in the NuGet Packages folder since
-# NuGet packages use it for MSBuild targets.
-# This line needs to be after the ignore of the build folder
-# (and the packages folder if the line above has been uncommented)
-!packages/build/
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
 
 # Windows Azure Build Output
 csx/
@@ -147,9 +156,13 @@ csx/
 # Windows Store app package directory
 AppPackages/
 
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
 # Others
-sql/
-*.Cache
 ClientBin/
 [Ss]tyle[Cc]op.*
 ~$*
@@ -159,6 +172,7 @@ ClientBin/
 *.pfx
 *.publishsettings
 node_modules/
+orleans.codegen.cs
 
 # RIA/Silverlight projects
 Generated_Code/
@@ -183,7 +197,16 @@ UpgradeLog*.htm
 # Microsoft Fakes
 FakesAssemblies/
 
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
 # LightSwitch generated files
 GeneratedArtifacts/
 _Pvt_Extensions/
-ModelManifest.xml
+ModelManifest.xml

MetricsExtractor/Custom/TypeMetricWithNamespace.cs

@@ -48,7 +48,7 @@ public TypeMetricWithNamespace(ITypeMetric typeMetric)
 
         public string Namespace { get; private set; }
 
-        public string FullName { get { return string.Format("{0}.{1}", Namespace, Name); } }
+        public string FullName => $"{Namespace}.{Name}";
 
         public ClassRank Rank { get; private set; }
 

MetricsExtractor/MetodoRuim.cs

@@ -5,14 +5,33 @@ namespace MetricsExtractor
     [Serializable]
     public class MetodoRuim
     {
-        public string ClassName { get; set; }
+        public MetodoRuim()
+        {
+            
+        }
 
-        public string NomeMetodo { get; set; }
+        public MetodoRuim(string className, string ns, string nomeMetodo, double manutenibilidade, double complexidade, double quantidadeDeLinhas)
+        {
+            ClassName = className;
+            Namespace = ns;
+            NomeMetodo = nomeMetodo;
+            Manutenibilidade = manutenibilidade;
+            Complexidade = complexidade;
+            QuantidadeDeLinhas = quantidadeDeLinhas;
+        }
 
-        public double Manutenibilidade { get; set; }
-        
-        public double Complexidade { get; set; }
+        public string FullClassName => $"{Namespace}.{ClassName}";
 
-        public double QuantidadeDeLinhas { get; set; }
+        public string ClassName { get; }
+
+        public string Namespace { get; }
+
+        public string NomeMetodo { get; }
+
+        public double Manutenibilidade { get; }
+
+        public double Complexidade { get; }
+
+        public double QuantidadeDeLinhas { get; }
     }
 }

MetricsExtractor/MetricConfiguration.cs

@@ -1,6 +1,8 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.IO;
 using DocoptNet;
+using Newtonsoft.Json;
 using static System.IO.Path;
 
 namespace MetricsExtractor
@@ -12,17 +14,32 @@ public class MetricConfiguration
         public MetricConfiguration(IDictionary<string, ValueObject> arguments)
         {
             _arguments = arguments;
+            if (!string.IsNullOrWhiteSpace(JsonConfigFile))
+            {
+                var converted = JsonConvert.DeserializeAnonymousType(File.ReadAllText(JsonConfigFile), new { IgnoredProjects, IgnoredNamespaces, IgnoredTypes });
+                IgnoredProjects = converted.IgnoredProjects;
+                IgnoredNamespaces = converted.IgnoredNamespaces;
+                IgnoredTypes = converted.IgnoredTypes;
+            }
+            else
+            {
+                IgnoredProjects = GetImmutableArray("ignoredProjects");
+                IgnoredNamespaces = GetImmutableArray("ignoredNamespaces");
+                IgnoredTypes = GetImmutableArray("ignoredTypes");
+            }
         }
 
         public string Solution => _arguments["<solution>"].ToString();
 
         public string SolutionDirectory => GetDirectoryName(Solution);
 
-        public ImmutableArray<string> IgnoredProjects => GetImmutableArray("ignoredProjects");
+        public ImmutableArray<string> IgnoredProjects { get; }
 
-        public ImmutableArray<string> IgnoredNamespaces => GetImmutableArray("ignoredNamespaces");
+        public ImmutableArray<string> IgnoredNamespaces { get; }
 
-        public ImmutableArray<string> IgnoredTypes => GetImmutableArray("ignoredTypes");
+        public ImmutableArray<string> IgnoredTypes { get; }
+
+        public string JsonConfigFile => _arguments["<jsonfileconfig>"].ToString();
 
         private ImmutableArray<string> GetImmutableArray(string key)
             => _arguments[$"<{key}>"] != null

MetricsExtractor/MetricsExtractor.csproj

@@ -57,6 +57,10 @@
       <HintPath>..\packages\Microsoft.CodeAnalysis.Workspaces.Common.1.0.0\lib\net45\Microsoft.CodeAnalysis.Workspaces.Desktop.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="Newtonsoft.Json, Version=7.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+      <HintPath>..\packages\Newtonsoft.Json.7.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="RazorEngine">
       <HintPath>..\packages\RazorEngine.3.4.2\lib\net45\RazorEngine.dll</HintPath>
     </Reference>

MetricsExtractor/Program.cs

@@ -6,7 +6,6 @@
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
-using System.Runtime.InteropServices;
 using System.Text;
 using System.Threading.Tasks;
 using System.Xml.Serialization;
@@ -33,12 +32,14 @@ class Program
       MetricsExtractor.exe -s <solution> [-in <ignoredNamespaces>]
       MetricsExtractor.exe -s <solution> [-it <ignoredTypes>]
       MetricsExtractor.exe -s <solution> [-ip <ignoredProjects>] [-in <ignoredNamespaces>] [-it <ignoredTypes>]
+      MetricsExtractor.exe -s <solution> [-jsonconfig <jsonfileconfig>]
 
     Options:
       -s --solution                                                     Load projects from solution.
       -ip <ignoredProjects> --ignoredprojects <ignoredProjects>         Projets in solution that you want to ignore, split them by "";""
       -in <ignoredNamespaces> --ignorednamespaces <ignoredNamespaces>   Namespaces in your application that you want to ignore, split them by "";""
       -it <ignoredTypes> --ignoredtypes <ignoredTypes>                  Types in your application that you want to ignore, split them by "";""
+      -jsonconfig <jsonfileconfig>                                      User a json file to configure metrics extraction "";""
 
     ";
         private static readonly List<ClassRank> ClassRanks = Enum.GetValues(typeof(ClassRank)).Cast<ClassRank>().ToList();
@@ -153,19 +154,11 @@ private static EstadoDoProjeto CreateEstadoDoProjeto(List<TypeMetricWithNamespac
 
         private static List<MetodoRuim> GetMetodosRuins(List<MetodoComTipo> metodos, int maxLinesOfCodeOnMethod)
         {
-            var metodosRuins = metodos
+            return metodos
                 .Where(x => (x.Metodo.SourceLinesOfCode >= maxLinesOfCodeOnMethod) || (x.Metodo.CyclomaticComplexity >= 10))
-                .Select(x => new MetodoRuim
-                {
-                    ClassName = x.Tipo.FullName,
-                    NomeMetodo = x.Metodo.Name,
-                    Complexidade = x.Metodo.CyclomaticComplexity,
-                    Manutenibilidade = x.Metodo.MaintainabilityIndex,
-                    QuantidadeDeLinhas = x.Metodo.SourceLinesOfCode,
-                })
+                .Select(x => new MetodoRuim(x.Tipo.Name, x.Tipo.Namespace, x.Metodo.Name, x.Metodo.MaintainabilityIndex, x.Metodo.CyclomaticComplexity, x.Metodo.SourceLinesOfCode))
                 .OrderByDescending(x => x.QuantidadeDeLinhas).ThenByDescending(x => x.Complexidade)
                 .ToList();
-            return metodosRuins;
         }
 
         private static async Task<IEnumerable<INamespaceMetric>> RunCodeMetrics(MetricConfiguration configuration)

MetricsExtractor/ReportTemplate/Index.cshtml

@@ -10,6 +10,11 @@
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css">
     <link rel="stylesheet" type="text/css" href="site.css">
+    <style>
+        div.tooltip-inner {
+            max-width: 700px;
+        }
+    </style>
     <script src="https://code.jquery.com/jquery-2.1.3.min.js"></script>
     <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
 </head>
@@ -86,8 +91,7 @@
                             <table class="table table-striped table-hover ">
                                 <thead>
                                     <tr>
-                                        <th>Classe</th>
-                                        <th>Nome do método</th>
+                                        <th>Classe/Nome do método</th>
                                         <th>SLOC <span class="glyphicon glyphicon-exclamation-sign cor-azul" data-original-title="Linhas de Código(Source Lines Of Code)" data-toggle="tooltip" aria-hidden="true"></span></th>
                                         <th>Comp. Ciclomática</th>
                                         <th>Manutenibilidade</th>
@@ -97,8 +101,7 @@
                                     @foreach (MetodoRuim metodoRuim in md.MetodosRuins)
                                     {
                                         <tr>
-                                            <td>@metodoRuim.ClassName</td>
-                                            <td>@metodoRuim.NomeMetodo</td>
+                                            <td>@(metodoRuim.ClassName + "." + metodoRuim.NomeMetodo) <span class="glyphicon glyphicon-exclamation-sign cor-azul" data-original-title="@(metodoRuim.FullClassName + "." + metodoRuim.NomeMetodo)" data-toggle="tooltip" aria-hidden="true"></span></td>
                                             <td>@metodoRuim.QuantidadeDeLinhas</td>
                                             <td>@metodoRuim.Complexidade</td>
                                             <td>@metodoRuim.Manutenibilidade.ToString("N0")</td>
@@ -122,12 +125,29 @@
                         </div>
                         <div id="collapse@(type.Key)" class="panel-collapse collapse" role="tabpanel" aria-labelledby="heading@(type.Key)" aria-expanded="false">
                             <div class="panel-body">
-                                <ul>
-                                    @foreach (var typeWithMetric in type.Value)
-                                    {
-                                        <li>@typeWithMetric.FullName</li>
-                                    }
-                                </ul>
+                                <table class="table table-striped table-hover table-bordered">
+                                    <thead>
+                                        <tr>
+                                            <th>Classe</th>
+                                            <th>Manutenibilidade <span class="glyphicon glyphicon-exclamation-sign cor-azul" data-original-title="Número de 0-100" data-toggle="tooltip" aria-hidden="true"></span></th>
+                                            <th>Comp. Ciclomática <span class="glyphicon glyphicon-exclamation-sign cor-azul" data-original-title="Complexidade ciclomática" data-toggle="tooltip" aria-hidden="true"></span></th>
+                                            <th>Profundidade de Herança</th>
+                                            <th>Linhas de código</th>
+                                        </tr>
+                                    </thead>
+                                    <tbody>
+                                        @foreach (var typeWithMetric in type.Value)
+                                        {
+                                            <tr>
+                                                <td>@typeWithMetric.Name <span class="glyphicon glyphicon-exclamation-sign cor-azul" data-original-title="@typeWithMetric.FullName" data-toggle="tooltip" aria-hidden="true"></td>
+                                                <td>@typeWithMetric.MaintainabilityIndex.ToString("0")</td>
+                                                <td>@typeWithMetric.CyclomaticComplexity</td>
+                                                <td>@typeWithMetric.DepthOfInheritance</td>
+                                                <td>@typeWithMetric.SourceLinesOfCode</td>
+                                            </tr>
+                                        }
+                                    </tbody>
+                                </table>
                             </div>
                         </div>
                     </div>
@@ -137,7 +157,7 @@
     </div>
     <script type="text/javascript">
         $(function () {
-            $('[data-toggle="tooltip"]').tooltip();
+            $('[data-toggle="tooltip"]').tooltip({ trigger: "click" });
             $(".progress-bar-success").css("width", "@(md.Manutenibilidade)%");
         });
     </script>

MetricsExtractor/ReportTemplate/ReportTemplateFactory.cs

@@ -8,21 +8,8 @@ public class ReportTemplateFactory
     {
         public string GetReport(EstadoDoProjeto estadoDoProjeto)
         {
-            // Generate the email body from the template file.
             var templateFolderPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "ReportTemplate");
             var templateFilePath = Path.Combine(templateFolderPath, "Index.cshtml");
-/*
-            var templateConfig = new TemplateServiceConfiguration
-            {
-                Resolver = new DelegateTemplateResolver(name =>
-                {
-                    //no caching cause RazorEngine handles that itself
-                    var templatePath = Path.Combine(templateFolderPath, name);
-                    using (var reader = new StreamReader(templatePath)) // let it throw if doesn't exist
-                        return reader.ReadToEnd();
-                })
-            };
-*/
             var service = new TemplateService(/*templateConfig*/);
             RazorEngine.Razor.SetTemplateService(service);
             var emailHtmlBody = service.Parse(File.ReadAllText(templateFilePath), estadoDoProjeto, null, null);

MetricsExtractor/packages.config

@@ -8,6 +8,7 @@
   <package id="Microsoft.CodeAnalysis.CSharp.Workspaces" version="1.0.0" targetFramework="net451" />
   <package id="Microsoft.CodeAnalysis.Workspaces.Common" version="1.0.0" targetFramework="net451" />
   <package id="Microsoft.Composition" version="1.0.30" targetFramework="net45" />
+  <package id="Newtonsoft.Json" version="7.0.1" targetFramework="net452" />
   <package id="RazorEngine" version="3.4.2" targetFramework="net45" />
   <package id="System.Collections.Immutable" version="1.1.36" targetFramework="net451" />
   <package id="System.Reflection.Metadata" version="1.0.21" targetFramework="net451" />