Merge pull request #621 from Acumatica/feature/ATR-728-dev-graph-declaration-diagnostic

Feature/atr 728 dev graph declaration diagnostic

Author: SENya1990

docs/Summary.md

@@ -112,3 +112,4 @@ Acuminator does not perform static analysis of projects whose names contain `Tes
 | [PX1102](diagnostics/PX1102.md) | The additional delegate parameter of the method with the `PXOverride` attribute must have a name conforming Acumatica naming conventions. | Warning | Available |
 | [PX1110](diagnostics/PX1110.md) | The DAC has a DAC field with the `PXDBLocalizableString` attribute. Therefore, this DAC must declare a `NoteID` DAC field. | Error | Available |
 | [PX1111](diagnostics/PX1111.md) | The primary DAC of a processing view must contain the `NoteID` field. | Error | Unavailable |
+| [PX1112](diagnostics/PX1112.md) | Graphs and graph extensions with generic type parameters must be abstract. | Error | Available |

docs/diagnostics/PX1112.md

@@ -0,0 +1,63 @@
+# PX1112
+This document describes the PX1112 diagnostic.
+
+## Summary
+
+| Code   | Short Description                                                          | Type  | Code Fix  | 
+| ------ | -------------------------------------------------------------------------- | ----- | --------- | 
+| PX1112 | Graphs and graph extensions with generic type parameters must be abstract. | Error | Available |
+
+## Diagnostic Description
+
+The PX1112 diagnostic detects and reports non-abstract graphs and graph extensions with generic type parameters. 
+
+In Acumatica Framework, graphs and graph extensions with generic type parameters must be declared as `abstract`. This requirement ensures proper inheritance and instantiation patterns within the Acumatica Framework.
+Generic graphs and graph extensions serve as base classes that define common functionality to be shared across multiple derived implementations. 
+Since they contain unresolved type parameters, they cannot be directly instantiated by the framework. The `abstract` modifier makes this constraint explicit, keeps graph extensions relationships consistent, 
+and prevents accidental instantiation attempts.
+
+## Code Fix Behavior
+
+The PX1112 code fix automatically adds the `abstract` modifier to the graph or graph extension declaration.
+If the class has a `sealed` modifier, it is automatically removed (since `abstract` and `sealed` are mutually exclusive).
+
+## Example of Incorrect Code
+
+```C#
+using PX.Data;
+
+namespace Examples
+{
+	// Generic graph without abstract modifier - reports PX1112
+	public class GenericOrderGraph<TOrderDac> : PXGraph<GenericOrderGraph<TOrderDac>>
+	where TOrderDac : PXBqlTable, IBqlTable, new()
+	{
+		public PXSelect<TOrderDac> Orders = null!;
+		
+		// Business logic
+	}
+}
+```
+
+## Example of Correct Code after Code Fix
+
+```C#
+using PX.Data;
+
+namespace Examples
+{
+	public abstract class GenericOrderGraph<TOrderDac> : PXGraph<GenericOrderGraph<TOrderDac>>
+	where TOrderDac : PXBqlTable, IBqlTable, new()
+	{
+		public PXSelect<TOrderDac> Orders = null!;
+		
+		// Business logic
+	}
+}
+```
+
+## Related Articles
+
+ - [Business Logic Implementation](https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=b02bd27f-3e86-4210-9e0f-c0df7aa701d9)
+ - [Use of Generic Graph Extensions by the System](https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=eece8358-f6ea-47e8-899a-d466eccbc14e)
+ - [Reusing Business Logic](https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=76b8c160-89bd-4501-9f9f-1dabc648d417)

src/Acuminator/Acuminator.Analyzers/DiagnosticsShortName.Designer.cs

@@ -462,4 +462,7 @@
   <data name="PX1111" xml:space="preserve">
     <value>MainDacOfProcessingViewMustContainNoteIdField</value>
   </data>
+  <data name="PX1112" xml:space="preserve">
+    <value>GenericNonAbstractGraphOrGraphExtension</value>
+  </data>
 </root>

src/Acuminator/Acuminator.Analyzers/DiagnosticsShortName.resx

@@ -869,6 +869,12 @@ Reason: {2}</value>
   <data name="PX1111TitleFormat" xml:space="preserve">
     <value>The primary DAC "{0}" of the processing view "{1}" must contain the "NoteID" field</value>
   </data>
+  <data name="PX1112Fix" xml:space="preserve">
+    <value>Make the type abstract</value>
+  </data>
+  <data name="PX1112Title" xml:space="preserve">
+    <value>Graphs and graph extensions with generic type parameters must be abstract</value>
+  </data>
   <data name="SuppressDiagnosticGroupCodeActionTitle" xml:space="preserve">
     <value>Suppress the {0} diagnostic with Acuminator</value>
   </data>

src/Acuminator/Acuminator.Analyzers/Resources.Designer.cs

@@ -0,0 +1,52 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
+using System.Threading;
+
+using Acuminator.Analyzers.StaticAnalysis.PXGraph;
+using Acuminator.Utilities.Common;
+using Acuminator.Utilities.DiagnosticSuppression;
+using Acuminator.Utilities.Roslyn.Semantic;
+using Acuminator.Utilities.Roslyn.Semantic.PXGraph;
+
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+using Microsoft.CodeAnalysis.Diagnostics;
+
+namespace Acuminator.Analyzers.StaticAnalysis.DeclarationAnalysisGraphAndDac
+{
+	public class GraphAndGraphExtensionDeclarationAnalyzer : PXGraphAggregatedAnalyzerBase
+	{
+		public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } =
+			ImmutableArray.Create
+			(
+				Descriptors.PX1112_GenericGraphsAndGraphExtensionsMustBeAbstract
+			);
+
+		public override void Analyze(SymbolAnalysisContext context, PXContext pxContext, PXGraphEventSemanticModel graphOrGraphExt)
+		{
+			context.CancellationToken.ThrowIfCancellationRequested();
+
+			CheckIfGraphOrGraphExtensionIsGenericNonAbstract(context, pxContext, graphOrGraphExt);
+		}
+
+		protected virtual void CheckIfGraphOrGraphExtensionIsGenericNonAbstract(SymbolAnalysisContext context, PXContext pxContext,
+																				PXGraphEventSemanticModel graphOrGraphExt)
+		{
+			if (graphOrGraphExt.Symbol.IsAbstract || !graphOrGraphExt.Symbol.IsGenericType ||
+				graphOrGraphExt.Symbol.TypeParameters.IsDefaultOrEmpty || graphOrGraphExt.Node == null)
+			{
+				return;
+			}
+			
+			var location = graphOrGraphExt.Node.Identifier.GetLocation().NullIfLocationKindIsNone() ??
+						   graphOrGraphExt.Node.GetLocation();
+			var diagnostic = Diagnostic.Create(Descriptors.PX1112_GenericGraphsAndGraphExtensionsMustBeAbstract, location,
+												graphOrGraphExt.Symbol.Name);
+
+			context.ReportDiagnosticWithSuppressionCheck(diagnostic, pxContext.CodeAnalysisSettings);
+		}
+	}
+}