Added DeclarationFinder test class. Moved tests from AssignedByValParameter..QuickFixTests and RenameTests to new test class.

Author: BZngr

RetailCoder.VBE/Inspections/QuickFixes/AssignedByValParameterMakeLocalCopyQuickFix.cs

@@ -27,8 +27,9 @@ public AssignedByValParameterMakeLocalCopyQuickFix(Declaration target, Qualified
             _target = target;
             _dialogFactory = dialogFactory;
             _parserState = parserState;
-            _forbiddenNames = GetIdentifierNamesAccessibleToProcedureContext();
-           _localCopyVariableName = ComputeSuggestedName();
+            _forbiddenNames = parserState.DeclarationFinder.GetDeclarationsAccessibleToScope(target, parserState.AllUserDeclarations).Select(n => n.IdentifierName);
+            //_forbiddenNames = GetIdentifierNamesAccessibleToProcedureContext();
+            _localCopyVariableName = ComputeSuggestedName();
         }
 
         public override bool CanFixInModule { get { return false; } }
@@ -113,61 +114,5 @@ private string BuildLocalCopyAssignment()
             return (_target.AsTypeDeclaration is ClassModuleDeclaration ? Tokens.Set + " " : string.Empty) 
                 + _localCopyVariableName + " = " + _target.IdentifierName;
         }
-
-        private IEnumerable<string> GetIdentifierNamesAccessibleToProcedureContext()
-        {
-            return _parserState.AllUserDeclarations
-                .Where(candidateDeclaration => 
-                (
-                        IsDeclarationInTheSameProcedure(candidateDeclaration, _target)
-                    ||  IsDeclarationInTheSameModule(candidateDeclaration, _target)
-                    ||  IsProjectGlobalDeclaration(candidateDeclaration, _target))
-                 ).Select(declaration => declaration.IdentifierName).Distinct();
-        }
-
-        private bool IsDeclarationInTheSameProcedure(Declaration candidateDeclaration, Declaration scopingDeclaration)
-        {
-            return candidateDeclaration.ParentScope == scopingDeclaration.ParentScope;
-        }
-
-        private bool IsDeclarationInTheSameModule(Declaration candidateDeclaration, Declaration scopingDeclaration)
-        {
-            return candidateDeclaration.ComponentName == scopingDeclaration.ComponentName
-                    && !IsDeclaredInMethodOrProperty(candidateDeclaration.ParentDeclaration.Context);
-        }
-
-        private bool IsProjectGlobalDeclaration(Declaration candidateDeclaration, Declaration scopingDeclaration)
-        {
-            return candidateDeclaration.ProjectName == scopingDeclaration.ProjectName
-                && !(candidateDeclaration.ParentScopeDeclaration is ClassModuleDeclaration)
-                && (candidateDeclaration.Accessibility == Accessibility.Public
-                    || ((candidateDeclaration.Accessibility == Accessibility.Implicit)
-                        && (candidateDeclaration.ParentScopeDeclaration is ProceduralModuleDeclaration)));
-        }
-
-        private bool IsDeclaredInMethodOrProperty(RuleContext procedureContext)
-        {
-            if (procedureContext is VBAParser.SubStmtContext)
-            {
-                return true;
-            }
-            else if (procedureContext is VBAParser.FunctionStmtContext)
-            {
-                return true;
-            }
-            else if (procedureContext is VBAParser.PropertyLetStmtContext)
-            {
-                return true;
-            }
-            else if (procedureContext is VBAParser.PropertyGetStmtContext)
-            {
-                return true;
-            }
-            else if (procedureContext is VBAParser.PropertySetStmtContext)
-            {
-                return true;
-            }
-            return false;
-        }
     }
 }

Rubberduck.Parsing/Symbols/DeclarationFinder.cs

@@ -751,11 +751,10 @@ private ConcurrentBag<Declaration> FindEventHandlers(IEnumerable<Declaration> de
         public IEnumerable<Declaration> GetDeclarationsAccessibleToScope(Declaration target, IEnumerable<Declaration> declarations)
         {
             if (target == null) { return Enumerable.Empty<Declaration>(); }
-
             return declarations
                 .Where(candidateDeclaration =>
                 (
-                        IsDeclarationInTheSameProcedure(candidateDeclaration, target)
+                       IsDeclarationInTheSameProcedure(candidateDeclaration, target)
                     || IsDeclarationChildOfTheScope(candidateDeclaration, target)
                     || IsModuleLevelDeclarationOfTheScope(candidateDeclaration, target)
                     || IsProjectGlobalDeclaration(candidateDeclaration, target)
@@ -786,9 +785,22 @@ private bool IsProjectGlobalDeclaration(Declaration candidateDeclaration, Declar
         {
             return candidateDeclaration.ProjectName == scopingDeclaration.ProjectName
                 && !(candidateDeclaration.ParentScopeDeclaration is ClassModuleDeclaration)
-                && (candidateDeclaration.Accessibility == Accessibility.Public
-                    || ((candidateDeclaration.Accessibility == Accessibility.Implicit)
-                        && (candidateDeclaration.ParentScopeDeclaration is ProceduralModuleDeclaration)));
+                && (IsExplicitPublicInOtherModule(candidateDeclaration, scopingDeclaration)
+                || IsImplicitPublicInOtherModule(candidateDeclaration, scopingDeclaration));
+        }
+
+        private bool IsExplicitPublicInOtherModule(Declaration candidateDeclaration, Declaration scopingDeclaration)
+        {
+            return candidateDeclaration.ComponentName != scopingDeclaration.ComponentName
+                    && candidateDeclaration.Accessibility == Accessibility.Public;
+        }
+
+        private bool IsImplicitPublicInOtherModule(Declaration candidateDeclaration, Declaration scopingDeclaration)
+        {
+            return candidateDeclaration.ComponentName != scopingDeclaration.ComponentName
+                        && candidateDeclaration.Accessibility == Accessibility.Implicit
+                        && (candidateDeclaration.ParentScopeDeclaration is ProceduralModuleDeclaration)
+                        && !candidateDeclaration.IdentifierName.StartsWith("Option ");
         }
 
         private bool IsDeclaredWithinMethodOrProperty(RuleContext procedureContextCandidate)

RubberduckTests/Inspections/AssignedByValParameterMakeLocalCopyQuickFixTests.cs

@@ -10,7 +10,6 @@
 using System.Threading;
 using Rubberduck.UI.Refactorings;
 using System.Windows.Forms;
-using Rubberduck.VBEditor.SafeComWrappers;
 
 namespace RubberduckTests.Inspections
 {
@@ -172,74 +171,6 @@ End Function
 
         }
 
-        [TestMethod]
-        [TestCategory("Inspections")]
-        public void AssignedByValParameter_LocalVariableAssignment_RespectsAccessibleDeclarations_InProcedure()
-        {
-            string[] accessibleWithinParentProcedure = { "localVar" };
-            RespectsDeclarationAccessibilityRules(accessibleWithinParentProcedure, "Procedure Scope", true, false);
-        }
-
-        [TestMethod]
-        [TestCategory("Inspections")]
-        public void AssignedByValParameter_LocalVariableAssignment_RespectsAccessibleDeclarations_ModuleScope()
-        {
-            string[] accessibleModuleScope = { "memberString", "KungFooFighting", "FooFight" };
-            RespectsDeclarationAccessibilityRules(accessibleModuleScope, "ModuleScope", true, false);
-        }
-
-        [TestMethod]
-        [TestCategory("Inspections")]
-        public void AssignedByValParameter_LocalVariableAssignment_RespectsAccessibleDeclarations_GlobalScope()
-        {
-            string[] accessibleGlobalScope = { "CantTouchThis", "BigNumber", "DoSomething", "SetFilename" };
-            RespectsDeclarationAccessibilityRules(accessibleGlobalScope, "GlobalScope", true, true);
-        }
-
-        [TestMethod]
-        [TestCategory("Inspections")]
-        public void AssignedByValParameter_LocalVariableAssignment_RespectsAccessibleDeclarations_PublicClassElements()
-        {
-            string[] allowsNamesThatArePublicDeclarationsWithinAnotherClassModule = { "mySecondEggo", "Bar" };
-            RespectsDeclarationAccessibilityRules(allowsNamesThatArePublicDeclarationsWithinAnotherClassModule, "Different Class, Public Member", false, false);
-        }
-
-        private void RespectsDeclarationAccessibilityRules(string[] namesToTest, string scope, bool expectedEqualsInput, bool includeModuleNames)
-        {
-            var firstClassBody = GetRespectsDeclarationsAccessibilityRules_FirstClassBody();
-            var secondClassBody = GetRespectsDeclarationsAccessibilityRules_SecondClassBody();
-            var firstModuleBody = GetRespectsDeclarationsAccessibilityRules_FirstModuleBody();
-            var secondModuleBody = GetRespectsDeclarationsAccessibilityRules_SecondModuleBody();
-
-            var firstClass = new TestComponentSpecification("CFirstClass", firstClassBody, ComponentType.ClassModule);
-            var secondClass = new TestComponentSpecification("CSecondClass", secondClassBody, ComponentType.ClassModule);
-            var firstModule = new TestComponentSpecification("modFirst", firstModuleBody, ComponentType.StandardModule);
-            var secondModule = new TestComponentSpecification("modSecond", secondModuleBody, ComponentType.StandardModule);
-
-
-            var expectedCode = firstClass.Content;
-            TestComponentSpecification[] testComponents = { firstClass, secondClass, firstModule, secondModule };
-            var allTestNames = namesToTest.ToList();
-            if (includeModuleNames)
-            {
-                allTestNames.AddRange(testComponents.Select(n => n.Name));
-            }
-
-            var messagePreface = "Test failed for  " + scope + " identifier: ";
-            foreach (var nameToTest in allTestNames)
-            {
-                var quickFixResult = GetQuickFixResult(nameToTest, firstClass, testComponents);
-                if (expectedEqualsInput)
-                {
-                    Assert.AreEqual(expectedCode, quickFixResult, messagePreface + nameToTest);
-                }
-                else
-                {
-                    Assert.AreNotEqual(expectedCode, quickFixResult, messagePreface + nameToTest);
-                }
-            }
-        }
-
         private string ApplyLocalVariableQuickFixToCodeFragment(string inputCode, string userEnteredName = "")
         {
             var vbe = BuildMockVBEStandardModuleForCodeFragment(inputCode);
@@ -300,182 +231,5 @@ private string GetModuleContent(IVBE vbe, string componentName = "")
                 ? project.VBComponents[componentName].CodeModule : project.VBComponents[0].CodeModule;
             return module.Content();
         }
-
-        internal class TestComponentSpecification
-        {
-            private string _name;
-            private string _content;
-            private ComponentType _componentType;
-            public TestComponentSpecification(string componentName, string componentContent, ComponentType componentType)
-            {
-                _name = componentName;
-                _content = componentContent;
-                _componentType = componentType;
-            }
-
-            public string Name { get { return _name; } }
-            public string Content { get { return _content; } }
-            public ComponentType ModuleType { get { return _componentType; } }
-        }
-
-        private string GetQuickFixResult(string userEnteredNames, TestComponentSpecification resultsComponent, TestComponentSpecification[] testComponents)
-        {
-            var vbe = BuildProject("TestProject", testComponents.ToList());
-            var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object));
-            parser.Parse(new CancellationTokenSource());
-            if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
-
-            var mockDialogFactory = BuildMockDialogFactory(userEnteredNames);
-            var inspection = new AssignedByValParameterInspection(parser.State, mockDialogFactory.Object);
-            var inspectionResults = inspection.GetInspectionResults();
-
-            inspectionResults.First().QuickFixes.Single(s => s is AssignedByValParameterMakeLocalCopyQuickFix).Fix();
-
-            return GetModuleContent(vbe.Object, resultsComponent.Name);
-        }
-
-        private Mock<IVBE> BuildProject(string projectName, List<TestComponentSpecification> testComponents)
-        {
-            var builder = new MockVbeBuilder();
-            var enclosingProjectBuilder = builder.ProjectBuilder(projectName, ProjectProtection.Unprotected);
-
-            testComponents.ForEach(c => enclosingProjectBuilder.AddComponent(c.Name, c.ModuleType, c.Content));
-            var enclosingProject = enclosingProjectBuilder.Build();
-            builder.AddProject(enclosingProject);
-            return builder.Build();
-        }
-
-        private string GetNameAlreadyAccessibleWithinClass_FirstClassBody()
-        {
-            return
-                @"
-Private memberString As String
-Private memberLong As Long
-
-Private Sub Class_Initialize()
-    memberLong = 6
-    memberString = ""No Value""
-End Sub
-
-Public Sub Foo(ByVal arg1 As String, theSecondArg As Long)
-    Let arg1 = ""test""
-End Sub
-
-Private Sub FooFight(ByRef arg1 As String)
-    xArg1 = 6
-    Let arg1 = ""test""
-End Sub
-";
-
-        }
-        private string GetRespectsDeclarationsAccessibilityRules_FirstClassBody()
-        {
-            return 
-@"
-Private memberString As String
-Private memberLong As Long
-Private myEggo as String
-
-Public Sub Foo(ByVal arg1 As String)
-    Dim localVar as Long
-    localVar = 7
-    Let arg1 = ""test""
-    memberString = arg1 & ""Foo""
-End Sub
-
-Public Function KungFooFighting(ByRef arg1 As String, theSecondArg As Long) As String
-    Let arg1 = ""test""
-    Dim result As String
-    result = arg1 & theSecondArg
-    KungFooFighting = result
-End Function
-
-Property Let GoMyEggo(newValue As String)
-    myEggo = newValue
-End Property
-
-Property Get GoMyEggo()
-    GoMyEggo = myEggo
-End Property
-
-Private Sub FooFight(ByRef arg1 As String)
-    xArg1 = 6
-    Let arg1 = ""test""
-End Sub
-";
-        }
-        private string GetRespectsDeclarationsAccessibilityRules_SecondClassBody()
-        {
-            return
-@"
-Private memberString As String
-Private memberLong As Long
-Public mySecondEggo as String
-
-
-Public Sub Foo2( arg1 As String, theSecondArg As Long)
-    Let arg1 = ""test""
-    memberString = arg1 & ""Foo""
-End Sub
-
-Public Function KungFooFighting(ByRef arg1 As String, theSecondArg As Long) As String
-    Let arg1 = ""test""
-    Dim result As String
-    result = arg1 & theSecondArg
-    KungFooFighting = result
-End Function
-
-Property Let GoMyOtherEggo(newValue As String)
-    mySecondEggo = newValue
-End Property
-
-Property Get GoMyOtherEggo()
-    GoMyOtherEggo = mySecondEggo
-End Property
-
-Private Sub FooFighters(ByRef arg1 As String)
-    xArg1 = 6
-    Let arg1 = ""test""
-End Sub
-
-Sub Bar()
-    Dim st As String
-    st = ""Test""
-    Dim v As Long
-    v = 5
-    result = KungFooFighting(st, v)
-End Sub
-";
-        }
-        private string GetRespectsDeclarationsAccessibilityRules_FirstModuleBody()
-        {
-            return
-@"
-Option Explicit
-
-
-Public Const CantTouchThis As String = ""Can't Touch this""
-Public THE_FILENAME As String
-
-Sub SetFilename(filename As String)
-    THE_FILENAME = filename
-End Sub
-";
-        }
-        private string GetRespectsDeclarationsAccessibilityRules_SecondModuleBody()
-        {
-            return
-@"
-Option Explicit
-
-
-Public BigNumber as Long
-Public ShortStory As String
-
-Public Sub DoSomething(filename As String)
-    ShortStory = filename
-End Sub
-";
-        }
     }
 }