refactored IBsonSerializer to not be aware of items so that implementors don't need to implement methods that don't apply.

craiggwilson · craiggwilson · commit 64c071e71dcf · 2012-05-01T08:23:18.000-05:00
diff --git a/Bson/Bson.csproj b/Bson/Bson.csproj
@@ -103,6 +103,7 @@
     <Compile Include="Serialization\Conventions\IgnoreIfDefaultConventions.cs" />
     <Compile Include="Serialization\Conventions\SerializationOptionsConventions.cs" />
     <Compile Include="Serialization\IBsonClassMapModifier.cs" />
+    <Compile Include="Serialization\IBsonItemSerializationInfoProvider.cs" />
     <Compile Include="Serialization\IBsonMemberMapModifier.cs" />
     <Compile Include="Serialization\IBsonIdProvider.cs" />
     <Compile Include="Serialization\IBsonMemberSerializationInfoProvider.cs" />
diff --git a/Bson/Serialization/IBsonItemSerializationInfoProvider.cs b/Bson/Serialization/IBsonItemSerializationInfoProvider.cs
@@ -0,0 +1,19 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace MongoDB.Bson.Serialization
+{
+    /// <summary>
+    /// Contract for serializers to implement if they serialize an array of items.
+    /// </summary>
+    public interface IBsonItemSerializationInfoProvider
+    {
+        /// <summary>
+        /// Gets the serialization info for individual items of an enumerable type.
+        /// </summary>
+        /// <returns>The serialization info for the items.</returns>
+        BsonSerializationInfo GetItemSerializationInfo();
+    }
+}
diff --git a/Bson/Serialization/IBsonSerializer.cs b/Bson/Serialization/IBsonSerializer.cs
@@ -47,11 +47,6 @@ public interface IBsonSerializer
         /// <returns>The default serialization options for this serializer.</returns>
         IBsonSerializationOptions GetDefaultSerializationOptions();
         /// <summary>
-        /// Gets the serialization info for individual items of an enumerable type.
-        /// </summary>
-        /// <returns>The serialization info for the items.</returns>
-        BsonSerializationInfo GetItemSerializationInfo();
-        /// <summary>
         /// Serializes an object to a BsonWriter.
         /// </summary>
         /// <param name="bsonWriter">The BsonWriter.</param>
diff --git a/Bson/Serialization/Options/ArraySerializationOptions.cs b/Bson/Serialization/Options/ArraySerializationOptions.cs
@@ -71,7 +71,17 @@ public IBsonSerializationOptions ItemSerializationOptions
         public override void ApplyAttribute(IBsonSerializer serializer, Attribute attribute)
         {
             EnsureNotFrozen();
-            var itemSerializer = serializer.GetItemSerializationInfo().Serializer;
+            var itemSerializationProvider = serializer as IBsonItemSerializationInfoProvider;
+            if (itemSerializationProvider == null)
+            {
+                var message = string.Format(
+                        "A serialization options attribute of type {0} cannot be used when the serializer is of type {1}.",
+                        BsonUtils.GetFriendlyTypeName(attribute.GetType()),
+                        BsonUtils.GetFriendlyTypeName(serializer.GetType()));
+                throw new NotSupportedException(message);
+            }
+
+            var itemSerializer = itemSerializationProvider.GetItemSerializationInfo().Serializer;
             if (_itemSerializationOptions == null)
             {
                 var itemDefaultSerializationOptions = itemSerializer.GetDefaultSerializationOptions();
diff --git a/Bson/Serialization/Options/DictionarySerializationOptions.cs b/Bson/Serialization/Options/DictionarySerializationOptions.cs
@@ -188,7 +188,17 @@ public override void ApplyAttribute(IBsonSerializer serializer, Attribute attrib
                 }
             }
 
-            var itemSerializer = serializer.GetItemSerializationInfo().Serializer;
+            var itemSerializationProvider = serializer as IBsonItemSerializationInfoProvider;
+            if (itemSerializationProvider == null)
+            {
+                var message = string.Format(
+                        "A serialization options attribute of type {0} cannot be used when the serializer is of type {1}.",
+                        BsonUtils.GetFriendlyTypeName(attribute.GetType()),
+                        BsonUtils.GetFriendlyTypeName(serializer.GetType()));
+                throw new NotSupportedException(message);
+            }
+
+            var itemSerializer = itemSerializationProvider.GetItemSerializationInfo().Serializer;
             if (_itemSerializationOptions == null)
             {
                 var itemDefaultSerializationOptions = itemSerializer.GetDefaultSerializationOptions();
diff --git a/Bson/Serialization/Serializers/ArraySerializer.cs b/Bson/Serialization/Serializers/ArraySerializer.cs
@@ -30,7 +30,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// Represents a serializer for one-dimensional arrays.
     /// </summary>
     /// <typeparam name="T">The type of the elements.</typeparam>
-    public class ArraySerializer<T> : BsonBaseSerializer
+    public class ArraySerializer<T> : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // constructors
         /// <summary>
@@ -91,7 +91,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(T));
diff --git a/Bson/Serialization/Serializers/BsonBaseSerializer.cs b/Bson/Serialization/Serializers/BsonBaseSerializer.cs
@@ -103,16 +103,6 @@ public virtual IBsonSerializationOptions GetDefaultSerializationOptions()
             return _defaultSerializationOptions;
         }
 
-        /// <summary>
-        /// Gets the serialization info for individual items of an enumerable type.
-        /// </summary>
-        /// <returns>The serialization info for the items.</returns>
-        public virtual BsonSerializationInfo GetItemSerializationInfo()
-        {
-            var message = string.Format("{0} does not implement the GetItemSerializationInfo method.", this.GetType().Name);
-            throw new NotSupportedException(message);
-        }
-
         /// <summary>
         /// Serializes an object to a BsonWriter.
         /// </summary>
diff --git a/Bson/Serialization/Serializers/CollectionGenericSerializers.cs b/Bson/Serialization/Serializers/CollectionGenericSerializers.cs
@@ -30,7 +30,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// Represents a serializer for enumerable values.
     /// </summary>
     /// <typeparam name="T">The type of the elements.</typeparam>
-    public class EnumerableSerializer<T> : BsonBaseSerializer
+    public class EnumerableSerializer<T> : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // constructors
         /// <summary>
@@ -92,7 +92,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(T));
@@ -149,7 +149,7 @@ public override void Serialize(
     /// Represents a serializer for Queues.
     /// </summary>
     /// <typeparam name="T">The type of the elements.</typeparam>
-    public class QueueSerializer<T> : BsonBaseSerializer
+    public class QueueSerializer<T> : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // constructors
         /// <summary>
@@ -211,7 +211,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(T));
@@ -268,7 +268,7 @@ public override void Serialize(
     /// Represents a serializer for Stacks.
     /// </summary>
     /// <typeparam name="T">The type of the elements.</typeparam>
-    public class StackSerializer<T> : BsonBaseSerializer
+    public class StackSerializer<T> : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // constructors
         /// <summary>
@@ -330,7 +330,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(T));
diff --git a/Bson/Serialization/Serializers/CollectionSerializers.cs b/Bson/Serialization/Serializers/CollectionSerializers.cs
@@ -29,7 +29,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// <summary>
     /// Represents a serializer for enumerable values.
     /// </summary>
-    public class EnumerableSerializer : BsonBaseSerializer
+    public class EnumerableSerializer : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // private static fields
         private static EnumerableSerializer __instance = new EnumerableSerializer();
@@ -103,7 +103,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(object));
@@ -159,7 +159,7 @@ public override void Serialize(
     /// <summary>
     /// Represents a serializer for Queues.
     /// </summary>
-    public class QueueSerializer : BsonBaseSerializer
+    public class QueueSerializer : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // private static fields
         private static QueueSerializer __instance = new QueueSerializer();
@@ -233,7 +233,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(object));
@@ -289,7 +289,7 @@ public override void Serialize(
     /// <summary>
     /// Represents a serializer for Stacks.
     /// </summary>
-    public class StackSerializer : BsonBaseSerializer
+    public class StackSerializer : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // private static fields
         private static StackSerializer __instance = new StackSerializer();
@@ -363,7 +363,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(object));
diff --git a/Bson/Serialization/Serializers/DictionaryGenericSerializer.cs b/Bson/Serialization/Serializers/DictionaryGenericSerializer.cs
@@ -30,7 +30,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// </summary>
     /// <typeparam name="TKey">The type of the keys.</typeparam>
     /// <typeparam name="TValue">The type of the values.</typeparam>
-    public class DictionarySerializer<TKey, TValue> : BsonBaseSerializer
+    public class DictionarySerializer<TKey, TValue> : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // constructors
         /// <summary>
@@ -170,7 +170,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(TValue));
diff --git a/Bson/Serialization/Serializers/DictionarySerializer.cs b/Bson/Serialization/Serializers/DictionarySerializer.cs
@@ -29,7 +29,7 @@ namespace MongoDB.Bson.Serialization.Serializers
     /// <summary>
     /// Represents a serializer for dictionaries.
     /// </summary>
-    public class DictionarySerializer : BsonBaseSerializer
+    public class DictionarySerializer : BsonBaseSerializer, IBsonItemSerializationInfoProvider
     {
         // private static fields
         private static DictionarySerializer __instance = new DictionarySerializer();
@@ -180,7 +180,7 @@ public override object Deserialize(
         /// Gets the serialization info for individual items of an enumerable type.
         /// </summary>
         /// <returns>The serialization info for the items.</returns>
-        public override BsonSerializationInfo GetItemSerializationInfo()
+        public BsonSerializationInfo GetItemSerializationInfo()
         {
             string elementName = null;
             var serializer = BsonSerializer.LookupSerializer(typeof(object));
diff --git a/Driver/Linq/Translators/SelectQuery.cs b/Driver/Linq/Translators/SelectQuery.cs
@@ -467,7 +467,16 @@ private IMongoQuery BuildContainsAllQuery(MethodCallExpression methodCallExpress
                     var valuesExpression = arguments[1] as ConstantExpression;
                     if (serializationInfo != null && valuesExpression != null)
                     {
-                        var itemSerializationInfo = serializationInfo.Serializer.GetItemSerializationInfo();
+                        var itemSerializationProvider = serializationInfo.Serializer as IBsonItemSerializationInfoProvider;
+                        if (itemSerializationProvider == null)
+                        {
+                            var message = string.Format(
+                                "ContainsAll cannot be run against a member whose serializer does not implement {0}. The current serializer is {1}.",
+                                BsonUtils.GetFriendlyTypeName(typeof(IBsonItemSerializationInfoProvider)),
+                                BsonUtils.GetFriendlyTypeName(serializationInfo.Serializer.GetType()));
+                            throw new NotSupportedException(message);
+                        }
+                        var itemSerializationInfo = itemSerializationProvider.GetItemSerializationInfo();
                         var serializedValues = SerializeValues(itemSerializationInfo, (IEnumerable)valuesExpression.Value);
                         return Query.All(serializationInfo.ElementName, serializedValues);
                     }
@@ -487,7 +496,16 @@ private IMongoQuery BuildContainsAnyQuery(MethodCallExpression methodCallExpress
                     var valuesExpression = arguments[1] as ConstantExpression;
                     if (serializationInfo != null && valuesExpression != null)
                     {
-                        var itemSerializationInfo = serializationInfo.Serializer.GetItemSerializationInfo();
+                        var itemSerializationProvider = serializationInfo.Serializer as IBsonItemSerializationInfoProvider;
+                        if (itemSerializationProvider == null)
+                        {
+                            var message = string.Format(
+                                "ContainsAny cannot be run against a member whose serializer does not implement {0}. The current serializer is {1}.",
+                                BsonUtils.GetFriendlyTypeName(typeof(IBsonItemSerializationInfoProvider)),
+                                BsonUtils.GetFriendlyTypeName(serializationInfo.Serializer.GetType()));
+                            throw new NotSupportedException(message);
+                        }
+                        var itemSerializationInfo = itemSerializationProvider.GetItemSerializationInfo();
                         var serializedValues = SerializeValues(itemSerializationInfo, (IEnumerable)valuesExpression.Value);
                         return Query.In(serializationInfo.ElementName, serializedValues);
                     }
@@ -525,7 +543,16 @@ private IMongoQuery BuildContainsQuery(MethodCallExpression methodCallExpression
 
             if (serializationInfo != null && valueExpression != null)
             {
-                var itemSerializationInfo = serializationInfo.Serializer.GetItemSerializationInfo();
+                var itemSerializationProvider = serializationInfo.Serializer as IBsonItemSerializationInfoProvider;
+                if (itemSerializationProvider == null)
+                {
+                    var message = string.Format(
+                        "Contains cannot be run against a member whose serializer does not implement {0}. The current serializer is {1}.",
+                        BsonUtils.GetFriendlyTypeName(typeof(IBsonItemSerializationInfoProvider)),
+                        BsonUtils.GetFriendlyTypeName(serializationInfo.Serializer.GetType()));
+                    throw new NotSupportedException(message);
+                }
+                var itemSerializationInfo = itemSerializationProvider.GetItemSerializationInfo();
                 var serializedValue = SerializeValue(itemSerializationInfo, valueExpression.Value);
                 return Query.EQ(serializationInfo.ElementName, serializedValue);
             }
@@ -1480,7 +1507,16 @@ private BsonSerializationInfo GetSerializationInfoArrayIndex(IBsonSerializer ser
             var arraySerializationInfo = GetSerializationInfo(serializer, binaryExpression.Left);
             if (arraySerializationInfo != null)
             {
-                var itemSerializationInfo = arraySerializationInfo.Serializer.GetItemSerializationInfo();
+                var itemSerializationProvider = arraySerializationInfo.Serializer as IBsonItemSerializationInfoProvider;
+                if (itemSerializationProvider == null)
+                {
+                    var message = string.Format(
+                        "Queries using an array index cannot be run against a member whose serializer does not implement {0}. The current serializer is {1}.",
+                        BsonUtils.GetFriendlyTypeName(typeof(IBsonItemSerializationInfoProvider)),
+                        BsonUtils.GetFriendlyTypeName(arraySerializationInfo.Serializer.GetType()));
+                    throw new NotSupportedException(message);
+                }
+                var itemSerializationInfo = itemSerializationProvider.GetItemSerializationInfo();
                 var indexEpression = binaryExpression.Right as ConstantExpression;
                 if (indexEpression != null)
                 {
@@ -1501,13 +1537,17 @@ private BsonSerializationInfo GetSerializationInfoGetItem(IBsonSerializer serial
             var arguments = methodCallExpression.Arguments.ToArray();
             if (arguments.Length == 1)
             {
+                var indexEpression = arguments[0] as ConstantExpression;
+                if (indexEpression == null)
+                    return null;
+
                 var arraySerializationInfo = GetSerializationInfo(serializer, methodCallExpression.Object);
                 if (arraySerializationInfo != null)
                 {
-                    var itemSerializationInfo = arraySerializationInfo.Serializer.GetItemSerializationInfo();
-                    var indexEpression = arguments[0] as ConstantExpression;
-                    if (indexEpression != null)
+                    var itemSerializationProvider = arraySerializationInfo.Serializer as IBsonItemSerializationInfoProvider;
+                    if (itemSerializationProvider != null)
                     {
+                        var itemSerializationInfo = itemSerializationProvider.GetItemSerializationInfo();
                         var index = Convert.ToInt32(indexEpression.Value);
                         return new BsonSerializationInfo(
                             arraySerializationInfo.ElementName + "." + index.ToString(),

Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,17 @@ public override void ApplyAttribute(IBsonSerializer serializer, Attribute attrib`
`188`	`188`	`}`
`189`	`189`	`}`
`190`	`190`
`191`		`- var itemSerializer = serializer.GetItemSerializationInfo().Serializer;`
	`191`	`+ var itemSerializationProvider = serializer as IBsonItemSerializationInfoProvider;`
	`192`	`+ if (itemSerializationProvider == null)`
	`193`	`+ {`
	`194`	`+ var message = string.Format(`
	`195`	`+ "A serialization options attribute of type {0} cannot be used when the serializer is of type {1}.",`
	`196`	`+ BsonUtils.GetFriendlyTypeName(attribute.GetType()),`
	`197`	`+ BsonUtils.GetFriendlyTypeName(serializer.GetType()));`
	`198`	`+ throw new NotSupportedException(message);`
	`199`	`+ }`
	`200`	`+`
	`201`	`+ var itemSerializer = itemSerializationProvider.GetItemSerializationInfo().Serializer;`
`192`	`202`	`if (_itemSerializationOptions == null)`
`193`	`203`	`{`
`194`	`204`	`var itemDefaultSerializationOptions = itemSerializer.GetDefaultSerializationOptions();`