Made ComplexOperator of ComplexSettings mandatory and immutable through the constructor.

Author: dlemstra

src/Magick.NET.Core/Factories/ISettingsFactory.cs

@@ -22,8 +22,9 @@ public interface ISettingsFactory<TQuantumType>
     /// <summary>
     /// Initializes a new instance that implements <see cref="IComplexSettings"/>.
     /// </summary>
+    /// <param name="complexOperator">The complex operator to use.</param>
     /// <returns>A new <see cref="IComplexSettings"/> instance.</returns>
-    IComplexSettings CreateComplexSettings();
+    IComplexSettings CreateComplexSettings(ComplexOperator complexOperator);
 
     /// <summary>
     /// Initializes a new instance that implements <see cref="IConnectedComponentsSettings"/>.

src/Magick.NET.Core/Settings/IComplexSettings.cs

@@ -9,9 +9,9 @@ namespace ImageMagick;
 public interface IComplexSettings
 {
     /// <summary>
-    /// Gets or sets the complex operator.
+    /// Gets the complex operator.
     /// </summary>
-    ComplexOperator ComplexOperator { get; set; }
+    ComplexOperator ComplexOperator { get; }
 
     /// <summary>
     /// Gets or sets the signal to noise ratio.

src/Magick.NET/Factories/SettingsFactory.cs

@@ -29,9 +29,10 @@ public ICompareSettings<QuantumType> CreateCompareSettings(ErrorMetric metric)
     /// <summary>
     /// Initializes a new instance that implements <see cref="IComplexSettings"/>.
     /// </summary>
+    /// <param name="complexOperator">The complex operator to use.</param>
     /// <returns>A new <see cref="IComplexSettings"/> instance.</returns>
-    public IComplexSettings CreateComplexSettings()
-        => new ComplexSettings();
+    public IComplexSettings CreateComplexSettings(ComplexOperator complexOperator)
+        => new ComplexSettings(complexOperator);
 
     /// <summary>
     /// Initializes a new instance that implements <see cref="IConnectedComponentsSettings"/>.

src/Magick.NET/MagickImageCollection.cs

@@ -442,12 +442,12 @@ public void Complex(IComplexSettings complexSettings)
     {
         Throw.IfNull(nameof(complexSettings), complexSettings);
 
+        using var imageAttacher = new TemporaryImageAttacher(_images);
         using var temporaryDefines = new TemporaryDefines(_images[0]);
 
         if (complexSettings.SignalToNoiseRatio is not null)
             temporaryDefines.SetArtifact("complex:snr", complexSettings.SignalToNoiseRatio.Value.ToString(CultureInfo.InvariantCulture));
 
-        using var imageAttacher = new TemporaryImageAttacher(_images);
         var images = _nativeInstance.Complex(_images[0], complexSettings.ComplexOperator);
         ReplaceImages(images);
     }

src/Magick.NET/Settings/ComplexSettings.cs

@@ -9,9 +9,18 @@ namespace ImageMagick;
 public sealed class ComplexSettings : IComplexSettings
 {
     /// <summary>
-    /// Gets or sets the complex operator.
+    /// Initializes a new instance of the <see cref="ComplexSettings"/> class.
     /// </summary>
-    public ComplexOperator ComplexOperator { get; set; }
+    /// <param name="complexOperator">The complex operator.</param>
+    public ComplexSettings(ComplexOperator complexOperator)
+    {
+        ComplexOperator = complexOperator;
+    }
+
+    /// <summary>
+    /// Gets the complex operator.
+    /// </summary>
+    public ComplexOperator ComplexOperator { get; }
 
     /// <summary>
     /// Gets or sets the signal to noise ratio.

tests/Magick.NET.Tests/Factories/SettingsFactoryTests/TheCreateComplexSettingsMethod.cs

@@ -16,7 +16,7 @@ public void ShouldCreateInstance()
         {
             var factory = new SettingsFactory();
 
-            var settings = factory.CreateComplexSettings();
+            var settings = factory.CreateComplexSettings(ComplexOperator.MagnitudePhase);
 
             Assert.NotNull(settings);
             Assert.IsType<ComplexSettings>(settings);

tests/Magick.NET.Tests/MagickImageCollectionTests/TheComplexMethod.cs

@@ -15,8 +15,9 @@ public class TheComplexMethod
         public void ShouldThrowExceptionWhenCollectionIsEmpty()
         {
             using var images = new MagickImageCollection();
+            var settings = new ComplexSettings(ComplexOperator.RealImaginary);
 
-            Assert.Throws<InvalidOperationException>(() => images.Complex(new ComplexSettings()));
+            Assert.Throws<InvalidOperationException>(() => images.Complex(settings));
         }
 
         [Fact]
@@ -36,10 +37,8 @@ public void ShouldApplyTheOperatorToTheImages()
             using var images = new MagickImageCollection();
             images.Read(Files.RoseSparkleGIF);
 
-            images.Complex(new ComplexSettings
-            {
-                ComplexOperator = ComplexOperator.Conjugate,
-            });
+            var settings = new ComplexSettings(ComplexOperator.Conjugate);
+            images.Complex(settings);
 
             Assert.Equal(2, images.Count);