Rename CachedNameLength to CacheHashLength

Author: ronaldbarendse

samples/ImageSharp.Web.Sample/Startup.cs

@@ -88,7 +88,7 @@ private void ConfigureDefaultServicesAndCustomOptions(IServiceCollection service
                         options.Configuration = Configuration.Default;
                         options.BrowserMaxAge = TimeSpan.FromDays(7);
                         options.CacheMaxAge = TimeSpan.FromDays(365);
-                        options.CachedNameLength = 8;
+                        options.CacheHashLength = 8;
                         options.OnParseCommandsAsync = _ => Task.CompletedTask;
                         options.OnBeforeSaveAsync = _ => Task.CompletedTask;
                         options.OnProcessedAsync = _ => Task.CompletedTask;
@@ -111,7 +111,7 @@ private void ConfigureCustomServicesAndCustomOptions(IServiceCollection services
                         options.Configuration = Configuration.Default;
                         options.BrowserMaxAge = TimeSpan.FromDays(7);
                         options.CacheMaxAge = TimeSpan.FromDays(365);
-                        options.CachedNameLength = 8;
+                        options.CacheHashLength = 8;
                         options.OnParseCommandsAsync = _ => Task.CompletedTask;
                         options.OnBeforeSaveAsync = _ => Task.CompletedTask;
                         options.OnProcessedAsync = _ => Task.CompletedTask;

src/ImageSharp.Web/Caching/PhysicalFileSystemCache.cs

@@ -25,9 +25,9 @@ public class PhysicalFileSystemCache : IImageCache
         private readonly string cacheRootPath;
 
         /// <summary>
-        /// The length of the filename to use (minus the extension) when storing images in the image cache.
+        /// The depth of the nested cache folders structure to store the images.
         /// </summary>
-        private readonly int cachedNameLength;
+        private readonly int cacheFolderDepth;
 
         /// <summary>
         /// The file provider abstraction.
@@ -80,7 +80,7 @@ public PhysicalFileSystemCache(
 
             this.fileProvider = new PhysicalFileProvider(this.cacheRootPath);
             this.options = options.Value;
-            this.cachedNameLength = (int)this.options.CachedNameLength;
+            this.cacheFolderDepth = (int)this.options.CacheHashLength;
             this.formatUtilities = formatUtilities;
         }
 
@@ -105,7 +105,7 @@ internal static string GetCacheRoot(PhysicalFileSystemCacheOptions cacheOptions,
         /// <inheritdoc/>
         public Task<IImageCacheResolver> GetAsync(string key)
         {
-            string path = ToFilePath(key, this.cachedNameLength);
+            string path = ToFilePath(key, this.cacheFolderDepth);
 
             IFileInfo metaFileInfo = this.fileProvider.GetFileInfo(this.ToMetaDataFilePath(path));
             if (!metaFileInfo.Exists)
@@ -119,7 +119,7 @@ public Task<IImageCacheResolver> GetAsync(string key)
         /// <inheritdoc/>
         public async Task SetAsync(string key, Stream stream, ImageCacheMetadata metadata)
         {
-            string path = Path.Combine(this.cacheRootPath, ToFilePath(key, this.cachedNameLength));
+            string path = Path.Combine(this.cacheRootPath, ToFilePath(key, this.cacheFolderDepth));
             string imagePath = this.ToImageFilePath(path, metadata);
             string metaPath = this.ToMetaDataFilePath(path);
             string directory = Path.GetDirectoryName(path);
@@ -162,13 +162,13 @@ private string ToImageFilePath(string path, in ImageCacheMetadata metaData)
         /// Converts the key into a nested file path.
         /// </summary>
         /// <param name="key">The cache key.</param>
-        /// <param name="cachedNameLength">The length of the cached file name minus the extension.</param>
+        /// <param name="cacheFolderDepth">The depth of the nested cache folders structure to store the images.</param>
         /// <returns>The <see cref="string"/>.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal static unsafe string ToFilePath(string key, int cachedNameLength)
+        internal static unsafe string ToFilePath(string key, int cacheFolderDepth)
         {
             // Each key substring char + separator + key
-            int length = (cachedNameLength * 2) + key.Length;
+            int length = (cacheFolderDepth * 2) + key.Length;
             fixed (char* keyPtr = key)
             {
                 return string.Create(length, (Ptr: (IntPtr)keyPtr, key.Length), (chars, args) =>
@@ -179,7 +179,7 @@ internal static unsafe string ToFilePath(string key, int cachedNameLength)
                     ref char charRef = ref MemoryMarshal.GetReference(chars);
 
                     int index = 0;
-                    for (int i = 0; i < cachedNameLength; i++)
+                    for (int i = 0; i < cacheFolderDepth; i++)
                     {
                         Unsafe.Add(ref charRef, index++) = Unsafe.Add(ref keyRef, i);
                         Unsafe.Add(ref charRef, index++) = separator;

src/ImageSharp.Web/Caching/SHA256CacheHash.cs

@@ -25,7 +25,7 @@ public sealed class SHA256CacheHash : ICacheHash
         public SHA256CacheHash(IOptions<ImageSharpMiddlewareOptions> options)
         {
             Guard.NotNull(options, nameof(options));
-            Guard.MustBeBetweenOrEqualTo<uint>(options.Value.CachedNameLength, 2, 64, nameof(options.Value.CachedNameLength));
+            Guard.MustBeBetweenOrEqualTo<uint>(options.Value.CacheHashLength, 2, 64, nameof(options.Value.CacheHashLength));
         }
 
         /// <inheritdoc/>

src/ImageSharp.Web/Middleware/ImageSharpMiddleware.cs

@@ -271,7 +271,7 @@ private async Task ProcessRequestAsync(
             // Create a hashed cache key
             string key = this.cacheHash.Create(
                 this.cacheKey.Create(context, commands),
-                this.options.CachedNameLength);
+                this.options.CacheHashLength);
 
             // Check the cache, if present, not out of date and not requiring an update
             // we'll simply serve the file from there.

src/ImageSharp.Web/Middleware/ImageSharpMiddlewareOptions.cs

@@ -88,7 +88,7 @@ public class ImageSharpMiddlewareOptions
         /// Gets or sets the length of the filename to use (minus the extension) when storing
         /// images in the image cache. Defaults to 12 characters.
         /// </summary>
-        public uint CachedNameLength { get; set; } = 12;
+        public uint CacheHashLength { get; set; } = 12;
 
         /// <summary>
         /// Gets or sets the additional command parsing method that can be used to used to augment commands.