Separate IObjectDescriptor from IPropertyDescriptor to isolate access…

…ors from metadata.
aaubry · Mar 18, 2014 · b2abe20 · b2abe20
1 parent 4efc1f6
commit b2abe20
Show file tree

Hide file tree

Showing 14 changed files with 55 additions and 45 deletions.
diff --git a/YamlDotNet.Test/Serialization/SerializationTestHelper.cs b/YamlDotNet.Test/Serialization/SerializationTestHelper.cs
@@ -378,7 +378,11 @@ public Example()
 	public class IgnoreExample
 	{
 		[YamlIgnore]
-		public String IgnoreMe { get; set; }
+		public String IgnoreMe
+		{
+			get { throw new NotImplementedException("Accessing a [YamlIgnore] property"); }
+			set { throw new NotImplementedException("Accessing a [YamlIgnore] property"); }
+		}
 	}
 
 	public class DefaultsExample

diff --git a/YamlDotNet.Test/Serialization/SerializationTests.cs b/YamlDotNet.Test/Serialization/SerializationTests.cs
@@ -564,7 +564,7 @@ public void DeserializationOfDefaultsWorkInJson()
 		public void SerializationRespectsYamlIgnoreAttribute()
 		{
 			var writer = new StringWriter();
-			var obj = new IgnoreExample { IgnoreMe = "Some Text" };
+			var obj = new IgnoreExample();
 
 			Serializer.Serialize(writer, obj);
 			var serialized = writer.ToString();

diff --git a/YamlDotNet.build b/YamlDotNet.build
@@ -4,7 +4,7 @@
 	<!-- This build file requires .NET 4.0 and nant 0.91 alpha 2 or higher -->
 	<property name="nant.settings.currentframework" value="net-4.0"/>
 
-	<property name="version" value="3.1.0" />
+	<property name="version" value="3.1.1" />
 
 	<fileset id="binaries">
 		<include name="YamlDotNet/bin/Release/YamlDotNet.dll" />

diff --git a/YamlDotNet/Serialization/IObjectGraphVisitor.cs b/YamlDotNet/Serialization/IObjectGraphVisitor.cs
@@ -53,7 +53,7 @@ public interface IObjectGraphVisitor
 		/// <param name="key">The <see cref="IPropertyDescriptor"/> that provided access to <paramref name="value"/>.</param>
 		/// <param name="value">The value of the mapping that is about to be entered.</param>
 		/// <returns>If the mapping is to be entered, returns true; otherwise returns false;</returns>
-		bool EnterMapping(IPropertyDescriptor key, object value);
+		bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor value);
 
 		/// <summary>
 		/// Notifies the visitor that a scalar value has been encountered.

diff --git a/YamlDotNet/Serialization/IPropertyDescriptor.cs b/YamlDotNet/Serialization/IPropertyDescriptor.cs
@@ -23,13 +23,16 @@
 
 namespace YamlDotNet.Serialization
 {
-	public interface IPropertyDescriptor : IObjectDescriptor
+	public interface IPropertyDescriptor
 	{
 		string Name { get; }
 		bool CanWrite { get; }
-
-		void SetValue(object target, object value);
+		Type Type { get; }
+		Type TypeOverride { get; set; }
 
 		T GetCustomAttribute<T>() where T : Attribute;
+
+		IObjectDescriptor Read(object target);
+		void Write(object target, object value);
 	}
 }
diff --git a/YamlDotNet/Serialization/NodeDeserializers/ObjectNodeDeserializer.cs b/YamlDotNet/Serialization/NodeDeserializers/ObjectNodeDeserializer.cs
@@ -67,15 +67,15 @@ bool INodeDeserializer.Deserialize(EventReader reader, Type expectedType, Func<E
 				if (propertyValuePromise == null)
 				{
 					var convertedValue = TypeConverter.ChangeType(propertyValue, property.Type);
-					property.SetValue(value, convertedValue);
+					property.Write(value, convertedValue);
 				}
 				else
 				{
 					var valueRef = value;
 					propertyValuePromise.ValueAvailable += v =>
 					{
 						var convertedValue = TypeConverter.ChangeType(v, property.Type);
-						property.SetValue(valueRef, convertedValue);
+						property.Write(valueRef, convertedValue);
 					};
 				}
 			}

diff --git a/YamlDotNet/Serialization/ObjectGraphTraversalStrategies/FullObjectGraphTraversalStrategy.cs b/YamlDotNet/Serialization/ObjectGraphTraversalStrategies/FullObjectGraphTraversalStrategy.cs
@@ -228,12 +228,12 @@ protected virtual void TraverseProperties(IObjectDescriptor value, IObjectGraphV
 
 			foreach (var propertyDescriptor in typeDescriptor.GetProperties(value.Type, value.Value))
 			{
-				var propertyValue = propertyDescriptor.Value;
+				var propertyValue = propertyDescriptor.Read(value.Value);
 
 				if (visitor.EnterMapping(propertyDescriptor, propertyValue))
 				{
 					Traverse(new ObjectDescriptor(propertyDescriptor.Name, typeof(string), typeof(string)), visitor, currentDepth);
-					Traverse(propertyDescriptor, visitor, currentDepth);
+					Traverse(propertyValue, visitor, currentDepth);
 				}
 			}
 

diff --git a/YamlDotNet/Serialization/ObjectGraphVisitors/AnchorAssigner.cs b/YamlDotNet/Serialization/ObjectGraphVisitors/AnchorAssigner.cs
@@ -65,7 +65,7 @@ bool IObjectGraphVisitor.EnterMapping(IObjectDescriptor key, IObjectDescriptor v
 			return true;
 		}
 
-		bool IObjectGraphVisitor.EnterMapping(IPropertyDescriptor key, object value)
+		bool IObjectGraphVisitor.EnterMapping(IPropertyDescriptor key, IObjectDescriptor value)
 		{
 			return true;
 		}

diff --git a/YamlDotNet/Serialization/ObjectGraphVisitors/ChainedObjectGraphVisitor.cs b/YamlDotNet/Serialization/ObjectGraphVisitors/ChainedObjectGraphVisitor.cs
@@ -42,7 +42,7 @@ public virtual bool EnterMapping(IObjectDescriptor key, IObjectDescriptor value)
 			return nextVisitor.EnterMapping(key, value);
 		}
 
-		public virtual bool EnterMapping(IPropertyDescriptor key, object value)
+		public virtual bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor value)
 		{
 			return nextVisitor.EnterMapping(key, value);
 		}

diff --git a/YamlDotNet/Serialization/ObjectGraphVisitors/DefaultExclusiveObjectGraphVisitor.cs b/YamlDotNet/Serialization/ObjectGraphVisitors/DefaultExclusiveObjectGraphVisitor.cs
@@ -45,14 +45,14 @@ public override bool EnterMapping(IObjectDescriptor key, IObjectDescriptor value
 			       && base.EnterMapping(key, value);
 		}
 
-		public override bool EnterMapping(IPropertyDescriptor key, object value)
+		public override bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor value)
 		{
 			var defaultValueAttribute = key.GetCustomAttribute<DefaultValueAttribute>();
 			var defaultValue = defaultValueAttribute != null
 				? defaultValueAttribute.Value
 				: GetDefault(key.Type);
 
-			return !_objectComparer.Equals(value, defaultValue)
+			return !_objectComparer.Equals(value.Value, defaultValue)
 				   && base.EnterMapping(key, value);
 		}
 	}

diff --git a/YamlDotNet/Serialization/ObjectGraphVisitors/EmittingObjectGraphVisitor.cs b/YamlDotNet/Serialization/ObjectGraphVisitors/EmittingObjectGraphVisitor.cs
@@ -42,7 +42,7 @@ bool IObjectGraphVisitor.EnterMapping(IObjectDescriptor key, IObjectDescriptor v
 			return true;
 		}
 
-		bool IObjectGraphVisitor.EnterMapping(IPropertyDescriptor key, object value)
+		bool IObjectGraphVisitor.EnterMapping(IPropertyDescriptor key, IObjectDescriptor value)
 		{
 			return true;
 		}

diff --git a/YamlDotNet/Serialization/PropertyDescriptor.cs b/YamlDotNet/Serialization/PropertyDescriptor.cs
@@ -31,32 +31,36 @@ public PropertyDescriptor(IPropertyDescriptor baseDescriptor)
 		{
 			this.baseDescriptor = baseDescriptor;
 			Name = baseDescriptor.Name;
-			Type = baseDescriptor.Type;
-			StaticType = baseDescriptor.StaticType;
 		}
 
 		public string Name { get; set; }
-		public Type Type { get; set; }
-		public Type StaticType { get; set; }
 
-		public object Value
+		public Type Type { get { return baseDescriptor.Type; } }
+
+		public Type TypeOverride
 		{
-			get { return baseDescriptor.Value; }
+			get { return baseDescriptor.TypeOverride; }
+			set { baseDescriptor.TypeOverride = value; }
 		}
 
 		public bool CanWrite
 		{
 			get { return baseDescriptor.CanWrite; }
 		}
 
-		public void SetValue(object target, object value)
+		public void Write(object target, object value)
 		{
-			baseDescriptor.SetValue(target, value);
+			baseDescriptor.Write(target, value);
 		}
 
 		public T GetCustomAttribute<T>() where T : Attribute
 		{
 			return baseDescriptor.GetCustomAttribute<T>();
 		}
+
+		public IObjectDescriptor Read(object target)
+		{
+			return baseDescriptor.Read(target);
+		}
 	}
 }
diff --git a/YamlDotNet/Serialization/TypeInspectors/ReadablePropertiesTypeInspector.cs b/YamlDotNet/Serialization/TypeInspectors/ReadablePropertiesTypeInspector.cs
@@ -31,16 +31,16 @@ namespace YamlDotNet.Serialization.TypeInspectors
 	/// </summary>
 	public sealed class ReadablePropertiesTypeInspector : TypeInspectorSkeleton
 	{
-		private readonly ITypeResolver _reflectionPropertyDescriptorFactory;
+		private readonly ITypeResolver _typeResolver;
 
-		public ReadablePropertiesTypeInspector(ITypeResolver reflectionPropertyDescriptorFactory)
+		public ReadablePropertiesTypeInspector(ITypeResolver typeResolver)
 		{
-			if (reflectionPropertyDescriptorFactory == null)
+			if (typeResolver == null)
 			{
-				throw new ArgumentNullException("reflectionPropertyDescriptorFactory");
+				throw new ArgumentNullException("typeResolver");
 			}
 
-			_reflectionPropertyDescriptorFactory = reflectionPropertyDescriptorFactory;
+			_typeResolver = typeResolver;
 		}
 
 		private static bool IsValidProperty(PropertyInfo property)
@@ -54,34 +54,26 @@ public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object
 			return type
 				.GetProperties(BindingFlags.Instance | BindingFlags.Public)
 				.Where(IsValidProperty)
-				.Select(p =>
-				{
-					var propertyValue = container != null
-						? p.GetValue(container, null)
-						: null;
-
-					return (IPropertyDescriptor)new ReflectionPropertyDescriptor(p, _reflectionPropertyDescriptorFactory.Resolve(p.PropertyType, propertyValue), propertyValue);
-				});
+				.Select(p => (IPropertyDescriptor)new ReflectionPropertyDescriptor(p, _typeResolver));
 		}
 
 		private sealed class ReflectionPropertyDescriptor : IPropertyDescriptor
 		{
 			private readonly PropertyInfo _propertyInfo;
+			private readonly ITypeResolver _typeResolver;
 
-			public ReflectionPropertyDescriptor(PropertyInfo propertyInfo, Type type, object value)
+			public ReflectionPropertyDescriptor(PropertyInfo propertyInfo, ITypeResolver typeResolver)
 			{
 				_propertyInfo = propertyInfo;
-				Type = type;
-				Value = value;
+				_typeResolver = typeResolver;
 			}
 
 			public string Name { get { return _propertyInfo.Name; } }
-			public Type Type { get; private set; }
-			public Type StaticType { get { return _propertyInfo.PropertyType; } }
-			public object Value { get; private set; }
+			public Type Type { get { return _propertyInfo.PropertyType; } }
+			public Type TypeOverride { get; set; }
 			public bool CanWrite { get { return _propertyInfo.CanWrite; } }
 
-			public void SetValue(object target, object value)
+			public void Write(object target, object value)
 			{
 				_propertyInfo.SetValue(target, value, null);
 			}
@@ -93,6 +85,13 @@ public void SetValue(object target, object value)
 					? (T)attributes[0]
 					: null;
 			}
+
+			public IObjectDescriptor Read(object target)
+			{
+				var propertyValue = _propertyInfo.GetValue(target, null);
+				var actualType = TypeOverride ?? _typeResolver.Resolve(Type, propertyValue);
+				return new ObjectDescriptor(propertyValue, actualType, Type);
+			}
 		}
 	}
 }
diff --git a/YamlDotNet/Serialization/YamlAttributesTypeInspector.cs b/YamlDotNet/Serialization/YamlAttributesTypeInspector.cs
@@ -57,7 +57,7 @@ public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object
 					{
 						if (member.SerializeAs != null)
 						{
-							descriptor.Type = member.SerializeAs;
+							descriptor.TypeOverride = member.SerializeAs;
 						}
 					}