Merge pull request #49 from mwhelan/picking

Added Pick functionality to builders

Author: robdmoore

TestStack.Dossier.Tests/DataSources/Picking/PickingTests.cs

@@ -0,0 +1,48 @@
+using System.Linq;
+using Shouldly;
+using TestStack.Dossier.DataSources.Picking;
+using TestStack.Dossier.Lists;
+using TestStack.Dossier.Tests.TestHelpers.Objects.Entities;
+using Xunit;
+
+namespace TestStack.Dossier.Tests.DataSources.Picking
+{
+    public class PickingTests
+    {
+        [Fact]
+        public void RandomItemFrom_should_add_items_from_list_randomly()
+        {
+            var addresses = Builder<Address>.CreateListOfSize(15).BuildList();
+            var customers = Builder<Customer>
+                .CreateListOfSize(15)
+                .All()
+                .Set(x => x.PostalAddress, Pick.RandomItemFrom(addresses).Next)
+                .BuildList();
+
+            var uniqueAddresses = customers.Select(x => x.PostalAddress).Distinct().Count();
+            uniqueAddresses.ShouldBeGreaterThan(3);
+            uniqueAddresses.ShouldBeLessThan(15);
+        }
+
+        [Fact]
+        public void RepeatingSequenceFrom_should_add_items_from_list_sequentially_and_repeat_when_list_completes()
+        {
+            var addresses = Builder<Address>.CreateListOfSize(3).BuildList();
+            var customers = Builder<Customer>
+                .CreateListOfSize(9)
+                .All()
+                .Set(x => x.PostalAddress, Pick.RepeatingSequenceFrom(addresses).Next)
+                .BuildList();
+
+            for (int i = 0; i < 2; i++)
+            {
+                var address = customers[i].PostalAddress;
+                address.ShouldBeSameAs(customers[i + 3].PostalAddress);
+                address.ShouldBeSameAs(customers[i + 6].PostalAddress);
+
+                address.ShouldNotBeSameAs(customers[i + 1].PostalAddress);
+                address.ShouldNotBeSameAs(customers[i + 2].PostalAddress);
+            }
+        }
+    }
+}

TestStack.Dossier.Tests/TestStack.Dossier.Tests.csproj

@@ -58,6 +58,7 @@
     <Compile Include="Builder_CreateListTests.cs" />
     <Compile Include="Builder_CreateNewTests.cs" />
     <Compile Include="Builder_SetUsingBuilderTests.cs" />
+    <Compile Include="DataSources\Picking\PickingTests.cs" />
     <Compile Include="TestHelpers\Builders\AddressViewModelBuilder.cs" />
     <Compile Include="TestHelpers\Builders\AutoConstructorCustomerBuilder.cs" />
     <Compile Include="ChildBuilderTests.cs" />
@@ -119,6 +120,7 @@
       <Name>TestStack.Dossier</Name>
     </ProjectReference>
   </ItemGroup>
+  <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.

TestStack.Dossier/DataSources/DataSource.cs

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

TestStack.Dossier/DataSources/Picking/Pick.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+
+namespace TestStack.Dossier.DataSources.Picking
+{
+    /// <summary>
+    /// Pick a sequence of items from a collection of items according to different selection strategies.
+    /// </summary>
+    public class Pick
+    {
+        /// <summary>
+        /// Selects a random item from the list each time it is called.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="list">The list.</param>
+        /// <returns>The RandomItemSource class.</returns>
+        public static RandomItemSource<T> RandomItemFrom<T>(IList<T> list)
+        {
+            return new RandomItemSource<T>(list);
+        }
+
+        /// <summary>
+        /// Selects each item sequentially from the list and starts again from the beginning when the list is exhausted.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="list">The list.</param>
+        /// <returns></returns>
+        public static RepeatingSequenceSource<T> RepeatingSequenceFrom<T>(IList<T> list)
+        {
+            return new RepeatingSequenceSource<T>(list);
+        }
+    }
+}

TestStack.Dossier/DataSources/Picking/RandomItemSource.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+
+namespace TestStack.Dossier.DataSources.Picking
+{
+    /// <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/Picking/RepeatingSequenceSource.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+using TestStack.Dossier.DataSources.Generators;
+
+namespace TestStack.Dossier.DataSources.Picking
+{
+    /// <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/TestStack.Dossier.csproj

@@ -52,6 +52,9 @@
   <ItemGroup>
     <Compile Include="AnonymousValueFixture.cs" />
     <Compile Include="Builder.cs" />
+    <Compile Include="DataSources\Picking\Pick.cs" />
+    <Compile Include="DataSources\Picking\RandomItemSource.cs" />
+    <Compile Include="DataSources\Picking\RepeatingSequenceSource.cs" />
     <Compile Include="ITestDataBuilder.cs" />
     <Compile Include="DataSources\Dictionaries\Cache.cs" />
     <Compile Include="DataSources\Dictionaries\IDictionaryRepository.cs" />
@@ -179,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.