Added caching

Author: mwhelan

NTestDataBuilder.Tests/DataSources/Dictionaries/CacheTests.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace NTestDataBuilder.Tests.DataSources.Dictionaries
+{
+    public class CacheTests
+    {
+        public CacheTests()
+        {
+            Cache.Clear()
+        }
+    }
+}

NTestDataBuilder.Tests/DataSources/Dictionaries/FileDictionaryRepositoryIntegrationTests.cs

@@ -10,7 +10,7 @@ public class FileDictionaryRepositoryIntegrationTests
         [Fact]
         public void GivenAnExternalFileDictionaryExists_WhenRetrievingWords_ThenExternalDictionaryIsUsed()
         {
-            var sut = new FileDictionaryRepository();
+            var sut = new CachedFileDictionaryRepository();
 
             var result = sut.GetWordsFrom("SampleDictionaryFile");
 
@@ -21,7 +21,7 @@ public void GivenAnExternalFileDictionaryExists_WhenRetrievingWords_ThenExternal
         [Fact]
         public void GivenAResourceDictionaryAndNoExternalFileDictionary_WhenRetrievingWords_ThenResourceDictionaryIsUsed()
         {
-            var sut = new FileDictionaryRepository();
+            var sut = new CachedFileDictionaryRepository();
 
             var result = sut.GetWordsFrom("GeoContinent");
 
@@ -32,7 +32,7 @@ public void GivenAResourceDictionaryAndNoExternalFileDictionary_WhenRetrievingWo
         [Fact]
         public void GivenNoResourceDictionaryAndNoExternalFileDictionary_WhenRetrievingWords_ThenFileNotFoundException()
         {
-            var sut = new FileDictionaryRepository();
+            var sut = new CachedFileDictionaryRepository();
             Should.Throw<FileNotFoundException>(() => sut.GetWordsFrom("NonExistentDictionary"));
         }
 

NTestDataBuilder.Tests/EquivalenceClasses/DictionaryEquivalenceClassesTests.cs

@@ -21,15 +21,15 @@ public DictionaryEquivalenceClassesTests()
         [Theory]
         [PropertyData("TestCases")]
         public void WhenGettingAnyDictionaryData_ThenReturnRandomDictionaryDataWhichIsReasonablyUnique(DataSource<string> source,
-            List<string> testCases, bool checkUniqueness = true)
+            List<string> testCases)
         {
             foreach (var testCase in testCases)
             {
                 testCase.ShouldBeOfType<string>();
                 testCase.ShouldNotBeNullOrEmpty();
                 source.Data.ShouldContain(testCase);
             }
-            if (checkUniqueness)
+            if (source.Data.Count > 15)
             {
                 var unique = testCases.Distinct().Count();
                 unique.ShouldBeGreaterThan(5);
@@ -40,6 +40,7 @@ public static IEnumerable<object[]> TestCases
         {
             get
             {
+                yield return new object[] { new GeoContinentSource(), GenerateTestCasesForSut(Any.GeoContinent) };
                 yield return new object[] { new GeoCountrySource(), GenerateTestCasesForSut(Any.GeoCountry) };
             }
         }

NTestDataBuilder.Tests/NTestDataBuilder.Tests.csproj

@@ -53,6 +53,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="DataSources\DataSourceTests.cs" />
+    <Compile Include="DataSources\Dictionaries\CacheTests.cs" />
     <Compile Include="DataSources\Dictionaries\FileDictionaryRepositoryIntegrationTests.cs" />
     <Compile Include="DataSources\Dictionaries\FileDictionarySourceTests.cs" />
     <Compile Include="DataSources\Generators\RandomGeneratorTests.cs" />

NTestDataBuilder/DataSources/Dictionaries/Cache.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+
+namespace NTestDataBuilder.DataSources.Dictionaries
+{
+    internal static class Cache
+    {
+        private static IDictionary<string, IList<string>> _cache = new Dictionary<string, IList<string>>();
+
+        internal static IList<string> Get(string dictionary)
+        {
+            return _cache.ContainsKey(dictionary) ? _cache[dictionary] : null;
+        }
+
+        internal static void Set(string key, IList<string> items)
+        {
+            _cache[key] = items;
+        }
+
+        public static bool Contains(string key)
+        {
+            return _cache.ContainsKey(key);
+        }
+
+        public static void Clear()
+        {
+            _cache = new Dictionary<string, IList<string>>();
+        }
+    }
+}

…Dictionaries/FileDictionaryRepository.cs …naries/CachedFileDictionaryRepository.csNTestDataBuilder/DataSources/Dictionaries/FileDictionaryRepository.cs renamed to NTestDataBuilder/DataSources/Dictionaries/CachedFileDictionaryRepository.cs NTestDataBuilder/DataSources/Dictionaries/FileDictionaryRepository.cs renamed to NTestDataBuilder/DataSources/Dictionaries/CachedFileDictionaryRepository.cs

@@ -1,27 +1,37 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Reflection;
 
 namespace NTestDataBuilder.DataSources.Dictionaries
 {
     /// <summary>
-    /// Retrieves words from dictionaries stored in files
+    /// Retrieves words from dictionaries stored in files. First looks for external file that user might have created. If this does not exist then data is retrieved from embedded resource files.
     /// </summary>
-    public class FileDictionaryRepository : IDictionaryRepository
+    public class CachedFileDictionaryRepository : IDictionaryRepository
     {
         public IList<string> GetWordsFrom(string dictionary)
         {
-            // let users override values with file in bin directory
+            if (Cache.Contains(dictionary))
+            {
+                return Cache.Get(dictionary);
+            }
+
+            var words = new List<string>();
+
             var name = string.Format("{0}.txt", dictionary);
             if (File.Exists(name))
             {
-                return File.ReadAllLines(name);
+                words = File.ReadAllLines(name).ToList();
+            }
+            else
+            {
+                var resourceName = string.Format("NTestDataBuilder.DataSources.Dictionaries.Resources.{0}", name);
+                words = GetWordsFromEmbeddedResource(GetType().Assembly, resourceName).ToList();
             }
 
-            // otherwise get data from embedded resource files
-            var resourceName = string.Format("NTestDataBuilder.DataSources.Dictionaries.Resources.{0}", name);
-            return GetWordsFromEmbeddedResource(GetType().Assembly, resourceName);
+            Cache.Set(dictionary, words);
+            return words;
         }
 
         internal IList<string> GetWordsFromEmbeddedResource(Assembly assembly, string resourceName)

NTestDataBuilder/DataSources/Dictionaries/FileDictionarySource.cs

@@ -12,7 +12,7 @@ public abstract class FileDictionarySource : DataSource<string>
 
         /// <inheritdoc />
         protected FileDictionarySource()
-            : this(new RandomGenerator(), new FileDictionaryRepository()) { }
+            : this(new RandomGenerator(), new CachedFileDictionaryRepository()) { }
 
         /// <inheritdoc />
         public FileDictionarySource(IGenerator generator, IDictionaryRepository repository)

NTestDataBuilder/NTestDataBuilder.csproj

@@ -55,9 +55,10 @@
   <ItemGroup>
     <Compile Include="AnonymousValueFixture.cs" />
     <Compile Include="DataSources\CitySource.cs" />
+    <Compile Include="DataSources\Dictionaries\Cache.cs" />
     <Compile Include="DataSources\Dictionaries\IDictionaryRepository.cs" />
     <Compile Include="DataSources\CountySource.cs" />
-    <Compile Include="DataSources\Dictionaries\FileDictionaryRepository.cs" />
+    <Compile Include="DataSources\Dictionaries\CachedFileDictionaryRepository.cs" />
     <Compile Include="DataSources\Dictionaries\FileDictionarySource.cs" />
     <Compile Include="DataSources\Geography\GeoContinentSource.cs" />
     <Compile Include="DataSources\Geography\GeoCountrySource.cs" />

NTestDataBuilder/Properties/AssemblyInfo.cs

@@ -14,6 +14,8 @@
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
+[assembly: InternalsVisibleTo("NTestDataBuilder.Tests")]
+
 // Setting ComVisible to false makes the types in this assembly not visible 
 // to COM components.  If you need to access a type in this assembly from 
 // COM, set the ComVisible attribute to true on that type.