Refactored DataSource. Introduced file-based dictionaries

mwhelan · mwhelan · commit ce89027a6634 · 2014-09-23T12:47:17.000+01:00
diff --git a/NTestDataBuilder.Tests/DataSources/DataSourceTests.cs b/NTestDataBuilder.Tests/DataSources/DataSourceTests.cs
@@ -14,7 +14,7 @@ public void WhenCreatingADataSource_ThenListShouldContainAllTheValues()
         {
             var sut = new DummyDataSource();
 
-            var result = sut.List;
+            var result = sut.Data;
 
             result.Count.ShouldBe(3);
             result.ShouldBe(new List<string> { "Value 1", "Value 2", "Value 3" });
@@ -25,7 +25,7 @@ public void WhenGeneratingValuesFromDefaultDataSource_ThenShouldGenerateItemFrom
         {
             var sut = new DummyDataSource();
             var result = sut.Next();
-            sut.List.ShouldContain(result);
+            sut.Data.ShouldContain(result);
         }
 
         [Fact]
@@ -39,7 +39,7 @@ public void WhenGeneratingValuesFromDefaultDataSource_ThenShouldGenerateRandomIt
                 results.Add(sut.Next());
             }
 
-            foreach (var item in sut.List)
+            foreach (var item in sut.Data)
             {
                 results.ShouldContain(item);
             }
@@ -50,20 +50,20 @@ public void WhenGeneratingValuesFromSequentialDataSource_ThenShouldGenerateSeque
         {
             var sut = new DummyDataSource(new SequentialGenerator());
 
-            sut.Next().ShouldBe(sut.List[0]);
-            sut.Next().ShouldBe(sut.List[1]);
-            sut.Next().ShouldBe(sut.List[2]);
-            sut.Next().ShouldBe(sut.List[0]);
+            sut.Next().ShouldBe(sut.Data[0]);
+            sut.Next().ShouldBe(sut.Data[1]);
+            sut.Next().ShouldBe(sut.Data[2]);
+            sut.Next().ShouldBe(sut.Data[0]);
         }
 
         [Fact]
         public void WhenGeneratingValuesFromUniqueSequentialDataSource_ThenShouldThrowWhenCollectionExceeded()
         {
             var sut = new DummyDataSource(new SequentialGenerator(0,1,true));
 
-            sut.Next().ShouldBe(sut.List[0]);
-            sut.Next().ShouldBe(sut.List[1]);
-            sut.Next().ShouldBe(sut.List[2]);
+            sut.Next().ShouldBe(sut.Data[0]);
+            sut.Next().ShouldBe(sut.Data[1]);
+            sut.Next().ShouldBe(sut.Data[2]);
             Should.Throw<InvalidOperationException>(() => sut.Next());
         }
     }
@@ -76,7 +76,7 @@ public DummyDataSource(IGenerator generator)
         public DummyDataSource() 
             : this(new RandomGenerator()) { }
 
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return new List<string>{"Value 1", "Value 2", "Value 3"};
         }
diff --git a/NTestDataBuilder.Tests/DataSources/Dictionaries/FileDictionaryRepositoryIntegrationTests.cs b/NTestDataBuilder.Tests/DataSources/Dictionaries/FileDictionaryRepositoryIntegrationTests.cs
@@ -0,0 +1,40 @@
+﻿using System.IO;
+using NTestDataBuilder.DataSources.Dictionaries;
+using Shouldly;
+using Xunit;
+
+namespace NTestDataBuilder.Tests.DataSources.Dictionaries
+{
+    public class FileDictionaryRepositoryIntegrationTests
+    {
+        [Fact]
+        public void GivenAnExternalFileDictionaryExists_WhenRetrievingWords_ThenExternalDictionaryIsUsed()
+        {
+            var sut = new FileDictionaryRepository();
+
+            var result = sut.GetWordsFrom("SampleDictionaryFile");
+
+            result.Count.ShouldBe(2);
+            result[0].ShouldBe("File first word");
+        }
+
+        [Fact]
+        public void GivenAResourceDictionaryAndNoExternalFileDictionary_WhenRetrievingWords_ThenResourceDictionaryIsUsed()
+        {
+            var sut = new FileDictionaryRepository();
+
+            var result = sut.GetWordsFrom("GeoContinent");
+
+            result.Count.ShouldBe(7);
+            result[0].ShouldBe("Asia");
+        }
+
+        [Fact]
+        public void GivenNoResourceDictionaryAndNoExternalFileDictionary_WhenRetrievingWords_ThenFileNotFoundException()
+        {
+            var sut = new FileDictionaryRepository();
+            Should.Throw<FileNotFoundException>(() => sut.GetWordsFrom("NonExistentDictionary"));
+        }
+
+    }
+}
diff --git a/NTestDataBuilder.Tests/DataSources/Dictionaries/FileDictionarySourceTests.cs b/NTestDataBuilder.Tests/DataSources/Dictionaries/FileDictionarySourceTests.cs
@@ -0,0 +1,27 @@
+﻿using NSubstitute;
+using NTestDataBuilder.DataSources.Dictionaries;
+using NTestDataBuilder.DataSources.Generators;
+using Xunit;
+
+namespace NTestDataBuilder.Tests.DataSources.Dictionaries
+{
+    public class FileDictionarySourceTests
+    {
+        [Fact]
+        public void WhenInitializingList_ThenPassClassNameToRepositoryAsDictionaryName()
+        {
+            var repository = Substitute.For<IDictionaryRepository>();
+            var sut = new DummySource(repository);
+
+            var result = sut.Data;
+
+            repository.Received().GetWordsFrom("Dummy");
+        }
+    }
+
+    public class DummySource : FileDictionarySource
+    {
+        public DummySource(IDictionaryRepository repository) 
+            : base(Substitute.For<IGenerator>(), repository) { }
+    }
+}
diff --git a/NTestDataBuilder.Tests/DataSources/PersonSourceTests.cs b/NTestDataBuilder.Tests/DataSources/PersonSourceTests.cs
@@ -12,9 +12,9 @@ public class PersonSourceTests
         [PropertyData("TestCases")]
         public void PersonSourceSpec(DataSource<string> sut, int expectedCount)
         {
-            var collection = sut.List.ToList();
+            var collection = sut.Data.ToList();
             collection.Count.ShouldBe(expectedCount);
-            collection.Count.ShouldBe(sut.List.Distinct().ToList().Count);
+            collection.Count.ShouldBe(sut.Data.Distinct().ToList().Count);
             collection.ForEach(item => item.ShouldNotBeNullOrEmpty());
         }
 
diff --git a/NTestDataBuilder.Tests/EquivalenceClasses/PersonEquivalenceClassesTests.cs b/NTestDataBuilder.Tests/EquivalenceClasses/PersonEquivalenceClassesTests.cs
@@ -26,7 +26,7 @@ public void WhenGettingAnyPersonData_ThenReturnRandomPersonDataWhichIsReasonably
             {
                 testCase.ShouldBeOfType<string>();
                 testCase.ShouldNotBeNullOrEmpty();
-                source.List.ShouldContain(testCase);
+                source.Data.ShouldContain(testCase);
             }
             var unique = testCases.Distinct().Count();
             unique.ShouldBeGreaterThan(5);
diff --git a/NTestDataBuilder.Tests/NTestDataBuilder.Tests.csproj b/NTestDataBuilder.Tests/NTestDataBuilder.Tests.csproj
@@ -53,6 +53,8 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="DataSources\DataSourceTests.cs" />
+    <Compile Include="DataSources\Dictionaries\FileDictionaryRepositoryIntegrationTests.cs" />
+    <Compile Include="DataSources\Dictionaries\FileDictionarySourceTests.cs" />
     <Compile Include="DataSources\Generators\RandomGeneratorTests.cs" />
     <Compile Include="DataSources\Generators\SequentiaGeneratorTests.cs" />
     <Compile Include="DataSources\PersonSourceTests.cs" />
@@ -84,7 +86,14 @@
       <Name>NTestDataBuilder</Name>
     </ProjectReference>
   </ItemGroup>
-  <ItemGroup />
+  <ItemGroup>
+    <Folder Include="DataSources\Dictionaries\Resources\" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="SampleDictionaryFile.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </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.
diff --git a/NTestDataBuilder.Tests/SampleDictionaryFile.txt b/NTestDataBuilder.Tests/SampleDictionaryFile.txt
@@ -0,0 +1,2 @@
+﻿File first word
+File second word
diff --git a/NTestDataBuilder/DataSources/CitySource.cs b/NTestDataBuilder/DataSources/CitySource.cs
@@ -19,7 +19,7 @@ public CitySource(IGenerator generator)
             : base(generator) { }
 
         /// <inheritdoc />
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return FileDataRepository.People
                 .Select(person => person.City)
diff --git a/NTestDataBuilder/DataSources/CompanySource.cs b/NTestDataBuilder/DataSources/CompanySource.cs
@@ -19,7 +19,7 @@ public CompanySource(IGenerator generator)
             : base(generator) { }
 
         /// <inheritdoc />
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return FileDataRepository.People
                 .Select(person => person.CompanyName)
diff --git a/NTestDataBuilder/DataSources/CountySource.cs b/NTestDataBuilder/DataSources/CountySource.cs
@@ -19,7 +19,7 @@ public CountySource(IGenerator generator)
             : base(generator) { }
 
         /// <inheritdoc />
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return FileDataRepository.People
                 .Select(person => person.County)
diff --git a/NTestDataBuilder/DataSources/DataSource.cs b/NTestDataBuilder/DataSources/DataSource.cs
@@ -16,24 +16,50 @@ public abstract class DataSource<T> : IDataSource<T>
         protected DataSource(IGenerator generator)
         {
             Generator = generator;
-            List = InitializeList();
-            Generator.ListSize = List.Count;
         }
 
         /// <summary>
         /// The default constructor implements a RandomGenerator strategy
         /// </summary>
-        protected DataSource() 
+        protected DataSource()
             : this(new RandomGenerator()) { }
 
-        public IList<T> List { get; private set; }
+        private IList<T> _list;
+
+        /// <summary>
+        /// The data source data
+        /// </summary>
+        public IList<T> Data
+        {
+            get
+            {
+                if (_list == null)
+                {
+                    _list = InitializeDataSource();
+                    Generator.ListSize = Data.Count;
+                }
+                return _list;
+            }
+        }
+
+        /// <summary>
+        /// The Generator that determines which record from the data source collection is returned with the Next operation.
+        /// </summary>
         public IGenerator Generator { get; private set; }
 
-        protected abstract IList<T> InitializeList();
+        /// <summary>
+        /// Each data source implements this method to load data into the data source the first time the data is accessed
+        /// </summary>
+        /// <returns></returns>
+        protected abstract IList<T> InitializeDataSource();
 
+        /// <summary>
+        /// Returns the next item from the data source as determined by the Generator
+        /// </summary>
+        /// <returns></returns>
         public virtual T Next()
         {
-            return List[Generator.Generate()];
+            return Data[Generator.Generate()];
         }
     }
 }
diff --git a/NTestDataBuilder/DataSources/Dictionaries/FileDictionaryRepository.cs b/NTestDataBuilder/DataSources/Dictionaries/FileDictionaryRepository.cs
@@ -0,0 +1,46 @@
+﻿using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Reflection;
+
+namespace NTestDataBuilder.DataSources.Dictionaries
+{
+    /// <summary>
+    /// Retrieves words from dictionaries stored in files
+    /// </summary>
+    public class FileDictionaryRepository : IDictionaryRepository
+    {
+        public IList<string> GetWordsFrom(string dictionary)
+        {
+            // let users override values with file in bin directory
+            var name = string.Format("{0}.txt", dictionary);
+            if (File.Exists(name))
+            {
+                return File.ReadAllLines(name);
+            }
+
+            // otherwise get data from embedded resource files
+            var resourceName = string.Format("NTestDataBuilder.DataSources.Dictionaries.Resources.{0}", name);
+            return GetWordsFromEmbeddedResource(GetType().Assembly, resourceName);
+        }
+
+        internal IList<string> GetWordsFromEmbeddedResource(Assembly assembly, string resourceName)
+        {
+            var items = new List<string>();
+            var stream = assembly.GetManifestResourceStream(resourceName);
+            if (stream == null)
+            {
+                throw new FileNotFoundException();
+            }
+            using (var reader = new StreamReader(stream))
+            {
+                string line;
+                while ((line = reader.ReadLine()) != null)
+                {
+                    items.Add(line);
+                }
+            }
+            return items;
+        }
+    }
+}
diff --git a/NTestDataBuilder/DataSources/Dictionaries/FileDictionarySource.cs b/NTestDataBuilder/DataSources/Dictionaries/FileDictionarySource.cs
@@ -0,0 +1,31 @@
+﻿using System.Collections.Generic;
+using NTestDataBuilder.DataSources.Generators;
+
+namespace NTestDataBuilder.DataSources.Dictionaries
+{
+    /// <summary>
+    /// The base class for data sources that load their data from dictionaries stored in files
+    /// </summary>
+    public abstract class FileDictionarySource : DataSource<string>
+    {
+        private readonly IDictionaryRepository _repository;
+
+        /// <inheritdoc />
+        protected FileDictionarySource()
+            : this(new RandomGenerator(), new FileDictionaryRepository()) { }
+
+        /// <inheritdoc />
+        public FileDictionarySource(IGenerator generator, IDictionaryRepository repository)
+            : base(generator)
+        {
+            _repository = repository;
+        }
+
+        /// <inheritdoc />
+        protected override IList<string> InitializeDataSource()
+        {
+            var dictionary = GetType().Name.Replace("Source", string.Empty);
+            return _repository.GetWordsFrom(dictionary);
+        }
+    }
+}
diff --git a/NTestDataBuilder/DataSources/Dictionaries/IDictionaryRepository.cs b/NTestDataBuilder/DataSources/Dictionaries/IDictionaryRepository.cs
@@ -0,0 +1,18 @@
+﻿using System.Collections.Generic;
+
+namespace NTestDataBuilder.DataSources.Dictionaries
+{
+    /// <summary>
+    /// Retrieves words from specified dictionaries
+    /// </summary>
+    public interface IDictionaryRepository
+    {
+        /// <summary>
+        /// Retrieves words from specified dictionary
+        /// </summary>
+        /// <param name="dictionary">The name of the dictionary</param>
+        /// <returns>A list of words</returns>
+        IList<string> GetWordsFrom(string dictionary);
+    }
+
+}
diff --git a/NTestDataBuilder/DataSources/Dictionaries/Resources/GeoContinent.txt b/NTestDataBuilder/DataSources/Dictionaries/Resources/GeoContinent.txt
@@ -0,0 +1,7 @@
+Asia
+North America
+South America
+Australia
+Africa
+Europe
+Antarctica
diff --git a/NTestDataBuilder/DataSources/EmailSource.cs b/NTestDataBuilder/DataSources/EmailSource.cs
@@ -19,7 +19,7 @@ public EmailSource(IGenerator generator)
             : base(generator) { }
 
         /// <inheritdoc />
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return FileDataRepository.People
                 .Select(person => person.Email)
diff --git a/NTestDataBuilder/DataSources/FirstNameSource.cs b/NTestDataBuilder/DataSources/FirstNameSource.cs
@@ -19,7 +19,7 @@ public FirstNameSource(IGenerator generator)
             : base(generator) { }
 
         /// <inheritdoc />
-        protected override IList<string> InitializeList()
+        protected override IList<string> InitializeDataSource()
         {
             return FileDataRepository.People
                 .Select(person => person.FirstName)
diff --git a/NTestDataBuilder/DataSources/FullNameSource.cs b/NTestDataBuilder/DataSources/FullNameSource.cs
diff --git a/NTestDataBuilder/DataSources/IDataSource.cs b/NTestDataBuilder/DataSources/IDataSource.cs
diff --git a/NTestDataBuilder/DataSources/LastNameSource.cs b/NTestDataBuilder/DataSources/LastNameSource.cs
diff --git a/NTestDataBuilder/DataSources/PhoneSource.cs b/NTestDataBuilder/DataSources/PhoneSource.cs
diff --git a/NTestDataBuilder/DataSources/PostCodeSource.cs b/NTestDataBuilder/DataSources/PostCodeSource.cs
diff --git a/NTestDataBuilder/DataSources/StreetSource.cs b/NTestDataBuilder/DataSources/StreetSource.cs
diff --git a/NTestDataBuilder/DataSources/WebsiteSource.cs b/NTestDataBuilder/DataSources/WebsiteSource.cs
diff --git a/NTestDataBuilder/NTestDataBuilder.csproj b/NTestDataBuilder/NTestDataBuilder.csproj

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public void WhenCreatingADataSource_ThenListShouldContainAllTheValues()`
`14`	`14`	`{`
`15`	`15`	`var sut = new DummyDataSource();`
`16`	`16`
`17`		`- var result = sut.List;`
	`17`	`+ var result = sut.Data;`
`18`	`18`
`19`	`19`	`result.Count.ShouldBe(3);`
`20`	`20`	`result.ShouldBe(new List<string> { "Value 1", "Value 2", "Value 3" });`
`@@ -25,7 +25,7 @@ public void WhenGeneratingValuesFromDefaultDataSource_ThenShouldGenerateItemFrom`
`25`	`25`	`{`
`26`	`26`	`var sut = new DummyDataSource();`
`27`	`27`	`var result = sut.Next();`
`28`		`- sut.List.ShouldContain(result);`
	`28`	`+ sut.Data.ShouldContain(result);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`[Fact]`
`@@ -39,7 +39,7 @@ public void WhenGeneratingValuesFromDefaultDataSource_ThenShouldGenerateRandomIt`
`39`	`39`	`results.Add(sut.Next());`
`40`	`40`	`}`
`41`	`41`
`42`		`- foreach (var item in sut.List)`
	`42`	`+ foreach (var item in sut.Data)`
`43`	`43`	`{`
`44`	`44`	`results.ShouldContain(item);`
`45`	`45`	`}`
`@@ -50,20 +50,20 @@ public void WhenGeneratingValuesFromSequentialDataSource_ThenShouldGenerateSeque`
`50`	`50`	`{`
`51`	`51`	`var sut = new DummyDataSource(new SequentialGenerator());`
`52`	`52`
`53`		`- sut.Next().ShouldBe(sut.List[0]);`
`54`		`- sut.Next().ShouldBe(sut.List[1]);`
`55`		`- sut.Next().ShouldBe(sut.List[2]);`
`56`		`- sut.Next().ShouldBe(sut.List[0]);`
	`53`	`+ sut.Next().ShouldBe(sut.Data[0]);`
	`54`	`+ sut.Next().ShouldBe(sut.Data[1]);`
	`55`	`+ sut.Next().ShouldBe(sut.Data[2]);`
	`56`	`+ sut.Next().ShouldBe(sut.Data[0]);`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`[Fact]`
`60`	`60`	`public void WhenGeneratingValuesFromUniqueSequentialDataSource_ThenShouldThrowWhenCollectionExceeded()`
`61`	`61`	`{`
`62`	`62`	`var sut = new DummyDataSource(new SequentialGenerator(0,1,true));`
`63`	`63`
`64`		`- sut.Next().ShouldBe(sut.List[0]);`
`65`		`- sut.Next().ShouldBe(sut.List[1]);`
`66`		`- sut.Next().ShouldBe(sut.List[2]);`
	`64`	`+ sut.Next().ShouldBe(sut.Data[0]);`
	`65`	`+ sut.Next().ShouldBe(sut.Data[1]);`
	`66`	`+ sut.Next().ShouldBe(sut.Data[2]);`
`67`	`67`	`Should.Throw<InvalidOperationException>(() => sut.Next());`
`68`	`68`	`}`
`69`	`69`	`}`
`@@ -76,7 +76,7 @@ public DummyDataSource(IGenerator generator)`
`76`	`76`	`public DummyDataSource()`
`77`	`77`	`: this(new RandomGenerator()) { }`
`78`	`78`
`79`		`- protected override IList<string> InitializeList()`
	`79`	`+ protected override IList<string> InitializeDataSource()`
`80`	`80`	`{`
`81`	`81`	`return new List<string>{"Value 1", "Value 2", "Value 3"};`
`82`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,9 @@ public class PersonSourceTests`
`12`	`12`	`[PropertyData("TestCases")]`
`13`	`13`	`public void PersonSourceSpec(DataSource<string> sut, int expectedCount)`
`14`	`14`	`{`
`15`		`- var collection = sut.List.ToList();`
	`15`	`+ var collection = sut.Data.ToList();`
`16`	`16`	`collection.Count.ShouldBe(expectedCount);`
`17`		`- collection.Count.ShouldBe(sut.List.Distinct().ToList().Count);`
	`17`	`+ collection.Count.ShouldBe(sut.Data.Distinct().ToList().Count);`
`18`	`18`	`collection.ForEach(item => item.ShouldNotBeNullOrEmpty());`
`19`	`19`	`}`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public void WhenGettingAnyPersonData_ThenReturnRandomPersonDataWhichIsReasonably`
`26`	`26`	`{`
`27`	`27`	`testCase.ShouldBeOfType<string>();`
`28`	`28`	`testCase.ShouldNotBeNullOrEmpty();`
`29`		`- source.List.ShouldContain(testCase);`
	`29`	`+ source.Data.ShouldContain(testCase);`
`30`	`30`	`}`
`31`	`31`	`var unique = testCases.Distinct().Count();`
`32`	`32`	`unique.ShouldBeGreaterThan(5);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+File first word`
	`2`	`+File second word`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public CitySource(IGenerator generator)`
`19`	`19`	`: base(generator) { }`
`20`	`20`
`21`	`21`	`/// <inheritdoc />`
`22`		`- protected override IList<string> InitializeList()`
	`22`	`+ protected override IList<string> InitializeDataSource()`
`23`	`23`	`{`
`24`	`24`	`return FileDataRepository.People`
`25`	`25`	`.Select(person => person.City)`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public CompanySource(IGenerator generator)`
`19`	`19`	`: base(generator) { }`
`20`	`20`
`21`	`21`	`/// <inheritdoc />`
`22`		`- protected override IList<string> InitializeList()`
	`22`	`+ protected override IList<string> InitializeDataSource()`
`23`	`23`	`{`
`24`	`24`	`return FileDataRepository.People`
`25`	`25`	`.Select(person => person.CompanyName)`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public CountySource(IGenerator generator)`
`19`	`19`	`: base(generator) { }`
`20`	`20`
`21`	`21`	`/// <inheritdoc />`
`22`		`- protected override IList<string> InitializeList()`
	`22`	`+ protected override IList<string> InitializeDataSource()`
`23`	`23`	`{`
`24`	`24`	`return FileDataRepository.People`
`25`	`25`	`.Select(person => person.County)`