< Summary

Information
Class: MyNet.Observable.Metadata.Generator.ObservableObjectSetterAnalyzer
Assembly: MyNet.Observable.Metadata.Generator
File(s): https://raw.githubusercontent.com/sandre58/MyNet/5aaaab311aa14541478b9e402357d98b657a23e4/src/MyNet.Observable.Metadata.Generator/ObservableObjectSetterAnalyzer.cs
Tag: 342_31701152804
Line coverage
81%
Covered lines: 62
Uncovered lines: 14
Coverable lines: 76
Total lines: 154
Line coverage: 81.5%
Branch coverage
58%
Covered branches: 36
Total branches: 62
Branch coverage: 58%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.cctor()100%11100%
.ctor()100%11100%
Initialize(...)100%11100%
AnalyzeSetter(...)53.33%593068%
InheritsFromObservableObject(...)66.66%7671.42%
UsesSetProperty(...)100%11100%
IsSetPropertyInvocation(...)100%44100%
UsesManualChangingPipeline(...)100%11100%
AssignsBackingMember(...)66.66%141277.77%
IsBackingFieldForProperty(...)50%7671.42%
IsGeneratedFile(...)25%44100%

File(s)

https://raw.githubusercontent.com/sandre58/MyNet/5aaaab311aa14541478b9e402357d98b657a23e4/src/MyNet.Observable.Metadata.Generator/ObservableObjectSetterAnalyzer.cs

#LineLine coverage
 1// -----------------------------------------------------------------------
 2// <copyright file="ObservableObjectSetterAnalyzer.cs" company="Stéphane ANDRE">
 3// Copyright (c) Stéphane ANDRE. All rights reserved.
 4// </copyright>
 5// -----------------------------------------------------------------------
 6
 7using System.Collections.Immutable;
 8using System.Linq;
 9using Microsoft.CodeAnalysis;
 10using Microsoft.CodeAnalysis.CSharp;
 11using Microsoft.CodeAnalysis.CSharp.Syntax;
 12using Microsoft.CodeAnalysis.Diagnostics;
 13
 14namespace MyNet.Observable.Metadata.Generator;
 15
 16[DiagnosticAnalyzer(LanguageNames.CSharp)]
 17public sealed class ObservableObjectSetterAnalyzer : DiagnosticAnalyzer
 18{
 19    private const string ObservableObjectMetadataName = "MyNet.Observable.ObservableObject";
 20
 321    private static readonly DiagnosticDescriptor SetterMustUseSetPropertyDescriptor = new(
 322        id: "MNETOBS004",
 323        title: "Observable property setter must use SetProperty or the changing pipeline",
 324        messageFormat: "Property setter for '{0}' should call SetProperty(ref field, value) or guard assignment with OnP
 325        category: "MyNet.Observable.Usage",
 326        defaultSeverity: DiagnosticSeverity.Warning,
 327        isEnabledByDefault: true,
 328        description: "Assigning a backing field without SetProperty bypasses cancellation, behaviors, and coalesced susp
 29
 30    /// <inheritdoc />
 31    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } =
 932        [SetterMustUseSetPropertyDescriptor];
 33
 34    /// <inheritdoc />
 35    public override void Initialize(AnalysisContext context)
 36    {
 937        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
 938        context.EnableConcurrentExecution();
 939        context.RegisterSyntaxNodeAction(AnalyzeSetter, SyntaxKind.SetAccessorDeclaration);
 940    }
 41
 42    private static void AnalyzeSetter(SyntaxNodeAnalysisContext context)
 43    {
 944        if (context.Node is not AccessorDeclarationSyntax setter)
 045            return;
 46
 947        if (setter.Body is null && setter.ExpressionBody is null)
 048            return;
 49
 950        if (IsGeneratedFile(setter.SyntaxTree.FilePath))
 051            return;
 52
 953        var propertyDeclaration = setter.FirstAncestorOrSelf<PropertyDeclarationSyntax>();
 954        if (propertyDeclaration is null)
 055            return;
 56
 957        if (context.SemanticModel.GetDeclaredSymbol(propertyDeclaration, context.CancellationToken) is not { } propertyS
 058            return;
 59
 960        if (propertySymbol.IsIndexer)
 061            return;
 62
 963        var containingType = propertySymbol.ContainingType;
 964        if (!InheritsFromObservableObject(containingType, context.Compilation))
 065            return;
 66
 967        if (UsesSetProperty(setter, context.SemanticModel))
 368            return;
 69
 670        if (UsesManualChangingPipeline(setter, context.SemanticModel))
 371            return;
 72
 373        if (!AssignsBackingMember(setter, propertySymbol, context.SemanticModel))
 074            return;
 75
 376        var location = setter.Body?.OpenBraceToken.GetLocation() ?? setter.ExpressionBody?.GetLocation() ?? setter.GetLo
 377        context.ReportDiagnostic(Diagnostic.Create(SetterMustUseSetPropertyDescriptor, location, propertySymbol.Name));
 378    }
 79
 80    private static bool InheritsFromObservableObject(INamedTypeSymbol type, Compilation compilation)
 81    {
 982        var observableObject = compilation.GetTypeByMetadataName(ObservableObjectMetadataName);
 983        if (observableObject is null)
 084            return false;
 85
 3686        for (var current = type; current is not null; current = current.BaseType)
 87        {
 1888            if (SymbolEqualityComparer.Default.Equals(current, observableObject))
 989                return true;
 90        }
 91
 092        return false;
 93    }
 94
 95    private static bool UsesSetProperty(AccessorDeclarationSyntax setter, SemanticModel semanticModel)
 996        => setter.DescendantNodes()
 997            .OfType<InvocationExpressionSyntax>()
 998            .Any(invocation => IsSetPropertyInvocation(invocation, semanticModel));
 99
 100    private static bool IsSetPropertyInvocation(InvocationExpressionSyntax invocation, SemanticModel semanticModel)
 101    {
 21102        var symbol = semanticModel.GetSymbolInfo(invocation).Symbol as IMethodSymbol;
 21103        return symbol is { Name: "SetProperty" }
 21104               && symbol.ContainingType.ToDisplayString() == ObservableObjectMetadataName;
 105    }
 106
 107    private static bool UsesManualChangingPipeline(AccessorDeclarationSyntax setter, SemanticModel semanticModel)
 6108        => setter.DescendantNodes()
 6109            .OfType<InvocationExpressionSyntax>()
 6110            .Any(invocation =>
 6111            {
 6112                var name = semanticModel.GetSymbolInfo(invocation).Symbol?.Name;
 6113                return name is "OnPropertyChanging" or "ProcessPropertyChanging";
 6114            });
 115
 116    private static bool AssignsBackingMember(AccessorDeclarationSyntax setter, IPropertySymbol property, SemanticModel s
 117    {
 9118        foreach (var assignment in setter.DescendantNodes().OfType<AssignmentExpressionSyntax>())
 119        {
 3120            if (assignment.Kind() != SyntaxKind.SimpleAssignmentExpression)
 121                continue;
 122
 3123            var assignedSymbol = semanticModel.GetSymbolInfo(assignment.Left).Symbol;
 3124            switch (assignedSymbol)
 125            {
 3126                case IFieldSymbol field when IsBackingFieldForProperty(field, property):
 127                case IPropertySymbol assignedProperty
 0128                    when SymbolEqualityComparer.Default.Equals(assignedProperty, property):
 3129                    return true;
 130            }
 131        }
 132
 0133        return false;
 3134    }
 135
 136    private static bool IsBackingFieldForProperty(IFieldSymbol field, IPropertySymbol property)
 137    {
 3138        if (field.AssociatedSymbol is not null
 3139            && SymbolEqualityComparer.Default.Equals(field.AssociatedSymbol, property))
 140        {
 0141            return true;
 142        }
 143
 3144        var fieldName = field.Name.TrimStart('_');
 3145        if (fieldName.StartsWith("m_", System.StringComparison.Ordinal))
 0146            fieldName = fieldName.Substring(2);
 147
 3148        return string.Equals(fieldName, property.Name, System.StringComparison.OrdinalIgnoreCase);
 149    }
 150
 9151    private static bool IsGeneratedFile(string? filePath) => !string.IsNullOrEmpty(filePath) && (filePath!.EndsWith(".g.
 9152                                                                                                 || filePath.IndexOf("Ge
 153}
 154