Refactored Pickers as DataSources

Author: mwhelan

TestStack.Dossier.Tests/Picking/PickingTests.cs

@@ -1,7 +1,7 @@
 using System.Linq;
 using Shouldly;
+using TestStack.Dossier.DataSources;
 using TestStack.Dossier.Lists;
-using TestStack.Dossier.Picking;
 using TestStack.Dossier.Tests.TestHelpers.Objects.Entities;
 using Xunit;
 

TestStack.Dossier/DataSources/DataSource.cs

@@ -40,6 +40,7 @@ public IList<T> Data
                 }
                 return _list;
             }
+            internal set { _list = value; }
         }
 
         /// <summary>

TestStack.Dossier/Picking/Pick.cs renamed to TestStack.Dossier/DataSources/Pick.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace TestStack.Dossier.Picking
+namespace TestStack.Dossier.DataSources
 {
     /// <summary>
     /// Pick a sequence of items from a collection of items according to different selection strategies.
@@ -12,10 +12,10 @@ public class Pick
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="list">The list.</param>
-        /// <returns>The RandomItemPicker class.</returns>
-        public static RandomItemPicker<T> RandomItemFrom<T>(IList<T> list)
+        /// <returns>The RandomItemSource class.</returns>
+        public static RandomItemSource<T> RandomItemFrom<T>(IList<T> list)
         {
-            return new RandomItemPicker<T>(list);
+            return new RandomItemSource<T>(list);
         }
 
         /// <summary>
@@ -24,9 +24,9 @@ public static RandomItemPicker<T> RandomItemFrom<T>(IList<T> list)
         /// <typeparam name="T"></typeparam>
         /// <param name="list">The list.</param>
         /// <returns></returns>
-        public static RepeatingSequenceItemPicker<T> RepeatingSequenceFrom<T>(IList<T> list)
+        public static RepeatingSequenceSource<T> RepeatingSequenceFrom<T>(IList<T> list)
         {
-            return new RepeatingSequenceItemPicker<T>(list);
+            return new RepeatingSequenceSource<T>(list);
         }
     }
 }

TestStack.Dossier/DataSources/RandomItemSource.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+
+namespace TestStack.Dossier.DataSources
+{
+    /// <summary>
+    /// Implements the random item strategy
+    /// </summary>
+    public class RandomItemSource<T> : DataSource<T>
+    {
+        /// <inheritdoc />
+        public RandomItemSource(IList<T> list)
+        {
+            Data = list;
+            Generator.StartIndex = 0;
+            Generator.ListSize = Data.Count;
+        }
+
+        /// <inheritdoc />
+        protected override IList<T> InitializeDataSource()
+        {
+            // This method will never be called as the list is set in the constructor.
+            throw new NotImplementedException();
+        }
+    }
+}

TestStack.Dossier/DataSources/RepeatingSequenceSource.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+using TestStack.Dossier.DataSources.Generators;
+
+namespace TestStack.Dossier.DataSources
+{
+    /// <summary>
+    /// Implements the repeatable sequence strategy
+    /// </summary>
+    public class RepeatingSequenceSource<T> : DataSource<T>
+    {
+        /// <inheritdoc />
+        public RepeatingSequenceSource(IList<T> list)
+            : base(new SequentialGenerator())
+        {
+            Data = list;
+            Generator.StartIndex = 0;
+            Generator.ListSize = Data.Count;
+        }
+
+        /// <inheritdoc />
+        protected override IList<T> InitializeDataSource()
+        {
+            // This method will never be called as the list is set in the constructor.
+            throw new NotImplementedException();
+        }
+    }
+}

TestStack.Dossier/Picking/ItemPicker.cs

@@ -52,6 +52,9 @@
   <ItemGroup>
     <Compile Include="AnonymousValueFixture.cs" />
     <Compile Include="Builder.cs" />
+    <Compile Include="DataSources\Pick.cs" />
+    <Compile Include="DataSources\RandomItemSource.cs" />
+    <Compile Include="DataSources\RepeatingSequenceSource.cs" />
     <Compile Include="ITestDataBuilder.cs" />
     <Compile Include="DataSources\Dictionaries\Cache.cs" />
     <Compile Include="DataSources\Dictionaries\IDictionaryRepository.cs" />
@@ -94,10 +97,6 @@
     <Compile Include="NullingExpandoObject.cs" />
     <Compile Include="Factories\IFactory.cs" />
     <Compile Include="PathExpressionVisitor.cs" />
-    <Compile Include="Picking\ItemPicker.cs" />
-    <Compile Include="Picking\Pick.cs" />
-    <Compile Include="Picking\RandomItemPicker.cs" />
-    <Compile Include="Picking\RepeatingSequenceItemPicker.cs" />
     <Compile Include="Reflector.cs" />
     <Compile Include="Suppliers\DefaultEmailValueSupplier.cs" />
     <Compile Include="Suppliers\DefaultLastNameValueSupplier.cs" />
@@ -183,6 +182,9 @@
     <EmbeddedResource Include="DataSources\Dictionaries\Resources\PersonUsername.txt" />
     <EmbeddedResource Include="DataSources\Dictionaries\Resources\ShirtSize.txt" />
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Picking\" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.