Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common parts extracted + more changes for #984 #987

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 113 additions & 0 deletions YamlDotNet/Serialization/TypeInspectors/PropertiesTypeInspector.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
// This file is part of YamlDotNet - A .NET library for YAML.
// Copyright (c) Antoine Aubry and contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
// of the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;
using YamlDotNet.Core;

namespace YamlDotNet.Serialization.TypeInspectors
{
public class PropertiesTypeInspector : ReflectionTypeInspector
{
private readonly ITypeResolver typeResolver;
private readonly bool includeNonPublicProperties;

public PropertiesTypeInspector(ITypeResolver typeResolver)
: this(typeResolver, false)
{
}

public PropertiesTypeInspector(ITypeResolver typeResolver, bool includeNonPublicProperties)
{
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
this.includeNonPublicProperties = includeNonPublicProperties;
}

protected virtual bool IsValidProperty(PropertyInfo property)
=> true;

protected virtual ReflectionPropertyDescriptor CreateProperty(PropertyInfo property)
=> new ReflectionPropertyDescriptor(property, typeResolver);

public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object? container)
{
return type
.GetProperties(includeNonPublicProperties)
.Where(IsValidProperty)
.Select(p => (IPropertyDescriptor)CreateProperty(p));
}

protected class ReflectionPropertyDescriptor : IPropertyDescriptor
{
private readonly PropertyInfo propertyInfo;
private readonly ITypeResolver typeResolver;

public ReflectionPropertyDescriptor(PropertyInfo propertyInfo, ITypeResolver typeResolver)
{
this.propertyInfo = propertyInfo ?? throw new ArgumentNullException(nameof(propertyInfo));
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
ScalarStyle = ScalarStyle.Any;
var converterAttribute = propertyInfo.GetCustomAttribute<YamlConverterAttribute>();
if (converterAttribute != null)
{
ConverterType = converterAttribute.ConverterType;
}
}

public string Name => propertyInfo.Name;
public bool Required { get => propertyInfo.IsRequired(); }
public Type Type => propertyInfo.PropertyType;
public Type? TypeOverride { get; set; }
public Type? ConverterType { get; set; }

public bool AllowNulls { get => propertyInfo.AcceptsNull(); }

public int Order { get; set; }
public bool CanWrite => propertyInfo.CanWrite;
public ScalarStyle ScalarStyle { get; set; }

public PropertyInfo PropertyInfo => propertyInfo;

public void Write(object target, object? value)
{
propertyInfo.SetValue(target, value, null);
}

public T? GetCustomAttribute<T>() where T : Attribute
{
var attributes = propertyInfo.GetAllCustomAttributes<T>();
return (T?)attributes.FirstOrDefault();
}

public IObjectDescriptor Read(object target)
{
var propertyValue = propertyInfo.ReadValue(target);
var actualType = TypeOverride ?? typeResolver.Resolve(Type, propertyValue);
return new ObjectDescriptor(propertyValue, actualType, Type, ScalarStyle);
}
}
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -30,82 +30,17 @@ namespace YamlDotNet.Serialization.TypeInspectors
/// <summary>
/// Returns the properties of a type that are readable.
/// </summary>
public class ReadablePropertiesTypeInspector : ReflectionTypeInspector
public class ReadablePropertiesTypeInspector(ITypeResolver typeResolver, bool includeNonPublicProperties) : PropertiesTypeInspector(typeResolver, includeNonPublicProperties)
{
private readonly ITypeResolver typeResolver;
private readonly bool includeNonPublicProperties;

public ReadablePropertiesTypeInspector(ITypeResolver typeResolver)
: this(typeResolver, false)
{
}

public ReadablePropertiesTypeInspector(ITypeResolver typeResolver, bool includeNonPublicProperties)
{
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
this.includeNonPublicProperties = includeNonPublicProperties;
}

private static bool IsValidProperty(PropertyInfo property)
protected override bool IsValidProperty(PropertyInfo property)
{
return property.CanRead
&& property.GetGetMethod(true)!.GetParameters().Length == 0;
}

public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object? container)
{
return type
.GetProperties(includeNonPublicProperties)
.Where(IsValidProperty)
.Select(p => (IPropertyDescriptor)new ReflectionPropertyDescriptor(p, typeResolver));
}

protected class ReflectionPropertyDescriptor : IPropertyDescriptor
{
private readonly PropertyInfo propertyInfo;
private readonly ITypeResolver typeResolver;

public ReflectionPropertyDescriptor(PropertyInfo propertyInfo, ITypeResolver typeResolver)
{
this.propertyInfo = propertyInfo ?? throw new ArgumentNullException(nameof(propertyInfo));
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
ScalarStyle = ScalarStyle.Any;
var converterAttribute = propertyInfo.GetCustomAttribute<YamlConverterAttribute>();
if (converterAttribute != null)
{
ConverterType = converterAttribute.ConverterType;
}
}

public string Name => propertyInfo.Name;
public bool Required { get => propertyInfo.IsRequired(); }
public Type Type => propertyInfo.PropertyType;
public Type? TypeOverride { get; set; }
public Type? ConverterType { get; set; }

public bool AllowNulls { get => propertyInfo.AcceptsNull(); }

public int Order { get; set; }
public bool CanWrite => propertyInfo.CanWrite;
public ScalarStyle ScalarStyle { get; set; }

public void Write(object target, object? value)
{
propertyInfo.SetValue(target, value, null);
}

public T? GetCustomAttribute<T>() where T : Attribute
{
var attributes = propertyInfo.GetAllCustomAttributes<T>();
return (T?)attributes.FirstOrDefault();
}

public IObjectDescriptor Read(object target)
{
var propertyValue = propertyInfo.ReadValue(target);
var actualType = TypeOverride ?? typeResolver.Resolve(Type, propertyValue);
return new ObjectDescriptor(propertyValue, actualType, Type, ScalarStyle);
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,81 +30,17 @@ namespace YamlDotNet.Serialization.TypeInspectors
/// <summary>
/// Returns the properties of a type that are writable.
/// </summary>
public class WritablePropertiesTypeInspector : ReflectionTypeInspector
public class WritablePropertiesTypeInspector(ITypeResolver typeResolver, bool includeNonPublicProperties) : PropertiesTypeInspector(typeResolver, includeNonPublicProperties)
{
private readonly ITypeResolver typeResolver;
private readonly bool includeNonPublicProperties;

public WritablePropertiesTypeInspector(ITypeResolver typeResolver)
: this(typeResolver, false)
{
}

public WritablePropertiesTypeInspector(ITypeResolver typeResolver, bool includeNonPublicProperties)
{
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
this.includeNonPublicProperties = includeNonPublicProperties;
}

private static bool IsValidProperty(PropertyInfo property)
protected override bool IsValidProperty(PropertyInfo property)
{
return property.CanWrite
&& property.GetSetMethod(true)!.GetParameters().Length == 1;
}

public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object? container)
{
return type
.GetProperties(includeNonPublicProperties)
.Where(IsValidProperty)
.Select(p => (IPropertyDescriptor)new ReflectionPropertyDescriptor(p, typeResolver))
.ToArray();
}

protected class ReflectionPropertyDescriptor : IPropertyDescriptor
{
private readonly PropertyInfo propertyInfo;
private readonly ITypeResolver typeResolver;

public ReflectionPropertyDescriptor(PropertyInfo propertyInfo, ITypeResolver typeResolver)
{
this.propertyInfo = propertyInfo ?? throw new ArgumentNullException(nameof(propertyInfo));
this.typeResolver = typeResolver ?? throw new ArgumentNullException(nameof(typeResolver));
ScalarStyle = ScalarStyle.Any;
var converterAttribute = propertyInfo.GetCustomAttribute<YamlConverterAttribute>();
if (converterAttribute != null)
{
ConverterType = converterAttribute.ConverterType;
}
}

public string Name => propertyInfo.Name;
public bool Required { get => propertyInfo.IsRequired(); }
public Type Type => propertyInfo.PropertyType;
public Type? TypeOverride { get; set; }
public Type? ConverterType { get; set; }
public bool AllowNulls { get => propertyInfo.AcceptsNull(); }
public int Order { get; set; }
public bool CanWrite => propertyInfo.CanWrite;
public ScalarStyle ScalarStyle { get; set; }

public void Write(object target, object? value)
{
propertyInfo.SetValue(target, value, null);
}

public T? GetCustomAttribute<T>() where T : Attribute
{
var attributes = propertyInfo.GetAllCustomAttributes<T>();
return (T?)attributes.FirstOrDefault();
}

public IObjectDescriptor Read(object target)
{
var propertyValue = propertyInfo.ReadValue(target);
var actualType = TypeOverride ?? typeResolver.Resolve(Type, propertyValue);
return new ObjectDescriptor(propertyValue, actualType, Type, ScalarStyle);
}
}
}
}