Small code refactors and cleanups

daleghent · Jan 29, 2023 · 415c962 · 415c962
1 parent 0f09ca0
commit 415c962
Show file tree

Hide file tree

Showing 19 changed files with 69 additions and 69 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Ground Station
 
+## 2.2.0.0 - UNRELEASED
+* Small code refactors and cleanups
+
 ## 2.1.0.0 - 2022-11-26
 * Pushover client library replaced with internal one (Credit: Stefan Berg)
 * Replacing the internal Pushover client allows the implementation of Emergency priority messages for Pushover:

diff --git a/Email/FailuresToEmailTrigger.cs b/Email/FailuresToEmailTrigger.cs
@@ -136,6 +136,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -248,7 +249,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/Email/SendToEmail.cs b/Email/SendToEmail.cs
@@ -177,7 +177,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/HTTP/HttpClient.cs b/HTTP/HttpClient.cs
@@ -182,7 +182,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/IFTTT/FailuresToIftttTrigger.cs b/IFTTT/FailuresToIftttTrigger.cs
@@ -119,7 +119,7 @@ public FailuresToIftttTrigger(FailuresToIftttTrigger copyMe) : this(
         public string EventName {
             get => eventName;
             set {
-                if (value.Contains("/") || value.Contains(" ")) {
+                if (value.Contains('/') || value.Contains(' ')) {
                     RaisePropertyChanged();
                     return;
                 }
@@ -139,6 +139,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -240,7 +241,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/IFTTT/SendToIftttWebhook.cs b/IFTTT/SendToIftttWebhook.cs
@@ -33,7 +33,7 @@ namespace DaleGhent.NINA.GroundStation.SendToIftttWebhook {
     [Export(typeof(ISequenceItem))]
     [JsonObject(MemberSerialization.OptIn)]
     public class SendToIftttWebhook : SequenceItem, IValidatable {
-        private IftttCommon ifttt;
+        private readonly IftttCommon ifttt;
         private string eventName = "nina";
         private string value1 = string.Empty;
         private string value2 = string.Empty;
@@ -109,7 +109,7 @@ public SendToIftttWebhook(SendToIftttWebhook copyMe) : this(cameraMediator: copy
         public string EventName {
             get => eventName;
             set {
-                if (!value.Contains("/")) {
+                if (!value.Contains('/')) {
                     eventName = value;
                 }
 
@@ -165,7 +165,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/MQTT/FailuresToMqttTrigger.cs b/MQTT/FailuresToMqttTrigger.cs
@@ -84,6 +84,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -179,7 +180,7 @@ private async Task WorkerFn(SequenceEntityFailureEventArgs item, CancellationTok
             }
         }
 
-        public IList<string> QoSLevels => MqttCommon.QoSLevels;
+        public static IList<string> QoSLevels => MqttCommon.QoSLevels;
 
         public override Task Execute(ISequenceContainer context, IProgress<ApplicationStatus> progress, CancellationToken ct) {
             return Task.CompletedTask;
@@ -204,7 +205,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/MQTT/MqttClient.cs b/MQTT/MqttClient.cs
@@ -28,7 +28,7 @@ This Source Code Form is subject to the terms of the Mozilla Public
 namespace DaleGhent.NINA.GroundStation.Mqtt {
 
     internal class MqttClient {
-        private IMqttClient mqttClient;
+        private readonly IMqttClient mqttClient;
 
         public MqttClient() {
             var mqttFactory = new MqttFactory();

diff --git a/MQTT/SendToMqtt.cs b/MQTT/SendToMqtt.cs
@@ -34,7 +34,7 @@ namespace DaleGhent.NINA.GroundStation.SendToMqtt {
     [Export(typeof(ISequenceItem))]
     [JsonObject(MemberSerialization.OptIn)]
     public class SendToMqtt : SequenceItem, IValidatable {
-        private MqttCommon mqtt;
+        private readonly MqttCommon mqtt;
         private string topic;
         private string payload = string.Empty;
         private int qos = 0;
@@ -136,7 +136,7 @@ public int QoS {
             }
         }
 
-        public IList<string> QoSLevels => MqttCommon.QoSLevels;
+        public static IList<string> QoSLevels => MqttCommon.QoSLevels;
 
         public override async Task Execute(IProgress<ApplicationStatus> progress, CancellationToken ct) {
             var payload = Utilities.Utilities.ResolveTokens(Payload, this, metadata);
@@ -160,7 +160,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/MetadataClient/Metadata.cs b/MetadataClient/Metadata.cs
@@ -22,15 +22,10 @@ This Source Code Form is subject to the terms of the Mozilla Public
 using NINA.Equipment.Equipment.MyTelescope;
 using NINA.Equipment.Equipment.MyWeatherData;
 using NINA.Equipment.Interfaces.Mediator;
-using NINA.WPF.Base.Mediator;
-using System;
-using System.Collections.Generic;
 using System.Globalization;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace DaleGhent.NINA.GroundStation.MetadataClient {
+
     public class Metadata : IMetadata {
         private readonly ICameraMediator cameraMediator;
         private readonly IDomeMediator domeMediator;
@@ -81,4 +76,4 @@ public Metadata(ICameraMediator cameraMediator,
         public WeatherDataInfo WeatherDataInfo => weatherDataMediator.GetInfo();
         public CultureInfo CultureInfo { get; set; } = CultureInfo.InvariantCulture;
     }
-}
+}
diff --git a/Pushover/FailuresToPushoverTrigger.cs b/Pushover/FailuresToPushoverTrigger.cs
@@ -126,6 +126,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -223,8 +224,8 @@ public NotificationSound NotificationSound {
             }
         }
 
-        public Priority[] Priorities => Enum.GetValues(typeof(Priority)).Cast<Priority>().ToArray();
-        public NotificationSound[] NotificationSounds => Enum.GetValues(typeof(NotificationSound)).Cast<NotificationSound>().Where(p => p != NotificationSound.NotSet).ToArray();
+        public static Priority[] Priorities => Enum.GetValues(typeof(Priority)).Cast<Priority>().ToArray();
+        public static NotificationSound[] NotificationSounds => Enum.GetValues(typeof(NotificationSound)).Cast<NotificationSound>().Where(p => p != NotificationSound.NotSet).ToArray();
 
         public override Task Execute(ISequenceContainer context, IProgress<ApplicationStatus> progress, CancellationToken ct) {
             return Task.CompletedTask;
@@ -245,7 +246,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/Pushover/SendToPushover.cs b/Pushover/SendToPushover.cs
@@ -34,7 +34,7 @@ namespace DaleGhent.NINA.GroundStation.SendToPushover {
     [Export(typeof(ISequenceItem))]
     [JsonObject(MemberSerialization.OptIn)]
     public class SendToPushover : SequenceItem, IValidatable {
-        private PushoverClient.PushoverClient pushover;
+        private readonly PushoverClient.PushoverClient pushover;
         private string title = string.Empty;
         private string message = string.Empty;
         private Priority priority;
@@ -172,7 +172,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/TTS/FailuresToTTS.cs b/TTS/FailuresToTTS.cs
@@ -133,6 +133,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -217,7 +218,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/TTS/SendToTTS.cs b/TTS/SendToTTS.cs
@@ -136,7 +136,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/Telegram/FailuresToTelegramTrigger.cs b/Telegram/FailuresToTelegramTrigger.cs
@@ -120,6 +120,7 @@ public override void Teardown() {
 
         public void Dispose() {
             queueWorker.Dispose();
+            GC.SuppressFinalize(this);
         }
 
         public override void AfterParentChanged() {
@@ -214,7 +215,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/Telegram/SendToTelegram.cs b/Telegram/SendToTelegram.cs
@@ -33,7 +33,7 @@ namespace DaleGhent.NINA.GroundStation.SendToTelegram {
     [Export(typeof(ISequenceItem))]
     [JsonObject(MemberSerialization.OptIn)]
     public class SendToTelegram : SequenceItem, IValidatable {
-        private TelegramCommon telegram;
+        private readonly TelegramCommon telegram;
         private string message = string.Empty;
         private bool doNotNotify = false;
 
@@ -137,7 +137,7 @@ public bool Validate() {
 
             if (i != Issues) {
                 Issues = i;
-                RaisePropertyChanged("Issues");
+                RaisePropertyChanged(nameof(Issues));
             }
 
             return i.Count == 0;

diff --git a/Utilities/BackgroundQueueWorker.cs b/Utilities/BackgroundQueueWorker.cs
@@ -7,7 +7,7 @@
 namespace DaleGhent.NINA.GroundStation.Utilities {
 
     internal class BackgroundQueueWorker<T> : IDisposable {
-        private int queueSize;
+        private readonly int queueSize;
         private CancellationTokenSource workerCts;
         private AsyncProducerConsumerQueue<T> messageQueue;
         private Func<T, CancellationToken, Task> workerFn;
@@ -73,6 +73,7 @@ public async Task Start() {
 
         public void Dispose() {
             semaphore?.Dispose();
+            GC.SuppressFinalize(this);
         }
     }
 }
diff --git a/Utilities/FailedItem.cs b/Utilities/FailedItem.cs
@@ -16,9 +16,6 @@ This Source Code Form is subject to the terms of the Mozilla Public
 using NINA.Sequencer.Validations;
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace DaleGhent.NINA.GroundStation.Utilities {