add preliminary Code Metrics implementation status and unit-tests, see #403

Author: Vogel612

RetailCoder.VBE/Navigation/CodeMetrics/CodeMetricsResult.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Rubberduck.Navigation.CodeMetrics
+{
+    public struct CodeMetricsResult
+    {
+        public CodeMetricsResult(int lines, int cyclomaticComplexity, int nesting)
+            : this(lines, cyclomaticComplexity, nesting, Enumerable.Empty<CodeMetricsResult>())
+        { 
+        }
+
+        public CodeMetricsResult(int lines, int cyclomaticComplexity, int nesting, IEnumerable<CodeMetricsResult> childScopeResults)
+        {
+            var childScopeMetric =
+                childScopeResults.Aggregate(new CodeMetricsResult(), (r1, r2) => new CodeMetricsResult(r1.Lines + r2.Lines, r1.CyclomaticComplexity + r2.CyclomaticComplexity, Math.Max(r1.MaximumNesting, r2.MaximumNesting)));
+            Lines = lines + childScopeMetric.Lines;
+            CyclomaticComplexity = cyclomaticComplexity + childScopeMetric.CyclomaticComplexity;
+            MaximumNesting = Math.Max(nesting, childScopeMetric.MaximumNesting);
+        }
+
+        // possibly refer to a selection?
+        public int Lines { get; private set; }
+        public int CyclomaticComplexity { get; private set; }
+        public int MaximumNesting { get; private set; }
+
+    }
+}

RetailCoder.VBE/Navigation/CodeMetrics/ICodeMetricsAnalyst.cs

@@ -0,0 +1,15 @@
+using Rubberduck.Parsing.VBA;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Rubberduck.Navigation.CodeMetrics
+{
+    public interface ICodeMetricsAnalyst
+    {
+        Task<CodeMetricsResult> GetResult(RubberduckParserState state, CancellationToken token);
+    }
+}

RetailCoder.VBE/Navigation/CodeMetrics/ParseTreeMetricsAnalyst.cs

@@ -0,0 +1,115 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Rubberduck.Parsing.VBA;
+using Antlr4.Runtime.Tree;
+using Antlr4.Runtime;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.VBEditor;
+using Antlr4.Runtime.Misc;
+
+namespace Rubberduck.Navigation.CodeMetrics
+{
+    public class ParseTreeMetricsAnalyst : ICodeMetricsAnalyst
+    {
+        public async Task<CodeMetricsResult> GetResult(RubberduckParserState state, CancellationToken token)
+        {
+            if (state == null || !state.AllUserDeclarations.Any())
+            {
+                return new CodeMetricsResult();
+            }
+            return await Task.Run(() =>
+            {
+                var trees = state.ParseTrees;
+                var results = new List<CodeMetricsResult>();
+
+                foreach (var moduleTree in trees)
+                {
+                    if (token.IsCancellationRequested)
+                    {
+                        return new CodeMetricsResult();
+                    }
+                    // FIXME rewrite as visitor. That should make subtrees easier and allow us to expand metrics
+                    var cmListener = new CodeMetricsListener(moduleTree.Key);
+                    ParseTreeWalker.Default.Walk(cmListener, moduleTree.Value);
+                    results.Add(cmListener.GetMetricsResult());
+                }
+                return new CodeMetricsResult(0, 0, 0, results);
+            });
+        }
+
+        private class CodeMetricsListener : VBAParserBaseListener
+        {
+            private QualifiedModuleName qmn;
+            private List<CodeMetricsResult> results = new List<CodeMetricsResult>();
+
+            public CodeMetricsListener(QualifiedModuleName qmn)
+            {
+                this.qmn = qmn;
+            }
+
+            public override void EnterEndOfLine([NotNull] VBAParser.EndOfLineContext context)
+            {
+                results.Add(new CodeMetricsResult(1, 0, 0));
+            }
+
+            public override void EnterIfStmt([NotNull] VBAParser.IfStmtContext context)
+            {
+                // one additional path beside the default
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterElseIfBlock([NotNull] VBAParser.ElseIfBlockContext context)
+            {
+                // one additonal path beside the default
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterForEachStmt([NotNull] VBAParser.ForEachStmtContext context)
+            {
+                // one additional path
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterForNextStmt([NotNull] VBAParser.ForNextStmtContext context)
+            {
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterCaseClause([NotNull] VBAParser.CaseClauseContext context)
+            {
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterSubStmt([NotNull] VBAParser.SubStmtContext context)
+            {
+                // this is the default path through the sub
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterFunctionStmt([NotNull] VBAParser.FunctionStmtContext context)
+            {
+                // this is the default path through the function
+                results.Add(new CodeMetricsResult(0, 1, 0));
+            }
+
+            public override void EnterBlockStmt([NotNull] VBAParser.BlockStmtContext context)
+            {
+                var ws = context.whiteSpace();
+                // FIXME divide by indent size and assume we're indented?
+                // FIXME LINE_CONTINUATION might interfere here
+                //results.Add(new CodeMetricsResult(0, 0, ws.ChildCount / 4));
+            }
+
+            // FIXME also check if we need to do something about `mandatoryLineContinuation`?
+
+            internal CodeMetricsResult GetMetricsResult()
+            {
+                return new CodeMetricsResult(0, 0, 0, results);
+            }
+        }
+    }
+}

RetailCoder.VBE/Rubberduck.csproj

@@ -344,6 +344,9 @@
     <Compile Include="Common\WindowsOperatingSystem.cs" />
     <Compile Include="Common\UndocumentedAttribute.cs" />
     <Compile Include="Navigation\CodeExplorer\ICodeExplorerDeclarationViewModel.cs" />
+    <Compile Include="Navigation\CodeMetrics\CodeMetricsResult.cs" />
+    <Compile Include="Navigation\CodeMetrics\ICodeMetricsAnalyst.cs" />
+    <Compile Include="Navigation\CodeMetrics\ParseTreeMetricsAnalyst.cs" />
     <Compile Include="Navigation\Folders\FolderHelper.cs" />
     <Compile Include="Refactorings\EncapsulateField\PropertyGenerator.cs" />
     <Compile Include="Refactorings\ExtractMethod\ExtractedMethod.cs" />

RubberduckTests/Mocks/MockParser.cs

@@ -29,7 +29,14 @@ public static RubberduckParserState ParseString(string inputCode, out QualifiedM
             var parser = Create(vbe.Object);
 
             parser.Parse(new CancellationTokenSource());
-            if (parser.State.Status == ParserState.Error) { Assert.Inconclusive("Parser Error"); }
+            if (parser.State.Status == ParserState.Error) {
+                SyntaxErrorException ex = null;
+                foreach (var exception in parser.State.ModuleExceptions)
+                {
+                    ex = exception.Item2;
+                }
+                Assert.Inconclusive("Parser Error: {0}", ex?.Message ?? "None?");
+            }
             return parser.State;
 
         }

RubberduckTests/RubberduckTests.csproj

@@ -180,6 +180,7 @@
     <Compile Include="QuickFixes\QuickFixBaseTests.cs" />
     <Compile Include="SmartIndenter\VerticalSpacingTests.cs" />
     <Compile Include="SourceControl\SynchrounouslyConstructedDeclarationFinderFactory.cs" />
+    <Compile Include="Stats\ParseTreeMetricsAnalystTests.cs" />
     <Compile Include="Symbols\AccessibilityCheckTests.cs" />
     <Compile Include="Symbols\ClassModuleDeclarationTests.cs" />
     <Compile Include="Symbols\CommandBarControlCaptionGuardTests.cs" />