From 0dc9949933bec06b14d036326475077bf721e894 Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Sun, 20 Nov 2022 19:59:19 +1000 Subject: [PATCH] Rename and move configuration module. --- src/ImageSharp/Configuration.cs | 8 ++++---- src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs | 4 ++-- src/ImageSharp/Formats/Gif/GifConfigurationModule.cs | 2 +- .../IImageFormatConfigurationModule.cs} | 6 +++--- src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs | 2 +- src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs | 2 +- src/ImageSharp/Formats/Png/PngConfigurationModule.cs | 2 +- src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs | 2 +- src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs | 2 +- src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs | 2 +- tests/ImageSharp.Tests/ConfigurationTests.cs | 7 ++++--- tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs | 2 +- tests/ImageSharp.Tests/TestFormat.cs | 2 +- 13 files changed, 22 insertions(+), 21 deletions(-) rename src/ImageSharp/{IConfigurationModule.cs => Formats/IImageFormatConfigurationModule.cs} (81%) diff --git a/src/ImageSharp/Configuration.cs b/src/ImageSharp/Configuration.cs index b299405758..d4d0558238 100644 --- a/src/ImageSharp/Configuration.cs +++ b/src/ImageSharp/Configuration.cs @@ -42,11 +42,11 @@ public sealed class Configuration /// Initializes a new instance of the class. /// /// A collection of configuration modules to register. - public Configuration(params IConfigurationModule[] configurationModules) + public Configuration(params IImageFormatConfigurationModule[] configurationModules) { if (configurationModules != null) { - foreach (IConfigurationModule p in configurationModules) + foreach (IImageFormatConfigurationModule p in configurationModules) { p.Configure(this); } @@ -180,7 +180,7 @@ public sealed class Configuration /// Registers a new format provider. /// /// The configuration provider to call configure on. - public void Configure(IConfigurationModule configuration) + public void Configure(IImageFormatConfigurationModule configuration) { Guard.NotNull(configuration, nameof(configuration)); configuration.Configure(this); @@ -203,7 +203,7 @@ public sealed class Configuration }; /// - /// Creates the default instance with the following s preregistered: + /// Creates the default instance with the following s preregistered: /// /// /// diff --git a/src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs b/src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs index 05303058ef..2da90ade8b 100644 --- a/src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs +++ b/src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs @@ -1,4 +1,4 @@ -// Copyright (c) Six Labors. +// Copyright (c) Six Labors. // Licensed under the Six Labors Split License. namespace SixLabors.ImageSharp.Formats.Bmp; @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp; /// /// Registers the image encoders, decoders and mime type detectors for the bmp format. /// -public sealed class BmpConfigurationModule : IConfigurationModule +public sealed class BmpConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Gif/GifConfigurationModule.cs b/src/ImageSharp/Formats/Gif/GifConfigurationModule.cs index 8c8067adaf..1439930363 100644 --- a/src/ImageSharp/Formats/Gif/GifConfigurationModule.cs +++ b/src/ImageSharp/Formats/Gif/GifConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Gif; /// /// Registers the image encoders, decoders and mime type detectors for the gif format. /// -public sealed class GifConfigurationModule : IConfigurationModule +public sealed class GifConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/IConfigurationModule.cs b/src/ImageSharp/Formats/IImageFormatConfigurationModule.cs similarity index 81% rename from src/ImageSharp/IConfigurationModule.cs rename to src/ImageSharp/Formats/IImageFormatConfigurationModule.cs index e2b221a080..b05a8c037a 100644 --- a/src/ImageSharp/IConfigurationModule.cs +++ b/src/ImageSharp/Formats/IImageFormatConfigurationModule.cs @@ -1,12 +1,12 @@ -// Copyright (c) Six Labors. +// Copyright (c) Six Labors. // Licensed under the Six Labors Split License. -namespace SixLabors.ImageSharp; +namespace SixLabors.ImageSharp.Formats; /// /// Represents an interface that can register image encoders, decoders and image format detectors. /// -public interface IConfigurationModule +public interface IImageFormatConfigurationModule { /// /// Called when loaded into a configuration object so the module can register items into the configuration. diff --git a/src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs b/src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs index 963b8eb299..b8da5db2a6 100644 --- a/src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs +++ b/src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Jpeg; /// /// Registers the image encoders, decoders and mime type detectors for the jpeg format. /// -public sealed class JpegConfigurationModule : IConfigurationModule +public sealed class JpegConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs b/src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs index cd411a2d75..de2a2588d9 100644 --- a/src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs +++ b/src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Pbm; /// /// Registers the image encoders, decoders and mime type detectors for the Pbm format. /// -public sealed class PbmConfigurationModule : IConfigurationModule +public sealed class PbmConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Png/PngConfigurationModule.cs b/src/ImageSharp/Formats/Png/PngConfigurationModule.cs index caee817191..9ae8543040 100644 --- a/src/ImageSharp/Formats/Png/PngConfigurationModule.cs +++ b/src/ImageSharp/Formats/Png/PngConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Png; /// /// Registers the image encoders, decoders and mime type detectors for the png format. /// -public sealed class PngConfigurationModule : IConfigurationModule +public sealed class PngConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs b/src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs index 06f93d1ce5..040fbb6411 100644 --- a/src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs +++ b/src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Tga; /// /// Registers the image encoders, decoders and mime type detectors for the tga format. /// -public sealed class TgaConfigurationModule : IConfigurationModule +public sealed class TgaConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs b/src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs index 67b6517237..58b3cd18b6 100644 --- a/src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs +++ b/src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Tiff; /// /// Registers the image encoders, decoders and mime type detectors for the TIFF format. /// -public sealed class TiffConfigurationModule : IConfigurationModule +public sealed class TiffConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs b/src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs index f266cde32f..2773c03f68 100644 --- a/src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs +++ b/src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs @@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Webp; /// /// Registers the image encoders, decoders and mime type detectors for the webp format. /// -public sealed class WebpConfigurationModule : IConfigurationModule +public sealed class WebpConfigurationModule : IImageFormatConfigurationModule { /// public void Configure(Configuration configuration) diff --git a/tests/ImageSharp.Tests/ConfigurationTests.cs b/tests/ImageSharp.Tests/ConfigurationTests.cs index a3419eb27d..3853c445f7 100644 --- a/tests/ImageSharp.Tests/ConfigurationTests.cs +++ b/tests/ImageSharp.Tests/ConfigurationTests.cs @@ -3,6 +3,7 @@ using Microsoft.DotNet.RemoteExecutor; using Moq; +using SixLabors.ImageSharp.Formats; using SixLabors.ImageSharp.Formats.Bmp; using SixLabors.ImageSharp.IO; using SixLabors.ImageSharp.Memory; @@ -86,7 +87,7 @@ public class ConfigurationTests [Fact] public void ConstructorCallConfigureOnFormatProvider() { - var provider = new Mock(); + var provider = new Mock(); var config = new Configuration(provider.Object); provider.Verify(x => x.Configure(config)); @@ -95,7 +96,7 @@ public class ConfigurationTests [Fact] public void AddFormatCallsConfig() { - var provider = new Mock(); + var provider = new Mock(); var config = new Configuration(); config.Configure(provider.Object); @@ -178,7 +179,7 @@ public class ConfigurationTests } } - private class MockConfigurationModule : IConfigurationModule + private class MockConfigurationModule : IImageFormatConfigurationModule { public void Configure(Configuration configuration) { diff --git a/tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs b/tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs index cd1180a9bf..d276f7eb6d 100644 --- a/tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs +++ b/tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs @@ -102,7 +102,7 @@ public class ImageFormatManagerTests [Fact] public void AddFormatCallsConfig() { - Mock provider = new(); + Mock provider = new(); Configuration config = new(); config.Configure(provider.Object); diff --git a/tests/ImageSharp.Tests/TestFormat.cs b/tests/ImageSharp.Tests/TestFormat.cs index 59eafe17d6..f3176f16c5 100644 --- a/tests/ImageSharp.Tests/TestFormat.cs +++ b/tests/ImageSharp.Tests/TestFormat.cs @@ -11,7 +11,7 @@ namespace SixLabors.ImageSharp.Tests; /// /// A test image file. /// -public class TestFormat : IConfigurationModule, IImageFormat +public class TestFormat : IImageFormatConfigurationModule, IImageFormat { private readonly Dictionary sampleImages = new();