NoAsyncRunSynchronouslyInLibrary: refactoring

Use new function `howLikelyProjectIsTestOrLibrary` instead of
`isInTestProject` and made unit tests for this function.

Author: webwarrior-ws

src/FSharpLint.Core/FSharpLint.Core.fsproj

@@ -69,7 +69,6 @@
     <Compile Include="Rules\Smells\RaiseWithTooManyArguments\InvalidArgWithTwoArguments.fs" />
     <Compile Include="Rules\Smells\RaiseWithTooManyArguments\FailwithfWithArgumentsMatchingFormatString.fs" />
     <Compile Include="Rules\Conventions\FailwithBadUsage.fs" />
-    <Compile Include="Rules\Conventions\NoAsyncRunSynchronouslyInLibrary.fs" />
     <Compile Include="Rules\Conventions\SourceLength\SourceLengthHelper.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInLambdaFunction.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInMatchLambdaFunction.fs" />
@@ -123,6 +122,7 @@
     <Compile Include="Rules\Formatting\Typography\MaxCharactersOnLine.fs" />
     <Compile Include="Rules\Formatting\Typography\TrailingWhitespaceOnLine.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInFile.fs" />
+    <Compile Include="Rules\Conventions\NoAsyncRunSynchronouslyInLibrary.fs" />
     <Compile Include="Rules\Formatting\Typography\TrailingNewLineInFile.fs" />
     <Compile Include="Rules\Formatting\Typography\NoTabCharacters.fs" />
     <Compile Include="Rules\Conventions\IndexerAccessorStyleConsistency.fs" />

src/FSharpLint.Core/Rules/Conventions/NoAsyncRunSynchronouslyInLibrary.fs

@@ -10,6 +10,11 @@ open FSharpLint.Framework.Ast
 open FSharpLint.Framework.Rules
 open FSharpLint.Framework.Utilities
 
+type LibraryHeuristicResultByProjectName =
+    | Likely
+    | Unlikely
+    | Uncertain
+
 let hasEntryPoint (checkFileResults: FSharpCheckFileResults) (maybeProjectCheckResults: FSharpCheckProjectResults option) =
     let hasEntryPointInTheSameFile =
         match checkFileResults.ImplementationFile with
@@ -26,15 +31,16 @@ let hasEntryPoint (checkFileResults: FSharpCheckFileResults) (maybeProjectCheckR
 
 let excludedProjectNames = [ "test"; "console" ]
 
-let isInTestProject (checkFileResults: FSharpCheckFileResults) =
-    let namespaceIncludesTest =
-        match checkFileResults.ImplementationFile with
-        | Some implFile -> 
-            excludedProjectNames |> List.exists (fun name -> implFile.QualifiedName.ToLowerInvariant().Contains name)
-        | None -> false
-    let projectFileInfo = System.IO.FileInfo checkFileResults.ProjectContext.ProjectOptions.ProjectFileName
-    namespaceIncludesTest 
-    || excludedProjectNames |> List.exists (fun name -> projectFileInfo.Name.ToLowerInvariant().Contains name)
+let howLikelyProjectIsLibrary (projectFileName: string): LibraryHeuristicResultByProjectName =
+    let nameSegments = Helper.Naming.QuickFixes.splitByCaseChange projectFileName
+    if nameSegments |> Seq.contains "Lib" then
+        Likely
+    elif excludedProjectNames |> List.exists (fun name -> projectFileName.ToLowerInvariant().Contains name) then
+        Unlikely
+    elif projectFileName.ToLowerInvariant().EndsWith "lib" then
+        Likely
+    else
+        Uncertain
 
 let extractAttributeNames (attributes: SynAttributes) =
     seq {
@@ -94,15 +100,19 @@ let isInObsoleteMethodOrFunction parents =
 
 let checkIfInLibrary (args: AstNodeRuleParams) (range: range) : array<WarningDetails> =
     let ruleNotApplicable =
+        isInObsoleteMethodOrFunction (args.GetParents args.NodeIndex)
+        ||
         match args.CheckInfo with
         | Some checkFileResults ->
-            hasEntryPoint checkFileResults args.ProjectCheckInfo
-            || isInTestProject checkFileResults
-            || isInObsoleteMethodOrFunction (args.GetParents args.NodeIndex)
-            || isInTheSameModuleAsTest args.SyntaxArray args.ProjectCheckInfo
+            let projectFileName = System.IO.FileInfo(checkFileResults.ProjectContext.ProjectOptions.ProjectFileName).Name
+            match howLikelyProjectIsLibrary projectFileName with
+            | Likely -> false
+            | Unlikely -> true
+            | Uncertain ->
+                hasEntryPoint checkFileResults args.ProjectCheckInfo
+                || isInTheSameModuleAsTest args.SyntaxArray args.ProjectCheckInfo
         | None ->
-            isInObsoleteMethodOrFunction (args.GetParents args.NodeIndex)
-            || isInTheSameModuleAsTest args.SyntaxArray args.ProjectCheckInfo
+            isInTheSameModuleAsTest args.SyntaxArray args.ProjectCheckInfo
 
     if ruleNotApplicable then
         Array.empty

tests/FSharpLint.Core.Tests/Rules/Conventions/NoAsyncRunSynchronouslyInLibrary.fs

@@ -3,6 +3,7 @@
 open NUnit.Framework
 open FSharpLint.Framework.Rules
 open FSharpLint.Rules
+open FSharpLint.Rules.NoAsyncRunSynchronouslyInLibrary
 
 [<TestFixture>]
 type TestNoAsyncRunSynchronouslyInLibrary() =
@@ -130,3 +131,40 @@ let Foo() =
     |> Async.RunSynchronously""")
 
         this.AssertNoWarnings()
+
+[<TestFixture>]
+type TestNoAsyncRunSynchronouslyInLibraryHeuristic() =
+    [<Test>]
+    member this.``Unlikely to be library if contains "test" in name``() =
+        Assert.AreEqual(
+            howLikelyProjectIsLibrary "TestProject",
+            LibraryHeuristicResultByProjectName.Unlikely
+        )
+
+    [<Test>]
+    member this.``Unlikely to be library if contains "console" in name``() =
+        Assert.AreEqual(
+            howLikelyProjectIsLibrary "FooConsole",
+            LibraryHeuristicResultByProjectName.Unlikely
+        )
+
+    [<Test>]
+    member this.``Likely to be library if contains Contains "Lib" as a PascalCase segment``() =
+        Assert.AreEqual(
+            howLikelyProjectIsLibrary "LibFoo",
+            LibraryHeuristicResultByProjectName.Likely
+        )
+
+    [<Test>]
+    member this.``Uncertain if contains contains "Lib" but not as a PascalCase segment``() =
+        Assert.AreEqual(
+            howLikelyProjectIsLibrary "LibreOfficeProg",
+            LibraryHeuristicResultByProjectName.Uncertain
+        )
+
+    [<Test>]
+    member this.``Likely to be library if contains ends with "lib" (case-insensitive)``() =
+        Assert.AreEqual(
+            howLikelyProjectIsLibrary "FooLib",
+            LibraryHeuristicResultByProjectName.Likely
+        )