HasValidPreviousVersionAttribute.cs

/*
 * This file is part of the Buildings and Habitats object Model (BHoM)
 * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
 *
 * Each contributor holds copyright over their respective contributions.
 * The project versioning (Git) records all such contribution source information.
 *                                           
 *                                                                              
 * The BHoM is free software: you can redistribute it and/or modify         
 * it under the terms of the GNU Lesser General Public License as published by  
 * the Free Software Foundation, either version 3.0 of the License, or          
 * (at your option) any later version.                                          
 *                                                                              
 * The BHoM is distributed in the hope that it will be useful,              
 * but WITHOUT ANY WARRANTY; without even the implied warranty of               
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
 * GNU Lesser General Public License for more details.                          
 *                                                                            
 * You should have received a copy of the GNU Lesser General Public License     
 * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
 */

using BH.oM.Test;
using BH.oM.Test.CodeCompliance;
using BH.oM.Test.CodeCompliance.Attributes;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using System.Collections.Generic;

namespace BH.Engine.Test.CodeCompliance.Checks
{
    public static partial class Query
    {
        [Message("Methods implementing a PreviousVersion versioning attribute should implement it for the current version of development. Methods with PreviousVersion attributes from previous milestones should have those attributes removed", "HasValidPreviousVersionAttribute")]
        [ErrorLevel(TestStatus.Error)]
        [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$")]
        [Path(@"([a-zA-Z0-9]+)_Engine\\Objects\\.*\.cs$", false)]
        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$", false)]     //NUnit style projects
        [Path(@"([a-zA-Z0-9]+)_Test\\.*\.cs$", false)]      //Verification projects
        [IsPublic()]
        [ComplianceType("documentation")]
        public static Span HasValidPreviousVersionAttribute(this MethodDeclarationSyntax node)
        {
            if (node == null || node.IsDeprecated() || !node.HasAttribute("PreviousVersion"))
                return null; //Don't care about deprecated methods or if the method does not have the attribute at all

            List<AttributeSyntax> previousVersionAttributes = node.GetAttributes("PreviousVersion");

            string currentVersion = BH.Engine.Test.CodeCompliance.Query.CurrentAssemblyFileVersion();

            foreach (AttributeSyntax a in previousVersionAttributes)
            {
                string givenVersion = a.ArgumentList.Arguments[0].Expression.GetFirstToken().Value.ToString();

                if (givenVersion != currentVersion)
                    return node.Identifier.Span.ToSpan();
            }

            return null; //All ok
        }

        [Message("Methods implementing a PreviousVersion versioning attribute should implement it for the current version of development. Methods with PreviousVersion attributes from previous milestones should have those attributes removed", "HasValidPreviousVersionAttribute")]
        [ErrorLevel(TestStatus.Error)]
        [Path(@"([a-zA-Z0-9]+)_Adapter\\.*\.cs$")]
        [IsPublic()]
        [ComplianceType("documentation")]
        public static Span HasValidPreviousVersionAttribute(this ConstructorDeclarationSyntax node)
        {
            if (node == null || node.IsDeprecated() || !node.HasAttribute("PreviousVersion"))
                return null; //Don't care about deprecated methods or if the method does not have the attribute at all

            List<AttributeSyntax> previousVersionAttributes = node.GetAttributes("PreviousVersion");

            string currentVersion = BH.Engine.Test.CodeCompliance.Query.CurrentAssemblyFileVersion();

            foreach (AttributeSyntax a in previousVersionAttributes)
            {
                string givenVersion = a.ArgumentList.Arguments[0].Expression.GetFirstToken().Value.ToString();

                if (givenVersion != currentVersion)
                    return node.Identifier.Span.ToSpan();
            }

            return null; //All ok
        }
    }
}