Compare-NET-Objects/ExcludeLogic.cs

﻿
using System;
using System.Linq;
using System.Reflection;

namespace KellermanSoftware.CompareNetObjects
{
    /// <summary>
    /// Exclude types depending upon the configuration
    /// </summary>
    public static class ExcludeLogic 
    {
        /// <summary>
        /// Exclude a member of an expando object
        /// </summary>
        /// <param name="config"></param>
        /// <param name="name"></param>
        /// <param name="type"></param>
        /// <returns></returns>
        public static bool ShouldExcludeDynamicMember(ComparisonConfig config, string name, Type type)
        {
            //Only compare specific member names
            if (config.MembersToIncludeSet.Count > 0 && !config.MembersToIncludeSet.Contains(name))
                return true;

            if (config.MembersToIgnoreSet.Count > 0)
            {
                //Ignore by type.membername
                if (type != null
                    && config.MembersToIgnoreSet.Contains(type.Name + "." + name))
                    return true;

                //Ignore exactly by the name of the member
                if (config.MembersToIgnoreSet.Count > 0 && config.MembersToIgnoreSet.Contains(name))
                    return true;

                //Wildcard member
                if (config.HasWildcardMembersToExclude() && ExcludedByWildcard(config, name))
                    return true;
            }

            return false;
        }

        /// <summary>
        /// Returns true if the property or field should be excluded
        /// </summary>
        /// <param name="config"></param>
        /// <param name="info"></param>
        /// <param name="objectType"></param>
        /// <returns></returns>
        public static bool ShouldExcludeMember(ComparisonConfig config, MemberInfo info, Type objectType)
        {
            //Only compare specific member names
            if (config.MembersToIncludeSet.Count > 0 && !config.MembersToIncludeSet.Contains(info.Name))
                return true;
            
            if (config.MembersToIgnoreSet.Count > 0)
            {
				//Ignore by objecttype.membername
	            if (config.MembersToIgnoreSet.Contains(objectType.Name + "." + info.Name))
		            return true;

				//Ignore by declaringType.membername
				if (info.DeclaringType != null
                    && config.MembersToIgnoreSet.Contains(info.DeclaringType.Name + "." + info.Name))
                    return true;

                //Ignore exactly by the name of the member
                if (config.MembersToIgnoreSet.Count > 0 && config.MembersToIgnoreSet.Contains(info.Name))
                    return true;

                //Wildcard member
                if (config.HasWildcardMembersToExclude() && ExcludedByWildcard(config, info.Name))
                    return true;
            }


            if (IgnoredByAttribute(config, info))
                return true;

            if (IgnoredByLackOfAttribute(config, info))
                return true;

            return false;
        }

        /// <summary>
        /// Returns true if the property or field should be exluded by wilcard
        /// </summary>
        /// <param name="config"></param>
        /// <param name="name"></param>
        /// <returns></returns>
        public static bool ExcludedByWildcard(ComparisonConfig config, string name)
        {
            foreach (var memberWildcard in config.MembersToIgnore)
            {
                string small;

                if (memberWildcard.StartsWith("*") && memberWildcard.EndsWith("*") && memberWildcard.Length > 2)
                {
                    small = memberWildcard.Substring(1, memberWildcard.Length - 2);
                    if (name.Contains(small))
                    {
                        return true;
                    }
                }
                else if (memberWildcard.StartsWith("*")
                         && memberWildcard.Length >= 2
                         && name.EndsWith(memberWildcard.Substring(1)))
                {
                    return true;
                }
                else if (memberWildcard.EndsWith("*")
                         && memberWildcard.Length >= 2
                         && name.StartsWith(memberWildcard.Substring(0, memberWildcard.Length - 2)))
                {
                    return true;
                }
            }

            return false;
        }

        /// <summary>
        /// Check if the class should be exluded by Attribute
        /// </summary>
        /// <param name="config"></param>
        /// <param name="t1"></param>
        /// <param name="t2"></param>
        /// <returns></returns>
        public static bool ShouldExcludeClass(ComparisonConfig config, Type t1, Type t2)
        {
            //Only include specific class types
            if (config.ClassTypesToIncludeSet.Count > 0
                && (!config.ClassTypesToIncludeSet.Contains(t1)
                    || !config.ClassTypesToIncludeSet.Contains(t2)))
            {
                return true;
            }

            //Ignore specific class types
            if (config.ClassTypesToIgnoreSet.Count > 0
                && (config.ClassTypesToIgnoreSet.Contains(t1)
                    || config.ClassTypesToIgnoreSet.Contains(t2)))
            {
                return true;
            }

            //The class is ignored by an attribute
            if (IgnoredByAttribute(config, t1.GetTypeInfo()) || IgnoredByAttribute(config, t2.GetTypeInfo()))
                return true;

            return false;
        }

        /// <summary>
        /// Check if the class type should be excluded based on the configuration
        /// </summary>
        /// <param name="config"></param>
        /// <param name="t1"></param>
        /// <param name="t2"></param>
        /// <returns></returns>
        public static bool ShouldExcludeType(ComparisonConfig config, Type t1, Type t2)
        {
            //Only include specific types
            if (config.TypesToIncludeSet.Count > 0
                && (!config.TypesToIncludeSet.Contains(t1)
                    || !config.TypesToIncludeSet.Contains(t2)))
            {
                return true;
            }

            //Ignore specific types
            if (config.TypesToIgnoreSet.Count > 0
                && (config.TypesToIgnoreSet.Contains(t1)
                    || config.TypesToIgnoreSet.Contains(t2)))
            {
                return true;
            }

            return false;
        }

        /// <summary>
        /// Check if any type has attributes that should be bypassed
        /// </summary>
        /// <returns></returns>	
        public static bool IgnoredByAttribute(ComparisonConfig config, MemberInfo info)
        {
            //Prevent loading attributes when AttributesToIgnore is empty
            if (config.AttributesToIgnoreSet.Count == 0)
            {
                return false;
            }
            
            var attributes = info.GetCustomAttributes(true);

            return attributes.Any(a => config.AttributesToIgnoreSet.Contains(a.GetType()));
        }

        /// <summary>
        /// Check if any type lacks attributes that should be required
        /// </summary>
        /// <returns></returns>	
        public static bool IgnoredByLackOfAttribute(ComparisonConfig config, MemberInfo info)
        {
            //Prevent loading attributes when RequiredAttributesToCompare is empty
            if (config.RequiredAttributesToCompareSet.Count == 0)
            {
                return false;
            }

            var attributes = info.GetCustomAttributes(true);

            return !attributes.Any(a => config.RequiredAttributesToCompareSet.Contains(a.GetType()));
        }

    }
}