Browse Source

Rename and move configuration module.

pull/2301/head
James Jackson-South 4 years ago
parent
commit
0dc9949933
  1. 8
      src/ImageSharp/Configuration.cs
  2. 4
      src/ImageSharp/Formats/Bmp/BmpConfigurationModule.cs
  3. 2
      src/ImageSharp/Formats/Gif/GifConfigurationModule.cs
  4. 6
      src/ImageSharp/Formats/IImageFormatConfigurationModule.cs
  5. 2
      src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs
  6. 2
      src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs
  7. 2
      src/ImageSharp/Formats/Png/PngConfigurationModule.cs
  8. 2
      src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs
  9. 2
      src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs
  10. 2
      src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs
  11. 7
      tests/ImageSharp.Tests/ConfigurationTests.cs
  12. 2
      tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs
  13. 2
      tests/ImageSharp.Tests/TestFormat.cs

8
src/ImageSharp/Configuration.cs

@ -42,11 +42,11 @@ public sealed class Configuration
/// Initializes a new instance of the <see cref="Configuration" /> class. /// Initializes a new instance of the <see cref="Configuration" /> class.
/// </summary> /// </summary>
/// <param name="configurationModules">A collection of configuration modules to register.</param> /// <param name="configurationModules">A collection of configuration modules to register.</param>
public Configuration(params IConfigurationModule[] configurationModules) public Configuration(params IImageFormatConfigurationModule[] configurationModules)
{ {
if (configurationModules != null) if (configurationModules != null)
{ {
foreach (IConfigurationModule p in configurationModules) foreach (IImageFormatConfigurationModule p in configurationModules)
{ {
p.Configure(this); p.Configure(this);
} }
@ -180,7 +180,7 @@ public sealed class Configuration
/// Registers a new format provider. /// Registers a new format provider.
/// </summary> /// </summary>
/// <param name="configuration">The configuration provider to call configure on.</param> /// <param name="configuration">The configuration provider to call configure on.</param>
public void Configure(IConfigurationModule configuration) public void Configure(IImageFormatConfigurationModule configuration)
{ {
Guard.NotNull(configuration, nameof(configuration)); Guard.NotNull(configuration, nameof(configuration));
configuration.Configure(this); configuration.Configure(this);
@ -203,7 +203,7 @@ public sealed class Configuration
}; };
/// <summary> /// <summary>
/// Creates the default instance with the following <see cref="IConfigurationModule"/>s preregistered: /// Creates the default instance with the following <see cref="IImageFormatConfigurationModule"/>s preregistered:
/// <see cref="PngConfigurationModule"/> /// <see cref="PngConfigurationModule"/>
/// <see cref="JpegConfigurationModule"/> /// <see cref="JpegConfigurationModule"/>
/// <see cref="GifConfigurationModule"/> /// <see cref="GifConfigurationModule"/>

4
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. // Licensed under the Six Labors Split License.
namespace SixLabors.ImageSharp.Formats.Bmp; namespace SixLabors.ImageSharp.Formats.Bmp;
@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Bmp;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the bmp format. /// Registers the image encoders, decoders and mime type detectors for the bmp format.
/// </summary> /// </summary>
public sealed class BmpConfigurationModule : IConfigurationModule public sealed class BmpConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Gif/GifConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Gif;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the gif format. /// Registers the image encoders, decoders and mime type detectors for the gif format.
/// </summary> /// </summary>
public sealed class GifConfigurationModule : IConfigurationModule public sealed class GifConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

6
src/ImageSharp/IConfigurationModule.cs → src/ImageSharp/Formats/IImageFormatConfigurationModule.cs

@ -1,12 +1,12 @@
// Copyright (c) Six Labors. // Copyright (c) Six Labors.
// Licensed under the Six Labors Split License. // Licensed under the Six Labors Split License.
namespace SixLabors.ImageSharp; namespace SixLabors.ImageSharp.Formats;
/// <summary> /// <summary>
/// Represents an interface that can register image encoders, decoders and image format detectors. /// Represents an interface that can register image encoders, decoders and image format detectors.
/// </summary> /// </summary>
public interface IConfigurationModule public interface IImageFormatConfigurationModule
{ {
/// <summary> /// <summary>
/// Called when loaded into a configuration object so the module can register items into the configuration. /// Called when loaded into a configuration object so the module can register items into the configuration.

2
src/ImageSharp/Formats/Jpeg/JpegConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Jpeg;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the jpeg format. /// Registers the image encoders, decoders and mime type detectors for the jpeg format.
/// </summary> /// </summary>
public sealed class JpegConfigurationModule : IConfigurationModule public sealed class JpegConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Pbm/PbmConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Pbm;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the Pbm format. /// Registers the image encoders, decoders and mime type detectors for the Pbm format.
/// </summary> /// </summary>
public sealed class PbmConfigurationModule : IConfigurationModule public sealed class PbmConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Png/PngConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Png;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the png format. /// Registers the image encoders, decoders and mime type detectors for the png format.
/// </summary> /// </summary>
public sealed class PngConfigurationModule : IConfigurationModule public sealed class PngConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Tga/TgaConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Tga;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the tga format. /// Registers the image encoders, decoders and mime type detectors for the tga format.
/// </summary> /// </summary>
public sealed class TgaConfigurationModule : IConfigurationModule public sealed class TgaConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Tiff/TiffConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Tiff;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the TIFF format. /// Registers the image encoders, decoders and mime type detectors for the TIFF format.
/// </summary> /// </summary>
public sealed class TiffConfigurationModule : IConfigurationModule public sealed class TiffConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

2
src/ImageSharp/Formats/Webp/WebpConfigurationModule.cs

@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Formats.Webp;
/// <summary> /// <summary>
/// Registers the image encoders, decoders and mime type detectors for the webp format. /// Registers the image encoders, decoders and mime type detectors for the webp format.
/// </summary> /// </summary>
public sealed class WebpConfigurationModule : IConfigurationModule public sealed class WebpConfigurationModule : IImageFormatConfigurationModule
{ {
/// <inheritdoc/> /// <inheritdoc/>
public void Configure(Configuration configuration) public void Configure(Configuration configuration)

7
tests/ImageSharp.Tests/ConfigurationTests.cs

@ -3,6 +3,7 @@
using Microsoft.DotNet.RemoteExecutor; using Microsoft.DotNet.RemoteExecutor;
using Moq; using Moq;
using SixLabors.ImageSharp.Formats;
using SixLabors.ImageSharp.Formats.Bmp; using SixLabors.ImageSharp.Formats.Bmp;
using SixLabors.ImageSharp.IO; using SixLabors.ImageSharp.IO;
using SixLabors.ImageSharp.Memory; using SixLabors.ImageSharp.Memory;
@ -86,7 +87,7 @@ public class ConfigurationTests
[Fact] [Fact]
public void ConstructorCallConfigureOnFormatProvider() public void ConstructorCallConfigureOnFormatProvider()
{ {
var provider = new Mock<IConfigurationModule>(); var provider = new Mock<IImageFormatConfigurationModule>();
var config = new Configuration(provider.Object); var config = new Configuration(provider.Object);
provider.Verify(x => x.Configure(config)); provider.Verify(x => x.Configure(config));
@ -95,7 +96,7 @@ public class ConfigurationTests
[Fact] [Fact]
public void AddFormatCallsConfig() public void AddFormatCallsConfig()
{ {
var provider = new Mock<IConfigurationModule>(); var provider = new Mock<IImageFormatConfigurationModule>();
var config = new Configuration(); var config = new Configuration();
config.Configure(provider.Object); config.Configure(provider.Object);
@ -178,7 +179,7 @@ public class ConfigurationTests
} }
} }
private class MockConfigurationModule : IConfigurationModule private class MockConfigurationModule : IImageFormatConfigurationModule
{ {
public void Configure(Configuration configuration) public void Configure(Configuration configuration)
{ {

2
tests/ImageSharp.Tests/Formats/ImageFormatManagerTests.cs

@ -102,7 +102,7 @@ public class ImageFormatManagerTests
[Fact] [Fact]
public void AddFormatCallsConfig() public void AddFormatCallsConfig()
{ {
Mock<IConfigurationModule> provider = new(); Mock<IImageFormatConfigurationModule> provider = new();
Configuration config = new(); Configuration config = new();
config.Configure(provider.Object); config.Configure(provider.Object);

2
tests/ImageSharp.Tests/TestFormat.cs

@ -11,7 +11,7 @@ namespace SixLabors.ImageSharp.Tests;
/// <summary> /// <summary>
/// A test image file. /// A test image file.
/// </summary> /// </summary>
public class TestFormat : IConfigurationModule, IImageFormat public class TestFormat : IImageFormatConfigurationModule, IImageFormat
{ {
private readonly Dictionary<Type, object> sampleImages = new(); private readonly Dictionary<Type, object> sampleImages = new();

Loading…
Cancel
Save